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 void 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 int acpi_video_backlight_support(void);
 194 extern int acpi_video_display_switch_support(void);
 195
 196 #else
 197
 198 static inline long acpi_video_get_capabilities(acpi_handle graphics_dev_handle)
 199 {
 200         return 0;
 201 }
 202
 203 static inline long acpi_is_video_device(struct acpi_device *device)
 204 {
 205         return 0;
 206 }
 207
 208 static inline int acpi_video_backlight_support(void)
 209 {
 210         return 0;
 211 }
 212
 213 static inline int acpi_video_display_switch_support(void)
 214 {
 215         return 0;
 216 }
 217
 218 #endif /* defined(CONFIG_ACPI_VIDEO) || defined(CONFIG_ACPI_VIDEO_MODULE) */
 219
 220 extern int acpi_blacklisted(void);
 221 extern void acpi_dmi_osi_linux(int enable, const struct dmi_system_id *d);
 222 extern void acpi_osi_setup(char *str);
 223
 224 #ifdef CONFIG_ACPI_NUMA
 225 int acpi_get_pxm(acpi_handle handle);
 226 int acpi_get_node(acpi_handle *handle);
 227 #else
 228 static inline int acpi_get_pxm(acpi_handle handle)
 229 {
 230         return 0;
 231 }
 232 static inline int acpi_get_node(acpi_handle *handle)
 233 {
 234         return 0;
 235 }
 236 #endif
 237 extern int acpi_paddr_to_node(u64 start_addr, u64 size);
 238
 239 extern int pnpacpi_disabled;
 240
 241 #define PXM_INVAL       (-1)
 242
 243 int acpi_check_resource_conflict(const struct resource *res);
 244
 245 int acpi_check_region(resource_size_t start, resource_size_t n,
 246                       const char *name);
 247
 248 int acpi_resources_are_enforced(void);
 249
 250 #ifdef CONFIG_PM_SLEEP
 251 void __init acpi_no_s4_hw_signature(void);
 252 void __init acpi_old_suspend_ordering(void);
 253 void __init acpi_nvs_nosave(void);
 254 #endif /* CONFIG_PM_SLEEP */
 255
 256 struct acpi_osc_context {
 257         char *uuid_str; /* uuid string */
 258         int rev;
 259         struct acpi_buffer cap; /* arg2/arg3 */
 260         struct acpi_buffer ret; /* free by caller if success */
 261 };
 262
 263 #define OSC_QUERY_TYPE                  0
 264 #define OSC_SUPPORT_TYPE                1
 265 #define OSC_CONTROL_TYPE                2
 266
 267 /* _OSC DW0 Definition */
 268 #define OSC_QUERY_ENABLE                1
 269 #define OSC_REQUEST_ERROR               2
 270 #define OSC_INVALID_UUID_ERROR          4
 271 #define OSC_INVALID_REVISION_ERROR      8
 272 #define OSC_CAPABILITIES_MASK_ERROR     16
 273
 274 acpi_status acpi_run_osc(acpi_handle handle, struct acpi_osc_context *context);
 275
 276 /* platform-wide _OSC bits */
 277 #define OSC_SB_PAD_SUPPORT              1
 278 #define OSC_SB_PPC_OST_SUPPORT          2
 279 #define OSC_SB_PR3_SUPPORT              4
 280 #define OSC_SB_CPUHP_OST_SUPPORT        8
 281 #define OSC_SB_APEI_SUPPORT             16
 282
 283 extern bool osc_sb_apei_support_acked;
 284
 285 /* PCI defined _OSC bits */
 286 /* _OSC DW1 Definition (OS Support Fields) */
 287 #define OSC_EXT_PCI_CONFIG_SUPPORT              1
 288 #define OSC_ACTIVE_STATE_PWR_SUPPORT            2
 289 #define OSC_CLOCK_PWR_CAPABILITY_SUPPORT        4
 290 #define OSC_PCI_SEGMENT_GROUPS_SUPPORT          8
 291 #define OSC_MSI_SUPPORT                         16
 292 #define OSC_PCI_SUPPORT_MASKS                   0x1f
 293
 294 /* _OSC DW1 Definition (OS Control Fields) */
 295 #define OSC_PCI_EXPRESS_NATIVE_HP_CONTROL       1
 296 #define OSC_SHPC_NATIVE_HP_CONTROL              2
 297 #define OSC_PCI_EXPRESS_PME_CONTROL             4
 298 #define OSC_PCI_EXPRESS_AER_CONTROL             8
 299 #define OSC_PCI_EXPRESS_CAP_STRUCTURE_CONTROL   16
 300
 301 #define OSC_PCI_CONTROL_MASKS   (OSC_PCI_EXPRESS_NATIVE_HP_CONTROL |    \
 302                                 OSC_SHPC_NATIVE_HP_CONTROL |            \
 303                                 OSC_PCI_EXPRESS_PME_CONTROL |           \
 304                                 OSC_PCI_EXPRESS_AER_CONTROL |           \
 305                                 OSC_PCI_EXPRESS_CAP_STRUCTURE_CONTROL)
 306
 307 #define OSC_PCI_NATIVE_HOTPLUG  (OSC_PCI_EXPRESS_NATIVE_HP_CONTROL |    \
 308                                 OSC_SHPC_NATIVE_HP_CONTROL)
 309
 310 extern acpi_status acpi_pci_osc_control_set(acpi_handle handle,
 311                                              u32 *mask, u32 req);
 312 extern void acpi_early_init(void);
 313
 314 extern int acpi_nvs_register(__u64 start, __u64 size);
 315
 316 extern int acpi_nvs_for_each_region(int (*func)(__u64, __u64, void *),
 317                                     void *data);
 318
 319 #else   /* !CONFIG_ACPI */
 320
 321 #define acpi_disabled 1
 322
 323 static inline void acpi_early_init(void) { }
 324
 325 static inline int early_acpi_boot_init(void)
 326 {
 327         return 0;
 328 }
 329 static inline int acpi_boot_init(void)
 330 {
 331         return 0;
 332 }
 333
 334 static inline void acpi_boot_table_init(void)
 335 {
 336         return;
 337 }
 338
 339 static inline int acpi_mps_check(void)
 340 {
 341         return 0;
 342 }
 343
 344 static inline int acpi_check_resource_conflict(struct resource *res)
 345 {
 346         return 0;
 347 }
 348
 349 static inline int acpi_check_region(resource_size_t start, resource_size_t n,
 350                                     const char *name)
 351 {
 352         return 0;
 353 }
 354
 355 struct acpi_table_header;
 356 static inline int acpi_table_parse(char *id,
 357                                 int (*handler)(struct acpi_table_header *))
 358 {
 359         return -1;
 360 }
 361
 362 static inline int acpi_nvs_register(__u64 start, __u64 size)
 363 {
 364         return 0;
 365 }
 366
 367 static inline int acpi_nvs_for_each_region(int (*func)(__u64, __u64, void *),
 368                                            void *data)
 369 {
 370         return 0;
 371 }
 372
 373 #endif  /* !CONFIG_ACPI */
 374
 375 #ifdef CONFIG_ACPI
 376 void acpi_os_set_prepare_sleep(int (*func)(u8 sleep_state,
 377                                u32 pm1a_ctrl,  u32 pm1b_ctrl));
 378
 379 acpi_status acpi_os_prepare_sleep(u8 sleep_state,
 380                                   u32 pm1a_control, u32 pm1b_control);
 381 #else
 382 #define acpi_os_set_prepare_sleep(func, pm1a_ctrl, pm1b_ctrl) do { } while (0)
 383 #endif
 384
 385 #endif  /*_LINUX_ACPI_H*/