[linux-2.6-block.git] / include / linux / property.h

/* SPDX-License-Identifier: GPL-2.0-only */
/*
 * property.h - Unified device property interface.
 *
 * Copyright (C) 2014, Intel Corporation
 * Authors: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
 *          Mika Westerberg <mika.westerberg@linux.intel.com>
 */

#ifndef _LINUX_PROPERTY_H_
#define _LINUX_PROPERTY_H_

#include <linux/bits.h>
#include <linux/fwnode.h>
#include <linux/types.h>

struct device;

enum dev_prop_type {
	DEV_PROP_U8,
	DEV_PROP_U16,
	DEV_PROP_U32,
	DEV_PROP_U64,
	DEV_PROP_STRING,
	DEV_PROP_REF,
};

enum dev_dma_attr {
	DEV_DMA_NOT_SUPPORTED,
	DEV_DMA_NON_COHERENT,
	DEV_DMA_COHERENT,
};

struct fwnode_handle *dev_fwnode(struct device *dev);

bool device_property_present(struct device *dev, const char *propname);
int device_property_read_u8_array(struct device *dev, const char *propname,
				  u8 *val, size_t nval);
int device_property_read_u16_array(struct device *dev, const char *propname,
				   u16 *val, size_t nval);
int device_property_read_u32_array(struct device *dev, const char *propname,
				   u32 *val, size_t nval);
int device_property_read_u64_array(struct device *dev, const char *propname,
				   u64 *val, size_t nval);
int device_property_read_string_array(struct device *dev, const char *propname,
				      const char **val, size_t nval);
int device_property_read_string(struct device *dev, const char *propname,
				const char **val);
int device_property_match_string(struct device *dev,
				 const char *propname, const char *string);

bool fwnode_device_is_available(const struct fwnode_handle *fwnode);
bool fwnode_property_present(const struct fwnode_handle *fwnode,
			     const char *propname);
int fwnode_property_read_u8_array(const struct fwnode_handle *fwnode,
				  const char *propname, u8 *val,
				  size_t nval);
int fwnode_property_read_u16_array(const struct fwnode_handle *fwnode,
				   const char *propname, u16 *val,
				   size_t nval);
int fwnode_property_read_u32_array(const struct fwnode_handle *fwnode,
				   const char *propname, u32 *val,
				   size_t nval);
int fwnode_property_read_u64_array(const struct fwnode_handle *fwnode,
				   const char *propname, u64 *val,
				   size_t nval);
int fwnode_property_read_string_array(const struct fwnode_handle *fwnode,
				      const char *propname, const char **val,
				      size_t nval);
int fwnode_property_read_string(const struct fwnode_handle *fwnode,
				const char *propname, const char **val);
int fwnode_property_match_string(const struct fwnode_handle *fwnode,
				 const char *propname, const char *string);
int fwnode_property_get_reference_args(const struct fwnode_handle *fwnode,
				       const char *prop, const char *nargs_prop,
				       unsigned int nargs, unsigned int index,
				       struct fwnode_reference_args *args);

struct fwnode_handle *fwnode_find_reference(const struct fwnode_handle *fwnode,
					    const char *name,
					    unsigned int index);

const char *fwnode_get_name(const struct fwnode_handle *fwnode);
const char *fwnode_get_name_prefix(const struct fwnode_handle *fwnode);
struct fwnode_handle *fwnode_get_parent(const struct fwnode_handle *fwnode);
struct fwnode_handle *fwnode_get_next_parent(
	struct fwnode_handle *fwnode);
unsigned int fwnode_count_parents(const struct fwnode_handle *fwn);
struct fwnode_handle *fwnode_get_nth_parent(struct fwnode_handle *fwn,
					    unsigned int depth);
struct fwnode_handle *fwnode_get_next_child_node(
	const struct fwnode_handle *fwnode, struct fwnode_handle *child);
struct fwnode_handle *fwnode_get_next_available_child_node(
	const struct fwnode_handle *fwnode, struct fwnode_handle *child);

#define fwnode_for_each_child_node(fwnode, child)			\
	for (child = fwnode_get_next_child_node(fwnode, NULL); child;	\
	     child = fwnode_get_next_child_node(fwnode, child))

#define fwnode_for_each_available_child_node(fwnode, child)		       \
	for (child = fwnode_get_next_available_child_node(fwnode, NULL); child;\
	     child = fwnode_get_next_available_child_node(fwnode, child))

struct fwnode_handle *device_get_next_child_node(
	struct device *dev, struct fwnode_handle *child);

#define device_for_each_child_node(dev, child)				\
	for (child = device_get_next_child_node(dev, NULL); child;	\
	     child = device_get_next_child_node(dev, child))

struct fwnode_handle *fwnode_get_named_child_node(
	const struct fwnode_handle *fwnode, const char *childname);
struct fwnode_handle *device_get_named_child_node(struct device *dev,
						  const char *childname);

struct fwnode_handle *fwnode_handle_get(struct fwnode_handle *fwnode);
void fwnode_handle_put(struct fwnode_handle *fwnode);

int fwnode_irq_get(struct fwnode_handle *fwnode, unsigned int index);

unsigned int device_get_child_node_count(struct device *dev);

static inline bool device_property_read_bool(struct device *dev,
					     const char *propname)
{
	return device_property_present(dev, propname);
}

static inline int device_property_read_u8(struct device *dev,
					  const char *propname, u8 *val)
{
	return device_property_read_u8_array(dev, propname, val, 1);
}

static inline int device_property_read_u16(struct device *dev,
					   const char *propname, u16 *val)
{
	return device_property_read_u16_array(dev, propname, val, 1);
}

static inline int device_property_read_u32(struct device *dev,
					   const char *propname, u32 *val)
{
	return device_property_read_u32_array(dev, propname, val, 1);
}

static inline int device_property_read_u64(struct device *dev,
					   const char *propname, u64 *val)
{
	return device_property_read_u64_array(dev, propname, val, 1);
}

static inline int device_property_count_u8(struct device *dev, const char *propname)
{
	return device_property_read_u8_array(dev, propname, NULL, 0);
}

static inline int device_property_count_u16(struct device *dev, const char *propname)
{
	return device_property_read_u16_array(dev, propname, NULL, 0);
}

static inline int device_property_count_u32(struct device *dev, const char *propname)
{
	return device_property_read_u32_array(dev, propname, NULL, 0);
}

static inline int device_property_count_u64(struct device *dev, const char *propname)
{
	return device_property_read_u64_array(dev, propname, NULL, 0);
}

static inline int device_property_string_array_count(struct device *dev,
						     const char *propname)
{
	return device_property_read_string_array(dev, propname, NULL, 0);
}

static inline bool fwnode_property_read_bool(const struct fwnode_handle *fwnode,
					     const char *propname)
{
	return fwnode_property_present(fwnode, propname);
}

static inline int fwnode_property_read_u8(const struct fwnode_handle *fwnode,
					  const char *propname, u8 *val)
{
	return fwnode_property_read_u8_array(fwnode, propname, val, 1);
}

static inline int fwnode_property_read_u16(const struct fwnode_handle *fwnode,
					   const char *propname, u16 *val)
{
	return fwnode_property_read_u16_array(fwnode, propname, val, 1);
}

static inline int fwnode_property_read_u32(const struct fwnode_handle *fwnode,
					   const char *propname, u32 *val)
{
	return fwnode_property_read_u32_array(fwnode, propname, val, 1);
}

static inline int fwnode_property_read_u64(const struct fwnode_handle *fwnode,
					   const char *propname, u64 *val)
{
	return fwnode_property_read_u64_array(fwnode, propname, val, 1);
}

static inline int fwnode_property_count_u8(const struct fwnode_handle *fwnode,
					   const char *propname)
{
	return fwnode_property_read_u8_array(fwnode, propname, NULL, 0);
}

static inline int fwnode_property_count_u16(const struct fwnode_handle *fwnode,
					    const char *propname)
{
	return fwnode_property_read_u16_array(fwnode, propname, NULL, 0);
}

static inline int fwnode_property_count_u32(const struct fwnode_handle *fwnode,
					    const char *propname)
{
	return fwnode_property_read_u32_array(fwnode, propname, NULL, 0);
}

static inline int fwnode_property_count_u64(const struct fwnode_handle *fwnode,
					    const char *propname)
{
	return fwnode_property_read_u64_array(fwnode, propname, NULL, 0);
}

static inline int
fwnode_property_string_array_count(const struct fwnode_handle *fwnode,
				   const char *propname)
{
	return fwnode_property_read_string_array(fwnode, propname, NULL, 0);
}

struct software_node;

/**
 * struct software_node_ref_args - Reference property with additional arguments
 * @node: Reference to a software node
 * @nargs: Number of elements in @args array
 * @args: Integer arguments
 */
struct software_node_ref_args {
	const struct software_node *node;
	unsigned int nargs;
	u64 args[NR_FWNODE_REFERENCE_ARGS];
};

/**
 * struct property_entry - "Built-in" device property representation.
 * @name: Name of the property.
 * @length: Length of data making up the value.
 * @is_inline: True when the property value is stored inline.
 * @type: Type of the data in unions.
 * @pointer: Pointer to the property when it is not stored inline.
 * @value: Value of the property when it is stored inline.
 */
struct property_entry {
	const char *name;
	size_t length;
	bool is_inline;
	enum dev_prop_type type;
	union {
		const void *pointer;
		union {
			u8 u8_data[sizeof(u64) / sizeof(u8)];
			u16 u16_data[sizeof(u64) / sizeof(u16)];
			u32 u32_data[sizeof(u64) / sizeof(u32)];
			u64 u64_data[sizeof(u64) / sizeof(u64)];
			const char *str[sizeof(u64) / sizeof(char *)];
		} value;
	};
};

/*
 * Note: the below initializers for the anonymous union are carefully
 * crafted to avoid gcc-4.4.4's problems with initialization of anon unions
 * and structs.
 */

#define __PROPERTY_ENTRY_ELEMENT_SIZE(_elem_)				\
	sizeof(((struct property_entry *)NULL)->value._elem_[0])

#define __PROPERTY_ENTRY_ARRAY_ELSIZE_LEN(_name_, _elsize_, _Type_,	\
					  _val_, _len_)			\
(struct property_entry) {						\
	.name = _name_,							\
	.length = (_len_) * (_elsize_),					\
	.type = DEV_PROP_##_Type_,					\
	{ .pointer = _val_ },						\
}

#define __PROPERTY_ENTRY_ARRAY_LEN(_name_, _elem_, _Type_, _val_, _len_)\
	__PROPERTY_ENTRY_ARRAY_ELSIZE_LEN(_name_,			\
				__PROPERTY_ENTRY_ELEMENT_SIZE(_elem_),	\
				_Type_, _val_, _len_)

#define PROPERTY_ENTRY_U8_ARRAY_LEN(_name_, _val_, _len_)		\
	__PROPERTY_ENTRY_ARRAY_LEN(_name_, u8_data, U8, _val_, _len_)
#define PROPERTY_ENTRY_U16_ARRAY_LEN(_name_, _val_, _len_)		\
	__PROPERTY_ENTRY_ARRAY_LEN(_name_, u16_data, U16, _val_, _len_)
#define PROPERTY_ENTRY_U32_ARRAY_LEN(_name_, _val_, _len_)		\
	__PROPERTY_ENTRY_ARRAY_LEN(_name_, u32_data, U32, _val_, _len_)
#define PROPERTY_ENTRY_U64_ARRAY_LEN(_name_, _val_, _len_)		\
	__PROPERTY_ENTRY_ARRAY_LEN(_name_, u64_data, U64, _val_, _len_)
#define PROPERTY_ENTRY_STRING_ARRAY_LEN(_name_, _val_, _len_)		\
	__PROPERTY_ENTRY_ARRAY_LEN(_name_, str, STRING, _val_, _len_)
#define PROPERTY_ENTRY_REF_ARRAY_LEN(_name_, _val_, _len_)		\
	__PROPERTY_ENTRY_ARRAY_ELSIZE_LEN(_name_,			\
				sizeof(struct software_node_ref_args),	\
				REF, _val_, _len_)

#define PROPERTY_ENTRY_U8_ARRAY(_name_, _val_)				\
	PROPERTY_ENTRY_U8_ARRAY_LEN(_name_, _val_, ARRAY_SIZE(_val_))
#define PROPERTY_ENTRY_U16_ARRAY(_name_, _val_)				\
	PROPERTY_ENTRY_U16_ARRAY_LEN(_name_, _val_, ARRAY_SIZE(_val_))
#define PROPERTY_ENTRY_U32_ARRAY(_name_, _val_)				\
	PROPERTY_ENTRY_U32_ARRAY_LEN(_name_, _val_, ARRAY_SIZE(_val_))
#define PROPERTY_ENTRY_U64_ARRAY(_name_, _val_)				\
	PROPERTY_ENTRY_U64_ARRAY_LEN(_name_, _val_, ARRAY_SIZE(_val_))
#define PROPERTY_ENTRY_STRING_ARRAY(_name_, _val_)			\
	PROPERTY_ENTRY_STRING_ARRAY_LEN(_name_, _val_, ARRAY_SIZE(_val_))
#define PROPERTY_ENTRY_REF_ARRAY(_name_, _val_)			\
	PROPERTY_ENTRY_REF_ARRAY_LEN(_name_, _val_, ARRAY_SIZE(_val_))

#define __PROPERTY_ENTRY_ELEMENT(_name_, _elem_, _Type_, _val_)		\
(struct property_entry) {						\
	.name = _name_,							\
	.length = __PROPERTY_ENTRY_ELEMENT_SIZE(_elem_),		\
	.is_inline = true,						\
	.type = DEV_PROP_##_Type_,					\
	{ .value = { ._elem_[0] = _val_ } },				\
}

#define PROPERTY_ENTRY_U8(_name_, _val_)				\
	__PROPERTY_ENTRY_ELEMENT(_name_, u8_data, U8, _val_)
#define PROPERTY_ENTRY_U16(_name_, _val_)				\
	__PROPERTY_ENTRY_ELEMENT(_name_, u16_data, U16, _val_)
#define PROPERTY_ENTRY_U32(_name_, _val_)				\
	__PROPERTY_ENTRY_ELEMENT(_name_, u32_data, U32, _val_)
#define PROPERTY_ENTRY_U64(_name_, _val_)				\
	__PROPERTY_ENTRY_ELEMENT(_name_, u64_data, U64, _val_)
#define PROPERTY_ENTRY_STRING(_name_, _val_)				\
	__PROPERTY_ENTRY_ELEMENT(_name_, str, STRING, _val_)

#define PROPERTY_ENTRY_BOOL(_name_)		\
(struct property_entry) {			\
	.name = _name_,				\
	.is_inline = true,			\
}

#define PROPERTY_ENTRY_REF(_name_, _ref_, ...)				\
(struct property_entry) {						\
	.name = _name_,							\
	.length = sizeof(struct software_node_ref_args),		\
	.type = DEV_PROP_REF,						\
	{ .pointer = &(const struct software_node_ref_args) {		\
		.node = _ref_,						\
		.nargs = ARRAY_SIZE(((u64[]){ 0, ##__VA_ARGS__ })) - 1,	\
		.args = { __VA_ARGS__ },				\
	} },								\
}

struct property_entry *
property_entries_dup(const struct property_entry *properties);

void property_entries_free(const struct property_entry *properties);

int device_add_properties(struct device *dev,
			  const struct property_entry *properties);
void device_remove_properties(struct device *dev);

bool device_dma_supported(struct device *dev);

enum dev_dma_attr device_get_dma_attr(struct device *dev);

const void *device_get_match_data(struct device *dev);

int device_get_phy_mode(struct device *dev);

void *device_get_mac_address(struct device *dev, char *addr, int alen);

int fwnode_get_phy_mode(struct fwnode_handle *fwnode);
void *fwnode_get_mac_address(struct fwnode_handle *fwnode,
			     char *addr, int alen);
struct fwnode_handle *fwnode_graph_get_next_endpoint(
	const struct fwnode_handle *fwnode, struct fwnode_handle *prev);
struct fwnode_handle *
fwnode_graph_get_port_parent(const struct fwnode_handle *fwnode);
struct fwnode_handle *fwnode_graph_get_remote_port_parent(
	const struct fwnode_handle *fwnode);
struct fwnode_handle *fwnode_graph_get_remote_port(
	const struct fwnode_handle *fwnode);
struct fwnode_handle *fwnode_graph_get_remote_endpoint(
	const struct fwnode_handle *fwnode);
struct fwnode_handle *
fwnode_graph_get_remote_node(const struct fwnode_handle *fwnode, u32 port,
			     u32 endpoint);

static inline bool fwnode_graph_is_endpoint(struct fwnode_handle *fwnode)
{
	return fwnode_property_present(fwnode, "remote-endpoint");
}

/*
 * Fwnode lookup flags
 *
 * @FWNODE_GRAPH_ENDPOINT_NEXT: In the case of no exact match, look for the
 *				closest endpoint ID greater than the specified
 *				one.
 * @FWNODE_GRAPH_DEVICE_DISABLED: That the device to which the remote
 *				  endpoint of the given endpoint belongs to,
 *				  may be disabled.
 */
#define FWNODE_GRAPH_ENDPOINT_NEXT	BIT(0)
#define FWNODE_GRAPH_DEVICE_DISABLED	BIT(1)

struct fwnode_handle *
fwnode_graph_get_endpoint_by_id(const struct fwnode_handle *fwnode,
				u32 port, u32 endpoint, unsigned long flags);

#define fwnode_graph_for_each_endpoint(fwnode, child)			\
	for (child = NULL;						\
	     (child = fwnode_graph_get_next_endpoint(fwnode, child)); )

int fwnode_graph_parse_endpoint(const struct fwnode_handle *fwnode,
				struct fwnode_endpoint *endpoint);

typedef void *(*devcon_match_fn_t)(struct fwnode_handle *fwnode, const char *id,
				   void *data);

void *fwnode_connection_find_match(struct fwnode_handle *fwnode,
				   const char *con_id, void *data,
				   devcon_match_fn_t match);

static inline void *device_connection_find_match(struct device *dev,
						 const char *con_id, void *data,
						 devcon_match_fn_t match)
{
	return fwnode_connection_find_match(dev_fwnode(dev), con_id, data, match);
}

/* -------------------------------------------------------------------------- */
/* Software fwnode support - when HW description is incomplete or missing */

/**
 * struct software_node - Software node description
 * @name: Name of the software node
 * @parent: Parent of the software node
 * @properties: Array of device properties
 */
struct software_node {
	const char *name;
	const struct software_node *parent;
	const struct property_entry *properties;
};

bool is_software_node(const struct fwnode_handle *fwnode);
const struct software_node *
to_software_node(const struct fwnode_handle *fwnode);
struct fwnode_handle *software_node_fwnode(const struct software_node *node);

const struct software_node *
software_node_find_by_name(const struct software_node *parent,
			   const char *name);

int software_node_register_nodes(const struct software_node *nodes);
void software_node_unregister_nodes(const struct software_node *nodes);

int software_node_register_node_group(const struct software_node **node_group);
void software_node_unregister_node_group(const struct software_node **node_group);

int software_node_register(const struct software_node *node);
void software_node_unregister(const struct software_node *node);

int software_node_notify(struct device *dev, unsigned long action);

struct fwnode_handle *
fwnode_create_software_node(const struct property_entry *properties,
			    const struct fwnode_handle *parent);
void fwnode_remove_software_node(struct fwnode_handle *fwnode);

#endif /* _LINUX_PROPERTY_H_ */
Commit	Line	Data
d2912cb1	1	/* SPDX-License-Identifier: GPL-2.0-only */
b31384fa RW	2	/*
	3	* property.h - Unified device property interface.
	4	*
	5	* Copyright (C) 2014, Intel Corporation
	6	* Authors: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
	7	* Mika Westerberg <mika.westerberg@linux.intel.com>
b31384fa RW	8	*/
	9
	10	#ifndef _LINUX_PROPERTY_H_
	11	#define _LINUX_PROPERTY_H_
	12
0fcc2bdc	13	#include <linux/bits.h>
ce793486	14	#include <linux/fwnode.h>
b31384fa RW	15	#include <linux/types.h>
	16
	17	struct device;
	18
	19	enum dev_prop_type {
	20	DEV_PROP_U8,
	21	DEV_PROP_U16,
	22	DEV_PROP_U32,
	23	DEV_PROP_U64,
	24	DEV_PROP_STRING,
e64b674b	25	DEV_PROP_REF,
b31384fa RW	26	};
b31384fa RW	27
1b9863c6 SS	28	enum dev_dma_attr {
	29	DEV_DMA_NOT_SUPPORTED,
	30	DEV_DMA_NON_COHERENT,
	31	DEV_DMA_COHERENT,
	32	};
	33
e44bb0cb SA	34	struct fwnode_handle dev_fwnode(struct device dev);
e44bb0cb SA	35
b31384fa RW	36	bool device_property_present(struct device dev, const char propname);
	37	int device_property_read_u8_array(struct device dev, const char propname,
	38	u8 *val, size_t nval);
	39	int device_property_read_u16_array(struct device dev, const char propname,
	40	u16 *val, size_t nval);
	41	int device_property_read_u32_array(struct device dev, const char propname,
	42	u32 *val, size_t nval);
	43	int device_property_read_u64_array(struct device dev, const char propname,
	44	u64 *val, size_t nval);
	45	int device_property_read_string_array(struct device dev, const char propname,
	46	const char **val, size_t nval);
	47	int device_property_read_string(struct device dev, const char propname,
	48	const char **val);
3f5c8d31 MW	49	int device_property_match_string(struct device *dev,
3f5c8d31 MW	50	const char propname, const char string);
b31384fa	51
37ba983c SA	52	bool fwnode_device_is_available(const struct fwnode_handle *fwnode);
	53	bool fwnode_property_present(const struct fwnode_handle *fwnode,
	54	const char *propname);
	55	int fwnode_property_read_u8_array(const struct fwnode_handle *fwnode,
8a0662d9 RW	56	const char propname, u8 val,
8a0662d9 RW	57	size_t nval);
37ba983c	58	int fwnode_property_read_u16_array(const struct fwnode_handle *fwnode,
8a0662d9 RW	59	const char propname, u16 val,
8a0662d9 RW	60	size_t nval);
37ba983c	61	int fwnode_property_read_u32_array(const struct fwnode_handle *fwnode,
8a0662d9 RW	62	const char propname, u32 val,
8a0662d9 RW	63	size_t nval);
37ba983c	64	int fwnode_property_read_u64_array(const struct fwnode_handle *fwnode,
8a0662d9 RW	65	const char propname, u64 val,
8a0662d9 RW	66	size_t nval);
37ba983c	67	int fwnode_property_read_string_array(const struct fwnode_handle *fwnode,
8a0662d9 RW	68	const char propname, const char *val,
8a0662d9 RW	69	size_t nval);
37ba983c	70	int fwnode_property_read_string(const struct fwnode_handle *fwnode,
8a0662d9	71	const char propname, const char *val);
37ba983c	72	int fwnode_property_match_string(const struct fwnode_handle *fwnode,
3f5c8d31	73	const char propname, const char string);
3e3119d3 SA	74	int fwnode_property_get_reference_args(const struct fwnode_handle *fwnode,
	75	const char prop, const char nargs_prop,
	76	unsigned int nargs, unsigned int index,
	77	struct fwnode_reference_args *args);
8a0662d9	78
83b34afb HK	79	struct fwnode_handle fwnode_find_reference(const struct fwnode_handle fwnode,
	80	const char *name,
	81	unsigned int index);
	82
bc0500c1	83	const char fwnode_get_name(const struct fwnode_handle fwnode);
e7e242bc	84	const char fwnode_get_name_prefix(const struct fwnode_handle fwnode);
37ba983c SA	85	struct fwnode_handle fwnode_get_parent(const struct fwnode_handle fwnode);
	86	struct fwnode_handle *fwnode_get_next_parent(
	87	struct fwnode_handle *fwnode);
87e5e95d SA	88	unsigned int fwnode_count_parents(const struct fwnode_handle *fwn);
	89	struct fwnode_handle fwnode_get_nth_parent(struct fwnode_handle fwn,
	90	unsigned int depth);
37ba983c SA	91	struct fwnode_handle *fwnode_get_next_child_node(
37ba983c SA	92	const struct fwnode_handle fwnode, struct fwnode_handle child);
3395de96 MW	93	struct fwnode_handle *fwnode_get_next_available_child_node(
3395de96 MW	94	const struct fwnode_handle fwnode, struct fwnode_handle child);
34055190 MW	95
	96	#define fwnode_for_each_child_node(fwnode, child) \
	97	for (child = fwnode_get_next_child_node(fwnode, NULL); child; \
	98	child = fwnode_get_next_child_node(fwnode, child))
afaf26fd	99
3395de96 MW	100	#define fwnode_for_each_available_child_node(fwnode, child) \
	101	for (child = fwnode_get_next_available_child_node(fwnode, NULL); child;\
	102	child = fwnode_get_next_available_child_node(fwnode, child))
	103
37ba983c SA	104	struct fwnode_handle *device_get_next_child_node(
37ba983c SA	105	struct device dev, struct fwnode_handle child);
8a0662d9	106
1d656fb7 AS	107	#define device_for_each_child_node(dev, child) \
1d656fb7 AS	108	for (child = device_get_next_child_node(dev, NULL); child; \
8a0662d9 RW	109	child = device_get_next_child_node(dev, child))
8a0662d9 RW	110
37ba983c SA	111	struct fwnode_handle *fwnode_get_named_child_node(
37ba983c SA	112	const struct fwnode_handle fwnode, const char childname);
613e9721 AT	113	struct fwnode_handle device_get_named_child_node(struct device dev,
	114	const char *childname);
	115
cf89a31c	116	struct fwnode_handle fwnode_handle_get(struct fwnode_handle fwnode);
8a0662d9 RW	117	void fwnode_handle_put(struct fwnode_handle *fwnode);
8a0662d9 RW	118
7c6c57f2 MW	119	int fwnode_irq_get(struct fwnode_handle *fwnode, unsigned int index);
7c6c57f2 MW	120
8a0662d9 RW	121	unsigned int device_get_child_node_count(struct device *dev);
8a0662d9 RW	122
b31384fa RW	123	static inline bool device_property_read_bool(struct device *dev,
	124	const char *propname)
	125	{
	126	return device_property_present(dev, propname);
	127	}
	128
	129	static inline int device_property_read_u8(struct device *dev,
	130	const char propname, u8 val)
	131	{
	132	return device_property_read_u8_array(dev, propname, val, 1);
	133	}
	134
	135	static inline int device_property_read_u16(struct device *dev,
	136	const char propname, u16 val)
	137	{
	138	return device_property_read_u16_array(dev, propname, val, 1);
	139	}
	140
	141	static inline int device_property_read_u32(struct device *dev,
	142	const char propname, u32 val)
	143	{
	144	return device_property_read_u32_array(dev, propname, val, 1);
	145	}
	146
	147	static inline int device_property_read_u64(struct device *dev,
	148	const char propname, u64 val)
	149	{
	150	return device_property_read_u64_array(dev, propname, val, 1);
	151	}
	152
33ee09cd AS	153	static inline int device_property_count_u8(struct device dev, const char propname)
	154	{
	155	return device_property_read_u8_array(dev, propname, NULL, 0);
	156	}
	157
	158	static inline int device_property_count_u16(struct device dev, const char propname)
	159	{
	160	return device_property_read_u16_array(dev, propname, NULL, 0);
	161	}
	162
	163	static inline int device_property_count_u32(struct device dev, const char propname)
	164	{
	165	return device_property_read_u32_array(dev, propname, NULL, 0);
	166	}
	167
	168	static inline int device_property_count_u64(struct device dev, const char propname)
	169	{
	170	return device_property_read_u64_array(dev, propname, NULL, 0);
	171	}
	172
6b6ff4ac BG	173	static inline int device_property_string_array_count(struct device *dev,
	174	const char *propname)
	175	{
	176	return device_property_read_string_array(dev, propname, NULL, 0);
	177	}
	178
37ba983c	179	static inline bool fwnode_property_read_bool(const struct fwnode_handle *fwnode,
8a0662d9 RW	180	const char *propname)
	181	{
	182	return fwnode_property_present(fwnode, propname);
	183	}
	184
37ba983c	185	static inline int fwnode_property_read_u8(const struct fwnode_handle *fwnode,
8a0662d9 RW	186	const char propname, u8 val)
	187	{
	188	return fwnode_property_read_u8_array(fwnode, propname, val, 1);
	189	}
	190
37ba983c	191	static inline int fwnode_property_read_u16(const struct fwnode_handle *fwnode,
8a0662d9 RW	192	const char propname, u16 val)
	193	{
	194	return fwnode_property_read_u16_array(fwnode, propname, val, 1);
	195	}
	196
37ba983c	197	static inline int fwnode_property_read_u32(const struct fwnode_handle *fwnode,
8a0662d9 RW	198	const char propname, u32 val)
	199	{
	200	return fwnode_property_read_u32_array(fwnode, propname, val, 1);
	201	}
	202
37ba983c	203	static inline int fwnode_property_read_u64(const struct fwnode_handle *fwnode,
8a0662d9 RW	204	const char propname, u64 val)
	205	{
	206	return fwnode_property_read_u64_array(fwnode, propname, val, 1);
	207	}
	208
33ee09cd AS	209	static inline int fwnode_property_count_u8(const struct fwnode_handle *fwnode,
	210	const char *propname)
	211	{
	212	return fwnode_property_read_u8_array(fwnode, propname, NULL, 0);
	213	}
	214
	215	static inline int fwnode_property_count_u16(const struct fwnode_handle *fwnode,
	216	const char *propname)
	217	{
	218	return fwnode_property_read_u16_array(fwnode, propname, NULL, 0);
	219	}
	220
	221	static inline int fwnode_property_count_u32(const struct fwnode_handle *fwnode,
	222	const char *propname)
	223	{
	224	return fwnode_property_read_u32_array(fwnode, propname, NULL, 0);
	225	}
	226
	227	static inline int fwnode_property_count_u64(const struct fwnode_handle *fwnode,
	228	const char *propname)
	229	{
	230	return fwnode_property_read_u64_array(fwnode, propname, NULL, 0);
	231	}
	232
6b6ff4ac BG	233	static inline int
	234	fwnode_property_string_array_count(const struct fwnode_handle *fwnode,
	235	const char *propname)
	236	{
	237	return fwnode_property_read_string_array(fwnode, propname, NULL, 0);
	238	}
	239
e64b674b DT	240	struct software_node;
	241
	242	/**
	243	* struct software_node_ref_args - Reference property with additional arguments
	244	* @node: Reference to a software node
	245	* @nargs: Number of elements in @args array
	246	* @args: Integer arguments
	247	*/
	248	struct software_node_ref_args {
	249	const struct software_node *node;
	250	unsigned int nargs;
	251	u64 args[NR_FWNODE_REFERENCE_ARGS];
	252	};
	253
16ba08d5 RW	254	/**
	255	* struct property_entry - "Built-in" device property representation.
	256	* @name: Name of the property.
318a1971	257	* @length: Length of data making up the value.
e6bff466	258	* @is_inline: True when the property value is stored inline.
63dcc709	259	* @type: Type of the data in unions.
e6bff466 DT	260	* @pointer: Pointer to the property when it is not stored inline.
e6bff466 DT	261	* @value: Value of the property when it is stored inline.
16ba08d5 RW	262	*/
	263	struct property_entry {
	264	const char *name;
318a1971	265	size_t length;
e6bff466	266	bool is_inline;
63dcc709	267	enum dev_prop_type type;
16ba08d5	268	union {
1f74d70f	269	const void *pointer;
66586bab	270	union {
996b0830 DT	271	u8 u8_data[sizeof(u64) / sizeof(u8)];
	272	u16 u16_data[sizeof(u64) / sizeof(u16)];
	273	u32 u32_data[sizeof(u64) / sizeof(u32)];
	274	u64 u64_data[sizeof(u64) / sizeof(u64)];
	275	const char str[sizeof(u64) / sizeof(char )];
66586bab AS	276	} value;
66586bab AS	277	};
16ba08d5 RW	278	};
16ba08d5 RW	279
d76eebfa	280	/*
daeba9bf	281	* Note: the below initializers for the anonymous union are carefully
d76eebfa AM	282	* crafted to avoid gcc-4.4.4's problems with initialization of anon unions
	283	* and structs.
	284	*/
	285
daeba9bf	286	#define __PROPERTY_ENTRY_ELEMENT_SIZE(_elem_) \
996b0830	287	sizeof(((struct property_entry *)NULL)->value._elem_[0])
daeba9bf	288
e64b674b DT	289	#define __PROPERTY_ENTRY_ARRAY_ELSIZE_LEN(_name_, _elsize_, _Type_, \
e64b674b DT	290	_val_, _len_) \
63dcc709 AS	291	(struct property_entry) { \
63dcc709 AS	292	.name = _name_, \
e64b674b	293	.length = (_len_) * (_elsize_), \
63dcc709	294	.type = DEV_PROP_##_Type_, \
1f74d70f	295	{ .pointer = _val_ }, \
a85f4204 HK	296	}
a85f4204 HK	297
e64b674b DT	298	#define __PROPERTY_ENTRY_ARRAY_LEN(_name_, _elem_, _Type_, _val_, _len_)\
	299	__PROPERTY_ENTRY_ARRAY_ELSIZE_LEN(_name_, \
	300	__PROPERTY_ENTRY_ELEMENT_SIZE(_elem_), \
	301	_Type_, _val_, _len_)
	302
1741cfac	303	#define PROPERTY_ENTRY_U8_ARRAY_LEN(_name_, _val_, _len_) \
daeba9bf	304	__PROPERTY_ENTRY_ARRAY_LEN(_name_, u8_data, U8, _val_, _len_)
1741cfac	305	#define PROPERTY_ENTRY_U16_ARRAY_LEN(_name_, _val_, _len_) \
daeba9bf	306	__PROPERTY_ENTRY_ARRAY_LEN(_name_, u16_data, U16, _val_, _len_)
1741cfac	307	#define PROPERTY_ENTRY_U32_ARRAY_LEN(_name_, _val_, _len_) \
daeba9bf	308	__PROPERTY_ENTRY_ARRAY_LEN(_name_, u32_data, U32, _val_, _len_)
1741cfac	309	#define PROPERTY_ENTRY_U64_ARRAY_LEN(_name_, _val_, _len_) \
daeba9bf	310	__PROPERTY_ENTRY_ARRAY_LEN(_name_, u64_data, U64, _val_, _len_)
1741cfac	311	#define PROPERTY_ENTRY_STRING_ARRAY_LEN(_name_, _val_, _len_) \
daeba9bf	312	__PROPERTY_ENTRY_ARRAY_LEN(_name_, str, STRING, _val_, _len_)
e64b674b DT	313	#define PROPERTY_ENTRY_REF_ARRAY_LEN(_name_, _val_, _len_) \
	314	__PROPERTY_ENTRY_ARRAY_ELSIZE_LEN(_name_, \
	315	sizeof(struct software_node_ref_args), \
	316	REF, _val_, _len_)
a85f4204	317
1741cfac DT	318	#define PROPERTY_ENTRY_U8_ARRAY(_name_, _val_) \
	319	PROPERTY_ENTRY_U8_ARRAY_LEN(_name_, _val_, ARRAY_SIZE(_val_))
	320	#define PROPERTY_ENTRY_U16_ARRAY(_name_, _val_) \
	321	PROPERTY_ENTRY_U16_ARRAY_LEN(_name_, _val_, ARRAY_SIZE(_val_))
	322	#define PROPERTY_ENTRY_U32_ARRAY(_name_, _val_) \
	323	PROPERTY_ENTRY_U32_ARRAY_LEN(_name_, _val_, ARRAY_SIZE(_val_))
	324	#define PROPERTY_ENTRY_U64_ARRAY(_name_, _val_) \
	325	PROPERTY_ENTRY_U64_ARRAY_LEN(_name_, _val_, ARRAY_SIZE(_val_))
	326	#define PROPERTY_ENTRY_STRING_ARRAY(_name_, _val_) \
	327	PROPERTY_ENTRY_STRING_ARRAY_LEN(_name_, _val_, ARRAY_SIZE(_val_))
e64b674b DT	328	#define PROPERTY_ENTRY_REF_ARRAY(_name_, _val_) \
e64b674b DT	329	PROPERTY_ENTRY_REF_ARRAY_LEN(_name_, _val_, ARRAY_SIZE(_val_))
1741cfac	330
daeba9bf DT	331	#define __PROPERTY_ENTRY_ELEMENT(_name_, _elem_, _Type_, _val_) \
	332	(struct property_entry) { \
	333	.name = _name_, \
	334	.length = __PROPERTY_ENTRY_ELEMENT_SIZE(_elem_), \
e6bff466	335	.is_inline = true, \
daeba9bf	336	.type = DEV_PROP_##_Type_, \
996b0830	337	{ .value = { ._elem_[0] = _val_ } }, \
a85f4204 HK	338	}
a85f4204 HK	339
daeba9bf DT	340	#define PROPERTY_ENTRY_U8(_name_, _val_) \
	341	__PROPERTY_ENTRY_ELEMENT(_name_, u8_data, U8, _val_)
	342	#define PROPERTY_ENTRY_U16(_name_, _val_) \
	343	__PROPERTY_ENTRY_ELEMENT(_name_, u16_data, U16, _val_)
	344	#define PROPERTY_ENTRY_U32(_name_, _val_) \
	345	__PROPERTY_ENTRY_ELEMENT(_name_, u32_data, U32, _val_)
	346	#define PROPERTY_ENTRY_U64(_name_, _val_) \
	347	__PROPERTY_ENTRY_ELEMENT(_name_, u64_data, U64, _val_)
	348	#define PROPERTY_ENTRY_STRING(_name_, _val_) \
	349	__PROPERTY_ENTRY_ELEMENT(_name_, str, STRING, _val_)
a85f4204 HK	350
a85f4204 HK	351	#define PROPERTY_ENTRY_BOOL(_name_) \
c505cbd4	352	(struct property_entry) { \
a85f4204	353	.name = _name_, \
e6bff466	354	.is_inline = true, \
a85f4204 HK	355	}
a85f4204 HK	356
e64b674b DT	357	#define PROPERTY_ENTRY_REF(_name_, _ref_, ...) \
	358	(struct property_entry) { \
	359	.name = _name_, \
	360	.length = sizeof(struct software_node_ref_args), \
	361	.type = DEV_PROP_REF, \
	362	{ .pointer = &(const struct software_node_ref_args) { \
	363	.node = _ref_, \
	364	.nargs = ARRAY_SIZE(((u64[]){ 0, ##__VA_ARGS__ })) - 1, \
	365	.args = { __VA_ARGS__ }, \
	366	} }, \
	367	}
	368
2d479e1f DT	369	struct property_entry *
	370	property_entries_dup(const struct property_entry *properties);
	371
	372	void property_entries_free(const struct property_entry *properties);
	373
f4d05266	374	int device_add_properties(struct device *dev,
bec84da8	375	const struct property_entry *properties);
f4d05266	376	void device_remove_properties(struct device *dev);
16ba08d5	377
e5e55864 SS	378	bool device_dma_supported(struct device *dev);
	379
	380	enum dev_dma_attr device_get_dma_attr(struct device *dev);
b283f157	381
67dcc26d	382	const void device_get_match_data(struct device dev);
e5e55864	383
4c96b7dc JL	384	int device_get_phy_mode(struct device *dev);
	385
	386	void device_get_mac_address(struct device dev, char *addr, int alen);
	387
b28f263b	388	int fwnode_get_phy_mode(struct fwnode_handle *fwnode);
babe2dbb MW	389	void fwnode_get_mac_address(struct fwnode_handle fwnode,
babe2dbb MW	390	char *addr, int alen);
07bb80d4	391	struct fwnode_handle *fwnode_graph_get_next_endpoint(
37ba983c	392	const struct fwnode_handle fwnode, struct fwnode_handle prev);
6a71d8d7	393	struct fwnode_handle *
37ba983c	394	fwnode_graph_get_port_parent(const struct fwnode_handle *fwnode);
07bb80d4	395	struct fwnode_handle *fwnode_graph_get_remote_port_parent(
37ba983c	396	const struct fwnode_handle *fwnode);
07bb80d4	397	struct fwnode_handle *fwnode_graph_get_remote_port(
37ba983c	398	const struct fwnode_handle *fwnode);
07bb80d4	399	struct fwnode_handle *fwnode_graph_get_remote_endpoint(
37ba983c SA	400	const struct fwnode_handle *fwnode);
	401	struct fwnode_handle *
	402	fwnode_graph_get_remote_node(const struct fwnode_handle *fwnode, u32 port,
	403	u32 endpoint);
07bb80d4	404
35694afc LP	405	static inline bool fwnode_graph_is_endpoint(struct fwnode_handle *fwnode)
	406	{
	407	return fwnode_property_present(fwnode, "remote-endpoint");
	408	}
	409
0fcc2bdc SA	410	/*
	411	* Fwnode lookup flags
	412	*
	413	* @FWNODE_GRAPH_ENDPOINT_NEXT: In the case of no exact match, look for the
	414	* closest endpoint ID greater than the specified
	415	* one.
	416	* @FWNODE_GRAPH_DEVICE_DISABLED: That the device to which the remote
	417	* endpoint of the given endpoint belongs to,
	418	* may be disabled.
	419	*/
	420	#define FWNODE_GRAPH_ENDPOINT_NEXT BIT(0)
	421	#define FWNODE_GRAPH_DEVICE_DISABLED BIT(1)
	422
	423	struct fwnode_handle *
	424	fwnode_graph_get_endpoint_by_id(const struct fwnode_handle *fwnode,
	425	u32 port, u32 endpoint, unsigned long flags);
	426
5e4b1b70 SA	427	#define fwnode_graph_for_each_endpoint(fwnode, child) \
	428	for (child = NULL; \
	429	(child = fwnode_graph_get_next_endpoint(fwnode, child)); )
	430
37ba983c	431	int fwnode_graph_parse_endpoint(const struct fwnode_handle *fwnode,
2bd5452d SA	432	struct fwnode_endpoint *endpoint);
2bd5452d SA	433
d7cf5590 HK	434	typedef void (devcon_match_fn_t)(struct fwnode_handle fwnode, const char id,
	435	void *data);
	436
	437	void fwnode_connection_find_match(struct fwnode_handle fwnode,
	438	const char con_id, void data,
	439	devcon_match_fn_t match);
	440
	441	static inline void device_connection_find_match(struct device dev,
	442	const char con_id, void data,
	443	devcon_match_fn_t match)
	444	{
	445	return fwnode_connection_find_match(dev_fwnode(dev), con_id, data, match);
	446	}
	447
59abd836 HK	448	/* -------------------------------------------------------------------------- */
	449	/* Software fwnode support - when HW description is incomplete or missing */
	450
80488a6b HK	451	/**
	452	* struct software_node - Software node description
	453	* @name: Name of the software node
	454	* @parent: Parent of the software node
	455	* @properties: Array of device properties
	456	*/
	457	struct software_node {
	458	const char *name;
	459	const struct software_node *parent;
	460	const struct property_entry *properties;
	461	};
	462
59abd836	463	bool is_software_node(const struct fwnode_handle *fwnode);
56c9aa07 SA	464	const struct software_node *
56c9aa07 SA	465	to_software_node(const struct fwnode_handle *fwnode);
80488a6b HK	466	struct fwnode_handle software_node_fwnode(const struct software_node node);
80488a6b HK	467
1666faed HK	468	const struct software_node *
	469	software_node_find_by_name(const struct software_node *parent,
	470	const char *name);
	471
80488a6b HK	472	int software_node_register_nodes(const struct software_node *nodes);
	473	void software_node_unregister_nodes(const struct software_node *nodes);
	474
02094d54 AS	475	int software_node_register_node_group(const struct software_node **node_group);
	476	void software_node_unregister_node_group(const struct software_node **node_group);
	477
80488a6b	478	int software_node_register(const struct software_node *node);
46d26819	479	void software_node_unregister(const struct software_node *node);
59abd836 HK	480
	481	int software_node_notify(struct device *dev, unsigned long action);
	482
	483	struct fwnode_handle *
	484	fwnode_create_software_node(const struct property_entry *properties,
	485	const struct fwnode_handle *parent);
	486	void fwnode_remove_software_node(struct fwnode_handle *fwnode);
	487
b31384fa	488	#endif /* _LINUX_PROPERTY_H_ */