Zephyr API Documentation 3.7.99
A Scalable Open Source RTOS
|
Emulators used to test drivers and higher-level code that uses them . More...
Topics | |
I2C Emulation Interface | |
I2C Emulation Interface . | |
MSPI Emulation Interface | |
MSPI Emulation Interface . | |
SPI Emulation Interface | |
SPI Emulation Interface . | |
UART Emulation Interface | |
UART Emulation Interface . | |
eSPI Emulation Interface | |
eSPI Emulation Interface | |
Data Structures | |
struct | emul_link_for_bus |
Structure uniquely identifying a device to be emulated. More... | |
struct | emul_list_for_bus |
List of emulators attached to a bus. More... | |
struct | no_bus_emul |
Emulator API stub when an emulator is not actually placed on a bus. More... | |
struct | emul |
An emulator instance - represents the target emulated device/peripheral that is interacted with through an emulated bus. More... | |
Macros | |
#define | EMUL_DT_NAME_GET(node_id) |
Use the devicetree node identifier as a unique name. | |
#define | EMUL_DT_DEFINE(node_id, init_fn, data_ptr, cfg_ptr, bus_api, _backend_api) |
Define a new emulator. | |
#define | EMUL_DT_INST_DEFINE(inst, ...) |
Like EMUL_DT_DEFINE(), but uses an instance of a DT_DRV_COMPAT compatible instead of a node identifier. | |
#define | EMUL_DT_GET(node_id) |
Get a const struct emul* from a devicetree node identifier. | |
#define | EMUL_DT_GET_OR_NULL(node_id) |
Utility macro to obtain an optional reference to an emulator. | |
Typedefs | |
typedef int(* | emul_init_t) (const struct emul *emul, const struct device *parent) |
Standard callback for emulator initialisation providing the initialiser record and the device that calls the emulator functions. | |
Enumerations | |
enum | emul_bus_type { EMUL_BUS_TYPE_I2C , EMUL_BUS_TYPE_ESPI , EMUL_BUS_TYPE_SPI , EMUL_BUS_TYPE_MSPI , EMUL_BUS_TYPE_UART , EMUL_BUS_TYPE_NONE } |
The types of supported buses. More... | |
Functions | |
int | emul_init_for_bus (const struct device *dev) |
Set up a list of emulators. | |
const struct emul * | emul_get_binding (const char *name) |
Retrieve the emul structure for an emulator by name. | |
Emulators used to test drivers and higher-level code that uses them .
#define EMUL_DT_DEFINE | ( | node_id, | |
init_fn, | |||
data_ptr, | |||
cfg_ptr, | |||
bus_api, | |||
_backend_api ) |
#include <zephyr/drivers/emul.h>
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.
node_id | Node ID of the driver to emulate (e.g. DT_DRV_INST(n)); the node_id MUST have a corresponding DEVICE_DT_DEFINE(). |
init_fn | function to call to initialise the emulator (see emul_init typedef) |
data_ptr | emulator-specific data |
cfg_ptr | emulator-specific configuration data |
bus_api | emulator-specific bus api |
_backend_api | emulator-specific backend api |
#define EMUL_DT_GET | ( | node_id | ) |
#include <zephyr/drivers/emul.h>
Get a const struct emul*
from a devicetree node identifier.
Returns a pointer to an emulator object created from a devicetree node, if any device was allocated by an emulator implementation.
If no such device was allocated, this will fail at linker time. If you get an error that looks like undefined reference to __device_dts_ord_<N>
, that is what happened. Check to make sure your emulator implementation is being compiled, usually by enabling the Kconfig options it requires.
node_id | A devicetree node identifier |
#define EMUL_DT_GET_OR_NULL | ( | node_id | ) |
#include <zephyr/drivers/emul.h>
Utility macro to obtain an optional reference to an emulator.
If the node identifier refers to a node with status okay
, this returns EMUL_DT_GET(node_id)
. Otherwise, it returns NULL
.
node_id | A devicetree node identifier |
NULL
. #define EMUL_DT_INST_DEFINE | ( | inst, | |
... ) |
#include <zephyr/drivers/emul.h>
Like EMUL_DT_DEFINE(), but uses an instance of a DT_DRV_COMPAT compatible instead of a node identifier.
inst | instance number. The node_id argument to EMUL_DT_DEFINE is set to DT_DRV_INST(inst) . |
... | other parameters as expected by EMUL_DT_DEFINE. |
#define EMUL_DT_NAME_GET | ( | node_id | ) |
#include <zephyr/drivers/emul.h>
Use the devicetree node identifier as a unique name.
node_id | A devicetree node identifier |
#include <zephyr/drivers/emul.h>
Standard callback for emulator initialisation providing the initialiser record and the device that calls the emulator functions.
emul | Emulator to init |
parent | Parent device that is using the emulator |
enum emul_bus_type |
#include <zephyr/drivers/emul.h>
The types of supported buses.
Enumerator | |
---|---|
EMUL_BUS_TYPE_I2C | |
EMUL_BUS_TYPE_ESPI | |
EMUL_BUS_TYPE_SPI | |
EMUL_BUS_TYPE_MSPI | |
EMUL_BUS_TYPE_UART | |
EMUL_BUS_TYPE_NONE |
const struct emul * emul_get_binding | ( | const char * | name | ) |
#include <zephyr/drivers/emul.h>
Retrieve the emul structure for an emulator by name.
Emulator objects are created via the EMUL_DT_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).
name | Emulator name to search for. A null pointer, or a pointer to an empty string, will cause NULL to be returned. |
int emul_init_for_bus | ( | const struct device * | dev | ) |
#include <zephyr/drivers/emul.h>
Set up a list of emulators.
dev | Device the emulators are attached to (e.g. an I2C controller) |