[mirror_ubuntu-bionic-kernel.git] / include / linux / acpi.h

/*
 * acpi.h - ACPI Interface
 *
 * Copyright (C) 2001 Paul Diefenbaugh <paul.s.diefenbaugh@intel.com>
 *
 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 */

#ifndef _LINUX_ACPI_H
#define _LINUX_ACPI_H

#include <linux/ioport.h>	/* for struct resource */

#ifdef	CONFIG_ACPI

#ifndef _LINUX
#define _LINUX
#endif

#include <linux/list.h>
#include <linux/mod_devicetable.h>

#include <acpi/acpi.h>
#include <acpi/acpi_bus.h>
#include <acpi/acpi_drivers.h>
#include <acpi/acpi_numa.h>
#include <asm/acpi.h>
#include <linux/dmi.h>


enum acpi_irq_model_id {
	ACPI_IRQ_MODEL_PIC = 0,
	ACPI_IRQ_MODEL_IOAPIC,
	ACPI_IRQ_MODEL_IOSAPIC,
	ACPI_IRQ_MODEL_PLATFORM,
	ACPI_IRQ_MODEL_COUNT
};

extern enum acpi_irq_model_id	acpi_irq_model;

enum acpi_interrupt_id {
	ACPI_INTERRUPT_PMI	= 1,
	ACPI_INTERRUPT_INIT,
	ACPI_INTERRUPT_CPEI,
	ACPI_INTERRUPT_COUNT
};

#define	ACPI_SPACE_MEM		0

enum acpi_address_range_id {
	ACPI_ADDRESS_RANGE_MEMORY = 1,
	ACPI_ADDRESS_RANGE_RESERVED = 2,
	ACPI_ADDRESS_RANGE_ACPI = 3,
	ACPI_ADDRESS_RANGE_NVS	= 4,
	ACPI_ADDRESS_RANGE_COUNT
};


/* Table Handlers */

typedef int (*acpi_table_handler) (struct acpi_table_header *table);

typedef int (*acpi_table_entry_handler) (struct acpi_subtable_header *header, const unsigned long end);

char * __acpi_map_table (unsigned long phys_addr, unsigned long size);
int early_acpi_boot_init(void);
int acpi_boot_init (void);
int acpi_boot_table_init (void);
int acpi_mps_check (void);
int acpi_numa_init (void);

int acpi_table_init (void);
int acpi_table_parse (char *id, acpi_table_handler handler);
int __init acpi_table_parse_entries(char *id, unsigned long table_size,
	int entry_id, acpi_table_entry_handler handler, unsigned int max_entries);
int acpi_table_parse_madt (enum acpi_madt_type id, acpi_table_entry_handler handler, unsigned int max_entries);
int acpi_parse_mcfg (struct acpi_table_header *header);
void acpi_table_print_madt_entry (struct acpi_subtable_header *madt);

/* the following four functions are architecture-dependent */
void acpi_numa_slit_init (struct acpi_table_slit *slit);
void acpi_numa_processor_affinity_init (struct acpi_srat_cpu_affinity *pa);
void acpi_numa_memory_affinity_init (struct acpi_srat_mem_affinity *ma);
void acpi_numa_arch_fixup(void);

#ifdef CONFIG_ACPI_HOTPLUG_CPU
/* Arch dependent functions for cpu hotplug support */
int acpi_map_lsapic(acpi_handle handle, int *pcpu);
int acpi_unmap_lsapic(int cpu);
#endif /* CONFIG_ACPI_HOTPLUG_CPU */

int acpi_register_ioapic(acpi_handle handle, u64 phys_addr, u32 gsi_base);
int acpi_unregister_ioapic(acpi_handle handle, u32 gsi_base);
void acpi_irq_stats_init(void);
extern u32 acpi_irq_handled;

extern struct acpi_mcfg_allocation *pci_mmcfg_config;
extern int pci_mmcfg_config_num;

extern int sbf_port;
extern unsigned long acpi_realmode_flags;

int acpi_register_gsi (u32 gsi, int triggering, int polarity);
int acpi_gsi_to_irq (u32 gsi, unsigned int *irq);

#ifdef CONFIG_X86_IO_APIC
extern int acpi_get_override_irq(int bus_irq, int *trigger, int *polarity);
#else
#define acpi_get_override_irq(bus, trigger, polarity) (-1)
#endif
/*
 * This function undoes the effect of one call to acpi_register_gsi().
 * If this matches the last registration, any IRQ resources for gsi
 * are freed.
 */
void acpi_unregister_gsi (u32 gsi);

struct acpi_prt_entry {
	struct list_head	node;
	struct acpi_pci_id	id;
	u8			pin;
	struct {
		acpi_handle		handle;
		u32			index;
	}			link;
	u32			irq;
};

struct acpi_prt_list {
	int			count;
	struct list_head	entries;
};

struct pci_dev;

int acpi_pci_irq_enable (struct pci_dev *dev);
void acpi_penalize_isa_irq(int irq, int active);

void acpi_pci_irq_disable (struct pci_dev *dev);

struct acpi_pci_driver {
	struct acpi_pci_driver *next;
	int (*add)(acpi_handle handle);
	void (*remove)(acpi_handle handle);
};

int acpi_pci_register_driver(struct acpi_pci_driver *driver);
void acpi_pci_unregister_driver(struct acpi_pci_driver *driver);

#ifdef CONFIG_ACPI_EC

extern int ec_read(u8 addr, u8 *val);
extern int ec_write(u8 addr, u8 val);
extern int ec_transaction(u8 command,
                          const u8 *wdata, unsigned wdata_len,
                          u8 *rdata, unsigned rdata_len,
			  int force_poll);

#endif /*CONFIG_ACPI_EC*/

#if defined(CONFIG_ACPI_WMI) || defined(CONFIG_ACPI_WMI_MODULE)

typedef void (*wmi_notify_handler) (u32 value, void *context);

extern acpi_status wmi_evaluate_method(const char *guid, u8 instance,
					u32 method_id,
					const struct acpi_buffer *in,
					struct acpi_buffer *out);
extern acpi_status wmi_query_block(const char *guid, u8 instance,
					struct acpi_buffer *out);
extern acpi_status wmi_set_block(const char *guid, u8 instance,
					const struct acpi_buffer *in);
extern acpi_status wmi_install_notify_handler(const char *guid,
					wmi_notify_handler handler, void *data);
extern acpi_status wmi_remove_notify_handler(const char *guid);
extern acpi_status wmi_get_event_data(u32 event, struct acpi_buffer *out);
extern bool wmi_has_guid(const char *guid);

#endif	/* CONFIG_ACPI_WMI */

extern int acpi_blacklisted(void);
#ifdef CONFIG_DMI
extern void acpi_dmi_osi_linux(int enable, const struct dmi_system_id *d);
extern int acpi_osi_setup(char *str);
#endif

#ifdef CONFIG_ACPI_NUMA
int acpi_get_pxm(acpi_handle handle);
int acpi_get_node(acpi_handle *handle);
#else
static inline int acpi_get_pxm(acpi_handle handle)
{
	return 0;
}
static inline int acpi_get_node(acpi_handle *handle)
{
	return 0;
}
#endif
extern int acpi_paddr_to_node(u64 start_addr, u64 size);

extern int pnpacpi_disabled;

#define PXM_INVAL	(-1)
#define NID_INVAL	(-1)

int acpi_check_resource_conflict(struct resource *res);

int acpi_check_region(resource_size_t start, resource_size_t n,
		      const char *name);
int acpi_check_mem_region(resource_size_t start, resource_size_t n,
		      const char *name);

#ifdef CONFIG_PM_SLEEP
void __init acpi_no_s4_hw_signature(void);
void __init acpi_old_suspend_ordering(void);
#endif /* CONFIG_PM_SLEEP */
#else	/* CONFIG_ACPI */

static inline int early_acpi_boot_init(void)
{
	return 0;
}
static inline int acpi_boot_init(void)
{
	return 0;
}

static inline int acpi_boot_table_init(void)
{
	return 0;
}

static inline int acpi_mps_check(void)
{
	return 0;
}

static inline int acpi_check_resource_conflict(struct resource *res)
{
	return 0;
}

static inline int acpi_check_region(resource_size_t start, resource_size_t n,
				    const char *name)
{
	return 0;
}

static inline int acpi_check_mem_region(resource_size_t start,
					resource_size_t n, const char *name)
{
	return 0;
}

#endif	/* !CONFIG_ACPI */
#endif	/*_LINUX_ACPI_H*/
Commit	Line	Data
1da177e4 LT	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
443dea72	28	#include <linux/ioport.h> /* for struct resource */
3f5948fa	29
25be5e6c LB	30	#ifdef CONFIG_ACPI
25be5e6c LB	31
1da177e4 LT	32	#ifndef _LINUX
	33	#define _LINUX
	34	#endif
	35
	36	#include <linux/list.h>
29b71a1c	37	#include <linux/mod_devicetable.h>
1da177e4 LT	38
	39	#include <acpi/acpi.h>
	40	#include <acpi/acpi_bus.h>
	41	#include <acpi/acpi_drivers.h>
762834e8	42	#include <acpi/acpi_numa.h>
1da177e4	43	#include <asm/acpi.h>
d4b7dc49	44	#include <linux/dmi.h>
1da177e4 LT	45
1da177e4 LT	46
1da177e4 LT	47	enum acpi_irq_model_id {
	48	ACPI_IRQ_MODEL_PIC = 0,
	49	ACPI_IRQ_MODEL_IOAPIC,
	50	ACPI_IRQ_MODEL_IOSAPIC,
3948ec94	51	ACPI_IRQ_MODEL_PLATFORM,
1da177e4 LT	52	ACPI_IRQ_MODEL_COUNT
	53	};
	54
	55	extern enum acpi_irq_model_id acpi_irq_model;
	56
1da177e4 LT	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
1da177e4 LT	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
1da177e4	74
1da177e4 LT	75	/* Table Handlers */
1da177e4 LT	76
15a58ed1	77	typedef int (acpi_table_handler) (struct acpi_table_header table);
1da177e4	78
5a8765a8	79	typedef int (acpi_table_entry_handler) (struct acpi_subtable_header header, const unsigned long end);
1da177e4 LT	80
1da177e4 LT	81	char * __acpi_map_table (unsigned long phys_addr, unsigned long size);
cbf9bd60	82	int early_acpi_boot_init(void);
1da177e4 LT	83	int acpi_boot_init (void);
1da177e4 LT	84	int acpi_boot_table_init (void);
3c999f14	85	int acpi_mps_check (void);
1da177e4 LT	86	int acpi_numa_init (void);
	87
	88	int acpi_table_init (void);
ceb6c468	89	int acpi_table_parse (char *id, acpi_table_handler handler);
6eb87fed LB	90	int __init acpi_table_parse_entries(char *id, unsigned long table_size,
6eb87fed LB	91	int entry_id, acpi_table_entry_handler handler, unsigned int max_entries);
5a8765a8	92	int acpi_table_parse_madt (enum acpi_madt_type id, acpi_table_entry_handler handler, unsigned int max_entries);
ceb6c468	93	int acpi_parse_mcfg (struct acpi_table_header *header);
5f3b1a8b	94	void acpi_table_print_madt_entry (struct acpi_subtable_header *madt);
1da177e4 LT	95
	96	/* the following four functions are architecture-dependent */
	97	void acpi_numa_slit_init (struct acpi_table_slit *slit);
15a58ed1 AS	98	void acpi_numa_processor_affinity_init (struct acpi_srat_cpu_affinity *pa);
15a58ed1 AS	99	void acpi_numa_memory_affinity_init (struct acpi_srat_mem_affinity *ma);
1da177e4 LT	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
b1bb248a KK	108	int acpi_register_ioapic(acpi_handle handle, u64 phys_addr, u32 gsi_base);
b1bb248a KK	109	int acpi_unregister_ioapic(acpi_handle handle, u32 gsi_base);
5229e87d	110	void acpi_irq_stats_init(void);
5229e87d	111	extern u32 acpi_irq_handled;
1da177e4	112
15a58ed1	113	extern struct acpi_mcfg_allocation *pci_mmcfg_config;
54549391	114	extern int pci_mmcfg_config_num;
1da177e4	115
c255d844	116	extern int sbf_port;
77afcf78	117	extern unsigned long acpi_realmode_flags;
1da177e4	118
50eca3eb	119	int acpi_register_gsi (u32 gsi, int triggering, int polarity);
1da177e4 LT	120	int acpi_gsi_to_irq (u32 gsi, unsigned int *irq);
1da177e4 LT	121
61fd47e0 SL	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
1da177e4 LT	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	*/
1da177e4	132	void acpi_unregister_gsi (u32 gsi);
1da177e4	133
1da177e4 LT	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);
c9c3e457	153	void acpi_penalize_isa_irq(int irq, int active);
1da177e4	154
1da177e4	155	void acpi_pci_irq_disable (struct pci_dev *dev);
1da177e4 LT	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
1da177e4 LT	166	#ifdef CONFIG_ACPI_EC
	167
	168	extern int ec_read(u8 addr, u8 *val);
	169	extern int ec_write(u8 addr, u8 val);
d7a76e4c LP	170	extern int ec_transaction(u8 command,
d7a76e4c LP	171	const u8 *wdata, unsigned wdata_len,
00eb43a1 LP	172	u8 *rdata, unsigned rdata_len,
00eb43a1 LP	173	int force_poll);
1da177e4 LT	174
	175	#endif /CONFIG_ACPI_EC/
	176
bff431e4 CC	177	#if defined(CONFIG_ACPI_WMI) \|\| defined(CONFIG_ACPI_WMI_MODULE)
	178
	179	typedef void (wmi_notify_handler) (u32 value, void context);
	180
	181	extern acpi_status wmi_evaluate_method(const char *guid, u8 instance,
	182	u32 method_id,
	183	const struct acpi_buffer *in,
	184	struct acpi_buffer *out);
	185	extern acpi_status wmi_query_block(const char *guid, u8 instance,
	186	struct acpi_buffer *out);
	187	extern acpi_status wmi_set_block(const char *guid, u8 instance,
	188	const struct acpi_buffer *in);
	189	extern acpi_status wmi_install_notify_handler(const char *guid,
	190	wmi_notify_handler handler, void *data);
	191	extern acpi_status wmi_remove_notify_handler(const char *guid);
	192	extern acpi_status wmi_get_event_data(u32 event, struct acpi_buffer *out);
	193	extern bool wmi_has_guid(const char *guid);
	194
	195	#endif /* CONFIG_ACPI_WMI */
	196
1da177e4	197	extern int acpi_blacklisted(void);
d4b7dc49 LB	198	#ifdef CONFIG_DMI
d4b7dc49 LB	199	extern void acpi_dmi_osi_linux(int enable, const struct dmi_system_id *d);
46c1fbdb	200	extern int acpi_osi_setup(char *str);
d4b7dc49	201	#endif
1da177e4	202
1da177e4 LT	203	#ifdef CONFIG_ACPI_NUMA
1da177e4 LT	204	int acpi_get_pxm(acpi_handle handle);
1e3590e2	205	int acpi_get_node(acpi_handle *handle);
1da177e4 LT	206	#else
	207	static inline int acpi_get_pxm(acpi_handle handle)
	208	{
	209	return 0;
	210	}
1e3590e2 YG	211	static inline int acpi_get_node(acpi_handle *handle)
	212	{
	213	return 0;
	214	}
1da177e4	215	#endif
1e3590e2	216	extern int acpi_paddr_to_node(u64 start_addr, u64 size);
1da177e4 LT	217
	218	extern int pnpacpi_disabled;
	219
3484d798 DR	220	#define PXM_INVAL (-1)
	221	#define NID_INVAL (-1)
	222
443dea72 TR	223	int acpi_check_resource_conflict(struct resource *res);
443dea72 TR	224
df92e695 TR	225	int acpi_check_region(resource_size_t start, resource_size_t n,
	226	const char *name);
	227	int acpi_check_mem_region(resource_size_t start, resource_size_t n,
	228	const char *name);
	229
d8f3de0d	230	#ifdef CONFIG_PM_SLEEP
bdfe6b7c	231	void __init acpi_no_s4_hw_signature(void);
d8f3de0d RW	232	void __init acpi_old_suspend_ordering(void);
d8f3de0d RW	233	#endif /* CONFIG_PM_SLEEP */
53de49f5 AM	234	#else /* CONFIG_ACPI */
53de49f5 AM	235
cbf9bd60 YL	236	static inline int early_acpi_boot_init(void)
	237	{
	238	return 0;
	239	}
53de49f5 AM	240	static inline int acpi_boot_init(void)
	241	{
	242	return 0;
	243	}
	244
	245	static inline int acpi_boot_table_init(void)
	246	{
	247	return 0;
	248	}
	249
3c999f14 YL	250	static inline int acpi_mps_check(void)
	251	{
	252	return 0;
	253	}
	254
443dea72 TR	255	static inline int acpi_check_resource_conflict(struct resource *res)
	256	{
	257	return 0;
	258	}
	259
df92e695 TR	260	static inline int acpi_check_region(resource_size_t start, resource_size_t n,
	261	const char *name)
	262	{
	263	return 0;
	264	}
	265
	266	static inline int acpi_check_mem_region(resource_size_t start,
	267	resource_size_t n, const char *name)
	268	{
	269	return 0;
	270	}
	271
d4b7dc49	272	#endif /* !CONFIG_ACPI */
25be5e6c	273	#endif /_LINUX_ACPI_H/