include/dm/test.h

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