Loading...
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
15struct acpi_handle_list {
16 u32 count;
17 acpi_handle *handles;
18};
19
20/* acpi_utils.h */
21acpi_status
22acpi_extract_package(union acpi_object *package,
23 struct acpi_buffer *format, struct acpi_buffer *buffer);
24acpi_status
25acpi_evaluate_integer(acpi_handle handle,
26 acpi_string pathname,
27 struct acpi_object_list *arguments, unsigned long long *data);
28bool acpi_evaluate_reference(acpi_handle handle, acpi_string pathname,
29 struct acpi_object_list *arguments,
30 struct acpi_handle_list *list);
31bool acpi_handle_list_equal(struct acpi_handle_list *list1,
32 struct acpi_handle_list *list2);
33void acpi_handle_list_replace(struct acpi_handle_list *dst,
34 struct acpi_handle_list *src);
35void acpi_handle_list_free(struct acpi_handle_list *list);
36bool acpi_device_dep(acpi_handle target, acpi_handle match);
37acpi_status
38acpi_evaluate_ost(acpi_handle handle, u32 source_event, u32 status_code,
39 struct acpi_buffer *status_buf);
40
41acpi_status
42acpi_get_physical_device_location(acpi_handle handle, struct acpi_pld_info **pld);
43
44bool acpi_has_method(acpi_handle handle, char *name);
45acpi_status acpi_execute_simple_method(acpi_handle handle, char *method,
46 u64 arg);
47acpi_status acpi_evaluate_ej0(acpi_handle handle);
48acpi_status acpi_evaluate_lck(acpi_handle handle, int lock);
49acpi_status acpi_evaluate_reg(acpi_handle handle, u8 space_id, u32 function);
50bool acpi_ata_match(acpi_handle handle);
51bool acpi_bay_match(acpi_handle handle);
52bool acpi_dock_match(acpi_handle handle);
53
54bool acpi_check_dsm(acpi_handle handle, const guid_t *guid, u64 rev, u64 funcs);
55union acpi_object *acpi_evaluate_dsm(acpi_handle handle, const guid_t *guid,
56 u64 rev, u64 func, union acpi_object *argv4);
57#ifdef CONFIG_ACPI
58static inline union acpi_object *
59acpi_evaluate_dsm_typed(acpi_handle handle, const guid_t *guid, u64 rev,
60 u64 func, union acpi_object *argv4,
61 acpi_object_type type)
62{
63 union acpi_object *obj;
64
65 obj = acpi_evaluate_dsm(handle, guid, rev, func, argv4);
66 if (obj && obj->type != type) {
67 ACPI_FREE(obj);
68 obj = NULL;
69 }
70
71 return obj;
72}
73#endif
74
75#define ACPI_INIT_DSM_ARGV4(cnt, eles) \
76 { \
77 .package.type = ACPI_TYPE_PACKAGE, \
78 .package.count = (cnt), \
79 .package.elements = (eles) \
80 }
81
82bool acpi_dev_found(const char *hid);
83bool acpi_dev_present(const char *hid, const char *uid, s64 hrv);
84bool acpi_reduced_hardware(void);
85
86#ifdef CONFIG_ACPI
87
88struct proc_dir_entry;
89
90#define ACPI_BUS_FILE_ROOT "acpi"
91extern struct proc_dir_entry *acpi_root_dir;
92
93enum acpi_bus_device_type {
94 ACPI_BUS_TYPE_DEVICE = 0,
95 ACPI_BUS_TYPE_POWER,
96 ACPI_BUS_TYPE_PROCESSOR,
97 ACPI_BUS_TYPE_THERMAL,
98 ACPI_BUS_TYPE_POWER_BUTTON,
99 ACPI_BUS_TYPE_SLEEP_BUTTON,
100 ACPI_BUS_TYPE_ECDT_EC,
101 ACPI_BUS_DEVICE_TYPE_COUNT
102};
103
104struct acpi_driver;
105struct acpi_device;
106
107/*
108 * ACPI Scan Handler
109 * -----------------
110 */
111
112struct acpi_hotplug_profile {
113 struct kobject kobj;
114 int (*scan_dependent)(struct acpi_device *adev);
115 void (*notify_online)(struct acpi_device *adev);
116 bool enabled:1;
117 bool demand_offline:1;
118};
119
120static inline struct acpi_hotplug_profile *to_acpi_hotplug_profile(
121 struct kobject *kobj)
122{
123 return container_of(kobj, struct acpi_hotplug_profile, kobj);
124}
125
126struct acpi_scan_handler {
127 const struct acpi_device_id *ids;
128 struct list_head list_node;
129 bool (*match)(const char *idstr, const struct acpi_device_id **matchid);
130 int (*attach)(struct acpi_device *dev, const struct acpi_device_id *id);
131 void (*detach)(struct acpi_device *dev);
132 void (*bind)(struct device *phys_dev);
133 void (*unbind)(struct device *phys_dev);
134 struct acpi_hotplug_profile hotplug;
135};
136
137/*
138 * ACPI Hotplug Context
139 * --------------------
140 */
141
142struct acpi_hotplug_context {
143 struct acpi_device *self;
144 int (*notify)(struct acpi_device *, u32);
145 void (*uevent)(struct acpi_device *, u32);
146 void (*fixup)(struct acpi_device *);
147};
148
149/*
150 * ACPI Driver
151 * -----------
152 */
153
154typedef int (*acpi_op_add) (struct acpi_device * device);
155typedef void (*acpi_op_remove) (struct acpi_device *device);
156typedef void (*acpi_op_notify) (struct acpi_device * device, u32 event);
157
158struct acpi_device_ops {
159 acpi_op_add add;
160 acpi_op_remove remove;
161 acpi_op_notify notify;
162};
163
164#define ACPI_DRIVER_ALL_NOTIFY_EVENTS 0x1 /* system AND device events */
165
166struct acpi_driver {
167 char name[80];
168 char class[80];
169 const struct acpi_device_id *ids; /* Supported Hardware IDs */
170 unsigned int flags;
171 struct acpi_device_ops ops;
172 struct device_driver drv;
173 struct module *owner;
174};
175
176/*
177 * ACPI Device
178 * -----------
179 */
180
181/* Status (_STA) */
182
183struct acpi_device_status {
184 u32 present:1;
185 u32 enabled:1;
186 u32 show_in_ui:1;
187 u32 functional:1;
188 u32 battery_present:1;
189 u32 reserved:27;
190};
191
192/* Flags */
193
194struct acpi_device_flags {
195 u32 dynamic_status:1;
196 u32 removable:1;
197 u32 ejectable:1;
198 u32 power_manageable:1;
199 u32 match_driver:1;
200 u32 initialized:1;
201 u32 visited:1;
202 u32 hotplug_notify:1;
203 u32 is_dock_station:1;
204 u32 of_compatible_ok:1;
205 u32 coherent_dma:1;
206 u32 cca_seen:1;
207 u32 enumeration_by_parent:1;
208 u32 honor_deps:1;
209 u32 reserved:18;
210};
211
212/* File System */
213
214struct acpi_device_dir {
215 struct proc_dir_entry *entry;
216};
217
218#define acpi_device_dir(d) ((d)->dir.entry)
219
220/* Plug and Play */
221
222typedef char acpi_bus_id[8];
223typedef u64 acpi_bus_address;
224typedef char acpi_device_name[40];
225typedef char acpi_device_class[20];
226
227struct acpi_hardware_id {
228 struct list_head list;
229 const char *id;
230};
231
232struct acpi_pnp_type {
233 u32 hardware_id:1;
234 u32 bus_address:1;
235 u32 platform_id:1;
236 u32 backlight:1;
237 u32 reserved:28;
238};
239
240struct acpi_device_pnp {
241 acpi_bus_id bus_id; /* Object name */
242 int instance_no; /* Instance number of this object */
243 struct acpi_pnp_type type; /* ID type */
244 acpi_bus_address bus_address; /* _ADR */
245 char *unique_id; /* _UID */
246 struct list_head ids; /* _HID and _CIDs */
247 acpi_device_name device_name; /* Driver-determined */
248 acpi_device_class device_class; /* " */
249 union acpi_object *str_obj; /* unicode string for _STR method */
250};
251
252#define acpi_device_bid(d) ((d)->pnp.bus_id)
253#define acpi_device_adr(d) ((d)->pnp.bus_address)
254const char *acpi_device_hid(struct acpi_device *device);
255#define acpi_device_uid(d) ((d)->pnp.unique_id)
256#define acpi_device_name(d) ((d)->pnp.device_name)
257#define acpi_device_class(d) ((d)->pnp.device_class)
258
259/* Power Management */
260
261struct acpi_device_power_flags {
262 u32 explicit_get:1; /* _PSC present? */
263 u32 power_resources:1; /* Power resources */
264 u32 inrush_current:1; /* Serialize Dx->D0 */
265 u32 power_removed:1; /* Optimize Dx->D0 */
266 u32 ignore_parent:1; /* Power is independent of parent power state */
267 u32 dsw_present:1; /* _DSW present? */
268 u32 reserved:26;
269};
270
271struct acpi_device_power_state {
272 struct {
273 u8 valid:1;
274 u8 explicit_set:1; /* _PSx present? */
275 u8 reserved:6;
276 } flags;
277 int power; /* % Power (compared to D0) */
278 int latency; /* Dx->D0 time (microseconds) */
279 struct list_head resources; /* Power resources referenced */
280};
281
282struct acpi_device_power {
283 int state; /* Current state */
284 struct acpi_device_power_flags flags;
285 struct acpi_device_power_state states[ACPI_D_STATE_COUNT]; /* Power states (D0-D3Cold) */
286 u8 state_for_enumeration; /* Deepest power state for enumeration */
287};
288
289struct acpi_dep_data {
290 struct list_head node;
291 acpi_handle supplier;
292 acpi_handle consumer;
293 bool honor_dep;
294 bool met;
295 bool free_when_met;
296};
297
298/* Performance Management */
299
300struct acpi_device_perf_flags {
301 u8 reserved:8;
302};
303
304struct acpi_device_perf_state {
305 struct {
306 u8 valid:1;
307 u8 reserved:7;
308 } flags;
309 u8 power; /* % Power (compared to P0) */
310 u8 performance; /* % Performance ( " ) */
311 int latency; /* Px->P0 time (microseconds) */
312};
313
314struct acpi_device_perf {
315 int state;
316 struct acpi_device_perf_flags flags;
317 int state_count;
318 struct acpi_device_perf_state *states;
319};
320
321/* Wakeup Management */
322struct acpi_device_wakeup_flags {
323 u8 valid:1; /* Can successfully enable wakeup? */
324 u8 notifier_present:1; /* Wake-up notify handler has been installed */
325};
326
327struct acpi_device_wakeup_context {
328 void (*func)(struct acpi_device_wakeup_context *context);
329 struct device *dev;
330};
331
332struct acpi_device_wakeup {
333 acpi_handle gpe_device;
334 u64 gpe_number;
335 u64 sleep_state;
336 struct list_head resources;
337 struct acpi_device_wakeup_flags flags;
338 struct acpi_device_wakeup_context context;
339 struct wakeup_source *ws;
340 int prepare_count;
341 int enable_count;
342};
343
344struct acpi_device_physical_node {
345 unsigned int node_id;
346 struct list_head node;
347 struct device *dev;
348 bool put_online:1;
349};
350
351struct acpi_device_properties {
352 const guid_t *guid;
353 union acpi_object *properties;
354 struct list_head list;
355 void **bufs;
356};
357
358/* ACPI Device Specific Data (_DSD) */
359struct acpi_device_data {
360 const union acpi_object *pointer;
361 struct list_head properties;
362 const union acpi_object *of_compatible;
363 struct list_head subnodes;
364};
365
366struct acpi_gpio_mapping;
367
368#define ACPI_DEVICE_SWNODE_ROOT 0
369
370/*
371 * The maximum expected number of CSI-2 data lanes.
372 *
373 * This number is not expected to ever have to be equal to or greater than the
374 * number of bits in an unsigned long variable, but if it needs to be increased
375 * above that limit, code will need to be adjusted accordingly.
376 */
377#define ACPI_DEVICE_CSI2_DATA_LANES 8
378
379#define ACPI_DEVICE_SWNODE_PORT_NAME_LENGTH 8
380
381enum acpi_device_swnode_dev_props {
382 ACPI_DEVICE_SWNODE_DEV_ROTATION,
383 ACPI_DEVICE_SWNODE_DEV_CLOCK_FREQUENCY,
384 ACPI_DEVICE_SWNODE_DEV_LED_MAX_MICROAMP,
385 ACPI_DEVICE_SWNODE_DEV_FLASH_MAX_MICROAMP,
386 ACPI_DEVICE_SWNODE_DEV_FLASH_MAX_TIMEOUT_US,
387 ACPI_DEVICE_SWNODE_DEV_NUM_OF,
388 ACPI_DEVICE_SWNODE_DEV_NUM_ENTRIES
389};
390
391enum acpi_device_swnode_port_props {
392 ACPI_DEVICE_SWNODE_PORT_REG,
393 ACPI_DEVICE_SWNODE_PORT_NUM_OF,
394 ACPI_DEVICE_SWNODE_PORT_NUM_ENTRIES
395};
396
397enum acpi_device_swnode_ep_props {
398 ACPI_DEVICE_SWNODE_EP_REMOTE_EP,
399 ACPI_DEVICE_SWNODE_EP_BUS_TYPE,
400 ACPI_DEVICE_SWNODE_EP_REG,
401 ACPI_DEVICE_SWNODE_EP_CLOCK_LANES,
402 ACPI_DEVICE_SWNODE_EP_DATA_LANES,
403 ACPI_DEVICE_SWNODE_EP_LANE_POLARITIES,
404 /* TX only */
405 ACPI_DEVICE_SWNODE_EP_LINK_FREQUENCIES,
406 ACPI_DEVICE_SWNODE_EP_NUM_OF,
407 ACPI_DEVICE_SWNODE_EP_NUM_ENTRIES
408};
409
410/*
411 * Each device has a root software node plus two times as many nodes as the
412 * number of CSI-2 ports.
413 */
414#define ACPI_DEVICE_SWNODE_PORT(port) (2 * (port) + 1)
415#define ACPI_DEVICE_SWNODE_EP(endpoint) \
416 (ACPI_DEVICE_SWNODE_PORT(endpoint) + 1)
417
418/**
419 * struct acpi_device_software_node_port - MIPI DisCo for Imaging CSI-2 port
420 * @port_name: Port name.
421 * @data_lanes: "data-lanes" property values.
422 * @lane_polarities: "lane-polarities" property values.
423 * @link_frequencies: "link_frequencies" property values.
424 * @port_nr: Port number.
425 * @crs_crs2_local: _CRS CSI2 record present (i.e. this is a transmitter one).
426 * @port_props: Port properties.
427 * @ep_props: Endpoint properties.
428 * @remote_ep: Reference to the remote endpoint.
429 */
430struct acpi_device_software_node_port {
431 char port_name[ACPI_DEVICE_SWNODE_PORT_NAME_LENGTH + 1];
432 u32 data_lanes[ACPI_DEVICE_CSI2_DATA_LANES];
433 u32 lane_polarities[ACPI_DEVICE_CSI2_DATA_LANES + 1 /* clock lane */];
434 u64 link_frequencies[ACPI_DEVICE_CSI2_DATA_LANES];
435 unsigned int port_nr;
436 bool crs_csi2_local;
437
438 struct property_entry port_props[ACPI_DEVICE_SWNODE_PORT_NUM_ENTRIES];
439 struct property_entry ep_props[ACPI_DEVICE_SWNODE_EP_NUM_ENTRIES];
440
441 struct software_node_ref_args remote_ep[1];
442};
443
444/**
445 * struct acpi_device_software_nodes - Software nodes for an ACPI device
446 * @dev_props: Device properties.
447 * @nodes: Software nodes for root as well as ports and endpoints.
448 * @nodeprts: Array of software node pointers, for (un)registering them.
449 * @ports: Information related to each port and endpoint within a port.
450 * @num_ports: The number of ports.
451 */
452struct acpi_device_software_nodes {
453 struct property_entry dev_props[ACPI_DEVICE_SWNODE_DEV_NUM_ENTRIES];
454 struct software_node *nodes;
455 const struct software_node **nodeptrs;
456 struct acpi_device_software_node_port *ports;
457 unsigned int num_ports;
458};
459
460/* Device */
461struct acpi_device {
462 u32 pld_crc;
463 int device_type;
464 acpi_handle handle; /* no handle for fixed hardware */
465 struct fwnode_handle fwnode;
466 struct list_head wakeup_list;
467 struct list_head del_list;
468 struct acpi_device_status status;
469 struct acpi_device_flags flags;
470 struct acpi_device_pnp pnp;
471 struct acpi_device_power power;
472 struct acpi_device_wakeup wakeup;
473 struct acpi_device_perf performance;
474 struct acpi_device_dir dir;
475 struct acpi_device_data data;
476 struct acpi_scan_handler *handler;
477 struct acpi_hotplug_context *hp;
478 struct acpi_device_software_nodes *swnodes;
479 const struct acpi_gpio_mapping *driver_gpios;
480 void *driver_data;
481 struct device dev;
482 unsigned int physical_node_count;
483 unsigned int dep_unmet;
484 struct list_head physical_node_list;
485 struct mutex physical_node_lock;
486 void (*remove)(struct acpi_device *);
487};
488
489/* Non-device subnode */
490struct acpi_data_node {
491 const char *name;
492 acpi_handle handle;
493 struct fwnode_handle fwnode;
494 struct fwnode_handle *parent;
495 struct acpi_device_data data;
496 struct list_head sibling;
497 struct kobject kobj;
498 struct completion kobj_done;
499};
500
501extern const struct fwnode_operations acpi_device_fwnode_ops;
502extern const struct fwnode_operations acpi_data_fwnode_ops;
503extern const struct fwnode_operations acpi_static_fwnode_ops;
504
505bool is_acpi_device_node(const struct fwnode_handle *fwnode);
506bool is_acpi_data_node(const struct fwnode_handle *fwnode);
507
508static inline bool is_acpi_node(const struct fwnode_handle *fwnode)
509{
510 return (is_acpi_device_node(fwnode) || is_acpi_data_node(fwnode));
511}
512
513#define to_acpi_device_node(__fwnode) \
514 ({ \
515 typeof(__fwnode) __to_acpi_device_node_fwnode = __fwnode; \
516 \
517 is_acpi_device_node(__to_acpi_device_node_fwnode) ? \
518 container_of(__to_acpi_device_node_fwnode, \
519 struct acpi_device, fwnode) : \
520 NULL; \
521 })
522
523#define to_acpi_data_node(__fwnode) \
524 ({ \
525 typeof(__fwnode) __to_acpi_data_node_fwnode = __fwnode; \
526 \
527 is_acpi_data_node(__to_acpi_data_node_fwnode) ? \
528 container_of(__to_acpi_data_node_fwnode, \
529 struct acpi_data_node, fwnode) : \
530 NULL; \
531 })
532
533static inline bool is_acpi_static_node(const struct fwnode_handle *fwnode)
534{
535 return !IS_ERR_OR_NULL(fwnode) &&
536 fwnode->ops == &acpi_static_fwnode_ops;
537}
538
539static inline bool acpi_data_node_match(const struct fwnode_handle *fwnode,
540 const char *name)
541{
542 return is_acpi_data_node(fwnode) ?
543 (!strcmp(to_acpi_data_node(fwnode)->name, name)) : false;
544}
545
546static inline struct fwnode_handle *acpi_fwnode_handle(struct acpi_device *adev)
547{
548 return &adev->fwnode;
549}
550
551static inline void *acpi_driver_data(struct acpi_device *d)
552{
553 return d->driver_data;
554}
555
556#define to_acpi_device(d) container_of(d, struct acpi_device, dev)
557#define to_acpi_driver(d) container_of(d, struct acpi_driver, drv)
558
559static inline struct acpi_device *acpi_dev_parent(struct acpi_device *adev)
560{
561 if (adev->dev.parent)
562 return to_acpi_device(adev->dev.parent);
563
564 return NULL;
565}
566
567static inline void acpi_set_device_status(struct acpi_device *adev, u32 sta)
568{
569 *((u32 *)&adev->status) = sta;
570}
571
572static inline void acpi_set_hp_context(struct acpi_device *adev,
573 struct acpi_hotplug_context *hp)
574{
575 hp->self = adev;
576 adev->hp = hp;
577}
578
579void acpi_initialize_hp_context(struct acpi_device *adev,
580 struct acpi_hotplug_context *hp,
581 int (*notify)(struct acpi_device *, u32),
582 void (*uevent)(struct acpi_device *, u32));
583
584/* acpi_device.dev.bus == &acpi_bus_type */
585extern struct bus_type acpi_bus_type;
586
587int acpi_bus_for_each_dev(int (*fn)(struct device *, void *), void *data);
588int acpi_dev_for_each_child(struct acpi_device *adev,
589 int (*fn)(struct acpi_device *, void *), void *data);
590int acpi_dev_for_each_child_reverse(struct acpi_device *adev,
591 int (*fn)(struct acpi_device *, void *),
592 void *data);
593
594/*
595 * Events
596 * ------
597 */
598
599struct acpi_bus_event {
600 struct list_head node;
601 acpi_device_class device_class;
602 acpi_bus_id bus_id;
603 u32 type;
604 u32 data;
605};
606
607extern struct kobject *acpi_kobj;
608extern int acpi_bus_generate_netlink_event(const char*, const char*, u8, int);
609void acpi_bus_private_data_handler(acpi_handle, void *);
610int acpi_bus_get_private_data(acpi_handle, void **);
611int acpi_bus_attach_private_data(acpi_handle, void *);
612void acpi_bus_detach_private_data(acpi_handle);
613int acpi_dev_install_notify_handler(struct acpi_device *adev,
614 u32 handler_type,
615 acpi_notify_handler handler, void *context);
616void acpi_dev_remove_notify_handler(struct acpi_device *adev,
617 u32 handler_type,
618 acpi_notify_handler handler);
619extern int acpi_notifier_call_chain(struct acpi_device *, u32, u32);
620extern int register_acpi_notifier(struct notifier_block *);
621extern int unregister_acpi_notifier(struct notifier_block *);
622
623/*
624 * External Functions
625 */
626
627acpi_status acpi_bus_get_status_handle(acpi_handle handle,
628 unsigned long long *sta);
629int acpi_bus_get_status(struct acpi_device *device);
630
631int acpi_bus_set_power(acpi_handle handle, int state);
632const char *acpi_power_state_string(int state);
633int acpi_device_set_power(struct acpi_device *device, int state);
634int acpi_bus_init_power(struct acpi_device *device);
635int acpi_device_fix_up_power(struct acpi_device *device);
636void acpi_device_fix_up_power_extended(struct acpi_device *adev);
637void acpi_device_fix_up_power_children(struct acpi_device *adev);
638int acpi_bus_update_power(acpi_handle handle, int *state_p);
639int acpi_device_update_power(struct acpi_device *device, int *state_p);
640bool acpi_bus_power_manageable(acpi_handle handle);
641void acpi_dev_power_up_children_with_adr(struct acpi_device *adev);
642u8 acpi_dev_power_state_for_wake(struct acpi_device *adev);
643int acpi_device_power_add_dependent(struct acpi_device *adev,
644 struct device *dev);
645void acpi_device_power_remove_dependent(struct acpi_device *adev,
646 struct device *dev);
647
648#ifdef CONFIG_PM
649bool acpi_bus_can_wakeup(acpi_handle handle);
650#else
651static inline bool acpi_bus_can_wakeup(acpi_handle handle) { return false; }
652#endif
653
654void acpi_scan_lock_acquire(void);
655void acpi_scan_lock_release(void);
656void acpi_lock_hp_context(void);
657void acpi_unlock_hp_context(void);
658int acpi_scan_add_handler(struct acpi_scan_handler *handler);
659int acpi_bus_register_driver(struct acpi_driver *driver);
660void acpi_bus_unregister_driver(struct acpi_driver *driver);
661int acpi_bus_scan(acpi_handle handle);
662void acpi_bus_trim(struct acpi_device *start);
663acpi_status acpi_bus_get_ejd(acpi_handle handle, acpi_handle * ejd);
664int acpi_match_device_ids(struct acpi_device *device,
665 const struct acpi_device_id *ids);
666void acpi_set_modalias(struct acpi_device *adev, const char *default_id,
667 char *modalias, size_t len);
668
669static inline bool acpi_device_enumerated(struct acpi_device *adev)
670{
671 return adev && adev->flags.initialized && adev->flags.visited;
672}
673
674/**
675 * module_acpi_driver(acpi_driver) - Helper macro for registering an ACPI driver
676 * @__acpi_driver: acpi_driver struct
677 *
678 * Helper macro for ACPI drivers which do not do anything special in module
679 * init/exit. This eliminates a lot of boilerplate. Each module may only
680 * use this macro once, and calling it replaces module_init() and module_exit()
681 */
682#define module_acpi_driver(__acpi_driver) \
683 module_driver(__acpi_driver, acpi_bus_register_driver, \
684 acpi_bus_unregister_driver)
685
686/*
687 * Bind physical devices with ACPI devices
688 */
689struct acpi_bus_type {
690 struct list_head list;
691 const char *name;
692 bool (*match)(struct device *dev);
693 struct acpi_device * (*find_companion)(struct device *);
694 void (*setup)(struct device *);
695};
696int register_acpi_bus_type(struct acpi_bus_type *);
697int unregister_acpi_bus_type(struct acpi_bus_type *);
698int acpi_bind_one(struct device *dev, struct acpi_device *adev);
699int acpi_unbind_one(struct device *dev);
700
701enum acpi_bridge_type {
702 ACPI_BRIDGE_TYPE_PCIE = 1,
703 ACPI_BRIDGE_TYPE_CXL,
704};
705
706struct acpi_pci_root {
707 struct acpi_device * device;
708 struct pci_bus *bus;
709 u16 segment;
710 int bridge_type;
711 struct resource secondary; /* downstream bus range */
712
713 u32 osc_support_set; /* _OSC state of support bits */
714 u32 osc_control_set; /* _OSC state of control bits */
715 u32 osc_ext_support_set; /* _OSC state of extended support bits */
716 u32 osc_ext_control_set; /* _OSC state of extended control bits */
717 phys_addr_t mcfg_addr;
718};
719
720/* helper */
721
722struct iommu_ops;
723
724bool acpi_dma_supported(const struct acpi_device *adev);
725enum dev_dma_attr acpi_get_dma_attr(struct acpi_device *adev);
726int acpi_iommu_fwspec_init(struct device *dev, u32 id,
727 struct fwnode_handle *fwnode,
728 const struct iommu_ops *ops);
729int acpi_dma_get_range(struct device *dev, const struct bus_dma_region **map);
730int acpi_dma_configure_id(struct device *dev, enum dev_dma_attr attr,
731 const u32 *input_id);
732static inline int acpi_dma_configure(struct device *dev,
733 enum dev_dma_attr attr)
734{
735 return acpi_dma_configure_id(dev, attr, NULL);
736}
737struct acpi_device *acpi_find_child_device(struct acpi_device *parent,
738 u64 address, bool check_children);
739struct acpi_device *acpi_find_child_by_adr(struct acpi_device *adev,
740 acpi_bus_address adr);
741int acpi_is_root_bridge(acpi_handle);
742struct acpi_pci_root *acpi_pci_find_root(acpi_handle handle);
743
744int acpi_enable_wakeup_device_power(struct acpi_device *dev, int state);
745int acpi_disable_wakeup_device_power(struct acpi_device *dev);
746
747#ifdef CONFIG_X86
748bool acpi_device_override_status(struct acpi_device *adev, unsigned long long *status);
749bool acpi_quirk_skip_acpi_ac_and_battery(void);
750int acpi_install_cmos_rtc_space_handler(acpi_handle handle);
751void acpi_remove_cmos_rtc_space_handler(acpi_handle handle);
752#else
753static inline bool acpi_device_override_status(struct acpi_device *adev,
754 unsigned long long *status)
755{
756 return false;
757}
758static inline bool acpi_quirk_skip_acpi_ac_and_battery(void)
759{
760 return false;
761}
762static inline int acpi_install_cmos_rtc_space_handler(acpi_handle handle)
763{
764 return 1;
765}
766static inline void acpi_remove_cmos_rtc_space_handler(acpi_handle handle)
767{
768}
769#endif
770
771#if IS_ENABLED(CONFIG_X86_ANDROID_TABLETS)
772bool acpi_quirk_skip_i2c_client_enumeration(struct acpi_device *adev);
773int acpi_quirk_skip_serdev_enumeration(struct device *controller_parent, bool *skip);
774bool acpi_quirk_skip_gpio_event_handlers(void);
775#else
776static inline bool acpi_quirk_skip_i2c_client_enumeration(struct acpi_device *adev)
777{
778 return false;
779}
780static inline int
781acpi_quirk_skip_serdev_enumeration(struct device *controller_parent, bool *skip)
782{
783 *skip = false;
784 return 0;
785}
786static inline bool acpi_quirk_skip_gpio_event_handlers(void)
787{
788 return false;
789}
790#endif
791
792#ifdef CONFIG_PM
793void acpi_pm_wakeup_event(struct device *dev);
794acpi_status acpi_add_pm_notifier(struct acpi_device *adev, struct device *dev,
795 void (*func)(struct acpi_device_wakeup_context *context));
796acpi_status acpi_remove_pm_notifier(struct acpi_device *adev);
797bool acpi_pm_device_can_wakeup(struct device *dev);
798int acpi_pm_device_sleep_state(struct device *, int *, int);
799int acpi_pm_set_device_wakeup(struct device *dev, bool enable);
800#else
801static inline void acpi_pm_wakeup_event(struct device *dev)
802{
803}
804static inline acpi_status acpi_add_pm_notifier(struct acpi_device *adev,
805 struct device *dev,
806 void (*func)(struct acpi_device_wakeup_context *context))
807{
808 return AE_SUPPORT;
809}
810static inline acpi_status acpi_remove_pm_notifier(struct acpi_device *adev)
811{
812 return AE_SUPPORT;
813}
814static inline bool acpi_pm_device_can_wakeup(struct device *dev)
815{
816 return false;
817}
818static inline int acpi_pm_device_sleep_state(struct device *d, int *p, int m)
819{
820 if (p)
821 *p = ACPI_STATE_D0;
822
823 return (m >= ACPI_STATE_D0 && m <= ACPI_STATE_D3_COLD) ?
824 m : ACPI_STATE_D0;
825}
826static inline int acpi_pm_set_device_wakeup(struct device *dev, bool enable)
827{
828 return -ENODEV;
829}
830#endif
831
832#ifdef CONFIG_ACPI_SYSTEM_POWER_STATES_SUPPORT
833bool acpi_sleep_state_supported(u8 sleep_state);
834#else
835static inline bool acpi_sleep_state_supported(u8 sleep_state) { return false; }
836#endif
837
838#ifdef CONFIG_ACPI_SLEEP
839u32 acpi_target_system_state(void);
840#else
841static inline u32 acpi_target_system_state(void) { return ACPI_STATE_S0; }
842#endif
843
844static inline bool acpi_device_power_manageable(struct acpi_device *adev)
845{
846 return adev->flags.power_manageable;
847}
848
849static inline bool acpi_device_can_wakeup(struct acpi_device *adev)
850{
851 return adev->wakeup.flags.valid;
852}
853
854static inline bool acpi_device_can_poweroff(struct acpi_device *adev)
855{
856 return adev->power.states[ACPI_STATE_D3_COLD].flags.valid ||
857 ((acpi_gbl_FADT.header.revision < 6) &&
858 adev->power.states[ACPI_STATE_D3_HOT].flags.explicit_set);
859}
860
861int acpi_dev_uid_to_integer(struct acpi_device *adev, u64 *integer);
862
863static inline bool acpi_dev_hid_match(struct acpi_device *adev, const char *hid2)
864{
865 const char *hid1 = acpi_device_hid(adev);
866
867 return hid1 && hid2 && !strcmp(hid1, hid2);
868}
869
870static inline bool acpi_str_uid_match(struct acpi_device *adev, const char *uid2)
871{
872 const char *uid1 = acpi_device_uid(adev);
873
874 return uid1 && uid2 && !strcmp(uid1, uid2);
875}
876
877static inline bool acpi_int_uid_match(struct acpi_device *adev, u64 uid2)
878{
879 u64 uid1;
880
881 return !acpi_dev_uid_to_integer(adev, &uid1) && uid1 == uid2;
882}
883
884#define TYPE_ENTRY(type, x) \
885 const type: x, \
886 type: x
887
888#define ACPI_STR_TYPES(match) \
889 TYPE_ENTRY(unsigned char *, match), \
890 TYPE_ENTRY(signed char *, match), \
891 TYPE_ENTRY(char *, match), \
892 TYPE_ENTRY(void *, match)
893
894/**
895 * acpi_dev_uid_match - Match device by supplied UID
896 * @adev: ACPI device to match.
897 * @uid2: Unique ID of the device.
898 *
899 * Matches UID in @adev with given @uid2.
900 *
901 * Returns: %true if matches, %false otherwise.
902 */
903#define acpi_dev_uid_match(adev, uid2) \
904 _Generic(uid2, \
905 /* Treat @uid2 as a string for acpi string types */ \
906 ACPI_STR_TYPES(acpi_str_uid_match), \
907 /* Treat as an integer otherwise */ \
908 default: acpi_int_uid_match)(adev, uid2)
909
910/**
911 * acpi_dev_hid_uid_match - Match device by supplied HID and UID
912 * @adev: ACPI device to match.
913 * @hid2: Hardware ID of the device.
914 * @uid2: Unique ID of the device, pass 0 or NULL to not check _UID.
915 *
916 * Matches HID and UID in @adev with given @hid2 and @uid2. Absence of @uid2
917 * will be treated as a match. If user wants to validate @uid2, it should be
918 * done before calling this function.
919 *
920 * Returns: %true if matches or @uid2 is 0 or NULL, %false otherwise.
921 */
922#define acpi_dev_hid_uid_match(adev, hid2, uid2) \
923 (acpi_dev_hid_match(adev, hid2) && \
924 (!(uid2) || acpi_dev_uid_match(adev, uid2)))
925
926void acpi_dev_clear_dependencies(struct acpi_device *supplier);
927bool acpi_dev_ready_for_enumeration(const struct acpi_device *device);
928struct acpi_device *acpi_dev_get_next_consumer_dev(struct acpi_device *supplier,
929 struct acpi_device *start);
930
931/**
932 * for_each_acpi_consumer_dev - iterate over the consumer ACPI devices for a
933 * given supplier
934 * @supplier: Pointer to the supplier's ACPI device
935 * @consumer: Pointer to &struct acpi_device to hold the consumer, initially NULL
936 */
937#define for_each_acpi_consumer_dev(supplier, consumer) \
938 for (consumer = acpi_dev_get_next_consumer_dev(supplier, NULL); \
939 consumer; \
940 consumer = acpi_dev_get_next_consumer_dev(supplier, consumer))
941
942struct acpi_device *
943acpi_dev_get_next_match_dev(struct acpi_device *adev, const char *hid, const char *uid, s64 hrv);
944struct acpi_device *
945acpi_dev_get_first_match_dev(const char *hid, const char *uid, s64 hrv);
946
947/**
948 * for_each_acpi_dev_match - iterate over ACPI devices that matching the criteria
949 * @adev: pointer to the matching ACPI device, NULL at the end of the loop
950 * @hid: Hardware ID of the device.
951 * @uid: Unique ID of the device, pass NULL to not check _UID
952 * @hrv: Hardware Revision of the device, pass -1 to not check _HRV
953 *
954 * The caller is responsible for invoking acpi_dev_put() on the returned device.
955 */
956#define for_each_acpi_dev_match(adev, hid, uid, hrv) \
957 for (adev = acpi_dev_get_first_match_dev(hid, uid, hrv); \
958 adev; \
959 adev = acpi_dev_get_next_match_dev(adev, hid, uid, hrv))
960
961static inline struct acpi_device *acpi_dev_get(struct acpi_device *adev)
962{
963 return adev ? to_acpi_device(get_device(&adev->dev)) : NULL;
964}
965
966static inline void acpi_dev_put(struct acpi_device *adev)
967{
968 if (adev)
969 put_device(&adev->dev);
970}
971
972struct acpi_device *acpi_fetch_acpi_dev(acpi_handle handle);
973struct acpi_device *acpi_get_acpi_dev(acpi_handle handle);
974
975static inline void acpi_put_acpi_dev(struct acpi_device *adev)
976{
977 acpi_dev_put(adev);
978}
979#else /* CONFIG_ACPI */
980
981static inline int register_acpi_bus_type(void *bus) { return 0; }
982static inline int unregister_acpi_bus_type(void *bus) { return 0; }
983
984#endif /* CONFIG_ACPI */
985
986#endif /*__ACPI_BUS_H__*/
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, u64 rev, u64 funcs);
65union acpi_object *acpi_evaluate_dsm(acpi_handle handle, const u8 *uuid,
66 u64 rev, u64 func, union acpi_object *argv4);
67
68static inline union acpi_object *
69acpi_evaluate_dsm_typed(acpi_handle handle, const u8 *uuid, u64 rev, u64 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_found(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 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
430static inline struct fwnode_handle *acpi_fwnode_handle(struct acpi_device *adev)
431{
432 return &adev->fwnode;
433}
434
435static inline void *acpi_driver_data(struct acpi_device *d)
436{
437 return d->driver_data;
438}
439
440#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)
442
443static inline void acpi_set_device_status(struct acpi_device *adev, u32 sta)
444{
445 *((u32 *)&adev->status) = sta;
446}
447
448static inline void acpi_set_hp_context(struct acpi_device *adev,
449 struct acpi_hotplug_context *hp)
450{
451 hp->self = adev;
452 adev->hp = hp;
453}
454
455void 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
460/* acpi_device.dev.bus == &acpi_bus_type */
461extern struct bus_type acpi_bus_type;
462
463/*
464 * Events
465 * ------
466 */
467
468struct acpi_bus_event {
469 struct list_head node;
470 acpi_device_class device_class;
471 acpi_bus_id bus_id;
472 u32 type;
473 u32 data;
474};
475
476extern struct kobject *acpi_kobj;
477extern int acpi_bus_generate_netlink_event(const char*, const char*, u8, int);
478void acpi_bus_private_data_handler(acpi_handle, void *);
479int acpi_bus_get_private_data(acpi_handle, void **);
480int acpi_bus_attach_private_data(acpi_handle, void *);
481void acpi_bus_detach_private_data(acpi_handle);
482extern 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 *);
485
486/*
487 * External Functions
488 */
489
490int acpi_bus_get_device(acpi_handle handle, struct acpi_device **device);
491struct acpi_device *acpi_bus_get_acpi_device(acpi_handle handle);
492void acpi_bus_put_acpi_device(struct acpi_device *adev);
493acpi_status acpi_bus_get_status_handle(acpi_handle handle,
494 unsigned long long *sta);
495int acpi_bus_get_status(struct acpi_device *device);
496
497int acpi_bus_set_power(acpi_handle handle, int state);
498const char *acpi_power_state_string(int state);
499int acpi_device_get_power(struct acpi_device *device, int *state);
500int acpi_device_set_power(struct acpi_device *device, int state);
501int acpi_bus_init_power(struct acpi_device *device);
502int acpi_device_fix_up_power(struct acpi_device *device);
503int acpi_bus_update_power(acpi_handle handle, int *state_p);
504int acpi_device_update_power(struct acpi_device *device, int *state_p);
505bool acpi_bus_power_manageable(acpi_handle handle);
506
507#ifdef CONFIG_PM
508bool acpi_bus_can_wakeup(acpi_handle handle);
509#else
510static inline bool acpi_bus_can_wakeup(acpi_handle handle) { return false; }
511#endif
512
513void acpi_scan_lock_acquire(void);
514void acpi_scan_lock_release(void);
515void acpi_lock_hp_context(void);
516void acpi_unlock_hp_context(void);
517int acpi_scan_add_handler(struct acpi_scan_handler *handler);
518int acpi_bus_register_driver(struct acpi_driver *driver);
519void acpi_bus_unregister_driver(struct acpi_driver *driver);
520int acpi_bus_scan(acpi_handle handle);
521void acpi_bus_trim(struct acpi_device *start);
522acpi_status acpi_bus_get_ejd(acpi_handle handle, acpi_handle * ejd);
523int acpi_match_device_ids(struct acpi_device *device,
524 const struct acpi_device_id *ids);
525int acpi_create_dir(struct acpi_device *);
526void acpi_remove_dir(struct acpi_device *);
527
528static inline bool acpi_device_enumerated(struct acpi_device *adev)
529{
530 return adev && adev->flags.initialized && adev->flags.visited;
531}
532
533/**
534 * module_acpi_driver(acpi_driver) - Helper macro for registering an ACPI driver
535 * @__acpi_driver: acpi_driver struct
536 *
537 * Helper macro for ACPI drivers which do not do anything special in module
538 * init/exit. This eliminates a lot of boilerplate. Each module may only
539 * use this macro once, and calling it replaces module_init() and module_exit()
540 */
541#define module_acpi_driver(__acpi_driver) \
542 module_driver(__acpi_driver, acpi_bus_register_driver, \
543 acpi_bus_unregister_driver)
544
545/*
546 * Bind physical devices with ACPI devices
547 */
548struct acpi_bus_type {
549 struct list_head list;
550 const char *name;
551 bool (*match)(struct device *dev);
552 struct acpi_device * (*find_companion)(struct device *);
553 void (*setup)(struct device *);
554 void (*cleanup)(struct device *);
555};
556int register_acpi_bus_type(struct acpi_bus_type *);
557int unregister_acpi_bus_type(struct acpi_bus_type *);
558int acpi_bind_one(struct device *dev, struct acpi_device *adev);
559int acpi_unbind_one(struct device *dev);
560
561struct acpi_pci_root {
562 struct acpi_device * device;
563 struct pci_bus *bus;
564 u16 segment;
565 struct resource secondary; /* downstream bus range */
566
567 u32 osc_support_set; /* _OSC state of support bits */
568 u32 osc_control_set; /* _OSC state of control bits */
569 phys_addr_t mcfg_addr;
570};
571
572/* helper */
573
574bool acpi_dma_supported(struct acpi_device *adev);
575enum dev_dma_attr acpi_get_dma_attr(struct acpi_device *adev);
576void acpi_dma_configure(struct device *dev, enum dev_dma_attr attr);
577void acpi_dma_deconfigure(struct device *dev);
578
579struct acpi_device *acpi_find_child_device(struct acpi_device *parent,
580 u64 address, bool check_children);
581int acpi_is_root_bridge(acpi_handle);
582struct acpi_pci_root *acpi_pci_find_root(acpi_handle handle);
583
584int acpi_enable_wakeup_device_power(struct acpi_device *dev, int state);
585int acpi_disable_wakeup_device_power(struct acpi_device *dev);
586
587#ifdef CONFIG_PM
588acpi_status acpi_add_pm_notifier(struct acpi_device *adev, struct device *dev,
589 void (*work_func)(struct work_struct *work));
590acpi_status acpi_remove_pm_notifier(struct acpi_device *adev);
591int acpi_pm_device_sleep_state(struct device *, int *, int);
592int acpi_pm_device_run_wake(struct device *, bool);
593#else
594static inline acpi_status acpi_add_pm_notifier(struct acpi_device *adev,
595 struct device *dev,
596 void (*work_func)(struct work_struct *work))
597{
598 return AE_SUPPORT;
599}
600static inline acpi_status acpi_remove_pm_notifier(struct acpi_device *adev)
601{
602 return AE_SUPPORT;
603}
604static inline int acpi_pm_device_sleep_state(struct device *d, int *p, int m)
605{
606 if (p)
607 *p = ACPI_STATE_D0;
608
609 return (m >= ACPI_STATE_D0 && m <= ACPI_STATE_D3_COLD) ?
610 m : ACPI_STATE_D0;
611}
612static inline int acpi_pm_device_run_wake(struct device *dev, bool enable)
613{
614 return -ENODEV;
615}
616#endif
617
618#ifdef CONFIG_PM_SLEEP
619int acpi_pm_device_sleep_wake(struct device *, bool);
620#else
621static inline int acpi_pm_device_sleep_wake(struct device *dev, bool enable)
622{
623 return -ENODEV;
624}
625#endif
626
627#ifdef CONFIG_ACPI_SLEEP
628u32 acpi_target_system_state(void);
629#else
630static inline u32 acpi_target_system_state(void) { return ACPI_STATE_S0; }
631#endif
632
633static inline bool acpi_device_power_manageable(struct acpi_device *adev)
634{
635 return adev->flags.power_manageable;
636}
637
638static inline bool acpi_device_can_wakeup(struct acpi_device *adev)
639{
640 return adev->wakeup.flags.valid;
641}
642
643static inline bool acpi_device_can_poweroff(struct acpi_device *adev)
644{
645 return adev->power.states[ACPI_STATE_D3_COLD].flags.valid ||
646 ((acpi_gbl_FADT.header.revision < 6) &&
647 adev->power.states[ACPI_STATE_D3_HOT].flags.explicit_set);
648}
649
650#else /* CONFIG_ACPI */
651
652static inline int register_acpi_bus_type(void *bus) { return 0; }
653static inline int unregister_acpi_bus_type(void *bus) { return 0; }
654
655#endif /* CONFIG_ACPI */
656
657#endif /*__ACPI_BUS_H__*/