device.h File Reference

#include <stdint.h>
#include <stdbool.h>
#include <zephyr/device.h>

Go to the source code of this file.

Data Structures
struct	shared_device_dt_spec
	Container for shared device information specified in devicetree. More...
struct	shared_device_api

Macros
#define	SHARED_DEVICE_DT_SPEC_GET_BY_IDX(node_id, prop, idx)
	Static initializer for a shared_device_dt_spec.
#define	SHARED_DEVICE_DT_SPEC_GET_BY_IDX_OR(node_id, prop, idx, default_value)
	Like SHARED_DEVICE_DT_SPEC_GET_BY_IDX(), with a fallback to a default value.
#define	SHARED_DEVICE_DT_SPEC_GET(node_id, prop)
	Equivalent to SHARED_DEVICE_DT_SPEC_GET_BY_IDX(node_id, prop, 0).
#define	SHARED_DEVICE_DT_SPEC_GET_OR(node_id, prop, default_value)
	Equivalent to SHARED_DEVICE_DT_SPEC_GET_BY_IDX_OR(node_id, prop, 0, default_value).
#define	SHARED_DEVICE_DT_SPEC_INST_GET_BY_IDX(inst, prop, idx)
	Static initializer for a shared_device_dt_spec from a DT_DRV_COMPAT instance's shared device property at an index.
#define	SHARED_DEVICE_DT_SPEC_INST_GET_BY_IDX_OR(inst, prop, idx, default_value)
	Static initializer for a shared_device_dt_spec from a DT_DRV_COMPAT instance's shared device property at an index, with fallback.
#define	SHARED_DEVICE_DT_SPEC_INST_GET(inst, prop)
	Equivalent to SHARED_DEVICE_DT_SPEC_INST_GET_BY_IDX(inst, prop, 0).
#define	SHARED_DEVICE_DT_SPEC_INST_GET_OR(inst, prop, default_value)
	Equivalent to SHARED_DEVICE_DT_SPEC_INST_GET_BY_IDX_OR(inst, prop, 0, default_value).

Functions
static bool	shared_device_is_ready_dt (const struct shared_device_dt_spec *spec)
	Validate that the shared device is ready.
static int	shared_device_request (const struct device *dev, uint8_t state_priority, uint8_t state)
	Request a device to be in a given state.
static int	shared_device_request_dt (const struct shared_device_dt_spec *spec)
	Request a shared device from a shared_device_dt_spec.
static int	shared_device_release (const struct device *dev, uint8_t state_priority)
	Release a previous request for a given state.
static int	shared_device_release_dt (const struct shared_device_dt_spec *spec)
	Release a shared device from a shared_device_dt_spec.

Detailed Description

Copyright

2024 Embeint Holdings Pty Ltd

Author

Jordan Yates jorda.nosp@m.n@em.nosp@m.beint.nosp@m..com

SPDX-License-Identifier: FSL-1.1-ALv2