7#ifndef ZEPHYR_INCLUDE_DEVICE_H_
8#define ZEPHYR_INCLUDE_DEVICE_H_
43#define Z_DEVICE_DEPS_SEP INT16_MIN
49#define Z_DEVICE_DEPS_ENDS INT16_MAX
52#define Z_DEVICE_IS_MUTABLE(node_id) \
53 COND_CODE_1(IS_ENABLED(CONFIG_DEVICE_MUTABLE), (DT_PROP(node_id, zephyr_mutable)), (0))
75#define DEVICE_HANDLE_NULL 0
96#define DEVICE_NAME_GET(dev_id) _CONCAT(__device_, dev_id)
104#define Z_DEVICE_DT_DEV_ID(node_id) _CONCAT(dts_ord_, DT_DEP_ORD(node_id))
106#if defined(CONFIG_LLEXT_EXPORT_DEVICES)
108#define Z_DEVICE_EXPORT(node_id) EXPORT_SYMBOL(DEVICE_DT_NAME_GET(node_id))
141#define DEVICE_DEFINE(dev_id, name, init_fn, pm, data, config, level, prio, \
143 Z_DEVICE_STATE_DEFINE(dev_id); \
144 Z_DEVICE_DEFINE(DT_INVALID_NODE, dev_id, name, init_fn, pm, data, \
145 config, level, prio, api, \
146 &Z_DEVICE_STATE_NAME(dev_id))
159#define DEVICE_DT_NAME(node_id) \
160 DT_PROP_OR(node_id, label, DT_NODE_FULL_NAME(node_id))
169#define DEVICE_DT_DEFER(node_id) \
170 DT_PROP(node_id, zephyr_deferred_init)
203#define DEVICE_DT_DEFINE(node_id, init_fn, pm, data, config, level, prio, api, \
205 Z_DEVICE_STATE_DEFINE(Z_DEVICE_DT_DEV_ID(node_id)); \
206 Z_DEVICE_DEFINE(node_id, Z_DEVICE_DT_DEV_ID(node_id), \
207 DEVICE_DT_NAME(node_id), init_fn, pm, data, config, \
209 &Z_DEVICE_STATE_NAME(Z_DEVICE_DT_DEV_ID(node_id)), \
211 IF_ENABLED(CONFIG_LLEXT_EXPORT_DEVICES, (Z_DEVICE_EXPORT(node_id);))
221#define DEVICE_DT_INST_DEFINE(inst, ...) \
222 DEVICE_DT_DEFINE(DT_DRV_INST(inst), __VA_ARGS__)
238#define DEVICE_DT_NAME_GET(node_id) DEVICE_NAME_GET(Z_DEVICE_DT_DEV_ID(node_id))
255#define DEVICE_DT_GET(node_id) (&DEVICE_DT_NAME_GET(node_id))
266#define DEVICE_DT_INST_GET(inst) DEVICE_DT_GET(DT_DRV_INST(inst))
284#define DEVICE_DT_GET_ANY(compat) \
285 COND_CODE_1(DT_HAS_COMPAT_STATUS_OKAY(compat), \
286 (DEVICE_DT_GET(DT_COMPAT_GET_ANY_STATUS_OKAY(compat))), \
305#define DEVICE_DT_GET_ONE(compat) \
306 COND_CODE_1(DT_HAS_COMPAT_STATUS_OKAY(compat), \
307 (DEVICE_DT_GET(DT_COMPAT_GET_ANY_STATUS_OKAY(compat))), \
308 (ZERO_OR_COMPILE_ERROR(0)))
320#define DEVICE_DT_GET_OR_NULL(node_id) \
321 COND_CODE_1(DT_NODE_HAS_STATUS_OKAY(node_id), \
322 (DEVICE_DT_GET(node_id)), (NULL))
334#define DEVICE_GET(dev_id) (&DEVICE_NAME_GET(dev_id))
350#define DEVICE_DECLARE(dev_id) \
351 static const struct device DEVICE_NAME_GET(dev_id)
360#define DEVICE_INIT_DT_GET(node_id) \
361 (&Z_INIT_ENTRY_NAME(DEVICE_DT_NAME_GET(node_id)))
370#define DEVICE_INIT_GET(dev_id) (&Z_INIT_ENTRY_NAME(DEVICE_NAME_GET(dev_id)))
399#if defined(CONFIG_DEVICE_DT_METADATA) || defined(__DOXYGEN__)
400struct device_dt_metadata;
403#ifdef CONFIG_DEVICE_DEPS_DYNAMIC
404#define Z_DEVICE_DEPS_CONST
406#define Z_DEVICE_DEPS_CONST const
423#if defined(CONFIG_DEVICE_DEPS) || defined(__DOXYGEN__)
434#if defined(CONFIG_PM_DEVICE) || defined(__DOXYGEN__)
445#if defined(CONFIG_DEVICE_DT_METADATA) || defined(__DOXYGEN__)
481static inline const struct device *
485 const struct device *dev = NULL;
490 if ((dev_handle > 0) && ((
size_t)dev_handle <= numdev)) {
497#if defined(CONFIG_DEVICE_DEPS) || defined(__DOXYGEN__)
546 while ((rv[i] != Z_DEVICE_DEPS_ENDS) &&
547 (rv[i] != Z_DEVICE_DEPS_SEP)) {
583 while (region != 1) {
584 if (*rv == Z_DEVICE_DEPS_SEP) {
589 while ((rv[i] != Z_DEVICE_DEPS_ENDS) &&
590 (rv[i] != Z_DEVICE_DEPS_SEP)) {
627 while (region != 2) {
628 if (*rv == Z_DEVICE_DEPS_SEP) {
637 while ((rv[i] != Z_DEVICE_DEPS_ENDS) &&
746size_t z_device_get_all_static(
const struct device **devices);
792#define Z_DEVICE_STATE_NAME(dev_id) _CONCAT(__devstate_, dev_id)
799#define Z_DEVICE_STATE_DEFINE(dev_id) \
800 static Z_DECL_ALIGN(struct device_state) Z_DEVICE_STATE_NAME(dev_id) \
801 __attribute__((__section__(".z_devstate")))
803#if defined(CONFIG_DEVICE_DEPS) || defined(__DOXYGEN__)
811#define Z_DEVICE_DEPS_NAME(dev_id) _CONCAT(__devicedeps_, dev_id)
818#define Z_DEVICE_EXTRA_DEPS(...) \
819 FOR_EACH_NONEMPTY_TERM(IDENTITY, (,), __VA_ARGS__)
822#define Z_DEVICE_DEPS_SECTION \
823 __attribute__((__section__(".__device_deps_pass1")))
826#define Z_DEVICE_DEPS_EXTERN extern
828#define Z_DEVICE_DEPS_EXTERN
866#define Z_DEVICE_DEPS_DEFINE(node_id, dev_id, ...) \
867 extern Z_DEVICE_DEPS_CONST device_handle_t Z_DEVICE_DEPS_NAME( \
869 Z_DEVICE_DEPS_CONST Z_DECL_ALIGN(device_handle_t) \
870 Z_DEVICE_DEPS_SECTION Z_DEVICE_DEPS_EXTERN __weak \
871 Z_DEVICE_DEPS_NAME(dev_id)[] = { \
873 DT_NODE_EXISTS(node_id), \
874 (DT_DEP_ORD(node_id), DT_REQUIRES_DEP_ORDS(node_id)), \
875 (DEVICE_HANDLE_NULL,)) \
877 Z_DEVICE_EXTRA_DEPS(__VA_ARGS__) \
879 COND_CODE_1(DT_NODE_EXISTS(node_id), \
880 (DT_SUPPORTS_DEP_ORDS(node_id)), ()) \
884#if defined(CONFIG_DEVICE_DT_METADATA) || defined(__DOXYGEN__)
888struct device_dt_nodelabels {
890 size_t num_nodelabels;
894 const char *nodelabels[];
904struct device_dt_metadata {
909 const struct device_dt_nodelabels *nl;
930__syscall
const struct device *device_get_by_dt_nodelabel(
const char *nodelabel);
937static inline const struct device_dt_nodelabels *
938device_get_dt_nodelabels(
const struct device *dev)
952#define Z_DEVICE_MAX_NODELABEL_LEN Z_DEVICE_MAX_NAME_LEN
958#define Z_DEVICE_DT_METADATA_NAME_GET(dev_id) UTIL_CAT(__dev_dt_meta_, dev_id)
964#define Z_DEVICE_DT_NODELABELS_NAME_GET(dev_id) UTIL_CAT(__dev_dt_nodelabels_, dev_id)
972#define Z_DEVICE_DT_METADATA_DEFINE(node_id, dev_id) \
973 static const struct device_dt_nodelabels \
974 Z_DEVICE_DT_NODELABELS_NAME_GET(dev_id) = { \
975 .num_nodelabels = DT_NUM_NODELABELS(node_id), \
976 .nodelabels = DT_NODELABEL_STRING_ARRAY(node_id), \
979 static const struct device_dt_metadata \
980 Z_DEVICE_DT_METADATA_NAME_GET(dev_id) = { \
981 .nl = &Z_DEVICE_DT_NODELABELS_NAME_GET(dev_id), \
992#define Z_DEVICE_INIT_SUB_PRIO(node_id) \
993 COND_CODE_1(DT_NODE_EXISTS(node_id), \
994 (DT_DEP_ORD_STR_SORTABLE(node_id)), (0))
1002#define Z_DEVICE_MAX_NAME_LEN 48U
1009#define Z_DEVICE_NAME_CHECK(name) \
1010 BUILD_ASSERT(sizeof(Z_STRINGIFY(name)) <= Z_DEVICE_MAX_NAME_LEN, \
1011 Z_STRINGIFY(name) " too long")
1026#define Z_DEVICE_INIT(name_, pm_, data_, config_, api_, state_, deps_, node_id_, \
1030 .config = (config_), \
1032 .state = (state_), \
1034 IF_ENABLED(CONFIG_DEVICE_DEPS, (.deps = (deps_),)) \
1035 IF_ENABLED(CONFIG_PM_DEVICE, Z_DEVICE_INIT_PM_BASE(pm_)) \
1036 IF_ENABLED(CONFIG_DEVICE_DT_METADATA, \
1037 (IF_ENABLED(DT_NODE_EXISTS(node_id_), \
1038 (.dt_meta = &Z_DEVICE_DT_METADATA_NAME_GET( \
1047#if defined(__STDC_VERSION__) && (__STDC_VERSION__) < 201100
1048# define Z_DEVICE_INIT_PM_BASE(pm_) ({ .pm_base = (pm_),},)
1050# define Z_DEVICE_INIT_PM_BASE(pm_) (.pm_base = (pm_),)
1059#define Z_DEVICE_SECTION_NAME(level, prio) \
1060 _CONCAT(INIT_LEVEL_ORD(level), _##prio)
1078#define Z_DEVICE_BASE_DEFINE(node_id, dev_id, name, pm, data, config, level, prio, api, state, \
1080 COND_CODE_1(DT_NODE_EXISTS(node_id), (), (static)) \
1081 COND_CODE_1(Z_DEVICE_IS_MUTABLE(node_id), (), (const)) \
1082 STRUCT_SECTION_ITERABLE_NAMED_ALTERNATE( \
1083 device, COND_CODE_1(Z_DEVICE_IS_MUTABLE(node_id), (device_mutable), (device)), \
1084 Z_DEVICE_SECTION_NAME(level, prio), DEVICE_NAME_GET(dev_id)) = \
1085 Z_DEVICE_INIT(name, pm, data, config, api, state, deps, node_id, dev_id)
1092#define Z_DEVICE_CHECK_INIT_LEVEL(level) \
1093 COND_CODE_1(Z_INIT_PRE_KERNEL_1_##level, (), \
1094 (COND_CODE_1(Z_INIT_PRE_KERNEL_2_##level, (), \
1095 (COND_CODE_1(Z_INIT_POST_KERNEL_##level, (), \
1096 (ZERO_OR_COMPILE_ERROR(0)))))))
1108#define Z_DEVICE_INIT_ENTRY_DEFINE(node_id, dev_id, init_fn_, level, prio) \
1109 Z_DEVICE_CHECK_INIT_LEVEL(level) \
1111 static const Z_DECL_ALIGN(struct init_entry) __used __noasan Z_INIT_ENTRY_SECTION( \
1112 level, prio, Z_DEVICE_INIT_SUB_PRIO(node_id)) \
1113 Z_INIT_ENTRY_NAME(DEVICE_NAME_GET(dev_id)) = { \
1114 .init_fn = {COND_CODE_1(Z_DEVICE_IS_MUTABLE(node_id), (.dev_rw), (.dev)) = \
1116 Z_DEVICE_INIT_ENTRY_DEV(node_id, dev_id), \
1119#define Z_DEFER_DEVICE_INIT_ENTRY_DEFINE(node_id, dev_id, init_fn_) \
1120 static const Z_DECL_ALIGN(struct init_entry) __used __noasan \
1121 __attribute__((__section__(".z_deferred_init"))) \
1122 Z_INIT_ENTRY_NAME(DEVICE_NAME_GET(dev_id)) = { \
1123 .init_fn = {COND_CODE_1(Z_DEVICE_IS_MUTABLE(node_id), (.dev_rw), (.dev)) = \
1125 Z_DEVICE_INIT_ENTRY_DEV(node_id, dev_id), \
1133#if defined(__STDC_VERSION__) && (__STDC_VERSION__) < 201100
1134# define Z_DEVICE_INIT_ENTRY_DEV(node_id, dev_id) { Z_DEV_ENTRY_DEV(node_id, dev_id) }
1136# define Z_DEVICE_INIT_ENTRY_DEV(node_id, dev_id) Z_DEV_ENTRY_DEV(node_id, dev_id)
1139#define Z_DEV_ENTRY_DEV(node_id, dev_id) \
1140 COND_CODE_1(Z_DEVICE_IS_MUTABLE(node_id), (.dev_rw), (.dev)) = &DEVICE_NAME_GET(dev_id)
1163#define Z_DEVICE_DEFINE(node_id, dev_id, name, init_fn, pm, data, config, \
1164 level, prio, api, state, ...) \
1165 Z_DEVICE_NAME_CHECK(name); \
1167 IF_ENABLED(CONFIG_DEVICE_DEPS, \
1168 (Z_DEVICE_DEPS_DEFINE(node_id, dev_id, __VA_ARGS__);)) \
1170 IF_ENABLED(CONFIG_DEVICE_DT_METADATA, \
1171 (IF_ENABLED(DT_NODE_EXISTS(node_id), \
1172 (Z_DEVICE_DT_METADATA_DEFINE(node_id, dev_id);))))\
1174 Z_DEVICE_BASE_DEFINE(node_id, dev_id, name, pm, data, config, level, \
1175 prio, api, state, Z_DEVICE_DEPS_NAME(dev_id)); \
1176 COND_CODE_1(DEVICE_DT_DEFER(node_id), \
1177 (Z_DEFER_DEVICE_INIT_ENTRY_DEFINE(node_id, dev_id, \
1179 (Z_DEVICE_INIT_ENTRY_DEFINE(node_id, dev_id, init_fn, \
1192#define Z_MAYBE_DEVICE_DECLARE_INTERNAL(node_id) \
1193 extern COND_CODE_1(Z_DEVICE_IS_MUTABLE(node_id), (), \
1194 (const)) struct device DEVICE_DT_NAME_GET(node_id);
1204#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:72
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:539
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:619
static device_handle_t device_handle_get(const struct device *dev)
Get the handle for a given device.
Definition device.h:458
#define DEVICE_HANDLE_NULL
Flag value used to identify an unknown device.
Definition device.h:75
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:482
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:517
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:575
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:2942
#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:380
bool initialized
Indicates the device initialization function has been invoked.
Definition device.h:393
uint8_t init_res
Device initialization return code (positive errno value).
Definition device.h:388
Runtime device structure (in ROM) per driver instance.
Definition device.h:412
struct pm_device_base * pm_base
Definition device.h:440
const device_handle_t * deps
Optional pointer to dependencies associated with the device.
Definition device.h:432
struct pm_device_isr * pm_isr
Definition device.h:442
const char * name
Name of the device instance.
Definition device.h:414
struct pm_device * pm
Definition device.h:441
void * data
Address of the device instance private data.
Definition device.h:422
const void * api
Address of the API structure exposed by the device instance.
Definition device.h:418
struct device_state * state
Address of the common device state.
Definition device.h:420
const void * config
Address of device instance config information.
Definition device.h:416
const struct device_dt_metadata * dt_meta
Definition device.h:446
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
Linkable loadable extension symbol definitions.