Stephen Rothwell | b41912c | 2007-05-01 16:12:57 +1000 | [diff] [blame] | 1 | #ifndef _LINUX_OF_PLATFORM_H |
| 2 | #define _LINUX_OF_PLATFORM_H |
| 3 | /* |
| 4 | * Copyright (C) 2006 Benjamin Herrenschmidt, IBM Corp. |
| 5 | * <benh@kernel.crashing.org> |
| 6 | * |
| 7 | * This program is free software; you can redistribute it and/or |
| 8 | * modify it under the terms of the GNU General Public License |
| 9 | * as published by the Free Software Foundation; either version |
| 10 | * 2 of the License, or (at your option) any later version. |
| 11 | * |
| 12 | */ |
| 13 | |
Stephen Rothwell | b41912c | 2007-05-01 16:12:57 +1000 | [diff] [blame] | 14 | #include <linux/device.h> |
| 15 | #include <linux/mod_devicetable.h> |
| 16 | #include <linux/pm.h> |
| 17 | #include <linux/of_device.h> |
Grant Likely | eca3930 | 2010-06-08 07:48:21 -0600 | [diff] [blame] | 18 | #include <linux/platform_device.h> |
Stephen Rothwell | b41912c | 2007-05-01 16:12:57 +1000 | [diff] [blame] | 19 | |
Grant Likely | 2dc1158 | 2010-08-06 09:25:50 -0600 | [diff] [blame] | 20 | /** |
Grant Likely | 15c3597 | 2011-06-21 10:59:35 -0600 | [diff] [blame] | 21 | * struct of_dev_auxdata - lookup table entry for device names & platform_data |
| 22 | * @compatible: compatible value of node to match against node |
| 23 | * @phys_addr: Start address of registers to match against node |
| 24 | * @name: Name to assign for matching nodes |
| 25 | * @platform_data: platform_data to assign for matching nodes |
| 26 | * |
| 27 | * This lookup table allows the caller of of_platform_populate() to override |
| 28 | * the names of devices when creating devices from the device tree. The table |
| 29 | * should be terminated with an empty entry. It also allows the platform_data |
| 30 | * pointer to be set. |
| 31 | * |
| 32 | * The reason for this functionality is that some Linux infrastructure uses |
| 33 | * the device name to look up a specific device, but the Linux-specific names |
| 34 | * are not encoded into the device tree, so the kernel needs to provide specific |
| 35 | * values. |
| 36 | * |
| 37 | * Note: Using an auxdata lookup table should be considered a last resort when |
| 38 | * converting a platform to use the DT. Normally the automatically generated |
| 39 | * device name will not matter, and drivers should obtain data from the device |
Geert Uytterhoeven | 8c1eb25 | 2014-03-11 11:23:50 +0100 | [diff] [blame] | 40 | * node instead of from an anonymous platform_data pointer. |
Grant Likely | 15c3597 | 2011-06-21 10:59:35 -0600 | [diff] [blame] | 41 | */ |
| 42 | struct of_dev_auxdata { |
| 43 | char *compatible; |
| 44 | resource_size_t phys_addr; |
| 45 | char *name; |
| 46 | void *platform_data; |
| 47 | }; |
| 48 | |
| 49 | /* Macro to simplify populating a lookup table */ |
| 50 | #define OF_DEV_AUXDATA(_compat,_phys,_name,_pdata) \ |
| 51 | { .compatible = _compat, .phys_addr = _phys, .name = _name, \ |
| 52 | .platform_data = _pdata } |
| 53 | |
Grant Likely | cbb49c2 | 2011-06-21 10:59:34 -0600 | [diff] [blame] | 54 | extern const struct of_device_id of_default_bus_match_table[]; |
| 55 | |
Grant Likely | 0763ed2 | 2009-04-30 15:08:50 -0700 | [diff] [blame] | 56 | /* Platform drivers register/unregister */ |
Grant Likely | 94a0cb1 | 2010-07-22 13:59:23 -0600 | [diff] [blame] | 57 | extern struct platform_device *of_device_alloc(struct device_node *np, |
Grant Likely | 94c0931 | 2010-06-08 07:48:14 -0600 | [diff] [blame] | 58 | const char *bus_id, |
| 59 | struct device *parent); |
Grant Likely | 94a0cb1 | 2010-07-22 13:59:23 -0600 | [diff] [blame] | 60 | extern struct platform_device *of_find_device_by_node(struct device_node *np); |
Stephen Rothwell | b41912c | 2007-05-01 16:12:57 +1000 | [diff] [blame] | 61 | |
Grant Likely | 5fd200f | 2010-06-08 07:48:13 -0600 | [diff] [blame] | 62 | /* Platform devices and busses creation */ |
Grant Likely | 94a0cb1 | 2010-07-22 13:59:23 -0600 | [diff] [blame] | 63 | extern struct platform_device *of_platform_device_create(struct device_node *np, |
Grant Likely | 5fd200f | 2010-06-08 07:48:13 -0600 | [diff] [blame] | 64 | const char *bus_id, |
| 65 | struct device *parent); |
| 66 | |
Grant Likely | 5fd200f | 2010-06-08 07:48:13 -0600 | [diff] [blame] | 67 | extern int of_platform_bus_probe(struct device_node *root, |
| 68 | const struct of_device_id *matches, |
| 69 | struct device *parent); |
Arnd Bergmann | 8a46f4f | 2013-06-01 00:22:52 +0200 | [diff] [blame] | 70 | #ifdef CONFIG_OF_ADDRESS |
Grant Likely | 29d4f8a | 2011-06-21 10:59:34 -0600 | [diff] [blame] | 71 | extern int of_platform_populate(struct device_node *root, |
| 72 | const struct of_device_id *matches, |
Grant Likely | 15c3597 | 2011-06-21 10:59:35 -0600 | [diff] [blame] | 73 | const struct of_dev_auxdata *lookup, |
Grant Likely | 29d4f8a | 2011-06-21 10:59:34 -0600 | [diff] [blame] | 74 | struct device *parent); |
Hauke Mehrtens | 43443ad | 2015-08-02 19:44:43 +0200 | [diff] [blame] | 75 | extern int of_platform_default_populate(struct device_node *root, |
| 76 | const struct of_dev_auxdata *lookup, |
| 77 | struct device *parent); |
Grant Likely | 75f353b | 2014-06-24 16:13:47 +0100 | [diff] [blame] | 78 | extern void of_platform_depopulate(struct device *parent); |
Benjamin Gaignard | 38b0b21 | 2017-02-24 17:14:33 +0100 | [diff] [blame] | 79 | |
| 80 | extern int devm_of_platform_populate(struct device *dev); |
| 81 | |
| 82 | extern void devm_of_platform_depopulate(struct device *dev); |
Arnd Bergmann | 8a46f4f | 2013-06-01 00:22:52 +0200 | [diff] [blame] | 83 | #else |
Grant Likely | 964dba2 | 2012-02-24 14:58:34 -0700 | [diff] [blame] | 84 | static inline int of_platform_populate(struct device_node *root, |
| 85 | const struct of_device_id *matches, |
| 86 | const struct of_dev_auxdata *lookup, |
| 87 | struct device *parent) |
| 88 | { |
| 89 | return -ENODEV; |
| 90 | } |
Hauke Mehrtens | 43443ad | 2015-08-02 19:44:43 +0200 | [diff] [blame] | 91 | static inline int of_platform_default_populate(struct device_node *root, |
| 92 | const struct of_dev_auxdata *lookup, |
| 93 | struct device *parent) |
| 94 | { |
| 95 | return -ENODEV; |
| 96 | } |
Grant Likely | 75f353b | 2014-06-24 16:13:47 +0100 | [diff] [blame] | 97 | static inline void of_platform_depopulate(struct device *parent) { } |
Benjamin Gaignard | 38b0b21 | 2017-02-24 17:14:33 +0100 | [diff] [blame] | 98 | |
| 99 | static inline int devm_of_platform_populate(struct device *dev) |
| 100 | { |
| 101 | return -ENODEV; |
| 102 | } |
| 103 | |
| 104 | static inline void devm_of_platform_depopulate(struct device *dev) { } |
Arnd Bergmann | 8a46f4f | 2013-06-01 00:22:52 +0200 | [diff] [blame] | 105 | #endif |
Grant Likely | 5fd200f | 2010-06-08 07:48:13 -0600 | [diff] [blame] | 106 | |
Guenter Roeck | a697c2e | 2015-03-10 20:31:04 -0700 | [diff] [blame] | 107 | #if defined(CONFIG_OF_DYNAMIC) && defined(CONFIG_OF_ADDRESS) |
Pantelis Antoniou | 801d728 | 2014-10-28 22:36:01 +0200 | [diff] [blame] | 108 | extern void of_platform_register_reconfig_notifier(void); |
| 109 | #else |
| 110 | static inline void of_platform_register_reconfig_notifier(void) { } |
| 111 | #endif |
| 112 | |
Stephen Rothwell | b41912c | 2007-05-01 16:12:57 +1000 | [diff] [blame] | 113 | #endif /* _LINUX_OF_PLATFORM_H */ |