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