blob: dfbc82c756d001a0d8e3990fa88c03b4c8f59ed2 [file] [log] [blame]
Tom Rini83d290c2018-05-06 17:58:06 -04001/* SPDX-License-Identifier: GPL-2.0+ */
Simon Glass2e7d35d2014-02-26 15:59:21 -07002/*
3 * Copyright (c) 2013 Google, Inc.
Simon Glass2e7d35d2014-02-26 15:59:21 -07004 */
5
6#ifndef __DM_TEST_H
7#define __DM_TEST_H
8
Simon Glass2e7d35d2014-02-26 15:59:21 -07009/**
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 */
15struct 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 */
29struct test_ops {
Heiko Schocher54c5d082014-05-22 12:43:05 +020030 int (*ping)(struct udevice *dev, int pingval, int *pingret);
Simon Glass2e7d35d2014-02-26 15:59:21 -070031};
32
33/* Operations that our test driver supports */
34enum {
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,
Simon Glass02c07b32015-03-05 12:25:22 -070043 DM_TEST_OP_PRE_PROBE,
Simon Glass2e7d35d2014-02-26 15:59:21 -070044 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 */
53enum {
54 DM_TEST_TYPE_FIRST = 0,
55 DM_TEST_TYPE_SECOND,
Simon Glass50162342020-02-06 09:54:50 -070056
57 DM_TEST_TYPE_COUNT,
Simon Glass2e7d35d2014-02-26 15:59:21 -070058};
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 */
66struct dm_test_priv {
67 int ping_total;
68 int op_count[DM_TEST_OP_COUNT];
Simon Glass83c7e432015-01-25 08:27:10 -070069 int uclass_flag;
70 int uclass_total;
Bin Mengd92878a2018-10-15 02:20:58 -070071 int uclass_postp;
Simon Glass2e7d35d2014-02-26 15:59:21 -070072};
73
74/**
75 * struct dm_test_perdev_class_priv - private per-device data for test uclass
76 */
77struct dm_test_uclass_perdev_priv {
78 int base_add;
79};
80
81/**
82 * struct dm_test_uclass_priv - private data for test uclass
83 */
84struct dm_test_uclass_priv {
85 int total_add;
86};
87
Simon Glasse59f4582014-07-23 06:55:20 -060088/**
89 * struct dm_test_parent_data - parent's information on each child
90 *
91 * @sum: Test value used to check parent data works correctly
Simon Glassa327dee2014-07-23 06:55:21 -060092 * @flag: Used to track calling of parent operations
Simon Glass83c7e432015-01-25 08:27:10 -070093 * @uclass_flag: Used to track calling of parent operations by uclass
Simon Glasse59f4582014-07-23 06:55:20 -060094 */
95struct dm_test_parent_data {
96 int sum;
Simon Glassa327dee2014-07-23 06:55:21 -060097 int flag;
Simon Glasse59f4582014-07-23 06:55:20 -060098};
99
Przemyslaw Marczak754e71e2015-04-15 13:07:19 +0200100/* Test values for test device's uclass platform data */
101enum {
102 TEST_UC_PDATA_INTVAL1 = 2,
103 TEST_UC_PDATA_INTVAL2 = 334,
104 TEST_UC_PDATA_INTVAL3 = 789452,
105};
106
107/**
108 * struct dm_test_uclass_platda - uclass's information on each device
109 *
110 * @intval1: set to TEST_UC_PDATA_INTVAL1 in .post_bind method of test uclass
111 * @intval2: set to TEST_UC_PDATA_INTVAL2 in .post_bind method of test uclass
112 * @intval3: set to TEST_UC_PDATA_INTVAL3 in .post_bind method of test uclass
113 */
114struct dm_test_perdev_uc_pdata {
115 int intval1;
116 int intval2;
117 int intval3;
118};
119
Simon Glass2e7d35d2014-02-26 15:59:21 -0700120/*
121 * Operation counts for the test driver, used to check that each method is
122 * called correctly
123 */
124extern int dm_testdrv_op_count[DM_TEST_OP_COUNT];
125
Joe Hershbergere721b882015-05-20 14:27:27 -0500126extern struct unit_test_state global_dm_test_state;
Simon Glass2e7d35d2014-02-26 15:59:21 -0700127
128/*
129 * struct dm_test_state - Entire state of dm test system
130 *
131 * This is often abreviated to dms.
132 *
133 * @root: Root device
134 * @testdev: Test device
Simon Glass2e7d35d2014-02-26 15:59:21 -0700135 * @force_fail_alloc: Force all memory allocs to fail
136 * @skip_post_probe: Skip uclass post-probe processing
137 */
138struct dm_test_state {
Heiko Schocher54c5d082014-05-22 12:43:05 +0200139 struct udevice *root;
140 struct udevice *testdev;
Simon Glass2e7d35d2014-02-26 15:59:21 -0700141 int force_fail_alloc;
142 int skip_post_probe;
143};
144
Simon Glass2e7d35d2014-02-26 15:59:21 -0700145/* Declare a new driver model test */
Simon Glass4bc639e2021-03-07 17:34:45 -0700146#define DM_TEST(_name, _flags) \
147 UNIT_TEST(_name, UT_TESTF_DM | (_flags), dm_test)
Simon Glass2e7d35d2014-02-26 15:59:21 -0700148
Simon Glassef453122020-07-02 21:12:28 -0600149/*
150 * struct sandbox_sdl_plat - Platform data for the SDL video driver
151 *
152 * This platform data is needed in tests, so declare it here
153 *
154 * @xres: Width of display in pixels
155 * @yres: Height of display in pixels
156 * @bpix: Log2 of bits per pixel (enum video_log2_bpp)
157 * @rot: Console rotation (0=normal orientation, 1=90 degrees clockwise,
158 * 2=upside down, 3=90 degree counterclockwise)
159 * @vidconsole_drv_name: Name of video console driver (set by tests)
160 * @font_size: Console font size to select (set by tests)
161 */
Simon Glass3c97c4f2016-01-18 19:52:26 -0700162struct sandbox_sdl_plat {
163 int xres;
164 int yres;
165 int bpix;
166 int rot;
Simon Glass8de536c2016-01-14 18:10:49 -0700167 const char *vidconsole_drv_name;
168 int font_size;
Simon Glass3c97c4f2016-01-18 19:52:26 -0700169};
170
Simon Glass079ac592020-12-23 08:11:18 -0700171/**
172 * struct dm_test_parent_plat - Used to track state in bus tests
173 *
174 * @count:
175 * @bind_flag: Indicates that the child post-bind method was called
176 * @uclass_bind_flag: Also indicates that the child post-bind method was called
177 */
178struct dm_test_parent_plat {
179 int count;
180 int bind_flag;
181 int uclass_bind_flag;
182};
183
184enum {
185 TEST_FLAG_CHILD_PROBED = 10,
186 TEST_FLAG_CHILD_REMOVED = -7,
187};
188
Simon Glass2e7d35d2014-02-26 15:59:21 -0700189/* Declare ping methods for the drivers */
Heiko Schocher54c5d082014-05-22 12:43:05 +0200190int test_ping(struct udevice *dev, int pingval, int *pingret);
191int testfdt_ping(struct udevice *dev, int pingval, int *pingret);
Simon Glass2e7d35d2014-02-26 15:59:21 -0700192
193/**
194 * dm_check_operations() - Check that we can perform ping operations
195 *
196 * This checks that the ping operations work as expected for a device
197 *
198 * @dms: Overall test state
199 * @dev: Device to test
200 * @base: Base address, used to check ping return value
201 * @priv: Pointer to private test information
202 * @return 0 if OK, -ve on error
203 */
Joe Hershbergere721b882015-05-20 14:27:27 -0500204int dm_check_operations(struct unit_test_state *uts, struct udevice *dev,
Simon Glass2e7d35d2014-02-26 15:59:21 -0700205 uint32_t base, struct dm_test_priv *priv);
206
207/**
Simon Glass1ca7e202014-07-23 06:55:18 -0600208 * dm_check_devices() - check the devices respond to operations correctly
209 *
210 * @dms: Overall test state
211 * @num_devices: Number of test devices to check
212 * @return 0 if OK, -ve on error
213 */
Joe Hershbergere721b882015-05-20 14:27:27 -0500214int dm_check_devices(struct unit_test_state *uts, int num_devices);
Simon Glass1ca7e202014-07-23 06:55:18 -0600215
216/**
Simon Glass756ac0b2014-10-04 11:29:50 -0600217 * dm_leak_check_start() - Prepare to check for a memory leak
218 *
219 * Call this before allocating memory to record the amount of memory being
220 * used.
221 *
222 * @dms: Overall test state
223 */
Joe Hershbergere721b882015-05-20 14:27:27 -0500224void dm_leak_check_start(struct unit_test_state *uts);
Simon Glass756ac0b2014-10-04 11:29:50 -0600225
226/**
227 * dm_leak_check_end() - Check that no memory has leaked
228 *
229 * Call this after dm_leak_check_start() and after you have hopefuilly freed
230 * all the memory that was allocated. This function will print an error if
231 * it sees a different amount of total memory allocated than before.
232 *
233 * @dms: Overall test state
Joe Hershbergere721b882015-05-20 14:27:27 -0500234 */int dm_leak_check_end(struct unit_test_state *uts);
Simon Glass756ac0b2014-10-04 11:29:50 -0600235
Simon Glass2e7d35d2014-02-26 15:59:21 -0700236#endif