blob: eeaa2eb2f4645eb7aafff7c1e1626ffb8eae3b6c [file] [log] [blame]
/*
* Copyright (c) 2013 Google, Inc.
*
* SPDX-License-Identifier: GPL-2.0+
*/
#ifndef __DM_TEST_H
#define __DM_TEST_H
#include <dm.h>
/**
* struct dm_test_cdata - configuration data for test instance
*
* @ping_add: Amonut to add each time we get a ping
* @base: Base address of this device
*/
struct dm_test_pdata {
int ping_add;
uint32_t base;
};
/**
* struct test_ops - Operations supported by the test device
*
* @ping: Ping operation
* @dev: Device to operate on
* @pingval: Value to ping the device with
* @pingret: Returns resulting value from driver
* @return 0 if OK, -ve on error
*/
struct test_ops {
int (*ping)(struct device *dev, int pingval, int *pingret);
};
/* Operations that our test driver supports */
enum {
DM_TEST_OP_BIND = 0,
DM_TEST_OP_UNBIND,
DM_TEST_OP_PROBE,
DM_TEST_OP_REMOVE,
/* For uclass */
DM_TEST_OP_POST_BIND,
DM_TEST_OP_PRE_UNBIND,
DM_TEST_OP_POST_PROBE,
DM_TEST_OP_PRE_REMOVE,
DM_TEST_OP_INIT,
DM_TEST_OP_DESTROY,
DM_TEST_OP_COUNT,
};
/* Test driver types */
enum {
DM_TEST_TYPE_FIRST = 0,
DM_TEST_TYPE_SECOND,
};
/* The number added to the ping total on each probe */
#define DM_TEST_START_TOTAL 5
/**
* struct dm_test_priv - private data for the test devices
*/
struct dm_test_priv {
int ping_total;
int op_count[DM_TEST_OP_COUNT];
};
/**
* struct dm_test_perdev_class_priv - private per-device data for test uclass
*/
struct dm_test_uclass_perdev_priv {
int base_add;
};
/**
* struct dm_test_uclass_priv - private data for test uclass
*/
struct dm_test_uclass_priv {
int total_add;
};
/*
* Operation counts for the test driver, used to check that each method is
* called correctly
*/
extern int dm_testdrv_op_count[DM_TEST_OP_COUNT];
extern struct dm_test_state global_test_state;
/*
* struct dm_test_state - Entire state of dm test system
*
* This is often abreviated to dms.
*
* @root: Root device
* @testdev: Test device
* @fail_count: Number of tests that failed
* @force_fail_alloc: Force all memory allocs to fail
* @skip_post_probe: Skip uclass post-probe processing
*/
struct dm_test_state {
struct device *root;
struct device *testdev;
int fail_count;
int force_fail_alloc;
int skip_post_probe;
};
/* Test flags for each test */
enum {
DM_TESTF_SCAN_PDATA = 1 << 0, /* test needs platform data */
DM_TESTF_PROBE_TEST = 1 << 1, /* probe test uclass */
DM_TESTF_SCAN_FDT = 1 << 2, /* scan device tree */
};
/**
* struct dm_test - Information about a driver model test
*
* @name: Name of test
* @func: Function to call to perform test
* @flags: Flags indicated pre-conditions for test
*/
struct dm_test {
const char *name;
int (*func)(struct dm_test_state *dms);
int flags;
};
/* Declare a new driver model test */
#define DM_TEST(_name, _flags) \
ll_entry_declare(struct dm_test, _name, dm_test) = { \
.name = #_name, \
.flags = _flags, \
.func = _name, \
}
/* Declare ping methods for the drivers */
int test_ping(struct device *dev, int pingval, int *pingret);
int testfdt_ping(struct device *dev, int pingval, int *pingret);
/**
* dm_check_operations() - Check that we can perform ping operations
*
* This checks that the ping operations work as expected for a device
*
* @dms: Overall test state
* @dev: Device to test
* @base: Base address, used to check ping return value
* @priv: Pointer to private test information
* @return 0 if OK, -ve on error
*/
int dm_check_operations(struct dm_test_state *dms, struct device *dev,
uint32_t base, struct dm_test_priv *priv);
/**
* dm_test_main() - Run all the tests
*
* This runs all available driver model tests
*
* @return 0 if OK, -ve on error
*/
int dm_test_main(void);
#endif