include/linux/property.h

   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
  16 #include <linux/fwnode.h>
  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
  30 enum dev_dma_attr {
  31         DEV_DMA_NOT_SUPPORTED,
  32         DEV_DMA_NON_COHERENT,
  33         DEV_DMA_COHERENT,
  34 };
  35
  36 struct fwnode_handle *dev_fwnode(struct device *dev);
  37
  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);
  51 int device_property_match_string(struct device *dev,
  52                                  const char *propname, const char *string);
  53
  54 bool fwnode_property_present(struct fwnode_handle *fwnode, const char *propname);
  55 int fwnode_property_read_u8_array(struct fwnode_handle *fwnode,
  56                                   const char *propname, u8 *val,
  57                                   size_t nval);
  58 int fwnode_property_read_u16_array(struct fwnode_handle *fwnode,
  59                                    const char *propname, u16 *val,
  60                                    size_t nval);
  61 int fwnode_property_read_u32_array(struct fwnode_handle *fwnode,
  62                                    const char *propname, u32 *val,
  63                                    size_t nval);
  64 int fwnode_property_read_u64_array(struct fwnode_handle *fwnode,
  65                                    const char *propname, u64 *val,
  66                                    size_t nval);
  67 int fwnode_property_read_string_array(struct fwnode_handle *fwnode,
  68                                       const char *propname, const char **val,
  69                                       size_t nval);
  70 int fwnode_property_read_string(struct fwnode_handle *fwnode,
  71                                 const char *propname, const char **val);
  72 int fwnode_property_match_string(struct fwnode_handle *fwnode,
  73                                  const char *propname, const char *string);
  74
  75 struct fwnode_handle *device_get_next_child_node(struct device *dev,
  76                                                  struct fwnode_handle *child);
  77
  78 #define device_for_each_child_node(dev, child)                          \
  79         for (child = device_get_next_child_node(dev, NULL); child;      \
  80              child = device_get_next_child_node(dev, child))
  81
  82 struct fwnode_handle *device_get_named_child_node(struct device *dev,
  83                                                   const char *childname);
  84
  85 void fwnode_handle_put(struct fwnode_handle *fwnode);
  86
  87 unsigned int device_get_child_node_count(struct device *dev);
  88
  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
 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
 149 /**
 150  * struct property_entry - "Built-in" device property representation.
 151  * @name: Name of the property.
 152  * @length: Length of data making up the value.
 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).
 157  */
 158 struct property_entry {
 159         const char *name;
 160         size_t length;
 161         bool is_array;
 162         bool is_string;
 163         union {
 164                 union {
 165                         void *raw_data;
 166                         u8 *u8_data;
 167                         u16 *u16_data;
 168                         u32 *u32_data;
 169                         u64 *u64_data;
 170                         const char **str;
 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         };
 181 };
 182
 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
 189 #define PROPERTY_ENTRY_INTEGER_ARRAY(_name_, _type_, _val_)     \
 190 (struct property_entry) {                                       \
 191         .name = _name_,                                         \
 192         .length = ARRAY_SIZE(_val_) * sizeof(_type_),           \
 193         .is_array = true,                                       \
 194         .is_string = false,                                     \
 195         { .pointer = { ._type_##_data = _val_ } },              \
 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 (struct property_entry) {                                       \
 209         .name = _name_,                                         \
 210         .length = ARRAY_SIZE(_val_) * sizeof(const char *),     \
 211         .is_array = true,                                       \
 212         .is_string = true,                                      \
 213         { .pointer = { .str = _val_ } },                        \
 214 }
 215
 216 #define PROPERTY_ENTRY_INTEGER(_name_, _type_, _val_)   \
 217 (struct property_entry) {                               \
 218         .name = _name_,                                 \
 219         .length = sizeof(_type_),                       \
 220         .is_string = false,                             \
 221         { .value = { ._type_##_data = _val_ } },        \
 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 (struct property_entry) {                               \
 235         .name = _name_,                                 \
 236         .length = sizeof(const char *),                 \
 237         .is_string = true,                              \
 238         { .value = { .str = _val_ } },                  \
 239 }
 240
 241 #define PROPERTY_ENTRY_BOOL(_name_)             \
 242 (struct property_entry) {                       \
 243         .name = _name_,                         \
 244 }
 245
 246 int device_add_properties(struct device *dev,
 247                           struct property_entry *properties);
 248 void device_remove_properties(struct device *dev);
 249
 250 bool device_dma_supported(struct device *dev);
 251
 252 enum dev_dma_attr device_get_dma_attr(struct device *dev);
 253
 254 int device_get_phy_mode(struct device *dev);
 255
 256 void *device_get_mac_address(struct device *dev, char *addr, int alen);
 257
 258 #endif /* _LINUX_PROPERTY_H_ */