11da177e4SLinus Torvalds /* 21da177e4SLinus Torvalds * acpi_bus.h - ACPI Bus Driver ($Revision: 22 $) 31da177e4SLinus Torvalds * 41da177e4SLinus Torvalds * Copyright (C) 2001, 2002 Andy Grover <andrew.grover@intel.com> 51da177e4SLinus Torvalds * Copyright (C) 2001, 2002 Paul Diefenbaugh <paul.s.diefenbaugh@intel.com> 61da177e4SLinus Torvalds * 71da177e4SLinus Torvalds * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 81da177e4SLinus Torvalds * 91da177e4SLinus Torvalds * This program is free software; you can redistribute it and/or modify 101da177e4SLinus Torvalds * it under the terms of the GNU General Public License as published by 111da177e4SLinus Torvalds * the Free Software Foundation; either version 2 of the License, or (at 121da177e4SLinus Torvalds * your option) any later version. 131da177e4SLinus Torvalds * 141da177e4SLinus Torvalds * This program is distributed in the hope that it will be useful, but 151da177e4SLinus Torvalds * WITHOUT ANY WARRANTY; without even the implied warranty of 161da177e4SLinus Torvalds * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 171da177e4SLinus Torvalds * General Public License for more details. 181da177e4SLinus Torvalds * 191da177e4SLinus Torvalds * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 201da177e4SLinus Torvalds */ 211da177e4SLinus Torvalds 221da177e4SLinus Torvalds #ifndef __ACPI_BUS_H__ 231da177e4SLinus Torvalds #define __ACPI_BUS_H__ 241da177e4SLinus Torvalds 255b327265SPatrick Mochel #include <linux/device.h> 268a0662d9SRafael J. Wysocki #include <linux/property.h> 271da177e4SLinus Torvalds 281da177e4SLinus Torvalds /* TBD: Make dynamic */ 291da177e4SLinus Torvalds #define ACPI_MAX_HANDLES 10 301da177e4SLinus Torvalds struct acpi_handle_list { 311da177e4SLinus Torvalds u32 count; 321da177e4SLinus Torvalds acpi_handle handles[ACPI_MAX_HANDLES]; 331da177e4SLinus Torvalds }; 341da177e4SLinus Torvalds 351da177e4SLinus Torvalds /* acpi_utils.h */ 361da177e4SLinus Torvalds acpi_status 374be44fcdSLen Brown acpi_extract_package(union acpi_object *package, 384be44fcdSLen Brown struct acpi_buffer *format, struct acpi_buffer *buffer); 391da177e4SLinus Torvalds acpi_status 404be44fcdSLen Brown acpi_evaluate_integer(acpi_handle handle, 411da177e4SLinus Torvalds acpi_string pathname, 4227663c58SMatthew Wilcox struct acpi_object_list *arguments, unsigned long long *data); 431da177e4SLinus Torvalds acpi_status 444be44fcdSLen Brown acpi_evaluate_reference(acpi_handle handle, 451da177e4SLinus Torvalds acpi_string pathname, 461da177e4SLinus Torvalds struct acpi_object_list *arguments, 471da177e4SLinus Torvalds struct acpi_handle_list *list); 48275c58d7SToshi Kani acpi_status 4905730c19SJiang Liu acpi_evaluate_ost(acpi_handle handle, u32 source_event, u32 status_code, 5005730c19SJiang Liu struct acpi_buffer *status_buf); 511da177e4SLinus Torvalds 5238ac0f1bSMatthew Garrett acpi_status 538ede06abSFeng Tang acpi_get_physical_device_location(acpi_handle handle, struct acpi_pld_info **pld); 54952c63e9SJiang Liu 55952c63e9SJiang Liu bool acpi_has_method(acpi_handle handle, char *name); 560db98202SJiang Liu acpi_status acpi_execute_simple_method(acpi_handle handle, char *method, 570db98202SJiang Liu u64 arg); 587d2421f8SJiang Liu acpi_status acpi_evaluate_ej0(acpi_handle handle); 597d2421f8SJiang Liu acpi_status acpi_evaluate_lck(acpi_handle handle, int lock); 60ebf4df8dSJiang Liu bool acpi_ata_match(acpi_handle handle); 61ebf4df8dSJiang Liu bool acpi_bay_match(acpi_handle handle); 62ebf4df8dSJiang Liu bool acpi_dock_match(acpi_handle handle); 63952c63e9SJiang Liu 6494116f81SAndy Shevchenko bool acpi_check_dsm(acpi_handle handle, const guid_t *guid, u64 rev, u64 funcs); 6594116f81SAndy Shevchenko union acpi_object *acpi_evaluate_dsm(acpi_handle handle, const guid_t *guid, 66c7e16e52SJerry Hoemann u64 rev, u64 func, union acpi_object *argv4); 67a65ac520SJiang Liu 68a65ac520SJiang Liu static inline union acpi_object * 6994116f81SAndy Shevchenko acpi_evaluate_dsm_typed(acpi_handle handle, const guid_t *guid, u64 rev, 7094116f81SAndy Shevchenko u64 func, union acpi_object *argv4, 7194116f81SAndy Shevchenko acpi_object_type type) 72a65ac520SJiang Liu { 73a65ac520SJiang Liu union acpi_object *obj; 74a65ac520SJiang Liu 7594116f81SAndy Shevchenko obj = acpi_evaluate_dsm(handle, guid, rev, func, argv4); 76a65ac520SJiang Liu if (obj && obj->type != type) { 77a65ac520SJiang Liu ACPI_FREE(obj); 78a65ac520SJiang Liu obj = NULL; 79a65ac520SJiang Liu } 80a65ac520SJiang Liu 81a65ac520SJiang Liu return obj; 82a65ac520SJiang Liu } 83a65ac520SJiang Liu 84a65ac520SJiang Liu #define ACPI_INIT_DSM_ARGV4(cnt, eles) \ 85a65ac520SJiang Liu { \ 86a65ac520SJiang Liu .package.type = ACPI_TYPE_PACKAGE, \ 87a65ac520SJiang Liu .package.count = (cnt), \ 88a65ac520SJiang Liu .package.elements = (eles) \ 89a65ac520SJiang Liu } 90a65ac520SJiang Liu 91c68ae33eSLukas Wunner bool acpi_dev_found(const char *hid); 928661423eSHans de Goede bool acpi_dev_present(const char *hid, const char *uid, s64 hrv); 932d12b6b3SLukas Wunner 9476f58584SLen Brown #ifdef CONFIG_ACPI 951da177e4SLinus Torvalds 961da177e4SLinus Torvalds #include <linux/proc_fs.h> 971da177e4SLinus Torvalds 981da177e4SLinus Torvalds #define ACPI_BUS_FILE_ROOT "acpi" 991da177e4SLinus Torvalds extern struct proc_dir_entry *acpi_root_dir; 1001da177e4SLinus Torvalds 1011da177e4SLinus Torvalds enum acpi_bus_device_type { 1021da177e4SLinus Torvalds ACPI_BUS_TYPE_DEVICE = 0, 1031da177e4SLinus Torvalds ACPI_BUS_TYPE_POWER, 1041da177e4SLinus Torvalds ACPI_BUS_TYPE_PROCESSOR, 1051da177e4SLinus Torvalds ACPI_BUS_TYPE_THERMAL, 1061da177e4SLinus Torvalds ACPI_BUS_TYPE_POWER_BUTTON, 1071da177e4SLinus Torvalds ACPI_BUS_TYPE_SLEEP_BUTTON, 108a64a62ceSLv Zheng ACPI_BUS_TYPE_ECDT_EC, 1091da177e4SLinus Torvalds ACPI_BUS_DEVICE_TYPE_COUNT 1101da177e4SLinus Torvalds }; 1111da177e4SLinus Torvalds 1121da177e4SLinus Torvalds struct acpi_driver; 1131da177e4SLinus Torvalds struct acpi_device; 1141da177e4SLinus Torvalds 1151da177e4SLinus Torvalds /* 116ca589f94SRafael J. Wysocki * ACPI Scan Handler 117ca589f94SRafael J. Wysocki * ----------------- 118ca589f94SRafael J. Wysocki */ 119ca589f94SRafael J. Wysocki 120a33ec399SRafael J. Wysocki struct acpi_hotplug_profile { 1213f8055c3SRafael J. Wysocki struct kobject kobj; 1223338db00SRafael J. Wysocki int (*scan_dependent)(struct acpi_device *adev); 1238ab17fc9SRafael J. Wysocki void (*notify_online)(struct acpi_device *adev); 124d22ddcbcSRafael J. Wysocki bool enabled:1; 125d22ddcbcSRafael J. Wysocki bool demand_offline:1; 126a33ec399SRafael J. Wysocki }; 127a33ec399SRafael J. Wysocki 1283f8055c3SRafael J. Wysocki static inline struct acpi_hotplug_profile *to_acpi_hotplug_profile( 1293f8055c3SRafael J. Wysocki struct kobject *kobj) 1303f8055c3SRafael J. Wysocki { 1313f8055c3SRafael J. Wysocki return container_of(kobj, struct acpi_hotplug_profile, kobj); 1323f8055c3SRafael J. Wysocki } 1333f8055c3SRafael J. Wysocki 134ca589f94SRafael J. Wysocki struct acpi_scan_handler { 135ca589f94SRafael J. Wysocki const struct acpi_device_id *ids; 136ca589f94SRafael J. Wysocki struct list_head list_node; 137636c19d3SRasmus Villemoes bool (*match)(const char *idstr, const struct acpi_device_id **matchid); 138ca589f94SRafael J. Wysocki int (*attach)(struct acpi_device *dev, const struct acpi_device_id *id); 139ca589f94SRafael J. Wysocki void (*detach)(struct acpi_device *dev); 1409cb32acfSRafael J. Wysocki void (*bind)(struct device *phys_dev); 1419cb32acfSRafael J. Wysocki void (*unbind)(struct device *phys_dev); 142a33ec399SRafael J. Wysocki struct acpi_hotplug_profile hotplug; 143ca589f94SRafael J. Wysocki }; 144ca589f94SRafael J. Wysocki 145ca589f94SRafael J. Wysocki /* 1463c2cc7ffSRafael J. Wysocki * ACPI Hotplug Context 1473c2cc7ffSRafael J. Wysocki * -------------------- 1483c2cc7ffSRafael J. Wysocki */ 1493c2cc7ffSRafael J. Wysocki 1503c2cc7ffSRafael J. Wysocki struct acpi_hotplug_context { 1513c2cc7ffSRafael J. Wysocki struct acpi_device *self; 152be27b3dcSRafael J. Wysocki int (*notify)(struct acpi_device *, u32); 153be27b3dcSRafael J. Wysocki void (*uevent)(struct acpi_device *, u32); 15459b42fa0SRafael J. Wysocki void (*fixup)(struct acpi_device *); 1553c2cc7ffSRafael J. Wysocki }; 1563c2cc7ffSRafael J. Wysocki 1573c2cc7ffSRafael J. Wysocki /* 1581da177e4SLinus Torvalds * ACPI Driver 1591da177e4SLinus Torvalds * ----------- 1601da177e4SLinus Torvalds */ 1611da177e4SLinus Torvalds 1621da177e4SLinus Torvalds typedef int (*acpi_op_add) (struct acpi_device * device); 16351fac838SRafael J. Wysocki typedef int (*acpi_op_remove) (struct acpi_device * device); 16446ec8598SBjorn Helgaas typedef void (*acpi_op_notify) (struct acpi_device * device, u32 event); 1651da177e4SLinus Torvalds 1661da177e4SLinus Torvalds struct acpi_device_ops { 1671da177e4SLinus Torvalds acpi_op_add add; 1681da177e4SLinus Torvalds acpi_op_remove remove; 16946ec8598SBjorn Helgaas acpi_op_notify notify; 1701da177e4SLinus Torvalds }; 1711da177e4SLinus Torvalds 1726d278131SBjorn Helgaas #define ACPI_DRIVER_ALL_NOTIFY_EVENTS 0x1 /* system AND device events */ 1736d278131SBjorn Helgaas 1741da177e4SLinus Torvalds struct acpi_driver { 1751da177e4SLinus Torvalds char name[80]; 1761da177e4SLinus Torvalds char class[80]; 1778c8eb78fSThomas Renninger const struct acpi_device_id *ids; /* Supported Hardware IDs */ 1786d278131SBjorn Helgaas unsigned int flags; 1791da177e4SLinus Torvalds struct acpi_device_ops ops; 180d43ec68eSPatrick Mochel struct device_driver drv; 1811890a97aSPatrick Mochel struct module *owner; 1821da177e4SLinus Torvalds }; 1831da177e4SLinus Torvalds 1841da177e4SLinus Torvalds /* 1851da177e4SLinus Torvalds * ACPI Device 1861da177e4SLinus Torvalds * ----------- 1871da177e4SLinus Torvalds */ 1881da177e4SLinus Torvalds 1891da177e4SLinus Torvalds /* Status (_STA) */ 1901da177e4SLinus Torvalds 1911da177e4SLinus Torvalds struct acpi_device_status { 1921da177e4SLinus Torvalds u32 present:1; 1931da177e4SLinus Torvalds u32 enabled:1; 1941da177e4SLinus Torvalds u32 show_in_ui:1; 1951da177e4SLinus Torvalds u32 functional:1; 1961da177e4SLinus Torvalds u32 battery_present:1; 1971da177e4SLinus Torvalds u32 reserved:27; 1981da177e4SLinus Torvalds }; 1991da177e4SLinus Torvalds 2001da177e4SLinus Torvalds /* Flags */ 2011da177e4SLinus Torvalds 2021da177e4SLinus Torvalds struct acpi_device_flags { 2031da177e4SLinus Torvalds u32 dynamic_status:1; 2041da177e4SLinus Torvalds u32 removable:1; 2051da177e4SLinus Torvalds u32 ejectable:1; 2061da177e4SLinus Torvalds u32 power_manageable:1; 207209d3b17SRafael J. Wysocki u32 match_driver:1; 208202317a5SRafael J. Wysocki u32 initialized:1; 209202317a5SRafael J. Wysocki u32 visited:1; 2103c2cc7ffSRafael J. Wysocki u32 hotplug_notify:1; 2111e2380cdSRafael J. Wysocki u32 is_dock_station:1; 2125c53b262SRafael J. Wysocki u32 of_compatible_ok:1; 213d0562674SSuthikulpanit, Suravee u32 coherent_dma:1; 214d0562674SSuthikulpanit, Suravee u32 cca_seen:1; 215e4330d8bSJarkko Nikula u32 spi_i2c_slave:1; 216e4330d8bSJarkko Nikula u32 reserved:19; 2171da177e4SLinus Torvalds }; 2181da177e4SLinus Torvalds 2191da177e4SLinus Torvalds /* File System */ 2201da177e4SLinus Torvalds 2211da177e4SLinus Torvalds struct acpi_device_dir { 2221da177e4SLinus Torvalds struct proc_dir_entry *entry; 2231da177e4SLinus Torvalds }; 2241da177e4SLinus Torvalds 2251da177e4SLinus Torvalds #define acpi_device_dir(d) ((d)->dir.entry) 2261da177e4SLinus Torvalds 2271da177e4SLinus Torvalds /* Plug and Play */ 2281da177e4SLinus Torvalds 22924c5c4c2SZhao Yakui typedef char acpi_bus_id[8]; 2301da177e4SLinus Torvalds typedef unsigned long acpi_bus_address; 2311da177e4SLinus Torvalds typedef char acpi_device_name[40]; 2321da177e4SLinus Torvalds typedef char acpi_device_class[20]; 2331da177e4SLinus Torvalds 2347f47fa6cSBjorn Helgaas struct acpi_hardware_id { 2357f47fa6cSBjorn Helgaas struct list_head list; 236844142c3SRasmus Villemoes const char *id; 2377f47fa6cSBjorn Helgaas }; 2387f47fa6cSBjorn Helgaas 239d4e1a692SToshi Kani struct acpi_pnp_type { 240d4e1a692SToshi Kani u32 hardware_id:1; 241d4e1a692SToshi Kani u32 bus_address:1; 242549e6845SRafael J. Wysocki u32 platform_id:1; 243549e6845SRafael J. Wysocki u32 reserved:29; 244d4e1a692SToshi Kani }; 245d4e1a692SToshi Kani 2461da177e4SLinus Torvalds struct acpi_device_pnp { 2471da177e4SLinus Torvalds acpi_bus_id bus_id; /* Object name */ 248d4e1a692SToshi Kani struct acpi_pnp_type type; /* ID type */ 2491da177e4SLinus Torvalds acpi_bus_address bus_address; /* _ADR */ 25015b8dd53SBob Moore char *unique_id; /* _UID */ 2517f47fa6cSBjorn Helgaas struct list_head ids; /* _HID and _CIDs */ 2521da177e4SLinus Torvalds acpi_device_name device_name; /* Driver-determined */ 2531da177e4SLinus Torvalds acpi_device_class device_class; /* " */ 254d1efe3c3SLance Ortiz union acpi_object *str_obj; /* unicode string for _STR method */ 2551da177e4SLinus Torvalds }; 2561da177e4SLinus Torvalds 2571da177e4SLinus Torvalds #define acpi_device_bid(d) ((d)->pnp.bus_id) 2581da177e4SLinus Torvalds #define acpi_device_adr(d) ((d)->pnp.bus_address) 259620e112cSThomas Renninger const char *acpi_device_hid(struct acpi_device *device); 260359597cbSAdrian Hunter #define acpi_device_uid(d) ((d)->pnp.unique_id) 2611da177e4SLinus Torvalds #define acpi_device_name(d) ((d)->pnp.device_name) 2621da177e4SLinus Torvalds #define acpi_device_class(d) ((d)->pnp.device_class) 2631da177e4SLinus Torvalds 2641da177e4SLinus Torvalds /* Power Management */ 2651da177e4SLinus Torvalds 2661da177e4SLinus Torvalds struct acpi_device_power_flags { 2671da177e4SLinus Torvalds u32 explicit_get:1; /* _PSC present? */ 2681da177e4SLinus Torvalds u32 power_resources:1; /* Power resources */ 2691da177e4SLinus Torvalds u32 inrush_current:1; /* Serialize Dx->D0 */ 2701da177e4SLinus Torvalds u32 power_removed:1; /* Optimize Dx->D0 */ 271644f17adSMika Westerberg u32 ignore_parent:1; /* Power is independent of parent power state */ 272f25c0ae2SRafael J. Wysocki u32 dsw_present:1; /* _DSW present? */ 273f25c0ae2SRafael J. Wysocki u32 reserved:26; 2741da177e4SLinus Torvalds }; 2751da177e4SLinus Torvalds 2761da177e4SLinus Torvalds struct acpi_device_power_state { 2771da177e4SLinus Torvalds struct { 2781da177e4SLinus Torvalds u8 valid:1; 2791da177e4SLinus Torvalds u8 explicit_set:1; /* _PSx present? */ 2801da177e4SLinus Torvalds u8 reserved:6; 2811da177e4SLinus Torvalds } flags; 2821da177e4SLinus Torvalds int power; /* % Power (compared to D0) */ 2831da177e4SLinus Torvalds int latency; /* Dx->D0 time (microseconds) */ 2840b224527SRafael J. Wysocki struct list_head resources; /* Power resources referenced */ 2851da177e4SLinus Torvalds }; 2861da177e4SLinus Torvalds 2871da177e4SLinus Torvalds struct acpi_device_power { 2881da177e4SLinus Torvalds int state; /* Current state */ 2891da177e4SLinus Torvalds struct acpi_device_power_flags flags; 290b4a03b9aSLin Ming struct acpi_device_power_state states[ACPI_D_STATE_COUNT]; /* Power states (D0-D3Cold) */ 2911da177e4SLinus Torvalds }; 2921da177e4SLinus Torvalds 2931da177e4SLinus Torvalds /* Performance Management */ 2941da177e4SLinus Torvalds 2951da177e4SLinus Torvalds struct acpi_device_perf_flags { 2961da177e4SLinus Torvalds u8 reserved:8; 2971da177e4SLinus Torvalds }; 2981da177e4SLinus Torvalds 2991da177e4SLinus Torvalds struct acpi_device_perf_state { 3001da177e4SLinus Torvalds struct { 3011da177e4SLinus Torvalds u8 valid:1; 3021da177e4SLinus Torvalds u8 reserved:7; 3031da177e4SLinus Torvalds } flags; 3041da177e4SLinus Torvalds u8 power; /* % Power (compared to P0) */ 3051da177e4SLinus Torvalds u8 performance; /* % Performance ( " ) */ 3061da177e4SLinus Torvalds int latency; /* Px->P0 time (microseconds) */ 3071da177e4SLinus Torvalds }; 3081da177e4SLinus Torvalds 3091da177e4SLinus Torvalds struct acpi_device_perf { 3101da177e4SLinus Torvalds int state; 3111da177e4SLinus Torvalds struct acpi_device_perf_flags flags; 3121da177e4SLinus Torvalds int state_count; 3131da177e4SLinus Torvalds struct acpi_device_perf_state *states; 3141da177e4SLinus Torvalds }; 3151da177e4SLinus Torvalds 3161da177e4SLinus Torvalds /* Wakeup Management */ 3171da177e4SLinus Torvalds struct acpi_device_wakeup_flags { 3181da177e4SLinus Torvalds u8 valid:1; /* Can successfully enable wakeup? */ 319b67ea761SRafael J. Wysocki u8 notifier_present:1; /* Wake-up notify handler has been installed */ 3201da177e4SLinus Torvalds }; 3211da177e4SLinus Torvalds 322c072530fSRafael J. Wysocki struct acpi_device_wakeup_context { 32364fd1c70SRafael J. Wysocki void (*func)(struct acpi_device_wakeup_context *context); 324c072530fSRafael J. Wysocki struct device *dev; 325c072530fSRafael J. Wysocki }; 326c072530fSRafael J. Wysocki 3271da177e4SLinus Torvalds struct acpi_device_wakeup { 3281da177e4SLinus Torvalds acpi_handle gpe_device; 329439913ffSLin Ming u64 gpe_number; 330439913ffSLin Ming u64 sleep_state; 331993cbe59SRafael J. Wysocki struct list_head resources; 3321da177e4SLinus Torvalds struct acpi_device_wakeup_flags flags; 333c072530fSRafael J. Wysocki struct acpi_device_wakeup_context context; 334c072530fSRafael J. Wysocki struct wakeup_source *ws; 3359b83ccd2SRafael J. Wysocki int prepare_count; 33699d8845eSRafael J. Wysocki int enable_count; 3371da177e4SLinus Torvalds }; 3381da177e4SLinus Torvalds 3391033f904SLan Tianyu struct acpi_device_physical_node { 340007ccfcfSRafael J. Wysocki unsigned int node_id; 3411033f904SLan Tianyu struct list_head node; 3421033f904SLan Tianyu struct device *dev; 343683058e3SRafael J. Wysocki bool put_online:1; 3441033f904SLan Tianyu }; 3451da177e4SLinus Torvalds 346ffdcd955SMika Westerberg /* ACPI Device Specific Data (_DSD) */ 347ffdcd955SMika Westerberg struct acpi_device_data { 348ffdcd955SMika Westerberg const union acpi_object *pointer; 349ffdcd955SMika Westerberg const union acpi_object *properties; 350733e6251SMika Westerberg const union acpi_object *of_compatible; 351445b0eb0SRafael J. Wysocki struct list_head subnodes; 352ffdcd955SMika Westerberg }; 353ffdcd955SMika Westerberg 354f028d524SRafael J. Wysocki struct acpi_gpio_mapping; 355f028d524SRafael J. Wysocki 3561033f904SLan Tianyu /* Device */ 3571da177e4SLinus Torvalds struct acpi_device { 358caaa6efbSBjorn Helgaas int device_type; 359caaa6efbSBjorn Helgaas acpi_handle handle; /* no handle for fixed hardware */ 3608a0662d9SRafael J. Wysocki struct fwnode_handle fwnode; 3611da177e4SLinus Torvalds struct acpi_device *parent; 3621da177e4SLinus Torvalds struct list_head children; 3631da177e4SLinus Torvalds struct list_head node; 3641da177e4SLinus Torvalds struct list_head wakeup_list; 365d783156eSRafael J. Wysocki struct list_head del_list; 3661da177e4SLinus Torvalds struct acpi_device_status status; 3671da177e4SLinus Torvalds struct acpi_device_flags flags; 3681da177e4SLinus Torvalds struct acpi_device_pnp pnp; 3691da177e4SLinus Torvalds struct acpi_device_power power; 3701da177e4SLinus Torvalds struct acpi_device_wakeup wakeup; 3711da177e4SLinus Torvalds struct acpi_device_perf performance; 3721da177e4SLinus Torvalds struct acpi_device_dir dir; 373ffdcd955SMika Westerberg struct acpi_device_data data; 374ca589f94SRafael J. Wysocki struct acpi_scan_handler *handler; 3753c2cc7ffSRafael J. Wysocki struct acpi_hotplug_context *hp; 3761da177e4SLinus Torvalds struct acpi_driver *driver; 377f028d524SRafael J. Wysocki const struct acpi_gpio_mapping *driver_gpios; 3781da177e4SLinus Torvalds void *driver_data; 3795b327265SPatrick Mochel struct device dev; 380007ccfcfSRafael J. Wysocki unsigned int physical_node_count; 38140e7fcb1SLan Tianyu unsigned int dep_unmet; 3821033f904SLan Tianyu struct list_head physical_node_list; 3831033f904SLan Tianyu struct mutex physical_node_lock; 384b1c0f99bSRafael J. Wysocki void (*remove)(struct acpi_device *); 3851da177e4SLinus Torvalds }; 3861da177e4SLinus Torvalds 387445b0eb0SRafael J. Wysocki /* Non-device subnode */ 388445b0eb0SRafael J. Wysocki struct acpi_data_node { 389445b0eb0SRafael J. Wysocki const char *name; 390263b4c1aSRafael J. Wysocki acpi_handle handle; 391445b0eb0SRafael J. Wysocki struct fwnode_handle fwnode; 392dfa672fbSMika Westerberg struct fwnode_handle *parent; 393445b0eb0SRafael J. Wysocki struct acpi_device_data data; 394445b0eb0SRafael J. Wysocki struct list_head sibling; 395263b4c1aSRafael J. Wysocki struct kobject kobj; 396263b4c1aSRafael J. Wysocki struct completion kobj_done; 397445b0eb0SRafael J. Wysocki }; 398445b0eb0SRafael J. Wysocki 399db3e50f3SSakari Ailus extern const struct fwnode_operations acpi_device_fwnode_ops; 400db3e50f3SSakari Ailus extern const struct fwnode_operations acpi_data_fwnode_ops; 401db3e50f3SSakari Ailus extern const struct fwnode_operations acpi_static_fwnode_ops; 402db3e50f3SSakari Ailus 4039e987b70SJohn Hubbard bool is_acpi_device_node(const struct fwnode_handle *fwnode); 4049e987b70SJohn Hubbard bool is_acpi_data_node(const struct fwnode_handle *fwnode); 4059e987b70SJohn Hubbard 4068b9d6802SSakari Ailus static inline bool is_acpi_node(const struct fwnode_handle *fwnode) 4078a0662d9SRafael J. Wysocki { 4089e987b70SJohn Hubbard return (is_acpi_device_node(fwnode) || is_acpi_data_node(fwnode)); 4098a0662d9SRafael J. Wysocki } 4108a0662d9SRafael J. Wysocki 4118b9d6802SSakari Ailus #define to_acpi_device_node(__fwnode) \ 4128b9d6802SSakari Ailus ({ \ 4138b9d6802SSakari Ailus typeof(__fwnode) __to_acpi_device_node_fwnode = __fwnode; \ 4148b9d6802SSakari Ailus \ 4158b9d6802SSakari Ailus is_acpi_device_node(__to_acpi_device_node_fwnode) ? \ 4168b9d6802SSakari Ailus container_of(__to_acpi_device_node_fwnode, \ 4178b9d6802SSakari Ailus struct acpi_device, fwnode) : \ 4188b9d6802SSakari Ailus NULL; \ 4198b9d6802SSakari Ailus }) 4208a0662d9SRafael J. Wysocki 4218b9d6802SSakari Ailus #define to_acpi_data_node(__fwnode) \ 4228b9d6802SSakari Ailus ({ \ 4238b9d6802SSakari Ailus typeof(__fwnode) __to_acpi_data_node_fwnode = __fwnode; \ 4248b9d6802SSakari Ailus \ 4258b9d6802SSakari Ailus is_acpi_data_node(__to_acpi_data_node_fwnode) ? \ 4268b9d6802SSakari Ailus container_of(__to_acpi_data_node_fwnode, \ 4278b9d6802SSakari Ailus struct acpi_data_node, fwnode) : \ 4288b9d6802SSakari Ailus NULL; \ 4298b9d6802SSakari Ailus }) 4303a7a2ab8SRafael J. Wysocki 4318b9d6802SSakari Ailus static inline bool is_acpi_static_node(const struct fwnode_handle *fwnode) 432db89b4f0SPavel Machek { 433db3e50f3SSakari Ailus return !IS_ERR_OR_NULL(fwnode) && 434db3e50f3SSakari Ailus fwnode->ops == &acpi_static_fwnode_ops; 435db89b4f0SPavel Machek } 436d43ec68eSPatrick Mochel 4378b9d6802SSakari Ailus static inline bool acpi_data_node_match(const struct fwnode_handle *fwnode, 438613e9721SAdam Thomson const char *name) 439613e9721SAdam Thomson { 440613e9721SAdam Thomson return is_acpi_data_node(fwnode) ? 441613e9721SAdam Thomson (!strcmp(to_acpi_data_node(fwnode)->name, name)) : false; 442613e9721SAdam Thomson } 443613e9721SAdam Thomson 44425db115bSRafael J. Wysocki static inline struct fwnode_handle *acpi_fwnode_handle(struct acpi_device *adev) 4453c2cc7ffSRafael J. Wysocki { 446ba574dc8SRafael J. Wysocki return &adev->fwnode; 4473c2cc7ffSRafael J. Wysocki } 4483c2cc7ffSRafael J. Wysocki 4493c2cc7ffSRafael J. Wysocki static inline void *acpi_driver_data(struct acpi_device *d) 4503c2cc7ffSRafael J. Wysocki { 4513c2cc7ffSRafael J. Wysocki return d->driver_data; 4525d513205SRafael J. Wysocki } 4535d513205SRafael J. Wysocki 4545d513205SRafael J. Wysocki #define to_acpi_device(d) container_of(d, struct acpi_device, dev) 4555d513205SRafael J. Wysocki #define to_acpi_driver(d) container_of(d, struct acpi_driver, drv) 4565d513205SRafael J. Wysocki 45755955aadSDavid Brownell static inline void acpi_set_device_status(struct acpi_device *adev, u32 sta) 45855955aadSDavid Brownell { 45955955aadSDavid Brownell *((u32 *)&adev->status) = sta; 4601da177e4SLinus Torvalds } 4611da177e4SLinus Torvalds 4621da177e4SLinus Torvalds static inline void acpi_set_hp_context(struct acpi_device *adev, 4631da177e4SLinus Torvalds struct acpi_hotplug_context *hp) 4641da177e4SLinus Torvalds { 4651da177e4SLinus Torvalds hp->self = adev; 4661da177e4SLinus Torvalds adev->hp = hp; 4671da177e4SLinus Torvalds } 4681da177e4SLinus Torvalds 4691da177e4SLinus Torvalds void acpi_initialize_hp_context(struct acpi_device *adev, 4701da177e4SLinus Torvalds struct acpi_hotplug_context *hp, 4711da177e4SLinus Torvalds int (*notify)(struct acpi_device *, u32), 4721da177e4SLinus Torvalds void (*uevent)(struct acpi_device *, u32)); 47399e0d2fcSGreg Kroah-Hartman 474962ce8caSZhang Rui /* acpi_device.dev.bus == &acpi_bus_type */ 4758e4319c4SBob Moore extern struct bus_type acpi_bus_type; 47620733939SZhang Rui 47772013795SLan Tianyu /* 47872013795SLan Tianyu * Events 4799ee85241SZhang Rui * ------ 4809ee85241SZhang Rui */ 4819ee85241SZhang Rui 4826bd00a61SShaohua Li struct acpi_bus_event { 4831da177e4SLinus Torvalds struct list_head node; 4841da177e4SLinus Torvalds acpi_device_class device_class; 4851da177e4SLinus Torvalds acpi_bus_id bus_id; 4861da177e4SLinus Torvalds u32 type; 4871da177e4SLinus Torvalds u32 data; 48878ea4639SRafael J. Wysocki }; 48978ea4639SRafael J. Wysocki 490402ac536SBjorn Helgaas extern struct kobject *acpi_kobj; 491402ac536SBjorn Helgaas extern int acpi_bus_generate_netlink_event(const char*, const char*, u8, int); 4921da177e4SLinus Torvalds void acpi_bus_private_data_handler(acpi_handle, void *); 4939ce4e607SRafael J. Wysocki int acpi_bus_get_private_data(acpi_handle, void **); 4941da177e4SLinus Torvalds int acpi_bus_attach_private_data(acpi_handle, void *); 49596bfd3ceSRafael J. Wysocki void acpi_bus_detach_private_data(acpi_handle); 496ad0c3b0eSRafael J. Wysocki extern int acpi_notifier_call_chain(struct acpi_device *, u32, u32); 497078eb126SRafael J. Wysocki extern int register_acpi_notifier(struct notifier_block *); 4989ce4e607SRafael J. Wysocki extern int unregister_acpi_notifier(struct notifier_block *); 499b9e95fc6SRafael J. Wysocki 50025eed407SRafael J. Wysocki /* 5012bb3a2bfSAaron Lu * External Functions 5023737b2b1SRafael J. Wysocki */ 503ec4602a9SRafael J. Wysocki 504ec4602a9SRafael J. Wysocki int acpi_bus_get_device(acpi_handle handle, struct acpi_device **device); 505eb9d0fe4SRafael J. Wysocki struct acpi_device *acpi_bus_get_acpi_device(acpi_handle handle); 506ec4602a9SRafael J. Wysocki void acpi_bus_put_acpi_device(struct acpi_device *adev); 507ec4602a9SRafael J. Wysocki acpi_status acpi_bus_get_status_handle(acpi_handle handle, 508ec4602a9SRafael J. Wysocki unsigned long long *sta); 5099ce4e607SRafael J. Wysocki int acpi_bus_get_status(struct acpi_device *device); 5103757b948SRafael J. Wysocki 5113757b948SRafael J. Wysocki int acpi_bus_set_power(acpi_handle handle, int state); 512e525506fSRafael J. Wysocki const char *acpi_power_state_string(int state); 513e525506fSRafael J. Wysocki int acpi_device_get_power(struct acpi_device *device, int *state); 514ca589f94SRafael J. Wysocki int acpi_device_set_power(struct acpi_device *device, int state); 5151da177e4SLinus Torvalds int acpi_bus_init_power(struct acpi_device *device); 51606ea8e08SBjorn Helgaas int acpi_device_fix_up_power(struct acpi_device *device); 517b8bd759aSRafael J. Wysocki int acpi_bus_update_power(acpi_handle handle, int *state_p); 518bfee26dbSRafael J. Wysocki int acpi_device_update_power(struct acpi_device *device, int *state_p); 519c8f7a62cSLen Brown bool acpi_bus_power_manageable(acpi_handle handle); 5208c8eb78fSThomas Renninger 5218c8eb78fSThomas Renninger #ifdef CONFIG_PM 5221da177e4SLinus Torvalds bool acpi_bus_can_wakeup(acpi_handle handle); 5231da177e4SLinus Torvalds #else 5241da177e4SLinus Torvalds static inline bool acpi_bus_can_wakeup(acpi_handle handle) { return false; } 525202317a5SRafael J. Wysocki #endif 526202317a5SRafael J. Wysocki 527202317a5SRafael J. Wysocki void acpi_scan_lock_acquire(void); 528202317a5SRafael J. Wysocki void acpi_scan_lock_release(void); 529202317a5SRafael J. Wysocki void acpi_lock_hp_context(void); 5300d2cf8f5SMika Westerberg void acpi_unlock_hp_context(void); 5310d2cf8f5SMika Westerberg int acpi_scan_add_handler(struct acpi_scan_handler *handler); 5320d2cf8f5SMika Westerberg int acpi_bus_register_driver(struct acpi_driver *driver); 5330d2cf8f5SMika Westerberg void acpi_bus_unregister_driver(struct acpi_driver *driver); 5340d2cf8f5SMika Westerberg int acpi_bus_scan(acpi_handle handle); 5350d2cf8f5SMika Westerberg void acpi_bus_trim(struct acpi_device *start); 5360d2cf8f5SMika Westerberg acpi_status acpi_bus_get_ejd(acpi_handle handle, acpi_handle * ejd); 5370d2cf8f5SMika Westerberg int acpi_match_device_ids(struct acpi_device *device, 5380d2cf8f5SMika Westerberg const struct acpi_device_id *ids); 53951ede5d9SDan O'Donovan void acpi_set_modalias(struct acpi_device *adev, const char *default_id, 54051ede5d9SDan O'Donovan char *modalias, size_t len); 5410d2cf8f5SMika Westerberg int acpi_create_dir(struct acpi_device *); 5420d2cf8f5SMika Westerberg void acpi_remove_dir(struct acpi_device *); 5430d2cf8f5SMika Westerberg 5444e10d12aSDavid Shaohua Li static inline bool acpi_device_enumerated(struct acpi_device *adev) 5454e10d12aSDavid Shaohua Li { 5464e10d12aSDavid Shaohua Li return adev && adev->flags.initialized && adev->flags.visited; 5474e10d12aSDavid Shaohua Li } 5484e10d12aSDavid Shaohua Li 54953540098SRafael J. Wysocki /** 55053540098SRafael J. Wysocki * module_acpi_driver(acpi_driver) - Helper macro for registering an ACPI driver 551e3f02c52SRafael J. Wysocki * @__acpi_driver: acpi_driver struct 55211909ca1SRafael J. Wysocki * 55311909ca1SRafael J. Wysocki * Helper macro for ACPI drivers which do not do anything special in module 5544e10d12aSDavid Shaohua Li * init/exit. This eliminates a lot of boilerplate. Each module may only 5554e10d12aSDavid Shaohua Li * use this macro once, and calling it replaces module_init() and module_exit() 5564e10d12aSDavid Shaohua Li */ 55722c13f9dSThomas Renninger #define module_acpi_driver(__acpi_driver) \ 55876d56de5SAlex Chiang module_driver(__acpi_driver, acpi_bus_register_driver, \ 55976d56de5SAlex Chiang acpi_bus_unregister_driver) 56076d56de5SAlex Chiang 56176d56de5SAlex Chiang /* 5626ad95513SBjorn Helgaas * Bind physical devices with ACPI devices 56376d56de5SAlex Chiang */ 56476d56de5SAlex Chiang struct acpi_bus_type { 56576d56de5SAlex Chiang struct list_head list; 566f4b57a3bSJiang Liu const char *name; 56776d56de5SAlex Chiang bool (*match)(struct device *dev); 56876d56de5SAlex Chiang struct acpi_device * (*find_companion)(struct device *); 5694e10d12aSDavid Shaohua Li void (*setup)(struct device *); 570d9fef0c4SRafael J. Wysocki void (*cleanup)(struct device *); 571d9fef0c4SRafael J. Wysocki }; 572d9fef0c4SRafael J. Wysocki int register_acpi_bus_type(struct acpi_bus_type *); 57327558203SAlexander Chiang int unregister_acpi_bus_type(struct acpi_bus_type *); 574f1b1dc84SZhang Rui int acpi_bind_one(struct device *dev, struct acpi_device *adev); 575f1b1dc84SZhang Rui int acpi_unbind_one(struct device *dev); 5761da177e4SLinus Torvalds 5771da177e4SLinus Torvalds struct acpi_pci_root { 5781da177e4SLinus Torvalds struct acpi_device * device; 5791da177e4SLinus Torvalds struct pci_bus *bus; 5801da177e4SLinus Torvalds u16 segment; 5811da177e4SLinus Torvalds struct resource secondary; /* downstream bus range */ 5821da177e4SLinus Torvalds 5831da177e4SLinus Torvalds u32 osc_support_set; /* _OSC state of support bits */ 5841da177e4SLinus Torvalds u32 osc_control_set; /* _OSC state of control bits */ 5851da177e4SLinus Torvalds phys_addr_t mcfg_addr; 5861da177e4SLinus Torvalds }; 5871da177e4SLinus Torvalds 5881da177e4SLinus Torvalds /* helper */ 5891da177e4SLinus Torvalds 590b84f196dSSuthikulpanit, Suravee bool acpi_dma_supported(struct acpi_device *adev); 591b84f196dSSuthikulpanit, Suravee enum dev_dma_attr acpi_get_dma_attr(struct acpi_device *adev); 592c04ac679SLorenzo Pieralisi int acpi_dma_get_range(struct device *dev, u64 *dma_addr, u64 *offset, 593c04ac679SLorenzo Pieralisi u64 *size); 5945a1bb638SSricharan R int acpi_dma_configure(struct device *dev, enum dev_dma_attr attr); 595d760a1baSLorenzo Pieralisi void acpi_dma_deconfigure(struct device *dev); 596b84f196dSSuthikulpanit, Suravee 5974e10d12aSDavid Shaohua Li struct acpi_device *acpi_find_child_device(struct acpi_device *parent, 5984e10d12aSDavid Shaohua Li u64 address, bool check_children); 59976d56de5SAlex Chiang int acpi_is_root_bridge(acpi_handle); 60095f8a082SRafael J. Wysocki struct acpi_pci_root *acpi_pci_find_root(acpi_handle handle); 6014e10d12aSDavid Shaohua Li 602b67ea761SRafael J. Wysocki int acpi_enable_wakeup_device_power(struct acpi_device *dev, int state); 603b67ea761SRafael J. Wysocki int acpi_disable_wakeup_device_power(struct acpi_device *dev); 6041da177e4SLinus Torvalds 605b7ecf663SHans de Goede #ifdef CONFIG_X86 606b7ecf663SHans de Goede bool acpi_device_always_present(struct acpi_device *adev); 607b7ecf663SHans de Goede #else 608b7ecf663SHans de Goede static inline bool acpi_device_always_present(struct acpi_device *adev) 609b7ecf663SHans de Goede { 610b7ecf663SHans de Goede return false; 611b7ecf663SHans de Goede } 612b7ecf663SHans de Goede #endif 613b7ecf663SHans de Goede 614aa338601SRafael J. Wysocki #ifdef CONFIG_PM 61533e4f80eSRafael J. Wysocki void acpi_pm_wakeup_event(struct device *dev); 616c072530fSRafael J. Wysocki acpi_status acpi_add_pm_notifier(struct acpi_device *adev, struct device *dev, 61764fd1c70SRafael J. Wysocki void (*func)(struct acpi_device_wakeup_context *context)); 618c072530fSRafael J. Wysocki acpi_status acpi_remove_pm_notifier(struct acpi_device *adev); 6198370c2dcSRafael J. Wysocki bool acpi_pm_device_can_wakeup(struct device *dev); 620ee85f543SHuang Ying int acpi_pm_device_sleep_state(struct device *, int *, int); 6214d183d04SRafael J. Wysocki int acpi_pm_set_device_wakeup(struct device *dev, bool enable); 6221ba51a7cSRafael J. Wysocki int acpi_pm_set_bridge_wakeup(struct device *dev, bool enable); 623761afb86SRafael J. Wysocki #else 62433e4f80eSRafael J. Wysocki static inline void acpi_pm_wakeup_event(struct device *dev) 62533e4f80eSRafael J. Wysocki { 62633e4f80eSRafael J. Wysocki } 627ec2cd81cSRafael J. Wysocki static inline acpi_status acpi_add_pm_notifier(struct acpi_device *adev, 628c072530fSRafael J. Wysocki struct device *dev, 62933e4f80eSRafael J. Wysocki void (*func)(struct acpi_device_wakeup_context *context)) 630ec2cd81cSRafael J. Wysocki { 631ec2cd81cSRafael J. Wysocki return AE_SUPPORT; 632ec2cd81cSRafael J. Wysocki } 633c072530fSRafael J. Wysocki static inline acpi_status acpi_remove_pm_notifier(struct acpi_device *adev) 634ec2cd81cSRafael J. Wysocki { 635ec2cd81cSRafael J. Wysocki return AE_SUPPORT; 636ec2cd81cSRafael J. Wysocki } 6378370c2dcSRafael J. Wysocki static inline bool acpi_pm_device_can_wakeup(struct device *dev) 6388370c2dcSRafael J. Wysocki { 6398370c2dcSRafael J. Wysocki return false; 6408370c2dcSRafael J. Wysocki } 641b25c77efSRafael J. Wysocki static inline int acpi_pm_device_sleep_state(struct device *d, int *p, int m) 642296699deSRafael J. Wysocki { 643296699deSRafael J. Wysocki if (p) 644296699deSRafael J. Wysocki *p = ACPI_STATE_D0; 645b25c77efSRafael J. Wysocki 6468ad928d5SRafael J. Wysocki return (m >= ACPI_STATE_D0 && m <= ACPI_STATE_D3_COLD) ? 6478ad928d5SRafael J. Wysocki m : ACPI_STATE_D0; 648296699deSRafael J. Wysocki } 6494d183d04SRafael J. Wysocki static inline int acpi_pm_set_device_wakeup(struct device *dev, bool enable) 650f7a1b860SDavid Howells { 651f7a1b860SDavid Howells return -ENODEV; 652f7a1b860SDavid Howells } 6531ba51a7cSRafael J. Wysocki static inline int acpi_pm_set_bridge_wakeup(struct device *dev, bool enable) 6541ba51a7cSRafael J. Wysocki { 6551ba51a7cSRafael J. Wysocki return -ENODEV; 6561ba51a7cSRafael J. Wysocki } 657761afb86SRafael J. Wysocki #endif 658fd4aff1aSShaohua Li 65999926a8cSDavid Rientjes #ifdef CONFIG_ACPI_SLEEP 66099926a8cSDavid Rientjes u32 acpi_target_system_state(void); 66199926a8cSDavid Rientjes #else 66299926a8cSDavid Rientjes static inline u32 acpi_target_system_state(void) { return ACPI_STATE_S0; } 66399926a8cSDavid Rientjes #endif 66499926a8cSDavid Rientjes 665078eb126SRafael J. Wysocki static inline bool acpi_device_power_manageable(struct acpi_device *adev) 666078eb126SRafael J. Wysocki { 667078eb126SRafael J. Wysocki return adev->flags.power_manageable; 668078eb126SRafael J. Wysocki } 669078eb126SRafael J. Wysocki 670078eb126SRafael J. Wysocki static inline bool acpi_device_can_wakeup(struct acpi_device *adev) 671078eb126SRafael J. Wysocki { 672078eb126SRafael J. Wysocki return adev->wakeup.flags.valid; 673078eb126SRafael J. Wysocki } 674078eb126SRafael J. Wysocki 6751399dfcdSAaron Lu static inline bool acpi_device_can_poweroff(struct acpi_device *adev) 6761399dfcdSAaron Lu { 677cd7f84c0SKen Xue return adev->power.states[ACPI_STATE_D3_COLD].flags.valid || 678cd7f84c0SKen Xue ((acpi_gbl_FADT.header.revision < 6) && 679cd7f84c0SKen Xue adev->power.states[ACPI_STATE_D3_HOT].flags.explicit_set); 6801399dfcdSAaron Lu } 6811399dfcdSAaron Lu 68266886d6fSMatthew Garrett #else /* CONFIG_ACPI */ 68366886d6fSMatthew Garrett 6847ae30986SLen Brown static inline int register_acpi_bus_type(void *bus) { return 0; } 6857ae30986SLen Brown static inline int unregister_acpi_bus_type(void *bus) { return 0; } 68666886d6fSMatthew Garrett 68776f58584SLen Brown #endif /* CONFIG_ACPI */ 6881da177e4SLinus Torvalds 6891da177e4SLinus Torvalds #endif /*__ACPI_BUS_H__*/ 690