xref: /linux-6.15/include/linux/acpi.h (revision d289bf7b)
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 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_parse_mcfg (struct acpi_table_header *header);
92 void acpi_table_print_madt_entry (struct acpi_subtable_header *madt);
93 
94 /* the following four functions are architecture-dependent */
95 #ifdef CONFIG_HAVE_ARCH_PARSE_SRAT
96 #define NR_NODE_MEMBLKS MAX_NUMNODES
97 #define acpi_numa_slit_init(slit) do {} while (0)
98 #define acpi_numa_processor_affinity_init(pa) do {} while (0)
99 #define acpi_numa_memory_affinity_init(ma) do {} while (0)
100 #define acpi_numa_arch_fixup() do {} while (0)
101 #else
102 void acpi_numa_slit_init (struct acpi_table_slit *slit);
103 void acpi_numa_processor_affinity_init (struct acpi_srat_cpu_affinity *pa);
104 void acpi_numa_memory_affinity_init (struct acpi_srat_mem_affinity *ma);
105 void acpi_numa_arch_fixup(void);
106 #endif
107 
108 #ifdef CONFIG_ACPI_HOTPLUG_CPU
109 /* Arch dependent functions for cpu hotplug support */
110 int acpi_map_lsapic(acpi_handle handle, int *pcpu);
111 int acpi_unmap_lsapic(int cpu);
112 #endif /* CONFIG_ACPI_HOTPLUG_CPU */
113 
114 int acpi_register_ioapic(acpi_handle handle, u64 phys_addr, u32 gsi_base);
115 int acpi_unregister_ioapic(acpi_handle handle, u32 gsi_base);
116 void acpi_irq_stats_init(void);
117 extern u32 acpi_irq_handled;
118 
119 extern struct acpi_mcfg_allocation *pci_mmcfg_config;
120 extern int pci_mmcfg_config_num;
121 
122 extern int sbf_port;
123 extern unsigned long acpi_realmode_flags;
124 
125 int acpi_register_gsi (u32 gsi, int triggering, int polarity);
126 int acpi_gsi_to_irq (u32 gsi, unsigned int *irq);
127 
128 #ifdef CONFIG_X86_IO_APIC
129 extern int acpi_get_override_irq(int bus_irq, int *trigger, int *polarity);
130 #else
131 #define acpi_get_override_irq(bus, trigger, polarity) (-1)
132 #endif
133 /*
134  * This function undoes the effect of one call to acpi_register_gsi().
135  * If this matches the last registration, any IRQ resources for gsi
136  * are freed.
137  */
138 void acpi_unregister_gsi (u32 gsi);
139 
140 struct acpi_prt_entry {
141 	struct list_head	node;
142 	struct acpi_pci_id	id;
143 	u8			pin;
144 	struct {
145 		acpi_handle		handle;
146 		u32			index;
147 	}			link;
148 	u32			irq;
149 };
150 
151 struct acpi_prt_list {
152 	int			count;
153 	struct list_head	entries;
154 };
155 
156 struct pci_dev;
157 
158 int acpi_pci_irq_enable (struct pci_dev *dev);
159 void acpi_penalize_isa_irq(int irq, int active);
160 
161 void acpi_pci_irq_disable (struct pci_dev *dev);
162 
163 struct acpi_pci_driver {
164 	struct acpi_pci_driver *next;
165 	int (*add)(acpi_handle handle);
166 	void (*remove)(acpi_handle handle);
167 };
168 
169 int acpi_pci_register_driver(struct acpi_pci_driver *driver);
170 void acpi_pci_unregister_driver(struct acpi_pci_driver *driver);
171 
172 #ifdef CONFIG_ACPI_EC
173 
174 extern int ec_read(u8 addr, u8 *val);
175 extern int ec_write(u8 addr, u8 val);
176 extern int ec_transaction(u8 command,
177                           const u8 *wdata, unsigned wdata_len,
178                           u8 *rdata, unsigned rdata_len,
179 			  int force_poll);
180 
181 #endif /*CONFIG_ACPI_EC*/
182 
183 #if defined(CONFIG_ACPI_WMI) || defined(CONFIG_ACPI_WMI_MODULE)
184 
185 typedef void (*wmi_notify_handler) (u32 value, void *context);
186 
187 extern acpi_status wmi_evaluate_method(const char *guid, u8 instance,
188 					u32 method_id,
189 					const struct acpi_buffer *in,
190 					struct acpi_buffer *out);
191 extern acpi_status wmi_query_block(const char *guid, u8 instance,
192 					struct acpi_buffer *out);
193 extern acpi_status wmi_set_block(const char *guid, u8 instance,
194 					const struct acpi_buffer *in);
195 extern acpi_status wmi_install_notify_handler(const char *guid,
196 					wmi_notify_handler handler, void *data);
197 extern acpi_status wmi_remove_notify_handler(const char *guid);
198 extern acpi_status wmi_get_event_data(u32 event, struct acpi_buffer *out);
199 extern bool wmi_has_guid(const char *guid);
200 
201 #endif	/* CONFIG_ACPI_WMI */
202 
203 extern int acpi_blacklisted(void);
204 #ifdef CONFIG_DMI
205 extern void acpi_dmi_osi_linux(int enable, const struct dmi_system_id *d);
206 extern int acpi_osi_setup(char *str);
207 #endif
208 
209 #ifdef CONFIG_ACPI_NUMA
210 int acpi_get_pxm(acpi_handle handle);
211 int acpi_get_node(acpi_handle *handle);
212 #else
213 static inline int acpi_get_pxm(acpi_handle handle)
214 {
215 	return 0;
216 }
217 static inline int acpi_get_node(acpi_handle *handle)
218 {
219 	return 0;
220 }
221 #endif
222 extern int acpi_paddr_to_node(u64 start_addr, u64 size);
223 
224 extern int pnpacpi_disabled;
225 
226 #define PXM_INVAL	(-1)
227 #define NID_INVAL	(-1)
228 
229 int acpi_check_resource_conflict(struct resource *res);
230 
231 int acpi_check_region(resource_size_t start, resource_size_t n,
232 		      const char *name);
233 int acpi_check_mem_region(resource_size_t start, resource_size_t n,
234 		      const char *name);
235 
236 #else	/* CONFIG_ACPI */
237 
238 static inline int acpi_boot_init(void)
239 {
240 	return 0;
241 }
242 
243 static inline int acpi_boot_table_init(void)
244 {
245 	return 0;
246 }
247 
248 static inline int acpi_check_resource_conflict(struct resource *res)
249 {
250 	return 0;
251 }
252 
253 static inline int acpi_check_region(resource_size_t start, resource_size_t n,
254 				    const char *name)
255 {
256 	return 0;
257 }
258 
259 static inline int acpi_check_mem_region(resource_size_t start,
260 					resource_size_t n, const char *name)
261 {
262 	return 0;
263 }
264 
265 #endif	/* !CONFIG_ACPI */
266 #endif	/*_LINUX_ACPI_H*/
267