blob: ef0ae8aaa56771a3a1c4e00a4712f55cbdda9114 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * acpi_bus.h - ACPI Bus Driver ($Revision: 22 $)
3 *
4 * Copyright (C) 2001, 2002 Andy Grover <andrew.grover@intel.com>
5 * Copyright (C) 2001, 2002 Paul Diefenbaugh <paul.s.diefenbaugh@intel.com>
6 *
7 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
8 *
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or (at
12 * your option) any later version.
13 *
14 * This program is distributed in the hope that it will be useful, but
15 * WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * General Public License for more details.
18 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070019 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
20 */
21
22#ifndef __ACPI_BUS_H__
23#define __ACPI_BUS_H__
24
Patrick Mochel5b327262006-05-10 10:33:00 -040025#include <linux/device.h>
Rafael J. Wysocki8a0662d2014-11-04 14:03:59 +010026#include <linux/property.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070027
Linus Torvalds1da177e2005-04-16 15:20:36 -070028/* TBD: Make dynamic */
29#define ACPI_MAX_HANDLES 10
30struct acpi_handle_list {
Len Brown4be44fc2005-08-05 00:44:28 -040031 u32 count;
32 acpi_handle handles[ACPI_MAX_HANDLES];
Linus Torvalds1da177e2005-04-16 15:20:36 -070033};
34
Linus Torvalds1da177e2005-04-16 15:20:36 -070035/* acpi_utils.h */
36acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -040037acpi_extract_package(union acpi_object *package,
38 struct acpi_buffer *format, struct acpi_buffer *buffer);
Linus Torvalds1da177e2005-04-16 15:20:36 -070039acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -040040acpi_evaluate_integer(acpi_handle handle,
41 acpi_string pathname,
Matthew Wilcox27663c52008-10-10 02:22:59 -040042 struct acpi_object_list *arguments, unsigned long long *data);
Linus Torvalds1da177e2005-04-16 15:20:36 -070043acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -040044acpi_evaluate_reference(acpi_handle handle,
45 acpi_string pathname,
46 struct acpi_object_list *arguments,
47 struct acpi_handle_list *list);
Toshi Kani275c58d2012-05-23 20:25:19 -060048acpi_status
Jiang Liu05730c12014-02-19 14:02:15 +080049acpi_evaluate_ost(acpi_handle handle, u32 source_event, u32 status_code,
50 struct acpi_buffer *status_buf);
Linus Torvalds1da177e2005-04-16 15:20:36 -070051
Matthew Garrett38ac0f12012-05-11 16:08:26 +080052acpi_status
Feng Tang8ede06a2012-08-21 09:56:58 +080053acpi_get_physical_device_location(acpi_handle handle, struct acpi_pld_info **pld);
Jiang Liu952c63e2013-06-29 00:24:38 +080054
55bool acpi_has_method(acpi_handle handle, char *name);
Jiang Liu0db98202013-06-29 00:24:39 +080056acpi_status acpi_execute_simple_method(acpi_handle handle, char *method,
57 u64 arg);
Jiang Liu7d2421f2013-06-29 00:24:40 +080058acpi_status acpi_evaluate_ej0(acpi_handle handle);
59acpi_status acpi_evaluate_lck(acpi_handle handle, int lock);
Jiang Liuebf4df82013-06-29 00:24:41 +080060bool acpi_ata_match(acpi_handle handle);
61bool acpi_bay_match(acpi_handle handle);
62bool acpi_dock_match(acpi_handle handle);
Jiang Liu952c63e2013-06-29 00:24:38 +080063
Jerry Hoemannc7e16e52016-04-11 15:02:26 -070064bool acpi_check_dsm(acpi_handle handle, const u8 *uuid, u64 rev, u64 funcs);
Jiang Liua65ac522013-12-19 20:38:10 +080065union acpi_object *acpi_evaluate_dsm(acpi_handle handle, const u8 *uuid,
Jerry Hoemannc7e16e52016-04-11 15:02:26 -070066 u64 rev, u64 func, union acpi_object *argv4);
Jiang Liua65ac522013-12-19 20:38:10 +080067
68static inline union acpi_object *
Jerry Hoemannc7e16e52016-04-11 15:02:26 -070069acpi_evaluate_dsm_typed(acpi_handle handle, const u8 *uuid, u64 rev, u64 func,
Jiang Liua65ac522013-12-19 20:38:10 +080070 union acpi_object *argv4, acpi_object_type type)
71{
72 union acpi_object *obj;
73
74 obj = acpi_evaluate_dsm(handle, uuid, rev, func, argv4);
75 if (obj && obj->type != type) {
76 ACPI_FREE(obj);
77 obj = NULL;
78 }
79
80 return obj;
81}
82
83#define ACPI_INIT_DSM_ARGV4(cnt, eles) \
84 { \
85 .package.type = ACPI_TYPE_PACKAGE, \
86 .package.count = (cnt), \
87 .package.elements = (eles) \
88 }
89
Lukas Wunnerc68ae33e2016-03-24 13:15:20 +010090bool acpi_dev_found(const char *hid);
Lukas Wunner2d12b6b2015-11-25 21:19:55 +010091
Len Brown76f58582005-08-24 12:10:49 -040092#ifdef CONFIG_ACPI
Linus Torvalds1da177e2005-04-16 15:20:36 -070093
94#include <linux/proc_fs.h>
95
96#define ACPI_BUS_FILE_ROOT "acpi"
Len Brown4be44fc2005-08-05 00:44:28 -040097extern struct proc_dir_entry *acpi_root_dir;
Linus Torvalds1da177e2005-04-16 15:20:36 -070098
Linus Torvalds1da177e2005-04-16 15:20:36 -070099enum acpi_bus_device_type {
Len Brown4be44fc2005-08-05 00:44:28 -0400100 ACPI_BUS_TYPE_DEVICE = 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101 ACPI_BUS_TYPE_POWER,
102 ACPI_BUS_TYPE_PROCESSOR,
103 ACPI_BUS_TYPE_THERMAL,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700104 ACPI_BUS_TYPE_POWER_BUTTON,
105 ACPI_BUS_TYPE_SLEEP_BUTTON,
106 ACPI_BUS_DEVICE_TYPE_COUNT
107};
108
109struct acpi_driver;
110struct acpi_device;
111
Linus Torvalds1da177e2005-04-16 15:20:36 -0700112/*
Rafael J. Wysockica589f92013-01-30 14:27:29 +0100113 * ACPI Scan Handler
114 * -----------------
115 */
116
Rafael J. Wysockia33ec392013-03-03 23:05:29 +0100117struct acpi_hotplug_profile {
Rafael J. Wysocki3f8055c2013-03-03 23:08:16 +0100118 struct kobject kobj;
Rafael J. Wysocki3338db02013-11-22 21:55:20 +0100119 int (*scan_dependent)(struct acpi_device *adev);
Rafael J. Wysocki8ab17fc2014-09-21 02:58:18 +0200120 void (*notify_online)(struct acpi_device *adev);
Rafael J. Wysockid22ddcb2013-12-29 15:25:35 +0100121 bool enabled:1;
122 bool demand_offline:1;
Rafael J. Wysockia33ec392013-03-03 23:05:29 +0100123};
124
Rafael J. Wysocki3f8055c2013-03-03 23:08:16 +0100125static inline struct acpi_hotplug_profile *to_acpi_hotplug_profile(
126 struct kobject *kobj)
127{
128 return container_of(kobj, struct acpi_hotplug_profile, kobj);
129}
130
Rafael J. Wysockica589f92013-01-30 14:27:29 +0100131struct acpi_scan_handler {
132 const struct acpi_device_id *ids;
133 struct list_head list_node;
Rasmus Villemoes636c19d2015-09-09 23:59:41 +0200134 bool (*match)(const char *idstr, const struct acpi_device_id **matchid);
Rafael J. Wysockica589f92013-01-30 14:27:29 +0100135 int (*attach)(struct acpi_device *dev, const struct acpi_device_id *id);
136 void (*detach)(struct acpi_device *dev);
Rafael J. Wysocki9cb32ac2014-02-11 00:35:46 +0100137 void (*bind)(struct device *phys_dev);
138 void (*unbind)(struct device *phys_dev);
Rafael J. Wysockia33ec392013-03-03 23:05:29 +0100139 struct acpi_hotplug_profile hotplug;
Rafael J. Wysockica589f92013-01-30 14:27:29 +0100140};
141
142/*
Rafael J. Wysocki3c2cc7f2014-02-06 17:31:37 +0100143 * ACPI Hotplug Context
144 * --------------------
145 */
146
147struct acpi_hotplug_context {
148 struct acpi_device *self;
Rafael J. Wysockibe27b3d2014-02-21 01:10:27 +0100149 int (*notify)(struct acpi_device *, u32);
150 void (*uevent)(struct acpi_device *, u32);
Rafael J. Wysocki59b42fa2014-02-21 01:08:51 +0100151 void (*fixup)(struct acpi_device *);
Rafael J. Wysocki3c2cc7f2014-02-06 17:31:37 +0100152};
153
154/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700155 * ACPI Driver
156 * -----------
157 */
158
Len Brown4be44fc2005-08-05 00:44:28 -0400159typedef int (*acpi_op_add) (struct acpi_device * device);
Rafael J. Wysocki51fac832013-01-24 00:24:48 +0100160typedef int (*acpi_op_remove) (struct acpi_device * device);
Bjorn Helgaas46ec8592009-03-30 17:48:13 +0000161typedef void (*acpi_op_notify) (struct acpi_device * device, u32 event);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700162
163struct acpi_device_ops {
Len Brown4be44fc2005-08-05 00:44:28 -0400164 acpi_op_add add;
165 acpi_op_remove remove;
Bjorn Helgaas46ec8592009-03-30 17:48:13 +0000166 acpi_op_notify notify;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700167};
168
Bjorn Helgaas6d278132009-04-30 09:35:37 -0600169#define ACPI_DRIVER_ALL_NOTIFY_EVENTS 0x1 /* system AND device events */
170
Linus Torvalds1da177e2005-04-16 15:20:36 -0700171struct acpi_driver {
Len Brown4be44fc2005-08-05 00:44:28 -0400172 char name[80];
173 char class[80];
Thomas Renninger8c8eb782007-07-23 14:43:32 +0200174 const struct acpi_device_id *ids; /* Supported Hardware IDs */
Bjorn Helgaas6d278132009-04-30 09:35:37 -0600175 unsigned int flags;
Len Brown4be44fc2005-08-05 00:44:28 -0400176 struct acpi_device_ops ops;
Patrick Mocheld43ec682006-12-07 20:56:23 +0800177 struct device_driver drv;
Patrick Mochel1890a972006-12-07 20:56:31 +0800178 struct module *owner;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700179};
180
181/*
182 * ACPI Device
183 * -----------
184 */
185
186/* Status (_STA) */
187
188struct acpi_device_status {
Len Brown4be44fc2005-08-05 00:44:28 -0400189 u32 present:1;
190 u32 enabled:1;
191 u32 show_in_ui:1;
192 u32 functional:1;
193 u32 battery_present:1;
194 u32 reserved:27;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700195};
196
Linus Torvalds1da177e2005-04-16 15:20:36 -0700197/* Flags */
198
199struct acpi_device_flags {
Len Brown4be44fc2005-08-05 00:44:28 -0400200 u32 dynamic_status:1;
Len Brown4be44fc2005-08-05 00:44:28 -0400201 u32 removable:1;
202 u32 ejectable:1;
Len Brown4be44fc2005-08-05 00:44:28 -0400203 u32 power_manageable:1;
Rafael J. Wysocki209d3b12012-12-21 00:36:48 +0100204 u32 match_driver:1;
Rafael J. Wysocki202317a2013-11-22 21:54:37 +0100205 u32 initialized:1;
206 u32 visited:1;
Rafael J. Wysocki3c2cc7f2014-02-06 17:31:37 +0100207 u32 hotplug_notify:1;
Rafael J. Wysocki1e2380c2014-02-16 01:51:01 +0100208 u32 is_dock_station:1;
Rafael J. Wysocki5c53b262015-05-05 15:43:07 +0200209 u32 of_compatible_ok:1;
Suthikulpanit, Suraveed0562672015-06-10 11:08:52 -0500210 u32 coherent_dma:1;
211 u32 cca_seen:1;
212 u32 reserved:20;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700213};
214
Linus Torvalds1da177e2005-04-16 15:20:36 -0700215/* File System */
216
217struct acpi_device_dir {
Len Brown4be44fc2005-08-05 00:44:28 -0400218 struct proc_dir_entry *entry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700219};
220
221#define acpi_device_dir(d) ((d)->dir.entry)
222
Linus Torvalds1da177e2005-04-16 15:20:36 -0700223/* Plug and Play */
224
Zhao Yakui24c5c4c2009-05-21 16:25:35 +0800225typedef char acpi_bus_id[8];
Len Brown4be44fc2005-08-05 00:44:28 -0400226typedef unsigned long acpi_bus_address;
Len Brown4be44fc2005-08-05 00:44:28 -0400227typedef char acpi_device_name[40];
228typedef char acpi_device_class[20];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700229
Bjorn Helgaas7f47fa62009-09-21 13:35:19 -0600230struct acpi_hardware_id {
231 struct list_head list;
Rasmus Villemoes844142c2015-09-09 23:59:42 +0200232 const char *id;
Bjorn Helgaas7f47fa62009-09-21 13:35:19 -0600233};
234
Toshi Kanid4e1a692013-03-04 21:30:41 +0000235struct acpi_pnp_type {
236 u32 hardware_id:1;
237 u32 bus_address:1;
Rafael J. Wysocki549e6842014-05-30 04:26:18 +0200238 u32 platform_id:1;
239 u32 reserved:29;
Toshi Kanid4e1a692013-03-04 21:30:41 +0000240};
241
Linus Torvalds1da177e2005-04-16 15:20:36 -0700242struct acpi_device_pnp {
Toshi Kanid4e1a692013-03-04 21:30:41 +0000243 acpi_bus_id bus_id; /* Object name */
244 struct acpi_pnp_type type; /* ID type */
Len Brown4be44fc2005-08-05 00:44:28 -0400245 acpi_bus_address bus_address; /* _ADR */
Toshi Kanid4e1a692013-03-04 21:30:41 +0000246 char *unique_id; /* _UID */
Bjorn Helgaas7f47fa62009-09-21 13:35:19 -0600247 struct list_head ids; /* _HID and _CIDs */
Len Brown4be44fc2005-08-05 00:44:28 -0400248 acpi_device_name device_name; /* Driver-determined */
249 acpi_device_class device_class; /* " */
Lance Ortizd1efe3c2012-10-02 12:43:23 -0600250 union acpi_object *str_obj; /* unicode string for _STR method */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700251};
252
253#define acpi_device_bid(d) ((d)->pnp.bus_id)
254#define acpi_device_adr(d) ((d)->pnp.bus_address)
Thomas Renninger620e1122010-10-01 10:54:00 +0200255const char *acpi_device_hid(struct acpi_device *device);
Adrian Hunter359597c2015-03-17 11:48:30 +0200256#define acpi_device_uid(d) ((d)->pnp.unique_id)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700257#define acpi_device_name(d) ((d)->pnp.device_name)
258#define acpi_device_class(d) ((d)->pnp.device_class)
259
Linus Torvalds1da177e2005-04-16 15:20:36 -0700260/* Power Management */
261
262struct acpi_device_power_flags {
Len Brown4be44fc2005-08-05 00:44:28 -0400263 u32 explicit_get:1; /* _PSC present? */
264 u32 power_resources:1; /* Power resources */
265 u32 inrush_current:1; /* Serialize Dx->D0 */
266 u32 power_removed:1; /* Optimize Dx->D0 */
Mika Westerberg644f17a2013-10-10 13:28:46 +0300267 u32 ignore_parent:1; /* Power is independent of parent power state */
Rafael J. Wysockif25c0ae2014-05-17 00:18:13 +0200268 u32 dsw_present:1; /* _DSW present? */
269 u32 reserved:26;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700270};
271
272struct acpi_device_power_state {
273 struct {
Len Brown4be44fc2005-08-05 00:44:28 -0400274 u8 valid:1;
275 u8 explicit_set:1; /* _PSx present? */
276 u8 reserved:6;
277 } flags;
278 int power; /* % Power (compared to D0) */
279 int latency; /* Dx->D0 time (microseconds) */
Rafael J. Wysocki0b224522013-01-17 14:11:06 +0100280 struct list_head resources; /* Power resources referenced */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700281};
282
283struct acpi_device_power {
Len Brown4be44fc2005-08-05 00:44:28 -0400284 int state; /* Current state */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700285 struct acpi_device_power_flags flags;
Lin Mingb4a03b92011-06-01 23:54:02 +0800286 struct acpi_device_power_state states[ACPI_D_STATE_COUNT]; /* Power states (D0-D3Cold) */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700287};
288
Linus Torvalds1da177e2005-04-16 15:20:36 -0700289/* Performance Management */
290
291struct acpi_device_perf_flags {
Len Brown4be44fc2005-08-05 00:44:28 -0400292 u8 reserved:8;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700293};
294
295struct acpi_device_perf_state {
296 struct {
Len Brown4be44fc2005-08-05 00:44:28 -0400297 u8 valid:1;
298 u8 reserved:7;
299 } flags;
300 u8 power; /* % Power (compared to P0) */
301 u8 performance; /* % Performance ( " ) */
302 int latency; /* Px->P0 time (microseconds) */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700303};
304
305struct acpi_device_perf {
Len Brown4be44fc2005-08-05 00:44:28 -0400306 int state;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700307 struct acpi_device_perf_flags flags;
Len Brown4be44fc2005-08-05 00:44:28 -0400308 int state_count;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700309 struct acpi_device_perf_state *states;
310};
311
312/* Wakeup Management */
313struct acpi_device_wakeup_flags {
Len Brown4be44fc2005-08-05 00:44:28 -0400314 u8 valid:1; /* Can successfully enable wakeup? */
315 u8 run_wake:1; /* Run-Wake GPE devices */
Rafael J. Wysockib67ea762010-02-17 23:44:09 +0100316 u8 notifier_present:1; /* Wake-up notify handler has been installed */
Rafael J. Wysocki175f8e22014-12-12 22:51:58 +0100317 u8 enabled:1; /* Enabled for wakeup */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700318};
319
Rafael J. Wysockic0725302014-07-23 01:00:45 +0200320struct acpi_device_wakeup_context {
321 struct work_struct work;
322 struct device *dev;
323};
324
Linus Torvalds1da177e2005-04-16 15:20:36 -0700325struct acpi_device_wakeup {
Len Brown4be44fc2005-08-05 00:44:28 -0400326 acpi_handle gpe_device;
Lin Ming439913f2010-01-28 10:53:19 +0800327 u64 gpe_number;
328 u64 sleep_state;
Rafael J. Wysocki993cbe52013-01-17 14:11:06 +0100329 struct list_head resources;
Len Brown4be44fc2005-08-05 00:44:28 -0400330 struct acpi_device_wakeup_flags flags;
Rafael J. Wysockic0725302014-07-23 01:00:45 +0200331 struct acpi_device_wakeup_context context;
332 struct wakeup_source *ws;
Rafael J. Wysocki9b83ccd2009-09-08 23:15:31 +0200333 int prepare_count;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700334};
335
Lan Tianyu1033f902012-08-17 14:44:09 +0800336struct acpi_device_physical_node {
Rafael J. Wysocki007ccfc2013-08-06 14:32:54 +0200337 unsigned int node_id;
Lan Tianyu1033f902012-08-17 14:44:09 +0800338 struct list_head node;
339 struct device *dev;
Rafael J. Wysocki683058e2013-05-03 00:26:16 +0200340 bool put_online:1;
Lan Tianyu1033f902012-08-17 14:44:09 +0800341};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700342
Mika Westerbergffdcd952014-10-21 13:33:55 +0200343/* ACPI Device Specific Data (_DSD) */
344struct acpi_device_data {
345 const union acpi_object *pointer;
346 const union acpi_object *properties;
Mika Westerberg733e6252014-10-21 13:33:56 +0200347 const union acpi_object *of_compatible;
Rafael J. Wysocki445b0eb2015-08-27 04:36:14 +0200348 struct list_head subnodes;
Mika Westerbergffdcd952014-10-21 13:33:55 +0200349};
350
Rafael J. Wysockif028d522014-11-03 23:39:41 +0100351struct acpi_gpio_mapping;
352
Lan Tianyu1033f902012-08-17 14:44:09 +0800353/* Device */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700354struct acpi_device {
Bjorn Helgaascaaa6ef2009-09-21 19:29:10 +0000355 int device_type;
356 acpi_handle handle; /* no handle for fixed hardware */
Rafael J. Wysocki8a0662d2014-11-04 14:03:59 +0100357 struct fwnode_handle fwnode;
Len Brown4be44fc2005-08-05 00:44:28 -0400358 struct acpi_device *parent;
359 struct list_head children;
360 struct list_head node;
361 struct list_head wakeup_list;
Rafael J. Wysockid7831562013-11-22 21:52:12 +0100362 struct list_head del_list;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700363 struct acpi_device_status status;
364 struct acpi_device_flags flags;
Len Brown4be44fc2005-08-05 00:44:28 -0400365 struct acpi_device_pnp pnp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700366 struct acpi_device_power power;
367 struct acpi_device_wakeup wakeup;
Len Brown4be44fc2005-08-05 00:44:28 -0400368 struct acpi_device_perf performance;
369 struct acpi_device_dir dir;
Mika Westerbergffdcd952014-10-21 13:33:55 +0200370 struct acpi_device_data data;
Rafael J. Wysockica589f92013-01-30 14:27:29 +0100371 struct acpi_scan_handler *handler;
Rafael J. Wysocki3c2cc7f2014-02-06 17:31:37 +0100372 struct acpi_hotplug_context *hp;
Len Brown4be44fc2005-08-05 00:44:28 -0400373 struct acpi_driver *driver;
Rafael J. Wysockif028d522014-11-03 23:39:41 +0100374 const struct acpi_gpio_mapping *driver_gpios;
Len Brown4be44fc2005-08-05 00:44:28 -0400375 void *driver_data;
Patrick Mochel5b327262006-05-10 10:33:00 -0400376 struct device dev;
Rafael J. Wysocki007ccfc2013-08-06 14:32:54 +0200377 unsigned int physical_node_count;
Lan Tianyu40e7fcb2014-11-23 21:22:54 +0800378 unsigned int dep_unmet;
Lan Tianyu1033f902012-08-17 14:44:09 +0800379 struct list_head physical_node_list;
380 struct mutex physical_node_lock;
Rafael J. Wysockib1c0f992013-01-24 12:50:09 +0100381 void (*remove)(struct acpi_device *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700382};
383
Rafael J. Wysocki445b0eb2015-08-27 04:36:14 +0200384/* Non-device subnode */
385struct acpi_data_node {
386 const char *name;
Rafael J. Wysocki263b4c12015-08-27 04:37:19 +0200387 acpi_handle handle;
Rafael J. Wysocki445b0eb2015-08-27 04:36:14 +0200388 struct fwnode_handle fwnode;
389 struct acpi_device_data data;
390 struct list_head sibling;
Rafael J. Wysocki263b4c12015-08-27 04:37:19 +0200391 struct kobject kobj;
392 struct completion kobj_done;
Rafael J. Wysocki445b0eb2015-08-27 04:36:14 +0200393};
394
Rafael J. Wysocki8a0662d2014-11-04 14:03:59 +0100395static inline bool is_acpi_node(struct fwnode_handle *fwnode)
396{
Heikki Krogerus0224a4a2016-04-27 14:04:20 +0300397 return !IS_ERR_OR_NULL(fwnode) && (fwnode->type == FWNODE_ACPI
Rafael J. Wysocki3a7a2ab2015-08-27 04:40:05 +0200398 || fwnode->type == FWNODE_ACPI_DATA);
399}
400
401static inline bool is_acpi_device_node(struct fwnode_handle *fwnode)
402{
Heikki Krogerus0224a4a2016-04-27 14:04:20 +0300403 return !IS_ERR_OR_NULL(fwnode) && fwnode->type == FWNODE_ACPI;
Rafael J. Wysocki8a0662d2014-11-04 14:03:59 +0100404}
405
Rafael J. Wysocki3a7a2ab2015-08-27 04:40:05 +0200406static inline struct acpi_device *to_acpi_device_node(struct fwnode_handle *fwnode)
Rafael J. Wysocki8a0662d2014-11-04 14:03:59 +0100407{
Rafael J. Wysocki3a7a2ab2015-08-27 04:40:05 +0200408 return is_acpi_device_node(fwnode) ?
Rafael J. Wysockice793482015-03-16 23:49:03 +0100409 container_of(fwnode, struct acpi_device, fwnode) : NULL;
Rafael J. Wysocki8a0662d2014-11-04 14:03:59 +0100410}
411
Rafael J. Wysocki3a7a2ab2015-08-27 04:40:05 +0200412static inline bool is_acpi_data_node(struct fwnode_handle *fwnode)
413{
414 return fwnode && fwnode->type == FWNODE_ACPI_DATA;
415}
416
417static inline struct acpi_data_node *to_acpi_data_node(struct fwnode_handle *fwnode)
418{
419 return is_acpi_data_node(fwnode) ?
420 container_of(fwnode, struct acpi_data_node, fwnode) : NULL;
421}
422
Adam Thomson613e9722016-06-21 18:50:20 +0100423static inline bool acpi_data_node_match(struct fwnode_handle *fwnode,
424 const char *name)
425{
426 return is_acpi_data_node(fwnode) ?
427 (!strcmp(to_acpi_data_node(fwnode)->name, name)) : false;
428}
429
Rafael J. Wysocki8a0662d2014-11-04 14:03:59 +0100430static inline struct fwnode_handle *acpi_fwnode_handle(struct acpi_device *adev)
431{
432 return &adev->fwnode;
433}
434
Pavel Machekdb89b4f2008-09-22 14:37:34 -0700435static inline void *acpi_driver_data(struct acpi_device *d)
436{
437 return d->driver_data;
438}
439
Patrick Mocheld43ec682006-12-07 20:56:23 +0800440#define to_acpi_device(d) container_of(d, struct acpi_device, dev)
441#define to_acpi_driver(d) container_of(d, struct acpi_driver, drv)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700442
Rafael J. Wysocki25db1152013-11-22 21:56:06 +0100443static inline void acpi_set_device_status(struct acpi_device *adev, u32 sta)
444{
445 *((u32 *)&adev->status) = sta;
446}
447
Rafael J. Wysocki3c2cc7f2014-02-06 17:31:37 +0100448static inline void acpi_set_hp_context(struct acpi_device *adev,
Rafael J. Wysockiba574dc2014-07-15 22:03:22 +0200449 struct acpi_hotplug_context *hp)
Rafael J. Wysocki3c2cc7f2014-02-06 17:31:37 +0100450{
451 hp->self = adev;
Rafael J. Wysocki3c2cc7f2014-02-06 17:31:37 +0100452 adev->hp = hp;
453}
454
Rafael J. Wysocki5d513202014-02-22 00:48:31 +0100455void acpi_initialize_hp_context(struct acpi_device *adev,
456 struct acpi_hotplug_context *hp,
457 int (*notify)(struct acpi_device *, u32),
458 void (*uevent)(struct acpi_device *, u32));
459
David Brownell55955aa2007-05-08 00:28:35 -0700460/* acpi_device.dev.bus == &acpi_bus_type */
461extern struct bus_type acpi_bus_type;
462
Linus Torvalds1da177e2005-04-16 15:20:36 -0700463/*
464 * Events
465 * ------
466 */
467
468struct acpi_bus_event {
Len Brown4be44fc2005-08-05 00:44:28 -0400469 struct list_head node;
470 acpi_device_class device_class;
471 acpi_bus_id bus_id;
472 u32 type;
473 u32 data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700474};
475
Greg Kroah-Hartman99e0d2f2007-11-02 16:19:59 -0700476extern struct kobject *acpi_kobj;
Zhang Rui962ce8c2007-08-23 01:24:31 +0800477extern int acpi_bus_generate_netlink_event(const char*, const char*, u8, int);
Bob Moore8e4319c2009-06-29 13:43:27 +0800478void acpi_bus_private_data_handler(acpi_handle, void *);
Zhang Rui20733932008-01-17 15:51:21 +0800479int acpi_bus_get_private_data(acpi_handle, void **);
Lan Tianyu72013792014-05-20 20:59:21 +0800480int acpi_bus_attach_private_data(acpi_handle, void *);
481void acpi_bus_detach_private_data(acpi_handle);
Zhang Rui9ee85242008-01-25 14:48:06 +0800482extern int acpi_notifier_call_chain(struct acpi_device *, u32, u32);
483extern int register_acpi_notifier(struct notifier_block *);
484extern int unregister_acpi_notifier(struct notifier_block *);
Shaohua Li6bd00a62008-08-28 10:04:29 +0800485
Linus Torvalds1da177e2005-04-16 15:20:36 -0700486/*
487 * External Functions
488 */
489
490int acpi_bus_get_device(acpi_handle handle, struct acpi_device **device);
Rafael J. Wysocki78ea4632014-02-04 00:43:05 +0100491struct acpi_device *acpi_bus_get_acpi_device(acpi_handle handle);
492void acpi_bus_put_acpi_device(struct acpi_device *adev);
Bjorn Helgaas402ac532009-09-21 19:30:01 +0000493acpi_status acpi_bus_get_status_handle(acpi_handle handle,
494 unsigned long long *sta);
Len Brown4be44fc2005-08-05 00:44:28 -0400495int acpi_bus_get_status(struct acpi_device *device);
Rafael J. Wysocki9ce4e602013-01-17 14:11:08 +0100496
Len Brown4be44fc2005-08-05 00:44:28 -0400497int acpi_bus_set_power(acpi_handle handle, int state);
Rafael J. Wysocki96bfd3c2013-01-17 14:11:08 +0100498const char *acpi_power_state_string(int state);
Rafael J. Wysockiad0c3b02013-01-17 14:11:08 +0100499int acpi_device_get_power(struct acpi_device *device, int *state);
Rafael J. Wysocki078eb122012-11-02 01:40:45 +0100500int acpi_device_set_power(struct acpi_device *device, int state);
Rafael J. Wysocki9ce4e602013-01-17 14:11:08 +0100501int acpi_bus_init_power(struct acpi_device *device);
Rafael J. Wysockib9e95fc2013-06-19 00:45:34 +0200502int acpi_device_fix_up_power(struct acpi_device *device);
Rafael J. Wysocki25eed402010-11-25 00:09:15 +0100503int acpi_bus_update_power(acpi_handle handle, int *state_p);
Aaron Lu2bb3a2b2013-11-19 15:43:52 +0800504int acpi_device_update_power(struct acpi_device *device, int *state_p);
Rafael J. Wysocki3737b2b2008-07-07 03:30:55 +0200505bool acpi_bus_power_manageable(acpi_handle handle);
Rafael J. Wysockiec4602a2013-05-16 22:29:28 +0200506
507#ifdef CONFIG_PM
Rafael J. Wysockieb9d0fe2008-07-07 03:34:48 +0200508bool acpi_bus_can_wakeup(acpi_handle handle);
Rafael J. Wysockiec4602a2013-05-16 22:29:28 +0200509#else
510static inline bool acpi_bus_can_wakeup(acpi_handle handle) { return false; }
511#endif
Rafael J. Wysocki9ce4e602013-01-17 14:11:08 +0100512
Rafael J. Wysocki3757b942013-02-13 14:36:47 +0100513void acpi_scan_lock_acquire(void);
514void acpi_scan_lock_release(void);
Rafael J. Wysockie5255062014-02-04 00:43:17 +0100515void acpi_lock_hp_context(void);
516void acpi_unlock_hp_context(void);
Rafael J. Wysockica589f92013-01-30 14:27:29 +0100517int acpi_scan_add_handler(struct acpi_scan_handler *handler);
Len Brown4be44fc2005-08-05 00:44:28 -0400518int acpi_bus_register_driver(struct acpi_driver *driver);
Bjorn Helgaas06ea8e082006-04-27 05:25:00 -0400519void acpi_bus_unregister_driver(struct acpi_driver *driver);
Rafael J. Wysockib8bd7592013-01-19 01:27:35 +0100520int acpi_bus_scan(acpi_handle handle);
Rafael J. Wysockibfee26d2013-01-26 00:27:44 +0100521void acpi_bus_trim(struct acpi_device *start);
Len Brownfd350942007-05-09 23:34:35 -0400522acpi_status acpi_bus_get_ejd(acpi_handle handle, acpi_handle * ejd);
Thomas Renninger8c8eb782007-07-23 14:43:32 +0200523int acpi_match_device_ids(struct acpi_device *device,
524 const struct acpi_device_id *ids);
Dan O'Donovan51ede5d2017-02-05 16:30:12 +0000525void acpi_set_modalias(struct acpi_device *adev, const char *default_id,
526 char *modalias, size_t len);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700527int acpi_create_dir(struct acpi_device *);
528void acpi_remove_dir(struct acpi_device *);
529
Rafael J. Wysocki202317a2013-11-22 21:54:37 +0100530static inline bool acpi_device_enumerated(struct acpi_device *adev)
531{
532 return adev && adev->flags.initialized && adev->flags.visited;
533}
534
Mika Westerberg0d2cf8f2012-09-07 10:31:38 +0300535/**
536 * module_acpi_driver(acpi_driver) - Helper macro for registering an ACPI driver
537 * @__acpi_driver: acpi_driver struct
538 *
539 * Helper macro for ACPI drivers which do not do anything special in module
540 * init/exit. This eliminates a lot of boilerplate. Each module may only
541 * use this macro once, and calling it replaces module_init() and module_exit()
542 */
543#define module_acpi_driver(__acpi_driver) \
544 module_driver(__acpi_driver, acpi_bus_register_driver, \
545 acpi_bus_unregister_driver)
546
David Shaohua Li4e10d122005-03-18 18:45:35 -0500547/*
548 * Bind physical devices with ACPI devices
549 */
David Shaohua Li4e10d122005-03-18 18:45:35 -0500550struct acpi_bus_type {
Len Brown4be44fc2005-08-05 00:44:28 -0400551 struct list_head list;
Rafael J. Wysocki53540092013-03-03 22:35:20 +0100552 const char *name;
553 bool (*match)(struct device *dev);
Rafael J. Wysockie3f02c52013-11-29 16:27:34 +0100554 struct acpi_device * (*find_companion)(struct device *);
Rafael J. Wysocki11909ca2012-12-23 00:02:13 +0100555 void (*setup)(struct device *);
556 void (*cleanup)(struct device *);
David Shaohua Li4e10d122005-03-18 18:45:35 -0500557};
558int register_acpi_bus_type(struct acpi_bus_type *);
559int unregister_acpi_bus_type(struct acpi_bus_type *);
Zhang Ruif1b1dc82014-07-07 14:07:38 +0200560int acpi_bind_one(struct device *dev, struct acpi_device *adev);
561int acpi_unbind_one(struct device *dev);
Thomas Renninger22c13f92008-08-01 17:37:54 +0200562
Alex Chiang76d56de2009-07-23 17:03:00 -0600563struct acpi_pci_root {
Alex Chiang76d56de2009-07-23 17:03:00 -0600564 struct acpi_device * device;
Alex Chiang76d56de2009-07-23 17:03:00 -0600565 struct pci_bus *bus;
566 u16 segment;
Bjorn Helgaas6ad95512010-03-11 12:20:06 -0700567 struct resource secondary; /* downstream bus range */
Alex Chiang76d56de2009-07-23 17:03:00 -0600568
569 u32 osc_support_set; /* _OSC state of support bits */
570 u32 osc_control_set; /* _OSC state of control bits */
Jiang Liuf4b57a32012-06-22 14:55:16 +0800571 phys_addr_t mcfg_addr;
Alex Chiang76d56de2009-07-23 17:03:00 -0600572};
573
David Shaohua Li4e10d122005-03-18 18:45:35 -0500574/* helper */
Rafael J. Wysockid9fef0c2013-11-28 23:57:58 +0100575
Suthikulpanit, Suraveeb84f1962015-10-28 15:50:48 -0700576bool acpi_dma_supported(struct acpi_device *adev);
577enum dev_dma_attr acpi_get_dma_attr(struct acpi_device *adev);
Lorenzo Pieralisid760a1b2016-11-21 10:01:39 +0000578void acpi_dma_configure(struct device *dev, enum dev_dma_attr attr);
579void acpi_dma_deconfigure(struct device *dev);
Suthikulpanit, Suraveeb84f1962015-10-28 15:50:48 -0700580
Rafael J. Wysockid9fef0c2013-11-28 23:57:58 +0100581struct acpi_device *acpi_find_child_device(struct acpi_device *parent,
582 u64 address, bool check_children);
Alexander Chiang27558202009-06-10 19:55:14 +0000583int acpi_is_root_bridge(acpi_handle);
Alex Chiang76d56de2009-07-23 17:03:00 -0600584struct acpi_pci_root *acpi_pci_find_root(acpi_handle handle);
David Shaohua Li4e10d122005-03-18 18:45:35 -0500585
Rafael J. Wysockib67ea762010-02-17 23:44:09 +0100586int acpi_enable_wakeup_device_power(struct acpi_device *dev, int state);
587int acpi_disable_wakeup_device_power(struct acpi_device *dev);
588
Rafael J. Wysockiaa338602011-02-11 00:06:54 +0100589#ifdef CONFIG_PM
Rafael J. Wysockic0725302014-07-23 01:00:45 +0200590acpi_status acpi_add_pm_notifier(struct acpi_device *adev, struct device *dev,
591 void (*work_func)(struct work_struct *work));
592acpi_status acpi_remove_pm_notifier(struct acpi_device *adev);
Huang Yingee85f542012-06-23 10:23:48 +0800593int acpi_pm_device_sleep_state(struct device *, int *, int);
Rafael J. Wysocki5de21bb92014-11-27 22:38:23 +0100594int acpi_pm_device_run_wake(struct device *, bool);
Rafael J. Wysocki761afb82010-10-14 23:24:13 +0200595#else
Rafael J. Wysockiec2cd812012-11-02 01:40:09 +0100596static inline acpi_status acpi_add_pm_notifier(struct acpi_device *adev,
Rafael J. Wysockic0725302014-07-23 01:00:45 +0200597 struct device *dev,
598 void (*work_func)(struct work_struct *work))
Rafael J. Wysockiec2cd812012-11-02 01:40:09 +0100599{
600 return AE_SUPPORT;
601}
Rafael J. Wysockic0725302014-07-23 01:00:45 +0200602static inline acpi_status acpi_remove_pm_notifier(struct acpi_device *adev)
Rafael J. Wysockiec2cd812012-11-02 01:40:09 +0100603{
604 return AE_SUPPORT;
605}
Rafael J. Wysockib25c77e2013-06-16 00:37:42 +0200606static inline int acpi_pm_device_sleep_state(struct device *d, int *p, int m)
Rafael J. Wysocki296699d2007-07-29 23:27:18 +0200607{
608 if (p)
609 *p = ACPI_STATE_D0;
Rafael J. Wysockib25c77e2013-06-16 00:37:42 +0200610
Rafael J. Wysocki8ad928d2013-07-30 14:36:20 +0200611 return (m >= ACPI_STATE_D0 && m <= ACPI_STATE_D3_COLD) ?
612 m : ACPI_STATE_D0;
Rafael J. Wysocki296699d2007-07-29 23:27:18 +0200613}
Lin Mingb24e5092012-03-27 15:43:25 +0800614static inline int acpi_pm_device_run_wake(struct device *dev, bool enable)
615{
616 return -ENODEV;
617}
Rafael J. Wysocki761afb82010-10-14 23:24:13 +0200618#endif
619
620#ifdef CONFIG_PM_SLEEP
Rafael J. Wysocki761afb82010-10-14 23:24:13 +0200621int acpi_pm_device_sleep_wake(struct device *, bool);
David Howellsf7a1b862008-07-08 15:00:54 +0100622#else
David Howellsf7a1b862008-07-08 15:00:54 +0100623static inline int acpi_pm_device_sleep_wake(struct device *dev, bool enable)
624{
625 return -ENODEV;
626}
Rafael J. Wysocki761afb82010-10-14 23:24:13 +0200627#endif
Shaohua Lifd4aff12007-07-17 22:40:25 +0200628
David Rientjes99926a82012-11-10 22:48:33 +0100629#ifdef CONFIG_ACPI_SLEEP
630u32 acpi_target_system_state(void);
631#else
632static inline u32 acpi_target_system_state(void) { return ACPI_STATE_S0; }
633#endif
634
Rafael J. Wysocki078eb122012-11-02 01:40:45 +0100635static inline bool acpi_device_power_manageable(struct acpi_device *adev)
636{
637 return adev->flags.power_manageable;
638}
639
640static inline bool acpi_device_can_wakeup(struct acpi_device *adev)
641{
642 return adev->wakeup.flags.valid;
643}
644
Aaron Lu1399dfc2012-11-21 23:33:40 +0100645static inline bool acpi_device_can_poweroff(struct acpi_device *adev)
646{
Ken Xuecd7f84c2015-12-09 16:17:30 +0800647 return adev->power.states[ACPI_STATE_D3_COLD].flags.valid ||
648 ((acpi_gbl_FADT.header.revision < 6) &&
649 adev->power.states[ACPI_STATE_D3_HOT].flags.explicit_set);
Aaron Lu1399dfc2012-11-21 23:33:40 +0100650}
651
Matthew Garrett66886d62012-05-11 16:08:25 +0800652#else /* CONFIG_ACPI */
653
Len Brown7ae30982012-06-04 00:29:11 -0400654static inline int register_acpi_bus_type(void *bus) { return 0; }
655static inline int unregister_acpi_bus_type(void *bus) { return 0; }
Matthew Garrett66886d62012-05-11 16:08:25 +0800656
Len Brownfd350942007-05-09 23:34:35 -0400657#endif /* CONFIG_ACPI */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700658
659#endif /*__ACPI_BUS_H__*/