1 #ifndef _LINUX_OF_PLATFORM_H 2 #define _LINUX_OF_PLATFORM_H 3 /* 4 * Copyright (C) 2006 Benjamin Herrenschmidt, IBM Corp. 5 * <[email protected]> 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 14 #include <linux/device.h> 15 #include <linux/mod_devicetable.h> 16 17 #ifdef CONFIG_OF_DEVICE 18 #include <linux/pm.h> 19 #include <linux/of_device.h> 20 #include <linux/platform_device.h> 21 22 /** 23 * struct of_dev_auxdata - lookup table entry for device names & platform_data 24 * @compatible: compatible value of node to match against node 25 * @phys_addr: Start address of registers to match against node 26 * @name: Name to assign for matching nodes 27 * @platform_data: platform_data to assign for matching nodes 28 * 29 * This lookup table allows the caller of of_platform_populate() to override 30 * the names of devices when creating devices from the device tree. The table 31 * should be terminated with an empty entry. It also allows the platform_data 32 * pointer to be set. 33 * 34 * The reason for this functionality is that some Linux infrastructure uses 35 * the device name to look up a specific device, but the Linux-specific names 36 * are not encoded into the device tree, so the kernel needs to provide specific 37 * values. 38 * 39 * Note: Using an auxdata lookup table should be considered a last resort when 40 * converting a platform to use the DT. Normally the automatically generated 41 * device name will not matter, and drivers should obtain data from the device 42 * node instead of from an anonymouns platform_data pointer. 43 */ 44 struct of_dev_auxdata { 45 char *compatible; 46 resource_size_t phys_addr; 47 char *name; 48 void *platform_data; 49 }; 50 51 /* Macro to simplify populating a lookup table */ 52 #define OF_DEV_AUXDATA(_compat,_phys,_name,_pdata) \ 53 { .compatible = _compat, .phys_addr = _phys, .name = _name, \ 54 .platform_data = _pdata } 55 56 /** 57 * of_platform_driver - Legacy of-aware driver for platform devices. 58 * 59 * An of_platform_driver driver is attached to a basic platform_device on 60 * the ibm ebus (ibmebus_bus_type). 61 */ 62 struct of_platform_driver 63 { 64 int (*probe)(struct platform_device* dev, 65 const struct of_device_id *match); 66 int (*remove)(struct platform_device* dev); 67 68 int (*suspend)(struct platform_device* dev, pm_message_t state); 69 int (*resume)(struct platform_device* dev); 70 int (*shutdown)(struct platform_device* dev); 71 72 struct device_driver driver; 73 }; 74 #define to_of_platform_driver(drv) \ 75 container_of(drv,struct of_platform_driver, driver) 76 77 extern const struct of_device_id of_default_bus_match_table[]; 78 79 /* Platform drivers register/unregister */ 80 extern struct platform_device *of_device_alloc(struct device_node *np, 81 const char *bus_id, 82 struct device *parent); 83 extern struct platform_device *of_find_device_by_node(struct device_node *np); 84 85 #ifdef CONFIG_OF_ADDRESS /* device reg helpers depend on OF_ADDRESS */ 86 /* Platform devices and busses creation */ 87 extern struct platform_device *of_platform_device_create(struct device_node *np, 88 const char *bus_id, 89 struct device *parent); 90 91 extern int of_platform_bus_probe(struct device_node *root, 92 const struct of_device_id *matches, 93 struct device *parent); 94 extern int of_platform_populate(struct device_node *root, 95 const struct of_device_id *matches, 96 const struct of_dev_auxdata *lookup, 97 struct device *parent); 98 #endif /* CONFIG_OF_ADDRESS */ 99 100 #endif /* CONFIG_OF_DEVICE */ 101 102 #if !defined(CONFIG_OF_ADDRESS) 103 struct of_dev_auxdata; 104 struct device_node; 105 static inline int of_platform_populate(struct device_node *root, 106 const struct of_device_id *matches, 107 const struct of_dev_auxdata *lookup, 108 struct device *parent) 109 { 110 return -ENODEV; 111 } 112 #endif /* !CONFIG_OF_ADDRESS */ 113 114 #endif /* _LINUX_OF_PLATFORM_H */ 115