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 /* struct dm_test_uc_priv - private data for the testdrv uclass */ 77 struct dm_test_uc_priv { 78 int dummy; 79 }; 80 81 /** 82 * struct dm_test_perdev_class_priv - private per-device data for test uclass 83 */ 84 struct dm_test_uclass_perdev_priv { 85 int base_add; 86 }; 87 88 /** 89 * struct dm_test_uclass_priv - private data for test uclass 90 */ 91 struct dm_test_uclass_priv { 92 int total_add; 93 }; 94 95 /** 96 * struct dm_test_parent_data - parent's information on each child 97 * 98 * @sum: Test value used to check parent data works correctly 99 * @flag: Used to track calling of parent operations 100 * @uclass_flag: Used to track calling of parent operations by uclass 101 */ 102 struct dm_test_parent_data { 103 int sum; 104 int flag; 105 }; 106 107 /* Test values for test device's uclass platform data */ 108 enum { 109 TEST_UC_PDATA_INTVAL1 = 2, 110 TEST_UC_PDATA_INTVAL2 = 334, 111 TEST_UC_PDATA_INTVAL3 = 789452, 112 }; 113 114 /** 115 * struct dm_test_uclass_platda - uclass's information on each device 116 * 117 * @intval1: set to TEST_UC_PDATA_INTVAL1 in .post_bind method of test uclass 118 * @intval2: set to TEST_UC_PDATA_INTVAL2 in .post_bind method of test uclass 119 * @intval3: set to TEST_UC_PDATA_INTVAL3 in .post_bind method of test uclass 120 */ 121 struct dm_test_perdev_uc_pdata { 122 int intval1; 123 int intval2; 124 int intval3; 125 }; 126 127 /* 128 * Operation counts for the test driver, used to check that each method is 129 * called correctly 130 */ 131 extern int dm_testdrv_op_count[DM_TEST_OP_COUNT]; 132 133 extern struct unit_test_state global_dm_test_state; 134 135 /* Declare a new driver model test */ 136 #define DM_TEST(_name, _flags) \ 137 UNIT_TEST(_name, UT_TESTF_DM | UT_TESTF_CONSOLE_REC | (_flags), dm_test) 138 139 /* 140 * struct sandbox_sdl_plat - Platform data for the SDL video driver 141 * 142 * This platform data is needed in tests, so declare it here 143 * 144 * @xres: Width of display in pixels 145 * @yres: Height of display in pixels 146 * @bpix: Log2 of bits per pixel (enum video_log2_bpp) 147 * @rot: Console rotation (0=normal orientation, 1=90 degrees clockwise, 148 * 2=upside down, 3=90 degree counterclockwise) 149 * @vidconsole_drv_name: Name of video console driver (set by tests) 150 * @font_size: Console font size to select (set by tests) 151 */ 152 struct sandbox_sdl_plat { 153 int xres; 154 int yres; 155 int bpix; 156 int rot; 157 const char *vidconsole_drv_name; 158 int font_size; 159 }; 160 161 /** 162 * struct dm_test_parent_plat - Used to track state in bus tests 163 * 164 * @count: 165 * @bind_flag: Indicates that the child post-bind method was called 166 * @uclass_bind_flag: Also indicates that the child post-bind method was called 167 */ 168 struct dm_test_parent_plat { 169 int count; 170 int bind_flag; 171 int uclass_bind_flag; 172 }; 173 174 enum { 175 TEST_FLAG_CHILD_PROBED = 10, 176 TEST_FLAG_CHILD_REMOVED = -7, 177 }; 178 179 /* Declare ping methods for the drivers */ 180 int test_ping(struct udevice *dev, int pingval, int *pingret); 181 int testfdt_ping(struct udevice *dev, int pingval, int *pingret); 182 183 /** 184 * dm_check_operations() - Check that we can perform ping operations 185 * 186 * This checks that the ping operations work as expected for a device 187 * 188 * @dms: Overall test state 189 * @dev: Device to test 190 * @base: Base address, used to check ping return value 191 * @priv: Pointer to private test information 192 * @return 0 if OK, -ve on error 193 */ 194 int dm_check_operations(struct unit_test_state *uts, struct udevice *dev, 195 uint32_t base, struct dm_test_priv *priv); 196 197 /** 198 * dm_check_devices() - check the devices respond to operations correctly 199 * 200 * @dms: Overall test state 201 * @num_devices: Number of test devices to check 202 * @return 0 if OK, -ve on error 203 */ 204 int dm_check_devices(struct unit_test_state *uts, int num_devices); 205 206 /** 207 * dm_leak_check_start() - Prepare to check for a memory leak 208 * 209 * Call this before allocating memory to record the amount of memory being 210 * used. 211 * 212 * @dms: Overall test state 213 */ 214 void dm_leak_check_start(struct unit_test_state *uts); 215 216 /** 217 * dm_leak_check_end() - Check that no memory has leaked 218 * 219 * Call this after dm_leak_check_start() and after you have hopefuilly freed 220 * all the memory that was allocated. This function will print an error if 221 * it sees a different amount of total memory allocated than before. 222 * 223 * @dms: Overall test state 224 */int dm_leak_check_end(struct unit_test_state *uts); 225 226 #endif 227