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/args.h> 14 #include <linux/array_size.h> 15 #include <linux/bits.h> 16 #include <linux/fwnode.h> 17 #include <linux/stddef.h> 18 #include <linux/types.h> 19 20 struct device; 21 22 enum dev_prop_type { 23 DEV_PROP_U8, 24 DEV_PROP_U16, 25 DEV_PROP_U32, 26 DEV_PROP_U64, 27 DEV_PROP_STRING, 28 DEV_PROP_REF, 29 }; 30 31 const struct fwnode_handle *__dev_fwnode_const(const struct device *dev); 32 struct fwnode_handle *__dev_fwnode(struct device *dev); 33 #define dev_fwnode(dev) \ 34 _Generic((dev), \ 35 const struct device *: __dev_fwnode_const, \ 36 struct device *: __dev_fwnode)(dev) 37 38 bool device_property_present(const struct device *dev, const char *propname); 39 int device_property_read_u8_array(const struct device *dev, const char *propname, 40 u8 *val, size_t nval); 41 int device_property_read_u16_array(const struct device *dev, const char *propname, 42 u16 *val, size_t nval); 43 int device_property_read_u32_array(const struct device *dev, const char *propname, 44 u32 *val, size_t nval); 45 int device_property_read_u64_array(const struct device *dev, const char *propname, 46 u64 *val, size_t nval); 47 int device_property_read_string_array(const struct device *dev, const char *propname, 48 const char **val, size_t nval); 49 int device_property_read_string(const struct device *dev, const char *propname, 50 const char **val); 51 int device_property_match_string(const struct device *dev, 52 const char *propname, const char *string); 53 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 76 bool fwnode_device_is_available(const struct fwnode_handle *fwnode); 77 78 static inline bool fwnode_device_is_big_endian(const struct fwnode_handle *fwnode) 79 { 80 if (fwnode_property_present(fwnode, "big-endian")) 81 return true; 82 if (IS_ENABLED(CONFIG_CPU_BIG_ENDIAN) && 83 fwnode_property_present(fwnode, "native-endian")) 84 return true; 85 return false; 86 } 87 88 static inline 89 bool fwnode_device_is_compatible(const struct fwnode_handle *fwnode, const char *compat) 90 { 91 return fwnode_property_match_string(fwnode, "compatible", compat) >= 0; 92 } 93 94 /** 95 * device_is_big_endian - check if a device has BE registers 96 * @dev: Pointer to the struct device 97 * 98 * Returns: true if the device has a "big-endian" property, or if the kernel 99 * was compiled for BE *and* the device has a "native-endian" property. 100 * Returns false otherwise. 101 * 102 * Callers would nominally use ioread32be/iowrite32be if 103 * device_is_big_endian() == true, or readl/writel otherwise. 104 */ 105 static inline bool device_is_big_endian(const struct device *dev) 106 { 107 return fwnode_device_is_big_endian(dev_fwnode(dev)); 108 } 109 110 /** 111 * device_is_compatible - match 'compatible' property of the device with a given string 112 * @dev: Pointer to the struct device 113 * @compat: The string to match 'compatible' property with 114 * 115 * Returns: true if matches, otherwise false. 116 */ 117 static inline bool device_is_compatible(const struct device *dev, const char *compat) 118 { 119 return fwnode_device_is_compatible(dev_fwnode(dev), compat); 120 } 121 122 int fwnode_property_match_property_string(const struct fwnode_handle *fwnode, 123 const char *propname, 124 const char * const *array, size_t n); 125 126 static inline 127 int device_property_match_property_string(const struct device *dev, 128 const char *propname, 129 const char * const *array, size_t n) 130 { 131 return fwnode_property_match_property_string(dev_fwnode(dev), propname, array, n); 132 } 133 134 int fwnode_property_get_reference_args(const struct fwnode_handle *fwnode, 135 const char *prop, const char *nargs_prop, 136 unsigned int nargs, unsigned int index, 137 struct fwnode_reference_args *args); 138 139 struct fwnode_handle *fwnode_find_reference(const struct fwnode_handle *fwnode, 140 const char *name, 141 unsigned int index); 142 143 const char *fwnode_get_name(const struct fwnode_handle *fwnode); 144 const char *fwnode_get_name_prefix(const struct fwnode_handle *fwnode); 145 bool fwnode_name_eq(const struct fwnode_handle *fwnode, const char *name); 146 147 struct fwnode_handle *fwnode_get_parent(const struct fwnode_handle *fwnode); 148 struct fwnode_handle *fwnode_get_next_parent(struct fwnode_handle *fwnode); 149 150 #define fwnode_for_each_parent_node(fwnode, parent) \ 151 for (parent = fwnode_get_parent(fwnode); parent; \ 152 parent = fwnode_get_next_parent(parent)) 153 154 unsigned int fwnode_count_parents(const struct fwnode_handle *fwn); 155 struct fwnode_handle *fwnode_get_nth_parent(struct fwnode_handle *fwn, 156 unsigned int depth); 157 struct fwnode_handle *fwnode_get_next_child_node( 158 const struct fwnode_handle *fwnode, struct fwnode_handle *child); 159 struct fwnode_handle *fwnode_get_next_available_child_node( 160 const struct fwnode_handle *fwnode, struct fwnode_handle *child); 161 162 #define fwnode_for_each_child_node(fwnode, child) \ 163 for (child = fwnode_get_next_child_node(fwnode, NULL); child; \ 164 child = fwnode_get_next_child_node(fwnode, child)) 165 166 #define fwnode_for_each_available_child_node(fwnode, child) \ 167 for (child = fwnode_get_next_available_child_node(fwnode, NULL); child;\ 168 child = fwnode_get_next_available_child_node(fwnode, child)) 169 170 struct fwnode_handle *device_get_next_child_node(const struct device *dev, 171 struct fwnode_handle *child); 172 173 #define device_for_each_child_node(dev, child) \ 174 for (child = device_get_next_child_node(dev, NULL); child; \ 175 child = device_get_next_child_node(dev, child)) 176 177 struct fwnode_handle *fwnode_get_named_child_node(const struct fwnode_handle *fwnode, 178 const char *childname); 179 struct fwnode_handle *device_get_named_child_node(const struct device *dev, 180 const char *childname); 181 182 struct fwnode_handle *fwnode_handle_get(struct fwnode_handle *fwnode); 183 184 /** 185 * fwnode_handle_put - Drop reference to a device node 186 * @fwnode: Pointer to the device node to drop the reference to. 187 * 188 * This has to be used when terminating device_for_each_child_node() iteration 189 * with break or return to prevent stale device node references from being left 190 * behind. 191 */ 192 static inline void fwnode_handle_put(struct fwnode_handle *fwnode) 193 { 194 fwnode_call_void_op(fwnode, put); 195 } 196 197 int fwnode_irq_get(const struct fwnode_handle *fwnode, unsigned int index); 198 int fwnode_irq_get_byname(const struct fwnode_handle *fwnode, const char *name); 199 200 unsigned int device_get_child_node_count(const struct device *dev); 201 202 static inline bool device_property_read_bool(const struct device *dev, 203 const char *propname) 204 { 205 return device_property_present(dev, propname); 206 } 207 208 static inline int device_property_read_u8(const struct device *dev, 209 const char *propname, u8 *val) 210 { 211 return device_property_read_u8_array(dev, propname, val, 1); 212 } 213 214 static inline int device_property_read_u16(const struct device *dev, 215 const char *propname, u16 *val) 216 { 217 return device_property_read_u16_array(dev, propname, val, 1); 218 } 219 220 static inline int device_property_read_u32(const struct device *dev, 221 const char *propname, u32 *val) 222 { 223 return device_property_read_u32_array(dev, propname, val, 1); 224 } 225 226 static inline int device_property_read_u64(const struct device *dev, 227 const char *propname, u64 *val) 228 { 229 return device_property_read_u64_array(dev, propname, val, 1); 230 } 231 232 static inline int device_property_count_u8(const struct device *dev, const char *propname) 233 { 234 return device_property_read_u8_array(dev, propname, NULL, 0); 235 } 236 237 static inline int device_property_count_u16(const struct device *dev, const char *propname) 238 { 239 return device_property_read_u16_array(dev, propname, NULL, 0); 240 } 241 242 static inline int device_property_count_u32(const struct device *dev, const char *propname) 243 { 244 return device_property_read_u32_array(dev, propname, NULL, 0); 245 } 246 247 static inline int device_property_count_u64(const struct device *dev, const char *propname) 248 { 249 return device_property_read_u64_array(dev, propname, NULL, 0); 250 } 251 252 static inline int device_property_string_array_count(const struct device *dev, 253 const char *propname) 254 { 255 return device_property_read_string_array(dev, propname, NULL, 0); 256 } 257 258 static inline bool fwnode_property_read_bool(const struct fwnode_handle *fwnode, 259 const char *propname) 260 { 261 return fwnode_property_present(fwnode, propname); 262 } 263 264 static inline int fwnode_property_read_u8(const struct fwnode_handle *fwnode, 265 const char *propname, u8 *val) 266 { 267 return fwnode_property_read_u8_array(fwnode, propname, val, 1); 268 } 269 270 static inline int fwnode_property_read_u16(const struct fwnode_handle *fwnode, 271 const char *propname, u16 *val) 272 { 273 return fwnode_property_read_u16_array(fwnode, propname, val, 1); 274 } 275 276 static inline int fwnode_property_read_u32(const struct fwnode_handle *fwnode, 277 const char *propname, u32 *val) 278 { 279 return fwnode_property_read_u32_array(fwnode, propname, val, 1); 280 } 281 282 static inline int fwnode_property_read_u64(const struct fwnode_handle *fwnode, 283 const char *propname, u64 *val) 284 { 285 return fwnode_property_read_u64_array(fwnode, propname, val, 1); 286 } 287 288 static inline int fwnode_property_count_u8(const struct fwnode_handle *fwnode, 289 const char *propname) 290 { 291 return fwnode_property_read_u8_array(fwnode, propname, NULL, 0); 292 } 293 294 static inline int fwnode_property_count_u16(const struct fwnode_handle *fwnode, 295 const char *propname) 296 { 297 return fwnode_property_read_u16_array(fwnode, propname, NULL, 0); 298 } 299 300 static inline int fwnode_property_count_u32(const struct fwnode_handle *fwnode, 301 const char *propname) 302 { 303 return fwnode_property_read_u32_array(fwnode, propname, NULL, 0); 304 } 305 306 static inline int fwnode_property_count_u64(const struct fwnode_handle *fwnode, 307 const char *propname) 308 { 309 return fwnode_property_read_u64_array(fwnode, propname, NULL, 0); 310 } 311 312 static inline int 313 fwnode_property_string_array_count(const struct fwnode_handle *fwnode, 314 const char *propname) 315 { 316 return fwnode_property_read_string_array(fwnode, propname, NULL, 0); 317 } 318 319 struct software_node; 320 321 /** 322 * struct software_node_ref_args - Reference property with additional arguments 323 * @node: Reference to a software node 324 * @nargs: Number of elements in @args array 325 * @args: Integer arguments 326 */ 327 struct software_node_ref_args { 328 const struct software_node *node; 329 unsigned int nargs; 330 u64 args[NR_FWNODE_REFERENCE_ARGS]; 331 }; 332 333 #define SOFTWARE_NODE_REFERENCE(_ref_, ...) \ 334 (const struct software_node_ref_args) { \ 335 .node = _ref_, \ 336 .nargs = COUNT_ARGS(__VA_ARGS__), \ 337 .args = { __VA_ARGS__ }, \ 338 } 339 340 /** 341 * struct property_entry - "Built-in" device property representation. 342 * @name: Name of the property. 343 * @length: Length of data making up the value. 344 * @is_inline: True when the property value is stored inline. 345 * @type: Type of the data in unions. 346 * @pointer: Pointer to the property when it is not stored inline. 347 * @value: Value of the property when it is stored inline. 348 */ 349 struct property_entry { 350 const char *name; 351 size_t length; 352 bool is_inline; 353 enum dev_prop_type type; 354 union { 355 const void *pointer; 356 union { 357 u8 u8_data[sizeof(u64) / sizeof(u8)]; 358 u16 u16_data[sizeof(u64) / sizeof(u16)]; 359 u32 u32_data[sizeof(u64) / sizeof(u32)]; 360 u64 u64_data[sizeof(u64) / sizeof(u64)]; 361 const char *str[sizeof(u64) / sizeof(char *)]; 362 } value; 363 }; 364 }; 365 366 /* 367 * Note: the below initializers for the anonymous union are carefully 368 * crafted to avoid gcc-4.4.4's problems with initialization of anon unions 369 * and structs. 370 */ 371 #define __PROPERTY_ENTRY_ARRAY_LEN(_name_, _elem_, _Type_, _val_, _len_) \ 372 (struct property_entry) { \ 373 .name = _name_, \ 374 .length = (_len_) * sizeof_field(struct property_entry, value._elem_[0]), \ 375 .type = DEV_PROP_##_Type_, \ 376 { .pointer = _val_ }, \ 377 } 378 379 #define PROPERTY_ENTRY_U8_ARRAY_LEN(_name_, _val_, _len_) \ 380 __PROPERTY_ENTRY_ARRAY_LEN(_name_, u8_data, U8, _val_, _len_) 381 #define PROPERTY_ENTRY_U16_ARRAY_LEN(_name_, _val_, _len_) \ 382 __PROPERTY_ENTRY_ARRAY_LEN(_name_, u16_data, U16, _val_, _len_) 383 #define PROPERTY_ENTRY_U32_ARRAY_LEN(_name_, _val_, _len_) \ 384 __PROPERTY_ENTRY_ARRAY_LEN(_name_, u32_data, U32, _val_, _len_) 385 #define PROPERTY_ENTRY_U64_ARRAY_LEN(_name_, _val_, _len_) \ 386 __PROPERTY_ENTRY_ARRAY_LEN(_name_, u64_data, U64, _val_, _len_) 387 #define PROPERTY_ENTRY_STRING_ARRAY_LEN(_name_, _val_, _len_) \ 388 __PROPERTY_ENTRY_ARRAY_LEN(_name_, str, STRING, _val_, _len_) 389 390 #define PROPERTY_ENTRY_REF_ARRAY_LEN(_name_, _val_, _len_) \ 391 (struct property_entry) { \ 392 .name = _name_, \ 393 .length = (_len_) * sizeof(struct software_node_ref_args), \ 394 .type = DEV_PROP_REF, \ 395 { .pointer = _val_ }, \ 396 } 397 398 #define PROPERTY_ENTRY_U8_ARRAY(_name_, _val_) \ 399 PROPERTY_ENTRY_U8_ARRAY_LEN(_name_, _val_, ARRAY_SIZE(_val_)) 400 #define PROPERTY_ENTRY_U16_ARRAY(_name_, _val_) \ 401 PROPERTY_ENTRY_U16_ARRAY_LEN(_name_, _val_, ARRAY_SIZE(_val_)) 402 #define PROPERTY_ENTRY_U32_ARRAY(_name_, _val_) \ 403 PROPERTY_ENTRY_U32_ARRAY_LEN(_name_, _val_, ARRAY_SIZE(_val_)) 404 #define PROPERTY_ENTRY_U64_ARRAY(_name_, _val_) \ 405 PROPERTY_ENTRY_U64_ARRAY_LEN(_name_, _val_, ARRAY_SIZE(_val_)) 406 #define PROPERTY_ENTRY_STRING_ARRAY(_name_, _val_) \ 407 PROPERTY_ENTRY_STRING_ARRAY_LEN(_name_, _val_, ARRAY_SIZE(_val_)) 408 #define PROPERTY_ENTRY_REF_ARRAY(_name_, _val_) \ 409 PROPERTY_ENTRY_REF_ARRAY_LEN(_name_, _val_, ARRAY_SIZE(_val_)) 410 411 #define __PROPERTY_ENTRY_ELEMENT(_name_, _elem_, _Type_, _val_) \ 412 (struct property_entry) { \ 413 .name = _name_, \ 414 .length = sizeof_field(struct property_entry, value._elem_[0]), \ 415 .is_inline = true, \ 416 .type = DEV_PROP_##_Type_, \ 417 { .value = { ._elem_[0] = _val_ } }, \ 418 } 419 420 #define PROPERTY_ENTRY_U8(_name_, _val_) \ 421 __PROPERTY_ENTRY_ELEMENT(_name_, u8_data, U8, _val_) 422 #define PROPERTY_ENTRY_U16(_name_, _val_) \ 423 __PROPERTY_ENTRY_ELEMENT(_name_, u16_data, U16, _val_) 424 #define PROPERTY_ENTRY_U32(_name_, _val_) \ 425 __PROPERTY_ENTRY_ELEMENT(_name_, u32_data, U32, _val_) 426 #define PROPERTY_ENTRY_U64(_name_, _val_) \ 427 __PROPERTY_ENTRY_ELEMENT(_name_, u64_data, U64, _val_) 428 #define PROPERTY_ENTRY_STRING(_name_, _val_) \ 429 __PROPERTY_ENTRY_ELEMENT(_name_, str, STRING, _val_) 430 431 #define PROPERTY_ENTRY_REF(_name_, _ref_, ...) \ 432 (struct property_entry) { \ 433 .name = _name_, \ 434 .length = sizeof(struct software_node_ref_args), \ 435 .type = DEV_PROP_REF, \ 436 { .pointer = &SOFTWARE_NODE_REFERENCE(_ref_, ##__VA_ARGS__), }, \ 437 } 438 439 #define PROPERTY_ENTRY_BOOL(_name_) \ 440 (struct property_entry) { \ 441 .name = _name_, \ 442 .is_inline = true, \ 443 } 444 445 struct property_entry * 446 property_entries_dup(const struct property_entry *properties); 447 void property_entries_free(const struct property_entry *properties); 448 449 bool device_dma_supported(const struct device *dev); 450 enum dev_dma_attr device_get_dma_attr(const struct device *dev); 451 452 const void *device_get_match_data(const struct device *dev); 453 454 int device_get_phy_mode(struct device *dev); 455 int fwnode_get_phy_mode(const struct fwnode_handle *fwnode); 456 457 void __iomem *fwnode_iomap(struct fwnode_handle *fwnode, int index); 458 459 struct fwnode_handle *fwnode_graph_get_next_endpoint( 460 const struct fwnode_handle *fwnode, struct fwnode_handle *prev); 461 struct fwnode_handle * 462 fwnode_graph_get_port_parent(const struct fwnode_handle *fwnode); 463 struct fwnode_handle *fwnode_graph_get_remote_port_parent( 464 const struct fwnode_handle *fwnode); 465 struct fwnode_handle *fwnode_graph_get_remote_port( 466 const struct fwnode_handle *fwnode); 467 struct fwnode_handle *fwnode_graph_get_remote_endpoint( 468 const struct fwnode_handle *fwnode); 469 470 static inline bool fwnode_graph_is_endpoint(const struct fwnode_handle *fwnode) 471 { 472 return fwnode_property_present(fwnode, "remote-endpoint"); 473 } 474 475 /* 476 * Fwnode lookup flags 477 * 478 * @FWNODE_GRAPH_ENDPOINT_NEXT: In the case of no exact match, look for the 479 * closest endpoint ID greater than the specified 480 * one. 481 * @FWNODE_GRAPH_DEVICE_DISABLED: That the device to which the remote 482 * endpoint of the given endpoint belongs to, 483 * may be disabled, or that the endpoint is not 484 * connected. 485 */ 486 #define FWNODE_GRAPH_ENDPOINT_NEXT BIT(0) 487 #define FWNODE_GRAPH_DEVICE_DISABLED BIT(1) 488 489 struct fwnode_handle * 490 fwnode_graph_get_endpoint_by_id(const struct fwnode_handle *fwnode, 491 u32 port, u32 endpoint, unsigned long flags); 492 unsigned int fwnode_graph_get_endpoint_count(const struct fwnode_handle *fwnode, 493 unsigned long flags); 494 495 #define fwnode_graph_for_each_endpoint(fwnode, child) \ 496 for (child = fwnode_graph_get_next_endpoint(fwnode, NULL); child; \ 497 child = fwnode_graph_get_next_endpoint(fwnode, child)) 498 499 int fwnode_graph_parse_endpoint(const struct fwnode_handle *fwnode, 500 struct fwnode_endpoint *endpoint); 501 502 typedef void *(*devcon_match_fn_t)(const struct fwnode_handle *fwnode, const char *id, 503 void *data); 504 505 void *fwnode_connection_find_match(const struct fwnode_handle *fwnode, 506 const char *con_id, void *data, 507 devcon_match_fn_t match); 508 509 static inline void *device_connection_find_match(const struct device *dev, 510 const char *con_id, void *data, 511 devcon_match_fn_t match) 512 { 513 return fwnode_connection_find_match(dev_fwnode(dev), con_id, data, match); 514 } 515 516 int fwnode_connection_find_matches(const struct fwnode_handle *fwnode, 517 const char *con_id, void *data, 518 devcon_match_fn_t match, 519 void **matches, unsigned int matches_len); 520 521 /* -------------------------------------------------------------------------- */ 522 /* Software fwnode support - when HW description is incomplete or missing */ 523 524 /** 525 * struct software_node - Software node description 526 * @name: Name of the software node 527 * @parent: Parent of the software node 528 * @properties: Array of device properties 529 */ 530 struct software_node { 531 const char *name; 532 const struct software_node *parent; 533 const struct property_entry *properties; 534 }; 535 536 #define SOFTWARE_NODE(_name_, _properties_, _parent_) \ 537 (struct software_node) { \ 538 .name = _name_, \ 539 .properties = _properties_, \ 540 .parent = _parent_, \ 541 } 542 543 bool is_software_node(const struct fwnode_handle *fwnode); 544 const struct software_node * 545 to_software_node(const struct fwnode_handle *fwnode); 546 struct fwnode_handle *software_node_fwnode(const struct software_node *node); 547 548 const struct software_node * 549 software_node_find_by_name(const struct software_node *parent, 550 const char *name); 551 552 int software_node_register_node_group(const struct software_node **node_group); 553 void software_node_unregister_node_group(const struct software_node **node_group); 554 555 int software_node_register(const struct software_node *node); 556 void software_node_unregister(const struct software_node *node); 557 558 struct fwnode_handle * 559 fwnode_create_software_node(const struct property_entry *properties, 560 const struct fwnode_handle *parent); 561 void fwnode_remove_software_node(struct fwnode_handle *fwnode); 562 563 int device_add_software_node(struct device *dev, const struct software_node *node); 564 void device_remove_software_node(struct device *dev); 565 566 int device_create_managed_software_node(struct device *dev, 567 const struct property_entry *properties, 568 const struct software_node *parent); 569 570 #endif /* _LINUX_PROPERTY_H_ */ 571