[mirror_ubuntu-artful-kernel.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/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(struct fwnode_handle *fwnode);
bool fwnode_property_present(struct fwnode_handle *fwnode, const char *propname);
int fwnode_property_read_u8_array(struct fwnode_handle *fwnode,
				  const char *propname, u8 *val,
				  size_t nval);
int fwnode_property_read_u16_array(struct fwnode_handle *fwnode,
				   const char *propname, u16 *val,
				   size_t nval);
int fwnode_property_read_u32_array(struct fwnode_handle *fwnode,
				   const char *propname, u32 *val,
				   size_t nval);
int fwnode_property_read_u64_array(struct fwnode_handle *fwnode,
				   const char *propname, u64 *val,
				   size_t nval);
int fwnode_property_read_string_array(struct fwnode_handle *fwnode,
				      const char *propname, const char **val,
				      size_t nval);
int fwnode_property_read_string(struct fwnode_handle *fwnode,
				const char *propname, const char **val);
int fwnode_property_match_string(struct fwnode_handle *fwnode,
				 const char *propname, const char *string);

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

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(struct fwnode_handle *fwnode,
						  const char *childname);
struct fwnode_handle *device_get_named_child_node(struct device *dev,
						  const char *childname);

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

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(struct fwnode_handle *fwnode,
					     const char *propname)
{
	return fwnode_property_present(fwnode, propname);
}

static inline int fwnode_property_read_u8(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(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(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(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.
 * @is_string: True when property is a string.
 * @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;
	bool is_string;
	union {
		union {
			const void *raw_data;
			const u8 *u8_data;
			const u16 *u16_data;
			const u32 *u32_data;
			const u64 *u64_data;
			const char * const *str;
		} pointer;
		union {
			unsigned long long raw_data;
			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_, _val_)	\
{								\
	.name = _name_,						\
	.length = ARRAY_SIZE(_val_) * sizeof(_type_),		\
	.is_array = true,					\
	.is_string = false,					\
	{ .pointer = { ._type_##_data = _val_ } },		\
}

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

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

#define PROPERTY_ENTRY_INTEGER(_name_, _type_, _val_)	\
{							\
	.name = _name_,					\
	.length = sizeof(_type_),			\
	.is_string = false,				\
	{ .value = { ._type_##_data = _val_ } },	\
}

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

#define PROPERTY_ENTRY_STRING(_name_, _val_)		\
{							\
	.name = _name_,					\
	.length = sizeof(_val_),			\
	.is_string = true,				\
	{ .value = { .str = _val_ } },			\
}

#define PROPERTY_ENTRY_BOOL(_name_)		\
{						\
	.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);

int device_get_phy_mode(struct device *dev);

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

struct fwnode_handle *fwnode_graph_get_next_endpoint(
	struct fwnode_handle *fwnode, struct fwnode_handle *prev);
struct fwnode_handle *
fwnode_graph_get_port_parent(struct fwnode_handle *fwnode);
struct fwnode_handle *fwnode_graph_get_remote_port_parent(
	struct fwnode_handle *fwnode);
struct fwnode_handle *fwnode_graph_get_remote_port(
	struct fwnode_handle *fwnode);
struct fwnode_handle *fwnode_graph_get_remote_endpoint(
	struct fwnode_handle *fwnode);
struct fwnode_handle *fwnode_graph_get_remote_node(struct fwnode_handle *fwnode,
						   u32 port, u32 endpoint);

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

#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
ce793486	16	#include <linux/fwnode.h>
b31384fa RW	17	#include <linux/types.h>
	18
	19	struct device;
	20
	21	enum dev_prop_type {
	22	DEV_PROP_U8,
	23	DEV_PROP_U16,
	24	DEV_PROP_U32,
	25	DEV_PROP_U64,
	26	DEV_PROP_STRING,
	27	DEV_PROP_MAX,
	28	};
	29
1b9863c6 SS	30	enum dev_dma_attr {
	31	DEV_DMA_NOT_SUPPORTED,
	32	DEV_DMA_NON_COHERENT,
	33	DEV_DMA_COHERENT,
	34	};
	35
e44bb0cb SA	36	struct fwnode_handle dev_fwnode(struct device dev);
e44bb0cb SA	37
b31384fa RW	38	bool device_property_present(struct device dev, const char propname);
	39	int device_property_read_u8_array(struct device dev, const char propname,
	40	u8 *val, size_t nval);
	41	int device_property_read_u16_array(struct device dev, const char propname,
	42	u16 *val, size_t nval);
	43	int device_property_read_u32_array(struct device dev, const char propname,
	44	u32 *val, size_t nval);
	45	int device_property_read_u64_array(struct device dev, const char propname,
	46	u64 *val, size_t nval);
	47	int device_property_read_string_array(struct device dev, const char propname,
	48	const char **val, size_t nval);
	49	int device_property_read_string(struct device dev, const char propname,
	50	const char **val);
3f5c8d31 MW	51	int device_property_match_string(struct device *dev,
3f5c8d31 MW	52	const char propname, const char string);
b31384fa	53
2294b3af	54	bool fwnode_device_is_available(struct fwnode_handle *fwnode);
8a0662d9 RW	55	bool fwnode_property_present(struct fwnode_handle fwnode, const char propname);
	56	int fwnode_property_read_u8_array(struct fwnode_handle *fwnode,
	57	const char propname, u8 val,
	58	size_t nval);
	59	int fwnode_property_read_u16_array(struct fwnode_handle *fwnode,
	60	const char propname, u16 val,
	61	size_t nval);
	62	int fwnode_property_read_u32_array(struct fwnode_handle *fwnode,
	63	const char propname, u32 val,
	64	size_t nval);
	65	int fwnode_property_read_u64_array(struct fwnode_handle *fwnode,
	66	const char propname, u64 val,
	67	size_t nval);
	68	int fwnode_property_read_string_array(struct fwnode_handle *fwnode,
	69	const char propname, const char *val,
	70	size_t nval);
	71	int fwnode_property_read_string(struct fwnode_handle *fwnode,
	72	const char propname, const char *val);
3f5c8d31 MW	73	int fwnode_property_match_string(struct fwnode_handle *fwnode,
3f5c8d31 MW	74	const char propname, const char string);
8a0662d9	75
afaf26fd	76	struct fwnode_handle fwnode_get_parent(struct fwnode_handle fwnode);
23387258	77	struct fwnode_handle fwnode_get_next_parent(struct fwnode_handle fwnode);
34055190 MW	78	struct fwnode_handle fwnode_get_next_child_node(struct fwnode_handle fwnode,
	79	struct fwnode_handle *child);
	80
	81	#define fwnode_for_each_child_node(fwnode, child) \
	82	for (child = fwnode_get_next_child_node(fwnode, NULL); child; \
	83	child = fwnode_get_next_child_node(fwnode, child))
afaf26fd	84
8a0662d9 RW	85	struct fwnode_handle device_get_next_child_node(struct device dev,
	86	struct fwnode_handle *child);
	87
1d656fb7 AS	88	#define device_for_each_child_node(dev, child) \
1d656fb7 AS	89	for (child = device_get_next_child_node(dev, NULL); child; \
8a0662d9 RW	90	child = device_get_next_child_node(dev, child))
8a0662d9 RW	91
21ea73f5 MW	92	struct fwnode_handle fwnode_get_named_child_node(struct fwnode_handle fwnode,
21ea73f5 MW	93	const char *childname);
613e9721 AT	94	struct fwnode_handle device_get_named_child_node(struct device dev,
	95	const char *childname);
	96
e7887c28	97	void fwnode_handle_get(struct fwnode_handle *fwnode);
8a0662d9 RW	98	void fwnode_handle_put(struct fwnode_handle *fwnode);
	99
	100	unsigned int device_get_child_node_count(struct device *dev);
	101
b31384fa RW	102	static inline bool device_property_read_bool(struct device *dev,
	103	const char *propname)
	104	{
	105	return device_property_present(dev, propname);
	106	}
	107
	108	static inline int device_property_read_u8(struct device *dev,
	109	const char propname, u8 val)
	110	{
	111	return device_property_read_u8_array(dev, propname, val, 1);
	112	}
	113
	114	static inline int device_property_read_u16(struct device *dev,
	115	const char propname, u16 val)
	116	{
	117	return device_property_read_u16_array(dev, propname, val, 1);
	118	}
	119
	120	static inline int device_property_read_u32(struct device *dev,
	121	const char propname, u32 val)
	122	{
	123	return device_property_read_u32_array(dev, propname, val, 1);
	124	}
	125
	126	static inline int device_property_read_u64(struct device *dev,
	127	const char propname, u64 val)
	128	{
	129	return device_property_read_u64_array(dev, propname, val, 1);
	130	}
	131
8a0662d9 RW	132	static inline bool fwnode_property_read_bool(struct fwnode_handle *fwnode,
	133	const char *propname)
	134	{
	135	return fwnode_property_present(fwnode, propname);
	136	}
	137
	138	static inline int fwnode_property_read_u8(struct fwnode_handle *fwnode,
	139	const char propname, u8 val)
	140	{
	141	return fwnode_property_read_u8_array(fwnode, propname, val, 1);
	142	}
	143
	144	static inline int fwnode_property_read_u16(struct fwnode_handle *fwnode,
	145	const char propname, u16 val)
	146	{
	147	return fwnode_property_read_u16_array(fwnode, propname, val, 1);
	148	}
	149
	150	static inline int fwnode_property_read_u32(struct fwnode_handle *fwnode,
	151	const char propname, u32 val)
	152	{
	153	return fwnode_property_read_u32_array(fwnode, propname, val, 1);
	154	}
	155
	156	static inline int fwnode_property_read_u64(struct fwnode_handle *fwnode,
	157	const char propname, u64 val)
	158	{
	159	return fwnode_property_read_u64_array(fwnode, propname, val, 1);
	160	}
	161
16ba08d5 RW	162	/**
	163	* struct property_entry - "Built-in" device property representation.
	164	* @name: Name of the property.
318a1971	165	* @length: Length of data making up the value.
66586bab AS	166	* @is_array: True when the property is an array.
	167	* @is_string: True when property is a string.
	168	* @pointer: Pointer to the property (an array of items of the given type).
	169	* @value: Value of the property (when it is a single item of the given type).
16ba08d5 RW	170	*/
	171	struct property_entry {
	172	const char *name;
318a1971	173	size_t length;
66586bab AS	174	bool is_array;
66586bab AS	175	bool is_string;
16ba08d5	176	union {
66586bab	177	union {
9426998c DT	178	const void *raw_data;
	179	const u8 *u8_data;
	180	const u16 *u16_data;
	181	const u32 *u32_data;
	182	const u64 *u64_data;
	183	const char * const *str;
66586bab AS	184	} pointer;
	185	union {
	186	unsigned long long raw_data;
	187	u8 u8_data;
	188	u16 u16_data;
	189	u32 u32_data;
	190	u64 u64_data;
	191	const char *str;
	192	} value;
	193	};
16ba08d5 RW	194	};
16ba08d5 RW	195
d76eebfa AM	196	/*
	197	* Note: the below four initializers for the anonymous union are carefully
	198	* crafted to avoid gcc-4.4.4's problems with initialization of anon unions
	199	* and structs.
	200	*/
	201
a85f4204 HK	202	#define PROPERTY_ENTRY_INTEGER_ARRAY(_name_, _type_, _val_) \
	203	{ \
	204	.name = _name_, \
	205	.length = ARRAY_SIZE(_val_) * sizeof(_type_), \
	206	.is_array = true, \
d76eebfa	207	.is_string = false, \
37aa7271	208	{ .pointer = { ._type_##_data = _val_ } }, \
a85f4204 HK	209	}
	210
	211	#define PROPERTY_ENTRY_U8_ARRAY(_name_, _val_) \
	212	PROPERTY_ENTRY_INTEGER_ARRAY(_name_, u8, _val_)
	213	#define PROPERTY_ENTRY_U16_ARRAY(_name_, _val_) \
	214	PROPERTY_ENTRY_INTEGER_ARRAY(_name_, u16, _val_)
	215	#define PROPERTY_ENTRY_U32_ARRAY(_name_, _val_) \
	216	PROPERTY_ENTRY_INTEGER_ARRAY(_name_, u32, _val_)
	217	#define PROPERTY_ENTRY_U64_ARRAY(_name_, _val_) \
	218	PROPERTY_ENTRY_INTEGER_ARRAY(_name_, u64, _val_)
	219
	220	#define PROPERTY_ENTRY_STRING_ARRAY(_name_, _val_) \
	221	{ \
	222	.name = _name_, \
	223	.length = ARRAY_SIZE(_val_) * sizeof(const char *), \
	224	.is_array = true, \
	225	.is_string = true, \
d76eebfa	226	{ .pointer = { .str = _val_ } }, \
a85f4204 HK	227	}
	228
	229	#define PROPERTY_ENTRY_INTEGER(_name_, _type_, _val_) \
	230	{ \
	231	.name = _name_, \
	232	.length = sizeof(_type_), \
d76eebfa AM	233	.is_string = false, \
d76eebfa AM	234	{ .value = { ._type_##_data = _val_ } }, \
a85f4204 HK	235	}
	236
	237	#define PROPERTY_ENTRY_U8(_name_, _val_) \
	238	PROPERTY_ENTRY_INTEGER(_name_, u8, _val_)
	239	#define PROPERTY_ENTRY_U16(_name_, _val_) \
	240	PROPERTY_ENTRY_INTEGER(_name_, u16, _val_)
	241	#define PROPERTY_ENTRY_U32(_name_, _val_) \
	242	PROPERTY_ENTRY_INTEGER(_name_, u32, _val_)
	243	#define PROPERTY_ENTRY_U64(_name_, _val_) \
	244	PROPERTY_ENTRY_INTEGER(_name_, u64, _val_)
	245
	246	#define PROPERTY_ENTRY_STRING(_name_, _val_) \
	247	{ \
	248	.name = _name_, \
	249	.length = sizeof(_val_), \
	250	.is_string = true, \
aace7367	251	{ .value = { .str = _val_ } }, \
a85f4204 HK	252	}
	253
	254	#define PROPERTY_ENTRY_BOOL(_name_) \
	255	{ \
	256	.name = _name_, \
	257	}
	258
2d479e1f DT	259	struct property_entry *
	260	property_entries_dup(const struct property_entry *properties);
	261
	262	void property_entries_free(const struct property_entry *properties);
	263
f4d05266	264	int device_add_properties(struct device *dev,
bec84da8	265	const struct property_entry *properties);
f4d05266	266	void device_remove_properties(struct device *dev);
16ba08d5	267
e5e55864 SS	268	bool device_dma_supported(struct device *dev);
	269
	270	enum dev_dma_attr device_get_dma_attr(struct device *dev);
	271
4c96b7dc JL	272	int device_get_phy_mode(struct device *dev);
	273
	274	void device_get_mac_address(struct device dev, char *addr, int alen);
	275
07bb80d4 MW	276	struct fwnode_handle *fwnode_graph_get_next_endpoint(
07bb80d4 MW	277	struct fwnode_handle fwnode, struct fwnode_handle prev);
6a71d8d7 KB	278	struct fwnode_handle *
6a71d8d7 KB	279	fwnode_graph_get_port_parent(struct fwnode_handle *fwnode);
07bb80d4 MW	280	struct fwnode_handle *fwnode_graph_get_remote_port_parent(
	281	struct fwnode_handle *fwnode);
	282	struct fwnode_handle *fwnode_graph_get_remote_port(
	283	struct fwnode_handle *fwnode);
	284	struct fwnode_handle *fwnode_graph_get_remote_endpoint(
	285	struct fwnode_handle *fwnode);
125ee6b3 SA	286	struct fwnode_handle fwnode_graph_get_remote_node(struct fwnode_handle fwnode,
125ee6b3 SA	287	u32 port, u32 endpoint);
07bb80d4	288
2bd5452d SA	289	int fwnode_graph_parse_endpoint(struct fwnode_handle *fwnode,
	290	struct fwnode_endpoint *endpoint);
	291
b31384fa	292	#endif /* _LINUX_PROPERTY_H_ */