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