PM: Optional beeping during resume from suspend to RAM
[linux-2.6.git] / 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 enum acpi_interrupt_id {
57         ACPI_INTERRUPT_PMI      = 1,
58         ACPI_INTERRUPT_INIT,
59         ACPI_INTERRUPT_CPEI,
60         ACPI_INTERRUPT_COUNT
61 };
62
63 #define ACPI_SPACE_MEM          0
64
65 enum acpi_address_range_id {
66         ACPI_ADDRESS_RANGE_MEMORY = 1,
67         ACPI_ADDRESS_RANGE_RESERVED = 2,
68         ACPI_ADDRESS_RANGE_ACPI = 3,
69         ACPI_ADDRESS_RANGE_NVS  = 4,
70         ACPI_ADDRESS_RANGE_COUNT
71 };
72
73
74 /* Table Handlers */
75
76 typedef int (*acpi_table_handler) (struct acpi_table_header *table);
77
78 typedef int (*acpi_table_entry_handler) (struct acpi_subtable_header *header, const unsigned long end);
79
80 char * __acpi_map_table (unsigned long phys_addr, unsigned long size);
81 unsigned long acpi_find_rsdp (void);
82 int acpi_boot_init (void);
83 int acpi_boot_table_init (void);
84 int acpi_numa_init (void);
85
86 int acpi_table_init (void);
87 int acpi_table_parse (char *id, acpi_table_handler handler);
88 int __init acpi_table_parse_entries(char *id, unsigned long table_size,
89         int entry_id, acpi_table_entry_handler handler, unsigned int max_entries);
90 int acpi_table_parse_madt (enum acpi_madt_type id, acpi_table_entry_handler handler, unsigned int max_entries);
91 int acpi_table_parse_srat (enum acpi_srat_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 void acpi_table_print_srat_entry (struct acpi_subtable_header *srat);
95
96 /* the following four functions are architecture-dependent */
97 #ifdef CONFIG_HAVE_ARCH_PARSE_SRAT
98 #define NR_NODE_MEMBLKS MAX_NUMNODES
99 #define acpi_numa_slit_init(slit) do {} while (0)
100 #define acpi_numa_processor_affinity_init(pa) do {} while (0)
101 #define acpi_numa_memory_affinity_init(ma) do {} while (0)
102 #define acpi_numa_arch_fixup() do {} while (0)
103 #else
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_memory_affinity_init (struct acpi_srat_mem_affinity *ma);
107 void acpi_numa_arch_fixup(void);
108 #endif
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
119 extern int acpi_mp_config;
120
121 extern struct acpi_mcfg_allocation *pci_mmcfg_config;
122 extern int pci_mmcfg_config_num;
123
124 extern int sbf_port;
125 extern unsigned long acpi_video_flags;
126 extern unsigned long s2ram_beep;
127
128 #else   /* !CONFIG_ACPI */
129
130 #define acpi_mp_config  0
131
132 #endif  /* !CONFIG_ACPI */
133
134 int acpi_register_gsi (u32 gsi, int triggering, int polarity);
135 int acpi_gsi_to_irq (u32 gsi, unsigned int *irq);
136
137 /*
138  * This function undoes the effect of one call to acpi_register_gsi().
139  * If this matches the last registration, any IRQ resources for gsi
140  * are freed.
141  */
142 void acpi_unregister_gsi (u32 gsi);
143
144 #ifdef CONFIG_ACPI
145
146 struct acpi_prt_entry {
147         struct list_head        node;
148         struct acpi_pci_id      id;
149         u8                      pin;
150         struct {
151                 acpi_handle             handle;
152                 u32                     index;
153         }                       link;
154         u32                     irq;
155 };
156
157 struct acpi_prt_list {
158         int                     count;
159         struct list_head        entries;
160 };
161
162 struct pci_dev;
163
164 int acpi_pci_irq_enable (struct pci_dev *dev);
165 void acpi_penalize_isa_irq(int irq, int active);
166
167 void acpi_pci_irq_disable (struct pci_dev *dev);
168
169 struct acpi_pci_driver {
170         struct acpi_pci_driver *next;
171         int (*add)(acpi_handle handle);
172         void (*remove)(acpi_handle handle);
173 };
174
175 int acpi_pci_register_driver(struct acpi_pci_driver *driver);
176 void acpi_pci_unregister_driver(struct acpi_pci_driver *driver);
177
178 #endif /* CONFIG_ACPI */
179
180 #ifdef CONFIG_ACPI_EC
181
182 extern int ec_read(u8 addr, u8 *val);
183 extern int ec_write(u8 addr, u8 val);
184 extern int ec_transaction(u8 command,
185                           const u8 *wdata, unsigned wdata_len,
186                           u8 *rdata, unsigned rdata_len,
187                           int force_poll);
188
189 #endif /*CONFIG_ACPI_EC*/
190
191 extern int acpi_blacklisted(void);
192 extern void acpi_bios_year(char *s);
193
194 #define ACPI_CSTATE_LIMIT_DEFINED       /* for driver builds */
195 #ifdef  CONFIG_ACPI
196
197 /*
198  * Set highest legal C-state
199  * 0: C0 okay, but not C1
200  * 1: C1 okay, but not C2
201  * 2: C2 okay, but not C3 etc.
202  */
203
204 extern unsigned int max_cstate;
205
206 static inline unsigned int acpi_get_cstate_limit(void)
207 {
208         return max_cstate;
209 }
210 static inline void acpi_set_cstate_limit(unsigned int new_limit)
211 {
212         max_cstate = new_limit;
213         return;
214 }
215 #else
216 static inline unsigned int acpi_get_cstate_limit(void) { return 0; }
217 static inline void acpi_set_cstate_limit(unsigned int new_limit) { return; }
218 #endif
219
220 #ifdef CONFIG_ACPI_NUMA
221 int acpi_get_pxm(acpi_handle handle);
222 int acpi_get_node(acpi_handle *handle);
223 #else
224 static inline int acpi_get_pxm(acpi_handle handle)
225 {
226         return 0;
227 }
228 static inline int acpi_get_node(acpi_handle *handle)
229 {
230         return 0;
231 }
232 #endif
233 extern int acpi_paddr_to_node(u64 start_addr, u64 size);
234
235 extern int pnpacpi_disabled;
236
237 #else   /* CONFIG_ACPI */
238
239 static inline int acpi_boot_init(void)
240 {
241         return 0;
242 }
243
244 static inline int acpi_boot_table_init(void)
245 {
246         return 0;
247 }
248
249 #endif  /* CONFIG_ACPI */
250 #endif  /*_LINUX_ACPI_H*/