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