x86/speculation/mds: Fix documentation typo
[linux/fpc-iii.git] / include / acpi / acpi_bus.h
blob324a04df3785b96b409b3a21d886ca6d61c43773
1 /*
2 * acpi_bus.h - ACPI Bus Driver ($Revision: 22 $)
4 * Copyright (C) 2001, 2002 Andy Grover <andrew.grover@intel.com>
5 * Copyright (C) 2001, 2002 Paul Diefenbaugh <paul.s.diefenbaugh@intel.com>
7 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
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.
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.
19 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
22 #ifndef __ACPI_BUS_H__
23 #define __ACPI_BUS_H__
25 #include <linux/device.h>
26 #include <linux/property.h>
28 /* TBD: Make dynamic */
29 #define ACPI_MAX_HANDLES 10
30 struct acpi_handle_list {
31 u32 count;
32 acpi_handle handles[ACPI_MAX_HANDLES];
35 /* acpi_utils.h */
36 acpi_status
37 acpi_extract_package(union acpi_object *package,
38 struct acpi_buffer *format, struct acpi_buffer *buffer);
39 acpi_status
40 acpi_evaluate_integer(acpi_handle handle,
41 acpi_string pathname,
42 struct acpi_object_list *arguments, unsigned long long *data);
43 acpi_status
44 acpi_evaluate_reference(acpi_handle handle,
45 acpi_string pathname,
46 struct acpi_object_list *arguments,
47 struct acpi_handle_list *list);
48 acpi_status
49 acpi_evaluate_ost(acpi_handle handle, u32 source_event, u32 status_code,
50 struct acpi_buffer *status_buf);
52 acpi_status
53 acpi_get_physical_device_location(acpi_handle handle, struct acpi_pld_info **pld);
55 bool acpi_has_method(acpi_handle handle, char *name);
56 acpi_status acpi_execute_simple_method(acpi_handle handle, char *method,
57 u64 arg);
58 acpi_status acpi_evaluate_ej0(acpi_handle handle);
59 acpi_status acpi_evaluate_lck(acpi_handle handle, int lock);
60 bool acpi_ata_match(acpi_handle handle);
61 bool acpi_bay_match(acpi_handle handle);
62 bool acpi_dock_match(acpi_handle handle);
64 bool acpi_check_dsm(acpi_handle handle, const guid_t *guid, u64 rev, u64 funcs);
65 union acpi_object *acpi_evaluate_dsm(acpi_handle handle, const guid_t *guid,
66 u64 rev, u64 func, union acpi_object *argv4);
68 static inline union acpi_object *
69 acpi_evaluate_dsm_typed(acpi_handle handle, const guid_t *guid, u64 rev,
70 u64 func, union acpi_object *argv4,
71 acpi_object_type type)
73 union acpi_object *obj;
75 obj = acpi_evaluate_dsm(handle, guid, rev, func, argv4);
76 if (obj && obj->type != type) {
77 ACPI_FREE(obj);
78 obj = NULL;
81 return obj;
84 #define ACPI_INIT_DSM_ARGV4(cnt, eles) \
85 { \
86 .package.type = ACPI_TYPE_PACKAGE, \
87 .package.count = (cnt), \
88 .package.elements = (eles) \
91 bool acpi_dev_found(const char *hid);
92 bool acpi_dev_present(const char *hid, const char *uid, s64 hrv);
94 #ifdef CONFIG_ACPI
96 #include <linux/proc_fs.h>
98 #define ACPI_BUS_FILE_ROOT "acpi"
99 extern struct proc_dir_entry *acpi_root_dir;
101 enum acpi_bus_device_type {
102 ACPI_BUS_TYPE_DEVICE = 0,
103 ACPI_BUS_TYPE_POWER,
104 ACPI_BUS_TYPE_PROCESSOR,
105 ACPI_BUS_TYPE_THERMAL,
106 ACPI_BUS_TYPE_POWER_BUTTON,
107 ACPI_BUS_TYPE_SLEEP_BUTTON,
108 ACPI_BUS_TYPE_ECDT_EC,
109 ACPI_BUS_DEVICE_TYPE_COUNT
112 struct acpi_driver;
113 struct acpi_device;
116 * ACPI Scan Handler
117 * -----------------
120 struct acpi_hotplug_profile {
121 struct kobject kobj;
122 int (*scan_dependent)(struct acpi_device *adev);
123 void (*notify_online)(struct acpi_device *adev);
124 bool enabled:1;
125 bool demand_offline:1;
128 static inline struct acpi_hotplug_profile *to_acpi_hotplug_profile(
129 struct kobject *kobj)
131 return container_of(kobj, struct acpi_hotplug_profile, kobj);
134 struct acpi_scan_handler {
135 const struct acpi_device_id *ids;
136 struct list_head list_node;
137 bool (*match)(const char *idstr, const struct acpi_device_id **matchid);
138 int (*attach)(struct acpi_device *dev, const struct acpi_device_id *id);
139 void (*detach)(struct acpi_device *dev);
140 void (*bind)(struct device *phys_dev);
141 void (*unbind)(struct device *phys_dev);
142 struct acpi_hotplug_profile hotplug;
146 * ACPI Hotplug Context
147 * --------------------
150 struct acpi_hotplug_context {
151 struct acpi_device *self;
152 int (*notify)(struct acpi_device *, u32);
153 void (*uevent)(struct acpi_device *, u32);
154 void (*fixup)(struct acpi_device *);
158 * ACPI Driver
159 * -----------
162 typedef int (*acpi_op_add) (struct acpi_device * device);
163 typedef int (*acpi_op_remove) (struct acpi_device * device);
164 typedef void (*acpi_op_notify) (struct acpi_device * device, u32 event);
166 struct acpi_device_ops {
167 acpi_op_add add;
168 acpi_op_remove remove;
169 acpi_op_notify notify;
172 #define ACPI_DRIVER_ALL_NOTIFY_EVENTS 0x1 /* system AND device events */
174 struct acpi_driver {
175 char name[80];
176 char class[80];
177 const struct acpi_device_id *ids; /* Supported Hardware IDs */
178 unsigned int flags;
179 struct acpi_device_ops ops;
180 struct device_driver drv;
181 struct module *owner;
185 * ACPI Device
186 * -----------
189 /* Status (_STA) */
191 struct acpi_device_status {
192 u32 present:1;
193 u32 enabled:1;
194 u32 show_in_ui:1;
195 u32 functional:1;
196 u32 battery_present:1;
197 u32 reserved:27;
200 /* Flags */
202 struct acpi_device_flags {
203 u32 dynamic_status:1;
204 u32 removable:1;
205 u32 ejectable:1;
206 u32 power_manageable:1;
207 u32 match_driver:1;
208 u32 initialized:1;
209 u32 visited:1;
210 u32 hotplug_notify:1;
211 u32 is_dock_station:1;
212 u32 of_compatible_ok:1;
213 u32 coherent_dma:1;
214 u32 cca_seen:1;
215 u32 spi_i2c_slave:1;
216 u32 reserved:19;
219 /* File System */
221 struct acpi_device_dir {
222 struct proc_dir_entry *entry;
225 #define acpi_device_dir(d) ((d)->dir.entry)
227 /* Plug and Play */
229 typedef char acpi_bus_id[8];
230 typedef unsigned long acpi_bus_address;
231 typedef char acpi_device_name[40];
232 typedef char acpi_device_class[20];
234 struct acpi_hardware_id {
235 struct list_head list;
236 const char *id;
239 struct acpi_pnp_type {
240 u32 hardware_id:1;
241 u32 bus_address:1;
242 u32 platform_id:1;
243 u32 reserved:29;
246 struct acpi_device_pnp {
247 acpi_bus_id bus_id; /* Object name */
248 struct acpi_pnp_type type; /* ID type */
249 acpi_bus_address bus_address; /* _ADR */
250 char *unique_id; /* _UID */
251 struct list_head ids; /* _HID and _CIDs */
252 acpi_device_name device_name; /* Driver-determined */
253 acpi_device_class device_class; /* " */
254 union acpi_object *str_obj; /* unicode string for _STR method */
257 #define acpi_device_bid(d) ((d)->pnp.bus_id)
258 #define acpi_device_adr(d) ((d)->pnp.bus_address)
259 const char *acpi_device_hid(struct acpi_device *device);
260 #define acpi_device_uid(d) ((d)->pnp.unique_id)
261 #define acpi_device_name(d) ((d)->pnp.device_name)
262 #define acpi_device_class(d) ((d)->pnp.device_class)
264 /* Power Management */
266 struct acpi_device_power_flags {
267 u32 explicit_get:1; /* _PSC present? */
268 u32 power_resources:1; /* Power resources */
269 u32 inrush_current:1; /* Serialize Dx->D0 */
270 u32 power_removed:1; /* Optimize Dx->D0 */
271 u32 ignore_parent:1; /* Power is independent of parent power state */
272 u32 dsw_present:1; /* _DSW present? */
273 u32 reserved:26;
276 struct acpi_device_power_state {
277 struct {
278 u8 valid:1;
279 u8 explicit_set:1; /* _PSx present? */
280 u8 reserved:6;
281 } flags;
282 int power; /* % Power (compared to D0) */
283 int latency; /* Dx->D0 time (microseconds) */
284 struct list_head resources; /* Power resources referenced */
287 struct acpi_device_power {
288 int state; /* Current state */
289 struct acpi_device_power_flags flags;
290 struct acpi_device_power_state states[ACPI_D_STATE_COUNT]; /* Power states (D0-D3Cold) */
293 /* Performance Management */
295 struct acpi_device_perf_flags {
296 u8 reserved:8;
299 struct acpi_device_perf_state {
300 struct {
301 u8 valid:1;
302 u8 reserved:7;
303 } flags;
304 u8 power; /* % Power (compared to P0) */
305 u8 performance; /* % Performance ( " ) */
306 int latency; /* Px->P0 time (microseconds) */
309 struct acpi_device_perf {
310 int state;
311 struct acpi_device_perf_flags flags;
312 int state_count;
313 struct acpi_device_perf_state *states;
316 /* Wakeup Management */
317 struct acpi_device_wakeup_flags {
318 u8 valid:1; /* Can successfully enable wakeup? */
319 u8 notifier_present:1; /* Wake-up notify handler has been installed */
322 struct acpi_device_wakeup_context {
323 void (*func)(struct acpi_device_wakeup_context *context);
324 struct device *dev;
327 struct acpi_device_wakeup {
328 acpi_handle gpe_device;
329 u64 gpe_number;
330 u64 sleep_state;
331 struct list_head resources;
332 struct acpi_device_wakeup_flags flags;
333 struct acpi_device_wakeup_context context;
334 struct wakeup_source *ws;
335 int prepare_count;
336 int enable_count;
339 struct acpi_device_physical_node {
340 unsigned int node_id;
341 struct list_head node;
342 struct device *dev;
343 bool put_online:1;
346 /* ACPI Device Specific Data (_DSD) */
347 struct acpi_device_data {
348 const union acpi_object *pointer;
349 const union acpi_object *properties;
350 const union acpi_object *of_compatible;
351 struct list_head subnodes;
354 struct acpi_gpio_mapping;
356 /* Device */
357 struct acpi_device {
358 int device_type;
359 acpi_handle handle; /* no handle for fixed hardware */
360 struct fwnode_handle fwnode;
361 struct acpi_device *parent;
362 struct list_head children;
363 struct list_head node;
364 struct list_head wakeup_list;
365 struct list_head del_list;
366 struct acpi_device_status status;
367 struct acpi_device_flags flags;
368 struct acpi_device_pnp pnp;
369 struct acpi_device_power power;
370 struct acpi_device_wakeup wakeup;
371 struct acpi_device_perf performance;
372 struct acpi_device_dir dir;
373 struct acpi_device_data data;
374 struct acpi_scan_handler *handler;
375 struct acpi_hotplug_context *hp;
376 struct acpi_driver *driver;
377 const struct acpi_gpio_mapping *driver_gpios;
378 void *driver_data;
379 struct device dev;
380 unsigned int physical_node_count;
381 unsigned int dep_unmet;
382 struct list_head physical_node_list;
383 struct mutex physical_node_lock;
384 void (*remove)(struct acpi_device *);
387 /* Non-device subnode */
388 struct acpi_data_node {
389 const char *name;
390 acpi_handle handle;
391 struct fwnode_handle fwnode;
392 struct fwnode_handle *parent;
393 struct acpi_device_data data;
394 struct list_head sibling;
395 struct kobject kobj;
396 struct completion kobj_done;
399 extern const struct fwnode_operations acpi_device_fwnode_ops;
400 extern const struct fwnode_operations acpi_data_fwnode_ops;
401 extern const struct fwnode_operations acpi_static_fwnode_ops;
403 bool is_acpi_device_node(const struct fwnode_handle *fwnode);
404 bool is_acpi_data_node(const struct fwnode_handle *fwnode);
406 static inline bool is_acpi_node(const struct fwnode_handle *fwnode)
408 return (is_acpi_device_node(fwnode) || is_acpi_data_node(fwnode));
411 #define to_acpi_device_node(__fwnode) \
412 ({ \
413 typeof(__fwnode) __to_acpi_device_node_fwnode = __fwnode; \
415 is_acpi_device_node(__to_acpi_device_node_fwnode) ? \
416 container_of(__to_acpi_device_node_fwnode, \
417 struct acpi_device, fwnode) : \
418 NULL; \
421 #define to_acpi_data_node(__fwnode) \
422 ({ \
423 typeof(__fwnode) __to_acpi_data_node_fwnode = __fwnode; \
425 is_acpi_data_node(__to_acpi_data_node_fwnode) ? \
426 container_of(__to_acpi_data_node_fwnode, \
427 struct acpi_data_node, fwnode) : \
428 NULL; \
431 static inline bool is_acpi_static_node(const struct fwnode_handle *fwnode)
433 return !IS_ERR_OR_NULL(fwnode) &&
434 fwnode->ops == &acpi_static_fwnode_ops;
437 static inline bool acpi_data_node_match(const struct fwnode_handle *fwnode,
438 const char *name)
440 return is_acpi_data_node(fwnode) ?
441 (!strcmp(to_acpi_data_node(fwnode)->name, name)) : false;
444 static inline struct fwnode_handle *acpi_fwnode_handle(struct acpi_device *adev)
446 return &adev->fwnode;
449 static inline void *acpi_driver_data(struct acpi_device *d)
451 return d->driver_data;
454 #define to_acpi_device(d) container_of(d, struct acpi_device, dev)
455 #define to_acpi_driver(d) container_of(d, struct acpi_driver, drv)
457 static inline void acpi_set_device_status(struct acpi_device *adev, u32 sta)
459 *((u32 *)&adev->status) = sta;
462 static inline void acpi_set_hp_context(struct acpi_device *adev,
463 struct acpi_hotplug_context *hp)
465 hp->self = adev;
466 adev->hp = hp;
469 void acpi_initialize_hp_context(struct acpi_device *adev,
470 struct acpi_hotplug_context *hp,
471 int (*notify)(struct acpi_device *, u32),
472 void (*uevent)(struct acpi_device *, u32));
474 /* acpi_device.dev.bus == &acpi_bus_type */
475 extern struct bus_type acpi_bus_type;
478 * Events
479 * ------
482 struct acpi_bus_event {
483 struct list_head node;
484 acpi_device_class device_class;
485 acpi_bus_id bus_id;
486 u32 type;
487 u32 data;
490 extern struct kobject *acpi_kobj;
491 extern int acpi_bus_generate_netlink_event(const char*, const char*, u8, int);
492 void acpi_bus_private_data_handler(acpi_handle, void *);
493 int acpi_bus_get_private_data(acpi_handle, void **);
494 int acpi_bus_attach_private_data(acpi_handle, void *);
495 void acpi_bus_detach_private_data(acpi_handle);
496 extern int acpi_notifier_call_chain(struct acpi_device *, u32, u32);
497 extern int register_acpi_notifier(struct notifier_block *);
498 extern int unregister_acpi_notifier(struct notifier_block *);
501 * External Functions
504 int acpi_bus_get_device(acpi_handle handle, struct acpi_device **device);
505 struct acpi_device *acpi_bus_get_acpi_device(acpi_handle handle);
506 void acpi_bus_put_acpi_device(struct acpi_device *adev);
507 acpi_status acpi_bus_get_status_handle(acpi_handle handle,
508 unsigned long long *sta);
509 int acpi_bus_get_status(struct acpi_device *device);
511 int acpi_bus_set_power(acpi_handle handle, int state);
512 const char *acpi_power_state_string(int state);
513 int acpi_device_get_power(struct acpi_device *device, int *state);
514 int acpi_device_set_power(struct acpi_device *device, int state);
515 int acpi_bus_init_power(struct acpi_device *device);
516 int acpi_device_fix_up_power(struct acpi_device *device);
517 int acpi_bus_update_power(acpi_handle handle, int *state_p);
518 int acpi_device_update_power(struct acpi_device *device, int *state_p);
519 bool acpi_bus_power_manageable(acpi_handle handle);
521 #ifdef CONFIG_PM
522 bool acpi_bus_can_wakeup(acpi_handle handle);
523 #else
524 static inline bool acpi_bus_can_wakeup(acpi_handle handle) { return false; }
525 #endif
527 void acpi_scan_lock_acquire(void);
528 void acpi_scan_lock_release(void);
529 void acpi_lock_hp_context(void);
530 void acpi_unlock_hp_context(void);
531 int acpi_scan_add_handler(struct acpi_scan_handler *handler);
532 int acpi_bus_register_driver(struct acpi_driver *driver);
533 void acpi_bus_unregister_driver(struct acpi_driver *driver);
534 int acpi_bus_scan(acpi_handle handle);
535 void acpi_bus_trim(struct acpi_device *start);
536 acpi_status acpi_bus_get_ejd(acpi_handle handle, acpi_handle * ejd);
537 int acpi_match_device_ids(struct acpi_device *device,
538 const struct acpi_device_id *ids);
539 void acpi_set_modalias(struct acpi_device *adev, const char *default_id,
540 char *modalias, size_t len);
541 int acpi_create_dir(struct acpi_device *);
542 void acpi_remove_dir(struct acpi_device *);
544 static inline bool acpi_device_enumerated(struct acpi_device *adev)
546 return adev && adev->flags.initialized && adev->flags.visited;
550 * module_acpi_driver(acpi_driver) - Helper macro for registering an ACPI driver
551 * @__acpi_driver: acpi_driver struct
553 * Helper macro for ACPI drivers which do not do anything special in module
554 * init/exit. This eliminates a lot of boilerplate. Each module may only
555 * use this macro once, and calling it replaces module_init() and module_exit()
557 #define module_acpi_driver(__acpi_driver) \
558 module_driver(__acpi_driver, acpi_bus_register_driver, \
559 acpi_bus_unregister_driver)
562 * Bind physical devices with ACPI devices
564 struct acpi_bus_type {
565 struct list_head list;
566 const char *name;
567 bool (*match)(struct device *dev);
568 struct acpi_device * (*find_companion)(struct device *);
569 void (*setup)(struct device *);
570 void (*cleanup)(struct device *);
572 int register_acpi_bus_type(struct acpi_bus_type *);
573 int unregister_acpi_bus_type(struct acpi_bus_type *);
574 int acpi_bind_one(struct device *dev, struct acpi_device *adev);
575 int acpi_unbind_one(struct device *dev);
577 struct acpi_pci_root {
578 struct acpi_device * device;
579 struct pci_bus *bus;
580 u16 segment;
581 struct resource secondary; /* downstream bus range */
583 u32 osc_support_set; /* _OSC state of support bits */
584 u32 osc_control_set; /* _OSC state of control bits */
585 phys_addr_t mcfg_addr;
588 /* helper */
590 bool acpi_dma_supported(struct acpi_device *adev);
591 enum dev_dma_attr acpi_get_dma_attr(struct acpi_device *adev);
592 int acpi_dma_get_range(struct device *dev, u64 *dma_addr, u64 *offset,
593 u64 *size);
594 int acpi_dma_configure(struct device *dev, enum dev_dma_attr attr);
595 void acpi_dma_deconfigure(struct device *dev);
597 struct acpi_device *acpi_find_child_device(struct acpi_device *parent,
598 u64 address, bool check_children);
599 int acpi_is_root_bridge(acpi_handle);
600 struct acpi_pci_root *acpi_pci_find_root(acpi_handle handle);
602 int acpi_enable_wakeup_device_power(struct acpi_device *dev, int state);
603 int acpi_disable_wakeup_device_power(struct acpi_device *dev);
605 #ifdef CONFIG_X86
606 bool acpi_device_always_present(struct acpi_device *adev);
607 #else
608 static inline bool acpi_device_always_present(struct acpi_device *adev)
610 return false;
612 #endif
614 #ifdef CONFIG_PM
615 void acpi_pm_wakeup_event(struct device *dev);
616 acpi_status acpi_add_pm_notifier(struct acpi_device *adev, struct device *dev,
617 void (*func)(struct acpi_device_wakeup_context *context));
618 acpi_status acpi_remove_pm_notifier(struct acpi_device *adev);
619 bool acpi_pm_device_can_wakeup(struct device *dev);
620 int acpi_pm_device_sleep_state(struct device *, int *, int);
621 int acpi_pm_set_device_wakeup(struct device *dev, bool enable);
622 int acpi_pm_set_bridge_wakeup(struct device *dev, bool enable);
623 #else
624 static inline void acpi_pm_wakeup_event(struct device *dev)
627 static inline acpi_status acpi_add_pm_notifier(struct acpi_device *adev,
628 struct device *dev,
629 void (*func)(struct acpi_device_wakeup_context *context))
631 return AE_SUPPORT;
633 static inline acpi_status acpi_remove_pm_notifier(struct acpi_device *adev)
635 return AE_SUPPORT;
637 static inline bool acpi_pm_device_can_wakeup(struct device *dev)
639 return false;
641 static inline int acpi_pm_device_sleep_state(struct device *d, int *p, int m)
643 if (p)
644 *p = ACPI_STATE_D0;
646 return (m >= ACPI_STATE_D0 && m <= ACPI_STATE_D3_COLD) ?
647 m : ACPI_STATE_D0;
649 static inline int acpi_pm_set_device_wakeup(struct device *dev, bool enable)
651 return -ENODEV;
653 static inline int acpi_pm_set_bridge_wakeup(struct device *dev, bool enable)
655 return -ENODEV;
657 #endif
659 #ifdef CONFIG_ACPI_SLEEP
660 u32 acpi_target_system_state(void);
661 #else
662 static inline u32 acpi_target_system_state(void) { return ACPI_STATE_S0; }
663 #endif
665 static inline bool acpi_device_power_manageable(struct acpi_device *adev)
667 return adev->flags.power_manageable;
670 static inline bool acpi_device_can_wakeup(struct acpi_device *adev)
672 return adev->wakeup.flags.valid;
675 static inline bool acpi_device_can_poweroff(struct acpi_device *adev)
677 return adev->power.states[ACPI_STATE_D3_COLD].flags.valid ||
678 ((acpi_gbl_FADT.header.revision < 6) &&
679 adev->power.states[ACPI_STATE_D3_HOT].flags.explicit_set);
682 #else /* CONFIG_ACPI */
684 static inline int register_acpi_bus_type(void *bus) { return 0; }
685 static inline int unregister_acpi_bus_type(void *bus) { return 0; }
687 #endif /* CONFIG_ACPI */
689 #endif /*__ACPI_BUS_H__*/