1 /* SPDX-License-Identifier: GPL-2.0+ */ 2 #ifndef _LINUX_OF_PLATFORM_H 3 #define _LINUX_OF_PLATFORM_H 4 /* 5 * Copyright (C) 2006 Benjamin Herrenschmidt, IBM Corp. 6 * <[email protected]> 7 */ 8 9 #include <linux/device.h> 10 #include <linux/mod_devicetable.h> 11 #include <linux/pm.h> 12 #include <linux/of_device.h> 13 #include <linux/platform_device.h> 14 15 /** 16 * struct of_dev_auxdata - lookup table entry for device names & platform_data 17 * @compatible: compatible value of node to match against node 18 * @phys_addr: Start address of registers to match against node 19 * @name: Name to assign for matching nodes 20 * @platform_data: platform_data to assign for matching nodes 21 * 22 * This lookup table allows the caller of of_platform_populate() to override 23 * the names of devices when creating devices from the device tree. The table 24 * should be terminated with an empty entry. It also allows the platform_data 25 * pointer to be set. 26 * 27 * The reason for this functionality is that some Linux infrastructure uses 28 * the device name to look up a specific device, but the Linux-specific names 29 * are not encoded into the device tree, so the kernel needs to provide specific 30 * values. 31 * 32 * Note: Using an auxdata lookup table should be considered a last resort when 33 * converting a platform to use the DT. Normally the automatically generated 34 * device name will not matter, and drivers should obtain data from the device 35 * node instead of from an anonymous platform_data pointer. 36 */ 37 struct of_dev_auxdata { 38 char *compatible; 39 resource_size_t phys_addr; 40 char *name; 41 void *platform_data; 42 }; 43 44 /* Macro to simplify populating a lookup table */ 45 #define OF_DEV_AUXDATA(_compat,_phys,_name,_pdata) \ 46 { .compatible = _compat, .phys_addr = _phys, .name = _name, \ 47 .platform_data = _pdata } 48 49 extern const struct of_device_id of_default_bus_match_table[]; 50 51 /* Platform drivers register/unregister */ 52 extern struct platform_device *of_device_alloc(struct device_node *np, 53 const char *bus_id, 54 struct device *parent); 55 56 extern int of_device_add(struct platform_device *pdev); 57 extern int of_device_register(struct platform_device *ofdev); 58 extern void of_device_unregister(struct platform_device *ofdev); 59 60 #ifdef CONFIG_OF 61 extern struct platform_device *of_find_device_by_node(struct device_node *np); 62 #else 63 static inline struct platform_device *of_find_device_by_node(struct device_node *np) 64 { 65 return NULL; 66 } 67 #endif 68 69 extern int of_platform_bus_probe(struct device_node *root, 70 const struct of_device_id *matches, 71 struct device *parent); 72 73 #ifdef CONFIG_OF_ADDRESS 74 /* Platform devices and busses creation */ 75 extern struct platform_device *of_platform_device_create(struct device_node *np, 76 const char *bus_id, 77 struct device *parent); 78 79 extern int of_platform_device_destroy(struct device *dev, void *data); 80 81 extern int of_platform_populate(struct device_node *root, 82 const struct of_device_id *matches, 83 const struct of_dev_auxdata *lookup, 84 struct device *parent); 85 extern int of_platform_default_populate(struct device_node *root, 86 const struct of_dev_auxdata *lookup, 87 struct device *parent); 88 extern void of_platform_depopulate(struct device *parent); 89 90 extern int devm_of_platform_populate(struct device *dev); 91 92 extern void devm_of_platform_depopulate(struct device *dev); 93 #else 94 /* Platform devices and busses creation */ 95 static inline struct platform_device *of_platform_device_create(struct device_node *np, 96 const char *bus_id, 97 struct device *parent) 98 { 99 return NULL; 100 } 101 static inline int of_platform_device_destroy(struct device *dev, void *data) 102 { 103 return -ENODEV; 104 } 105 106 static inline int of_platform_populate(struct device_node *root, 107 const struct of_device_id *matches, 108 const struct of_dev_auxdata *lookup, 109 struct device *parent) 110 { 111 return -ENODEV; 112 } 113 static inline int of_platform_default_populate(struct device_node *root, 114 const struct of_dev_auxdata *lookup, 115 struct device *parent) 116 { 117 return -ENODEV; 118 } 119 static inline void of_platform_depopulate(struct device *parent) { } 120 121 static inline int devm_of_platform_populate(struct device *dev) 122 { 123 return -ENODEV; 124 } 125 126 static inline void devm_of_platform_depopulate(struct device *dev) { } 127 #endif 128 129 #if defined(CONFIG_OF_DYNAMIC) && defined(CONFIG_OF_ADDRESS) 130 extern void of_platform_register_reconfig_notifier(void); 131 #else 132 static inline void of_platform_register_reconfig_notifier(void) { } 133 #endif 134 135 #endif /* _LINUX_OF_PLATFORM_H */ 136