1 /* 2 * Copyright (c) 2013 Google, Inc. 3 * 4 * SPDX-License-Identifier: GPL-2.0+ 5 */ 6 7 #ifndef __DM_TEST_H 8 #define __DM_TEST_H 9 10 #include <dm.h> 11 #include <test/test.h> 12 13 /** 14 * struct dm_test_cdata - configuration data for test instance 15 * 16 * @ping_add: Amonut to add each time we get a ping 17 * @base: Base address of this device 18 */ 19 struct dm_test_pdata { 20 int ping_add; 21 uint32_t base; 22 }; 23 24 /** 25 * struct test_ops - Operations supported by the test device 26 * 27 * @ping: Ping operation 28 * @dev: Device to operate on 29 * @pingval: Value to ping the device with 30 * @pingret: Returns resulting value from driver 31 * @return 0 if OK, -ve on error 32 */ 33 struct test_ops { 34 int (*ping)(struct udevice *dev, int pingval, int *pingret); 35 }; 36 37 /* Operations that our test driver supports */ 38 enum { 39 DM_TEST_OP_BIND = 0, 40 DM_TEST_OP_UNBIND, 41 DM_TEST_OP_PROBE, 42 DM_TEST_OP_REMOVE, 43 44 /* For uclass */ 45 DM_TEST_OP_POST_BIND, 46 DM_TEST_OP_PRE_UNBIND, 47 DM_TEST_OP_PRE_PROBE, 48 DM_TEST_OP_POST_PROBE, 49 DM_TEST_OP_PRE_REMOVE, 50 DM_TEST_OP_INIT, 51 DM_TEST_OP_DESTROY, 52 53 DM_TEST_OP_COUNT, 54 }; 55 56 /* Test driver types */ 57 enum { 58 DM_TEST_TYPE_FIRST = 0, 59 DM_TEST_TYPE_SECOND, 60 61 DM_TEST_TYPE_COUNT, 62 }; 63 64 /* The number added to the ping total on each probe */ 65 #define DM_TEST_START_TOTAL 5 66 67 /** 68 * struct dm_test_priv - private data for the test devices 69 */ 70 struct dm_test_priv { 71 int ping_total; 72 int op_count[DM_TEST_OP_COUNT]; 73 int uclass_flag; 74 int uclass_total; 75 }; 76 77 /** 78 * struct dm_test_perdev_class_priv - private per-device data for test uclass 79 */ 80 struct dm_test_uclass_perdev_priv { 81 int base_add; 82 }; 83 84 /** 85 * struct dm_test_uclass_priv - private data for test uclass 86 */ 87 struct dm_test_uclass_priv { 88 int total_add; 89 }; 90 91 /** 92 * struct dm_test_parent_data - parent's information on each child 93 * 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 97 */ 98 struct dm_test_parent_data { 99 int sum; 100 int flag; 101 }; 102 103 /* Test values for test device's uclass platform data */ 104 enum { 105 TEST_UC_PDATA_INTVAL1 = 2, 106 TEST_UC_PDATA_INTVAL2 = 334, 107 TEST_UC_PDATA_INTVAL3 = 789452, 108 }; 109 110 /** 111 * struct dm_test_uclass_platda - uclass's information on each device 112 * 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 116 */ 117 struct dm_test_perdev_uc_pdata { 118 int intval1; 119 int intval2; 120 int intval3; 121 }; 122 123 /* 124 * Operation counts for the test driver, used to check that each method is 125 * called correctly 126 */ 127 extern int dm_testdrv_op_count[DM_TEST_OP_COUNT]; 128 129 extern struct unit_test_state global_dm_test_state; 130 131 /* 132 * struct dm_test_state - Entire state of dm test system 133 * 134 * This is often abreviated to dms. 135 * 136 * @root: Root device 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 141 */ 142 struct dm_test_state { 143 struct udevice *root; 144 struct udevice *testdev; 145 int force_fail_alloc; 146 int skip_post_probe; 147 struct udevice *removed; 148 }; 149 150 /* Test flags for each test */ 151 enum { 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 */ 157 }; 158 159 /* Declare a new driver model test */ 160 #define DM_TEST(_name, _flags) UNIT_TEST(_name, _flags, dm_test) 161 162 /* This platform data is needed in tests, so declare it here */ 163 struct sandbox_sdl_plat { 164 int xres; 165 int yres; 166 int bpix; 167 int rot; 168 const char *vidconsole_drv_name; 169 int font_size; 170 }; 171 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); 175 176 /** 177 * dm_check_operations() - Check that we can perform ping operations 178 * 179 * This checks that the ping operations work as expected for a device 180 * 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 186 */ 187 int dm_check_operations(struct unit_test_state *uts, struct udevice *dev, 188 uint32_t base, struct dm_test_priv *priv); 189 190 /** 191 * dm_check_devices() - check the devices respond to operations correctly 192 * 193 * @dms: Overall test state 194 * @num_devices: Number of test devices to check 195 * @return 0 if OK, -ve on error 196 */ 197 int dm_check_devices(struct unit_test_state *uts, int num_devices); 198 199 /** 200 * dm_leak_check_start() - Prepare to check for a memory leak 201 * 202 * Call this before allocating memory to record the amount of memory being 203 * used. 204 * 205 * @dms: Overall test state 206 */ 207 void dm_leak_check_start(struct unit_test_state *uts); 208 209 /** 210 * dm_leak_check_end() - Check that no memory has leaked 211 * 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. 215 * 216 * @dms: Overall test state 217 */int dm_leak_check_end(struct unit_test_state *uts); 218 219 #endif 220