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
  29 #ifdef  CONFIG_ACPI
  30
  31 #ifndef _LINUX
  32 #define _LINUX
  33 #endif
  34
  35 #include <linux/list.h>
  36
  37 #include <acpi/acpi.h>
  38 #include <acpi/acpi_bus.h>
  39 #include <acpi/acpi_drivers.h>
  40 #include <acpi/acpi_numa.h>
  41 #include <asm/acpi.h>
  42
  43
  44 #ifdef CONFIG_ACPI
  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 typedef struct {
  57         u8                      type;
  58         u8                      length;
  59 } __attribute__ ((packed)) acpi_table_entry_header;
  60
  61 enum acpi_interrupt_id {
  62         ACPI_INTERRUPT_PMI      = 1,
  63         ACPI_INTERRUPT_INIT,
  64         ACPI_INTERRUPT_CPEI,
  65         ACPI_INTERRUPT_COUNT
  66 };
  67
  68 #define ACPI_SPACE_MEM          0
  69
  70 struct acpi_gen_regaddr {
  71         u8  space_id;
  72         u8  bit_width;
  73         u8  bit_offset;
  74         u8  resv;
  75         u32 addrl;
  76         u32 addrh;
  77 } __attribute__ ((packed));
  78
  79 /*
  80  * Simple Boot Flags
  81  * http://www.microsoft.com/whdc/hwdev/resources/specs/simp_bios.mspx
  82  */
  83 struct acpi_table_sbf
  84 {
  85         u8 sbf_signature[4];
  86         u32 sbf_len;
  87         u8 sbf_revision;
  88         u8 sbf_csum;
  89         u8 sbf_oemid[6];
  90         u8 sbf_oemtable[8];
  91         u8 sbf_revdata[4];
  92         u8 sbf_creator[4];
  93         u8 sbf_crearev[4];
  94         u8 sbf_cmos;
  95         u8 sbf_spare[3];
  96 } __attribute__ ((packed));
  97
  98 /*
  99  * System Resource Affinity Table (SRAT)
 100  * http://www.microsoft.com/whdc/hwdev/platform/proc/SRAT.mspx
 101  */
 102
 103 enum acpi_srat_entry_id {
 104         ACPI_SRAT_PROCESSOR_AFFINITY = 0,
 105         ACPI_SRAT_MEMORY_AFFINITY,
 106         ACPI_SRAT_ENTRY_COUNT
 107 };
 108
 109 struct acpi_table_processor_affinity {
 110         acpi_table_entry_header header;
 111         u8                      proximity_domain;
 112         u8                      apic_id;
 113         struct {
 114                 u32                     enabled:1;
 115                 u32                     reserved:31;
 116         }                       flags;
 117         u8                      lsapic_eid;
 118         u8                      reserved[7];
 119 } __attribute__ ((packed));
 120
 121 struct acpi_table_memory_affinity {
 122         acpi_table_entry_header header;
 123         u8                      proximity_domain;
 124         u8                      reserved1[5];
 125         u32                     base_addr_lo;
 126         u32                     base_addr_hi;
 127         u32                     length_lo;
 128         u32                     length_hi;
 129         u32                     memory_type;    /* See acpi_address_range_id */
 130         struct {
 131                 u32                     enabled:1;
 132                 u32                     hot_pluggable:1;
 133                 u32                     reserved:30;
 134         }                       flags;
 135         u64                     reserved2;
 136 } __attribute__ ((packed));
 137
 138 enum acpi_address_range_id {
 139         ACPI_ADDRESS_RANGE_MEMORY = 1,
 140         ACPI_ADDRESS_RANGE_RESERVED = 2,
 141         ACPI_ADDRESS_RANGE_ACPI = 3,
 142         ACPI_ADDRESS_RANGE_NVS  = 4,
 143         ACPI_ADDRESS_RANGE_COUNT
 144 };
 145
 146
 147 /* PCI MMCONFIG */
 148
 149 /* Defined in PCI Firmware Specification 3.0 */
 150 struct acpi_table_mcfg_config {
 151         u32                             base_address;
 152         u32                             base_reserved;
 153         u16                             pci_segment_group_number;
 154         u8                              start_bus_number;
 155         u8                              end_bus_number;
 156         u8                              reserved[4];
 157 } __attribute__ ((packed));
 158
 159 /* Table Handlers */
 160
 161 enum acpi_table_id {
 162         ACPI_TABLE_UNKNOWN = 0,
 163         ACPI_APIC,
 164         ACPI_BOOT,
 165         ACPI_DBGP,
 166         ACPI_DSDT,
 167         ACPI_ECDT,
 168         ACPI_ETDT,
 169         ACPI_FADT,
 170         ACPI_FACS,
 171         ACPI_OEMX,
 172         ACPI_PSDT,
 173         ACPI_SBST,
 174         ACPI_SLIT,
 175         ACPI_SPCR,
 176         ACPI_SRAT,
 177         ACPI_SSDT,
 178         ACPI_SPMI,
 179         ACPI_HPET,
 180         ACPI_MCFG,
 181         ACPI_TABLE_COUNT
 182 };
 183
 184 typedef int (*acpi_table_handler) (struct acpi_table_header *header);
 185
 186 extern acpi_table_handler acpi_table_ops[ACPI_TABLE_COUNT];
 187
 188 typedef int (*acpi_madt_entry_handler) (struct acpi_subtable_header *header, const unsigned long end);
 189
 190 char * __acpi_map_table (unsigned long phys_addr, unsigned long size);
 191 unsigned long acpi_find_rsdp (void);
 192 int acpi_boot_init (void);
 193 int acpi_boot_table_init (void);
 194 int acpi_numa_init (void);
 195
 196 int acpi_table_init (void);
 197 int acpi_table_parse (char *id, acpi_table_handler handler);
 198 int acpi_table_parse_madt (enum acpi_madt_type id, acpi_madt_entry_handler handler, unsigned int max_entries);
 199 int acpi_table_parse_srat (enum acpi_srat_entry_id id, acpi_madt_entry_handler handler, unsigned int max_entries);
 200 int acpi_parse_mcfg (struct acpi_table_header *header);
 201 void acpi_table_print (struct acpi_table_header *header, unsigned long phys_addr);
 202 void acpi_table_print_madt_entry (struct acpi_subtable_header *madt);
 203 void acpi_table_print_srat_entry (acpi_table_entry_header *srat);
 204
 205 /* the following four functions are architecture-dependent */
 206 #ifdef CONFIG_HAVE_ARCH_PARSE_SRAT
 207 #define NR_NODE_MEMBLKS MAX_NUMNODES
 208 #define acpi_numa_slit_init(slit) do {} while (0)
 209 #define acpi_numa_processor_affinity_init(pa) do {} while (0)
 210 #define acpi_numa_memory_affinity_init(ma) do {} while (0)
 211 #define acpi_numa_arch_fixup() do {} while (0)
 212 #else
 213 void acpi_numa_slit_init (struct acpi_table_slit *slit);
 214 void acpi_numa_processor_affinity_init (struct acpi_table_processor_affinity *pa);
 215 void acpi_numa_memory_affinity_init (struct acpi_table_memory_affinity *ma);
 216 void acpi_numa_arch_fixup(void);
 217 #endif
 218
 219 #ifdef CONFIG_ACPI_HOTPLUG_CPU
 220 /* Arch dependent functions for cpu hotplug support */
 221 int acpi_map_lsapic(acpi_handle handle, int *pcpu);
 222 int acpi_unmap_lsapic(int cpu);
 223 #endif /* CONFIG_ACPI_HOTPLUG_CPU */
 224
 225 int acpi_register_ioapic(acpi_handle handle, u64 phys_addr, u32 gsi_base);
 226 int acpi_unregister_ioapic(acpi_handle handle, u32 gsi_base);
 227
 228 extern int acpi_mp_config;
 229
 230 extern struct acpi_table_mcfg_config *pci_mmcfg_config;
 231 extern int pci_mmcfg_config_num;
 232
 233 extern int sbf_port;
 234 extern unsigned long acpi_video_flags;
 235
 236 #else   /* !CONFIG_ACPI */
 237
 238 #define acpi_mp_config  0
 239
 240 #endif  /* !CONFIG_ACPI */
 241
 242 int acpi_register_gsi (u32 gsi, int triggering, int polarity);
 243 int acpi_gsi_to_irq (u32 gsi, unsigned int *irq);
 244
 245 /*
 246  * This function undoes the effect of one call to acpi_register_gsi().
 247  * If this matches the last registration, any IRQ resources for gsi
 248  * are freed.
 249  */
 250 void acpi_unregister_gsi (u32 gsi);
 251
 252 #ifdef CONFIG_ACPI
 253
 254 struct acpi_prt_entry {
 255         struct list_head        node;
 256         struct acpi_pci_id      id;
 257         u8                      pin;
 258         struct {
 259                 acpi_handle             handle;
 260                 u32                     index;
 261         }                       link;
 262         u32                     irq;
 263 };
 264
 265 struct acpi_prt_list {
 266         int                     count;
 267         struct list_head        entries;
 268 };
 269
 270 struct pci_dev;
 271
 272 int acpi_pci_irq_enable (struct pci_dev *dev);
 273 void acpi_penalize_isa_irq(int irq, int active);
 274
 275 void acpi_pci_irq_disable (struct pci_dev *dev);
 276
 277 struct acpi_pci_driver {
 278         struct acpi_pci_driver *next;
 279         int (*add)(acpi_handle handle);
 280         void (*remove)(acpi_handle handle);
 281 };
 282
 283 int acpi_pci_register_driver(struct acpi_pci_driver *driver);
 284 void acpi_pci_unregister_driver(struct acpi_pci_driver *driver);
 285
 286 #endif /* CONFIG_ACPI */
 287
 288 #ifdef CONFIG_ACPI_EC
 289
 290 extern int ec_read(u8 addr, u8 *val);
 291 extern int ec_write(u8 addr, u8 val);
 292 extern int ec_transaction(u8 command,
 293                           const u8 *wdata, unsigned wdata_len,
 294                           u8 *rdata, unsigned rdata_len);
 295
 296 #endif /*CONFIG_ACPI_EC*/
 297
 298 extern int acpi_blacklisted(void);
 299 extern void acpi_bios_year(char *s);
 300
 301 #define ACPI_CSTATE_LIMIT_DEFINED       /* for driver builds */
 302 #ifdef  CONFIG_ACPI
 303
 304 /*
 305  * Set highest legal C-state
 306  * 0: C0 okay, but not C1
 307  * 1: C1 okay, but not C2
 308  * 2: C2 okay, but not C3 etc.
 309  */
 310
 311 extern unsigned int max_cstate;
 312
 313 static inline unsigned int acpi_get_cstate_limit(void)
 314 {
 315         return max_cstate;
 316 }
 317 static inline void acpi_set_cstate_limit(unsigned int new_limit)
 318 {
 319         max_cstate = new_limit;
 320         return;
 321 }
 322 #else
 323 static inline unsigned int acpi_get_cstate_limit(void) { return 0; }
 324 static inline void acpi_set_cstate_limit(unsigned int new_limit) { return; }
 325 #endif
 326
 327 #ifdef CONFIG_ACPI_NUMA
 328 int acpi_get_pxm(acpi_handle handle);
 329 int acpi_get_node(acpi_handle *handle);
 330 #else
 331 static inline int acpi_get_pxm(acpi_handle handle)
 332 {
 333         return 0;
 334 }
 335 static inline int acpi_get_node(acpi_handle *handle)
 336 {
 337         return 0;
 338 }
 339 #endif
 340 extern int acpi_paddr_to_node(u64 start_addr, u64 size);
 341
 342 extern int pnpacpi_disabled;
 343
 344 #else   /* CONFIG_ACPI */
 345
 346 static inline int acpi_boot_init(void)
 347 {
 348         return 0;
 349 }
 350
 351 static inline int acpi_boot_table_init(void)
 352 {
 353         return 0;
 354 }
 355
 356 #endif  /* CONFIG_ACPI */
 357 #endif  /*_LINUX_ACPI_H*/