[mirror_ubuntu-bionic-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,
};

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

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

#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
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
8a0662d9 RW	52	bool fwnode_property_present(struct fwnode_handle fwnode, const char propname);
	53	int fwnode_property_read_u8_array(struct fwnode_handle *fwnode,
	54	const char propname, u8 val,
	55	size_t nval);
	56	int fwnode_property_read_u16_array(struct fwnode_handle *fwnode,
	57	const char propname, u16 val,
	58	size_t nval);
	59	int fwnode_property_read_u32_array(struct fwnode_handle *fwnode,
	60	const char propname, u32 val,
	61	size_t nval);
	62	int fwnode_property_read_u64_array(struct fwnode_handle *fwnode,
	63	const char propname, u64 val,
	64	size_t nval);
	65	int fwnode_property_read_string_array(struct fwnode_handle *fwnode,
	66	const char propname, const char *val,
	67	size_t nval);
	68	int fwnode_property_read_string(struct fwnode_handle *fwnode,
	69	const char propname, const char *val);
3f5c8d31 MW	70	int fwnode_property_match_string(struct fwnode_handle *fwnode,
3f5c8d31 MW	71	const char propname, const char string);
8a0662d9	72
afaf26fd MW	73	struct fwnode_handle fwnode_get_parent(struct fwnode_handle fwnode);
afaf26fd MW	74
8a0662d9 RW	75	struct fwnode_handle device_get_next_child_node(struct device dev,
	76	struct fwnode_handle *child);
	77
1d656fb7 AS	78	#define device_for_each_child_node(dev, child) \
1d656fb7 AS	79	for (child = device_get_next_child_node(dev, NULL); child; \
8a0662d9 RW	80	child = device_get_next_child_node(dev, child))
8a0662d9 RW	81
613e9721 AT	82	struct fwnode_handle device_get_named_child_node(struct device dev,
	83	const char *childname);
	84
8a0662d9 RW	85	void fwnode_handle_put(struct fwnode_handle *fwnode);
	86
	87	unsigned int device_get_child_node_count(struct device *dev);
	88
b31384fa RW	89	static inline bool device_property_read_bool(struct device *dev,
	90	const char *propname)
	91	{
	92	return device_property_present(dev, propname);
	93	}
	94
	95	static inline int device_property_read_u8(struct device *dev,
	96	const char propname, u8 val)
	97	{
	98	return device_property_read_u8_array(dev, propname, val, 1);
	99	}
	100
	101	static inline int device_property_read_u16(struct device *dev,
	102	const char propname, u16 val)
	103	{
	104	return device_property_read_u16_array(dev, propname, val, 1);
	105	}
	106
	107	static inline int device_property_read_u32(struct device *dev,
	108	const char propname, u32 val)
	109	{
	110	return device_property_read_u32_array(dev, propname, val, 1);
	111	}
	112
	113	static inline int device_property_read_u64(struct device *dev,
	114	const char propname, u64 val)
	115	{
	116	return device_property_read_u64_array(dev, propname, val, 1);
	117	}
	118
8a0662d9 RW	119	static inline bool fwnode_property_read_bool(struct fwnode_handle *fwnode,
	120	const char *propname)
	121	{
	122	return fwnode_property_present(fwnode, propname);
	123	}
	124
	125	static inline int fwnode_property_read_u8(struct fwnode_handle *fwnode,
	126	const char propname, u8 val)
	127	{
	128	return fwnode_property_read_u8_array(fwnode, propname, val, 1);
	129	}
	130
	131	static inline int fwnode_property_read_u16(struct fwnode_handle *fwnode,
	132	const char propname, u16 val)
	133	{
	134	return fwnode_property_read_u16_array(fwnode, propname, val, 1);
	135	}
	136
	137	static inline int fwnode_property_read_u32(struct fwnode_handle *fwnode,
	138	const char propname, u32 val)
	139	{
	140	return fwnode_property_read_u32_array(fwnode, propname, val, 1);
	141	}
	142
	143	static inline int fwnode_property_read_u64(struct fwnode_handle *fwnode,
	144	const char propname, u64 val)
	145	{
	146	return fwnode_property_read_u64_array(fwnode, propname, val, 1);
	147	}
	148
16ba08d5 RW	149	/**
	150	* struct property_entry - "Built-in" device property representation.
	151	* @name: Name of the property.
318a1971	152	* @length: Length of data making up the value.
66586bab AS	153	* @is_array: True when the property is an array.
	154	* @is_string: True when property is a string.
	155	* @pointer: Pointer to the property (an array of items of the given type).
	156	* @value: Value of the property (when it is a single item of the given type).
16ba08d5 RW	157	*/
	158	struct property_entry {
	159	const char *name;
318a1971	160	size_t length;
66586bab AS	161	bool is_array;
66586bab AS	162	bool is_string;
16ba08d5	163	union {
66586bab	164	union {
9426998c DT	165	const void *raw_data;
	166	const u8 *u8_data;
	167	const u16 *u16_data;
	168	const u32 *u32_data;
	169	const u64 *u64_data;
	170	const char * const *str;
66586bab AS	171	} pointer;
	172	union {
	173	unsigned long long raw_data;
	174	u8 u8_data;
	175	u16 u16_data;
	176	u32 u32_data;
	177	u64 u64_data;
	178	const char *str;
	179	} value;
	180	};
16ba08d5 RW	181	};
16ba08d5 RW	182
d76eebfa AM	183	/*
	184	* Note: the below four initializers for the anonymous union are carefully
	185	* crafted to avoid gcc-4.4.4's problems with initialization of anon unions
	186	* and structs.
	187	*/
	188
a85f4204 HK	189	#define PROPERTY_ENTRY_INTEGER_ARRAY(_name_, _type_, _val_) \
	190	{ \
	191	.name = _name_, \
	192	.length = ARRAY_SIZE(_val_) * sizeof(_type_), \
	193	.is_array = true, \
d76eebfa	194	.is_string = false, \
37aa7271	195	{ .pointer = { ._type_##_data = _val_ } }, \
a85f4204 HK	196	}
	197
	198	#define PROPERTY_ENTRY_U8_ARRAY(_name_, _val_) \
	199	PROPERTY_ENTRY_INTEGER_ARRAY(_name_, u8, _val_)
	200	#define PROPERTY_ENTRY_U16_ARRAY(_name_, _val_) \
	201	PROPERTY_ENTRY_INTEGER_ARRAY(_name_, u16, _val_)
	202	#define PROPERTY_ENTRY_U32_ARRAY(_name_, _val_) \
	203	PROPERTY_ENTRY_INTEGER_ARRAY(_name_, u32, _val_)
	204	#define PROPERTY_ENTRY_U64_ARRAY(_name_, _val_) \
	205	PROPERTY_ENTRY_INTEGER_ARRAY(_name_, u64, _val_)
	206
	207	#define PROPERTY_ENTRY_STRING_ARRAY(_name_, _val_) \
	208	{ \
	209	.name = _name_, \
	210	.length = ARRAY_SIZE(_val_) * sizeof(const char *), \
	211	.is_array = true, \
	212	.is_string = true, \
d76eebfa	213	{ .pointer = { .str = _val_ } }, \
a85f4204 HK	214	}
	215
	216	#define PROPERTY_ENTRY_INTEGER(_name_, _type_, _val_) \
	217	{ \
	218	.name = _name_, \
	219	.length = sizeof(_type_), \
d76eebfa AM	220	.is_string = false, \
d76eebfa AM	221	{ .value = { ._type_##_data = _val_ } }, \
a85f4204 HK	222	}
	223
	224	#define PROPERTY_ENTRY_U8(_name_, _val_) \
	225	PROPERTY_ENTRY_INTEGER(_name_, u8, _val_)
	226	#define PROPERTY_ENTRY_U16(_name_, _val_) \
	227	PROPERTY_ENTRY_INTEGER(_name_, u16, _val_)
	228	#define PROPERTY_ENTRY_U32(_name_, _val_) \
	229	PROPERTY_ENTRY_INTEGER(_name_, u32, _val_)
	230	#define PROPERTY_ENTRY_U64(_name_, _val_) \
	231	PROPERTY_ENTRY_INTEGER(_name_, u64, _val_)
	232
	233	#define PROPERTY_ENTRY_STRING(_name_, _val_) \
	234	{ \
	235	.name = _name_, \
	236	.length = sizeof(_val_), \
	237	.is_string = true, \
aace7367	238	{ .value = { .str = _val_ } }, \
a85f4204 HK	239	}
	240
	241	#define PROPERTY_ENTRY_BOOL(_name_) \
	242	{ \
	243	.name = _name_, \
	244	}
	245
2d479e1f DT	246	struct property_entry *
	247	property_entries_dup(const struct property_entry *properties);
	248
	249	void property_entries_free(const struct property_entry *properties);
	250
f4d05266	251	int device_add_properties(struct device *dev,
bec84da8	252	const struct property_entry *properties);
f4d05266	253	void device_remove_properties(struct device *dev);
16ba08d5	254
e5e55864 SS	255	bool device_dma_supported(struct device *dev);
	256
	257	enum dev_dma_attr device_get_dma_attr(struct device *dev);
	258
4c96b7dc JL	259	int device_get_phy_mode(struct device *dev);
	260
	261	void device_get_mac_address(struct device dev, char *addr, int alen);
	262
b31384fa	263	#endif /* _LINUX_PROPERTY_H_ */