1c942fddfSThomas Gleixner /* SPDX-License-Identifier: GPL-2.0-or-later */ 21da177e4SLinus Torvalds /* 31da177e4SLinus Torvalds * acpi_bus.h - ACPI Bus Driver ($Revision: 22 $) 41da177e4SLinus Torvalds * 51da177e4SLinus Torvalds * Copyright (C) 2001, 2002 Andy Grover <andrew.grover@intel.com> 61da177e4SLinus Torvalds * Copyright (C) 2001, 2002 Paul Diefenbaugh <paul.s.diefenbaugh@intel.com> 71da177e4SLinus Torvalds */ 81da177e4SLinus Torvalds 91da177e4SLinus Torvalds #ifndef __ACPI_BUS_H__ 101da177e4SLinus Torvalds #define __ACPI_BUS_H__ 111da177e4SLinus Torvalds 125b327265SPatrick Mochel #include <linux/device.h> 138a0662d9SRafael J. Wysocki #include <linux/property.h> 141da177e4SLinus Torvalds 151da177e4SLinus Torvalds /* TBD: Make dynamic */ 161da177e4SLinus Torvalds #define ACPI_MAX_HANDLES 10 171da177e4SLinus Torvalds struct acpi_handle_list { 181da177e4SLinus Torvalds u32 count; 191da177e4SLinus Torvalds acpi_handle handles[ACPI_MAX_HANDLES]; 201da177e4SLinus Torvalds }; 211da177e4SLinus Torvalds 221da177e4SLinus Torvalds /* acpi_utils.h */ 231da177e4SLinus Torvalds acpi_status 244be44fcdSLen Brown acpi_extract_package(union acpi_object *package, 254be44fcdSLen Brown struct acpi_buffer *format, struct acpi_buffer *buffer); 261da177e4SLinus Torvalds acpi_status 274be44fcdSLen Brown acpi_evaluate_integer(acpi_handle handle, 281da177e4SLinus Torvalds acpi_string pathname, 2927663c58SMatthew Wilcox struct acpi_object_list *arguments, unsigned long long *data); 301da177e4SLinus Torvalds acpi_status 314be44fcdSLen Brown acpi_evaluate_reference(acpi_handle handle, 321da177e4SLinus Torvalds acpi_string pathname, 331da177e4SLinus Torvalds struct acpi_object_list *arguments, 341da177e4SLinus Torvalds struct acpi_handle_list *list); 35275c58d7SToshi Kani acpi_status 3605730c19SJiang Liu acpi_evaluate_ost(acpi_handle handle, u32 source_event, u32 status_code, 3705730c19SJiang Liu struct acpi_buffer *status_buf); 381da177e4SLinus Torvalds 3938ac0f1bSMatthew Garrett acpi_status 408ede06abSFeng Tang acpi_get_physical_device_location(acpi_handle handle, struct acpi_pld_info **pld); 41952c63e9SJiang Liu 42952c63e9SJiang Liu bool acpi_has_method(acpi_handle handle, char *name); 430db98202SJiang Liu acpi_status acpi_execute_simple_method(acpi_handle handle, char *method, 440db98202SJiang Liu u64 arg); 457d2421f8SJiang Liu acpi_status acpi_evaluate_ej0(acpi_handle handle); 467d2421f8SJiang Liu acpi_status acpi_evaluate_lck(acpi_handle handle, int lock); 47132565d8SHans de Goede acpi_status acpi_evaluate_reg(acpi_handle handle, u8 space_id, u32 function); 48ebf4df8dSJiang Liu bool acpi_ata_match(acpi_handle handle); 49ebf4df8dSJiang Liu bool acpi_bay_match(acpi_handle handle); 50ebf4df8dSJiang Liu bool acpi_dock_match(acpi_handle handle); 51952c63e9SJiang Liu 5294116f81SAndy Shevchenko bool acpi_check_dsm(acpi_handle handle, const guid_t *guid, u64 rev, u64 funcs); 5394116f81SAndy Shevchenko union acpi_object *acpi_evaluate_dsm(acpi_handle handle, const guid_t *guid, 54c7e16e52SJerry Hoemann u64 rev, u64 func, union acpi_object *argv4); 55a65ac520SJiang Liu 56a65ac520SJiang Liu static inline union acpi_object * 5794116f81SAndy Shevchenko acpi_evaluate_dsm_typed(acpi_handle handle, const guid_t *guid, u64 rev, 5894116f81SAndy Shevchenko u64 func, union acpi_object *argv4, 5994116f81SAndy Shevchenko acpi_object_type type) 60a65ac520SJiang Liu { 61a65ac520SJiang Liu union acpi_object *obj; 62a65ac520SJiang Liu 6394116f81SAndy Shevchenko obj = acpi_evaluate_dsm(handle, guid, rev, func, argv4); 64a65ac520SJiang Liu if (obj && obj->type != type) { 65a65ac520SJiang Liu ACPI_FREE(obj); 66a65ac520SJiang Liu obj = NULL; 67a65ac520SJiang Liu } 68a65ac520SJiang Liu 69a65ac520SJiang Liu return obj; 70a65ac520SJiang Liu } 71a65ac520SJiang Liu 72a65ac520SJiang Liu #define ACPI_INIT_DSM_ARGV4(cnt, eles) \ 73a65ac520SJiang Liu { \ 74a65ac520SJiang Liu .package.type = ACPI_TYPE_PACKAGE, \ 75a65ac520SJiang Liu .package.count = (cnt), \ 76a65ac520SJiang Liu .package.elements = (eles) \ 77a65ac520SJiang Liu } 78a65ac520SJiang Liu 79c68ae33eSLukas Wunner bool acpi_dev_found(const char *hid); 808661423eSHans de Goede bool acpi_dev_present(const char *hid, const char *uid, s64 hrv); 812d12b6b3SLukas Wunner 8276f58584SLen Brown #ifdef CONFIG_ACPI 831da177e4SLinus Torvalds 84df23e2beSPeter Zijlstra struct proc_dir_entry; 851da177e4SLinus Torvalds 861da177e4SLinus Torvalds #define ACPI_BUS_FILE_ROOT "acpi" 871da177e4SLinus Torvalds extern struct proc_dir_entry *acpi_root_dir; 881da177e4SLinus Torvalds 891da177e4SLinus Torvalds enum acpi_bus_device_type { 901da177e4SLinus Torvalds ACPI_BUS_TYPE_DEVICE = 0, 911da177e4SLinus Torvalds ACPI_BUS_TYPE_POWER, 921da177e4SLinus Torvalds ACPI_BUS_TYPE_PROCESSOR, 931da177e4SLinus Torvalds ACPI_BUS_TYPE_THERMAL, 941da177e4SLinus Torvalds ACPI_BUS_TYPE_POWER_BUTTON, 951da177e4SLinus Torvalds ACPI_BUS_TYPE_SLEEP_BUTTON, 96a64a62ceSLv Zheng ACPI_BUS_TYPE_ECDT_EC, 971da177e4SLinus Torvalds ACPI_BUS_DEVICE_TYPE_COUNT 981da177e4SLinus Torvalds }; 991da177e4SLinus Torvalds 1001da177e4SLinus Torvalds struct acpi_driver; 1011da177e4SLinus Torvalds struct acpi_device; 1021da177e4SLinus Torvalds 1031da177e4SLinus Torvalds /* 104ca589f94SRafael J. Wysocki * ACPI Scan Handler 105ca589f94SRafael J. Wysocki * ----------------- 106ca589f94SRafael J. Wysocki */ 107ca589f94SRafael J. Wysocki 108a33ec399SRafael J. Wysocki struct acpi_hotplug_profile { 1093f8055c3SRafael J. Wysocki struct kobject kobj; 1103338db00SRafael J. Wysocki int (*scan_dependent)(struct acpi_device *adev); 1118ab17fc9SRafael J. Wysocki void (*notify_online)(struct acpi_device *adev); 112d22ddcbcSRafael J. Wysocki bool enabled:1; 113d22ddcbcSRafael J. Wysocki bool demand_offline:1; 114a33ec399SRafael J. Wysocki }; 115a33ec399SRafael J. Wysocki 1163f8055c3SRafael J. Wysocki static inline struct acpi_hotplug_profile *to_acpi_hotplug_profile( 1173f8055c3SRafael J. Wysocki struct kobject *kobj) 1183f8055c3SRafael J. Wysocki { 1193f8055c3SRafael J. Wysocki return container_of(kobj, struct acpi_hotplug_profile, kobj); 1203f8055c3SRafael J. Wysocki } 1213f8055c3SRafael J. Wysocki 122ca589f94SRafael J. Wysocki struct acpi_scan_handler { 123ca589f94SRafael J. Wysocki const struct acpi_device_id *ids; 124ca589f94SRafael J. Wysocki struct list_head list_node; 125636c19d3SRasmus Villemoes bool (*match)(const char *idstr, const struct acpi_device_id **matchid); 126ca589f94SRafael J. Wysocki int (*attach)(struct acpi_device *dev, const struct acpi_device_id *id); 127ca589f94SRafael J. Wysocki void (*detach)(struct acpi_device *dev); 1289cb32acfSRafael J. Wysocki void (*bind)(struct device *phys_dev); 1299cb32acfSRafael J. Wysocki void (*unbind)(struct device *phys_dev); 130a33ec399SRafael J. Wysocki struct acpi_hotplug_profile hotplug; 131ca589f94SRafael J. Wysocki }; 132ca589f94SRafael J. Wysocki 133ca589f94SRafael J. Wysocki /* 1343c2cc7ffSRafael J. Wysocki * ACPI Hotplug Context 1353c2cc7ffSRafael J. Wysocki * -------------------- 1363c2cc7ffSRafael J. Wysocki */ 1373c2cc7ffSRafael J. Wysocki 1383c2cc7ffSRafael J. Wysocki struct acpi_hotplug_context { 1393c2cc7ffSRafael J. Wysocki struct acpi_device *self; 140be27b3dcSRafael J. Wysocki int (*notify)(struct acpi_device *, u32); 141be27b3dcSRafael J. Wysocki void (*uevent)(struct acpi_device *, u32); 14259b42fa0SRafael J. Wysocki void (*fixup)(struct acpi_device *); 1433c2cc7ffSRafael J. Wysocki }; 1443c2cc7ffSRafael J. Wysocki 1453c2cc7ffSRafael J. Wysocki /* 1461da177e4SLinus Torvalds * ACPI Driver 1471da177e4SLinus Torvalds * ----------- 1481da177e4SLinus Torvalds */ 1491da177e4SLinus Torvalds 1501da177e4SLinus Torvalds typedef int (*acpi_op_add) (struct acpi_device * device); 15151fac838SRafael J. Wysocki typedef int (*acpi_op_remove) (struct acpi_device * device); 15246ec8598SBjorn Helgaas typedef void (*acpi_op_notify) (struct acpi_device * device, u32 event); 1531da177e4SLinus Torvalds 1541da177e4SLinus Torvalds struct acpi_device_ops { 1551da177e4SLinus Torvalds acpi_op_add add; 1561da177e4SLinus Torvalds acpi_op_remove remove; 15746ec8598SBjorn Helgaas acpi_op_notify notify; 1581da177e4SLinus Torvalds }; 1591da177e4SLinus Torvalds 1606d278131SBjorn Helgaas #define ACPI_DRIVER_ALL_NOTIFY_EVENTS 0x1 /* system AND device events */ 1616d278131SBjorn Helgaas 1621da177e4SLinus Torvalds struct acpi_driver { 1631da177e4SLinus Torvalds char name[80]; 1641da177e4SLinus Torvalds char class[80]; 1658c8eb78fSThomas Renninger const struct acpi_device_id *ids; /* Supported Hardware IDs */ 1666d278131SBjorn Helgaas unsigned int flags; 1671da177e4SLinus Torvalds struct acpi_device_ops ops; 168d43ec68eSPatrick Mochel struct device_driver drv; 1691890a97aSPatrick Mochel struct module *owner; 1701da177e4SLinus Torvalds }; 1711da177e4SLinus Torvalds 1721da177e4SLinus Torvalds /* 1731da177e4SLinus Torvalds * ACPI Device 1741da177e4SLinus Torvalds * ----------- 1751da177e4SLinus Torvalds */ 1761da177e4SLinus Torvalds 1771da177e4SLinus Torvalds /* Status (_STA) */ 1781da177e4SLinus Torvalds 1791da177e4SLinus Torvalds struct acpi_device_status { 1801da177e4SLinus Torvalds u32 present:1; 1811da177e4SLinus Torvalds u32 enabled:1; 1821da177e4SLinus Torvalds u32 show_in_ui:1; 1831da177e4SLinus Torvalds u32 functional:1; 1841da177e4SLinus Torvalds u32 battery_present:1; 1851da177e4SLinus Torvalds u32 reserved:27; 1861da177e4SLinus Torvalds }; 1871da177e4SLinus Torvalds 1881da177e4SLinus Torvalds /* Flags */ 1891da177e4SLinus Torvalds 1901da177e4SLinus Torvalds struct acpi_device_flags { 1911da177e4SLinus Torvalds u32 dynamic_status:1; 1921da177e4SLinus Torvalds u32 removable:1; 1931da177e4SLinus Torvalds u32 ejectable:1; 1941da177e4SLinus Torvalds u32 power_manageable:1; 195209d3b17SRafael J. Wysocki u32 match_driver:1; 196202317a5SRafael J. Wysocki u32 initialized:1; 197202317a5SRafael J. Wysocki u32 visited:1; 1983c2cc7ffSRafael J. Wysocki u32 hotplug_notify:1; 1991e2380cdSRafael J. Wysocki u32 is_dock_station:1; 2005c53b262SRafael J. Wysocki u32 of_compatible_ok:1; 201d0562674SSuthikulpanit, Suravee u32 coherent_dma:1; 202d0562674SSuthikulpanit, Suravee u32 cca_seen:1; 203d87fb091SJohn Garry u32 enumeration_by_parent:1; 204e4330d8bSJarkko Nikula u32 reserved:19; 2051da177e4SLinus Torvalds }; 2061da177e4SLinus Torvalds 2071da177e4SLinus Torvalds /* File System */ 2081da177e4SLinus Torvalds 2091da177e4SLinus Torvalds struct acpi_device_dir { 2101da177e4SLinus Torvalds struct proc_dir_entry *entry; 2111da177e4SLinus Torvalds }; 2121da177e4SLinus Torvalds 2131da177e4SLinus Torvalds #define acpi_device_dir(d) ((d)->dir.entry) 2141da177e4SLinus Torvalds 2151da177e4SLinus Torvalds /* Plug and Play */ 2161da177e4SLinus Torvalds 21724c5c4c2SZhao Yakui typedef char acpi_bus_id[8]; 218ca6f998cSPierre-Louis Bossart typedef u64 acpi_bus_address; 2191da177e4SLinus Torvalds typedef char acpi_device_name[40]; 2201da177e4SLinus Torvalds typedef char acpi_device_class[20]; 2211da177e4SLinus Torvalds 2227f47fa6cSBjorn Helgaas struct acpi_hardware_id { 2237f47fa6cSBjorn Helgaas struct list_head list; 224844142c3SRasmus Villemoes const char *id; 2257f47fa6cSBjorn Helgaas }; 2267f47fa6cSBjorn Helgaas 227d4e1a692SToshi Kani struct acpi_pnp_type { 228d4e1a692SToshi Kani u32 hardware_id:1; 229d4e1a692SToshi Kani u32 bus_address:1; 230549e6845SRafael J. Wysocki u32 platform_id:1; 231549e6845SRafael J. Wysocki u32 reserved:29; 232d4e1a692SToshi Kani }; 233d4e1a692SToshi Kani 2341da177e4SLinus Torvalds struct acpi_device_pnp { 2351da177e4SLinus Torvalds acpi_bus_id bus_id; /* Object name */ 236d4e1a692SToshi Kani struct acpi_pnp_type type; /* ID type */ 2371da177e4SLinus Torvalds acpi_bus_address bus_address; /* _ADR */ 23815b8dd53SBob Moore char *unique_id; /* _UID */ 2397f47fa6cSBjorn Helgaas struct list_head ids; /* _HID and _CIDs */ 2401da177e4SLinus Torvalds acpi_device_name device_name; /* Driver-determined */ 2411da177e4SLinus Torvalds acpi_device_class device_class; /* " */ 242d1efe3c3SLance Ortiz union acpi_object *str_obj; /* unicode string for _STR method */ 2431da177e4SLinus Torvalds }; 2441da177e4SLinus Torvalds 2451da177e4SLinus Torvalds #define acpi_device_bid(d) ((d)->pnp.bus_id) 2461da177e4SLinus Torvalds #define acpi_device_adr(d) ((d)->pnp.bus_address) 247620e112cSThomas Renninger const char *acpi_device_hid(struct acpi_device *device); 248359597cbSAdrian Hunter #define acpi_device_uid(d) ((d)->pnp.unique_id) 2491da177e4SLinus Torvalds #define acpi_device_name(d) ((d)->pnp.device_name) 2501da177e4SLinus Torvalds #define acpi_device_class(d) ((d)->pnp.device_class) 2511da177e4SLinus Torvalds 2521da177e4SLinus Torvalds /* Power Management */ 2531da177e4SLinus Torvalds 2541da177e4SLinus Torvalds struct acpi_device_power_flags { 2551da177e4SLinus Torvalds u32 explicit_get:1; /* _PSC present? */ 2561da177e4SLinus Torvalds u32 power_resources:1; /* Power resources */ 2571da177e4SLinus Torvalds u32 inrush_current:1; /* Serialize Dx->D0 */ 2581da177e4SLinus Torvalds u32 power_removed:1; /* Optimize Dx->D0 */ 259644f17adSMika Westerberg u32 ignore_parent:1; /* Power is independent of parent power state */ 260f25c0ae2SRafael J. Wysocki u32 dsw_present:1; /* _DSW present? */ 261f25c0ae2SRafael J. Wysocki u32 reserved:26; 2621da177e4SLinus Torvalds }; 2631da177e4SLinus Torvalds 2641da177e4SLinus Torvalds struct acpi_device_power_state { 2651da177e4SLinus Torvalds struct { 2661da177e4SLinus Torvalds u8 valid:1; 2671da177e4SLinus Torvalds u8 explicit_set:1; /* _PSx present? */ 2681da177e4SLinus Torvalds u8 reserved:6; 2691da177e4SLinus Torvalds } flags; 2701da177e4SLinus Torvalds int power; /* % Power (compared to D0) */ 2711da177e4SLinus Torvalds int latency; /* Dx->D0 time (microseconds) */ 2720b224527SRafael J. Wysocki struct list_head resources; /* Power resources referenced */ 2731da177e4SLinus Torvalds }; 2741da177e4SLinus Torvalds 2751da177e4SLinus Torvalds struct acpi_device_power { 2761da177e4SLinus Torvalds int state; /* Current state */ 2771da177e4SLinus Torvalds struct acpi_device_power_flags flags; 278b4a03b9aSLin Ming struct acpi_device_power_state states[ACPI_D_STATE_COUNT]; /* Power states (D0-D3Cold) */ 2791da177e4SLinus Torvalds }; 2801da177e4SLinus Torvalds 2811da177e4SLinus Torvalds /* Performance Management */ 2821da177e4SLinus Torvalds 2831da177e4SLinus Torvalds struct acpi_device_perf_flags { 2841da177e4SLinus Torvalds u8 reserved:8; 2851da177e4SLinus Torvalds }; 2861da177e4SLinus Torvalds 2871da177e4SLinus Torvalds struct acpi_device_perf_state { 2881da177e4SLinus Torvalds struct { 2891da177e4SLinus Torvalds u8 valid:1; 2901da177e4SLinus Torvalds u8 reserved:7; 2911da177e4SLinus Torvalds } flags; 2921da177e4SLinus Torvalds u8 power; /* % Power (compared to P0) */ 2931da177e4SLinus Torvalds u8 performance; /* % Performance ( " ) */ 2941da177e4SLinus Torvalds int latency; /* Px->P0 time (microseconds) */ 2951da177e4SLinus Torvalds }; 2961da177e4SLinus Torvalds 2971da177e4SLinus Torvalds struct acpi_device_perf { 2981da177e4SLinus Torvalds int state; 2991da177e4SLinus Torvalds struct acpi_device_perf_flags flags; 3001da177e4SLinus Torvalds int state_count; 3011da177e4SLinus Torvalds struct acpi_device_perf_state *states; 3021da177e4SLinus Torvalds }; 3031da177e4SLinus Torvalds 3041da177e4SLinus Torvalds /* Wakeup Management */ 3051da177e4SLinus Torvalds struct acpi_device_wakeup_flags { 3061da177e4SLinus Torvalds u8 valid:1; /* Can successfully enable wakeup? */ 307b67ea761SRafael J. Wysocki u8 notifier_present:1; /* Wake-up notify handler has been installed */ 3081da177e4SLinus Torvalds }; 3091da177e4SLinus Torvalds 310c072530fSRafael J. Wysocki struct acpi_device_wakeup_context { 31164fd1c70SRafael J. Wysocki void (*func)(struct acpi_device_wakeup_context *context); 312c072530fSRafael J. Wysocki struct device *dev; 313c072530fSRafael J. Wysocki }; 314c072530fSRafael J. Wysocki 3151da177e4SLinus Torvalds struct acpi_device_wakeup { 3161da177e4SLinus Torvalds acpi_handle gpe_device; 317439913ffSLin Ming u64 gpe_number; 318439913ffSLin Ming u64 sleep_state; 319993cbe59SRafael J. Wysocki struct list_head resources; 3201da177e4SLinus Torvalds struct acpi_device_wakeup_flags flags; 321c072530fSRafael J. Wysocki struct acpi_device_wakeup_context context; 322c072530fSRafael J. Wysocki struct wakeup_source *ws; 3239b83ccd2SRafael J. Wysocki int prepare_count; 32499d8845eSRafael J. Wysocki int enable_count; 3251da177e4SLinus Torvalds }; 3261da177e4SLinus Torvalds 3271033f904SLan Tianyu struct acpi_device_physical_node { 328007ccfcfSRafael J. Wysocki unsigned int node_id; 3291033f904SLan Tianyu struct list_head node; 3301033f904SLan Tianyu struct device *dev; 331683058e3SRafael J. Wysocki bool put_online:1; 3321033f904SLan Tianyu }; 3331da177e4SLinus Torvalds 3345f5e4890SMika Westerberg struct acpi_device_properties { 3355f5e4890SMika Westerberg const guid_t *guid; 3365f5e4890SMika Westerberg const union acpi_object *properties; 3375f5e4890SMika Westerberg struct list_head list; 3385f5e4890SMika Westerberg }; 3395f5e4890SMika Westerberg 340ffdcd955SMika Westerberg /* ACPI Device Specific Data (_DSD) */ 341ffdcd955SMika Westerberg struct acpi_device_data { 342ffdcd955SMika Westerberg const union acpi_object *pointer; 3435f5e4890SMika Westerberg struct list_head properties; 344733e6251SMika Westerberg const union acpi_object *of_compatible; 345445b0eb0SRafael J. Wysocki struct list_head subnodes; 346ffdcd955SMika Westerberg }; 347ffdcd955SMika Westerberg 348f028d524SRafael J. Wysocki struct acpi_gpio_mapping; 349f028d524SRafael J. Wysocki 3501033f904SLan Tianyu /* Device */ 3511da177e4SLinus Torvalds struct acpi_device { 352caaa6efbSBjorn Helgaas int device_type; 353caaa6efbSBjorn Helgaas acpi_handle handle; /* no handle for fixed hardware */ 3548a0662d9SRafael J. Wysocki struct fwnode_handle fwnode; 3551da177e4SLinus Torvalds struct acpi_device *parent; 3561da177e4SLinus Torvalds struct list_head children; 3571da177e4SLinus Torvalds struct list_head node; 3581da177e4SLinus Torvalds struct list_head wakeup_list; 359d783156eSRafael J. Wysocki struct list_head del_list; 3601da177e4SLinus Torvalds struct acpi_device_status status; 3611da177e4SLinus Torvalds struct acpi_device_flags flags; 3621da177e4SLinus Torvalds struct acpi_device_pnp pnp; 3631da177e4SLinus Torvalds struct acpi_device_power power; 3641da177e4SLinus Torvalds struct acpi_device_wakeup wakeup; 3651da177e4SLinus Torvalds struct acpi_device_perf performance; 3661da177e4SLinus Torvalds struct acpi_device_dir dir; 367ffdcd955SMika Westerberg struct acpi_device_data data; 368ca589f94SRafael J. Wysocki struct acpi_scan_handler *handler; 3693c2cc7ffSRafael J. Wysocki struct acpi_hotplug_context *hp; 3701da177e4SLinus Torvalds struct acpi_driver *driver; 371f028d524SRafael J. Wysocki const struct acpi_gpio_mapping *driver_gpios; 3721da177e4SLinus Torvalds void *driver_data; 3735b327265SPatrick Mochel struct device dev; 374007ccfcfSRafael J. Wysocki unsigned int physical_node_count; 37540e7fcb1SLan Tianyu unsigned int dep_unmet; 3761033f904SLan Tianyu struct list_head physical_node_list; 3771033f904SLan Tianyu struct mutex physical_node_lock; 378b1c0f99bSRafael J. Wysocki void (*remove)(struct acpi_device *); 3791da177e4SLinus Torvalds }; 3801da177e4SLinus Torvalds 381445b0eb0SRafael J. Wysocki /* Non-device subnode */ 382445b0eb0SRafael J. Wysocki struct acpi_data_node { 383445b0eb0SRafael J. Wysocki const char *name; 384263b4c1aSRafael J. Wysocki acpi_handle handle; 385445b0eb0SRafael J. Wysocki struct fwnode_handle fwnode; 386dfa672fbSMika Westerberg struct fwnode_handle *parent; 387445b0eb0SRafael J. Wysocki struct acpi_device_data data; 388445b0eb0SRafael J. Wysocki struct list_head sibling; 389263b4c1aSRafael J. Wysocki struct kobject kobj; 390263b4c1aSRafael J. Wysocki struct completion kobj_done; 391445b0eb0SRafael J. Wysocki }; 392445b0eb0SRafael J. Wysocki 393db3e50f3SSakari Ailus extern const struct fwnode_operations acpi_device_fwnode_ops; 394db3e50f3SSakari Ailus extern const struct fwnode_operations acpi_data_fwnode_ops; 395db3e50f3SSakari Ailus extern const struct fwnode_operations acpi_static_fwnode_ops; 396db3e50f3SSakari Ailus 3979e987b70SJohn Hubbard bool is_acpi_device_node(const struct fwnode_handle *fwnode); 3989e987b70SJohn Hubbard bool is_acpi_data_node(const struct fwnode_handle *fwnode); 3999e987b70SJohn Hubbard 4008b9d6802SSakari Ailus static inline bool is_acpi_node(const struct fwnode_handle *fwnode) 4018a0662d9SRafael J. Wysocki { 4029e987b70SJohn Hubbard return (is_acpi_device_node(fwnode) || is_acpi_data_node(fwnode)); 4038a0662d9SRafael J. Wysocki } 4048a0662d9SRafael J. Wysocki 4058b9d6802SSakari Ailus #define to_acpi_device_node(__fwnode) \ 4068b9d6802SSakari Ailus ({ \ 4078b9d6802SSakari Ailus typeof(__fwnode) __to_acpi_device_node_fwnode = __fwnode; \ 4088b9d6802SSakari Ailus \ 4098b9d6802SSakari Ailus is_acpi_device_node(__to_acpi_device_node_fwnode) ? \ 4108b9d6802SSakari Ailus container_of(__to_acpi_device_node_fwnode, \ 4118b9d6802SSakari Ailus struct acpi_device, fwnode) : \ 4128b9d6802SSakari Ailus NULL; \ 4138b9d6802SSakari Ailus }) 4148a0662d9SRafael J. Wysocki 4158b9d6802SSakari Ailus #define to_acpi_data_node(__fwnode) \ 4168b9d6802SSakari Ailus ({ \ 4178b9d6802SSakari Ailus typeof(__fwnode) __to_acpi_data_node_fwnode = __fwnode; \ 4188b9d6802SSakari Ailus \ 4198b9d6802SSakari Ailus is_acpi_data_node(__to_acpi_data_node_fwnode) ? \ 4208b9d6802SSakari Ailus container_of(__to_acpi_data_node_fwnode, \ 4218b9d6802SSakari Ailus struct acpi_data_node, fwnode) : \ 4228b9d6802SSakari Ailus NULL; \ 4238b9d6802SSakari Ailus }) 4243a7a2ab8SRafael J. Wysocki 4258b9d6802SSakari Ailus static inline bool is_acpi_static_node(const struct fwnode_handle *fwnode) 426db89b4f0SPavel Machek { 427db3e50f3SSakari Ailus return !IS_ERR_OR_NULL(fwnode) && 428db3e50f3SSakari Ailus fwnode->ops == &acpi_static_fwnode_ops; 429db89b4f0SPavel Machek } 430d43ec68eSPatrick Mochel 4318b9d6802SSakari Ailus static inline bool acpi_data_node_match(const struct fwnode_handle *fwnode, 432613e9721SAdam Thomson const char *name) 433613e9721SAdam Thomson { 434613e9721SAdam Thomson return is_acpi_data_node(fwnode) ? 435613e9721SAdam Thomson (!strcmp(to_acpi_data_node(fwnode)->name, name)) : false; 436613e9721SAdam Thomson } 437613e9721SAdam Thomson 43825db115bSRafael J. Wysocki static inline struct fwnode_handle *acpi_fwnode_handle(struct acpi_device *adev) 4393c2cc7ffSRafael J. Wysocki { 440ba574dc8SRafael J. Wysocki return &adev->fwnode; 4413c2cc7ffSRafael J. Wysocki } 4423c2cc7ffSRafael J. Wysocki 4433c2cc7ffSRafael J. Wysocki static inline void *acpi_driver_data(struct acpi_device *d) 4443c2cc7ffSRafael J. Wysocki { 4453c2cc7ffSRafael J. Wysocki return d->driver_data; 4465d513205SRafael J. Wysocki } 4475d513205SRafael J. Wysocki 4485d513205SRafael J. Wysocki #define to_acpi_device(d) container_of(d, struct acpi_device, dev) 4495d513205SRafael J. Wysocki #define to_acpi_driver(d) container_of(d, struct acpi_driver, drv) 4505d513205SRafael J. Wysocki 45155955aadSDavid Brownell static inline void acpi_set_device_status(struct acpi_device *adev, u32 sta) 45255955aadSDavid Brownell { 45355955aadSDavid Brownell *((u32 *)&adev->status) = sta; 4541da177e4SLinus Torvalds } 4551da177e4SLinus Torvalds 4561da177e4SLinus Torvalds static inline void acpi_set_hp_context(struct acpi_device *adev, 4571da177e4SLinus Torvalds struct acpi_hotplug_context *hp) 4581da177e4SLinus Torvalds { 4591da177e4SLinus Torvalds hp->self = adev; 4601da177e4SLinus Torvalds adev->hp = hp; 4611da177e4SLinus Torvalds } 4621da177e4SLinus Torvalds 4631da177e4SLinus Torvalds void acpi_initialize_hp_context(struct acpi_device *adev, 4641da177e4SLinus Torvalds struct acpi_hotplug_context *hp, 4651da177e4SLinus Torvalds int (*notify)(struct acpi_device *, u32), 4661da177e4SLinus Torvalds void (*uevent)(struct acpi_device *, u32)); 46799e0d2fcSGreg Kroah-Hartman 468962ce8caSZhang Rui /* acpi_device.dev.bus == &acpi_bus_type */ 4698e4319c4SBob Moore extern struct bus_type acpi_bus_type; 47020733939SZhang Rui 47172013795SLan Tianyu /* 47272013795SLan Tianyu * Events 4739ee85241SZhang Rui * ------ 4749ee85241SZhang Rui */ 4759ee85241SZhang Rui 4766bd00a61SShaohua Li struct acpi_bus_event { 4771da177e4SLinus Torvalds struct list_head node; 4781da177e4SLinus Torvalds acpi_device_class device_class; 4791da177e4SLinus Torvalds acpi_bus_id bus_id; 4801da177e4SLinus Torvalds u32 type; 4811da177e4SLinus Torvalds u32 data; 48278ea4639SRafael J. Wysocki }; 48378ea4639SRafael J. Wysocki 484402ac536SBjorn Helgaas extern struct kobject *acpi_kobj; 485402ac536SBjorn Helgaas extern int acpi_bus_generate_netlink_event(const char*, const char*, u8, int); 4861da177e4SLinus Torvalds void acpi_bus_private_data_handler(acpi_handle, void *); 4879ce4e607SRafael J. Wysocki int acpi_bus_get_private_data(acpi_handle, void **); 4881da177e4SLinus Torvalds int acpi_bus_attach_private_data(acpi_handle, void *); 48996bfd3ceSRafael J. Wysocki void acpi_bus_detach_private_data(acpi_handle); 490ad0c3b0eSRafael J. Wysocki extern int acpi_notifier_call_chain(struct acpi_device *, u32, u32); 491078eb126SRafael J. Wysocki extern int register_acpi_notifier(struct notifier_block *); 4929ce4e607SRafael J. Wysocki extern int unregister_acpi_notifier(struct notifier_block *); 493b9e95fc6SRafael J. Wysocki 49425eed407SRafael J. Wysocki /* 4952bb3a2bfSAaron Lu * External Functions 4963737b2b1SRafael J. Wysocki */ 497ec4602a9SRafael J. Wysocki 498ec4602a9SRafael J. Wysocki int acpi_bus_get_device(acpi_handle handle, struct acpi_device **device); 499eb9d0fe4SRafael J. Wysocki struct acpi_device *acpi_bus_get_acpi_device(acpi_handle handle); 500ec4602a9SRafael J. Wysocki void acpi_bus_put_acpi_device(struct acpi_device *adev); 501ec4602a9SRafael J. Wysocki acpi_status acpi_bus_get_status_handle(acpi_handle handle, 502ec4602a9SRafael J. Wysocki unsigned long long *sta); 5039ce4e607SRafael J. Wysocki int acpi_bus_get_status(struct acpi_device *device); 5043757b948SRafael J. Wysocki 5053757b948SRafael J. Wysocki int acpi_bus_set_power(acpi_handle handle, int state); 506e525506fSRafael J. Wysocki const char *acpi_power_state_string(int state); 5071da177e4SLinus Torvalds int acpi_device_set_power(struct acpi_device *device, int state); 5081da177e4SLinus Torvalds int acpi_bus_init_power(struct acpi_device *device); 5091da177e4SLinus Torvalds int acpi_device_fix_up_power(struct acpi_device *device); 5101da177e4SLinus Torvalds int acpi_bus_update_power(acpi_handle handle, int *state_p); 5111da177e4SLinus Torvalds int acpi_device_update_power(struct acpi_device *device, int *state_p); 5121da177e4SLinus Torvalds bool acpi_bus_power_manageable(acpi_handle handle); 5134533771cSMika Westerberg int acpi_device_power_add_dependent(struct acpi_device *adev, 5144533771cSMika Westerberg struct device *dev); 5154533771cSMika Westerberg void acpi_device_power_remove_dependent(struct acpi_device *adev, 5164533771cSMika Westerberg struct device *dev); 5171da177e4SLinus Torvalds 5181da177e4SLinus Torvalds #ifdef CONFIG_PM 5191da177e4SLinus Torvalds bool acpi_bus_can_wakeup(acpi_handle handle); 5201da177e4SLinus Torvalds #else 5211da177e4SLinus Torvalds static inline bool acpi_bus_can_wakeup(acpi_handle handle) { return false; } 5221da177e4SLinus Torvalds #endif 5231da177e4SLinus Torvalds 5241da177e4SLinus Torvalds void acpi_scan_lock_acquire(void); 5251da177e4SLinus Torvalds void acpi_scan_lock_release(void); 526e525506fSRafael J. Wysocki void acpi_lock_hp_context(void); 527e525506fSRafael J. Wysocki void acpi_unlock_hp_context(void); 528ca589f94SRafael J. Wysocki int acpi_scan_add_handler(struct acpi_scan_handler *handler); 5291da177e4SLinus Torvalds int acpi_bus_register_driver(struct acpi_driver *driver); 53006ea8e08SBjorn Helgaas void acpi_bus_unregister_driver(struct acpi_driver *driver); 531b8bd759aSRafael J. Wysocki int acpi_bus_scan(acpi_handle handle); 532bfee26dbSRafael J. Wysocki void acpi_bus_trim(struct acpi_device *start); 533c8f7a62cSLen Brown acpi_status acpi_bus_get_ejd(acpi_handle handle, acpi_handle * ejd); 5348c8eb78fSThomas Renninger int acpi_match_device_ids(struct acpi_device *device, 5358c8eb78fSThomas Renninger const struct acpi_device_id *ids); 53651ede5d9SDan O'Donovan void acpi_set_modalias(struct acpi_device *adev, const char *default_id, 53751ede5d9SDan O'Donovan char *modalias, size_t len); 5381da177e4SLinus Torvalds int acpi_create_dir(struct acpi_device *); 5391da177e4SLinus Torvalds void acpi_remove_dir(struct acpi_device *); 5401da177e4SLinus Torvalds 541202317a5SRafael J. Wysocki static inline bool acpi_device_enumerated(struct acpi_device *adev) 542202317a5SRafael J. Wysocki { 543202317a5SRafael J. Wysocki return adev && adev->flags.initialized && adev->flags.visited; 544202317a5SRafael J. Wysocki } 545202317a5SRafael J. Wysocki 5460d2cf8f5SMika Westerberg /** 5470d2cf8f5SMika Westerberg * module_acpi_driver(acpi_driver) - Helper macro for registering an ACPI driver 5480d2cf8f5SMika Westerberg * @__acpi_driver: acpi_driver struct 5490d2cf8f5SMika Westerberg * 5500d2cf8f5SMika Westerberg * Helper macro for ACPI drivers which do not do anything special in module 5510d2cf8f5SMika Westerberg * init/exit. This eliminates a lot of boilerplate. Each module may only 5520d2cf8f5SMika Westerberg * use this macro once, and calling it replaces module_init() and module_exit() 5530d2cf8f5SMika Westerberg */ 5540d2cf8f5SMika Westerberg #define module_acpi_driver(__acpi_driver) \ 5550d2cf8f5SMika Westerberg module_driver(__acpi_driver, acpi_bus_register_driver, \ 5560d2cf8f5SMika Westerberg acpi_bus_unregister_driver) 5570d2cf8f5SMika Westerberg 5584e10d12aSDavid Shaohua Li /* 5594e10d12aSDavid Shaohua Li * Bind physical devices with ACPI devices 5604e10d12aSDavid Shaohua Li */ 5614e10d12aSDavid Shaohua Li struct acpi_bus_type { 5624e10d12aSDavid Shaohua Li struct list_head list; 56353540098SRafael J. Wysocki const char *name; 56453540098SRafael J. Wysocki bool (*match)(struct device *dev); 565e3f02c52SRafael J. Wysocki struct acpi_device * (*find_companion)(struct device *); 56611909ca1SRafael J. Wysocki void (*setup)(struct device *); 56711909ca1SRafael J. Wysocki void (*cleanup)(struct device *); 5684e10d12aSDavid Shaohua Li }; 5694e10d12aSDavid Shaohua Li int register_acpi_bus_type(struct acpi_bus_type *); 5704e10d12aSDavid Shaohua Li int unregister_acpi_bus_type(struct acpi_bus_type *); 571f1b1dc84SZhang Rui int acpi_bind_one(struct device *dev, struct acpi_device *adev); 572f1b1dc84SZhang Rui int acpi_unbind_one(struct device *dev); 57322c13f9dSThomas Renninger 57476d56de5SAlex Chiang struct acpi_pci_root { 57576d56de5SAlex Chiang struct acpi_device * device; 57676d56de5SAlex Chiang struct pci_bus *bus; 57776d56de5SAlex Chiang u16 segment; 5786ad95513SBjorn Helgaas struct resource secondary; /* downstream bus range */ 57976d56de5SAlex Chiang 58076d56de5SAlex Chiang u32 osc_support_set; /* _OSC state of support bits */ 58176d56de5SAlex Chiang u32 osc_control_set; /* _OSC state of control bits */ 582f4b57a3bSJiang Liu phys_addr_t mcfg_addr; 58376d56de5SAlex Chiang }; 58476d56de5SAlex Chiang 5854e10d12aSDavid Shaohua Li /* helper */ 586d9fef0c4SRafael J. Wysocki 587b84f196dSSuthikulpanit, Suravee bool acpi_dma_supported(struct acpi_device *adev); 588b84f196dSSuthikulpanit, Suravee enum dev_dma_attr acpi_get_dma_attr(struct acpi_device *adev); 589c04ac679SLorenzo Pieralisi int acpi_dma_get_range(struct device *dev, u64 *dma_addr, u64 *offset, 590c04ac679SLorenzo Pieralisi u64 *size); 591b8e069a2SLorenzo Pieralisi int acpi_dma_configure_id(struct device *dev, enum dev_dma_attr attr, 592b8e069a2SLorenzo Pieralisi const u32 *input_id); 593b8e069a2SLorenzo Pieralisi static inline int acpi_dma_configure(struct device *dev, 594b8e069a2SLorenzo Pieralisi enum dev_dma_attr attr) 595b8e069a2SLorenzo Pieralisi { 596b8e069a2SLorenzo Pieralisi return acpi_dma_configure_id(dev, attr, NULL); 597b8e069a2SLorenzo Pieralisi } 598d9fef0c4SRafael J. Wysocki struct acpi_device *acpi_find_child_device(struct acpi_device *parent, 599d9fef0c4SRafael J. Wysocki u64 address, bool check_children); 60027558203SAlexander Chiang int acpi_is_root_bridge(acpi_handle); 60176d56de5SAlex Chiang struct acpi_pci_root *acpi_pci_find_root(acpi_handle handle); 6024e10d12aSDavid Shaohua Li 603b67ea761SRafael J. Wysocki int acpi_enable_wakeup_device_power(struct acpi_device *dev, int state); 604b67ea761SRafael J. Wysocki int acpi_disable_wakeup_device_power(struct acpi_device *dev); 605b67ea761SRafael J. Wysocki 606b7ecf663SHans de Goede #ifdef CONFIG_X86 607b7ecf663SHans de Goede bool acpi_device_always_present(struct acpi_device *adev); 608b7ecf663SHans de Goede #else 609b7ecf663SHans de Goede static inline bool acpi_device_always_present(struct acpi_device *adev) 610b7ecf663SHans de Goede { 611b7ecf663SHans de Goede return false; 612b7ecf663SHans de Goede } 613b7ecf663SHans de Goede #endif 614b7ecf663SHans de Goede 615aa338601SRafael J. Wysocki #ifdef CONFIG_PM 61633e4f80eSRafael J. Wysocki void acpi_pm_wakeup_event(struct device *dev); 617c072530fSRafael J. Wysocki acpi_status acpi_add_pm_notifier(struct acpi_device *adev, struct device *dev, 61864fd1c70SRafael J. Wysocki void (*func)(struct acpi_device_wakeup_context *context)); 619c072530fSRafael J. Wysocki acpi_status acpi_remove_pm_notifier(struct acpi_device *adev); 6208370c2dcSRafael J. Wysocki bool acpi_pm_device_can_wakeup(struct device *dev); 621ee85f543SHuang Ying int acpi_pm_device_sleep_state(struct device *, int *, int); 6224d183d04SRafael J. Wysocki int acpi_pm_set_device_wakeup(struct device *dev, bool enable); 6231ba51a7cSRafael J. Wysocki int acpi_pm_set_bridge_wakeup(struct device *dev, bool enable); 624761afb86SRafael J. Wysocki #else 62533e4f80eSRafael J. Wysocki static inline void acpi_pm_wakeup_event(struct device *dev) 62633e4f80eSRafael J. Wysocki { 62733e4f80eSRafael J. Wysocki } 628ec2cd81cSRafael J. Wysocki static inline acpi_status acpi_add_pm_notifier(struct acpi_device *adev, 629c072530fSRafael J. Wysocki struct device *dev, 63033e4f80eSRafael J. Wysocki void (*func)(struct acpi_device_wakeup_context *context)) 631ec2cd81cSRafael J. Wysocki { 632ec2cd81cSRafael J. Wysocki return AE_SUPPORT; 633ec2cd81cSRafael J. Wysocki } 634c072530fSRafael J. Wysocki static inline acpi_status acpi_remove_pm_notifier(struct acpi_device *adev) 635ec2cd81cSRafael J. Wysocki { 636ec2cd81cSRafael J. Wysocki return AE_SUPPORT; 637ec2cd81cSRafael J. Wysocki } 6388370c2dcSRafael J. Wysocki static inline bool acpi_pm_device_can_wakeup(struct device *dev) 6398370c2dcSRafael J. Wysocki { 6408370c2dcSRafael J. Wysocki return false; 6418370c2dcSRafael J. Wysocki } 642b25c77efSRafael J. Wysocki static inline int acpi_pm_device_sleep_state(struct device *d, int *p, int m) 643296699deSRafael J. Wysocki { 644296699deSRafael J. Wysocki if (p) 645296699deSRafael J. Wysocki *p = ACPI_STATE_D0; 646b25c77efSRafael J. Wysocki 6478ad928d5SRafael J. Wysocki return (m >= ACPI_STATE_D0 && m <= ACPI_STATE_D3_COLD) ? 6488ad928d5SRafael J. Wysocki m : ACPI_STATE_D0; 649296699deSRafael J. Wysocki } 6504d183d04SRafael J. Wysocki static inline int acpi_pm_set_device_wakeup(struct device *dev, bool enable) 651f7a1b860SDavid Howells { 652f7a1b860SDavid Howells return -ENODEV; 653f7a1b860SDavid Howells } 6541ba51a7cSRafael J. Wysocki static inline int acpi_pm_set_bridge_wakeup(struct device *dev, bool enable) 6551ba51a7cSRafael J. Wysocki { 6561ba51a7cSRafael J. Wysocki return -ENODEV; 6571ba51a7cSRafael J. Wysocki } 658761afb86SRafael J. Wysocki #endif 659fd4aff1aSShaohua Li 660ad5a449bSDexuan Cui #ifdef CONFIG_ACPI_SYSTEM_POWER_STATES_SUPPORT 661ad5a449bSDexuan Cui bool acpi_sleep_state_supported(u8 sleep_state); 662ad5a449bSDexuan Cui #else 663ad5a449bSDexuan Cui static inline bool acpi_sleep_state_supported(u8 sleep_state) { return false; } 664ad5a449bSDexuan Cui #endif 665ad5a449bSDexuan Cui 66699926a8cSDavid Rientjes #ifdef CONFIG_ACPI_SLEEP 66799926a8cSDavid Rientjes u32 acpi_target_system_state(void); 66899926a8cSDavid Rientjes #else 66999926a8cSDavid Rientjes static inline u32 acpi_target_system_state(void) { return ACPI_STATE_S0; } 67099926a8cSDavid Rientjes #endif 67199926a8cSDavid Rientjes 672078eb126SRafael J. Wysocki static inline bool acpi_device_power_manageable(struct acpi_device *adev) 673078eb126SRafael J. Wysocki { 674078eb126SRafael J. Wysocki return adev->flags.power_manageable; 675078eb126SRafael J. Wysocki } 676078eb126SRafael J. Wysocki 677078eb126SRafael J. Wysocki static inline bool acpi_device_can_wakeup(struct acpi_device *adev) 678078eb126SRafael J. Wysocki { 679078eb126SRafael J. Wysocki return adev->wakeup.flags.valid; 680078eb126SRafael J. Wysocki } 681078eb126SRafael J. Wysocki 6821399dfcdSAaron Lu static inline bool acpi_device_can_poweroff(struct acpi_device *adev) 6831399dfcdSAaron Lu { 684cd7f84c0SKen Xue return adev->power.states[ACPI_STATE_D3_COLD].flags.valid || 685cd7f84c0SKen Xue ((acpi_gbl_FADT.header.revision < 6) && 686cd7f84c0SKen Xue adev->power.states[ACPI_STATE_D3_HOT].flags.explicit_set); 6871399dfcdSAaron Lu } 6881399dfcdSAaron Lu 68935009c80SAndy Shevchenko bool acpi_dev_hid_uid_match(struct acpi_device *adev, const char *hid2, const char *uid2); 69035009c80SAndy Shevchenko 691a814dcc2SAndy Shevchenko struct acpi_device * 692a814dcc2SAndy Shevchenko acpi_dev_get_first_match_dev(const char *hid, const char *uid, s64 hrv); 693a814dcc2SAndy Shevchenko 694fe066621SYueHaibing static inline void acpi_dev_put(struct acpi_device *adev) 695fe066621SYueHaibing { 696fe066621SYueHaibing put_device(&adev->dev); 697fe066621SYueHaibing } 69866886d6fSMatthew Garrett #else /* CONFIG_ACPI */ 69966886d6fSMatthew Garrett 7007ae30986SLen Brown static inline int register_acpi_bus_type(void *bus) { return 0; } 7017ae30986SLen Brown static inline int unregister_acpi_bus_type(void *bus) { return 0; } 70266886d6fSMatthew Garrett 70376f58584SLen Brown #endif /* CONFIG_ACPI */ 7041da177e4SLinus Torvalds 7051da177e4SLinus Torvalds #endif /*__ACPI_BUS_H__*/ 706