1 /* 2 * acpi_bus.h - ACPI Bus Driver ($Revision: 22 $) 3 * 4 * Copyright (C) 2001, 2002 Andy Grover <andrew.grover@intel.com> 5 * Copyright (C) 2001, 2002 Paul Diefenbaugh <paul.s.diefenbaugh@intel.com> 6 * 7 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 8 * 9 * This program is free software; you can redistribute it and/or modify 10 * it under the terms of the GNU General Public License as published by 11 * the Free Software Foundation; either version 2 of the License, or (at 12 * your option) any later version. 13 * 14 * This program is distributed in the hope that it will be useful, but 15 * WITHOUT ANY WARRANTY; without even the implied warranty of 16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 17 * General Public License for more details. 18 * 19 * You should have received a copy of the GNU General Public License along 20 * with this program; if not, write to the Free Software Foundation, Inc., 21 * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. 22 * 23 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 24 */ 25 26 #ifndef __ACPI_BUS_H__ 27 #define __ACPI_BUS_H__ 28 29 #include <linux/device.h> 30 31 #include <acpi/acpi.h> 32 33 #define PREFIX "ACPI: " 34 35 /* TBD: Make dynamic */ 36 #define ACPI_MAX_HANDLES 10 37 struct acpi_handle_list { 38 u32 count; 39 acpi_handle handles[ACPI_MAX_HANDLES]; 40 }; 41 42 /* acpi_utils.h */ 43 acpi_status 44 acpi_extract_package(union acpi_object *package, 45 struct acpi_buffer *format, struct acpi_buffer *buffer); 46 acpi_status 47 acpi_evaluate_integer(acpi_handle handle, 48 acpi_string pathname, 49 struct acpi_object_list *arguments, unsigned long *data); 50 acpi_status 51 acpi_evaluate_reference(acpi_handle handle, 52 acpi_string pathname, 53 struct acpi_object_list *arguments, 54 struct acpi_handle_list *list); 55 56 #ifdef CONFIG_ACPI 57 58 #include <linux/proc_fs.h> 59 60 #define ACPI_BUS_FILE_ROOT "acpi" 61 extern struct proc_dir_entry *acpi_root_dir; 62 63 enum acpi_bus_removal_type { 64 ACPI_BUS_REMOVAL_NORMAL = 0, 65 ACPI_BUS_REMOVAL_EJECT, 66 ACPI_BUS_REMOVAL_SUPRISE, 67 ACPI_BUS_REMOVAL_TYPE_COUNT 68 }; 69 70 enum acpi_bus_device_type { 71 ACPI_BUS_TYPE_DEVICE = 0, 72 ACPI_BUS_TYPE_POWER, 73 ACPI_BUS_TYPE_PROCESSOR, 74 ACPI_BUS_TYPE_THERMAL, 75 ACPI_BUS_TYPE_SYSTEM, 76 ACPI_BUS_TYPE_POWER_BUTTON, 77 ACPI_BUS_TYPE_SLEEP_BUTTON, 78 ACPI_BUS_DEVICE_TYPE_COUNT 79 }; 80 81 struct acpi_driver; 82 struct acpi_device; 83 84 /* 85 * ACPI Driver 86 * ----------- 87 */ 88 89 typedef int (*acpi_op_add) (struct acpi_device * device); 90 typedef int (*acpi_op_remove) (struct acpi_device * device, int type); 91 typedef int (*acpi_op_lock) (struct acpi_device * device, int type); 92 typedef int (*acpi_op_start) (struct acpi_device * device); 93 typedef int (*acpi_op_stop) (struct acpi_device * device, int type); 94 typedef int (*acpi_op_suspend) (struct acpi_device * device, pm_message_t state); 95 typedef int (*acpi_op_resume) (struct acpi_device * device); 96 typedef int (*acpi_op_scan) (struct acpi_device * device); 97 typedef int (*acpi_op_bind) (struct acpi_device * device); 98 typedef int (*acpi_op_unbind) (struct acpi_device * device); 99 typedef int (*acpi_op_shutdown) (struct acpi_device * device); 100 101 struct acpi_bus_ops { 102 u32 acpi_op_add:1; 103 u32 acpi_op_remove:1; 104 u32 acpi_op_lock:1; 105 u32 acpi_op_start:1; 106 u32 acpi_op_stop:1; 107 u32 acpi_op_suspend:1; 108 u32 acpi_op_resume:1; 109 u32 acpi_op_scan:1; 110 u32 acpi_op_bind:1; 111 u32 acpi_op_unbind:1; 112 u32 acpi_op_shutdown:1; 113 u32 reserved:21; 114 }; 115 116 struct acpi_device_ops { 117 acpi_op_add add; 118 acpi_op_remove remove; 119 acpi_op_lock lock; 120 acpi_op_start start; 121 acpi_op_stop stop; 122 acpi_op_suspend suspend; 123 acpi_op_resume resume; 124 acpi_op_scan scan; 125 acpi_op_bind bind; 126 acpi_op_unbind unbind; 127 acpi_op_shutdown shutdown; 128 }; 129 130 struct acpi_driver { 131 char name[80]; 132 char class[80]; 133 char *ids; /* Supported Hardware IDs */ 134 struct acpi_device_ops ops; 135 struct device_driver drv; 136 struct module *owner; 137 }; 138 139 /* 140 * ACPI Device 141 * ----------- 142 */ 143 144 /* Status (_STA) */ 145 146 struct acpi_device_status { 147 u32 present:1; 148 u32 enabled:1; 149 u32 show_in_ui:1; 150 u32 functional:1; 151 u32 battery_present:1; 152 u32 reserved:27; 153 }; 154 155 /* Flags */ 156 157 struct acpi_device_flags { 158 u32 dynamic_status:1; 159 u32 hardware_id:1; 160 u32 compatible_ids:1; 161 u32 bus_address:1; 162 u32 unique_id:1; 163 u32 removable:1; 164 u32 ejectable:1; 165 u32 lockable:1; 166 u32 suprise_removal_ok:1; 167 u32 power_manageable:1; 168 u32 performance_manageable:1; 169 u32 wake_capable:1; /* Wakeup(_PRW) supported? */ 170 u32 force_power_state:1; 171 u32 reserved:19; 172 }; 173 174 /* File System */ 175 176 struct acpi_device_dir { 177 struct proc_dir_entry *entry; 178 }; 179 180 #define acpi_device_dir(d) ((d)->dir.entry) 181 182 /* Plug and Play */ 183 184 typedef char acpi_bus_id[5]; 185 typedef unsigned long acpi_bus_address; 186 typedef char acpi_hardware_id[15]; 187 typedef char acpi_unique_id[9]; 188 typedef char acpi_device_name[40]; 189 typedef char acpi_device_class[20]; 190 191 struct acpi_device_pnp { 192 acpi_bus_id bus_id; /* Object name */ 193 acpi_bus_address bus_address; /* _ADR */ 194 acpi_hardware_id hardware_id; /* _HID */ 195 struct acpi_compatible_id_list *cid_list; /* _CIDs */ 196 acpi_unique_id unique_id; /* _UID */ 197 acpi_device_name device_name; /* Driver-determined */ 198 acpi_device_class device_class; /* " */ 199 }; 200 201 #define acpi_device_bid(d) ((d)->pnp.bus_id) 202 #define acpi_device_adr(d) ((d)->pnp.bus_address) 203 #define acpi_device_hid(d) ((d)->pnp.hardware_id) 204 #define acpi_device_uid(d) ((d)->pnp.unique_id) 205 #define acpi_device_name(d) ((d)->pnp.device_name) 206 #define acpi_device_class(d) ((d)->pnp.device_class) 207 208 /* Power Management */ 209 210 struct acpi_device_power_flags { 211 u32 explicit_get:1; /* _PSC present? */ 212 u32 power_resources:1; /* Power resources */ 213 u32 inrush_current:1; /* Serialize Dx->D0 */ 214 u32 power_removed:1; /* Optimize Dx->D0 */ 215 u32 reserved:28; 216 }; 217 218 struct acpi_device_power_state { 219 struct { 220 u8 valid:1; 221 u8 explicit_set:1; /* _PSx present? */ 222 u8 reserved:6; 223 } flags; 224 int power; /* % Power (compared to D0) */ 225 int latency; /* Dx->D0 time (microseconds) */ 226 struct acpi_handle_list resources; /* Power resources referenced */ 227 }; 228 229 struct acpi_device_power { 230 int state; /* Current state */ 231 struct acpi_device_power_flags flags; 232 struct acpi_device_power_state states[4]; /* Power states (D0-D3) */ 233 }; 234 235 /* Performance Management */ 236 237 struct acpi_device_perf_flags { 238 u8 reserved:8; 239 }; 240 241 struct acpi_device_perf_state { 242 struct { 243 u8 valid:1; 244 u8 reserved:7; 245 } flags; 246 u8 power; /* % Power (compared to P0) */ 247 u8 performance; /* % Performance ( " ) */ 248 int latency; /* Px->P0 time (microseconds) */ 249 }; 250 251 struct acpi_device_perf { 252 int state; 253 struct acpi_device_perf_flags flags; 254 int state_count; 255 struct acpi_device_perf_state *states; 256 }; 257 258 /* Wakeup Management */ 259 struct acpi_device_wakeup_flags { 260 u8 valid:1; /* Can successfully enable wakeup? */ 261 u8 run_wake:1; /* Run-Wake GPE devices */ 262 }; 263 264 struct acpi_device_wakeup_state { 265 u8 enabled:1; 266 u8 active:1; 267 }; 268 269 struct acpi_device_wakeup { 270 acpi_handle gpe_device; 271 acpi_integer gpe_number; 272 acpi_integer sleep_state; 273 struct acpi_handle_list resources; 274 struct acpi_device_wakeup_state state; 275 struct acpi_device_wakeup_flags flags; 276 }; 277 278 /* Device */ 279 280 struct acpi_device { 281 acpi_handle handle; 282 struct acpi_device *parent; 283 struct list_head children; 284 struct list_head node; 285 struct list_head wakeup_list; 286 struct list_head g_list; 287 struct acpi_device_status status; 288 struct acpi_device_flags flags; 289 struct acpi_device_pnp pnp; 290 struct acpi_device_power power; 291 struct acpi_device_wakeup wakeup; 292 struct acpi_device_perf performance; 293 struct acpi_device_dir dir; 294 struct acpi_device_ops ops; 295 struct acpi_driver *driver; 296 void *driver_data; 297 struct device dev; 298 struct acpi_bus_ops bus_ops; /* workaround for different code path for hotplug */ 299 enum acpi_bus_removal_type removal_type; /* indicate for different removal type */ 300 }; 301 302 #define acpi_driver_data(d) ((d)->driver_data) 303 #define to_acpi_device(d) container_of(d, struct acpi_device, dev) 304 #define to_acpi_driver(d) container_of(d, struct acpi_driver, drv) 305 306 /* 307 * Events 308 * ------ 309 */ 310 311 struct acpi_bus_event { 312 struct list_head node; 313 acpi_device_class device_class; 314 acpi_bus_id bus_id; 315 u32 type; 316 u32 data; 317 }; 318 319 extern struct subsystem acpi_subsys; 320 321 /* 322 * External Functions 323 */ 324 325 int acpi_bus_get_device(acpi_handle handle, struct acpi_device **device); 326 void acpi_bus_data_handler(acpi_handle handle, u32 function, void *context); 327 int acpi_bus_get_status(struct acpi_device *device); 328 int acpi_bus_get_power(acpi_handle handle, int *state); 329 int acpi_bus_set_power(acpi_handle handle, int state); 330 int acpi_bus_generate_event(struct acpi_device *device, u8 type, int data); 331 int acpi_bus_receive_event(struct acpi_bus_event *event); 332 int acpi_bus_register_driver(struct acpi_driver *driver); 333 void acpi_bus_unregister_driver(struct acpi_driver *driver); 334 int acpi_bus_add(struct acpi_device **child, struct acpi_device *parent, 335 acpi_handle handle, int type); 336 int acpi_bus_trim(struct acpi_device *start, int rmdevice); 337 int acpi_bus_start(struct acpi_device *device); 338 acpi_status acpi_bus_get_ejd(acpi_handle handle, acpi_handle *ejd); 339 int acpi_match_ids(struct acpi_device *device, char *ids); 340 int acpi_create_dir(struct acpi_device *); 341 void acpi_remove_dir(struct acpi_device *); 342 343 /* 344 * Bind physical devices with ACPI devices 345 */ 346 #include <linux/device.h> 347 struct acpi_bus_type { 348 struct list_head list; 349 struct bus_type *bus; 350 /* For general devices under the bus */ 351 int (*find_device) (struct device *, acpi_handle *); 352 /* For bridges, such as PCI root bridge, IDE controller */ 353 int (*find_bridge) (struct device *, acpi_handle *); 354 }; 355 int register_acpi_bus_type(struct acpi_bus_type *); 356 int unregister_acpi_bus_type(struct acpi_bus_type *); 357 struct device *acpi_get_physical_device(acpi_handle); 358 /* helper */ 359 acpi_handle acpi_get_child(acpi_handle, acpi_integer); 360 acpi_handle acpi_get_pci_rootbridge_handle(unsigned int, unsigned int); 361 #define DEVICE_ACPI_HANDLE(dev) ((acpi_handle)((dev)->archdata.acpi_handle)) 362 363 #endif /* CONFIG_ACPI */ 364 365 #endif /*__ACPI_BUS_H__*/ 366