1 /* 2 * platform_device.h - generic, centralized driver model 3 * 4 * Copyright (c) 2001-2003 Patrick Mochel <[email protected]> 5 * 6 * This file is released under the GPLv2 7 * 8 * See Documentation/driver-model/ for more information. 9 */ 10 11 #ifndef _PLATFORM_DEVICE_H_ 12 #define _PLATFORM_DEVICE_H_ 13 14 #include <linux/device.h> 15 #include <linux/mod_devicetable.h> 16 17 struct platform_device { 18 const char * name; 19 int id; 20 struct device dev; 21 u32 num_resources; 22 struct resource * resource; 23 24 const struct platform_device_id *id_entry; 25 26 /* arch specific additions */ 27 struct pdev_archdata archdata; 28 }; 29 30 #define platform_get_device_id(pdev) ((pdev)->id_entry) 31 32 #define to_platform_device(x) container_of((x), struct platform_device, dev) 33 34 extern int platform_device_register(struct platform_device *); 35 extern void platform_device_unregister(struct platform_device *); 36 37 extern struct bus_type platform_bus_type; 38 extern struct device platform_bus; 39 40 extern struct resource *platform_get_resource(struct platform_device *, unsigned int, unsigned int); 41 extern int platform_get_irq(struct platform_device *, unsigned int); 42 extern struct resource *platform_get_resource_byname(struct platform_device *, unsigned int, const char *); 43 extern int platform_get_irq_byname(struct platform_device *, const char *); 44 extern int platform_add_devices(struct platform_device **, int); 45 46 extern struct platform_device *platform_device_register_resndata( 47 struct device *parent, const char *name, int id, 48 const struct resource *res, unsigned int num, 49 const void *data, size_t size); 50 51 /** 52 * platform_device_register_simple - add a platform-level device and its resources 53 * @name: base name of the device we're adding 54 * @id: instance id 55 * @res: set of resources that needs to be allocated for the device 56 * @num: number of resources 57 * 58 * This function creates a simple platform device that requires minimal 59 * resource and memory management. Canned release function freeing memory 60 * allocated for the device allows drivers using such devices to be 61 * unloaded without waiting for the last reference to the device to be 62 * dropped. 63 * 64 * This interface is primarily intended for use with legacy drivers which 65 * probe hardware directly. Because such drivers create sysfs device nodes 66 * themselves, rather than letting system infrastructure handle such device 67 * enumeration tasks, they don't fully conform to the Linux driver model. 68 * In particular, when such drivers are built as modules, they can't be 69 * "hotplugged". 70 * 71 * Returns &struct platform_device pointer on success, or ERR_PTR() on error. 72 */ 73 static inline struct platform_device *platform_device_register_simple( 74 const char *name, int id, 75 const struct resource *res, unsigned int num) 76 { 77 return platform_device_register_resndata(NULL, name, id, 78 res, num, NULL, 0); 79 } 80 81 /** 82 * platform_device_register_data - add a platform-level device with platform-specific data 83 * @parent: parent device for the device we're adding 84 * @name: base name of the device we're adding 85 * @id: instance id 86 * @data: platform specific data for this platform device 87 * @size: size of platform specific data 88 * 89 * This function creates a simple platform device that requires minimal 90 * resource and memory management. Canned release function freeing memory 91 * allocated for the device allows drivers using such devices to be 92 * unloaded without waiting for the last reference to the device to be 93 * dropped. 94 * 95 * Returns &struct platform_device pointer on success, or ERR_PTR() on error. 96 */ 97 static inline struct platform_device *platform_device_register_data( 98 struct device *parent, const char *name, int id, 99 const void *data, size_t size) 100 { 101 return platform_device_register_resndata(parent, name, id, 102 NULL, 0, data, size); 103 } 104 105 extern struct platform_device *platform_device_alloc(const char *name, int id); 106 extern int platform_device_add_resources(struct platform_device *pdev, 107 const struct resource *res, 108 unsigned int num); 109 extern int platform_device_add_data(struct platform_device *pdev, const void *data, size_t size); 110 extern int platform_device_add(struct platform_device *pdev); 111 extern void platform_device_del(struct platform_device *pdev); 112 extern void platform_device_put(struct platform_device *pdev); 113 114 struct platform_driver { 115 int (*probe)(struct platform_device *); 116 int (*remove)(struct platform_device *); 117 void (*shutdown)(struct platform_device *); 118 int (*suspend)(struct platform_device *, pm_message_t state); 119 int (*resume)(struct platform_device *); 120 struct device_driver driver; 121 const struct platform_device_id *id_table; 122 }; 123 124 extern int platform_driver_register(struct platform_driver *); 125 extern void platform_driver_unregister(struct platform_driver *); 126 127 /* non-hotpluggable platform devices may use this so that probe() and 128 * its support may live in __init sections, conserving runtime memory. 129 */ 130 extern int platform_driver_probe(struct platform_driver *driver, 131 int (*probe)(struct platform_device *)); 132 133 #define platform_get_drvdata(_dev) dev_get_drvdata(&(_dev)->dev) 134 #define platform_set_drvdata(_dev,data) dev_set_drvdata(&(_dev)->dev, (data)) 135 136 extern struct platform_device *platform_create_bundle(struct platform_driver *driver, 137 int (*probe)(struct platform_device *), 138 struct resource *res, unsigned int n_res, 139 const void *data, size_t size); 140 141 extern const struct dev_pm_ops * platform_bus_get_pm_ops(void); 142 extern void platform_bus_set_pm_ops(const struct dev_pm_ops *pm); 143 144 /* early platform driver interface */ 145 struct early_platform_driver { 146 const char *class_str; 147 struct platform_driver *pdrv; 148 struct list_head list; 149 int requested_id; 150 char *buffer; 151 int bufsize; 152 }; 153 154 #define EARLY_PLATFORM_ID_UNSET -2 155 #define EARLY_PLATFORM_ID_ERROR -3 156 157 extern int early_platform_driver_register(struct early_platform_driver *epdrv, 158 char *buf); 159 extern void early_platform_add_devices(struct platform_device **devs, int num); 160 161 static inline int is_early_platform_device(struct platform_device *pdev) 162 { 163 return !pdev->dev.driver; 164 } 165 166 extern void early_platform_driver_register_all(char *class_str); 167 extern int early_platform_driver_probe(char *class_str, 168 int nr_probe, int user_only); 169 extern void early_platform_cleanup(void); 170 171 #define early_platform_init(class_string, platdrv) \ 172 early_platform_init_buffer(class_string, platdrv, NULL, 0) 173 174 #ifndef MODULE 175 #define early_platform_init_buffer(class_string, platdrv, buf, bufsiz) \ 176 static __initdata struct early_platform_driver early_driver = { \ 177 .class_str = class_string, \ 178 .buffer = buf, \ 179 .bufsize = bufsiz, \ 180 .pdrv = platdrv, \ 181 .requested_id = EARLY_PLATFORM_ID_UNSET, \ 182 }; \ 183 static int __init early_platform_driver_setup_func(char *buffer) \ 184 { \ 185 return early_platform_driver_register(&early_driver, buffer); \ 186 } \ 187 early_param(class_string, early_platform_driver_setup_func) 188 #else /* MODULE */ 189 #define early_platform_init_buffer(class_string, platdrv, buf, bufsiz) \ 190 static inline char *early_platform_driver_setup_func(void) \ 191 { \ 192 return bufsiz ? buf : NULL; \ 193 } 194 #endif /* MODULE */ 195 196 #endif /* _PLATFORM_DEVICE_H_ */ 197