xref: /linux-6.15/include/linux/acpi.h (revision 93c06cbb)
1 /*
2  * acpi.h - ACPI Interface
3  *
4  * Copyright (C) 2001 Paul Diefenbaugh <[email protected]>
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 #include <linux/dmi.h>
45 
46 
47 enum acpi_irq_model_id {
48 	ACPI_IRQ_MODEL_PIC = 0,
49 	ACPI_IRQ_MODEL_IOAPIC,
50 	ACPI_IRQ_MODEL_IOSAPIC,
51 	ACPI_IRQ_MODEL_PLATFORM,
52 	ACPI_IRQ_MODEL_COUNT
53 };
54 
55 extern enum acpi_irq_model_id	acpi_irq_model;
56 
57 enum acpi_interrupt_id {
58 	ACPI_INTERRUPT_PMI	= 1,
59 	ACPI_INTERRUPT_INIT,
60 	ACPI_INTERRUPT_CPEI,
61 	ACPI_INTERRUPT_COUNT
62 };
63 
64 #define	ACPI_SPACE_MEM		0
65 
66 enum acpi_address_range_id {
67 	ACPI_ADDRESS_RANGE_MEMORY = 1,
68 	ACPI_ADDRESS_RANGE_RESERVED = 2,
69 	ACPI_ADDRESS_RANGE_ACPI = 3,
70 	ACPI_ADDRESS_RANGE_NVS	= 4,
71 	ACPI_ADDRESS_RANGE_COUNT
72 };
73 
74 
75 /* Table Handlers */
76 
77 typedef int (*acpi_table_handler) (struct acpi_table_header *table);
78 
79 typedef int (*acpi_table_entry_handler) (struct acpi_subtable_header *header, const unsigned long end);
80 
81 char * __acpi_map_table (unsigned long phys_addr, unsigned long size);
82 int early_acpi_boot_init(void);
83 int acpi_boot_init (void);
84 int acpi_boot_table_init (void);
85 int acpi_mps_check (void);
86 int acpi_numa_init (void);
87 
88 int acpi_table_init (void);
89 int acpi_table_parse (char *id, acpi_table_handler handler);
90 int __init acpi_table_parse_entries(char *id, unsigned long table_size,
91 	int entry_id, acpi_table_entry_handler handler, unsigned int max_entries);
92 int acpi_table_parse_madt (enum acpi_madt_type id, acpi_table_entry_handler handler, unsigned int max_entries);
93 int acpi_parse_mcfg (struct acpi_table_header *header);
94 void acpi_table_print_madt_entry (struct acpi_subtable_header *madt);
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 void acpi_irq_stats_init(void);
119 extern u32 acpi_irq_handled;
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_realmode_flags;
126 
127 int acpi_register_gsi (u32 gsi, int triggering, int polarity);
128 int acpi_gsi_to_irq (u32 gsi, unsigned int *irq);
129 
130 #ifdef CONFIG_X86_IO_APIC
131 extern int acpi_get_override_irq(int bus_irq, int *trigger, int *polarity);
132 #else
133 #define acpi_get_override_irq(bus, trigger, polarity) (-1)
134 #endif
135 /*
136  * This function undoes the effect of one call to acpi_register_gsi().
137  * If this matches the last registration, any IRQ resources for gsi
138  * are freed.
139  */
140 void acpi_unregister_gsi (u32 gsi);
141 
142 struct acpi_prt_entry {
143 	struct list_head	node;
144 	struct acpi_pci_id	id;
145 	u8			pin;
146 	struct {
147 		acpi_handle		handle;
148 		u32			index;
149 	}			link;
150 	u32			irq;
151 };
152 
153 struct acpi_prt_list {
154 	int			count;
155 	struct list_head	entries;
156 };
157 
158 struct pci_dev;
159 
160 int acpi_pci_irq_enable (struct pci_dev *dev);
161 void acpi_penalize_isa_irq(int irq, int active);
162 
163 void acpi_pci_irq_disable (struct pci_dev *dev);
164 
165 struct acpi_pci_driver {
166 	struct acpi_pci_driver *next;
167 	int (*add)(acpi_handle handle);
168 	void (*remove)(acpi_handle handle);
169 };
170 
171 int acpi_pci_register_driver(struct acpi_pci_driver *driver);
172 void acpi_pci_unregister_driver(struct acpi_pci_driver *driver);
173 
174 #ifdef CONFIG_ACPI_EC
175 
176 extern int ec_read(u8 addr, u8 *val);
177 extern int ec_write(u8 addr, u8 val);
178 extern int ec_transaction(u8 command,
179                           const u8 *wdata, unsigned wdata_len,
180                           u8 *rdata, unsigned rdata_len,
181 			  int force_poll);
182 
183 #endif /*CONFIG_ACPI_EC*/
184 
185 #if defined(CONFIG_ACPI_WMI) || defined(CONFIG_ACPI_WMI_MODULE)
186 
187 typedef void (*wmi_notify_handler) (u32 value, void *context);
188 
189 extern acpi_status wmi_evaluate_method(const char *guid, u8 instance,
190 					u32 method_id,
191 					const struct acpi_buffer *in,
192 					struct acpi_buffer *out);
193 extern acpi_status wmi_query_block(const char *guid, u8 instance,
194 					struct acpi_buffer *out);
195 extern acpi_status wmi_set_block(const char *guid, u8 instance,
196 					const struct acpi_buffer *in);
197 extern acpi_status wmi_install_notify_handler(const char *guid,
198 					wmi_notify_handler handler, void *data);
199 extern acpi_status wmi_remove_notify_handler(const char *guid);
200 extern acpi_status wmi_get_event_data(u32 event, struct acpi_buffer *out);
201 extern bool wmi_has_guid(const char *guid);
202 
203 #endif	/* CONFIG_ACPI_WMI */
204 
205 extern int acpi_blacklisted(void);
206 #ifdef CONFIG_DMI
207 extern void acpi_dmi_osi_linux(int enable, const struct dmi_system_id *d);
208 extern int acpi_osi_setup(char *str);
209 #endif
210 
211 #ifdef CONFIG_ACPI_NUMA
212 int acpi_get_pxm(acpi_handle handle);
213 int acpi_get_node(acpi_handle *handle);
214 #else
215 static inline int acpi_get_pxm(acpi_handle handle)
216 {
217 	return 0;
218 }
219 static inline int acpi_get_node(acpi_handle *handle)
220 {
221 	return 0;
222 }
223 #endif
224 extern int acpi_paddr_to_node(u64 start_addr, u64 size);
225 
226 extern int pnpacpi_disabled;
227 
228 #define PXM_INVAL	(-1)
229 #define NID_INVAL	(-1)
230 
231 int acpi_check_resource_conflict(struct resource *res);
232 
233 int acpi_check_region(resource_size_t start, resource_size_t n,
234 		      const char *name);
235 int acpi_check_mem_region(resource_size_t start, resource_size_t n,
236 		      const char *name);
237 
238 #ifdef CONFIG_PM_SLEEP
239 void __init acpi_no_s4_hw_signature(void);
240 void __init acpi_old_suspend_ordering(void);
241 #endif /* CONFIG_PM_SLEEP */
242 #else	/* CONFIG_ACPI */
243 
244 static inline int early_acpi_boot_init(void)
245 {
246 	return 0;
247 }
248 static inline int acpi_boot_init(void)
249 {
250 	return 0;
251 }
252 
253 static inline int acpi_boot_table_init(void)
254 {
255 	return 0;
256 }
257 
258 static inline int acpi_mps_check(void)
259 {
260 	return 0;
261 }
262 
263 static inline int acpi_check_resource_conflict(struct resource *res)
264 {
265 	return 0;
266 }
267 
268 static inline int acpi_check_region(resource_size_t start, resource_size_t n,
269 				    const char *name)
270 {
271 	return 0;
272 }
273 
274 static inline int acpi_check_mem_region(resource_size_t start,
275 					resource_size_t n, const char *name)
276 {
277 	return 0;
278 }
279 
280 #endif	/* !CONFIG_ACPI */
281 #endif	/*_LINUX_ACPI_H*/
282