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#include <dm.h> 10#include <test/test.h> 11 12/** 13 * struct dm_test_cdata - configuration data for test instance 14 * 15 * @ping_add: Amonut to add each time we get a ping 16 * @base: Base address of this device 17 */ 18struct dm_test_pdata { 19 int ping_add; 20 uint32_t base; 21}; 22 23/** 24 * struct test_ops - Operations supported by the test device 25 * 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 31 */ 32struct test_ops { 33 int (*ping)(struct udevice *dev, int pingval, int *pingret); 34}; 35 36/* Operations that our test driver supports */ 37enum { 38 DM_TEST_OP_BIND = 0, 39 DM_TEST_OP_UNBIND, 40 DM_TEST_OP_PROBE, 41 DM_TEST_OP_REMOVE, 42 43 /* For uclass */ 44 DM_TEST_OP_POST_BIND, 45 DM_TEST_OP_PRE_UNBIND, 46 DM_TEST_OP_PRE_PROBE, 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 */ 56enum { 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 */ 67struct dm_test_priv { 68 int ping_total; 69 int op_count[DM_TEST_OP_COUNT]; 70 int uclass_flag; 71 int uclass_total; 72 int uclass_postp; 73}; 74 75/** 76 * struct dm_test_perdev_class_priv - private per-device data for test uclass 77 */ 78struct dm_test_uclass_perdev_priv { 79 int base_add; 80}; 81 82/** 83 * struct dm_test_uclass_priv - private data for test uclass 84 */ 85struct dm_test_uclass_priv { 86 int total_add; 87}; 88 89/** 90 * struct dm_test_parent_data - parent's information on each child 91 * 92 * @sum: Test value used to check parent data works correctly 93 * @flag: Used to track calling of parent operations 94 * @uclass_flag: Used to track calling of parent operations by uclass 95 */ 96struct dm_test_parent_data { 97 int sum; 98 int flag; 99}; 100 101/* Test values for test device's uclass platform data */ 102enum { 103 TEST_UC_PDATA_INTVAL1 = 2, 104 TEST_UC_PDATA_INTVAL2 = 334, 105 TEST_UC_PDATA_INTVAL3 = 789452, 106}; 107 108/** 109 * struct dm_test_uclass_platda - uclass's information on each device 110 * 111 * @intval1: set to TEST_UC_PDATA_INTVAL1 in .post_bind method of test uclass 112 * @intval2: set to TEST_UC_PDATA_INTVAL2 in .post_bind method of test uclass 113 * @intval3: set to TEST_UC_PDATA_INTVAL3 in .post_bind method of test uclass 114 */ 115struct dm_test_perdev_uc_pdata { 116 int intval1; 117 int intval2; 118 int intval3; 119}; 120 121/* 122 * Operation counts for the test driver, used to check that each method is 123 * called correctly 124 */ 125extern int dm_testdrv_op_count[DM_TEST_OP_COUNT]; 126 127extern struct unit_test_state global_dm_test_state; 128 129/* 130 * struct dm_test_state - Entire state of dm test system 131 * 132 * This is often abreviated to dms. 133 * 134 * @root: Root device 135 * @testdev: Test device 136 * @force_fail_alloc: Force all memory allocs to fail 137 * @skip_post_probe: Skip uclass post-probe processing 138 * @removed: Used to keep track of a device that was removed 139 */ 140struct dm_test_state { 141 struct udevice *root; 142 struct udevice *testdev; 143 int force_fail_alloc; 144 int skip_post_probe; 145 struct udevice *removed; 146}; 147 148/* Test flags for each test */ 149enum { 150 DM_TESTF_SCAN_PDATA = 1 << 0, /* test needs platform data */ 151 DM_TESTF_PROBE_TEST = 1 << 1, /* probe test uclass */ 152 DM_TESTF_SCAN_FDT = 1 << 2, /* scan device tree */ 153 DM_TESTF_FLAT_TREE = 1 << 3, /* test needs flat DT */ 154 DM_TESTF_LIVE_TREE = 1 << 4, /* needs live device tree */ 155}; 156 157/* Declare a new driver model test */ 158#define DM_TEST(_name, _flags) UNIT_TEST(_name, _flags, dm_test) 159 160/* This platform data is needed in tests, so declare it here */ 161struct sandbox_sdl_plat { 162 int xres; 163 int yres; 164 int bpix; 165 int rot; 166 const char *vidconsole_drv_name; 167 int font_size; 168}; 169 170/* Declare ping methods for the drivers */ 171int test_ping(struct udevice *dev, int pingval, int *pingret); 172int testfdt_ping(struct udevice *dev, int pingval, int *pingret); 173 174/** 175 * dm_check_operations() - Check that we can perform ping operations 176 * 177 * This checks that the ping operations work as expected for a device 178 * 179 * @dms: Overall test state 180 * @dev: Device to test 181 * @base: Base address, used to check ping return value 182 * @priv: Pointer to private test information 183 * @return 0 if OK, -ve on error 184 */ 185int dm_check_operations(struct unit_test_state *uts, struct udevice *dev, 186 uint32_t base, struct dm_test_priv *priv); 187 188/** 189 * dm_check_devices() - check the devices respond to operations correctly 190 * 191 * @dms: Overall test state 192 * @num_devices: Number of test devices to check 193 * @return 0 if OK, -ve on error 194 */ 195int dm_check_devices(struct unit_test_state *uts, int num_devices); 196 197/** 198 * dm_leak_check_start() - Prepare to check for a memory leak 199 * 200 * Call this before allocating memory to record the amount of memory being 201 * used. 202 * 203 * @dms: Overall test state 204 */ 205void dm_leak_check_start(struct unit_test_state *uts); 206 207/** 208 * dm_leak_check_end() - Check that no memory has leaked 209 * 210 * Call this after dm_leak_check_start() and after you have hopefuilly freed 211 * all the memory that was allocated. This function will print an error if 212 * it sees a different amount of total memory allocated than before. 213 * 214 * @dms: Overall test state 215 */int dm_leak_check_end(struct unit_test_state *uts); 216 217#endif 218