include/dm/test.h

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