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 extern unsigned int acpi_sci_irq;
 114 #define INVALID_ACPI_IRQ        ((unsigned)-1)
 115 static inline bool acpi_sci_irq_valid(void)
 116 {
 117         return acpi_sci_irq != INVALID_ACPI_IRQ;
 118 }
 119
 120 extern int sbf_port;
 121 extern unsigned long acpi_realmode_flags;
 122
 123 int acpi_register_gsi (struct device *dev, u32 gsi, int triggering, int polarity);
 124 int acpi_gsi_to_irq (u32 gsi, unsigned int *irq);
 125 int acpi_isa_irq_to_gsi (unsigned isa_irq, u32 *gsi);
 126
 127 #ifdef CONFIG_X86_IO_APIC
 128 extern int acpi_get_override_irq(u32 gsi, int *trigger, int *polarity);
 129 #else
 130 #define acpi_get_override_irq(gsi, trigger, polarity) (-1)
 131 #endif
 132 /*
 133  * This function undoes the effect of one call to acpi_register_gsi().
 134  * If this matches the last registration, any IRQ resources for gsi
 135  * are freed.
 136  */
 137 void acpi_unregister_gsi (u32 gsi);
 138
 139 struct pci_dev;
 140
 141 int acpi_pci_irq_enable (struct pci_dev *dev);
 142 void acpi_penalize_isa_irq(int irq, int active);
 143
 144 void acpi_pci_irq_disable (struct pci_dev *dev);
 145
 146 struct acpi_pci_driver {
 147         struct acpi_pci_driver *next;
 148         int (*add)(acpi_handle handle);
 149         void (*remove)(acpi_handle handle);
 150 };
 151
 152 int acpi_pci_register_driver(struct acpi_pci_driver *driver);
 153 void acpi_pci_unregister_driver(struct acpi_pci_driver *driver);
 154
 155 extern int ec_read(u8 addr, u8 *val);
 156 extern int ec_write(u8 addr, u8 val);
 157 extern int ec_transaction(u8 command,
 158                           const u8 *wdata, unsigned wdata_len,
 159                           u8 *rdata, unsigned rdata_len);
 160
 161 #if defined(CONFIG_ACPI_WMI) || defined(CONFIG_ACPI_WMI_MODULE)
 162
 163 typedef void (*wmi_notify_handler) (u32 value, void *context);
 164
 165 extern acpi_status wmi_evaluate_method(const char *guid, u8 instance,
 166                                         u32 method_id,
 167                                         const struct acpi_buffer *in,
 168                                         struct acpi_buffer *out);
 169 extern acpi_status wmi_query_block(const char *guid, u8 instance,
 170                                         struct acpi_buffer *out);
 171 extern acpi_status wmi_set_block(const char *guid, u8 instance,
 172                                         const struct acpi_buffer *in);
 173 extern acpi_status wmi_install_notify_handler(const char *guid,
 174                                         wmi_notify_handler handler, void *data);
 175 extern acpi_status wmi_remove_notify_handler(const char *guid);
 176 extern acpi_status wmi_get_event_data(u32 event, struct acpi_buffer *out);
 177 extern bool wmi_has_guid(const char *guid);
 178
 179 #endif  /* CONFIG_ACPI_WMI */
 180
 181 #define ACPI_VIDEO_OUTPUT_SWITCHING                     0x0001
 182 #define ACPI_VIDEO_DEVICE_POSTING                       0x0002
 183 #define ACPI_VIDEO_ROM_AVAILABLE                        0x0004
 184 #define ACPI_VIDEO_BACKLIGHT                            0x0008
 185 #define ACPI_VIDEO_BACKLIGHT_FORCE_VENDOR               0x0010
 186 #define ACPI_VIDEO_BACKLIGHT_FORCE_VIDEO                0x0020
 187 #define ACPI_VIDEO_OUTPUT_SWITCHING_FORCE_VENDOR        0x0040
 188 #define ACPI_VIDEO_OUTPUT_SWITCHING_FORCE_VIDEO         0x0080
 189 #define ACPI_VIDEO_BACKLIGHT_DMI_VENDOR                 0x0100
 190 #define ACPI_VIDEO_BACKLIGHT_DMI_VIDEO                  0x0200
 191 #define ACPI_VIDEO_OUTPUT_SWITCHING_DMI_VENDOR          0x0400
 192 #define ACPI_VIDEO_OUTPUT_SWITCHING_DMI_VIDEO           0x0800
 193
 194 #if defined(CONFIG_ACPI_VIDEO) || defined(CONFIG_ACPI_VIDEO_MODULE)
 195
 196 extern long acpi_video_get_capabilities(acpi_handle graphics_dev_handle);
 197 extern long acpi_is_video_device(struct acpi_device *device);
 198 extern int acpi_video_backlight_support(void);
 199 extern int acpi_video_display_switch_support(void);
 200
 201 #else
 202
 203 static inline long acpi_video_get_capabilities(acpi_handle graphics_dev_handle)
 204 {
 205         return 0;
 206 }
 207
 208 static inline long acpi_is_video_device(struct acpi_device *device)
 209 {
 210         return 0;
 211 }
 212
 213 static inline int acpi_video_backlight_support(void)
 214 {
 215         return 0;
 216 }
 217
 218 static inline int acpi_video_display_switch_support(void)
 219 {
 220         return 0;
 221 }
 222
 223 #endif /* defined(CONFIG_ACPI_VIDEO) || defined(CONFIG_ACPI_VIDEO_MODULE) */
 224
 225 extern int acpi_blacklisted(void);
 226 extern void acpi_dmi_osi_linux(int enable, const struct dmi_system_id *d);
 227 extern void acpi_osi_setup(char *str);
 228
 229 #ifdef CONFIG_ACPI_NUMA
 230 int acpi_get_pxm(acpi_handle handle);
 231 int acpi_get_node(acpi_handle *handle);
 232 #else
 233 static inline int acpi_get_pxm(acpi_handle handle)
 234 {
 235         return 0;
 236 }
 237 static inline int acpi_get_node(acpi_handle *handle)
 238 {
 239         return 0;
 240 }
 241 #endif
 242 extern int acpi_paddr_to_node(u64 start_addr, u64 size);
 243
 244 extern int pnpacpi_disabled;
 245
 246 #define PXM_INVAL       (-1)
 247
 248 int acpi_check_resource_conflict(const struct resource *res);
 249
 250 int acpi_check_region(resource_size_t start, resource_size_t n,
 251                       const char *name);
 252
 253 int acpi_resources_are_enforced(void);
 254
 255 #ifdef CONFIG_PM_SLEEP
 256 void __init acpi_no_s4_hw_signature(void);
 257 void __init acpi_old_suspend_ordering(void);
 258 void __init acpi_nvs_nosave(void);
 259 #endif /* CONFIG_PM_SLEEP */
 260
 261 struct acpi_osc_context {
 262         char *uuid_str; /* uuid string */
 263         int rev;
 264         struct acpi_buffer cap; /* arg2/arg3 */
 265         struct acpi_buffer ret; /* free by caller if success */
 266 };
 267
 268 #define OSC_QUERY_TYPE                  0
 269 #define OSC_SUPPORT_TYPE                1
 270 #define OSC_CONTROL_TYPE                2
 271
 272 /* _OSC DW0 Definition */
 273 #define OSC_QUERY_ENABLE                1
 274 #define OSC_REQUEST_ERROR               2
 275 #define OSC_INVALID_UUID_ERROR          4
 276 #define OSC_INVALID_REVISION_ERROR      8
 277 #define OSC_CAPABILITIES_MASK_ERROR     16
 278
 279 acpi_status acpi_run_osc(acpi_handle handle, struct acpi_osc_context *context);
 280
 281 /* platform-wide _OSC bits */
 282 #define OSC_SB_PAD_SUPPORT              1
 283 #define OSC_SB_PPC_OST_SUPPORT          2
 284 #define OSC_SB_PR3_SUPPORT              4
 285 #define OSC_SB_CPUHP_OST_SUPPORT        8
 286 #define OSC_SB_APEI_SUPPORT             16
 287
 288 extern bool osc_sb_apei_support_acked;
 289
 290 /* PCI defined _OSC bits */
 291 /* _OSC DW1 Definition (OS Support Fields) */
 292 #define OSC_EXT_PCI_CONFIG_SUPPORT              1
 293 #define OSC_ACTIVE_STATE_PWR_SUPPORT            2
 294 #define OSC_CLOCK_PWR_CAPABILITY_SUPPORT        4
 295 #define OSC_PCI_SEGMENT_GROUPS_SUPPORT          8
 296 #define OSC_MSI_SUPPORT                         16
 297 #define OSC_PCI_SUPPORT_MASKS                   0x1f
 298
 299 /* _OSC DW1 Definition (OS Control Fields) */
 300 #define OSC_PCI_EXPRESS_NATIVE_HP_CONTROL       1
 301 #define OSC_SHPC_NATIVE_HP_CONTROL              2
 302 #define OSC_PCI_EXPRESS_PME_CONTROL             4
 303 #define OSC_PCI_EXPRESS_AER_CONTROL             8
 304 #define OSC_PCI_EXPRESS_CAP_STRUCTURE_CONTROL   16
 305
 306 #define OSC_PCI_CONTROL_MASKS   (OSC_PCI_EXPRESS_NATIVE_HP_CONTROL |    \
 307                                 OSC_SHPC_NATIVE_HP_CONTROL |            \
 308                                 OSC_PCI_EXPRESS_PME_CONTROL |           \
 309                                 OSC_PCI_EXPRESS_AER_CONTROL |           \
 310                                 OSC_PCI_EXPRESS_CAP_STRUCTURE_CONTROL)
 311 extern acpi_status acpi_pci_osc_control_set(acpi_handle handle,
 312                                              u32 *mask, u32 req);
 313 extern void acpi_early_init(void);
 314
 315 #else   /* !CONFIG_ACPI */
 316
 317 #define acpi_disabled 1
 318
 319 static inline void acpi_early_init(void) { }
 320
 321 static inline int early_acpi_boot_init(void)
 322 {
 323         return 0;
 324 }
 325 static inline int acpi_boot_init(void)
 326 {
 327         return 0;
 328 }
 329
 330 static inline void acpi_boot_table_init(void)
 331 {
 332         return;
 333 }
 334
 335 static inline int acpi_mps_check(void)
 336 {
 337         return 0;
 338 }
 339
 340 static inline int acpi_check_resource_conflict(struct resource *res)
 341 {
 342         return 0;
 343 }
 344
 345 static inline int acpi_check_region(resource_size_t start, resource_size_t n,
 346                                     const char *name)
 347 {
 348         return 0;
 349 }
 350
 351 struct acpi_table_header;
 352 static inline int acpi_table_parse(char *id,
 353                                 int (*handler)(struct acpi_table_header *))
 354 {
 355         return -1;
 356 }
 357 #endif  /* !CONFIG_ACPI */
 358
 359 #ifdef CONFIG_ACPI_SLEEP
 360 int suspend_nvs_register(unsigned long start, unsigned long size);
 361 #else
 362 static inline int suspend_nvs_register(unsigned long a, unsigned long b)
 363 {
 364         return 0;
 365 }
 366 #endif
 367
 368 #endif  /*_LINUX_ACPI_H*/