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


#ifdef	CONFIG_ACPI

#ifndef _LINUX
#define _LINUX
#endif

#include <linux/list.h>

#include <acpi/acpi.h>
#include <acpi/acpi_bus.h>
#include <acpi/acpi_drivers.h>
#include <acpi/acpi_numa.h>
#include <asm/acpi.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);

/*
 * 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);
extern void acpi_bios_year(char *s);

#define	ACPI_CSTATE_LIMIT_DEFINED	/* for driver builds */
#ifdef	CONFIG_ACPI

/*
 * Set highest legal C-state
 * 0: C0 okay, but not C1
 * 1: C1 okay, but not C2
 * 2: C2 okay, but not C3 etc.
 */

extern unsigned int max_cstate;

static inline unsigned int acpi_get_cstate_limit(void)
{
	return max_cstate;
}
static inline void acpi_set_cstate_limit(unsigned int new_limit)
{
	max_cstate = new_limit;
	return;
}
#else
static inline unsigned int acpi_get_cstate_limit(void) { return 0; }
static inline void acpi_set_cstate_limit(unsigned int new_limit) { return; }
#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;

#else	/* CONFIG_ACPI */

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

static inline int acpi_boot_table_init(void)
{
	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
3f5948fa	28
25be5e6c LB	29	#ifdef CONFIG_ACPI
25be5e6c LB	30
1da177e4 LT	31	#ifndef _LINUX
	32	#define _LINUX
	33	#endif
	34
	35	#include <linux/list.h>
	36
	37	#include <acpi/acpi.h>
	38	#include <acpi/acpi_bus.h>
	39	#include <acpi/acpi_drivers.h>
762834e8	40	#include <acpi/acpi_numa.h>
1da177e4 LT	41	#include <asm/acpi.h>
	42
	43
888ba6c6	44	#ifdef CONFIG_ACPI
1da177e4 LT	45
	46	enum acpi_irq_model_id {
	47	ACPI_IRQ_MODEL_PIC = 0,
	48	ACPI_IRQ_MODEL_IOAPIC,
	49	ACPI_IRQ_MODEL_IOSAPIC,
3948ec94	50	ACPI_IRQ_MODEL_PLATFORM,
1da177e4 LT	51	ACPI_IRQ_MODEL_COUNT
	52	};
	53
	54	extern enum acpi_irq_model_id acpi_irq_model;
	55
1da177e4 LT	56	enum acpi_interrupt_id {
	57	ACPI_INTERRUPT_PMI = 1,
	58	ACPI_INTERRUPT_INIT,
	59	ACPI_INTERRUPT_CPEI,
	60	ACPI_INTERRUPT_COUNT
	61	};
	62
	63	#define ACPI_SPACE_MEM 0
	64
1da177e4 LT	65	enum acpi_address_range_id {
	66	ACPI_ADDRESS_RANGE_MEMORY = 1,
	67	ACPI_ADDRESS_RANGE_RESERVED = 2,
	68	ACPI_ADDRESS_RANGE_ACPI = 3,
	69	ACPI_ADDRESS_RANGE_NVS = 4,
	70	ACPI_ADDRESS_RANGE_COUNT
	71	};
	72
1da177e4	73
1da177e4 LT	74	/* Table Handlers */
1da177e4 LT	75
15a58ed1	76	typedef int (acpi_table_handler) (struct acpi_table_header table);
1da177e4	77
5a8765a8	78	typedef int (acpi_table_entry_handler) (struct acpi_subtable_header header, const unsigned long end);
1da177e4 LT	79
	80	char * __acpi_map_table (unsigned long phys_addr, unsigned long size);
	81	unsigned long acpi_find_rsdp (void);
	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);
ceb6c468	87	int acpi_table_parse (char *id, acpi_table_handler handler);
6eb87fed LB	88	int __init acpi_table_parse_entries(char *id, unsigned long table_size,
6eb87fed LB	89	int entry_id, acpi_table_entry_handler handler, unsigned int max_entries);
5a8765a8	90	int acpi_table_parse_madt (enum acpi_madt_type id, acpi_table_entry_handler handler, unsigned int max_entries);
ceb6c468	91	int acpi_parse_mcfg (struct acpi_table_header *header);
5f3b1a8b	92	void acpi_table_print_madt_entry (struct acpi_subtable_header *madt);
1da177e4 LT	93
1da177e4 LT	94	/* the following four functions are architecture-dependent */
762834e8 YG	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
1da177e4	102	void acpi_numa_slit_init (struct acpi_table_slit *slit);
15a58ed1 AS	103	void acpi_numa_processor_affinity_init (struct acpi_srat_cpu_affinity *pa);
15a58ed1 AS	104	void acpi_numa_memory_affinity_init (struct acpi_srat_mem_affinity *ma);
1da177e4	105	void acpi_numa_arch_fixup(void);
762834e8	106	#endif
1da177e4 LT	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
b1bb248a KK	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
1da177e4 LT	117	extern int acpi_mp_config;
1da177e4 LT	118
15a58ed1	119	extern struct acpi_mcfg_allocation *pci_mmcfg_config;
54549391	120	extern int pci_mmcfg_config_num;
1da177e4	121
c255d844	122	extern int sbf_port;
77afcf78	123	extern unsigned long acpi_realmode_flags;
1da177e4	124
888ba6c6	125	#else /* !CONFIG_ACPI */
1da177e4 LT	126
	127	#define acpi_mp_config 0
	128
888ba6c6	129	#endif /* !CONFIG_ACPI */
1da177e4	130
50eca3eb	131	int acpi_register_gsi (u32 gsi, int triggering, int polarity);
1da177e4 LT	132	int acpi_gsi_to_irq (u32 gsi, unsigned int *irq);
	133
	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	*/
1da177e4	139	void acpi_unregister_gsi (u32 gsi);
1da177e4	140
6153df7b	141	#ifdef CONFIG_ACPI
1da177e4 LT	142
	143	struct acpi_prt_entry {
	144	struct list_head node;
	145	struct acpi_pci_id id;
	146	u8 pin;
	147	struct {
	148	acpi_handle handle;
	149	u32 index;
	150	} link;
	151	u32 irq;
	152	};
	153
	154	struct acpi_prt_list {
	155	int count;
	156	struct list_head entries;
	157	};
	158
	159	struct pci_dev;
	160
	161	int acpi_pci_irq_enable (struct pci_dev *dev);
c9c3e457	162	void acpi_penalize_isa_irq(int irq, int active);
1da177e4	163
1da177e4	164	void acpi_pci_irq_disable (struct pci_dev *dev);
1da177e4 LT	165
	166	struct acpi_pci_driver {
	167	struct acpi_pci_driver *next;
	168	int (*add)(acpi_handle handle);
	169	void (*remove)(acpi_handle handle);
	170	};
	171
	172	int acpi_pci_register_driver(struct acpi_pci_driver *driver);
	173	void acpi_pci_unregister_driver(struct acpi_pci_driver *driver);
	174
6153df7b	175	#endif /* CONFIG_ACPI */
1da177e4 LT	176
	177	#ifdef CONFIG_ACPI_EC
	178
	179	extern int ec_read(u8 addr, u8 *val);
	180	extern int ec_write(u8 addr, u8 val);
d7a76e4c LP	181	extern int ec_transaction(u8 command,
d7a76e4c LP	182	const u8 *wdata, unsigned wdata_len,
00eb43a1 LP	183	u8 *rdata, unsigned rdata_len,
00eb43a1 LP	184	int force_poll);
1da177e4 LT	185
	186	#endif /CONFIG_ACPI_EC/
	187
1da177e4 LT	188	extern int acpi_blacklisted(void);
	189	extern void acpi_bios_year(char *s);
	190
1da177e4 LT	191	#define ACPI_CSTATE_LIMIT_DEFINED /* for driver builds */
	192	#ifdef CONFIG_ACPI
	193
	194	/*
	195	* Set highest legal C-state
	196	* 0: C0 okay, but not C1
	197	* 1: C1 okay, but not C2
	198	* 2: C2 okay, but not C3 etc.
	199	*/
	200
	201	extern unsigned int max_cstate;
	202
	203	static inline unsigned int acpi_get_cstate_limit(void)
	204	{
	205	return max_cstate;
	206	}
	207	static inline void acpi_set_cstate_limit(unsigned int new_limit)
	208	{
	209	max_cstate = new_limit;
	210	return;
	211	}
	212	#else
	213	static inline unsigned int acpi_get_cstate_limit(void) { return 0; }
	214	static inline void acpi_set_cstate_limit(unsigned int new_limit) { return; }
	215	#endif
	216
	217	#ifdef CONFIG_ACPI_NUMA
	218	int acpi_get_pxm(acpi_handle handle);
1e3590e2	219	int acpi_get_node(acpi_handle *handle);
1da177e4 LT	220	#else
	221	static inline int acpi_get_pxm(acpi_handle handle)
	222	{
	223	return 0;
	224	}
1e3590e2 YG	225	static inline int acpi_get_node(acpi_handle *handle)
	226	{
	227	return 0;
	228	}
1da177e4	229	#endif
1e3590e2	230	extern int acpi_paddr_to_node(u64 start_addr, u64 size);
1da177e4 LT	231
	232	extern int pnpacpi_disabled;
	233
53de49f5 AM	234	#else /* CONFIG_ACPI */
	235
	236	static inline int acpi_boot_init(void)
	237	{
	238	return 0;
	239	}
	240
	241	static inline int acpi_boot_table_init(void)
	242	{
	243	return 0;
	244	}
	245
25be5e6c LB	246	#endif /* CONFIG_ACPI */
25be5e6c LB	247	#endif /_LINUX_ACPI_H/