Zephyr Project API 3.7.0
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
emul.h
Go to the documentation of this file.
1/*
2 * Copyright (c) 2020 Nordic Semiconductor ASA
3 * Copyright 2020 Google LLC
4 *
5 * SPDX-License-Identifier: Apache-2.0
6 */
7
8#ifndef ZEPHYR_INCLUDE_DRIVERS_EMUL_H_
9#define ZEPHYR_INCLUDE_DRIVERS_EMUL_H_
10
18#ifdef __cplusplus
19extern "C" {
20#endif /* __cplusplus */
21
22struct emul;
23
24/* #includes required after forward-declaration of struct emul later defined in this header. */
25#include <zephyr/device.h>
26#include <zephyr/devicetree.h>
32
43
48 const struct device *dev;
49};
50
56 unsigned int num_children;
57};
58
66typedef int (*emul_init_t)(const struct emul *emul, const struct device *parent);
67
72 void *api;
74};
75
80struct emul {
84 const struct device *dev;
86 const void *cfg;
88 void *data;
92 union bus {
93 struct i2c_emul *i2c;
94 struct espi_emul *espi;
95 struct spi_emul *spi;
96 struct mspi_emul *mspi;
98 } bus;
100 const void *backend_api;
101};
102
108#define EMUL_DT_NAME_GET(node_id) _CONCAT(__emulreg_, node_id)
109
110/* Get a unique identifier based on the given _dev_node_id's reg property and
111 * the bus its on. Intended for use in other internal macros when declaring {bus}_emul
112 * structs in peripheral emulators.
113 */
114#define Z_EMUL_REG_BUS_IDENTIFIER(_dev_node_id) (_CONCAT(_CONCAT(__emulreg_, _dev_node_id), _bus))
115
116/* Conditionally places text based on what bus _dev_node_id is on. */
117#define Z_EMUL_BUS(_dev_node_id, _i2c, _espi, _spi, _mspi, _none) \
118 COND_CODE_1(DT_ON_BUS(_dev_node_id, i2c), (_i2c), \
119 (COND_CODE_1(DT_ON_BUS(_dev_node_id, espi), (_espi), \
120 (COND_CODE_1(DT_ON_BUS(_dev_node_id, spi), (_spi), \
121 (COND_CODE_1(DT_ON_BUS(_dev_node_id, mspi), (_mspi), \
122 (_none))))))))
137#define EMUL_DT_DEFINE(node_id, init_fn, data_ptr, cfg_ptr, bus_api, _backend_api) \
138 static struct Z_EMUL_BUS(node_id, i2c_emul, espi_emul, spi_emul, mspi_emul, no_bus_emul) \
139 Z_EMUL_REG_BUS_IDENTIFIER(node_id) = { \
140 .api = bus_api, \
141 .Z_EMUL_BUS(node_id, addr, chipsel, chipsel, dev_idx, addr) = \
142 DT_REG_ADDR(node_id), \
143 }; \
144 const STRUCT_SECTION_ITERABLE(emul, EMUL_DT_NAME_GET(node_id)) __used = { \
145 .init = (init_fn), \
146 .dev = DEVICE_DT_GET(node_id), \
147 .cfg = (cfg_ptr), \
148 .data = (data_ptr), \
149 .bus_type = Z_EMUL_BUS(node_id, EMUL_BUS_TYPE_I2C, EMUL_BUS_TYPE_ESPI, \
150 EMUL_BUS_TYPE_SPI, EMUL_BUS_TYPE_MSPI, EMUL_BUS_TYPE_NONE), \
151 .bus = {.Z_EMUL_BUS(node_id, i2c, espi, spi, mspi, none) = \
152 &(Z_EMUL_REG_BUS_IDENTIFIER(node_id))}, \
153 .backend_api = (_backend_api), \
154 };
155
164#define EMUL_DT_INST_DEFINE(inst, ...) EMUL_DT_DEFINE(DT_DRV_INST(inst), __VA_ARGS__)
165
180#define EMUL_DT_GET(node_id) (&EMUL_DT_NAME_GET(node_id))
181
191#define EMUL_DT_GET_OR_NULL(node_id) \
192 COND_CODE_1(DT_NODE_HAS_STATUS(node_id, okay), (EMUL_DT_GET(node_id)), (NULL))
193
201int emul_init_for_bus(const struct device *dev);
202
215const struct emul *emul_get_binding(const char *name);
216
221#define Z_MAYBE_EMUL_DECLARE_INTERNAL(node_id) extern const struct emul EMUL_DT_NAME_GET(node_id);
222
223DT_FOREACH_STATUS_OKAY_NODE(Z_MAYBE_EMUL_DECLARE_INTERNAL);
224
225#ifdef __cplusplus
226}
227#endif /* __cplusplus */
228
229#endif /* ZEPHYR_INCLUDE_DRIVERS_EMUL_H_ */
Devicetree main header.
Public APIs for the eSPI emulation drivers.
#define DT_FOREACH_STATUS_OKAY_NODE(fn)
Invokes fn for every status okay node in the tree.
Definition devicetree.h:2785
emul_bus_type
The types of supported buses.
Definition emul.h:36
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 ca...
Definition emul.h:66
const struct emul * emul_get_binding(const char *name)
Retrieve the emul structure for an emulator by name.
int emul_init_for_bus(const struct device *dev)
Set up a list of emulators.
@ EMUL_BUS_TYPE_SPI
Definition emul.h:39
@ EMUL_BUS_TYPE_I2C
Definition emul.h:37
@ EMUL_BUS_TYPE_MSPI
Definition emul.h:40
@ EMUL_BUS_TYPE_ESPI
Definition emul.h:38
@ EMUL_BUS_TYPE_NONE
Definition emul.h:41
Public APIs for the I2C emulation drivers.
Public APIs for the MSPI emulation drivers.
Public APIs for the SPI emulation drivers.
__UINT16_TYPE__ uint16_t
Definition stdint.h:89
Runtime device structure (in ROM) per driver instance.
Definition device.h:403
List of emulators attached to a bus.
Definition emul.h:52
const struct emul_link_for_bus * children
Identifiers for children of the node.
Definition emul.h:54
unsigned int num_children
Number of children of the node.
Definition emul.h:56
An emulator instance - represents the target emulated device/peripheral that is interacted with throu...
Definition emul.h:80
const struct device * dev
handle to the device for which this provides low-level emulation
Definition emul.h:84
emul_init_t init
function used to initialise the emulator state
Definition emul.h:82
void * data
Emulator-specific data.
Definition emul.h:88
enum emul_bus_type bus_type
The bus type that the emulator is attached to.
Definition emul.h:90
const void * backend_api
Address of the API structure exposed by the emulator instance.
Definition emul.h:100
const void * cfg
Emulator-specific configuration data.
Definition emul.h:86
Node in a linked list of emulators for eSPI devices.
Definition espi_emul.h:111
Node in a linked list of emulators for I2C devices.
Definition i2c_emul.h:37
Node in a linked list of emulators for MSPI devices.
Definition mspi_emul.h:87
Emulator API stub when an emulator is not actually placed on a bus.
Definition emul.h:71
void * api
Definition emul.h:72
uint16_t addr
Definition emul.h:73
Node in a linked list of emulators for SPI devices.
Definition spi_emul.h:37
Pointer to the emulated bus node.
Definition emul.h:92
struct i2c_emul * i2c
Definition emul.h:93
struct no_bus_emul * none
Definition emul.h:97
struct spi_emul * spi
Definition emul.h:95
struct mspi_emul * mspi
Definition emul.h:96
struct espi_emul * espi
Definition emul.h:94