7#ifndef ZEPHYR_INCLUDE_DEVICE_H_
8#define ZEPHYR_INCLUDE_DEVICE_H_
39#define Z_DEVICE_DEPS_SEP INT16_MIN
45#define Z_DEVICE_DEPS_ENDS INT16_MAX
48#define Z_DEVICE_IS_MUTABLE(node_id) \
49 COND_CODE_1(IS_ENABLED(CONFIG_DEVICE_MUTABLE), (DT_PROP(node_id, zephyr_mutable)), (0))
71#define DEVICE_HANDLE_NULL 0
92#define DEVICE_NAME_GET(dev_id) _CONCAT(__device_, dev_id)
102#define Z_DEVICE_DT_DEV_ID(node_id) _CONCAT(dts_ord_, DT_DEP_ORD(node_id))
134#define DEVICE_DEFINE(dev_id, name, init_fn, pm, data, config, level, prio, \
136 Z_DEVICE_STATE_DEFINE(dev_id); \
137 Z_DEVICE_DEFINE(DT_INVALID_NODE, dev_id, name, init_fn, pm, data, \
138 config, level, prio, api, \
139 &Z_DEVICE_STATE_NAME(dev_id))
152#define DEVICE_DT_NAME(node_id) \
153 DT_PROP_OR(node_id, label, DT_NODE_FULL_NAME(node_id))
162#define DEVICE_DT_DEFER(node_id) \
163 DT_PROP(node_id, zephyr_deferred_init)
195#define DEVICE_DT_DEFINE(node_id, init_fn, pm, data, config, level, prio, api, \
197 Z_DEVICE_STATE_DEFINE(Z_DEVICE_DT_DEV_ID(node_id)); \
198 Z_DEVICE_DEFINE(node_id, Z_DEVICE_DT_DEV_ID(node_id), \
199 DEVICE_DT_NAME(node_id), init_fn, pm, data, config, \
201 &Z_DEVICE_STATE_NAME(Z_DEVICE_DT_DEV_ID(node_id)), \
212#define DEVICE_DT_INST_DEFINE(inst, ...) \
213 DEVICE_DT_DEFINE(DT_DRV_INST(inst), __VA_ARGS__)
229#define DEVICE_DT_NAME_GET(node_id) DEVICE_NAME_GET(Z_DEVICE_DT_DEV_ID(node_id))
246#define DEVICE_DT_GET(node_id) (&DEVICE_DT_NAME_GET(node_id))
257#define DEVICE_DT_INST_GET(inst) DEVICE_DT_GET(DT_DRV_INST(inst))
275#define DEVICE_DT_GET_ANY(compat) \
276 COND_CODE_1(DT_HAS_COMPAT_STATUS_OKAY(compat), \
277 (DEVICE_DT_GET(DT_COMPAT_GET_ANY_STATUS_OKAY(compat))), \
296#define DEVICE_DT_GET_ONE(compat) \
297 COND_CODE_1(DT_HAS_COMPAT_STATUS_OKAY(compat), \
298 (DEVICE_DT_GET(DT_COMPAT_GET_ANY_STATUS_OKAY(compat))), \
299 (ZERO_OR_COMPILE_ERROR(0)))
311#define DEVICE_DT_GET_OR_NULL(node_id) \
312 COND_CODE_1(DT_NODE_HAS_STATUS(node_id, okay), \
313 (DEVICE_DT_GET(node_id)), (NULL))
325#define DEVICE_GET(dev_id) (&DEVICE_NAME_GET(dev_id))
341#define DEVICE_DECLARE(dev_id) \
342 static const struct device DEVICE_NAME_GET(dev_id)
351#define DEVICE_INIT_DT_GET(node_id) \
352 (&Z_INIT_ENTRY_NAME(DEVICE_DT_NAME_GET(node_id)))
361#define DEVICE_INIT_GET(dev_id) (&Z_INIT_ENTRY_NAME(DEVICE_NAME_GET(dev_id)))
390#if defined(CONFIG_DEVICE_DT_METADATA) || defined(__DOXYGEN__)
391struct device_dt_metadata;
394#ifdef CONFIG_DEVICE_DEPS_DYNAMIC
395#define Z_DEVICE_DEPS_CONST
397#define Z_DEVICE_DEPS_CONST const
414#if defined(CONFIG_DEVICE_DEPS) || defined(__DOXYGEN__)
425#if defined(CONFIG_PM_DEVICE) || defined(__DOXYGEN__)
436#if defined(CONFIG_DEVICE_DT_METADATA) || defined(__DOXYGEN__)
472static inline const struct device *
476 const struct device *dev = NULL;
481 if ((dev_handle > 0) && ((
size_t)dev_handle <= numdev)) {
488#if defined(CONFIG_DEVICE_DEPS) || defined(__DOXYGEN__)
537 while ((rv[i] != Z_DEVICE_DEPS_ENDS) &&
538 (rv[i] != Z_DEVICE_DEPS_SEP)) {
574 while (region != 1) {
575 if (*rv == Z_DEVICE_DEPS_SEP) {
580 while ((rv[i] != Z_DEVICE_DEPS_ENDS) &&
581 (rv[i] != Z_DEVICE_DEPS_SEP)) {
618 while (region != 2) {
619 if (*rv == Z_DEVICE_DEPS_SEP) {
628 while ((rv[i] != Z_DEVICE_DEPS_ENDS) &&
737size_t z_device_get_all_static(
const struct device **devices);
783#define Z_DEVICE_STATE_NAME(dev_id) _CONCAT(__devstate_, dev_id)
790#define Z_DEVICE_STATE_DEFINE(dev_id) \
791 static Z_DECL_ALIGN(struct device_state) Z_DEVICE_STATE_NAME(dev_id) \
792 __attribute__((__section__(".z_devstate")))
794#if defined(CONFIG_DEVICE_DEPS) || defined(__DOXYGEN__)
802#define Z_DEVICE_DEPS_NAME(dev_id) _CONCAT(__devicedeps_, dev_id)
809#define Z_DEVICE_EXTRA_DEPS(...) \
810 FOR_EACH_NONEMPTY_TERM(IDENTITY, (,), __VA_ARGS__)
813#define Z_DEVICE_DEPS_SECTION \
814 __attribute__((__section__(".__device_deps_pass1")))
817#define Z_DEVICE_DEPS_EXTERN extern
819#define Z_DEVICE_DEPS_EXTERN
857#define Z_DEVICE_DEPS_DEFINE(node_id, dev_id, ...) \
858 extern Z_DEVICE_DEPS_CONST device_handle_t Z_DEVICE_DEPS_NAME( \
860 Z_DEVICE_DEPS_CONST Z_DECL_ALIGN(device_handle_t) \
861 Z_DEVICE_DEPS_SECTION Z_DEVICE_DEPS_EXTERN __weak \
862 Z_DEVICE_DEPS_NAME(dev_id)[] = { \
864 DT_NODE_EXISTS(node_id), \
865 (DT_DEP_ORD(node_id), DT_REQUIRES_DEP_ORDS(node_id)), \
866 (DEVICE_HANDLE_NULL,)) \
868 Z_DEVICE_EXTRA_DEPS(__VA_ARGS__) \
870 COND_CODE_1(DT_NODE_EXISTS(node_id), \
871 (DT_SUPPORTS_DEP_ORDS(node_id)), ()) \
875#if defined(CONFIG_DEVICE_DT_METADATA) || defined(__DOXYGEN__)
879struct device_dt_nodelabels {
881 size_t num_nodelabels;
885 const char *nodelabels[];
895struct device_dt_metadata {
900 const struct device_dt_nodelabels *nl;
921__syscall
const struct device *device_get_by_dt_nodelabel(
const char *nodelabel);
928static inline const struct device_dt_nodelabels *
929device_get_dt_nodelabels(
const struct device *dev)
940#define Z_DEVICE_MAX_NODELABEL_LEN Z_DEVICE_MAX_NAME_LEN
946#define Z_DEVICE_DT_METADATA_NAME_GET(dev_id) UTIL_CAT(__dev_dt_meta_, dev_id)
952#define Z_DEVICE_DT_NODELABELS_NAME_GET(dev_id) UTIL_CAT(__dev_dt_nodelabels_, dev_id)
960#define Z_DEVICE_DT_METADATA_DEFINE(node_id, dev_id) \
961 static const struct device_dt_nodelabels \
962 Z_DEVICE_DT_NODELABELS_NAME_GET(dev_id) = { \
963 .num_nodelabels = DT_NUM_NODELABELS(node_id), \
964 .nodelabels = DT_NODELABEL_STRING_ARRAY(node_id), \
967 static const struct device_dt_metadata \
968 Z_DEVICE_DT_METADATA_NAME_GET(dev_id) = { \
969 .nl = &Z_DEVICE_DT_NODELABELS_NAME_GET(dev_id), \
980#define Z_DEVICE_INIT_SUB_PRIO(node_id) \
981 COND_CODE_1(DT_NODE_EXISTS(node_id), \
982 (DT_DEP_ORD_STR_SORTABLE(node_id)), (0))
990#define Z_DEVICE_MAX_NAME_LEN 48U
997#define Z_DEVICE_NAME_CHECK(name) \
998 BUILD_ASSERT(sizeof(Z_STRINGIFY(name)) <= Z_DEVICE_MAX_NAME_LEN, \
999 Z_STRINGIFY(DEVICE_NAME_GET(name)) " too long")
1014#define Z_DEVICE_INIT(name_, pm_, data_, config_, api_, state_, deps_, node_id_, \
1018 .config = (config_), \
1020 .state = (state_), \
1022 IF_ENABLED(CONFIG_DEVICE_DEPS, (.deps = (deps_),)) \
1023 IF_ENABLED(CONFIG_PM_DEVICE, Z_DEVICE_INIT_PM_BASE(pm_)) \
1024 IF_ENABLED(CONFIG_DEVICE_DT_METADATA, \
1025 (IF_ENABLED(DT_NODE_EXISTS(node_id_), \
1026 (.dt_meta = &Z_DEVICE_DT_METADATA_NAME_GET( \
1035#if defined(__STDC_VERSION__) && (__STDC_VERSION__) < 201100
1036# define Z_DEVICE_INIT_PM_BASE(pm_) ({ .pm_base = (pm_),},)
1038# define Z_DEVICE_INIT_PM_BASE(pm_) (.pm_base = (pm_),)
1047#define Z_DEVICE_SECTION_NAME(level, prio) \
1048 _CONCAT(INIT_LEVEL_ORD(level), _##prio)
1066#define Z_DEVICE_BASE_DEFINE(node_id, dev_id, name, pm, data, config, level, prio, api, state, \
1068 COND_CODE_1(DT_NODE_EXISTS(node_id), (), (static)) \
1069 COND_CODE_1(Z_DEVICE_IS_MUTABLE(node_id), (), (const)) \
1070 STRUCT_SECTION_ITERABLE_NAMED_ALTERNATE( \
1071 device, COND_CODE_1(Z_DEVICE_IS_MUTABLE(node_id), (device_mutable), (device)), \
1072 Z_DEVICE_SECTION_NAME(level, prio), DEVICE_NAME_GET(dev_id)) = \
1073 Z_DEVICE_INIT(name, pm, data, config, api, state, deps, node_id, dev_id)
1076#define Z_DEVICE_LEVEL_DEPRECATED_EARLY \
1077 __WARN("EARLY device driver level is deprecated")
1078#define Z_DEVICE_LEVEL_DEPRECATED_PRE_KERNEL_1
1079#define Z_DEVICE_LEVEL_DEPRECATED_PRE_KERNEL_2
1080#define Z_DEVICE_LEVEL_DEPRECATED_POST_KERNEL
1081#define Z_DEVICE_LEVEL_DEPRECATED_APPLICATION \
1082 __WARN("APPLICATION device driver level is deprecated")
1083#define Z_DEVICE_LEVEL_DEPRECATED_SMP \
1084 __WARN("SMP device driver level is deprecated")
1091#define Z_DEVICE_LEVEL_CHECK_DEPRECATED_LEVEL(level) \
1092 Z_DEVICE_LEVEL_DEPRECATED_##level
1104#define Z_DEVICE_INIT_ENTRY_DEFINE(node_id, dev_id, init_fn_, level, prio) \
1105 Z_DEVICE_LEVEL_CHECK_DEPRECATED_LEVEL(level) \
1107 static const Z_DECL_ALIGN(struct init_entry) __used __noasan Z_INIT_ENTRY_SECTION( \
1108 level, prio, Z_DEVICE_INIT_SUB_PRIO(node_id)) \
1109 Z_INIT_ENTRY_NAME(DEVICE_NAME_GET(dev_id)) = { \
1110 .init_fn = {COND_CODE_1(Z_DEVICE_IS_MUTABLE(node_id), (.dev_rw), (.dev)) = \
1112 Z_DEVICE_INIT_ENTRY_DEV(node_id, dev_id), \
1115#define Z_DEFER_DEVICE_INIT_ENTRY_DEFINE(node_id, dev_id, init_fn_) \
1116 static const Z_DECL_ALIGN(struct init_entry) __used __noasan \
1117 __attribute__((__section__(".z_deferred_init"))) \
1118 Z_INIT_ENTRY_NAME(DEVICE_NAME_GET(dev_id)) = { \
1119 .init_fn = {COND_CODE_1(Z_DEVICE_IS_MUTABLE(node_id), (.dev_rw), (.dev)) = \
1121 Z_DEVICE_INIT_ENTRY_DEV(node_id, dev_id), \
1129#if defined(__STDC_VERSION__) && (__STDC_VERSION__) < 201100
1130# define Z_DEVICE_INIT_ENTRY_DEV(node_id, dev_id) { Z_DEV_ENTRY_DEV(node_id, dev_id) }
1132# define Z_DEVICE_INIT_ENTRY_DEV(node_id, dev_id) Z_DEV_ENTRY_DEV(node_id, dev_id)
1135#define Z_DEV_ENTRY_DEV(node_id, dev_id) \
1136 COND_CODE_1(Z_DEVICE_IS_MUTABLE(node_id), (.dev_rw), (.dev)) = &DEVICE_NAME_GET(dev_id)
1159#define Z_DEVICE_DEFINE(node_id, dev_id, name, init_fn, pm, data, config, \
1160 level, prio, api, state, ...) \
1161 Z_DEVICE_NAME_CHECK(name); \
1163 IF_ENABLED(CONFIG_DEVICE_DEPS, \
1164 (Z_DEVICE_DEPS_DEFINE(node_id, dev_id, __VA_ARGS__);)) \
1166 IF_ENABLED(CONFIG_DEVICE_DT_METADATA, \
1167 (IF_ENABLED(DT_NODE_EXISTS(node_id), \
1168 (Z_DEVICE_DT_METADATA_DEFINE(node_id, dev_id);))))\
1170 Z_DEVICE_BASE_DEFINE(node_id, dev_id, name, pm, data, config, level, \
1171 prio, api, state, Z_DEVICE_DEPS_NAME(dev_id)); \
1172 COND_CODE_1(DEVICE_DT_DEFER(node_id), \
1173 (Z_DEFER_DEVICE_INIT_ENTRY_DEFINE(node_id, dev_id, \
1175 (Z_DEVICE_INIT_ENTRY_DEFINE(node_id, dev_id, init_fn, \
1188#define Z_MAYBE_DEVICE_DECLARE_INTERNAL(node_id) \
1189 extern COND_CODE_1(Z_DEVICE_IS_MUTABLE(node_id), (), \
1190 (const)) struct device DEVICE_DT_NAME_GET(node_id);
1200#include <zephyr/syscalls/device.h>
const struct device * device_get_binding(const char *name)
Get a device reference from its device::name field.
int16_t device_handle_t
Type used to represent a "handle" for a device.
Definition: device.h:68
static const device_handle_t * device_required_handles_get(const struct device *dev, size_t *count)
Get the device handles for devicetree dependencies of this device.
Definition: device.h:530
static const device_handle_t * device_supported_handles_get(const struct device *dev, size_t *count)
Get the set of handles that this device supports.
Definition: device.h:610
static device_handle_t device_handle_get(const struct device *dev)
Get the handle for a given device.
Definition: device.h:449
#define DEVICE_HANDLE_NULL
Flag value used to identify an unknown device.
Definition: device.h:71
int device_required_foreach(const struct device *dev, device_visitor_callback_t visitor_cb, void *context)
Visit every device that dev directly requires.
static const struct device * device_from_handle(device_handle_t dev_handle)
Get the device corresponding to a handle.
Definition: device.h:473
int(* device_visitor_callback_t)(const struct device *dev, void *context)
Prototype for functions used when iterating over a set of devices.
Definition: device.h:508
bool device_is_ready(const struct device *dev)
Verify that a device is ready for use.
static const device_handle_t * device_injected_handles_get(const struct device *dev, size_t *count)
Get the device handles for injected dependencies of this device.
Definition: device.h:566
int device_init(const struct device *dev)
Initialize a device.
int device_supported_foreach(const struct device *dev, device_visitor_callback_t visitor_cb, void *context)
Visit every device that dev directly supports.
#define DT_FOREACH_STATUS_OKAY_NODE(fn)
Invokes fn for every status okay node in the tree.
Definition: devicetree.h:2785
#define STRUCT_SECTION_START_EXTERN(struct_type)
iterable section extern for start symbol for a struct
Definition: iterable_sections.h:159
#define STRUCT_SECTION_START(struct_type)
iterable section start symbol for a struct type
Definition: iterable_sections.h:149
#define STRUCT_SECTION_COUNT(struct_type, dst)
Count elements in a section.
Definition: iterable_sections.h:291
Definitions of various linker Sections.
__UINT8_TYPE__ uint8_t
Definition: stdint.h:88
__INT16_TYPE__ int16_t
Definition: stdint.h:73
Runtime device dynamic structure (in RAM) per driver instance.
Definition: device.h:371
bool initialized
Indicates the device initialization function has been invoked.
Definition: device.h:384
uint8_t init_res
Device initialization return code (positive errno value).
Definition: device.h:379
Runtime device structure (in ROM) per driver instance.
Definition: device.h:403
struct pm_device_base * pm_base
Definition: device.h:431
const device_handle_t * deps
Optional pointer to dependencies associated with the device.
Definition: device.h:423
struct pm_device_isr * pm_isr
Definition: device.h:433
const char * name
Name of the device instance.
Definition: device.h:405
struct pm_device * pm
Definition: device.h:432
void * data
Address of the device instance private data.
Definition: device.h:413
const void * api
Address of the API structure exposed by the device instance.
Definition: device.h:409
struct device_state * state
Address of the common device state.
Definition: device.h:411
const void * config
Address of device instance config information.
Definition: device.h:407
const struct device_dt_metadata * dt_meta
Definition: device.h:437
Device PM info.
Definition: device.h:139
Runtime PM info for device with synchronous PM.
Definition: device.h:185
Runtime PM info for device with generic PM.
Definition: device.h:163