[mirror_ubuntu-hirsute-kernel.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_MAX,
};

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

/**
 * struct property_entry - "Built-in" device property representation.
 * @name: Name of the property.
 * @length: Length of data making up the value.
 * @is_array: True when the property is an array.
 * @type: Type of the data in unions.
 * @pointer: Pointer to the property (an array of items of the given type).
 * @value: Value of the property (when it is a single item of the given type).
 */
struct property_entry {
	const char *name;
	size_t length;
	bool is_array;
	enum dev_prop_type type;
	union {
		union {
			const u8 *u8_data;
			const u16 *u16_data;
			const u32 *u32_data;
			const u64 *u64_data;
			const char * const *str;
		} pointer;
		union {
			u8 u8_data;
			u16 u16_data;
			u32 u32_data;
			u64 u64_data;
			const char *str;
		} value;
	};
};

/*
 * Note: the below four 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_INTEGER_ARRAY(_name_, _type_, _Type_, _val_)	\
(struct property_entry) {						\
	.name = _name_,							\
	.length = ARRAY_SIZE(_val_) * sizeof(_type_),			\
	.is_array = true,						\
	.type = DEV_PROP_##_Type_,					\
	{ .pointer = { ._type_##_data = _val_ } },			\
}

#define PROPERTY_ENTRY_U8_ARRAY(_name_, _val_)			\
	PROPERTY_ENTRY_INTEGER_ARRAY(_name_, u8, U8, _val_)
#define PROPERTY_ENTRY_U16_ARRAY(_name_, _val_)			\
	PROPERTY_ENTRY_INTEGER_ARRAY(_name_, u16, U16, _val_)
#define PROPERTY_ENTRY_U32_ARRAY(_name_, _val_)			\
	PROPERTY_ENTRY_INTEGER_ARRAY(_name_, u32, U32, _val_)
#define PROPERTY_ENTRY_U64_ARRAY(_name_, _val_)			\
	PROPERTY_ENTRY_INTEGER_ARRAY(_name_, u64, U64, _val_)

#define PROPERTY_ENTRY_STRING_ARRAY(_name_, _val_)		\
(struct property_entry) {					\
	.name = _name_,						\
	.length = ARRAY_SIZE(_val_) * sizeof(const char *),	\
	.is_array = true,					\
	.type = DEV_PROP_STRING,				\
	{ .pointer = { .str = _val_ } },			\
}

#define PROPERTY_ENTRY_INTEGER(_name_, _type_, _Type_, _val_)	\
(struct property_entry) {					\
	.name = _name_,						\
	.length = sizeof(_type_),				\
	.type = DEV_PROP_##_Type_,				\
	{ .value = { ._type_##_data = _val_ } },		\
}

#define PROPERTY_ENTRY_U8(_name_, _val_)		\
	PROPERTY_ENTRY_INTEGER(_name_, u8, U8, _val_)
#define PROPERTY_ENTRY_U16(_name_, _val_)		\
	PROPERTY_ENTRY_INTEGER(_name_, u16, U16, _val_)
#define PROPERTY_ENTRY_U32(_name_, _val_)		\
	PROPERTY_ENTRY_INTEGER(_name_, u32, U32, _val_)
#define PROPERTY_ENTRY_U64(_name_, _val_)		\
	PROPERTY_ENTRY_INTEGER(_name_, u64, U64, _val_)

#define PROPERTY_ENTRY_STRING(_name_, _val_)		\
(struct property_entry) {				\
	.name = _name_,					\
	.length = sizeof(const char *),			\
	.type = DEV_PROP_STRING,			\
	{ .value = { .str = _val_ } },			\
}

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

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

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

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

struct software_node;

/**
 * struct software_node_ref_args - Reference 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 software_node_reference - Named software node reference property
 * @name: Name of the property
 * @nrefs: Number of elements in @refs array
 * @refs: Array of references with optional arguments
 */
struct software_node_reference {
	const char *name;
	unsigned int nrefs;
	const struct software_node_ref_args *refs;
};

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

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(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,
	25	DEV_PROP_MAX,
	26	};
	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
37ba983c	173	static inline bool fwnode_property_read_bool(const struct fwnode_handle *fwnode,
8a0662d9 RW	174	const char *propname)
	175	{
	176	return fwnode_property_present(fwnode, propname);
	177	}
	178
37ba983c	179	static inline int fwnode_property_read_u8(const struct fwnode_handle *fwnode,
8a0662d9 RW	180	const char propname, u8 val)
	181	{
	182	return fwnode_property_read_u8_array(fwnode, propname, val, 1);
	183	}
	184
37ba983c	185	static inline int fwnode_property_read_u16(const struct fwnode_handle *fwnode,
8a0662d9 RW	186	const char propname, u16 val)
	187	{
	188	return fwnode_property_read_u16_array(fwnode, propname, val, 1);
	189	}
	190
37ba983c	191	static inline int fwnode_property_read_u32(const struct fwnode_handle *fwnode,
8a0662d9 RW	192	const char propname, u32 val)
	193	{
	194	return fwnode_property_read_u32_array(fwnode, propname, val, 1);
	195	}
	196
37ba983c	197	static inline int fwnode_property_read_u64(const struct fwnode_handle *fwnode,
8a0662d9 RW	198	const char propname, u64 val)
	199	{
	200	return fwnode_property_read_u64_array(fwnode, propname, val, 1);
	201	}
	202
33ee09cd AS	203	static inline int fwnode_property_count_u8(const struct fwnode_handle *fwnode,
	204	const char *propname)
	205	{
	206	return fwnode_property_read_u8_array(fwnode, propname, NULL, 0);
	207	}
	208
	209	static inline int fwnode_property_count_u16(const struct fwnode_handle *fwnode,
	210	const char *propname)
	211	{
	212	return fwnode_property_read_u16_array(fwnode, propname, NULL, 0);
	213	}
	214
	215	static inline int fwnode_property_count_u32(const struct fwnode_handle *fwnode,
	216	const char *propname)
	217	{
	218	return fwnode_property_read_u32_array(fwnode, propname, NULL, 0);
	219	}
	220
	221	static inline int fwnode_property_count_u64(const struct fwnode_handle *fwnode,
	222	const char *propname)
	223	{
	224	return fwnode_property_read_u64_array(fwnode, propname, NULL, 0);
	225	}
	226
16ba08d5 RW	227	/**
	228	* struct property_entry - "Built-in" device property representation.
	229	* @name: Name of the property.
318a1971	230	* @length: Length of data making up the value.
66586bab	231	* @is_array: True when the property is an array.
63dcc709	232	* @type: Type of the data in unions.
66586bab AS	233	* @pointer: Pointer to the property (an array of items of the given type).
66586bab AS	234	* @value: Value of the property (when it is a single item of the given type).
16ba08d5 RW	235	*/
	236	struct property_entry {
	237	const char *name;
318a1971	238	size_t length;
66586bab	239	bool is_array;
63dcc709	240	enum dev_prop_type type;
16ba08d5	241	union {
66586bab	242	union {
9426998c DT	243	const u8 *u8_data;
	244	const u16 *u16_data;
	245	const u32 *u32_data;
	246	const u64 *u64_data;
	247	const char * const *str;
66586bab AS	248	} pointer;
66586bab AS	249	union {
66586bab AS	250	u8 u8_data;
	251	u16 u16_data;
	252	u32 u32_data;
	253	u64 u64_data;
	254	const char *str;
	255	} value;
	256	};
16ba08d5 RW	257	};
16ba08d5 RW	258
d76eebfa AM	259	/*
	260	* Note: the below four initializers for the anonymous union are carefully
	261	* crafted to avoid gcc-4.4.4's problems with initialization of anon unions
	262	* and structs.
	263	*/
	264
63dcc709 AS	265	#define PROPERTY_ENTRY_INTEGER_ARRAY(_name_, _type_, _Type_, _val_) \
	266	(struct property_entry) { \
	267	.name = _name_, \
	268	.length = ARRAY_SIZE(_val_) * sizeof(_type_), \
	269	.is_array = true, \
	270	.type = DEV_PROP_##_Type_, \
	271	{ .pointer = { ._type_##_data = _val_ } }, \
a85f4204 HK	272	}
	273
	274	#define PROPERTY_ENTRY_U8_ARRAY(_name_, _val_) \
63dcc709	275	PROPERTY_ENTRY_INTEGER_ARRAY(_name_, u8, U8, _val_)
a85f4204	276	#define PROPERTY_ENTRY_U16_ARRAY(_name_, _val_) \
63dcc709	277	PROPERTY_ENTRY_INTEGER_ARRAY(_name_, u16, U16, _val_)
a85f4204	278	#define PROPERTY_ENTRY_U32_ARRAY(_name_, _val_) \
63dcc709	279	PROPERTY_ENTRY_INTEGER_ARRAY(_name_, u32, U32, _val_)
a85f4204	280	#define PROPERTY_ENTRY_U64_ARRAY(_name_, _val_) \
63dcc709	281	PROPERTY_ENTRY_INTEGER_ARRAY(_name_, u64, U64, _val_)
a85f4204 HK	282
a85f4204 HK	283	#define PROPERTY_ENTRY_STRING_ARRAY(_name_, _val_) \
c505cbd4	284	(struct property_entry) { \
a85f4204 HK	285	.name = _name_, \
	286	.length = ARRAY_SIZE(_val_) * sizeof(const char *), \
	287	.is_array = true, \
63dcc709	288	.type = DEV_PROP_STRING, \
d76eebfa	289	{ .pointer = { .str = _val_ } }, \
a85f4204 HK	290	}
a85f4204 HK	291
63dcc709 AS	292	#define PROPERTY_ENTRY_INTEGER(_name_, _type_, _Type_, _val_) \
	293	(struct property_entry) { \
	294	.name = _name_, \
	295	.length = sizeof(_type_), \
	296	.type = DEV_PROP_##_Type_, \
	297	{ .value = { ._type_##_data = _val_ } }, \
a85f4204 HK	298	}
	299
	300	#define PROPERTY_ENTRY_U8(_name_, _val_) \
63dcc709	301	PROPERTY_ENTRY_INTEGER(_name_, u8, U8, _val_)
a85f4204	302	#define PROPERTY_ENTRY_U16(_name_, _val_) \
63dcc709	303	PROPERTY_ENTRY_INTEGER(_name_, u16, U16, _val_)
a85f4204	304	#define PROPERTY_ENTRY_U32(_name_, _val_) \
63dcc709	305	PROPERTY_ENTRY_INTEGER(_name_, u32, U32, _val_)
a85f4204	306	#define PROPERTY_ENTRY_U64(_name_, _val_) \
63dcc709	307	PROPERTY_ENTRY_INTEGER(_name_, u64, U64, _val_)
a85f4204 HK	308
a85f4204 HK	309	#define PROPERTY_ENTRY_STRING(_name_, _val_) \
c505cbd4	310	(struct property_entry) { \
a85f4204	311	.name = _name_, \
2b6e4924	312	.length = sizeof(const char *), \
63dcc709	313	.type = DEV_PROP_STRING, \
aace7367	314	{ .value = { .str = _val_ } }, \
a85f4204 HK	315	}
	316
	317	#define PROPERTY_ENTRY_BOOL(_name_) \
c505cbd4	318	(struct property_entry) { \
a85f4204 HK	319	.name = _name_, \
	320	}
	321
2d479e1f DT	322	struct property_entry *
	323	property_entries_dup(const struct property_entry *properties);
	324
	325	void property_entries_free(const struct property_entry *properties);
	326
f4d05266	327	int device_add_properties(struct device *dev,
bec84da8	328	const struct property_entry *properties);
f4d05266	329	void device_remove_properties(struct device *dev);
16ba08d5	330
e5e55864 SS	331	bool device_dma_supported(struct device *dev);
	332
	333	enum dev_dma_attr device_get_dma_attr(struct device *dev);
b283f157	334
67dcc26d	335	const void device_get_match_data(struct device dev);
e5e55864	336
4c96b7dc JL	337	int device_get_phy_mode(struct device *dev);
	338
	339	void device_get_mac_address(struct device dev, char *addr, int alen);
	340
b28f263b	341	int fwnode_get_phy_mode(struct fwnode_handle *fwnode);
babe2dbb MW	342	void fwnode_get_mac_address(struct fwnode_handle fwnode,
babe2dbb MW	343	char *addr, int alen);
07bb80d4	344	struct fwnode_handle *fwnode_graph_get_next_endpoint(
37ba983c	345	const struct fwnode_handle fwnode, struct fwnode_handle prev);
6a71d8d7	346	struct fwnode_handle *
37ba983c	347	fwnode_graph_get_port_parent(const struct fwnode_handle *fwnode);
07bb80d4	348	struct fwnode_handle *fwnode_graph_get_remote_port_parent(
37ba983c	349	const struct fwnode_handle *fwnode);
07bb80d4	350	struct fwnode_handle *fwnode_graph_get_remote_port(
37ba983c	351	const struct fwnode_handle *fwnode);
07bb80d4	352	struct fwnode_handle *fwnode_graph_get_remote_endpoint(
37ba983c SA	353	const struct fwnode_handle *fwnode);
	354	struct fwnode_handle *
	355	fwnode_graph_get_remote_node(const struct fwnode_handle *fwnode, u32 port,
	356	u32 endpoint);
07bb80d4	357
0fcc2bdc SA	358	/*
	359	* Fwnode lookup flags
	360	*
	361	* @FWNODE_GRAPH_ENDPOINT_NEXT: In the case of no exact match, look for the
	362	* closest endpoint ID greater than the specified
	363	* one.
	364	* @FWNODE_GRAPH_DEVICE_DISABLED: That the device to which the remote
	365	* endpoint of the given endpoint belongs to,
	366	* may be disabled.
	367	*/
	368	#define FWNODE_GRAPH_ENDPOINT_NEXT BIT(0)
	369	#define FWNODE_GRAPH_DEVICE_DISABLED BIT(1)
	370
	371	struct fwnode_handle *
	372	fwnode_graph_get_endpoint_by_id(const struct fwnode_handle *fwnode,
	373	u32 port, u32 endpoint, unsigned long flags);
	374
5e4b1b70 SA	375	#define fwnode_graph_for_each_endpoint(fwnode, child) \
	376	for (child = NULL; \
	377	(child = fwnode_graph_get_next_endpoint(fwnode, child)); )
	378
37ba983c	379	int fwnode_graph_parse_endpoint(const struct fwnode_handle *fwnode,
2bd5452d SA	380	struct fwnode_endpoint *endpoint);
2bd5452d SA	381
59abd836 HK	382	/* -------------------------------------------------------------------------- */
	383	/* Software fwnode support - when HW description is incomplete or missing */
	384
b06184ac HK	385	struct software_node;
	386
	387	/**
	388	* struct software_node_ref_args - Reference with additional arguments
	389	* @node: Reference to a software node
	390	* @nargs: Number of elements in @args array
	391	* @args: Integer arguments
	392	*/
	393	struct software_node_ref_args {
	394	const struct software_node *node;
	395	unsigned int nargs;
	396	u64 args[NR_FWNODE_REFERENCE_ARGS];
	397	};
	398
	399	/**
	400	* struct software_node_reference - Named software node reference property
	401	* @name: Name of the property
	402	* @nrefs: Number of elements in @refs array
	403	* @refs: Array of references with optional arguments
	404	*/
	405	struct software_node_reference {
	406	const char *name;
	407	unsigned int nrefs;
	408	const struct software_node_ref_args *refs;
	409	};
	410
80488a6b HK	411	/**
	412	* struct software_node - Software node description
	413	* @name: Name of the software node
	414	* @parent: Parent of the software node
	415	* @properties: Array of device properties
b06184ac	416	* @references: Array of software node reference properties
80488a6b HK	417	*/
	418	struct software_node {
	419	const char *name;
	420	const struct software_node *parent;
	421	const struct property_entry *properties;
b06184ac	422	const struct software_node_reference *references;
80488a6b HK	423	};
80488a6b HK	424
59abd836	425	bool is_software_node(const struct fwnode_handle *fwnode);
56c9aa07 SA	426	const struct software_node *
56c9aa07 SA	427	to_software_node(const struct fwnode_handle *fwnode);
80488a6b HK	428	struct fwnode_handle software_node_fwnode(const struct software_node node);
80488a6b HK	429
1666faed HK	430	const struct software_node *
	431	software_node_find_by_name(const struct software_node *parent,
	432	const char *name);
	433
80488a6b HK	434	int software_node_register_nodes(const struct software_node *nodes);
	435	void software_node_unregister_nodes(const struct software_node *nodes);
	436
	437	int software_node_register(const struct software_node *node);
59abd836 HK	438
	439	int software_node_notify(struct device *dev, unsigned long action);
	440
	441	struct fwnode_handle *
	442	fwnode_create_software_node(const struct property_entry *properties,
	443	const struct fwnode_handle *parent);
	444	void fwnode_remove_software_node(struct fwnode_handle *fwnode);
	445
b31384fa	446	#endif /* _LINUX_PROPERTY_H_ */