[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;
struct net_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);
struct device *fwnode_get_next_parent_dev(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);
bool fwnode_is_ancestor_of(struct fwnode_handle *test_ancestor,
				  struct fwnode_handle *test_child);
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(const struct fwnode_handle *fwnode, unsigned int index);
int fwnode_irq_get_byname(const struct fwnode_handle *fwnode, const char *name);

void __iomem *fwnode_iomap(struct fwnode_handle *fwnode, 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];
};

#define SOFTWARE_NODE_REFERENCE(_ref_, ...)			\
(const struct software_node_ref_args) {				\
	.node = _ref_,						\
	.nargs = ARRAY_SIZE(((u64[]){ 0, ##__VA_ARGS__ })) - 1,	\
	.args = { __VA_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 = &SOFTWARE_NODE_REFERENCE(_ref_, ##__VA_ARGS__), },	\
}

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

void property_entries_free(const struct property_entry *properties);

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);

int fwnode_get_phy_mode(struct fwnode_handle *fwnode);
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);

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, or that the endpoint is not
 *				  connected.
 */
#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);
unsigned int fwnode_graph_get_endpoint_count(struct fwnode_handle *fwnode,
					     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);

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);

int device_add_software_node(struct device *dev, const struct software_node *node);
void device_remove_software_node(struct device *dev);

int device_create_managed_software_node(struct device *dev,
					const struct property_entry *properties,
					const struct software_node *parent);

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