1 /* SPDX-License-Identifier: GPL-2.0+ */
3 * Copyright (c) 2013 Google, Inc.
10 #include <test/test.h>
13 * struct dm_test_cdata - configuration data for test instance
15 * @ping_add: Amonut to add each time we get a ping
16 * @base: Base address of this device
18 struct dm_test_pdata {
24 * struct test_ops - Operations supported by the test device
26 * @ping: Ping operation
27 * @dev: Device to operate on
28 * @pingval: Value to ping the device with
29 * @pingret: Returns resulting value from driver
30 * @return 0 if OK, -ve on error
33 int (*ping)(struct udevice *dev, int pingval, int *pingret);
36 /* Operations that our test driver supports */
45 DM_TEST_OP_PRE_UNBIND,
47 DM_TEST_OP_POST_PROBE,
48 DM_TEST_OP_PRE_REMOVE,
55 /* Test driver types */
57 DM_TEST_TYPE_FIRST = 0,
63 /* The number added to the ping total on each probe */
64 #define DM_TEST_START_TOTAL 5
67 * struct dm_test_priv - private data for the test devices
71 int op_count[DM_TEST_OP_COUNT];
78 * struct dm_test_perdev_class_priv - private per-device data for test uclass
80 struct dm_test_uclass_perdev_priv {
85 * struct dm_test_uclass_priv - private data for test uclass
87 struct dm_test_uclass_priv {
92 * struct dm_test_parent_data - parent's information on each child
94 * @sum: Test value used to check parent data works correctly
95 * @flag: Used to track calling of parent operations
96 * @uclass_flag: Used to track calling of parent operations by uclass
98 struct dm_test_parent_data {
103 /* Test values for test device's uclass platform data */
105 TEST_UC_PDATA_INTVAL1 = 2,
106 TEST_UC_PDATA_INTVAL2 = 334,
107 TEST_UC_PDATA_INTVAL3 = 789452,
111 * struct dm_test_uclass_platda - uclass's information on each device
113 * @intval1: set to TEST_UC_PDATA_INTVAL1 in .post_bind method of test uclass
114 * @intval2: set to TEST_UC_PDATA_INTVAL2 in .post_bind method of test uclass
115 * @intval3: set to TEST_UC_PDATA_INTVAL3 in .post_bind method of test uclass
117 struct dm_test_perdev_uc_pdata {
124 * Operation counts for the test driver, used to check that each method is
127 extern int dm_testdrv_op_count[DM_TEST_OP_COUNT];
129 extern struct unit_test_state global_dm_test_state;
132 * struct dm_test_state - Entire state of dm test system
134 * This is often abreviated to dms.
137 * @testdev: Test device
138 * @force_fail_alloc: Force all memory allocs to fail
139 * @skip_post_probe: Skip uclass post-probe processing
140 * @removed: Used to keep track of a device that was removed
142 struct dm_test_state {
143 struct udevice *root;
144 struct udevice *testdev;
145 int force_fail_alloc;
147 struct udevice *removed;
150 /* Test flags for each test */
152 DM_TESTF_SCAN_PDATA = 1 << 0, /* test needs platform data */
153 DM_TESTF_PROBE_TEST = 1 << 1, /* probe test uclass */
154 DM_TESTF_SCAN_FDT = 1 << 2, /* scan device tree */
155 DM_TESTF_FLAT_TREE = 1 << 3, /* test needs flat DT */
156 DM_TESTF_LIVE_TREE = 1 << 4, /* needs live device tree */
159 /* Declare a new driver model test */
160 #define DM_TEST(_name, _flags) UNIT_TEST(_name, _flags, dm_test)
162 /* This platform data is needed in tests, so declare it here */
163 struct sandbox_sdl_plat {
168 const char *vidconsole_drv_name;
172 /* Declare ping methods for the drivers */
173 int test_ping(struct udevice *dev, int pingval, int *pingret);
174 int testfdt_ping(struct udevice *dev, int pingval, int *pingret);
177 * dm_check_operations() - Check that we can perform ping operations
179 * This checks that the ping operations work as expected for a device
181 * @dms: Overall test state
182 * @dev: Device to test
183 * @base: Base address, used to check ping return value
184 * @priv: Pointer to private test information
185 * @return 0 if OK, -ve on error
187 int dm_check_operations(struct unit_test_state *uts, struct udevice *dev,
188 uint32_t base, struct dm_test_priv *priv);
191 * dm_check_devices() - check the devices respond to operations correctly
193 * @dms: Overall test state
194 * @num_devices: Number of test devices to check
195 * @return 0 if OK, -ve on error
197 int dm_check_devices(struct unit_test_state *uts, int num_devices);
200 * dm_leak_check_start() - Prepare to check for a memory leak
202 * Call this before allocating memory to record the amount of memory being
205 * @dms: Overall test state
207 void dm_leak_check_start(struct unit_test_state *uts);
210 * dm_leak_check_end() - Check that no memory has leaked
212 * Call this after dm_leak_check_start() and after you have hopefuilly freed
213 * all the memory that was allocated. This function will print an error if
214 * it sees a different amount of total memory allocated than before.
216 * @dms: Overall test state
217 */int dm_leak_check_end(struct unit_test_state *uts);