[mirror_ubuntu-zesty-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>


#ifdef CONFIG_ACPI

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);
unsigned long acpi_find_rsdp (void);
int acpi_boot_init (void);
int acpi_boot_table_init (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 */
#ifdef CONFIG_HAVE_ARCH_PARSE_SRAT
#define NR_NODE_MEMBLKS MAX_NUMNODES
#define acpi_numa_slit_init(slit) do {} while (0)
#define acpi_numa_processor_affinity_init(pa) do {} while (0)
#define acpi_numa_memory_affinity_init(ma) do {} while (0)
#define acpi_numa_arch_fixup() do {} while (0)
#else
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);
#endif

#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);

extern int acpi_mp_config;

extern struct acpi_mcfg_allocation *pci_mmcfg_config;
extern int pci_mmcfg_config_num;

extern int sbf_port;
extern unsigned long acpi_realmode_flags;

#else	/* !CONFIG_ACPI */

#define acpi_mp_config	0

#endif 	/* !CONFIG_ACPI */

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);

#ifdef CONFIG_ACPI

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);

#endif /* CONFIG_ACPI */

#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*/

extern int acpi_blacklisted(void);
#ifdef CONFIG_DMI
extern void acpi_dmi_osi_linux(int enable, const struct dmi_system_id *d);
#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);

#else	/* CONFIG_ACPI */

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

static inline int acpi_boot_table_init(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
888ba6c6	47	#ifdef CONFIG_ACPI
1da177e4 LT	48
	49	enum acpi_irq_model_id {
	50	ACPI_IRQ_MODEL_PIC = 0,
	51	ACPI_IRQ_MODEL_IOAPIC,
	52	ACPI_IRQ_MODEL_IOSAPIC,
3948ec94	53	ACPI_IRQ_MODEL_PLATFORM,
1da177e4 LT	54	ACPI_IRQ_MODEL_COUNT
	55	};
	56
	57	extern enum acpi_irq_model_id acpi_irq_model;
	58
1da177e4 LT	59	enum acpi_interrupt_id {
	60	ACPI_INTERRUPT_PMI = 1,
	61	ACPI_INTERRUPT_INIT,
	62	ACPI_INTERRUPT_CPEI,
	63	ACPI_INTERRUPT_COUNT
	64	};
	65
	66	#define ACPI_SPACE_MEM 0
	67
1da177e4 LT	68	enum acpi_address_range_id {
	69	ACPI_ADDRESS_RANGE_MEMORY = 1,
	70	ACPI_ADDRESS_RANGE_RESERVED = 2,
	71	ACPI_ADDRESS_RANGE_ACPI = 3,
	72	ACPI_ADDRESS_RANGE_NVS = 4,
	73	ACPI_ADDRESS_RANGE_COUNT
	74	};
	75
1da177e4	76
1da177e4 LT	77	/* Table Handlers */
1da177e4 LT	78
15a58ed1	79	typedef int (acpi_table_handler) (struct acpi_table_header table);
1da177e4	80
5a8765a8	81	typedef int (acpi_table_entry_handler) (struct acpi_subtable_header header, const unsigned long end);
1da177e4 LT	82
	83	char * __acpi_map_table (unsigned long phys_addr, unsigned long size);
	84	unsigned long acpi_find_rsdp (void);
	85	int acpi_boot_init (void);
	86	int acpi_boot_table_init (void);
	87	int acpi_numa_init (void);
	88
	89	int acpi_table_init (void);
ceb6c468	90	int acpi_table_parse (char *id, acpi_table_handler handler);
6eb87fed LB	91	int __init acpi_table_parse_entries(char *id, unsigned long table_size,
6eb87fed LB	92	int entry_id, acpi_table_entry_handler handler, unsigned int max_entries);
5a8765a8	93	int acpi_table_parse_madt (enum acpi_madt_type id, acpi_table_entry_handler handler, unsigned int max_entries);
ceb6c468	94	int acpi_parse_mcfg (struct acpi_table_header *header);
5f3b1a8b	95	void acpi_table_print_madt_entry (struct acpi_subtable_header *madt);
1da177e4 LT	96
1da177e4 LT	97	/* the following four functions are architecture-dependent */
762834e8 YG	98	#ifdef CONFIG_HAVE_ARCH_PARSE_SRAT
	99	#define NR_NODE_MEMBLKS MAX_NUMNODES
	100	#define acpi_numa_slit_init(slit) do {} while (0)
	101	#define acpi_numa_processor_affinity_init(pa) do {} while (0)
	102	#define acpi_numa_memory_affinity_init(ma) do {} while (0)
	103	#define acpi_numa_arch_fixup() do {} while (0)
	104	#else
1da177e4	105	void acpi_numa_slit_init (struct acpi_table_slit *slit);
15a58ed1 AS	106	void acpi_numa_processor_affinity_init (struct acpi_srat_cpu_affinity *pa);
15a58ed1 AS	107	void acpi_numa_memory_affinity_init (struct acpi_srat_mem_affinity *ma);
1da177e4	108	void acpi_numa_arch_fixup(void);
762834e8	109	#endif
1da177e4 LT	110
	111	#ifdef CONFIG_ACPI_HOTPLUG_CPU
	112	/* Arch dependent functions for cpu hotplug support */
	113	int acpi_map_lsapic(acpi_handle handle, int *pcpu);
	114	int acpi_unmap_lsapic(int cpu);
	115	#endif /* CONFIG_ACPI_HOTPLUG_CPU */
	116
b1bb248a KK	117	int acpi_register_ioapic(acpi_handle handle, u64 phys_addr, u32 gsi_base);
	118	int acpi_unregister_ioapic(acpi_handle handle, u32 gsi_base);
	119
1da177e4 LT	120	extern int acpi_mp_config;
1da177e4 LT	121
15a58ed1	122	extern struct acpi_mcfg_allocation *pci_mmcfg_config;
54549391	123	extern int pci_mmcfg_config_num;
1da177e4	124
c255d844	125	extern int sbf_port;
77afcf78	126	extern unsigned long acpi_realmode_flags;
1da177e4	127
888ba6c6	128	#else /* !CONFIG_ACPI */
1da177e4 LT	129
	130	#define acpi_mp_config 0
	131
888ba6c6	132	#endif /* !CONFIG_ACPI */
1da177e4	133
50eca3eb	134	int acpi_register_gsi (u32 gsi, int triggering, int polarity);
1da177e4 LT	135	int acpi_gsi_to_irq (u32 gsi, unsigned int *irq);
1da177e4 LT	136
61fd47e0 SL	137	#ifdef CONFIG_X86_IO_APIC
	138	extern int acpi_get_override_irq(int bus_irq, int trigger, int polarity);
	139	#else
	140	#define acpi_get_override_irq(bus, trigger, polarity) (-1)
	141	#endif
1da177e4 LT	142	/*
	143	* This function undoes the effect of one call to acpi_register_gsi().
	144	* If this matches the last registration, any IRQ resources for gsi
	145	* are freed.
	146	*/
1da177e4	147	void acpi_unregister_gsi (u32 gsi);
1da177e4	148
6153df7b	149	#ifdef CONFIG_ACPI
1da177e4 LT	150
	151	struct acpi_prt_entry {
	152	struct list_head node;
	153	struct acpi_pci_id id;
	154	u8 pin;
	155	struct {
	156	acpi_handle handle;
	157	u32 index;
	158	} link;
	159	u32 irq;
	160	};
	161
	162	struct acpi_prt_list {
	163	int count;
	164	struct list_head entries;
	165	};
	166
	167	struct pci_dev;
	168
	169	int acpi_pci_irq_enable (struct pci_dev *dev);
c9c3e457	170	void acpi_penalize_isa_irq(int irq, int active);
1da177e4	171
1da177e4	172	void acpi_pci_irq_disable (struct pci_dev *dev);
1da177e4 LT	173
	174	struct acpi_pci_driver {
	175	struct acpi_pci_driver *next;
	176	int (*add)(acpi_handle handle);
	177	void (*remove)(acpi_handle handle);
	178	};
	179
	180	int acpi_pci_register_driver(struct acpi_pci_driver *driver);
	181	void acpi_pci_unregister_driver(struct acpi_pci_driver *driver);
	182
6153df7b	183	#endif /* CONFIG_ACPI */
1da177e4 LT	184
	185	#ifdef CONFIG_ACPI_EC
	186
	187	extern int ec_read(u8 addr, u8 *val);
	188	extern int ec_write(u8 addr, u8 val);
d7a76e4c LP	189	extern int ec_transaction(u8 command,
d7a76e4c LP	190	const u8 *wdata, unsigned wdata_len,
00eb43a1 LP	191	u8 *rdata, unsigned rdata_len,
00eb43a1 LP	192	int force_poll);
1da177e4 LT	193
	194	#endif /CONFIG_ACPI_EC/
	195
1da177e4	196	extern int acpi_blacklisted(void);
d4b7dc49 LB	197	#ifdef CONFIG_DMI
	198	extern void acpi_dmi_osi_linux(int enable, const struct dmi_system_id *d);
	199	#endif
1da177e4	200
1da177e4 LT	201	#ifdef CONFIG_ACPI_NUMA
1da177e4 LT	202	int acpi_get_pxm(acpi_handle handle);
1e3590e2	203	int acpi_get_node(acpi_handle *handle);
1da177e4 LT	204	#else
	205	static inline int acpi_get_pxm(acpi_handle handle)
	206	{
	207	return 0;
	208	}
1e3590e2 YG	209	static inline int acpi_get_node(acpi_handle *handle)
	210	{
	211	return 0;
	212	}
1da177e4	213	#endif
1e3590e2	214	extern int acpi_paddr_to_node(u64 start_addr, u64 size);
1da177e4 LT	215
	216	extern int pnpacpi_disabled;
	217
3484d798 DR	218	#define PXM_INVAL (-1)
	219	#define NID_INVAL (-1)
	220
443dea72 TR	221	int acpi_check_resource_conflict(struct resource *res);
443dea72 TR	222
df92e695 TR	223	int acpi_check_region(resource_size_t start, resource_size_t n,
	224	const char *name);
	225	int acpi_check_mem_region(resource_size_t start, resource_size_t n,
	226	const char *name);
	227
53de49f5 AM	228	#else /* CONFIG_ACPI */
	229
	230	static inline int acpi_boot_init(void)
	231	{
	232	return 0;
	233	}
	234
	235	static inline int acpi_boot_table_init(void)
	236	{
	237	return 0;
	238	}
	239
443dea72 TR	240	static inline int acpi_check_resource_conflict(struct resource *res)
	241	{
	242	return 0;
	243	}
	244
df92e695 TR	245	static inline int acpi_check_region(resource_size_t start, resource_size_t n,
	246	const char *name)
	247	{
	248	return 0;
	249	}
	250
	251	static inline int acpi_check_mem_region(resource_size_t start,
	252	resource_size_t n, const char *name)
	253	{
	254	return 0;
	255	}
	256
d4b7dc49	257	#endif /* !CONFIG_ACPI */
25be5e6c	258	#endif /_LINUX_ACPI_H/