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

/*
 * 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>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation.
 */

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

struct fwnode_handle *fwnode_get_parent(const struct fwnode_handle *fwnode);
struct fwnode_handle *fwnode_get_next_parent(
	struct fwnode_handle *fwnode);
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 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);
}

/**
 * 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(struct fwnode_handle *fwnode);
struct fwnode_handle *software_node_fwnode(const struct software_node *node);

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
b31384fa RW	1	/*
	2	* property.h - Unified device property interface.
	3	*
	4	* Copyright (C) 2014, Intel Corporation
	5	* Authors: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
	6	* Mika Westerberg <mika.westerberg@linux.intel.com>
	7	*
	8	* This program is free software; you can redistribute it and/or modify
	9	* it under the terms of the GNU General Public License version 2 as
	10	* published by the Free Software Foundation.
	11	*/
	12
	13	#ifndef _LINUX_PROPERTY_H_
	14	#define _LINUX_PROPERTY_H_
	15
0fcc2bdc	16	#include <linux/bits.h>
ce793486	17	#include <linux/fwnode.h>
b31384fa RW	18	#include <linux/types.h>
	19
	20	struct device;
	21
	22	enum dev_prop_type {
	23	DEV_PROP_U8,
	24	DEV_PROP_U16,
	25	DEV_PROP_U32,
	26	DEV_PROP_U64,
	27	DEV_PROP_STRING,
	28	DEV_PROP_MAX,
	29	};
	30
1b9863c6 SS	31	enum dev_dma_attr {
	32	DEV_DMA_NOT_SUPPORTED,
	33	DEV_DMA_NON_COHERENT,
	34	DEV_DMA_COHERENT,
	35	};
	36
e44bb0cb SA	37	struct fwnode_handle dev_fwnode(struct device dev);
e44bb0cb SA	38
b31384fa RW	39	bool device_property_present(struct device dev, const char propname);
	40	int device_property_read_u8_array(struct device dev, const char propname,
	41	u8 *val, size_t nval);
	42	int device_property_read_u16_array(struct device dev, const char propname,
	43	u16 *val, size_t nval);
	44	int device_property_read_u32_array(struct device dev, const char propname,
	45	u32 *val, size_t nval);
	46	int device_property_read_u64_array(struct device dev, const char propname,
	47	u64 *val, size_t nval);
	48	int device_property_read_string_array(struct device dev, const char propname,
	49	const char **val, size_t nval);
	50	int device_property_read_string(struct device dev, const char propname,
	51	const char **val);
3f5c8d31 MW	52	int device_property_match_string(struct device *dev,
3f5c8d31 MW	53	const char propname, const char string);
b31384fa	54
37ba983c SA	55	bool fwnode_device_is_available(const struct fwnode_handle *fwnode);
	56	bool fwnode_property_present(const struct fwnode_handle *fwnode,
	57	const char *propname);
	58	int fwnode_property_read_u8_array(const struct fwnode_handle *fwnode,
8a0662d9 RW	59	const char propname, u8 val,
8a0662d9 RW	60	size_t nval);
37ba983c	61	int fwnode_property_read_u16_array(const struct fwnode_handle *fwnode,
8a0662d9 RW	62	const char propname, u16 val,
8a0662d9 RW	63	size_t nval);
37ba983c	64	int fwnode_property_read_u32_array(const struct fwnode_handle *fwnode,
8a0662d9 RW	65	const char propname, u32 val,
8a0662d9 RW	66	size_t nval);
37ba983c	67	int fwnode_property_read_u64_array(const struct fwnode_handle *fwnode,
8a0662d9 RW	68	const char propname, u64 val,
8a0662d9 RW	69	size_t nval);
37ba983c	70	int fwnode_property_read_string_array(const struct fwnode_handle *fwnode,
8a0662d9 RW	71	const char propname, const char *val,
8a0662d9 RW	72	size_t nval);
37ba983c	73	int fwnode_property_read_string(const struct fwnode_handle *fwnode,
8a0662d9	74	const char propname, const char *val);
37ba983c	75	int fwnode_property_match_string(const struct fwnode_handle *fwnode,
3f5c8d31	76	const char propname, const char string);
3e3119d3 SA	77	int fwnode_property_get_reference_args(const struct fwnode_handle *fwnode,
	78	const char prop, const char nargs_prop,
	79	unsigned int nargs, unsigned int index,
	80	struct fwnode_reference_args *args);
8a0662d9	81
83b34afb HK	82	struct fwnode_handle fwnode_find_reference(const struct fwnode_handle fwnode,
	83	const char *name,
	84	unsigned int index);
	85
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);
	89	struct fwnode_handle *fwnode_get_next_child_node(
	90	const struct fwnode_handle fwnode, struct fwnode_handle child);
3395de96 MW	91	struct fwnode_handle *fwnode_get_next_available_child_node(
3395de96 MW	92	const struct fwnode_handle fwnode, struct fwnode_handle child);
34055190 MW	93
	94	#define fwnode_for_each_child_node(fwnode, child) \
	95	for (child = fwnode_get_next_child_node(fwnode, NULL); child; \
	96	child = fwnode_get_next_child_node(fwnode, child))
afaf26fd	97
3395de96 MW	98	#define fwnode_for_each_available_child_node(fwnode, child) \
	99	for (child = fwnode_get_next_available_child_node(fwnode, NULL); child;\
	100	child = fwnode_get_next_available_child_node(fwnode, child))
	101
37ba983c SA	102	struct fwnode_handle *device_get_next_child_node(
37ba983c SA	103	struct device dev, struct fwnode_handle child);
8a0662d9	104
1d656fb7 AS	105	#define device_for_each_child_node(dev, child) \
1d656fb7 AS	106	for (child = device_get_next_child_node(dev, NULL); child; \
8a0662d9 RW	107	child = device_get_next_child_node(dev, child))
8a0662d9 RW	108
37ba983c SA	109	struct fwnode_handle *fwnode_get_named_child_node(
37ba983c SA	110	const struct fwnode_handle fwnode, const char childname);
613e9721 AT	111	struct fwnode_handle device_get_named_child_node(struct device dev,
	112	const char *childname);
	113
cf89a31c	114	struct fwnode_handle fwnode_handle_get(struct fwnode_handle fwnode);
8a0662d9 RW	115	void fwnode_handle_put(struct fwnode_handle *fwnode);
8a0662d9 RW	116
7c6c57f2 MW	117	int fwnode_irq_get(struct fwnode_handle *fwnode, unsigned int index);
7c6c57f2 MW	118
8a0662d9 RW	119	unsigned int device_get_child_node_count(struct device *dev);
8a0662d9 RW	120
b31384fa RW	121	static inline bool device_property_read_bool(struct device *dev,
	122	const char *propname)
	123	{
	124	return device_property_present(dev, propname);
	125	}
	126
	127	static inline int device_property_read_u8(struct device *dev,
	128	const char propname, u8 val)
	129	{
	130	return device_property_read_u8_array(dev, propname, val, 1);
	131	}
	132
	133	static inline int device_property_read_u16(struct device *dev,
	134	const char propname, u16 val)
	135	{
	136	return device_property_read_u16_array(dev, propname, val, 1);
	137	}
	138
	139	static inline int device_property_read_u32(struct device *dev,
	140	const char propname, u32 val)
	141	{
	142	return device_property_read_u32_array(dev, propname, val, 1);
	143	}
	144
	145	static inline int device_property_read_u64(struct device *dev,
	146	const char propname, u64 val)
	147	{
	148	return device_property_read_u64_array(dev, propname, val, 1);
	149	}
	150
37ba983c	151	static inline bool fwnode_property_read_bool(const struct fwnode_handle *fwnode,
8a0662d9 RW	152	const char *propname)
	153	{
	154	return fwnode_property_present(fwnode, propname);
	155	}
	156
37ba983c	157	static inline int fwnode_property_read_u8(const struct fwnode_handle *fwnode,
8a0662d9 RW	158	const char propname, u8 val)
	159	{
	160	return fwnode_property_read_u8_array(fwnode, propname, val, 1);
	161	}
	162
37ba983c	163	static inline int fwnode_property_read_u16(const struct fwnode_handle *fwnode,
8a0662d9 RW	164	const char propname, u16 val)
	165	{
	166	return fwnode_property_read_u16_array(fwnode, propname, val, 1);
	167	}
	168
37ba983c	169	static inline int fwnode_property_read_u32(const struct fwnode_handle *fwnode,
8a0662d9 RW	170	const char propname, u32 val)
	171	{
	172	return fwnode_property_read_u32_array(fwnode, propname, val, 1);
	173	}
	174
37ba983c	175	static inline int fwnode_property_read_u64(const struct fwnode_handle *fwnode,
8a0662d9 RW	176	const char propname, u64 val)
	177	{
	178	return fwnode_property_read_u64_array(fwnode, propname, val, 1);
	179	}
	180
16ba08d5 RW	181	/**
	182	* struct property_entry - "Built-in" device property representation.
	183	* @name: Name of the property.
318a1971	184	* @length: Length of data making up the value.
66586bab	185	* @is_array: True when the property is an array.
63dcc709	186	* @type: Type of the data in unions.
66586bab AS	187	* @pointer: Pointer to the property (an array of items of the given type).
66586bab AS	188	* @value: Value of the property (when it is a single item of the given type).
16ba08d5 RW	189	*/
	190	struct property_entry {
	191	const char *name;
318a1971	192	size_t length;
66586bab	193	bool is_array;
63dcc709	194	enum dev_prop_type type;
16ba08d5	195	union {
66586bab	196	union {
9426998c DT	197	const u8 *u8_data;
	198	const u16 *u16_data;
	199	const u32 *u32_data;
	200	const u64 *u64_data;
	201	const char * const *str;
66586bab AS	202	} pointer;
66586bab AS	203	union {
66586bab AS	204	u8 u8_data;
	205	u16 u16_data;
	206	u32 u32_data;
	207	u64 u64_data;
	208	const char *str;
	209	} value;
	210	};
16ba08d5 RW	211	};
16ba08d5 RW	212
d76eebfa AM	213	/*
	214	* Note: the below four initializers for the anonymous union are carefully
	215	* crafted to avoid gcc-4.4.4's problems with initialization of anon unions
	216	* and structs.
	217	*/
	218
63dcc709 AS	219	#define PROPERTY_ENTRY_INTEGER_ARRAY(_name_, _type_, _Type_, _val_) \
	220	(struct property_entry) { \
	221	.name = _name_, \
	222	.length = ARRAY_SIZE(_val_) * sizeof(_type_), \
	223	.is_array = true, \
	224	.type = DEV_PROP_##_Type_, \
	225	{ .pointer = { ._type_##_data = _val_ } }, \
a85f4204 HK	226	}
	227
	228	#define PROPERTY_ENTRY_U8_ARRAY(_name_, _val_) \
63dcc709	229	PROPERTY_ENTRY_INTEGER_ARRAY(_name_, u8, U8, _val_)
a85f4204	230	#define PROPERTY_ENTRY_U16_ARRAY(_name_, _val_) \
63dcc709	231	PROPERTY_ENTRY_INTEGER_ARRAY(_name_, u16, U16, _val_)
a85f4204	232	#define PROPERTY_ENTRY_U32_ARRAY(_name_, _val_) \
63dcc709	233	PROPERTY_ENTRY_INTEGER_ARRAY(_name_, u32, U32, _val_)
a85f4204	234	#define PROPERTY_ENTRY_U64_ARRAY(_name_, _val_) \
63dcc709	235	PROPERTY_ENTRY_INTEGER_ARRAY(_name_, u64, U64, _val_)
a85f4204 HK	236
a85f4204 HK	237	#define PROPERTY_ENTRY_STRING_ARRAY(_name_, _val_) \
c505cbd4	238	(struct property_entry) { \
a85f4204 HK	239	.name = _name_, \
	240	.length = ARRAY_SIZE(_val_) * sizeof(const char *), \
	241	.is_array = true, \
63dcc709	242	.type = DEV_PROP_STRING, \
d76eebfa	243	{ .pointer = { .str = _val_ } }, \
a85f4204 HK	244	}
a85f4204 HK	245
63dcc709 AS	246	#define PROPERTY_ENTRY_INTEGER(_name_, _type_, _Type_, _val_) \
	247	(struct property_entry) { \
	248	.name = _name_, \
	249	.length = sizeof(_type_), \
	250	.type = DEV_PROP_##_Type_, \
	251	{ .value = { ._type_##_data = _val_ } }, \
a85f4204 HK	252	}
	253
	254	#define PROPERTY_ENTRY_U8(_name_, _val_) \
63dcc709	255	PROPERTY_ENTRY_INTEGER(_name_, u8, U8, _val_)
a85f4204	256	#define PROPERTY_ENTRY_U16(_name_, _val_) \
63dcc709	257	PROPERTY_ENTRY_INTEGER(_name_, u16, U16, _val_)
a85f4204	258	#define PROPERTY_ENTRY_U32(_name_, _val_) \
63dcc709	259	PROPERTY_ENTRY_INTEGER(_name_, u32, U32, _val_)
a85f4204	260	#define PROPERTY_ENTRY_U64(_name_, _val_) \
63dcc709	261	PROPERTY_ENTRY_INTEGER(_name_, u64, U64, _val_)
a85f4204 HK	262
a85f4204 HK	263	#define PROPERTY_ENTRY_STRING(_name_, _val_) \
c505cbd4	264	(struct property_entry) { \
a85f4204	265	.name = _name_, \
2b6e4924	266	.length = sizeof(const char *), \
63dcc709	267	.type = DEV_PROP_STRING, \
aace7367	268	{ .value = { .str = _val_ } }, \
a85f4204 HK	269	}
	270
	271	#define PROPERTY_ENTRY_BOOL(_name_) \
c505cbd4	272	(struct property_entry) { \
a85f4204 HK	273	.name = _name_, \
	274	}
	275
2d479e1f DT	276	struct property_entry *
	277	property_entries_dup(const struct property_entry *properties);
	278
	279	void property_entries_free(const struct property_entry *properties);
	280
f4d05266	281	int device_add_properties(struct device *dev,
bec84da8	282	const struct property_entry *properties);
f4d05266	283	void device_remove_properties(struct device *dev);
16ba08d5	284
e5e55864 SS	285	bool device_dma_supported(struct device *dev);
	286
	287	enum dev_dma_attr device_get_dma_attr(struct device *dev);
b283f157	288
67dcc26d	289	const void device_get_match_data(struct device dev);
e5e55864	290
4c96b7dc JL	291	int device_get_phy_mode(struct device *dev);
	292
	293	void device_get_mac_address(struct device dev, char *addr, int alen);
	294
b28f263b	295	int fwnode_get_phy_mode(struct fwnode_handle *fwnode);
babe2dbb MW	296	void fwnode_get_mac_address(struct fwnode_handle fwnode,
babe2dbb MW	297	char *addr, int alen);
07bb80d4	298	struct fwnode_handle *fwnode_graph_get_next_endpoint(
37ba983c	299	const struct fwnode_handle fwnode, struct fwnode_handle prev);
6a71d8d7	300	struct fwnode_handle *
37ba983c	301	fwnode_graph_get_port_parent(const struct fwnode_handle *fwnode);
07bb80d4	302	struct fwnode_handle *fwnode_graph_get_remote_port_parent(
37ba983c	303	const struct fwnode_handle *fwnode);
07bb80d4	304	struct fwnode_handle *fwnode_graph_get_remote_port(
37ba983c	305	const struct fwnode_handle *fwnode);
07bb80d4	306	struct fwnode_handle *fwnode_graph_get_remote_endpoint(
37ba983c SA	307	const struct fwnode_handle *fwnode);
	308	struct fwnode_handle *
	309	fwnode_graph_get_remote_node(const struct fwnode_handle *fwnode, u32 port,
	310	u32 endpoint);
07bb80d4	311
0fcc2bdc SA	312	/*
	313	* Fwnode lookup flags
	314	*
	315	* @FWNODE_GRAPH_ENDPOINT_NEXT: In the case of no exact match, look for the
	316	* closest endpoint ID greater than the specified
	317	* one.
	318	* @FWNODE_GRAPH_DEVICE_DISABLED: That the device to which the remote
	319	* endpoint of the given endpoint belongs to,
	320	* may be disabled.
	321	*/
	322	#define FWNODE_GRAPH_ENDPOINT_NEXT BIT(0)
	323	#define FWNODE_GRAPH_DEVICE_DISABLED BIT(1)
	324
	325	struct fwnode_handle *
	326	fwnode_graph_get_endpoint_by_id(const struct fwnode_handle *fwnode,
	327	u32 port, u32 endpoint, unsigned long flags);
	328
5e4b1b70 SA	329	#define fwnode_graph_for_each_endpoint(fwnode, child) \
	330	for (child = NULL; \
	331	(child = fwnode_graph_get_next_endpoint(fwnode, child)); )
	332
37ba983c	333	int fwnode_graph_parse_endpoint(const struct fwnode_handle *fwnode,
2bd5452d SA	334	struct fwnode_endpoint *endpoint);
2bd5452d SA	335
59abd836 HK	336	/* -------------------------------------------------------------------------- */
	337	/* Software fwnode support - when HW description is incomplete or missing */
	338
b06184ac HK	339	struct software_node;
	340
	341	/**
	342	* struct software_node_ref_args - Reference with additional arguments
	343	* @node: Reference to a software node
	344	* @nargs: Number of elements in @args array
	345	* @args: Integer arguments
	346	*/
	347	struct software_node_ref_args {
	348	const struct software_node *node;
	349	unsigned int nargs;
	350	u64 args[NR_FWNODE_REFERENCE_ARGS];
	351	};
	352
	353	/**
	354	* struct software_node_reference - Named software node reference property
	355	* @name: Name of the property
	356	* @nrefs: Number of elements in @refs array
	357	* @refs: Array of references with optional arguments
	358	*/
	359	struct software_node_reference {
	360	const char *name;
	361	unsigned int nrefs;
	362	const struct software_node_ref_args *refs;
	363	};
	364
80488a6b HK	365	/**
	366	* struct software_node - Software node description
	367	* @name: Name of the software node
	368	* @parent: Parent of the software node
	369	* @properties: Array of device properties
b06184ac	370	* @references: Array of software node reference properties
80488a6b HK	371	*/
	372	struct software_node {
	373	const char *name;
	374	const struct software_node *parent;
	375	const struct property_entry *properties;
b06184ac	376	const struct software_node_reference *references;
80488a6b HK	377	};
80488a6b HK	378
59abd836	379	bool is_software_node(const struct fwnode_handle *fwnode);
80488a6b HK	380	const struct software_node to_software_node(struct fwnode_handle fwnode);
	381	struct fwnode_handle software_node_fwnode(const struct software_node node);
	382
	383	int software_node_register_nodes(const struct software_node *nodes);
	384	void software_node_unregister_nodes(const struct software_node *nodes);
	385
	386	int software_node_register(const struct software_node *node);
59abd836 HK	387
	388	int software_node_notify(struct device *dev, unsigned long action);
	389
	390	struct fwnode_handle *
	391	fwnode_create_software_node(const struct property_entry *properties,
	392	const struct fwnode_handle *parent);
	393	void fwnode_remove_software_node(struct fwnode_handle *fwnode);
	394
b31384fa	395	#endif /* _LINUX_PROPERTY_H_ */