Loading...
1/*
2 * acpi_bus.h - ACPI Bus Driver ($Revision: 22 $)
3 *
4 * Copyright (C) 2001, 2002 Andy Grover <andrew.grover@intel.com>
5 * Copyright (C) 2001, 2002 Paul Diefenbaugh <paul.s.diefenbaugh@intel.com>
6 *
7 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
8 *
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or (at
12 * your option) any later version.
13 *
14 * This program is distributed in the hope that it will be useful, but
15 * WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public License along
20 * with this program; if not, write to the Free Software Foundation, Inc.,
21 * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
22 *
23 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
24 */
25
26#ifndef __ACPI_BUS_H__
27#define __ACPI_BUS_H__
28
29#include <linux/device.h>
30
31#include <acpi/acpi.h>
32
33/* TBD: Make dynamic */
34#define ACPI_MAX_HANDLES 10
35struct acpi_handle_list {
36 u32 count;
37 acpi_handle handles[ACPI_MAX_HANDLES];
38};
39
40/* acpi_utils.h */
41acpi_status
42acpi_extract_package(union acpi_object *package,
43 struct acpi_buffer *format, struct acpi_buffer *buffer);
44acpi_status
45acpi_evaluate_integer(acpi_handle handle,
46 acpi_string pathname,
47 struct acpi_object_list *arguments, unsigned long long *data);
48acpi_status
49acpi_evaluate_reference(acpi_handle handle,
50 acpi_string pathname,
51 struct acpi_object_list *arguments,
52 struct acpi_handle_list *list);
53
54#ifdef CONFIG_ACPI
55
56#include <linux/proc_fs.h>
57
58#define ACPI_BUS_FILE_ROOT "acpi"
59extern struct proc_dir_entry *acpi_root_dir;
60
61enum acpi_bus_removal_type {
62 ACPI_BUS_REMOVAL_NORMAL = 0,
63 ACPI_BUS_REMOVAL_EJECT,
64 ACPI_BUS_REMOVAL_SUPRISE,
65 ACPI_BUS_REMOVAL_TYPE_COUNT
66};
67
68enum acpi_bus_device_type {
69 ACPI_BUS_TYPE_DEVICE = 0,
70 ACPI_BUS_TYPE_POWER,
71 ACPI_BUS_TYPE_PROCESSOR,
72 ACPI_BUS_TYPE_THERMAL,
73 ACPI_BUS_TYPE_POWER_BUTTON,
74 ACPI_BUS_TYPE_SLEEP_BUTTON,
75 ACPI_BUS_DEVICE_TYPE_COUNT
76};
77
78struct acpi_driver;
79struct acpi_device;
80
81/*
82 * ACPI Driver
83 * -----------
84 */
85
86typedef int (*acpi_op_add) (struct acpi_device * device);
87typedef int (*acpi_op_remove) (struct acpi_device * device, int type);
88typedef int (*acpi_op_start) (struct acpi_device * device);
89typedef int (*acpi_op_suspend) (struct acpi_device * device,
90 pm_message_t state);
91typedef int (*acpi_op_resume) (struct acpi_device * device);
92typedef int (*acpi_op_bind) (struct acpi_device * device);
93typedef int (*acpi_op_unbind) (struct acpi_device * device);
94typedef void (*acpi_op_notify) (struct acpi_device * device, u32 event);
95
96struct acpi_bus_ops {
97 u32 acpi_op_add:1;
98 u32 acpi_op_start:1;
99};
100
101struct acpi_device_ops {
102 acpi_op_add add;
103 acpi_op_remove remove;
104 acpi_op_start start;
105 acpi_op_suspend suspend;
106 acpi_op_resume resume;
107 acpi_op_bind bind;
108 acpi_op_unbind unbind;
109 acpi_op_notify notify;
110};
111
112#define ACPI_DRIVER_ALL_NOTIFY_EVENTS 0x1 /* system AND device events */
113
114struct acpi_driver {
115 char name[80];
116 char class[80];
117 const struct acpi_device_id *ids; /* Supported Hardware IDs */
118 unsigned int flags;
119 struct acpi_device_ops ops;
120 struct device_driver drv;
121 struct module *owner;
122};
123
124/*
125 * ACPI Device
126 * -----------
127 */
128
129/* Status (_STA) */
130
131struct acpi_device_status {
132 u32 present:1;
133 u32 enabled:1;
134 u32 show_in_ui:1;
135 u32 functional:1;
136 u32 battery_present:1;
137 u32 reserved:27;
138};
139
140/* Flags */
141
142struct acpi_device_flags {
143 u32 dynamic_status:1;
144 u32 bus_address:1;
145 u32 removable:1;
146 u32 ejectable:1;
147 u32 lockable:1;
148 u32 suprise_removal_ok:1;
149 u32 power_manageable:1;
150 u32 performance_manageable:1;
151 u32 reserved:24;
152};
153
154/* File System */
155
156struct acpi_device_dir {
157 struct proc_dir_entry *entry;
158};
159
160#define acpi_device_dir(d) ((d)->dir.entry)
161
162/* Plug and Play */
163
164typedef char acpi_bus_id[8];
165typedef unsigned long acpi_bus_address;
166typedef char acpi_device_name[40];
167typedef char acpi_device_class[20];
168
169struct acpi_hardware_id {
170 struct list_head list;
171 char *id;
172};
173
174struct acpi_device_pnp {
175 acpi_bus_id bus_id; /* Object name */
176 acpi_bus_address bus_address; /* _ADR */
177 char *unique_id; /* _UID */
178 struct list_head ids; /* _HID and _CIDs */
179 acpi_device_name device_name; /* Driver-determined */
180 acpi_device_class device_class; /* " */
181};
182
183#define acpi_device_bid(d) ((d)->pnp.bus_id)
184#define acpi_device_adr(d) ((d)->pnp.bus_address)
185const char *acpi_device_hid(struct acpi_device *device);
186#define acpi_device_name(d) ((d)->pnp.device_name)
187#define acpi_device_class(d) ((d)->pnp.device_class)
188
189/* Power Management */
190
191struct acpi_device_power_flags {
192 u32 explicit_get:1; /* _PSC present? */
193 u32 power_resources:1; /* Power resources */
194 u32 inrush_current:1; /* Serialize Dx->D0 */
195 u32 power_removed:1; /* Optimize Dx->D0 */
196 u32 reserved:28;
197};
198
199struct acpi_device_power_state {
200 struct {
201 u8 valid:1;
202 u8 explicit_set:1; /* _PSx present? */
203 u8 reserved:6;
204 } flags;
205 int power; /* % Power (compared to D0) */
206 int latency; /* Dx->D0 time (microseconds) */
207 struct acpi_handle_list resources; /* Power resources referenced */
208};
209
210struct acpi_device_power {
211 int state; /* Current state */
212 struct acpi_device_power_flags flags;
213 struct acpi_device_power_state states[ACPI_D_STATE_COUNT]; /* Power states (D0-D3Cold) */
214};
215
216/* Performance Management */
217
218struct acpi_device_perf_flags {
219 u8 reserved:8;
220};
221
222struct acpi_device_perf_state {
223 struct {
224 u8 valid:1;
225 u8 reserved:7;
226 } flags;
227 u8 power; /* % Power (compared to P0) */
228 u8 performance; /* % Performance ( " ) */
229 int latency; /* Px->P0 time (microseconds) */
230};
231
232struct acpi_device_perf {
233 int state;
234 struct acpi_device_perf_flags flags;
235 int state_count;
236 struct acpi_device_perf_state *states;
237};
238
239/* Wakeup Management */
240struct acpi_device_wakeup_flags {
241 u8 valid:1; /* Can successfully enable wakeup? */
242 u8 run_wake:1; /* Run-Wake GPE devices */
243 u8 notifier_present:1; /* Wake-up notify handler has been installed */
244};
245
246struct acpi_device_wakeup {
247 acpi_handle gpe_device;
248 u64 gpe_number;
249 u64 sleep_state;
250 struct acpi_handle_list resources;
251 struct acpi_device_wakeup_flags flags;
252 int prepare_count;
253};
254
255/* Device */
256
257struct acpi_device {
258 int device_type;
259 acpi_handle handle; /* no handle for fixed hardware */
260 struct acpi_device *parent;
261 struct list_head children;
262 struct list_head node;
263 struct list_head wakeup_list;
264 struct acpi_device_status status;
265 struct acpi_device_flags flags;
266 struct acpi_device_pnp pnp;
267 struct acpi_device_power power;
268 struct acpi_device_wakeup wakeup;
269 struct acpi_device_perf performance;
270 struct acpi_device_dir dir;
271 struct acpi_device_ops ops;
272 struct acpi_driver *driver;
273 void *driver_data;
274 struct device dev;
275 struct acpi_bus_ops bus_ops; /* workaround for different code path for hotplug */
276 enum acpi_bus_removal_type removal_type; /* indicate for different removal type */
277};
278
279static inline void *acpi_driver_data(struct acpi_device *d)
280{
281 return d->driver_data;
282}
283
284#define to_acpi_device(d) container_of(d, struct acpi_device, dev)
285#define to_acpi_driver(d) container_of(d, struct acpi_driver, drv)
286
287/* acpi_device.dev.bus == &acpi_bus_type */
288extern struct bus_type acpi_bus_type;
289
290/*
291 * Events
292 * ------
293 */
294
295struct acpi_bus_event {
296 struct list_head node;
297 acpi_device_class device_class;
298 acpi_bus_id bus_id;
299 u32 type;
300 u32 data;
301};
302
303extern struct kobject *acpi_kobj;
304extern int acpi_bus_generate_netlink_event(const char*, const char*, u8, int);
305void acpi_bus_private_data_handler(acpi_handle, void *);
306int acpi_bus_get_private_data(acpi_handle, void **);
307extern int acpi_notifier_call_chain(struct acpi_device *, u32, u32);
308extern int register_acpi_notifier(struct notifier_block *);
309extern int unregister_acpi_notifier(struct notifier_block *);
310
311extern int register_acpi_bus_notifier(struct notifier_block *nb);
312extern void unregister_acpi_bus_notifier(struct notifier_block *nb);
313/*
314 * External Functions
315 */
316
317int acpi_bus_get_device(acpi_handle handle, struct acpi_device **device);
318void acpi_bus_data_handler(acpi_handle handle, void *context);
319acpi_status acpi_bus_get_status_handle(acpi_handle handle,
320 unsigned long long *sta);
321int acpi_bus_get_status(struct acpi_device *device);
322int acpi_bus_set_power(acpi_handle handle, int state);
323int acpi_bus_update_power(acpi_handle handle, int *state_p);
324bool acpi_bus_power_manageable(acpi_handle handle);
325bool acpi_bus_can_wakeup(acpi_handle handle);
326#ifdef CONFIG_ACPI_PROC_EVENT
327int acpi_bus_generate_proc_event(struct acpi_device *device, u8 type, int data);
328int acpi_bus_generate_proc_event4(const char *class, const char *bid, u8 type, int data);
329int acpi_bus_receive_event(struct acpi_bus_event *event);
330#else
331static inline int acpi_bus_generate_proc_event(struct acpi_device *device, u8 type, int data)
332 { return 0; }
333#endif
334int acpi_bus_register_driver(struct acpi_driver *driver);
335void acpi_bus_unregister_driver(struct acpi_driver *driver);
336int acpi_bus_add(struct acpi_device **child, struct acpi_device *parent,
337 acpi_handle handle, int type);
338int acpi_bus_trim(struct acpi_device *start, int rmdevice);
339int acpi_bus_start(struct acpi_device *device);
340acpi_status acpi_bus_get_ejd(acpi_handle handle, acpi_handle * ejd);
341int acpi_match_device_ids(struct acpi_device *device,
342 const struct acpi_device_id *ids);
343int acpi_create_dir(struct acpi_device *);
344void acpi_remove_dir(struct acpi_device *);
345
346/*
347 * Bind physical devices with ACPI devices
348 */
349struct acpi_bus_type {
350 struct list_head list;
351 struct bus_type *bus;
352 /* For general devices under the bus */
353 int (*find_device) (struct device *, acpi_handle *);
354 /* For bridges, such as PCI root bridge, IDE controller */
355 int (*find_bridge) (struct device *, acpi_handle *);
356};
357int register_acpi_bus_type(struct acpi_bus_type *);
358int unregister_acpi_bus_type(struct acpi_bus_type *);
359struct device *acpi_get_physical_device(acpi_handle);
360
361struct acpi_pci_root {
362 struct list_head node;
363 struct acpi_device * device;
364 struct acpi_pci_id id;
365 struct pci_bus *bus;
366 u16 segment;
367 struct resource secondary; /* downstream bus range */
368
369 u32 osc_support_set; /* _OSC state of support bits */
370 u32 osc_control_set; /* _OSC state of control bits */
371};
372
373/* helper */
374acpi_handle acpi_get_child(acpi_handle, u64);
375int acpi_is_root_bridge(acpi_handle);
376acpi_handle acpi_get_pci_rootbridge_handle(unsigned int, unsigned int);
377struct acpi_pci_root *acpi_pci_find_root(acpi_handle handle);
378#define DEVICE_ACPI_HANDLE(dev) ((acpi_handle)((dev)->archdata.acpi_handle))
379
380int acpi_enable_wakeup_device_power(struct acpi_device *dev, int state);
381int acpi_disable_wakeup_device_power(struct acpi_device *dev);
382
383#ifdef CONFIG_PM
384int acpi_pm_device_sleep_state(struct device *, int *);
385#else
386static inline int acpi_pm_device_sleep_state(struct device *d, int *p)
387{
388 if (p)
389 *p = ACPI_STATE_D0;
390 return ACPI_STATE_D3;
391}
392#endif
393
394#ifdef CONFIG_PM_SLEEP
395int acpi_pm_device_sleep_wake(struct device *, bool);
396#else
397static inline int acpi_pm_device_sleep_wake(struct device *dev, bool enable)
398{
399 return -ENODEV;
400}
401#endif
402
403#endif /* CONFIG_ACPI */
404
405#endif /*__ACPI_BUS_H__*/
1/* SPDX-License-Identifier: GPL-2.0-or-later */
2/*
3 * acpi_bus.h - ACPI Bus Driver ($Revision: 22 $)
4 *
5 * Copyright (C) 2001, 2002 Andy Grover <andrew.grover@intel.com>
6 * Copyright (C) 2001, 2002 Paul Diefenbaugh <paul.s.diefenbaugh@intel.com>
7 */
8
9#ifndef __ACPI_BUS_H__
10#define __ACPI_BUS_H__
11
12#include <linux/device.h>
13#include <linux/property.h>
14
15/* TBD: Make dynamic */
16#define ACPI_MAX_HANDLES 10
17struct acpi_handle_list {
18 u32 count;
19 acpi_handle handles[ACPI_MAX_HANDLES];
20};
21
22/* acpi_utils.h */
23acpi_status
24acpi_extract_package(union acpi_object *package,
25 struct acpi_buffer *format, struct acpi_buffer *buffer);
26acpi_status
27acpi_evaluate_integer(acpi_handle handle,
28 acpi_string pathname,
29 struct acpi_object_list *arguments, unsigned long long *data);
30acpi_status
31acpi_evaluate_reference(acpi_handle handle,
32 acpi_string pathname,
33 struct acpi_object_list *arguments,
34 struct acpi_handle_list *list);
35acpi_status
36acpi_evaluate_ost(acpi_handle handle, u32 source_event, u32 status_code,
37 struct acpi_buffer *status_buf);
38
39acpi_status
40acpi_get_physical_device_location(acpi_handle handle, struct acpi_pld_info **pld);
41
42bool acpi_has_method(acpi_handle handle, char *name);
43acpi_status acpi_execute_simple_method(acpi_handle handle, char *method,
44 u64 arg);
45acpi_status acpi_evaluate_ej0(acpi_handle handle);
46acpi_status acpi_evaluate_lck(acpi_handle handle, int lock);
47acpi_status acpi_evaluate_reg(acpi_handle handle, u8 space_id, u32 function);
48bool acpi_ata_match(acpi_handle handle);
49bool acpi_bay_match(acpi_handle handle);
50bool acpi_dock_match(acpi_handle handle);
51
52bool acpi_check_dsm(acpi_handle handle, const guid_t *guid, u64 rev, u64 funcs);
53union acpi_object *acpi_evaluate_dsm(acpi_handle handle, const guid_t *guid,
54 u64 rev, u64 func, union acpi_object *argv4);
55
56static inline union acpi_object *
57acpi_evaluate_dsm_typed(acpi_handle handle, const guid_t *guid, u64 rev,
58 u64 func, union acpi_object *argv4,
59 acpi_object_type type)
60{
61 union acpi_object *obj;
62
63 obj = acpi_evaluate_dsm(handle, guid, rev, func, argv4);
64 if (obj && obj->type != type) {
65 ACPI_FREE(obj);
66 obj = NULL;
67 }
68
69 return obj;
70}
71
72#define ACPI_INIT_DSM_ARGV4(cnt, eles) \
73 { \
74 .package.type = ACPI_TYPE_PACKAGE, \
75 .package.count = (cnt), \
76 .package.elements = (eles) \
77 }
78
79bool acpi_dev_found(const char *hid);
80bool acpi_dev_present(const char *hid, const char *uid, s64 hrv);
81bool acpi_reduced_hardware(void);
82
83#ifdef CONFIG_ACPI
84
85struct proc_dir_entry;
86
87#define ACPI_BUS_FILE_ROOT "acpi"
88extern struct proc_dir_entry *acpi_root_dir;
89
90enum acpi_bus_device_type {
91 ACPI_BUS_TYPE_DEVICE = 0,
92 ACPI_BUS_TYPE_POWER,
93 ACPI_BUS_TYPE_PROCESSOR,
94 ACPI_BUS_TYPE_THERMAL,
95 ACPI_BUS_TYPE_POWER_BUTTON,
96 ACPI_BUS_TYPE_SLEEP_BUTTON,
97 ACPI_BUS_TYPE_ECDT_EC,
98 ACPI_BUS_DEVICE_TYPE_COUNT
99};
100
101struct acpi_driver;
102struct acpi_device;
103
104/*
105 * ACPI Scan Handler
106 * -----------------
107 */
108
109struct acpi_hotplug_profile {
110 struct kobject kobj;
111 int (*scan_dependent)(struct acpi_device *adev);
112 void (*notify_online)(struct acpi_device *adev);
113 bool enabled:1;
114 bool demand_offline:1;
115};
116
117static inline struct acpi_hotplug_profile *to_acpi_hotplug_profile(
118 struct kobject *kobj)
119{
120 return container_of(kobj, struct acpi_hotplug_profile, kobj);
121}
122
123struct acpi_scan_handler {
124 const struct acpi_device_id *ids;
125 struct list_head list_node;
126 bool (*match)(const char *idstr, const struct acpi_device_id **matchid);
127 int (*attach)(struct acpi_device *dev, const struct acpi_device_id *id);
128 void (*detach)(struct acpi_device *dev);
129 void (*bind)(struct device *phys_dev);
130 void (*unbind)(struct device *phys_dev);
131 struct acpi_hotplug_profile hotplug;
132};
133
134/*
135 * ACPI Hotplug Context
136 * --------------------
137 */
138
139struct acpi_hotplug_context {
140 struct acpi_device *self;
141 int (*notify)(struct acpi_device *, u32);
142 void (*uevent)(struct acpi_device *, u32);
143 void (*fixup)(struct acpi_device *);
144};
145
146/*
147 * ACPI Driver
148 * -----------
149 */
150
151typedef int (*acpi_op_add) (struct acpi_device * device);
152typedef void (*acpi_op_remove) (struct acpi_device *device);
153typedef void (*acpi_op_notify) (struct acpi_device * device, u32 event);
154
155struct acpi_device_ops {
156 acpi_op_add add;
157 acpi_op_remove remove;
158 acpi_op_notify notify;
159};
160
161#define ACPI_DRIVER_ALL_NOTIFY_EVENTS 0x1 /* system AND device events */
162
163struct acpi_driver {
164 char name[80];
165 char class[80];
166 const struct acpi_device_id *ids; /* Supported Hardware IDs */
167 unsigned int flags;
168 struct acpi_device_ops ops;
169 struct device_driver drv;
170 struct module *owner;
171};
172
173/*
174 * ACPI Device
175 * -----------
176 */
177
178/* Status (_STA) */
179
180struct acpi_device_status {
181 u32 present:1;
182 u32 enabled:1;
183 u32 show_in_ui:1;
184 u32 functional:1;
185 u32 battery_present:1;
186 u32 reserved:27;
187};
188
189/* Flags */
190
191struct acpi_device_flags {
192 u32 dynamic_status:1;
193 u32 removable:1;
194 u32 ejectable:1;
195 u32 power_manageable:1;
196 u32 match_driver:1;
197 u32 initialized:1;
198 u32 visited:1;
199 u32 hotplug_notify:1;
200 u32 is_dock_station:1;
201 u32 of_compatible_ok:1;
202 u32 coherent_dma:1;
203 u32 cca_seen:1;
204 u32 enumeration_by_parent:1;
205 u32 honor_deps:1;
206 u32 reserved:18;
207};
208
209/* File System */
210
211struct acpi_device_dir {
212 struct proc_dir_entry *entry;
213};
214
215#define acpi_device_dir(d) ((d)->dir.entry)
216
217/* Plug and Play */
218
219typedef char acpi_bus_id[8];
220typedef u64 acpi_bus_address;
221typedef char acpi_device_name[40];
222typedef char acpi_device_class[20];
223
224struct acpi_hardware_id {
225 struct list_head list;
226 const char *id;
227};
228
229struct acpi_pnp_type {
230 u32 hardware_id:1;
231 u32 bus_address:1;
232 u32 platform_id:1;
233 u32 backlight:1;
234 u32 reserved:28;
235};
236
237struct acpi_device_pnp {
238 acpi_bus_id bus_id; /* Object name */
239 int instance_no; /* Instance number of this object */
240 struct acpi_pnp_type type; /* ID type */
241 acpi_bus_address bus_address; /* _ADR */
242 char *unique_id; /* _UID */
243 struct list_head ids; /* _HID and _CIDs */
244 acpi_device_name device_name; /* Driver-determined */
245 acpi_device_class device_class; /* " */
246 union acpi_object *str_obj; /* unicode string for _STR method */
247};
248
249#define acpi_device_bid(d) ((d)->pnp.bus_id)
250#define acpi_device_adr(d) ((d)->pnp.bus_address)
251const char *acpi_device_hid(struct acpi_device *device);
252#define acpi_device_uid(d) ((d)->pnp.unique_id)
253#define acpi_device_name(d) ((d)->pnp.device_name)
254#define acpi_device_class(d) ((d)->pnp.device_class)
255
256/* Power Management */
257
258struct acpi_device_power_flags {
259 u32 explicit_get:1; /* _PSC present? */
260 u32 power_resources:1; /* Power resources */
261 u32 inrush_current:1; /* Serialize Dx->D0 */
262 u32 power_removed:1; /* Optimize Dx->D0 */
263 u32 ignore_parent:1; /* Power is independent of parent power state */
264 u32 dsw_present:1; /* _DSW present? */
265 u32 reserved:26;
266};
267
268struct acpi_device_power_state {
269 struct {
270 u8 valid:1;
271 u8 explicit_set:1; /* _PSx present? */
272 u8 reserved:6;
273 } flags;
274 int power; /* % Power (compared to D0) */
275 int latency; /* Dx->D0 time (microseconds) */
276 struct list_head resources; /* Power resources referenced */
277};
278
279struct acpi_device_power {
280 int state; /* Current state */
281 struct acpi_device_power_flags flags;
282 struct acpi_device_power_state states[ACPI_D_STATE_COUNT]; /* Power states (D0-D3Cold) */
283 u8 state_for_enumeration; /* Deepest power state for enumeration */
284};
285
286struct acpi_dep_data {
287 struct list_head node;
288 acpi_handle supplier;
289 acpi_handle consumer;
290 bool honor_dep;
291};
292
293/* Performance Management */
294
295struct acpi_device_perf_flags {
296 u8 reserved:8;
297};
298
299struct acpi_device_perf_state {
300 struct {
301 u8 valid:1;
302 u8 reserved:7;
303 } flags;
304 u8 power; /* % Power (compared to P0) */
305 u8 performance; /* % Performance ( " ) */
306 int latency; /* Px->P0 time (microseconds) */
307};
308
309struct acpi_device_perf {
310 int state;
311 struct acpi_device_perf_flags flags;
312 int state_count;
313 struct acpi_device_perf_state *states;
314};
315
316/* Wakeup Management */
317struct acpi_device_wakeup_flags {
318 u8 valid:1; /* Can successfully enable wakeup? */
319 u8 notifier_present:1; /* Wake-up notify handler has been installed */
320};
321
322struct acpi_device_wakeup_context {
323 void (*func)(struct acpi_device_wakeup_context *context);
324 struct device *dev;
325};
326
327struct acpi_device_wakeup {
328 acpi_handle gpe_device;
329 u64 gpe_number;
330 u64 sleep_state;
331 struct list_head resources;
332 struct acpi_device_wakeup_flags flags;
333 struct acpi_device_wakeup_context context;
334 struct wakeup_source *ws;
335 int prepare_count;
336 int enable_count;
337};
338
339struct acpi_device_physical_node {
340 unsigned int node_id;
341 struct list_head node;
342 struct device *dev;
343 bool put_online:1;
344};
345
346struct acpi_device_properties {
347 const guid_t *guid;
348 union acpi_object *properties;
349 struct list_head list;
350 void **bufs;
351};
352
353/* ACPI Device Specific Data (_DSD) */
354struct acpi_device_data {
355 const union acpi_object *pointer;
356 struct list_head properties;
357 const union acpi_object *of_compatible;
358 struct list_head subnodes;
359};
360
361struct acpi_gpio_mapping;
362
363/* Device */
364struct acpi_device {
365 u32 pld_crc;
366 int device_type;
367 acpi_handle handle; /* no handle for fixed hardware */
368 struct fwnode_handle fwnode;
369 struct list_head wakeup_list;
370 struct list_head del_list;
371 struct acpi_device_status status;
372 struct acpi_device_flags flags;
373 struct acpi_device_pnp pnp;
374 struct acpi_device_power power;
375 struct acpi_device_wakeup wakeup;
376 struct acpi_device_perf performance;
377 struct acpi_device_dir dir;
378 struct acpi_device_data data;
379 struct acpi_scan_handler *handler;
380 struct acpi_hotplug_context *hp;
381 const struct acpi_gpio_mapping *driver_gpios;
382 void *driver_data;
383 struct device dev;
384 unsigned int physical_node_count;
385 unsigned int dep_unmet;
386 struct list_head physical_node_list;
387 struct mutex physical_node_lock;
388 void (*remove)(struct acpi_device *);
389};
390
391/* Non-device subnode */
392struct acpi_data_node {
393 const char *name;
394 acpi_handle handle;
395 struct fwnode_handle fwnode;
396 struct fwnode_handle *parent;
397 struct acpi_device_data data;
398 struct list_head sibling;
399 struct kobject kobj;
400 struct completion kobj_done;
401};
402
403extern const struct fwnode_operations acpi_device_fwnode_ops;
404extern const struct fwnode_operations acpi_data_fwnode_ops;
405extern const struct fwnode_operations acpi_static_fwnode_ops;
406
407bool is_acpi_device_node(const struct fwnode_handle *fwnode);
408bool is_acpi_data_node(const struct fwnode_handle *fwnode);
409
410static inline bool is_acpi_node(const struct fwnode_handle *fwnode)
411{
412 return (is_acpi_device_node(fwnode) || is_acpi_data_node(fwnode));
413}
414
415#define to_acpi_device_node(__fwnode) \
416 ({ \
417 typeof(__fwnode) __to_acpi_device_node_fwnode = __fwnode; \
418 \
419 is_acpi_device_node(__to_acpi_device_node_fwnode) ? \
420 container_of(__to_acpi_device_node_fwnode, \
421 struct acpi_device, fwnode) : \
422 NULL; \
423 })
424
425#define to_acpi_data_node(__fwnode) \
426 ({ \
427 typeof(__fwnode) __to_acpi_data_node_fwnode = __fwnode; \
428 \
429 is_acpi_data_node(__to_acpi_data_node_fwnode) ? \
430 container_of(__to_acpi_data_node_fwnode, \
431 struct acpi_data_node, fwnode) : \
432 NULL; \
433 })
434
435static inline bool is_acpi_static_node(const struct fwnode_handle *fwnode)
436{
437 return !IS_ERR_OR_NULL(fwnode) &&
438 fwnode->ops == &acpi_static_fwnode_ops;
439}
440
441static inline bool acpi_data_node_match(const struct fwnode_handle *fwnode,
442 const char *name)
443{
444 return is_acpi_data_node(fwnode) ?
445 (!strcmp(to_acpi_data_node(fwnode)->name, name)) : false;
446}
447
448static inline struct fwnode_handle *acpi_fwnode_handle(struct acpi_device *adev)
449{
450 return &adev->fwnode;
451}
452
453static inline void *acpi_driver_data(struct acpi_device *d)
454{
455 return d->driver_data;
456}
457
458#define to_acpi_device(d) container_of(d, struct acpi_device, dev)
459#define to_acpi_driver(d) container_of(d, struct acpi_driver, drv)
460
461static inline struct acpi_device *acpi_dev_parent(struct acpi_device *adev)
462{
463 if (adev->dev.parent)
464 return to_acpi_device(adev->dev.parent);
465
466 return NULL;
467}
468
469static inline void acpi_set_device_status(struct acpi_device *adev, u32 sta)
470{
471 *((u32 *)&adev->status) = sta;
472}
473
474static inline void acpi_set_hp_context(struct acpi_device *adev,
475 struct acpi_hotplug_context *hp)
476{
477 hp->self = adev;
478 adev->hp = hp;
479}
480
481void acpi_initialize_hp_context(struct acpi_device *adev,
482 struct acpi_hotplug_context *hp,
483 int (*notify)(struct acpi_device *, u32),
484 void (*uevent)(struct acpi_device *, u32));
485
486/* acpi_device.dev.bus == &acpi_bus_type */
487extern struct bus_type acpi_bus_type;
488
489int acpi_bus_for_each_dev(int (*fn)(struct device *, void *), void *data);
490int acpi_dev_for_each_child(struct acpi_device *adev,
491 int (*fn)(struct acpi_device *, void *), void *data);
492int acpi_dev_for_each_child_reverse(struct acpi_device *adev,
493 int (*fn)(struct acpi_device *, void *),
494 void *data);
495
496/*
497 * Events
498 * ------
499 */
500
501struct acpi_bus_event {
502 struct list_head node;
503 acpi_device_class device_class;
504 acpi_bus_id bus_id;
505 u32 type;
506 u32 data;
507};
508
509extern struct kobject *acpi_kobj;
510extern int acpi_bus_generate_netlink_event(const char*, const char*, u8, int);
511void acpi_bus_private_data_handler(acpi_handle, void *);
512int acpi_bus_get_private_data(acpi_handle, void **);
513int acpi_bus_attach_private_data(acpi_handle, void *);
514void acpi_bus_detach_private_data(acpi_handle);
515extern int acpi_notifier_call_chain(struct acpi_device *, u32, u32);
516extern int register_acpi_notifier(struct notifier_block *);
517extern int unregister_acpi_notifier(struct notifier_block *);
518
519/*
520 * External Functions
521 */
522
523acpi_status acpi_bus_get_status_handle(acpi_handle handle,
524 unsigned long long *sta);
525int acpi_bus_get_status(struct acpi_device *device);
526
527int acpi_bus_set_power(acpi_handle handle, int state);
528const char *acpi_power_state_string(int state);
529int acpi_device_set_power(struct acpi_device *device, int state);
530int acpi_bus_init_power(struct acpi_device *device);
531int acpi_device_fix_up_power(struct acpi_device *device);
532void acpi_device_fix_up_power_extended(struct acpi_device *adev);
533int acpi_bus_update_power(acpi_handle handle, int *state_p);
534int acpi_device_update_power(struct acpi_device *device, int *state_p);
535bool acpi_bus_power_manageable(acpi_handle handle);
536void acpi_dev_power_up_children_with_adr(struct acpi_device *adev);
537int acpi_device_power_add_dependent(struct acpi_device *adev,
538 struct device *dev);
539void acpi_device_power_remove_dependent(struct acpi_device *adev,
540 struct device *dev);
541
542#ifdef CONFIG_PM
543bool acpi_bus_can_wakeup(acpi_handle handle);
544#else
545static inline bool acpi_bus_can_wakeup(acpi_handle handle) { return false; }
546#endif
547
548void acpi_scan_lock_acquire(void);
549void acpi_scan_lock_release(void);
550void acpi_lock_hp_context(void);
551void acpi_unlock_hp_context(void);
552int acpi_scan_add_handler(struct acpi_scan_handler *handler);
553int acpi_bus_register_driver(struct acpi_driver *driver);
554void acpi_bus_unregister_driver(struct acpi_driver *driver);
555int acpi_bus_scan(acpi_handle handle);
556void acpi_bus_trim(struct acpi_device *start);
557acpi_status acpi_bus_get_ejd(acpi_handle handle, acpi_handle * ejd);
558int acpi_match_device_ids(struct acpi_device *device,
559 const struct acpi_device_id *ids);
560void acpi_set_modalias(struct acpi_device *adev, const char *default_id,
561 char *modalias, size_t len);
562int acpi_create_dir(struct acpi_device *);
563void acpi_remove_dir(struct acpi_device *);
564
565static inline bool acpi_device_enumerated(struct acpi_device *adev)
566{
567 return adev && adev->flags.initialized && adev->flags.visited;
568}
569
570/**
571 * module_acpi_driver(acpi_driver) - Helper macro for registering an ACPI driver
572 * @__acpi_driver: acpi_driver struct
573 *
574 * Helper macro for ACPI drivers which do not do anything special in module
575 * init/exit. This eliminates a lot of boilerplate. Each module may only
576 * use this macro once, and calling it replaces module_init() and module_exit()
577 */
578#define module_acpi_driver(__acpi_driver) \
579 module_driver(__acpi_driver, acpi_bus_register_driver, \
580 acpi_bus_unregister_driver)
581
582/*
583 * Bind physical devices with ACPI devices
584 */
585struct acpi_bus_type {
586 struct list_head list;
587 const char *name;
588 bool (*match)(struct device *dev);
589 struct acpi_device * (*find_companion)(struct device *);
590 void (*setup)(struct device *);
591};
592int register_acpi_bus_type(struct acpi_bus_type *);
593int unregister_acpi_bus_type(struct acpi_bus_type *);
594int acpi_bind_one(struct device *dev, struct acpi_device *adev);
595int acpi_unbind_one(struct device *dev);
596
597enum acpi_bridge_type {
598 ACPI_BRIDGE_TYPE_PCIE = 1,
599 ACPI_BRIDGE_TYPE_CXL,
600};
601
602struct acpi_pci_root {
603 struct acpi_device * device;
604 struct pci_bus *bus;
605 u16 segment;
606 int bridge_type;
607 struct resource secondary; /* downstream bus range */
608
609 u32 osc_support_set; /* _OSC state of support bits */
610 u32 osc_control_set; /* _OSC state of control bits */
611 u32 osc_ext_support_set; /* _OSC state of extended support bits */
612 u32 osc_ext_control_set; /* _OSC state of extended control bits */
613 phys_addr_t mcfg_addr;
614};
615
616/* helper */
617
618bool acpi_dma_supported(const struct acpi_device *adev);
619enum dev_dma_attr acpi_get_dma_attr(struct acpi_device *adev);
620int acpi_iommu_fwspec_init(struct device *dev, u32 id,
621 struct fwnode_handle *fwnode,
622 const struct iommu_ops *ops);
623int acpi_dma_get_range(struct device *dev, const struct bus_dma_region **map);
624int acpi_dma_configure_id(struct device *dev, enum dev_dma_attr attr,
625 const u32 *input_id);
626static inline int acpi_dma_configure(struct device *dev,
627 enum dev_dma_attr attr)
628{
629 return acpi_dma_configure_id(dev, attr, NULL);
630}
631struct acpi_device *acpi_find_child_device(struct acpi_device *parent,
632 u64 address, bool check_children);
633struct acpi_device *acpi_find_child_by_adr(struct acpi_device *adev,
634 acpi_bus_address adr);
635int acpi_is_root_bridge(acpi_handle);
636struct acpi_pci_root *acpi_pci_find_root(acpi_handle handle);
637
638int acpi_enable_wakeup_device_power(struct acpi_device *dev, int state);
639int acpi_disable_wakeup_device_power(struct acpi_device *dev);
640
641#ifdef CONFIG_X86
642bool acpi_device_override_status(struct acpi_device *adev, unsigned long long *status);
643bool acpi_quirk_skip_acpi_ac_and_battery(void);
644#else
645static inline bool acpi_device_override_status(struct acpi_device *adev,
646 unsigned long long *status)
647{
648 return false;
649}
650static inline bool acpi_quirk_skip_acpi_ac_and_battery(void)
651{
652 return false;
653}
654#endif
655
656#if IS_ENABLED(CONFIG_X86_ANDROID_TABLETS)
657bool acpi_quirk_skip_i2c_client_enumeration(struct acpi_device *adev);
658int acpi_quirk_skip_serdev_enumeration(struct device *controller_parent, bool *skip);
659#else
660static inline bool acpi_quirk_skip_i2c_client_enumeration(struct acpi_device *adev)
661{
662 return false;
663}
664static inline int
665acpi_quirk_skip_serdev_enumeration(struct device *controller_parent, bool *skip)
666{
667 *skip = false;
668 return 0;
669}
670#endif
671
672#ifdef CONFIG_PM
673void acpi_pm_wakeup_event(struct device *dev);
674acpi_status acpi_add_pm_notifier(struct acpi_device *adev, struct device *dev,
675 void (*func)(struct acpi_device_wakeup_context *context));
676acpi_status acpi_remove_pm_notifier(struct acpi_device *adev);
677bool acpi_pm_device_can_wakeup(struct device *dev);
678int acpi_pm_device_sleep_state(struct device *, int *, int);
679int acpi_pm_set_device_wakeup(struct device *dev, bool enable);
680#else
681static inline void acpi_pm_wakeup_event(struct device *dev)
682{
683}
684static inline acpi_status acpi_add_pm_notifier(struct acpi_device *adev,
685 struct device *dev,
686 void (*func)(struct acpi_device_wakeup_context *context))
687{
688 return AE_SUPPORT;
689}
690static inline acpi_status acpi_remove_pm_notifier(struct acpi_device *adev)
691{
692 return AE_SUPPORT;
693}
694static inline bool acpi_pm_device_can_wakeup(struct device *dev)
695{
696 return false;
697}
698static inline int acpi_pm_device_sleep_state(struct device *d, int *p, int m)
699{
700 if (p)
701 *p = ACPI_STATE_D0;
702
703 return (m >= ACPI_STATE_D0 && m <= ACPI_STATE_D3_COLD) ?
704 m : ACPI_STATE_D0;
705}
706static inline int acpi_pm_set_device_wakeup(struct device *dev, bool enable)
707{
708 return -ENODEV;
709}
710#endif
711
712#ifdef CONFIG_ACPI_SYSTEM_POWER_STATES_SUPPORT
713bool acpi_sleep_state_supported(u8 sleep_state);
714#else
715static inline bool acpi_sleep_state_supported(u8 sleep_state) { return false; }
716#endif
717
718#ifdef CONFIG_ACPI_SLEEP
719u32 acpi_target_system_state(void);
720#else
721static inline u32 acpi_target_system_state(void) { return ACPI_STATE_S0; }
722#endif
723
724static inline bool acpi_device_power_manageable(struct acpi_device *adev)
725{
726 return adev->flags.power_manageable;
727}
728
729static inline bool acpi_device_can_wakeup(struct acpi_device *adev)
730{
731 return adev->wakeup.flags.valid;
732}
733
734static inline bool acpi_device_can_poweroff(struct acpi_device *adev)
735{
736 return adev->power.states[ACPI_STATE_D3_COLD].flags.valid ||
737 ((acpi_gbl_FADT.header.revision < 6) &&
738 adev->power.states[ACPI_STATE_D3_HOT].flags.explicit_set);
739}
740
741bool acpi_dev_hid_uid_match(struct acpi_device *adev, const char *hid2, const char *uid2);
742int acpi_dev_uid_to_integer(struct acpi_device *adev, u64 *integer);
743
744void acpi_dev_clear_dependencies(struct acpi_device *supplier);
745bool acpi_dev_ready_for_enumeration(const struct acpi_device *device);
746struct acpi_device *acpi_dev_get_next_consumer_dev(struct acpi_device *supplier,
747 struct acpi_device *start);
748
749/**
750 * for_each_acpi_consumer_dev - iterate over the consumer ACPI devices for a
751 * given supplier
752 * @supplier: Pointer to the supplier's ACPI device
753 * @consumer: Pointer to &struct acpi_device to hold the consumer, initially NULL
754 */
755#define for_each_acpi_consumer_dev(supplier, consumer) \
756 for (consumer = acpi_dev_get_next_consumer_dev(supplier, NULL); \
757 consumer; \
758 consumer = acpi_dev_get_next_consumer_dev(supplier, consumer))
759
760struct acpi_device *
761acpi_dev_get_next_match_dev(struct acpi_device *adev, const char *hid, const char *uid, s64 hrv);
762struct acpi_device *
763acpi_dev_get_first_match_dev(const char *hid, const char *uid, s64 hrv);
764
765/**
766 * for_each_acpi_dev_match - iterate over ACPI devices that matching the criteria
767 * @adev: pointer to the matching ACPI device, NULL at the end of the loop
768 * @hid: Hardware ID of the device.
769 * @uid: Unique ID of the device, pass NULL to not check _UID
770 * @hrv: Hardware Revision of the device, pass -1 to not check _HRV
771 *
772 * The caller is responsible for invoking acpi_dev_put() on the returned device.
773 */
774#define for_each_acpi_dev_match(adev, hid, uid, hrv) \
775 for (adev = acpi_dev_get_first_match_dev(hid, uid, hrv); \
776 adev; \
777 adev = acpi_dev_get_next_match_dev(adev, hid, uid, hrv))
778
779static inline struct acpi_device *acpi_dev_get(struct acpi_device *adev)
780{
781 return adev ? to_acpi_device(get_device(&adev->dev)) : NULL;
782}
783
784static inline void acpi_dev_put(struct acpi_device *adev)
785{
786 if (adev)
787 put_device(&adev->dev);
788}
789
790struct acpi_device *acpi_fetch_acpi_dev(acpi_handle handle);
791struct acpi_device *acpi_get_acpi_dev(acpi_handle handle);
792
793static inline void acpi_put_acpi_dev(struct acpi_device *adev)
794{
795 acpi_dev_put(adev);
796}
797#else /* CONFIG_ACPI */
798
799static inline int register_acpi_bus_type(void *bus) { return 0; }
800static inline int unregister_acpi_bus_type(void *bus) { return 0; }
801
802#endif /* CONFIG_ACPI */
803
804#endif /*__ACPI_BUS_H__*/