blob: f0f36624ce3b68906c3f3f692b0b8dda43d65bc0 [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
9#include <dm.h>
Joe Hershbergere721b882015-05-20 14:27:27 -050010#include <test/test.h>
Simon Glass2e7d35d2014-02-26 15:59:21 -070011
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 {
Heiko Schocher54c5d082014-05-22 12:43:05 +020033 int (*ping)(struct udevice *dev, int pingval, int *pingret);
Simon Glass2e7d35d2014-02-26 15:59:21 -070034};
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,
Simon Glass02c07b32015-03-05 12:25:22 -070046 DM_TEST_OP_PRE_PROBE,
Simon Glass2e7d35d2014-02-26 15:59:21 -070047 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,
Simon Glass50162342020-02-06 09:54:50 -070059
60 DM_TEST_TYPE_COUNT,
Simon Glass2e7d35d2014-02-26 15:59:21 -070061};
62
63/* The number added to the ping total on each probe */
64#define DM_TEST_START_TOTAL 5
65
66/**
67 * struct dm_test_priv - private data for the test devices
68 */
69struct dm_test_priv {
70 int ping_total;
71 int op_count[DM_TEST_OP_COUNT];
Simon Glass83c7e432015-01-25 08:27:10 -070072 int uclass_flag;
73 int uclass_total;
Bin Mengd92878a2018-10-15 02:20:58 -070074 int uclass_postp;
Simon Glass2e7d35d2014-02-26 15:59:21 -070075};
76
77/**
78 * struct dm_test_perdev_class_priv - private per-device data for test uclass
79 */
80struct dm_test_uclass_perdev_priv {
81 int base_add;
82};
83
84/**
85 * struct dm_test_uclass_priv - private data for test uclass
86 */
87struct dm_test_uclass_priv {
88 int total_add;
89};
90
Simon Glasse59f4582014-07-23 06:55:20 -060091/**
92 * struct dm_test_parent_data - parent's information on each child
93 *
94 * @sum: Test value used to check parent data works correctly
Simon Glassa327dee2014-07-23 06:55:21 -060095 * @flag: Used to track calling of parent operations
Simon Glass83c7e432015-01-25 08:27:10 -070096 * @uclass_flag: Used to track calling of parent operations by uclass
Simon Glasse59f4582014-07-23 06:55:20 -060097 */
98struct dm_test_parent_data {
99 int sum;
Simon Glassa327dee2014-07-23 06:55:21 -0600100 int flag;
Simon Glasse59f4582014-07-23 06:55:20 -0600101};
102
Przemyslaw Marczak754e71e2015-04-15 13:07:19 +0200103/* Test values for test device's uclass platform data */
104enum {
105 TEST_UC_PDATA_INTVAL1 = 2,
106 TEST_UC_PDATA_INTVAL2 = 334,
107 TEST_UC_PDATA_INTVAL3 = 789452,
108};
109
110/**
111 * struct dm_test_uclass_platda - uclass's information on each device
112 *
113 * @intval1: set to TEST_UC_PDATA_INTVAL1 in .post_bind method of test uclass
114 * @intval2: set to TEST_UC_PDATA_INTVAL2 in .post_bind method of test uclass
115 * @intval3: set to TEST_UC_PDATA_INTVAL3 in .post_bind method of test uclass
116 */
117struct dm_test_perdev_uc_pdata {
118 int intval1;
119 int intval2;
120 int intval3;
121};
122
Simon Glass2e7d35d2014-02-26 15:59:21 -0700123/*
124 * Operation counts for the test driver, used to check that each method is
125 * called correctly
126 */
127extern int dm_testdrv_op_count[DM_TEST_OP_COUNT];
128
Joe Hershbergere721b882015-05-20 14:27:27 -0500129extern struct unit_test_state global_dm_test_state;
Simon Glass2e7d35d2014-02-26 15:59:21 -0700130
131/*
132 * struct dm_test_state - Entire state of dm test system
133 *
134 * This is often abreviated to dms.
135 *
136 * @root: Root device
137 * @testdev: Test device
Simon Glass2e7d35d2014-02-26 15:59:21 -0700138 * @force_fail_alloc: Force all memory allocs to fail
139 * @skip_post_probe: Skip uclass post-probe processing
Simon Glassa327dee2014-07-23 06:55:21 -0600140 * @removed: Used to keep track of a device that was removed
Simon Glass2e7d35d2014-02-26 15:59:21 -0700141 */
142struct dm_test_state {
Heiko Schocher54c5d082014-05-22 12:43:05 +0200143 struct udevice *root;
144 struct udevice *testdev;
Simon Glass2e7d35d2014-02-26 15:59:21 -0700145 int force_fail_alloc;
146 int skip_post_probe;
Simon Glassa327dee2014-07-23 06:55:21 -0600147 struct udevice *removed;
Simon Glass2e7d35d2014-02-26 15:59:21 -0700148};
149
150/* Test flags for each test */
151enum {
152 DM_TESTF_SCAN_PDATA = 1 << 0, /* test needs platform data */
153 DM_TESTF_PROBE_TEST = 1 << 1, /* probe test uclass */
154 DM_TESTF_SCAN_FDT = 1 << 2, /* scan device tree */
Simon Glass6fb2f572017-05-18 20:09:17 -0600155 DM_TESTF_FLAT_TREE = 1 << 3, /* test needs flat DT */
156 DM_TESTF_LIVE_TREE = 1 << 4, /* needs live device tree */
Simon Glass2e7d35d2014-02-26 15:59:21 -0700157};
158
Simon Glass2e7d35d2014-02-26 15:59:21 -0700159/* Declare a new driver model test */
Joe Hershbergere721b882015-05-20 14:27:27 -0500160#define DM_TEST(_name, _flags) UNIT_TEST(_name, _flags, dm_test)
Simon Glass2e7d35d2014-02-26 15:59:21 -0700161
Simon Glass3c97c4f2016-01-18 19:52:26 -0700162/* This platform data is needed in tests, so declare it here */
163struct sandbox_sdl_plat {
164 int xres;
165 int yres;
166 int bpix;
167 int rot;
Simon Glass8de536c2016-01-14 18:10:49 -0700168 const char *vidconsole_drv_name;
169 int font_size;
Simon Glass3c97c4f2016-01-18 19:52:26 -0700170};
171
Simon Glass2e7d35d2014-02-26 15:59:21 -0700172/* Declare ping methods for the drivers */
Heiko Schocher54c5d082014-05-22 12:43:05 +0200173int test_ping(struct udevice *dev, int pingval, int *pingret);
174int testfdt_ping(struct udevice *dev, int pingval, int *pingret);
Simon Glass2e7d35d2014-02-26 15:59:21 -0700175
176/**
177 * dm_check_operations() - Check that we can perform ping operations
178 *
179 * This checks that the ping operations work as expected for a device
180 *
181 * @dms: Overall test state
182 * @dev: Device to test
183 * @base: Base address, used to check ping return value
184 * @priv: Pointer to private test information
185 * @return 0 if OK, -ve on error
186 */
Joe Hershbergere721b882015-05-20 14:27:27 -0500187int dm_check_operations(struct unit_test_state *uts, struct udevice *dev,
Simon Glass2e7d35d2014-02-26 15:59:21 -0700188 uint32_t base, struct dm_test_priv *priv);
189
190/**
Simon Glass1ca7e202014-07-23 06:55:18 -0600191 * dm_check_devices() - check the devices respond to operations correctly
192 *
193 * @dms: Overall test state
194 * @num_devices: Number of test devices to check
195 * @return 0 if OK, -ve on error
196 */
Joe Hershbergere721b882015-05-20 14:27:27 -0500197int dm_check_devices(struct unit_test_state *uts, int num_devices);
Simon Glass1ca7e202014-07-23 06:55:18 -0600198
199/**
Simon Glass756ac0b2014-10-04 11:29:50 -0600200 * dm_leak_check_start() - Prepare to check for a memory leak
201 *
202 * Call this before allocating memory to record the amount of memory being
203 * used.
204 *
205 * @dms: Overall test state
206 */
Joe Hershbergere721b882015-05-20 14:27:27 -0500207void dm_leak_check_start(struct unit_test_state *uts);
Simon Glass756ac0b2014-10-04 11:29:50 -0600208
209/**
210 * dm_leak_check_end() - Check that no memory has leaked
211 *
212 * Call this after dm_leak_check_start() and after you have hopefuilly freed
213 * all the memory that was allocated. This function will print an error if
214 * it sees a different amount of total memory allocated than before.
215 *
216 * @dms: Overall test state
Joe Hershbergere721b882015-05-20 14:27:27 -0500217 */int dm_leak_check_end(struct unit_test_state *uts);
Simon Glass756ac0b2014-10-04 11:29:50 -0600218
Simon Glass2e7d35d2014-02-26 15:59:21 -0700219#endif