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