blob: ca924d9237b586f9072917d980c42b1b1311d99a [file] [log] [blame]
Simon Glass2e7d35d2014-02-26 15:59:21 -07001/*
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>
Joe Hershbergere721b882015-05-20 14:27:27 -050011#include <test/test.h>
Simon Glass2e7d35d2014-02-26 15:59:21 -070012
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 */
19struct 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 */
33struct test_ops {
Heiko Schocher54c5d082014-05-22 12:43:05 +020034 int (*ping)(struct udevice *dev, int pingval, int *pingret);
Simon Glass2e7d35d2014-02-26 15:59:21 -070035};
36
37/* Operations that our test driver supports */
38enum {
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,
Simon Glass02c07b32015-03-05 12:25:22 -070047 DM_TEST_OP_PRE_PROBE,
Simon Glass2e7d35d2014-02-26 15:59:21 -070048 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 */
57enum {
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 */
68struct dm_test_priv {
69 int ping_total;
70 int op_count[DM_TEST_OP_COUNT];
Simon Glass83c7e432015-01-25 08:27:10 -070071 int uclass_flag;
72 int uclass_total;
Simon Glass2e7d35d2014-02-26 15:59:21 -070073};
74
75/**
76 * struct dm_test_perdev_class_priv - private per-device data for test uclass
77 */
78struct dm_test_uclass_perdev_priv {
79 int base_add;
80};
81
82/**
83 * struct dm_test_uclass_priv - private data for test uclass
84 */
85struct dm_test_uclass_priv {
86 int total_add;
87};
88
Simon Glasse59f4582014-07-23 06:55:20 -060089/**
90 * struct dm_test_parent_data - parent's information on each child
91 *
92 * @sum: Test value used to check parent data works correctly
Simon Glassa327dee2014-07-23 06:55:21 -060093 * @flag: Used to track calling of parent operations
Simon Glass83c7e432015-01-25 08:27:10 -070094 * @uclass_flag: Used to track calling of parent operations by uclass
Simon Glasse59f4582014-07-23 06:55:20 -060095 */
96struct dm_test_parent_data {
97 int sum;
Simon Glassa327dee2014-07-23 06:55:21 -060098 int flag;
Simon Glasse59f4582014-07-23 06:55:20 -060099};
100
Przemyslaw Marczak754e71e2015-04-15 13:07:19 +0200101/* Test values for test device's uclass platform data */
102enum {
103 TEST_UC_PDATA_INTVAL1 = 2,
104 TEST_UC_PDATA_INTVAL2 = 334,
105 TEST_UC_PDATA_INTVAL3 = 789452,
106};
107
108/**
109 * struct dm_test_uclass_platda - uclass's information on each device
110 *
111 * @intval1: set to TEST_UC_PDATA_INTVAL1 in .post_bind method of test uclass
112 * @intval2: set to TEST_UC_PDATA_INTVAL2 in .post_bind method of test uclass
113 * @intval3: set to TEST_UC_PDATA_INTVAL3 in .post_bind method of test uclass
114 */
115struct dm_test_perdev_uc_pdata {
116 int intval1;
117 int intval2;
118 int intval3;
119};
120
Simon Glass2e7d35d2014-02-26 15:59:21 -0700121/*
122 * Operation counts for the test driver, used to check that each method is
123 * called correctly
124 */
125extern int dm_testdrv_op_count[DM_TEST_OP_COUNT];
126
Joe Hershbergere721b882015-05-20 14:27:27 -0500127extern struct unit_test_state global_dm_test_state;
Simon Glass2e7d35d2014-02-26 15:59:21 -0700128
129/*
130 * struct dm_test_state - Entire state of dm test system
131 *
132 * This is often abreviated to dms.
133 *
134 * @root: Root device
135 * @testdev: Test device
Simon Glass2e7d35d2014-02-26 15:59:21 -0700136 * @force_fail_alloc: Force all memory allocs to fail
137 * @skip_post_probe: Skip uclass post-probe processing
Simon Glassa327dee2014-07-23 06:55:21 -0600138 * @removed: Used to keep track of a device that was removed
Simon Glass2e7d35d2014-02-26 15:59:21 -0700139 */
140struct dm_test_state {
Heiko Schocher54c5d082014-05-22 12:43:05 +0200141 struct udevice *root;
142 struct udevice *testdev;
Simon Glass2e7d35d2014-02-26 15:59:21 -0700143 int force_fail_alloc;
144 int skip_post_probe;
Simon Glassa327dee2014-07-23 06:55:21 -0600145 struct udevice *removed;
Simon Glass2e7d35d2014-02-26 15:59:21 -0700146};
147
148/* Test flags for each test */
149enum {
150 DM_TESTF_SCAN_PDATA = 1 << 0, /* test needs platform data */
151 DM_TESTF_PROBE_TEST = 1 << 1, /* probe test uclass */
152 DM_TESTF_SCAN_FDT = 1 << 2, /* scan device tree */
153};
154
Simon Glass2e7d35d2014-02-26 15:59:21 -0700155/* Declare a new driver model test */
Joe Hershbergere721b882015-05-20 14:27:27 -0500156#define DM_TEST(_name, _flags) UNIT_TEST(_name, _flags, dm_test)
Simon Glass2e7d35d2014-02-26 15:59:21 -0700157
Simon Glass3c97c4f2016-01-18 19:52:26 -0700158/* This platform data is needed in tests, so declare it here */
159struct sandbox_sdl_plat {
160 int xres;
161 int yres;
162 int bpix;
163 int rot;
164};
165
Simon Glass2e7d35d2014-02-26 15:59:21 -0700166/* Declare ping methods for the drivers */
Heiko Schocher54c5d082014-05-22 12:43:05 +0200167int test_ping(struct udevice *dev, int pingval, int *pingret);
168int testfdt_ping(struct udevice *dev, int pingval, int *pingret);
Simon Glass2e7d35d2014-02-26 15:59:21 -0700169
170/**
171 * dm_check_operations() - Check that we can perform ping operations
172 *
173 * This checks that the ping operations work as expected for a device
174 *
175 * @dms: Overall test state
176 * @dev: Device to test
177 * @base: Base address, used to check ping return value
178 * @priv: Pointer to private test information
179 * @return 0 if OK, -ve on error
180 */
Joe Hershbergere721b882015-05-20 14:27:27 -0500181int dm_check_operations(struct unit_test_state *uts, struct udevice *dev,
Simon Glass2e7d35d2014-02-26 15:59:21 -0700182 uint32_t base, struct dm_test_priv *priv);
183
184/**
Simon Glass1ca7e202014-07-23 06:55:18 -0600185 * dm_check_devices() - check the devices respond to operations correctly
186 *
187 * @dms: Overall test state
188 * @num_devices: Number of test devices to check
189 * @return 0 if OK, -ve on error
190 */
Joe Hershbergere721b882015-05-20 14:27:27 -0500191int dm_check_devices(struct unit_test_state *uts, int num_devices);
Simon Glass1ca7e202014-07-23 06:55:18 -0600192
193/**
Simon Glass756ac0b2014-10-04 11:29:50 -0600194 * dm_leak_check_start() - Prepare to check for a memory leak
195 *
196 * Call this before allocating memory to record the amount of memory being
197 * used.
198 *
199 * @dms: Overall test state
200 */
Joe Hershbergere721b882015-05-20 14:27:27 -0500201void dm_leak_check_start(struct unit_test_state *uts);
Simon Glass756ac0b2014-10-04 11:29:50 -0600202
203/**
204 * dm_leak_check_end() - Check that no memory has leaked
205 *
206 * Call this after dm_leak_check_start() and after you have hopefuilly freed
207 * all the memory that was allocated. This function will print an error if
208 * it sees a different amount of total memory allocated than before.
209 *
210 * @dms: Overall test state
Joe Hershbergere721b882015-05-20 14:27:27 -0500211 */int dm_leak_check_end(struct unit_test_state *uts);
Simon Glass756ac0b2014-10-04 11:29:50 -0600212
Simon Glass2e7d35d2014-02-26 15:59:21 -0700213#endif