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