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