test.h 5.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219
  1. /* SPDX-License-Identifier: GPL-2.0+ */
  2. /*
  3. * Copyright (c) 2013 Google, Inc.
  4. */
  5. #ifndef __DM_TEST_H
  6. #define __DM_TEST_H
  7. #include <dm.h>
  8. #include <test/test.h>
  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. * struct test_ops - Operations supported by the test device
  21. *
  22. * @ping: Ping operation
  23. * @dev: Device to operate on
  24. * @pingval: Value to ping the device with
  25. * @pingret: Returns resulting value from driver
  26. * @return 0 if OK, -ve on error
  27. */
  28. struct test_ops {
  29. int (*ping)(struct udevice *dev, int pingval, int *pingret);
  30. };
  31. /* Operations that our test driver supports */
  32. enum {
  33. DM_TEST_OP_BIND = 0,
  34. DM_TEST_OP_UNBIND,
  35. DM_TEST_OP_PROBE,
  36. DM_TEST_OP_REMOVE,
  37. /* For uclass */
  38. DM_TEST_OP_POST_BIND,
  39. DM_TEST_OP_PRE_UNBIND,
  40. DM_TEST_OP_PRE_PROBE,
  41. DM_TEST_OP_POST_PROBE,
  42. DM_TEST_OP_PRE_REMOVE,
  43. DM_TEST_OP_INIT,
  44. DM_TEST_OP_DESTROY,
  45. DM_TEST_OP_COUNT,
  46. };
  47. /* Test driver types */
  48. enum {
  49. DM_TEST_TYPE_FIRST = 0,
  50. DM_TEST_TYPE_SECOND,
  51. DM_TEST_TYPE_COUNT,
  52. };
  53. /* The number added to the ping total on each probe */
  54. #define DM_TEST_START_TOTAL 5
  55. /**
  56. * struct dm_test_priv - private data for the test devices
  57. */
  58. struct dm_test_priv {
  59. int ping_total;
  60. int op_count[DM_TEST_OP_COUNT];
  61. int uclass_flag;
  62. int uclass_total;
  63. int uclass_postp;
  64. };
  65. /**
  66. * struct dm_test_perdev_class_priv - private per-device data for test uclass
  67. */
  68. struct dm_test_uclass_perdev_priv {
  69. int base_add;
  70. };
  71. /**
  72. * struct dm_test_uclass_priv - private data for test uclass
  73. */
  74. struct dm_test_uclass_priv {
  75. int total_add;
  76. };
  77. /**
  78. * struct dm_test_parent_data - parent's information on each child
  79. *
  80. * @sum: Test value used to check parent data works correctly
  81. * @flag: Used to track calling of parent operations
  82. * @uclass_flag: Used to track calling of parent operations by uclass
  83. */
  84. struct dm_test_parent_data {
  85. int sum;
  86. int flag;
  87. };
  88. /* Test values for test device's uclass platform data */
  89. enum {
  90. TEST_UC_PDATA_INTVAL1 = 2,
  91. TEST_UC_PDATA_INTVAL2 = 334,
  92. TEST_UC_PDATA_INTVAL3 = 789452,
  93. };
  94. /**
  95. * struct dm_test_uclass_platda - uclass's information on each device
  96. *
  97. * @intval1: set to TEST_UC_PDATA_INTVAL1 in .post_bind method of test uclass
  98. * @intval2: set to TEST_UC_PDATA_INTVAL2 in .post_bind method of test uclass
  99. * @intval3: set to TEST_UC_PDATA_INTVAL3 in .post_bind method of test uclass
  100. */
  101. struct dm_test_perdev_uc_pdata {
  102. int intval1;
  103. int intval2;
  104. int intval3;
  105. };
  106. /*
  107. * Operation counts for the test driver, used to check that each method is
  108. * called correctly
  109. */
  110. extern int dm_testdrv_op_count[DM_TEST_OP_COUNT];
  111. extern struct unit_test_state global_dm_test_state;
  112. /*
  113. * struct dm_test_state - Entire state of dm test system
  114. *
  115. * This is often abreviated to dms.
  116. *
  117. * @root: Root device
  118. * @testdev: Test device
  119. * @force_fail_alloc: Force all memory allocs to fail
  120. * @skip_post_probe: Skip uclass post-probe processing
  121. * @removed: Used to keep track of a device that was removed
  122. */
  123. struct dm_test_state {
  124. struct udevice *root;
  125. struct udevice *testdev;
  126. int force_fail_alloc;
  127. int skip_post_probe;
  128. struct udevice *removed;
  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. DM_TESTF_FLAT_TREE = 1 << 3, /* test needs flat DT */
  136. DM_TESTF_LIVE_TREE = 1 << 4, /* needs live device tree */
  137. };
  138. /* Declare a new driver model test */
  139. #define DM_TEST(_name, _flags) UNIT_TEST(_name, _flags, dm_test)
  140. /* This platform data is needed in tests, so declare it here */
  141. struct sandbox_sdl_plat {
  142. int xres;
  143. int yres;
  144. int bpix;
  145. int rot;
  146. const char *vidconsole_drv_name;
  147. int font_size;
  148. };
  149. /* Declare ping methods for the drivers */
  150. int test_ping(struct udevice *dev, int pingval, int *pingret);
  151. int testfdt_ping(struct udevice *dev, int pingval, int *pingret);
  152. /**
  153. * dm_check_operations() - Check that we can perform ping operations
  154. *
  155. * This checks that the ping operations work as expected for a device
  156. *
  157. * @dms: Overall test state
  158. * @dev: Device to test
  159. * @base: Base address, used to check ping return value
  160. * @priv: Pointer to private test information
  161. * @return 0 if OK, -ve on error
  162. */
  163. int dm_check_operations(struct unit_test_state *uts, struct udevice *dev,
  164. uint32_t base, struct dm_test_priv *priv);
  165. /**
  166. * dm_check_devices() - check the devices respond to operations correctly
  167. *
  168. * @dms: Overall test state
  169. * @num_devices: Number of test devices to check
  170. * @return 0 if OK, -ve on error
  171. */
  172. int dm_check_devices(struct unit_test_state *uts, int num_devices);
  173. /**
  174. * dm_leak_check_start() - Prepare to check for a memory leak
  175. *
  176. * Call this before allocating memory to record the amount of memory being
  177. * used.
  178. *
  179. * @dms: Overall test state
  180. */
  181. void dm_leak_check_start(struct unit_test_state *uts);
  182. /**
  183. * dm_leak_check_end() - Check that no memory has leaked
  184. *
  185. * Call this after dm_leak_check_start() and after you have hopefuilly freed
  186. * all the memory that was allocated. This function will print an error if
  187. * it sees a different amount of total memory allocated than before.
  188. *
  189. * @dms: Overall test state
  190. */int dm_leak_check_end(struct unit_test_state *uts);
  191. #endif