03bcf8276a
Issue #38271 Implement a getter for emulators similar to device_get_binding. This function can be used to get the emulator instance during tests to call emulator specific functions. Example: The current BMI160 emulator pre-defines a finite set of data samples that will be returned. If a test was to be written for logic that uses that data, then the emulator would become completely useless without the ability for the test to define what data should be returned. This will also help in exercising error conditions in tests. Signed-off-by: Yuval Peress <peress@chromium.org>
124 lines
3.4 KiB
C
124 lines
3.4 KiB
C
/*
|
|
* Copyright (c) 2020 Nordic Semiconductor ASA
|
|
* Copyright 2020 Google LLC
|
|
*
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
#ifndef ZEPHYR_INCLUDE_DRIVERS_EMUL_H_
|
|
#define ZEPHYR_INCLUDE_DRIVERS_EMUL_H_
|
|
|
|
/**
|
|
* @brief Emulators used to test drivers and higher-level code that uses them
|
|
* @defgroup io_emulators Emulator interface
|
|
* @{
|
|
*/
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif /* __cplusplus */
|
|
|
|
struct device;
|
|
struct emul;
|
|
|
|
/**
|
|
* Structure uniquely identifying a device to be emulated
|
|
*
|
|
* Currently this uses the device node label, but that will go away by 2.5.
|
|
*/
|
|
struct emul_link_for_bus {
|
|
const char *label;
|
|
};
|
|
|
|
/** List of emulators attached to a bus */
|
|
struct emul_list_for_bus {
|
|
/** Identifiers for children of the node */
|
|
const struct emul_link_for_bus *children;
|
|
/** Number of children of the node */
|
|
unsigned int num_children;
|
|
};
|
|
|
|
/**
|
|
* Standard callback for emulator initialisation providing the initialiser
|
|
* record and the device that calls the emulator functions.
|
|
*
|
|
* @param emul Emulator to init
|
|
* @param parent Parent device that is using the emulator
|
|
*/
|
|
typedef int (*emul_init_t)(const struct emul *emul,
|
|
const struct device *parent);
|
|
|
|
/** An emulator instance */
|
|
struct emul {
|
|
/** function used to initialise the emulator state */
|
|
emul_init_t init;
|
|
/** handle to the device for which this provides low-level emulation */
|
|
const char *dev_label;
|
|
/** Emulator-specific configuration data */
|
|
const void *cfg;
|
|
};
|
|
|
|
/**
|
|
* Emulators are aggregated into an array at link time, from which emulating
|
|
* devices can find the emulators that they are to use.
|
|
*/
|
|
extern const struct emul __emul_list_start[];
|
|
extern const struct emul __emul_list_end[];
|
|
|
|
/* Use the devicetree node identifier as a unique name. */
|
|
#define EMUL_REG_NAME(node_id) (_CONCAT(__emulreg_, node_id))
|
|
|
|
/**
|
|
* Define a new emulator
|
|
*
|
|
* This adds a new struct emul to the linker list of emulations. This is
|
|
* typically used in your emulator's DT_INST_FOREACH_STATUS_OKAY() clause.
|
|
*
|
|
* @param init_ptr function to call to initialise the emulator (see emul_init
|
|
* typedef)
|
|
* @param node_id Node ID of the driver to emulate (e.g. DT_DRV_INST(n))
|
|
* @param cfg_ptr emulator-specific configuration data
|
|
*/
|
|
#define EMUL_DEFINE(init_ptr, node_id, cfg_ptr) \
|
|
static struct emul EMUL_REG_NAME(node_id) \
|
|
__attribute__((__section__(".emulators"))) __used = { \
|
|
.init = (init_ptr), \
|
|
.dev_label = DT_LABEL(node_id), \
|
|
.cfg = (cfg_ptr), \
|
|
};
|
|
|
|
/**
|
|
* Set up a list of emulators
|
|
*
|
|
* @param dev Device the emulators are attached to (e.g. an I2C controller)
|
|
* @param list List of devices to set up
|
|
* @return 0 if OK
|
|
* @return negative value on error
|
|
*/
|
|
int emul_init_for_bus_from_list(const struct device *dev,
|
|
const struct emul_list_for_bus *list);
|
|
|
|
/**
|
|
* @brief Retrieve the emul structure for an emulator by name
|
|
*
|
|
* @details Emulator objects are created via the EMUL_DEFINE() macro and placed in memory by the
|
|
* linker. If the emulator structure is needed for custom API calls, it can be retrieved by the name
|
|
* that the emulator exposes to the system (this is the devicetree node's label by default).
|
|
*
|
|
* @param name Emulator name to search for. A null pointer, or a pointer to an
|
|
* empty string, will cause NULL to be returned.
|
|
*
|
|
* @return pointer to emulator structure; NULL if not found or cannot be used.
|
|
*/
|
|
const struct emul *emul_get_binding(const char *name);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif /* __cplusplus */
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
#endif /* ZEPHYR_INCLUDE_DRIVERS_EMUL_H_ */
|