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 <malloc.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_POST_PROBE, 48 DM_TEST_OP_PRE_REMOVE, 49 DM_TEST_OP_INIT, 50 DM_TEST_OP_DESTROY, 51 52 DM_TEST_OP_COUNT, 53 }; 54 55 /* Test driver types */ 56 enum { 57 DM_TEST_TYPE_FIRST = 0, 58 DM_TEST_TYPE_SECOND, 59 }; 60 61 /* The number added to the ping total on each probe */ 62 #define DM_TEST_START_TOTAL 5 63 64 /** 65 * struct dm_test_priv - private data for the test devices 66 */ 67 struct dm_test_priv { 68 int ping_total; 69 int op_count[DM_TEST_OP_COUNT]; 70 int uclass_flag; 71 int uclass_total; 72 }; 73 74 /** 75 * struct dm_test_perdev_class_priv - private per-device data for test uclass 76 */ 77 struct dm_test_uclass_perdev_priv { 78 int base_add; 79 }; 80 81 /** 82 * struct dm_test_uclass_priv - private data for test uclass 83 */ 84 struct dm_test_uclass_priv { 85 int total_add; 86 }; 87 88 /** 89 * struct dm_test_parent_data - parent's information on each child 90 * 91 * @sum: Test value used to check parent data works correctly 92 * @flag: Used to track calling of parent operations 93 * @uclass_flag: Used to track calling of parent operations by uclass 94 */ 95 struct dm_test_parent_data { 96 int sum; 97 int flag; 98 }; 99 100 /* 101 * Operation counts for the test driver, used to check that each method is 102 * called correctly 103 */ 104 extern int dm_testdrv_op_count[DM_TEST_OP_COUNT]; 105 106 extern struct dm_test_state global_test_state; 107 108 /* 109 * struct dm_test_state - Entire state of dm test system 110 * 111 * This is often abreviated to dms. 112 * 113 * @root: Root device 114 * @testdev: Test device 115 * @fail_count: Number of tests that failed 116 * @force_fail_alloc: Force all memory allocs to fail 117 * @skip_post_probe: Skip uclass post-probe processing 118 * @removed: Used to keep track of a device that was removed 119 */ 120 struct dm_test_state { 121 struct udevice *root; 122 struct udevice *testdev; 123 int fail_count; 124 int force_fail_alloc; 125 int skip_post_probe; 126 struct udevice *removed; 127 struct mallinfo start; 128 }; 129 130 /* Test flags for each test */ 131 enum { 132 DM_TESTF_SCAN_PDATA = 1 << 0, /* test needs platform data */ 133 DM_TESTF_PROBE_TEST = 1 << 1, /* probe test uclass */ 134 DM_TESTF_SCAN_FDT = 1 << 2, /* scan device tree */ 135 }; 136 137 /** 138 * struct dm_test - Information about a driver model test 139 * 140 * @name: Name of test 141 * @func: Function to call to perform test 142 * @flags: Flags indicated pre-conditions for test 143 */ 144 struct dm_test { 145 const char *name; 146 int (*func)(struct dm_test_state *dms); 147 int flags; 148 }; 149 150 /* Declare a new driver model test */ 151 #define DM_TEST(_name, _flags) \ 152 ll_entry_declare(struct dm_test, _name, dm_test) = { \ 153 .name = #_name, \ 154 .flags = _flags, \ 155 .func = _name, \ 156 } 157 158 /* Declare ping methods for the drivers */ 159 int test_ping(struct udevice *dev, int pingval, int *pingret); 160 int testfdt_ping(struct udevice *dev, int pingval, int *pingret); 161 162 /** 163 * dm_check_operations() - Check that we can perform ping operations 164 * 165 * This checks that the ping operations work as expected for a device 166 * 167 * @dms: Overall test state 168 * @dev: Device to test 169 * @base: Base address, used to check ping return value 170 * @priv: Pointer to private test information 171 * @return 0 if OK, -ve on error 172 */ 173 int dm_check_operations(struct dm_test_state *dms, struct udevice *dev, 174 uint32_t base, struct dm_test_priv *priv); 175 176 /** 177 * dm_check_devices() - check the devices respond to operations correctly 178 * 179 * @dms: Overall test state 180 * @num_devices: Number of test devices to check 181 * @return 0 if OK, -ve on error 182 */ 183 int dm_check_devices(struct dm_test_state *dms, int num_devices); 184 185 /** 186 * dm_leak_check_start() - Prepare to check for a memory leak 187 * 188 * Call this before allocating memory to record the amount of memory being 189 * used. 190 * 191 * @dms: Overall test state 192 */ 193 void dm_leak_check_start(struct dm_test_state *dms); 194 195 /** 196 * dm_leak_check_end() - Check that no memory has leaked 197 * 198 * Call this after dm_leak_check_start() and after you have hopefuilly freed 199 * all the memory that was allocated. This function will print an error if 200 * it sees a different amount of total memory allocated than before. 201 * 202 * @dms: Overall test state 203 */int dm_leak_check_end(struct dm_test_state *dms); 204 205 206 /** 207 * dm_test_main() - Run all the tests 208 * 209 * This runs all available driver model tests 210 * 211 * @return 0 if OK, -ve on error 212 */ 213 int dm_test_main(void); 214 215 #endif 216