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