1 /* SPDX-License-Identifier: GPL-2.0+ */ 2 /* 3 * Copyright (c) 2013 Google, Inc. 4 */ 5 6 #ifndef __DM_TEST_H 7 #define __DM_TEST_H 8 9 struct udevice; 10 11 /** 12 * struct dm_test_cdata - configuration data for test instance 13 * 14 * @ping_add: Amonut to add each time we get a ping 15 * @base: Base address of this device 16 */ 17 struct dm_test_pdata { 18 int ping_add; 19 uint32_t base; 20 }; 21 22 /** 23 * struct test_ops - Operations supported by the test device 24 * 25 * @ping: Ping operation 26 * @dev: Device to operate on 27 * @pingval: Value to ping the device with 28 * @pingret: Returns resulting value from driver 29 * @return 0 if OK, -ve on error 30 */ 31 struct test_ops { 32 int (*ping)(struct udevice *dev, int pingval, int *pingret); 33 }; 34 35 /* Operations that our test driver supports */ 36 enum { 37 DM_TEST_OP_BIND = 0, 38 DM_TEST_OP_UNBIND, 39 DM_TEST_OP_PROBE, 40 DM_TEST_OP_REMOVE, 41 42 /* For uclass */ 43 DM_TEST_OP_POST_BIND, 44 DM_TEST_OP_PRE_UNBIND, 45 DM_TEST_OP_PRE_PROBE, 46 DM_TEST_OP_POST_PROBE, 47 DM_TEST_OP_PRE_REMOVE, 48 DM_TEST_OP_INIT, 49 DM_TEST_OP_DESTROY, 50 51 DM_TEST_OP_COUNT, 52 }; 53 54 /* Test driver types */ 55 enum { 56 DM_TEST_TYPE_FIRST = 0, 57 DM_TEST_TYPE_SECOND, 58 59 DM_TEST_TYPE_COUNT, 60 }; 61 62 /* The number added to the ping total on each probe */ 63 #define DM_TEST_START_TOTAL 5 64 65 /** 66 * struct dm_test_priv - private data for the test devices 67 */ 68 struct dm_test_priv { 69 int ping_total; 70 int op_count[DM_TEST_OP_COUNT]; 71 int uclass_flag; 72 int uclass_total; 73 int uclass_postp; 74 }; 75 76 /** 77 * struct dm_test_perdev_class_priv - private per-device data for test uclass 78 */ 79 struct dm_test_uclass_perdev_priv { 80 int base_add; 81 }; 82 83 /** 84 * struct dm_test_uclass_priv - private data for test uclass 85 */ 86 struct dm_test_uclass_priv { 87 int total_add; 88 }; 89 90 /** 91 * struct dm_test_parent_data - parent's information on each child 92 * 93 * @sum: Test value used to check parent data works correctly 94 * @flag: Used to track calling of parent operations 95 * @uclass_flag: Used to track calling of parent operations by uclass 96 */ 97 struct dm_test_parent_data { 98 int sum; 99 int flag; 100 }; 101 102 /* Test values for test device's uclass platform data */ 103 enum { 104 TEST_UC_PDATA_INTVAL1 = 2, 105 TEST_UC_PDATA_INTVAL2 = 334, 106 TEST_UC_PDATA_INTVAL3 = 789452, 107 }; 108 109 /** 110 * struct dm_test_uclass_platda - uclass's information on each device 111 * 112 * @intval1: set to TEST_UC_PDATA_INTVAL1 in .post_bind method of test uclass 113 * @intval2: set to TEST_UC_PDATA_INTVAL2 in .post_bind method of test uclass 114 * @intval3: set to TEST_UC_PDATA_INTVAL3 in .post_bind method of test uclass 115 */ 116 struct dm_test_perdev_uc_pdata { 117 int intval1; 118 int intval2; 119 int intval3; 120 }; 121 122 /* 123 * Operation counts for the test driver, used to check that each method is 124 * called correctly 125 */ 126 extern int dm_testdrv_op_count[DM_TEST_OP_COUNT]; 127 128 extern struct unit_test_state global_dm_test_state; 129 130 /* 131 * struct dm_test_state - Entire state of dm test system 132 * 133 * This is often abreviated to dms. 134 * 135 * @root: Root device 136 * @testdev: Test device 137 * @force_fail_alloc: Force all memory allocs to fail 138 * @skip_post_probe: Skip uclass post-probe processing 139 */ 140 struct dm_test_state { 141 struct udevice *root; 142 struct udevice *testdev; 143 int force_fail_alloc; 144 int skip_post_probe; 145 }; 146 147 /* Declare a new driver model test */ 148 #define DM_TEST(_name, _flags) UNIT_TEST(_name, _flags, dm_test) 149 150 /* 151 * struct sandbox_sdl_plat - Platform data for the SDL video driver 152 * 153 * This platform data is needed in tests, so declare it here 154 * 155 * @xres: Width of display in pixels 156 * @yres: Height of display in pixels 157 * @bpix: Log2 of bits per pixel (enum video_log2_bpp) 158 * @rot: Console rotation (0=normal orientation, 1=90 degrees clockwise, 159 * 2=upside down, 3=90 degree counterclockwise) 160 * @vidconsole_drv_name: Name of video console driver (set by tests) 161 * @font_size: Console font size to select (set by tests) 162 */ 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 /** 173 * struct dm_test_parent_plat - Used to track state in bus tests 174 * 175 * @count: 176 * @bind_flag: Indicates that the child post-bind method was called 177 * @uclass_bind_flag: Also indicates that the child post-bind method was called 178 */ 179 struct dm_test_parent_plat { 180 int count; 181 int bind_flag; 182 int uclass_bind_flag; 183 }; 184 185 enum { 186 TEST_FLAG_CHILD_PROBED = 10, 187 TEST_FLAG_CHILD_REMOVED = -7, 188 }; 189 190 /* Declare ping methods for the drivers */ 191 int test_ping(struct udevice *dev, int pingval, int *pingret); 192 int testfdt_ping(struct udevice *dev, int pingval, int *pingret); 193 194 /** 195 * dm_check_operations() - Check that we can perform ping operations 196 * 197 * This checks that the ping operations work as expected for a device 198 * 199 * @dms: Overall test state 200 * @dev: Device to test 201 * @base: Base address, used to check ping return value 202 * @priv: Pointer to private test information 203 * @return 0 if OK, -ve on error 204 */ 205 int dm_check_operations(struct unit_test_state *uts, struct udevice *dev, 206 uint32_t base, struct dm_test_priv *priv); 207 208 /** 209 * dm_check_devices() - check the devices respond to operations correctly 210 * 211 * @dms: Overall test state 212 * @num_devices: Number of test devices to check 213 * @return 0 if OK, -ve on error 214 */ 215 int dm_check_devices(struct unit_test_state *uts, int num_devices); 216 217 /** 218 * dm_leak_check_start() - Prepare to check for a memory leak 219 * 220 * Call this before allocating memory to record the amount of memory being 221 * used. 222 * 223 * @dms: Overall test state 224 */ 225 void dm_leak_check_start(struct unit_test_state *uts); 226 227 /** 228 * dm_leak_check_end() - Check that no memory has leaked 229 * 230 * Call this after dm_leak_check_start() and after you have hopefuilly freed 231 * all the memory that was allocated. This function will print an error if 232 * it sees a different amount of total memory allocated than before. 233 * 234 * @dms: Overall test state 235 */int dm_leak_check_end(struct unit_test_state *uts); 236 237 #endif 238