device.h File Reference

#include <stdint.h>
#include <zephyr/devicetree.h>
#include <zephyr/init.h>
#include <zephyr/linker/sections.h>
#include <zephyr/sys/device_mmio.h>
#include <zephyr/sys/util.h>
#include <syscalls/device.h>

Go to the source code of this file.

Data Structures
struct	device_state
	Runtime device dynamic structure (in RAM) per driver instance. More...
struct	device
	Runtime device structure (in ROM) per driver instance. More...

Macros
#define	DEVICE_HANDLE_SEP   INT16_MIN
	Flag value used in lists of device handles to separate distinct groups. More...
#define	DEVICE_HANDLE_ENDS   INT16_MAX
	Flag value used in lists of device handles to indicate the end of the list. More...
#define	DEVICE_HANDLE_NULL   0
	Flag value used to identify an unknown device. More...
#define	DEVICE_NAME_GET(dev_id)   _CONCAT(__device_, dev_id)
	Expands to the name of a global device object. More...
#define	DEVICE_DEFINE(dev_id, name, init_fn, pm, data, config, level, prio, api)
	Create a device object and set it up for boot time initialization. More...
#define	DEVICE_DT_NAME(node_id)    DT_PROP_OR(node_id, label, DT_NODE_FULL_NAME(node_id))
	Return a string name for a devicetree node. More...
#define	DEVICE_DT_DEFINE(node_id, init_fn, pm, data, config, level, prio, api, ...)
	Create a device object from a devicetree node identifier and set it up for boot time initialization. More...
#define	DEVICE_DT_INST_DEFINE(inst, ...)    DEVICE_DT_DEFINE(DT_DRV_INST(inst), __VA_ARGS__)
	Like DEVICE_DT_DEFINE(), but uses an instance of a DT_DRV_COMPAT compatible instead of a node identifier. More...
#define	DEVICE_DT_NAME_GET(node_id)   DEVICE_NAME_GET(Z_DEVICE_DT_DEV_ID(node_id))
	The name of the global device object for node_id. More...
#define	DEVICE_DT_GET(node_id)   (&DEVICE_DT_NAME_GET(node_id))
	Get a device reference from a devicetree node identifier. More...
#define	DEVICE_DT_INST_GET(inst)   DEVICE_DT_GET(DT_DRV_INST(inst))
	Get a device reference for an instance of a DT_DRV_COMPAT compatible. More...
#define	DEVICE_DT_GET_ANY(compat)
	Get a device reference from a devicetree compatible. More...
#define	DEVICE_DT_GET_ONE(compat)
	Get a device reference from a devicetree compatible. More...
#define	DEVICE_DT_GET_OR_NULL(node_id)
	Utility macro to obtain an optional reference to a device. More...
#define	DEVICE_GET(dev_id)   (&DEVICE_NAME_GET(dev_id))
	Obtain a pointer to a device object by name. More...
#define	DEVICE_DECLARE(dev_id)    static const struct device DEVICE_NAME_GET(dev_id)
	Declare a static device object. More...
#define	DEVICE_INIT_DT_GET(node_id)    (&Z_INIT_ENTRY_NAME(DEVICE_DT_NAME_GET(node_id)))
	Get a init_entry reference from a devicetree node. More...
#define	DEVICE_INIT_GET(dev_id)   (&Z_INIT_ENTRY_NAME(DEVICE_NAME_GET(dev_id)))
	Get a init_entry reference from a device identifier. More...

Typedefs
typedef int16_t	device_handle_t
	Type used to represent a "handle" for a device. More...
typedef int(*	device_visitor_callback_t) (const struct device *dev, void *context)
	Prototype for functions used when iterating over a set of devices. More...

Functions
static device_handle_t	device_handle_get (const struct device *dev)
	Get the handle for a given device. More...
static const struct device *	device_from_handle (device_handle_t dev_handle)
	Get the device corresponding to a handle. More...
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. More...
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. More...
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. More...
int	device_required_foreach (const struct device *dev, device_visitor_callback_t visitor_cb, void *context)
	Visit every device that dev directly requires. More...
int	device_supported_foreach (const struct device *dev, device_visitor_callback_t visitor_cb, void *context)
	Visit every device that dev directly supports. More...
const struct device *	device_get_binding (const char *name)
	Get a device reference from its device::name field. More...
bool	device_is_ready (const struct device *dev)
	Verify that a device is ready for use. More...