Pileus Git - ~andy/linux/blob - include/linux/acpi.h

   1 /*
   2  * acpi.h - ACPI Interface
   3  *
   4  * Copyright (C) 2001 Paul Diefenbaugh <paul.s.diefenbaugh@intel.com>
   5  *
   6  * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  21  *
  22  * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  23  */
  24
  25 #ifndef _LINUX_ACPI_H
  26 #define _LINUX_ACPI_H
  27
  28 #include <linux/errno.h>
  29 #include <linux/ioport.h>       /* for struct resource */
  30
  31 #ifdef  CONFIG_ACPI
  32
  33 #ifndef _LINUX
  34 #define _LINUX
  35 #endif
  36
  37 #include <linux/list.h>
  38 #include <linux/mod_devicetable.h>
  39
  40 #include <acpi/acpi.h>
  41 #include <acpi/acpi_bus.h>
  42 #include <acpi/acpi_drivers.h>
  43 #include <acpi/acpi_numa.h>
  44 #include <asm/acpi.h>
  45
  46 enum acpi_irq_model_id {
  47         ACPI_IRQ_MODEL_PIC = 0,
  48         ACPI_IRQ_MODEL_IOAPIC,
  49         ACPI_IRQ_MODEL_IOSAPIC,
  50         ACPI_IRQ_MODEL_PLATFORM,
  51         ACPI_IRQ_MODEL_COUNT
  52 };
  53
  54 extern enum acpi_irq_model_id   acpi_irq_model;
  55
  56 enum acpi_interrupt_id {
  57         ACPI_INTERRUPT_PMI      = 1,
  58         ACPI_INTERRUPT_INIT,
  59         ACPI_INTERRUPT_CPEI,
  60         ACPI_INTERRUPT_COUNT
  61 };
  62
  63 #define ACPI_SPACE_MEM          0
  64
  65 enum acpi_address_range_id {
  66         ACPI_ADDRESS_RANGE_MEMORY = 1,
  67         ACPI_ADDRESS_RANGE_RESERVED = 2,
  68         ACPI_ADDRESS_RANGE_ACPI = 3,
  69         ACPI_ADDRESS_RANGE_NVS  = 4,
  70         ACPI_ADDRESS_RANGE_COUNT
  71 };
  72
  73
  74 /* Table Handlers */
  75
  76 typedef int (*acpi_table_handler) (struct acpi_table_header *table);
  77
  78 typedef int (*acpi_table_entry_handler) (struct acpi_subtable_header *header, const unsigned long end);
  79
  80 char * __acpi_map_table (unsigned long phys_addr, unsigned long size);
  81 void __acpi_unmap_table(char *map, unsigned long size);
  82 int early_acpi_boot_init(void);
  83 int acpi_boot_init (void);
  84 void acpi_boot_table_init (void);
  85 int acpi_mps_check (void);
  86 int acpi_numa_init (void);
  87
  88 int acpi_table_init (void);
  89 int acpi_table_parse (char *id, acpi_table_handler handler);
  90 int __init acpi_table_parse_entries(char *id, unsigned long table_size,
  91         int entry_id, acpi_table_entry_handler handler, unsigned int max_entries);
  92 int acpi_table_parse_madt (enum acpi_madt_type id, acpi_table_entry_handler handler, unsigned int max_entries);
  93 int acpi_parse_mcfg (struct acpi_table_header *header);
  94 void acpi_table_print_madt_entry (struct acpi_subtable_header *madt);
  95
  96 /* the following four functions are architecture-dependent */
  97 void acpi_numa_slit_init (struct acpi_table_slit *slit);
  98 void acpi_numa_processor_affinity_init (struct acpi_srat_cpu_affinity *pa);
  99 void acpi_numa_x2apic_affinity_init(struct acpi_srat_x2apic_cpu_affinity *pa);
 100 int acpi_numa_memory_affinity_init (struct acpi_srat_mem_affinity *ma);
 101 void acpi_numa_arch_fixup(void);
 102
 103 #ifdef CONFIG_ACPI_HOTPLUG_CPU
 104 /* Arch dependent functions for cpu hotplug support */
 105 int acpi_map_lsapic(acpi_handle handle, int *pcpu);
 106 int acpi_unmap_lsapic(int cpu);
 107 #endif /* CONFIG_ACPI_HOTPLUG_CPU */
 108
 109 int acpi_register_ioapic(acpi_handle handle, u64 phys_addr, u32 gsi_base);
 110 int acpi_unregister_ioapic(acpi_handle handle, u32 gsi_base);
 111 void acpi_irq_stats_init(void);
 112 extern u32 acpi_irq_handled;
 113 extern u32 acpi_irq_not_handled;
 114
 115 extern int sbf_port;
 116 extern unsigned long acpi_realmode_flags;
 117
 118 int acpi_register_gsi (struct device *dev, u32 gsi, int triggering, int polarity);
 119 int acpi_gsi_to_irq (u32 gsi, unsigned int *irq);
 120 int acpi_isa_irq_to_gsi (unsigned isa_irq, u32 *gsi);
 121
 122 #ifdef CONFIG_X86_IO_APIC
 123 extern int acpi_get_override_irq(u32 gsi, int *trigger, int *polarity);
 124 #else
 125 #define acpi_get_override_irq(gsi, trigger, polarity) (-1)
 126 #endif
 127 /*
 128  * This function undoes the effect of one call to acpi_register_gsi().
 129  * If this matches the last registration, any IRQ resources for gsi
 130  * are freed.
 131  */
 132 void acpi_unregister_gsi (u32 gsi);
 133
 134 struct pci_dev;
 135
 136 int acpi_pci_irq_enable (struct pci_dev *dev);
 137 void acpi_penalize_isa_irq(int irq, int active);
 138
 139 void acpi_pci_irq_disable (struct pci_dev *dev);
 140
 141 struct acpi_pci_driver {
 142         struct list_head node;
 143         int (*add)(struct acpi_pci_root *root);
 144         void (*remove)(struct acpi_pci_root *root);
 145 };
 146
 147 int acpi_pci_register_driver(struct acpi_pci_driver *driver);
 148 void acpi_pci_unregister_driver(struct acpi_pci_driver *driver);
 149
 150 extern int ec_read(u8 addr, u8 *val);
 151 extern int ec_write(u8 addr, u8 val);
 152 extern int ec_transaction(u8 command,
 153                           const u8 *wdata, unsigned wdata_len,
 154                           u8 *rdata, unsigned rdata_len);
 155 extern acpi_handle ec_get_handle(void);
 156
 157 #if defined(CONFIG_ACPI_WMI) || defined(CONFIG_ACPI_WMI_MODULE)
 158
 159 typedef void (*wmi_notify_handler) (u32 value, void *context);
 160
 161 extern acpi_status wmi_evaluate_method(const char *guid, u8 instance,
 162                                         u32 method_id,
 163                                         const struct acpi_buffer *in,
 164                                         struct acpi_buffer *out);
 165 extern acpi_status wmi_query_block(const char *guid, u8 instance,
 166                                         struct acpi_buffer *out);
 167 extern acpi_status wmi_set_block(const char *guid, u8 instance,
 168                                         const struct acpi_buffer *in);
 169 extern acpi_status wmi_install_notify_handler(const char *guid,
 170                                         wmi_notify_handler handler, void *data);
 171 extern acpi_status wmi_remove_notify_handler(const char *guid);
 172 extern acpi_status wmi_get_event_data(u32 event, struct acpi_buffer *out);
 173 extern bool wmi_has_guid(const char *guid);
 174
 175 #endif  /* CONFIG_ACPI_WMI */
 176
 177 #define ACPI_VIDEO_OUTPUT_SWITCHING                     0x0001
 178 #define ACPI_VIDEO_DEVICE_POSTING                       0x0002
 179 #define ACPI_VIDEO_ROM_AVAILABLE                        0x0004
 180 #define ACPI_VIDEO_BACKLIGHT                            0x0008
 181 #define ACPI_VIDEO_BACKLIGHT_FORCE_VENDOR               0x0010
 182 #define ACPI_VIDEO_BACKLIGHT_FORCE_VIDEO                0x0020
 183 #define ACPI_VIDEO_OUTPUT_SWITCHING_FORCE_VENDOR        0x0040
 184 #define ACPI_VIDEO_OUTPUT_SWITCHING_FORCE_VIDEO         0x0080
 185 #define ACPI_VIDEO_BACKLIGHT_DMI_VENDOR                 0x0100
 186 #define ACPI_VIDEO_BACKLIGHT_DMI_VIDEO                  0x0200
 187 #define ACPI_VIDEO_OUTPUT_SWITCHING_DMI_VENDOR          0x0400
 188 #define ACPI_VIDEO_OUTPUT_SWITCHING_DMI_VIDEO           0x0800
 189
 190 #if defined(CONFIG_ACPI_VIDEO) || defined(CONFIG_ACPI_VIDEO_MODULE)
 191
 192 extern long acpi_video_get_capabilities(acpi_handle graphics_dev_handle);
 193 extern long acpi_is_video_device(struct acpi_device *device);
 194 extern void acpi_video_dmi_promote_vendor(void);
 195 extern void acpi_video_dmi_demote_vendor(void);
 196 extern int acpi_video_backlight_support(void);
 197 extern int acpi_video_display_switch_support(void);
 198
 199 #else
 200
 201 static inline long acpi_video_get_capabilities(acpi_handle graphics_dev_handle)
 202 {
 203         return 0;
 204 }
 205
 206 static inline long acpi_is_video_device(struct acpi_device *device)
 207 {
 208         return 0;
 209 }
 210
 211 static inline void acpi_video_dmi_promote_vendor(void)
 212 {
 213 }
 214
 215 static inline void acpi_video_dmi_demote_vendor(void)
 216 {
 217 }
 218
 219 static inline int acpi_video_backlight_support(void)
 220 {
 221         return 0;
 222 }
 223
 224 static inline int acpi_video_display_switch_support(void)
 225 {
 226         return 0;
 227 }
 228
 229 #endif /* defined(CONFIG_ACPI_VIDEO) || defined(CONFIG_ACPI_VIDEO_MODULE) */
 230
 231 extern int acpi_blacklisted(void);
 232 extern void acpi_dmi_osi_linux(int enable, const struct dmi_system_id *d);
 233 extern void acpi_osi_setup(char *str);
 234
 235 #ifdef CONFIG_ACPI_NUMA
 236 int acpi_get_pxm(acpi_handle handle);
 237 int acpi_get_node(acpi_handle *handle);
 238 #else
 239 static inline int acpi_get_pxm(acpi_handle handle)
 240 {
 241         return 0;
 242 }
 243 static inline int acpi_get_node(acpi_handle *handle)
 244 {
 245         return 0;
 246 }
 247 #endif
 248 extern int acpi_paddr_to_node(u64 start_addr, u64 size);
 249
 250 extern int pnpacpi_disabled;
 251
 252 #define PXM_INVAL       (-1)
 253
 254 int acpi_check_resource_conflict(const struct resource *res);
 255
 256 int acpi_check_region(resource_size_t start, resource_size_t n,
 257                       const char *name);
 258
 259 int acpi_resources_are_enforced(void);
 260
 261 #ifdef CONFIG_PM_SLEEP
 262 void __init acpi_no_s4_hw_signature(void);
 263 void __init acpi_old_suspend_ordering(void);
 264 void __init acpi_nvs_nosave(void);
 265 #endif /* CONFIG_PM_SLEEP */
 266
 267 struct acpi_osc_context {
 268         char *uuid_str; /* uuid string */
 269         int rev;
 270         struct acpi_buffer cap; /* arg2/arg3 */
 271         struct acpi_buffer ret; /* free by caller if success */
 272 };
 273
 274 #define OSC_QUERY_TYPE                  0
 275 #define OSC_SUPPORT_TYPE                1
 276 #define OSC_CONTROL_TYPE                2
 277
 278 /* _OSC DW0 Definition */
 279 #define OSC_QUERY_ENABLE                1
 280 #define OSC_REQUEST_ERROR               2
 281 #define OSC_INVALID_UUID_ERROR          4
 282 #define OSC_INVALID_REVISION_ERROR      8
 283 #define OSC_CAPABILITIES_MASK_ERROR     16
 284
 285 acpi_status acpi_run_osc(acpi_handle handle, struct acpi_osc_context *context);
 286
 287 /* platform-wide _OSC bits */
 288 #define OSC_SB_PAD_SUPPORT              1
 289 #define OSC_SB_PPC_OST_SUPPORT          2
 290 #define OSC_SB_PR3_SUPPORT              4
 291 #define OSC_SB_HOTPLUG_OST_SUPPORT      8
 292 #define OSC_SB_APEI_SUPPORT             16
 293
 294 extern bool osc_sb_apei_support_acked;
 295
 296 /* PCI defined _OSC bits */
 297 /* _OSC DW1 Definition (OS Support Fields) */
 298 #define OSC_EXT_PCI_CONFIG_SUPPORT              1
 299 #define OSC_ACTIVE_STATE_PWR_SUPPORT            2
 300 #define OSC_CLOCK_PWR_CAPABILITY_SUPPORT        4
 301 #define OSC_PCI_SEGMENT_GROUPS_SUPPORT          8
 302 #define OSC_MSI_SUPPORT                         16
 303 #define OSC_PCI_SUPPORT_MASKS                   0x1f
 304
 305 /* _OSC DW1 Definition (OS Control Fields) */
 306 #define OSC_PCI_EXPRESS_NATIVE_HP_CONTROL       1
 307 #define OSC_SHPC_NATIVE_HP_CONTROL              2
 308 #define OSC_PCI_EXPRESS_PME_CONTROL             4
 309 #define OSC_PCI_EXPRESS_AER_CONTROL             8
 310 #define OSC_PCI_EXPRESS_CAP_STRUCTURE_CONTROL   16
 311
 312 #define OSC_PCI_CONTROL_MASKS   (OSC_PCI_EXPRESS_NATIVE_HP_CONTROL |    \
 313                                 OSC_SHPC_NATIVE_HP_CONTROL |            \
 314                                 OSC_PCI_EXPRESS_PME_CONTROL |           \
 315                                 OSC_PCI_EXPRESS_AER_CONTROL |           \
 316                                 OSC_PCI_EXPRESS_CAP_STRUCTURE_CONTROL)
 317
 318 #define OSC_PCI_NATIVE_HOTPLUG  (OSC_PCI_EXPRESS_NATIVE_HP_CONTROL |    \
 319                                 OSC_SHPC_NATIVE_HP_CONTROL)
 320
 321 extern acpi_status acpi_pci_osc_control_set(acpi_handle handle,
 322                                              u32 *mask, u32 req);
 323
 324 /* Enable _OST when all relevant hotplug operations are enabled */
 325 #if defined(CONFIG_ACPI_HOTPLUG_CPU) &&                 \
 326         (defined(CONFIG_ACPI_HOTPLUG_MEMORY) ||         \
 327          defined(CONFIG_ACPI_HOTPLUG_MEMORY_MODULE)) && \
 328         (defined(CONFIG_ACPI_CONTAINER) ||              \
 329          defined(CONFIG_ACPI_CONTAINER_MODULE))
 330 #define ACPI_HOTPLUG_OST
 331 #endif
 332
 333 /* _OST Source Event Code (OSPM Action) */
 334 #define ACPI_OST_EC_OSPM_SHUTDOWN               0x100
 335 #define ACPI_OST_EC_OSPM_EJECT                  0x103
 336 #define ACPI_OST_EC_OSPM_INSERTION              0x200
 337
 338 /* _OST General Processing Status Code */
 339 #define ACPI_OST_SC_SUCCESS                     0x0
 340 #define ACPI_OST_SC_NON_SPECIFIC_FAILURE        0x1
 341 #define ACPI_OST_SC_UNRECOGNIZED_NOTIFY         0x2
 342
 343 /* _OST OS Shutdown Processing (0x100) Status Code */
 344 #define ACPI_OST_SC_OS_SHUTDOWN_DENIED          0x80
 345 #define ACPI_OST_SC_OS_SHUTDOWN_IN_PROGRESS     0x81
 346 #define ACPI_OST_SC_OS_SHUTDOWN_COMPLETED       0x82
 347 #define ACPI_OST_SC_OS_SHUTDOWN_NOT_SUPPORTED   0x83
 348
 349 /* _OST Ejection Request (0x3, 0x103) Status Code */
 350 #define ACPI_OST_SC_EJECT_NOT_SUPPORTED         0x80
 351 #define ACPI_OST_SC_DEVICE_IN_USE               0x81
 352 #define ACPI_OST_SC_DEVICE_BUSY                 0x82
 353 #define ACPI_OST_SC_EJECT_DEPENDENCY_BUSY       0x83
 354 #define ACPI_OST_SC_EJECT_IN_PROGRESS           0x84
 355
 356 /* _OST Insertion Request (0x200) Status Code */
 357 #define ACPI_OST_SC_INSERT_IN_PROGRESS          0x80
 358 #define ACPI_OST_SC_DRIVER_LOAD_FAILURE         0x81
 359 #define ACPI_OST_SC_INSERT_NOT_SUPPORTED        0x82
 360
 361 extern void acpi_early_init(void);
 362
 363 extern int acpi_nvs_register(__u64 start, __u64 size);
 364
 365 extern int acpi_nvs_for_each_region(int (*func)(__u64, __u64, void *),
 366                                     void *data);
 367
 368 #else   /* !CONFIG_ACPI */
 369
 370 #define acpi_disabled 1
 371
 372 static inline void acpi_early_init(void) { }
 373
 374 static inline int early_acpi_boot_init(void)
 375 {
 376         return 0;
 377 }
 378 static inline int acpi_boot_init(void)
 379 {
 380         return 0;
 381 }
 382
 383 static inline void acpi_boot_table_init(void)
 384 {
 385         return;
 386 }
 387
 388 static inline int acpi_mps_check(void)
 389 {
 390         return 0;
 391 }
 392
 393 static inline int acpi_check_resource_conflict(struct resource *res)
 394 {
 395         return 0;
 396 }
 397
 398 static inline int acpi_check_region(resource_size_t start, resource_size_t n,
 399                                     const char *name)
 400 {
 401         return 0;
 402 }
 403
 404 struct acpi_table_header;
 405 static inline int acpi_table_parse(char *id,
 406                                 int (*handler)(struct acpi_table_header *))
 407 {
 408         return -1;
 409 }
 410
 411 static inline int acpi_nvs_register(__u64 start, __u64 size)
 412 {
 413         return 0;
 414 }
 415
 416 static inline int acpi_nvs_for_each_region(int (*func)(__u64, __u64, void *),
 417                                            void *data)
 418 {
 419         return 0;
 420 }
 421
 422 #endif  /* !CONFIG_ACPI */
 423
 424 #ifdef CONFIG_ACPI
 425 void acpi_os_set_prepare_sleep(int (*func)(u8 sleep_state,
 426                                u32 pm1a_ctrl,  u32 pm1b_ctrl));
 427
 428 acpi_status acpi_os_prepare_sleep(u8 sleep_state,
 429                                   u32 pm1a_control, u32 pm1b_control);
 430 #else
 431 #define acpi_os_set_prepare_sleep(func, pm1a_ctrl, pm1b_ctrl) do { } while (0)
 432 #endif
 433
 434 #if defined(CONFIG_ACPI) && defined(CONFIG_PM_RUNTIME)
 435 int acpi_dev_runtime_suspend(struct device *dev);
 436 int acpi_dev_runtime_resume(struct device *dev);
 437 int acpi_subsys_runtime_suspend(struct device *dev);
 438 int acpi_subsys_runtime_resume(struct device *dev);
 439 #else
 440 static inline int acpi_dev_runtime_suspend(struct device *dev) { return 0; }
 441 static inline int acpi_dev_runtime_resume(struct device *dev) { return 0; }
 442 static inline int acpi_subsys_runtime_suspend(struct device *dev) { return 0; }
 443 static inline int acpi_subsys_runtime_resume(struct device *dev) { return 0; }
 444 #endif
 445
 446 #ifdef CONFIG_ACPI_SLEEP
 447 int acpi_dev_suspend_late(struct device *dev);
 448 int acpi_dev_resume_early(struct device *dev);
 449 int acpi_subsys_prepare(struct device *dev);
 450 int acpi_subsys_suspend_late(struct device *dev);
 451 int acpi_subsys_resume_early(struct device *dev);
 452 #else
 453 static inline int acpi_dev_suspend_late(struct device *dev) { return 0; }
 454 static inline int acpi_dev_resume_early(struct device *dev) { return 0; }
 455 static inline int acpi_subsys_prepare(struct device *dev) { return 0; }
 456 static inline int acpi_subsys_suspend_late(struct device *dev) { return 0; }
 457 static inline int acpi_subsys_resume_early(struct device *dev) { return 0; }
 458 #endif
 459
 460 #if defined(CONFIG_ACPI) && defined(CONFIG_PM)
 461 int acpi_dev_pm_attach(struct device *dev);
 462 int acpi_dev_pm_detach(struct device *dev);
 463 #else
 464 static inline int acpi_dev_pm_attach(struct device *dev) { return -ENODEV; }
 465 static inline void acpi_dev_pm_detach(struct device *dev) {}
 466 #endif
 467
 468 #endif  /*_LINUX_ACPI_H*/