1 /* SPDX-License-Identifier: GPL-2.0-only */ 2 /* 3 * property.h - Unified device property interface. 4 * 5 * Copyright (C) 2014, Intel Corporation 6 * Authors: Rafael J. Wysocki <[email protected]> 7 * Mika Westerberg <[email protected]> 8 */ 9 10 #ifndef _LINUX_PROPERTY_H_ 11 #define _LINUX_PROPERTY_H_ 12 13 #include <linux/bits.h> 14 #include <linux/fwnode.h> 15 #include <linux/types.h> 16 17 struct device; 18 struct net_device; 19 20 enum dev_prop_type { 21 DEV_PROP_U8, 22 DEV_PROP_U16, 23 DEV_PROP_U32, 24 DEV_PROP_U64, 25 DEV_PROP_STRING, 26 DEV_PROP_REF, 27 }; 28 29 enum dev_dma_attr { 30 DEV_DMA_NOT_SUPPORTED, 31 DEV_DMA_NON_COHERENT, 32 DEV_DMA_COHERENT, 33 }; 34 35 struct fwnode_handle *dev_fwnode(struct device *dev); 36 37 bool device_property_present(struct device *dev, const char *propname); 38 int device_property_read_u8_array(struct device *dev, const char *propname, 39 u8 *val, size_t nval); 40 int device_property_read_u16_array(struct device *dev, const char *propname, 41 u16 *val, size_t nval); 42 int device_property_read_u32_array(struct device *dev, const char *propname, 43 u32 *val, size_t nval); 44 int device_property_read_u64_array(struct device *dev, const char *propname, 45 u64 *val, size_t nval); 46 int device_property_read_string_array(struct device *dev, const char *propname, 47 const char **val, size_t nval); 48 int device_property_read_string(struct device *dev, const char *propname, 49 const char **val); 50 int device_property_match_string(struct device *dev, 51 const char *propname, const char *string); 52 53 bool fwnode_device_is_available(const struct fwnode_handle *fwnode); 54 bool fwnode_property_present(const struct fwnode_handle *fwnode, 55 const char *propname); 56 int fwnode_property_read_u8_array(const struct fwnode_handle *fwnode, 57 const char *propname, u8 *val, 58 size_t nval); 59 int fwnode_property_read_u16_array(const struct fwnode_handle *fwnode, 60 const char *propname, u16 *val, 61 size_t nval); 62 int fwnode_property_read_u32_array(const struct fwnode_handle *fwnode, 63 const char *propname, u32 *val, 64 size_t nval); 65 int fwnode_property_read_u64_array(const struct fwnode_handle *fwnode, 66 const char *propname, u64 *val, 67 size_t nval); 68 int fwnode_property_read_string_array(const struct fwnode_handle *fwnode, 69 const char *propname, const char **val, 70 size_t nval); 71 int fwnode_property_read_string(const struct fwnode_handle *fwnode, 72 const char *propname, const char **val); 73 int fwnode_property_match_string(const struct fwnode_handle *fwnode, 74 const char *propname, const char *string); 75 int fwnode_property_get_reference_args(const struct fwnode_handle *fwnode, 76 const char *prop, const char *nargs_prop, 77 unsigned int nargs, unsigned int index, 78 struct fwnode_reference_args *args); 79 80 struct fwnode_handle *fwnode_find_reference(const struct fwnode_handle *fwnode, 81 const char *name, 82 unsigned int index); 83 84 const char *fwnode_get_name(const struct fwnode_handle *fwnode); 85 const char *fwnode_get_name_prefix(const struct fwnode_handle *fwnode); 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 device *fwnode_get_next_parent_dev(struct fwnode_handle *fwnode); 90 unsigned int fwnode_count_parents(const struct fwnode_handle *fwn); 91 struct fwnode_handle *fwnode_get_nth_parent(struct fwnode_handle *fwn, 92 unsigned int depth); 93 bool fwnode_is_ancestor_of(struct fwnode_handle *test_ancestor, 94 struct fwnode_handle *test_child); 95 struct fwnode_handle *fwnode_get_next_child_node( 96 const struct fwnode_handle *fwnode, struct fwnode_handle *child); 97 struct fwnode_handle *fwnode_get_next_available_child_node( 98 const struct fwnode_handle *fwnode, struct fwnode_handle *child); 99 100 #define fwnode_for_each_child_node(fwnode, child) \ 101 for (child = fwnode_get_next_child_node(fwnode, NULL); child; \ 102 child = fwnode_get_next_child_node(fwnode, child)) 103 104 #define fwnode_for_each_available_child_node(fwnode, child) \ 105 for (child = fwnode_get_next_available_child_node(fwnode, NULL); child;\ 106 child = fwnode_get_next_available_child_node(fwnode, child)) 107 108 struct fwnode_handle *device_get_next_child_node( 109 struct device *dev, struct fwnode_handle *child); 110 111 #define device_for_each_child_node(dev, child) \ 112 for (child = device_get_next_child_node(dev, NULL); child; \ 113 child = device_get_next_child_node(dev, child)) 114 115 struct fwnode_handle *fwnode_get_named_child_node( 116 const struct fwnode_handle *fwnode, const char *childname); 117 struct fwnode_handle *device_get_named_child_node(struct device *dev, 118 const char *childname); 119 120 struct fwnode_handle *fwnode_handle_get(struct fwnode_handle *fwnode); 121 void fwnode_handle_put(struct fwnode_handle *fwnode); 122 123 int fwnode_irq_get(const struct fwnode_handle *fwnode, unsigned int index); 124 125 void __iomem *fwnode_iomap(struct fwnode_handle *fwnode, int index); 126 127 unsigned int device_get_child_node_count(struct device *dev); 128 129 static inline bool device_property_read_bool(struct device *dev, 130 const char *propname) 131 { 132 return device_property_present(dev, propname); 133 } 134 135 static inline int device_property_read_u8(struct device *dev, 136 const char *propname, u8 *val) 137 { 138 return device_property_read_u8_array(dev, propname, val, 1); 139 } 140 141 static inline int device_property_read_u16(struct device *dev, 142 const char *propname, u16 *val) 143 { 144 return device_property_read_u16_array(dev, propname, val, 1); 145 } 146 147 static inline int device_property_read_u32(struct device *dev, 148 const char *propname, u32 *val) 149 { 150 return device_property_read_u32_array(dev, propname, val, 1); 151 } 152 153 static inline int device_property_read_u64(struct device *dev, 154 const char *propname, u64 *val) 155 { 156 return device_property_read_u64_array(dev, propname, val, 1); 157 } 158 159 static inline int device_property_count_u8(struct device *dev, const char *propname) 160 { 161 return device_property_read_u8_array(dev, propname, NULL, 0); 162 } 163 164 static inline int device_property_count_u16(struct device *dev, const char *propname) 165 { 166 return device_property_read_u16_array(dev, propname, NULL, 0); 167 } 168 169 static inline int device_property_count_u32(struct device *dev, const char *propname) 170 { 171 return device_property_read_u32_array(dev, propname, NULL, 0); 172 } 173 174 static inline int device_property_count_u64(struct device *dev, const char *propname) 175 { 176 return device_property_read_u64_array(dev, propname, NULL, 0); 177 } 178 179 static inline int device_property_string_array_count(struct device *dev, 180 const char *propname) 181 { 182 return device_property_read_string_array(dev, propname, NULL, 0); 183 } 184 185 static inline bool fwnode_property_read_bool(const struct fwnode_handle *fwnode, 186 const char *propname) 187 { 188 return fwnode_property_present(fwnode, propname); 189 } 190 191 static inline int fwnode_property_read_u8(const struct fwnode_handle *fwnode, 192 const char *propname, u8 *val) 193 { 194 return fwnode_property_read_u8_array(fwnode, propname, val, 1); 195 } 196 197 static inline int fwnode_property_read_u16(const struct fwnode_handle *fwnode, 198 const char *propname, u16 *val) 199 { 200 return fwnode_property_read_u16_array(fwnode, propname, val, 1); 201 } 202 203 static inline int fwnode_property_read_u32(const struct fwnode_handle *fwnode, 204 const char *propname, u32 *val) 205 { 206 return fwnode_property_read_u32_array(fwnode, propname, val, 1); 207 } 208 209 static inline int fwnode_property_read_u64(const struct fwnode_handle *fwnode, 210 const char *propname, u64 *val) 211 { 212 return fwnode_property_read_u64_array(fwnode, propname, val, 1); 213 } 214 215 static inline int fwnode_property_count_u8(const struct fwnode_handle *fwnode, 216 const char *propname) 217 { 218 return fwnode_property_read_u8_array(fwnode, propname, NULL, 0); 219 } 220 221 static inline int fwnode_property_count_u16(const struct fwnode_handle *fwnode, 222 const char *propname) 223 { 224 return fwnode_property_read_u16_array(fwnode, propname, NULL, 0); 225 } 226 227 static inline int fwnode_property_count_u32(const struct fwnode_handle *fwnode, 228 const char *propname) 229 { 230 return fwnode_property_read_u32_array(fwnode, propname, NULL, 0); 231 } 232 233 static inline int fwnode_property_count_u64(const struct fwnode_handle *fwnode, 234 const char *propname) 235 { 236 return fwnode_property_read_u64_array(fwnode, propname, NULL, 0); 237 } 238 239 static inline int 240 fwnode_property_string_array_count(const struct fwnode_handle *fwnode, 241 const char *propname) 242 { 243 return fwnode_property_read_string_array(fwnode, propname, NULL, 0); 244 } 245 246 struct software_node; 247 248 /** 249 * struct software_node_ref_args - Reference property with additional arguments 250 * @node: Reference to a software node 251 * @nargs: Number of elements in @args array 252 * @args: Integer arguments 253 */ 254 struct software_node_ref_args { 255 const struct software_node *node; 256 unsigned int nargs; 257 u64 args[NR_FWNODE_REFERENCE_ARGS]; 258 }; 259 260 #define SOFTWARE_NODE_REFERENCE(_ref_, ...) \ 261 (const struct software_node_ref_args) { \ 262 .node = _ref_, \ 263 .nargs = ARRAY_SIZE(((u64[]){ 0, ##__VA_ARGS__ })) - 1, \ 264 .args = { __VA_ARGS__ }, \ 265 } 266 267 /** 268 * struct property_entry - "Built-in" device property representation. 269 * @name: Name of the property. 270 * @length: Length of data making up the value. 271 * @is_inline: True when the property value is stored inline. 272 * @type: Type of the data in unions. 273 * @pointer: Pointer to the property when it is not stored inline. 274 * @value: Value of the property when it is stored inline. 275 */ 276 struct property_entry { 277 const char *name; 278 size_t length; 279 bool is_inline; 280 enum dev_prop_type type; 281 union { 282 const void *pointer; 283 union { 284 u8 u8_data[sizeof(u64) / sizeof(u8)]; 285 u16 u16_data[sizeof(u64) / sizeof(u16)]; 286 u32 u32_data[sizeof(u64) / sizeof(u32)]; 287 u64 u64_data[sizeof(u64) / sizeof(u64)]; 288 const char *str[sizeof(u64) / sizeof(char *)]; 289 } value; 290 }; 291 }; 292 293 /* 294 * Note: the below initializers for the anonymous union are carefully 295 * crafted to avoid gcc-4.4.4's problems with initialization of anon unions 296 * and structs. 297 */ 298 299 #define __PROPERTY_ENTRY_ELEMENT_SIZE(_elem_) \ 300 sizeof(((struct property_entry *)NULL)->value._elem_[0]) 301 302 #define __PROPERTY_ENTRY_ARRAY_ELSIZE_LEN(_name_, _elsize_, _Type_, \ 303 _val_, _len_) \ 304 (struct property_entry) { \ 305 .name = _name_, \ 306 .length = (_len_) * (_elsize_), \ 307 .type = DEV_PROP_##_Type_, \ 308 { .pointer = _val_ }, \ 309 } 310 311 #define __PROPERTY_ENTRY_ARRAY_LEN(_name_, _elem_, _Type_, _val_, _len_)\ 312 __PROPERTY_ENTRY_ARRAY_ELSIZE_LEN(_name_, \ 313 __PROPERTY_ENTRY_ELEMENT_SIZE(_elem_), \ 314 _Type_, _val_, _len_) 315 316 #define PROPERTY_ENTRY_U8_ARRAY_LEN(_name_, _val_, _len_) \ 317 __PROPERTY_ENTRY_ARRAY_LEN(_name_, u8_data, U8, _val_, _len_) 318 #define PROPERTY_ENTRY_U16_ARRAY_LEN(_name_, _val_, _len_) \ 319 __PROPERTY_ENTRY_ARRAY_LEN(_name_, u16_data, U16, _val_, _len_) 320 #define PROPERTY_ENTRY_U32_ARRAY_LEN(_name_, _val_, _len_) \ 321 __PROPERTY_ENTRY_ARRAY_LEN(_name_, u32_data, U32, _val_, _len_) 322 #define PROPERTY_ENTRY_U64_ARRAY_LEN(_name_, _val_, _len_) \ 323 __PROPERTY_ENTRY_ARRAY_LEN(_name_, u64_data, U64, _val_, _len_) 324 #define PROPERTY_ENTRY_STRING_ARRAY_LEN(_name_, _val_, _len_) \ 325 __PROPERTY_ENTRY_ARRAY_LEN(_name_, str, STRING, _val_, _len_) 326 #define PROPERTY_ENTRY_REF_ARRAY_LEN(_name_, _val_, _len_) \ 327 __PROPERTY_ENTRY_ARRAY_ELSIZE_LEN(_name_, \ 328 sizeof(struct software_node_ref_args), \ 329 REF, _val_, _len_) 330 331 #define PROPERTY_ENTRY_U8_ARRAY(_name_, _val_) \ 332 PROPERTY_ENTRY_U8_ARRAY_LEN(_name_, _val_, ARRAY_SIZE(_val_)) 333 #define PROPERTY_ENTRY_U16_ARRAY(_name_, _val_) \ 334 PROPERTY_ENTRY_U16_ARRAY_LEN(_name_, _val_, ARRAY_SIZE(_val_)) 335 #define PROPERTY_ENTRY_U32_ARRAY(_name_, _val_) \ 336 PROPERTY_ENTRY_U32_ARRAY_LEN(_name_, _val_, ARRAY_SIZE(_val_)) 337 #define PROPERTY_ENTRY_U64_ARRAY(_name_, _val_) \ 338 PROPERTY_ENTRY_U64_ARRAY_LEN(_name_, _val_, ARRAY_SIZE(_val_)) 339 #define PROPERTY_ENTRY_STRING_ARRAY(_name_, _val_) \ 340 PROPERTY_ENTRY_STRING_ARRAY_LEN(_name_, _val_, ARRAY_SIZE(_val_)) 341 #define PROPERTY_ENTRY_REF_ARRAY(_name_, _val_) \ 342 PROPERTY_ENTRY_REF_ARRAY_LEN(_name_, _val_, ARRAY_SIZE(_val_)) 343 344 #define __PROPERTY_ENTRY_ELEMENT(_name_, _elem_, _Type_, _val_) \ 345 (struct property_entry) { \ 346 .name = _name_, \ 347 .length = __PROPERTY_ENTRY_ELEMENT_SIZE(_elem_), \ 348 .is_inline = true, \ 349 .type = DEV_PROP_##_Type_, \ 350 { .value = { ._elem_[0] = _val_ } }, \ 351 } 352 353 #define PROPERTY_ENTRY_U8(_name_, _val_) \ 354 __PROPERTY_ENTRY_ELEMENT(_name_, u8_data, U8, _val_) 355 #define PROPERTY_ENTRY_U16(_name_, _val_) \ 356 __PROPERTY_ENTRY_ELEMENT(_name_, u16_data, U16, _val_) 357 #define PROPERTY_ENTRY_U32(_name_, _val_) \ 358 __PROPERTY_ENTRY_ELEMENT(_name_, u32_data, U32, _val_) 359 #define PROPERTY_ENTRY_U64(_name_, _val_) \ 360 __PROPERTY_ENTRY_ELEMENT(_name_, u64_data, U64, _val_) 361 #define PROPERTY_ENTRY_STRING(_name_, _val_) \ 362 __PROPERTY_ENTRY_ELEMENT(_name_, str, STRING, _val_) 363 364 #define PROPERTY_ENTRY_BOOL(_name_) \ 365 (struct property_entry) { \ 366 .name = _name_, \ 367 .is_inline = true, \ 368 } 369 370 #define PROPERTY_ENTRY_REF(_name_, _ref_, ...) \ 371 (struct property_entry) { \ 372 .name = _name_, \ 373 .length = sizeof(struct software_node_ref_args), \ 374 .type = DEV_PROP_REF, \ 375 { .pointer = &SOFTWARE_NODE_REFERENCE(_ref_, ##__VA_ARGS__), }, \ 376 } 377 378 struct property_entry * 379 property_entries_dup(const struct property_entry *properties); 380 381 void property_entries_free(const struct property_entry *properties); 382 383 bool device_dma_supported(struct device *dev); 384 385 enum dev_dma_attr device_get_dma_attr(struct device *dev); 386 387 const void *device_get_match_data(struct device *dev); 388 389 int device_get_phy_mode(struct device *dev); 390 391 int fwnode_get_phy_mode(struct fwnode_handle *fwnode); 392 struct fwnode_handle *fwnode_graph_get_next_endpoint( 393 const struct fwnode_handle *fwnode, struct fwnode_handle *prev); 394 struct fwnode_handle * 395 fwnode_graph_get_port_parent(const struct fwnode_handle *fwnode); 396 struct fwnode_handle *fwnode_graph_get_remote_port_parent( 397 const struct fwnode_handle *fwnode); 398 struct fwnode_handle *fwnode_graph_get_remote_port( 399 const struct fwnode_handle *fwnode); 400 struct fwnode_handle *fwnode_graph_get_remote_endpoint( 401 const struct fwnode_handle *fwnode); 402 403 static inline bool fwnode_graph_is_endpoint(struct fwnode_handle *fwnode) 404 { 405 return fwnode_property_present(fwnode, "remote-endpoint"); 406 } 407 408 /* 409 * Fwnode lookup flags 410 * 411 * @FWNODE_GRAPH_ENDPOINT_NEXT: In the case of no exact match, look for the 412 * closest endpoint ID greater than the specified 413 * one. 414 * @FWNODE_GRAPH_DEVICE_DISABLED: That the device to which the remote 415 * endpoint of the given endpoint belongs to, 416 * may be disabled, or that the endpoint is not 417 * connected. 418 */ 419 #define FWNODE_GRAPH_ENDPOINT_NEXT BIT(0) 420 #define FWNODE_GRAPH_DEVICE_DISABLED BIT(1) 421 422 struct fwnode_handle * 423 fwnode_graph_get_endpoint_by_id(const struct fwnode_handle *fwnode, 424 u32 port, u32 endpoint, unsigned long flags); 425 unsigned int fwnode_graph_get_endpoint_count(struct fwnode_handle *fwnode, 426 unsigned long flags); 427 428 #define fwnode_graph_for_each_endpoint(fwnode, child) \ 429 for (child = NULL; \ 430 (child = fwnode_graph_get_next_endpoint(fwnode, child)); ) 431 432 int fwnode_graph_parse_endpoint(const struct fwnode_handle *fwnode, 433 struct fwnode_endpoint *endpoint); 434 435 typedef void *(*devcon_match_fn_t)(struct fwnode_handle *fwnode, const char *id, 436 void *data); 437 438 void *fwnode_connection_find_match(struct fwnode_handle *fwnode, 439 const char *con_id, void *data, 440 devcon_match_fn_t match); 441 442 static inline void *device_connection_find_match(struct device *dev, 443 const char *con_id, void *data, 444 devcon_match_fn_t match) 445 { 446 return fwnode_connection_find_match(dev_fwnode(dev), con_id, data, match); 447 } 448 449 /* -------------------------------------------------------------------------- */ 450 /* Software fwnode support - when HW description is incomplete or missing */ 451 452 /** 453 * struct software_node - Software node description 454 * @name: Name of the software node 455 * @parent: Parent of the software node 456 * @properties: Array of device properties 457 */ 458 struct software_node { 459 const char *name; 460 const struct software_node *parent; 461 const struct property_entry *properties; 462 }; 463 464 bool is_software_node(const struct fwnode_handle *fwnode); 465 const struct software_node * 466 to_software_node(const struct fwnode_handle *fwnode); 467 struct fwnode_handle *software_node_fwnode(const struct software_node *node); 468 469 const struct software_node * 470 software_node_find_by_name(const struct software_node *parent, 471 const char *name); 472 473 int software_node_register_nodes(const struct software_node *nodes); 474 void software_node_unregister_nodes(const struct software_node *nodes); 475 476 int software_node_register_node_group(const struct software_node **node_group); 477 void software_node_unregister_node_group(const struct software_node **node_group); 478 479 int software_node_register(const struct software_node *node); 480 void software_node_unregister(const struct software_node *node); 481 482 struct fwnode_handle * 483 fwnode_create_software_node(const struct property_entry *properties, 484 const struct fwnode_handle *parent); 485 void fwnode_remove_software_node(struct fwnode_handle *fwnode); 486 487 int device_add_software_node(struct device *dev, const struct software_node *node); 488 void device_remove_software_node(struct device *dev); 489 490 int device_create_managed_software_node(struct device *dev, 491 const struct property_entry *properties, 492 const struct software_node *parent); 493 494 #endif /* _LINUX_PROPERTY_H_ */ 495