~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

TOMOYO Linux Cross Reference
Linux/include/acpi/acpi_bus.h

Version: ~ [ linux-5.7 ] ~ [ linux-5.6.15 ] ~ [ linux-5.5.19 ] ~ [ linux-5.4.43 ] ~ [ linux-5.3.18 ] ~ [ linux-5.2.21 ] ~ [ linux-5.1.21 ] ~ [ linux-5.0.21 ] ~ [ linux-4.20.17 ] ~ [ linux-4.19.125 ] ~ [ linux-4.18.20 ] ~ [ linux-4.17.19 ] ~ [ linux-4.16.18 ] ~ [ linux-4.15.18 ] ~ [ linux-4.14.182 ] ~ [ linux-4.13.16 ] ~ [ linux-4.12.14 ] ~ [ linux-4.11.12 ] ~ [ linux-4.10.17 ] ~ [ linux-4.9.225 ] ~ [ linux-4.8.17 ] ~ [ linux-4.7.10 ] ~ [ linux-4.6.7 ] ~ [ linux-4.5.7 ] ~ [ linux-4.4.225 ] ~ [ linux-4.3.6 ] ~ [ linux-4.2.8 ] ~ [ linux-4.1.52 ] ~ [ linux-4.0.9 ] ~ [ linux-3.19.8 ] ~ [ linux-3.18.140 ] ~ [ linux-3.17.8 ] ~ [ linux-3.16.84 ] ~ [ linux-3.15.10 ] ~ [ linux-3.14.79 ] ~ [ linux-3.13.11 ] ~ [ linux-3.12.74 ] ~ [ linux-3.11.10 ] ~ [ linux-3.10.108 ] ~ [ linux-2.6.32.71 ] ~ [ linux-2.6.0 ] ~ [ linux-2.4.37.11 ] ~ [ unix-v6-master ] ~ [ ccs-tools-1.8.5 ] ~ [ policy-sample ] ~
Architecture: ~ [ i386 ] ~ [ alpha ] ~ [ m68k ] ~ [ mips ] ~ [ ppc ] ~ [ sparc ] ~ [ sparc64 ] ~

  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
 35 struct acpi_handle_list {
 36         u32 count;
 37         acpi_handle handles[ACPI_MAX_HANDLES];
 38 };
 39 
 40 /* acpi_utils.h */
 41 acpi_status
 42 acpi_extract_package(union acpi_object *package,
 43                      struct acpi_buffer *format, struct acpi_buffer *buffer);
 44 acpi_status
 45 acpi_evaluate_integer(acpi_handle handle,
 46                       acpi_string pathname,
 47                       struct acpi_object_list *arguments, unsigned long long *data);
 48 acpi_status
 49 acpi_evaluate_reference(acpi_handle handle,
 50                         acpi_string pathname,
 51                         struct acpi_object_list *arguments,
 52                         struct acpi_handle_list *list);
 53 acpi_status
 54 acpi_evaluate_hotplug_ost(acpi_handle handle, u32 source_event,
 55                         u32 status_code, struct acpi_buffer *status_buf);
 56 
 57 acpi_status
 58 acpi_get_physical_device_location(acpi_handle handle, struct acpi_pld_info **pld);
 59 
 60 bool acpi_has_method(acpi_handle handle, char *name);
 61 acpi_status acpi_execute_simple_method(acpi_handle handle, char *method,
 62                                        u64 arg);
 63 acpi_status acpi_evaluate_ej0(acpi_handle handle);
 64 acpi_status acpi_evaluate_lck(acpi_handle handle, int lock);
 65 bool acpi_ata_match(acpi_handle handle);
 66 bool acpi_bay_match(acpi_handle handle);
 67 bool acpi_dock_match(acpi_handle handle);
 68 
 69 #ifdef CONFIG_ACPI
 70 
 71 #include <linux/proc_fs.h>
 72 
 73 #define ACPI_BUS_FILE_ROOT      "acpi"
 74 extern struct proc_dir_entry *acpi_root_dir;
 75 
 76 enum acpi_bus_device_type {
 77         ACPI_BUS_TYPE_DEVICE = 0,
 78         ACPI_BUS_TYPE_POWER,
 79         ACPI_BUS_TYPE_PROCESSOR,
 80         ACPI_BUS_TYPE_THERMAL,
 81         ACPI_BUS_TYPE_POWER_BUTTON,
 82         ACPI_BUS_TYPE_SLEEP_BUTTON,
 83         ACPI_BUS_DEVICE_TYPE_COUNT
 84 };
 85 
 86 struct acpi_driver;
 87 struct acpi_device;
 88 
 89 /*
 90  * ACPI Scan Handler
 91  * -----------------
 92  */
 93 
 94 enum acpi_hotplug_mode {
 95         AHM_GENERIC = 0,
 96         AHM_CONTAINER,
 97         AHM_COUNT
 98 };
 99 
100 struct acpi_hotplug_profile {
101         struct kobject kobj;
102         bool enabled:1;
103         bool ignore:1;
104         enum acpi_hotplug_mode mode;
105 };
106 
107 static inline struct acpi_hotplug_profile *to_acpi_hotplug_profile(
108                                                 struct kobject *kobj)
109 {
110         return container_of(kobj, struct acpi_hotplug_profile, kobj);
111 }
112 
113 struct acpi_scan_handler {
114         const struct acpi_device_id *ids;
115         struct list_head list_node;
116         int (*attach)(struct acpi_device *dev, const struct acpi_device_id *id);
117         void (*detach)(struct acpi_device *dev);
118         struct acpi_hotplug_profile hotplug;
119 };
120 
121 /*
122  * ACPI Driver
123  * -----------
124  */
125 
126 typedef int (*acpi_op_add) (struct acpi_device * device);
127 typedef int (*acpi_op_remove) (struct acpi_device * device);
128 typedef void (*acpi_op_notify) (struct acpi_device * device, u32 event);
129 
130 struct acpi_device_ops {
131         acpi_op_add add;
132         acpi_op_remove remove;
133         acpi_op_notify notify;
134 };
135 
136 #define ACPI_DRIVER_ALL_NOTIFY_EVENTS   0x1     /* system AND device events */
137 
138 struct acpi_driver {
139         char name[80];
140         char class[80];
141         const struct acpi_device_id *ids; /* Supported Hardware IDs */
142         unsigned int flags;
143         struct acpi_device_ops ops;
144         struct device_driver drv;
145         struct module *owner;
146 };
147 
148 /*
149  * ACPI Device
150  * -----------
151  */
152 
153 /* Status (_STA) */
154 
155 struct acpi_device_status {
156         u32 present:1;
157         u32 enabled:1;
158         u32 show_in_ui:1;
159         u32 functional:1;
160         u32 battery_present:1;
161         u32 reserved:27;
162 };
163 
164 /* Flags */
165 
166 struct acpi_device_flags {
167         u32 dynamic_status:1;
168         u32 removable:1;
169         u32 ejectable:1;
170         u32 power_manageable:1;
171         u32 match_driver:1;
172         u32 no_hotplug:1;
173         u32 reserved:26;
174 };
175 
176 /* File System */
177 
178 struct acpi_device_dir {
179         struct proc_dir_entry *entry;
180 };
181 
182 #define acpi_device_dir(d)      ((d)->dir.entry)
183 
184 /* Plug and Play */
185 
186 typedef char acpi_bus_id[8];
187 typedef unsigned long acpi_bus_address;
188 typedef char acpi_device_name[40];
189 typedef char acpi_device_class[20];
190 
191 struct acpi_hardware_id {
192         struct list_head list;
193         char *id;
194 };
195 
196 struct acpi_pnp_type {
197         u32 hardware_id:1;
198         u32 bus_address:1;
199         u32 reserved:30;
200 };
201 
202 struct acpi_device_pnp {
203         acpi_bus_id bus_id;             /* Object name */
204         struct acpi_pnp_type type;      /* ID type */
205         acpi_bus_address bus_address;   /* _ADR */
206         char *unique_id;                /* _UID */
207         struct list_head ids;           /* _HID and _CIDs */
208         acpi_device_name device_name;   /* Driver-determined */
209         acpi_device_class device_class; /*        "          */
210         union acpi_object *str_obj;     /* unicode string for _STR method */
211         unsigned long sun;              /* _SUN */
212 };
213 
214 #define acpi_device_bid(d)      ((d)->pnp.bus_id)
215 #define acpi_device_adr(d)      ((d)->pnp.bus_address)
216 const char *acpi_device_hid(struct acpi_device *device);
217 #define acpi_device_name(d)     ((d)->pnp.device_name)
218 #define acpi_device_class(d)    ((d)->pnp.device_class)
219 
220 /* Power Management */
221 
222 struct acpi_device_power_flags {
223         u32 explicit_get:1;     /* _PSC present? */
224         u32 power_resources:1;  /* Power resources */
225         u32 inrush_current:1;   /* Serialize Dx->D0 */
226         u32 power_removed:1;    /* Optimize Dx->D0 */
227         u32 reserved:28;
228 };
229 
230 struct acpi_device_power_state {
231         struct {
232                 u8 valid:1;
233                 u8 os_accessible:1;
234                 u8 explicit_set:1;      /* _PSx present? */
235                 u8 reserved:6;
236         } flags;
237         int power;              /* % Power (compared to D0) */
238         int latency;            /* Dx->D0 time (microseconds) */
239         struct list_head resources;     /* Power resources referenced */
240 };
241 
242 struct acpi_device_power {
243         int state;              /* Current state */
244         struct acpi_device_power_flags flags;
245         struct acpi_device_power_state states[ACPI_D_STATE_COUNT];      /* Power states (D0-D3Cold) */
246 };
247 
248 /* Performance Management */
249 
250 struct acpi_device_perf_flags {
251         u8 reserved:8;
252 };
253 
254 struct acpi_device_perf_state {
255         struct {
256                 u8 valid:1;
257                 u8 reserved:7;
258         } flags;
259         u8 power;               /* % Power (compared to P0) */
260         u8 performance;         /* % Performance (    "   ) */
261         int latency;            /* Px->P0 time (microseconds) */
262 };
263 
264 struct acpi_device_perf {
265         int state;
266         struct acpi_device_perf_flags flags;
267         int state_count;
268         struct acpi_device_perf_state *states;
269 };
270 
271 /* Wakeup Management */
272 struct acpi_device_wakeup_flags {
273         u8 valid:1;             /* Can successfully enable wakeup? */
274         u8 run_wake:1;          /* Run-Wake GPE devices */
275         u8 notifier_present:1;  /* Wake-up notify handler has been installed */
276 };
277 
278 struct acpi_device_wakeup {
279         acpi_handle gpe_device;
280         u64 gpe_number;
281         u64 sleep_state;
282         struct list_head resources;
283         struct acpi_device_wakeup_flags flags;
284         int prepare_count;
285 };
286 
287 struct acpi_device_physical_node {
288         unsigned int node_id;
289         struct list_head node;
290         struct device *dev;
291         bool put_online:1;
292 };
293 
294 /* Device */
295 struct acpi_device {
296         int device_type;
297         acpi_handle handle;             /* no handle for fixed hardware */
298         struct acpi_device *parent;
299         struct list_head children;
300         struct list_head node;
301         struct list_head wakeup_list;
302         struct acpi_device_status status;
303         struct acpi_device_flags flags;
304         struct acpi_device_pnp pnp;
305         struct acpi_device_power power;
306         struct acpi_device_wakeup wakeup;
307         struct acpi_device_perf performance;
308         struct acpi_device_dir dir;
309         struct acpi_scan_handler *handler;
310         struct acpi_driver *driver;
311         void *driver_data;
312         struct device dev;
313         unsigned int physical_node_count;
314         struct list_head physical_node_list;
315         struct mutex physical_node_lock;
316         void (*remove)(struct acpi_device *);
317 };
318 
319 static inline void *acpi_driver_data(struct acpi_device *d)
320 {
321         return d->driver_data;
322 }
323 
324 #define to_acpi_device(d)       container_of(d, struct acpi_device, dev)
325 #define to_acpi_driver(d)       container_of(d, struct acpi_driver, drv)
326 
327 /* acpi_device.dev.bus == &acpi_bus_type */
328 extern struct bus_type acpi_bus_type;
329 
330 /*
331  * Events
332  * ------
333  */
334 
335 struct acpi_bus_event {
336         struct list_head node;
337         acpi_device_class device_class;
338         acpi_bus_id bus_id;
339         u32 type;
340         u32 data;
341 };
342 
343 struct acpi_eject_event {
344         struct acpi_device      *device;
345         u32             event;
346 };
347 
348 struct acpi_hp_work {
349         struct work_struct work;
350         acpi_handle handle;
351         u32 type;
352         void *context;
353 };
354 void alloc_acpi_hp_work(acpi_handle handle, u32 type, void *context,
355                         void (*func)(struct work_struct *work));
356 
357 extern struct kobject *acpi_kobj;
358 extern int acpi_bus_generate_netlink_event(const char*, const char*, u8, int);
359 void acpi_bus_private_data_handler(acpi_handle, void *);
360 int acpi_bus_get_private_data(acpi_handle, void **);
361 void acpi_bus_no_hotplug(acpi_handle handle);
362 extern int acpi_notifier_call_chain(struct acpi_device *, u32, u32);
363 extern int register_acpi_notifier(struct notifier_block *);
364 extern int unregister_acpi_notifier(struct notifier_block *);
365 
366 /*
367  * External Functions
368  */
369 
370 int acpi_bus_get_device(acpi_handle handle, struct acpi_device **device);
371 acpi_status acpi_bus_get_status_handle(acpi_handle handle,
372                                        unsigned long long *sta);
373 int acpi_bus_get_status(struct acpi_device *device);
374 
375 int acpi_bus_set_power(acpi_handle handle, int state);
376 const char *acpi_power_state_string(int state);
377 int acpi_device_get_power(struct acpi_device *device, int *state);
378 int acpi_device_set_power(struct acpi_device *device, int state);
379 int acpi_bus_init_power(struct acpi_device *device);
380 int acpi_device_fix_up_power(struct acpi_device *device);
381 int acpi_bus_update_power(acpi_handle handle, int *state_p);
382 bool acpi_bus_power_manageable(acpi_handle handle);
383 
384 #ifdef CONFIG_PM
385 bool acpi_bus_can_wakeup(acpi_handle handle);
386 #else
387 static inline bool acpi_bus_can_wakeup(acpi_handle handle) { return false; }
388 #endif
389 
390 void acpi_scan_lock_acquire(void);
391 void acpi_scan_lock_release(void);
392 int acpi_scan_add_handler(struct acpi_scan_handler *handler);
393 int acpi_bus_register_driver(struct acpi_driver *driver);
394 void acpi_bus_unregister_driver(struct acpi_driver *driver);
395 int acpi_bus_scan(acpi_handle handle);
396 void acpi_bus_hot_remove_device(void *context);
397 void acpi_bus_trim(struct acpi_device *start);
398 acpi_status acpi_bus_get_ejd(acpi_handle handle, acpi_handle * ejd);
399 int acpi_match_device_ids(struct acpi_device *device,
400                           const struct acpi_device_id *ids);
401 int acpi_create_dir(struct acpi_device *);
402 void acpi_remove_dir(struct acpi_device *);
403 
404 
405 /**
406  * module_acpi_driver(acpi_driver) - Helper macro for registering an ACPI driver
407  * @__acpi_driver: acpi_driver struct
408  *
409  * Helper macro for ACPI drivers which do not do anything special in module
410  * init/exit. This eliminates a lot of boilerplate. Each module may only
411  * use this macro once, and calling it replaces module_init() and module_exit()
412  */
413 #define module_acpi_driver(__acpi_driver) \
414         module_driver(__acpi_driver, acpi_bus_register_driver, \
415                       acpi_bus_unregister_driver)
416 
417 /*
418  * Bind physical devices with ACPI devices
419  */
420 struct acpi_bus_type {
421         struct list_head list;
422         const char *name;
423         bool (*match)(struct device *dev);
424         int (*find_device) (struct device *, acpi_handle *);
425         void (*setup)(struct device *);
426         void (*cleanup)(struct device *);
427 };
428 int register_acpi_bus_type(struct acpi_bus_type *);
429 int unregister_acpi_bus_type(struct acpi_bus_type *);
430 
431 struct acpi_pci_root {
432         struct acpi_device * device;
433         struct pci_bus *bus;
434         u16 segment;
435         struct resource secondary;      /* downstream bus range */
436 
437         u32 osc_support_set;    /* _OSC state of support bits */
438         u32 osc_control_set;    /* _OSC state of control bits */
439         phys_addr_t mcfg_addr;
440 };
441 
442 /* helper */
443 acpi_handle acpi_find_child(acpi_handle, u64, bool);
444 static inline acpi_handle acpi_get_child(acpi_handle handle, u64 addr)
445 {
446         return acpi_find_child(handle, addr, false);
447 }
448 int acpi_is_root_bridge(acpi_handle);
449 struct acpi_pci_root *acpi_pci_find_root(acpi_handle handle);
450 #define DEVICE_ACPI_HANDLE(dev) ((acpi_handle)ACPI_HANDLE(dev))
451 
452 int acpi_enable_wakeup_device_power(struct acpi_device *dev, int state);
453 int acpi_disable_wakeup_device_power(struct acpi_device *dev);
454 
455 #ifdef CONFIG_PM
456 acpi_status acpi_add_pm_notifier(struct acpi_device *adev,
457                                  acpi_notify_handler handler, void *context);
458 acpi_status acpi_remove_pm_notifier(struct acpi_device *adev,
459                                     acpi_notify_handler handler);
460 int acpi_pm_device_sleep_state(struct device *, int *, int);
461 #else
462 static inline acpi_status acpi_add_pm_notifier(struct acpi_device *adev,
463                                                acpi_notify_handler handler,
464                                                void *context)
465 {
466         return AE_SUPPORT;
467 }
468 static inline acpi_status acpi_remove_pm_notifier(struct acpi_device *adev,
469                                                   acpi_notify_handler handler)
470 {
471         return AE_SUPPORT;
472 }
473 static inline int acpi_pm_device_sleep_state(struct device *d, int *p, int m)
474 {
475         if (p)
476                 *p = ACPI_STATE_D0;
477 
478         return (m >= ACPI_STATE_D0 && m <= ACPI_STATE_D3_COLD) ?
479                 m : ACPI_STATE_D0;
480 }
481 #endif
482 
483 #ifdef CONFIG_PM_RUNTIME
484 int __acpi_device_run_wake(struct acpi_device *, bool);
485 int acpi_pm_device_run_wake(struct device *, bool);
486 #else
487 static inline int __acpi_device_run_wake(struct acpi_device *adev, bool en)
488 {
489         return -ENODEV;
490 }
491 static inline int acpi_pm_device_run_wake(struct device *dev, bool enable)
492 {
493         return -ENODEV;
494 }
495 #endif
496 
497 #ifdef CONFIG_PM_SLEEP
498 int __acpi_device_sleep_wake(struct acpi_device *, u32, bool);
499 int acpi_pm_device_sleep_wake(struct device *, bool);
500 #else
501 static inline int __acpi_device_sleep_wake(struct acpi_device *adev,
502                                            u32 target_state, bool enable)
503 {
504         return -ENODEV;
505 }
506 static inline int acpi_pm_device_sleep_wake(struct device *dev, bool enable)
507 {
508         return -ENODEV;
509 }
510 #endif
511 
512 #ifdef CONFIG_ACPI_SLEEP
513 u32 acpi_target_system_state(void);
514 #else
515 static inline u32 acpi_target_system_state(void) { return ACPI_STATE_S0; }
516 #endif
517 
518 static inline bool acpi_device_power_manageable(struct acpi_device *adev)
519 {
520         return adev->flags.power_manageable;
521 }
522 
523 static inline bool acpi_device_can_wakeup(struct acpi_device *adev)
524 {
525         return adev->wakeup.flags.valid;
526 }
527 
528 static inline bool acpi_device_can_poweroff(struct acpi_device *adev)
529 {
530         return adev->power.states[ACPI_STATE_D3_COLD].flags.os_accessible;
531 }
532 
533 #else   /* CONFIG_ACPI */
534 
535 static inline int register_acpi_bus_type(void *bus) { return 0; }
536 static inline int unregister_acpi_bus_type(void *bus) { return 0; }
537 
538 #endif                          /* CONFIG_ACPI */
539 
540 #endif /*__ACPI_BUS_H__*/
541 

~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

kernel.org | git.kernel.org | LWN.net | Project Home | Wiki (Japanese) | Wiki (English) | SVN repository | Mail admin

Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.

osdn.jp