[linux-2.6-block.git] / include / acpi / acpi_drivers.h

/*
 *  acpi_drivers.h  ($Revision: 31 $)
 *
 *  Copyright (C) 2001, 2002 Andy Grover <andrew.grover@intel.com>
 *  Copyright (C) 2001, 2002 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 __ACPI_DRIVERS_H__
#define __ACPI_DRIVERS_H__

#define ACPI_MAX_STRING			80

/*
 * Please update drivers/acpi/debug.c and Documentation/acpi/debug.txt
 * if you add to this list.
 */
#define ACPI_BUS_COMPONENT		0x00010000
#define ACPI_AC_COMPONENT		0x00020000
#define ACPI_BATTERY_COMPONENT		0x00040000
#define ACPI_BUTTON_COMPONENT		0x00080000
#define ACPI_SBS_COMPONENT		0x00100000
#define ACPI_FAN_COMPONENT		0x00200000
#define ACPI_PCI_COMPONENT		0x00400000
#define ACPI_POWER_COMPONENT		0x00800000
#define ACPI_CONTAINER_COMPONENT	0x01000000
#define ACPI_SYSTEM_COMPONENT		0x02000000
#define ACPI_THERMAL_COMPONENT		0x04000000
#define ACPI_MEMORY_DEVICE_COMPONENT	0x08000000
#define ACPI_VIDEO_COMPONENT		0x10000000
#define ACPI_PROCESSOR_COMPONENT	0x20000000

/*
 * _HID definitions
 * HIDs must conform to ACPI spec(6.1.4)
 * Linux specific HIDs do not apply to this and begin with LNX:
 */

#define ACPI_POWER_HID			"LNXPOWER"
#define ACPI_PROCESSOR_OBJECT_HID	"LNXCPU"
#define ACPI_SYSTEM_HID			"LNXSYSTM"
#define ACPI_THERMAL_HID		"LNXTHERM"
#define ACPI_BUTTON_HID_POWERF		"LNXPWRBN"
#define ACPI_BUTTON_HID_SLEEPF		"LNXSLPBN"
#define ACPI_VIDEO_HID			"LNXVIDEO"
#define ACPI_BAY_HID			"LNXIOBAY"
#define ACPI_DOCK_HID			"LNXDOCK"
/* Quirk for broken IBM BIOSes */
#define ACPI_SMBUS_IBM_HID		"SMBUSIBM"

/*
 * For fixed hardware buttons, we fabricate acpi_devices with HID
 * ACPI_BUTTON_HID_POWERF or ACPI_BUTTON_HID_SLEEPF.  Fixed hardware
 * signals only an event; it doesn't supply a notification value.
 * To allow drivers to treat notifications from fixed hardware the
 * same as those from real devices, we turn the events into this
 * notification value.
 */
#define ACPI_FIXED_HARDWARE_EVENT	0x100

/* --------------------------------------------------------------------------
                                       PCI
   -------------------------------------------------------------------------- */


/* ACPI PCI Interrupt Link (pci_link.c) */

int acpi_irq_penalty_init(void);
int acpi_pci_link_allocate_irq(acpi_handle handle, int index, int *triggering,
			       int *polarity, char **name);
int acpi_pci_link_free_irq(acpi_handle handle);

/* ACPI PCI Device Binding (pci_bind.c) */

struct pci_bus;

struct pci_dev *acpi_get_pci_dev(acpi_handle);

/* Arch-defined function to add a bus to the system */

struct pci_bus *pci_acpi_scan_root(struct acpi_pci_root *root);
void pci_acpi_crs_quirks(void);

/* --------------------------------------------------------------------------
                                    Processor
   -------------------------------------------------------------------------- */

#define ACPI_PROCESSOR_LIMIT_NONE	0x00
#define ACPI_PROCESSOR_LIMIT_INCREMENT	0x01
#define ACPI_PROCESSOR_LIMIT_DECREMENT	0x02

/*--------------------------------------------------------------------------
                                  Dock Station
  -------------------------------------------------------------------------- */
struct acpi_dock_ops {
	acpi_notify_handler fixup;
	acpi_notify_handler handler;
	acpi_notify_handler uevent;
};

#ifdef CONFIG_ACPI_DOCK
extern int is_dock_device(acpi_handle handle);
extern int register_hotplug_dock_device(acpi_handle handle,
					const struct acpi_dock_ops *ops,
					void *context,
					void (*init)(void *),
					void (*release)(void *));
extern void unregister_hotplug_dock_device(acpi_handle handle);
#else
static inline int is_dock_device(acpi_handle handle)
{
	return 0;
}
static inline int register_hotplug_dock_device(acpi_handle handle,
					       const struct acpi_dock_ops *ops,
					       void *context,
					       void (*init)(void *),
					       void (*release)(void *))
{
	return -ENODEV;
}
static inline void unregister_hotplug_dock_device(acpi_handle handle)
{
}
#endif /* CONFIG_ACPI_DOCK */

#endif /*__ACPI_DRIVERS_H__*/
Commit	Line	Data
1da177e4 LT	1	/*
	2	* acpi_drivers.h ($Revision: 31 $)
	3	*
	4	* Copyright (C) 2001, 2002 Andy Grover <andrew.grover@intel.com>
	5	* Copyright (C) 2001, 2002 Paul Diefenbaugh <paul.s.diefenbaugh@intel.com>
	6	*
	7	* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
	8	*
	9	* This program is free software; you can redistribute it and/or modify
	10	* it under the terms of the GNU General Public License as published by
	11	* the Free Software Foundation; either version 2 of the License, or (at
	12	* your option) any later version.
	13	*
	14	* This program is distributed in the hope that it will be useful, but
	15	* WITHOUT ANY WARRANTY; without even the implied warranty of
	16	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
	17	* General Public License for more details.
	18	*
	19	* You should have received a copy of the GNU General Public License along
	20	* with this program; if not, write to the Free Software Foundation, Inc.,
	21	* 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
	22	*
	23	* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
	24	*/
	25
	26	#ifndef __ACPI_DRIVERS_H__
	27	#define __ACPI_DRIVERS_H__
	28
1da177e4 LT	29	#define ACPI_MAX_STRING 80
1da177e4 LT	30
bdd72799 BH	31	/*
	32	* Please update drivers/acpi/debug.c and Documentation/acpi/debug.txt
	33	* if you add to this list.
	34	*/
1da177e4	35	#define ACPI_BUS_COMPONENT 0x00010000
89595b8f BH	36	#define ACPI_AC_COMPONENT 0x00020000
	37	#define ACPI_BATTERY_COMPONENT 0x00040000
	38	#define ACPI_BUTTON_COMPONENT 0x00080000
44342f9e	39	#define ACPI_SBS_COMPONENT 0x00100000
89595b8f BH	40	#define ACPI_FAN_COMPONENT 0x00200000
	41	#define ACPI_PCI_COMPONENT 0x00400000
	42	#define ACPI_POWER_COMPONENT 0x00800000
	43	#define ACPI_CONTAINER_COMPONENT 0x01000000
1da177e4	44	#define ACPI_SYSTEM_COMPONENT 0x02000000
89595b8f BH	45	#define ACPI_THERMAL_COMPONENT 0x04000000
89595b8f BH	46	#define ACPI_MEMORY_DEVICE_COMPONENT 0x08000000
44342f9e BH	47	#define ACPI_VIDEO_COMPONENT 0x10000000
44342f9e BH	48	#define ACPI_PROCESSOR_COMPONENT 0x20000000
1da177e4	49
8c8eb78f TR	50	/*
	51	* _HID definitions
	52	* HIDs must conform to ACPI spec(6.1.4)
	53	* Linux specific HIDs do not apply to this and begin with LNX:
	54	*/
1da177e4	55
8c8eb78f	56	#define ACPI_POWER_HID "LNXPOWER"
b9417f84	57	#define ACPI_PROCESSOR_OBJECT_HID "LNXCPU"
8c8eb78f TR	58	#define ACPI_SYSTEM_HID "LNXSYSTM"
	59	#define ACPI_THERMAL_HID "LNXTHERM"
	60	#define ACPI_BUTTON_HID_POWERF "LNXPWRBN"
	61	#define ACPI_BUTTON_HID_SLEEPF "LNXSLPBN"
	62	#define ACPI_VIDEO_HID "LNXVIDEO"
	63	#define ACPI_BAY_HID "LNXIOBAY"
a340af14	64	#define ACPI_DOCK_HID "LNXDOCK"
222e82ac DW	65	/* Quirk for broken IBM BIOSes */
222e82ac DW	66	#define ACPI_SMBUS_IBM_HID "SMBUSIBM"
8c8eb78f	67
46ec8598 BH	68	/*
	69	* For fixed hardware buttons, we fabricate acpi_devices with HID
	70	* ACPI_BUTTON_HID_POWERF or ACPI_BUTTON_HID_SLEEPF. Fixed hardware
	71	* signals only an event; it doesn't supply a notification value.
	72	* To allow drivers to treat notifications from fixed hardware the
	73	* same as those from real devices, we turn the events into this
	74	* notification value.
	75	*/
	76	#define ACPI_FIXED_HARDWARE_EVENT 0x100
	77
1da177e4 LT	78	/* --------------------------------------------------------------------------
	79	PCI
	80	-------------------------------------------------------------------------- */
	81
1da177e4 LT	82
	83	/* ACPI PCI Interrupt Link (pci_link.c) */
	84
4be44fcd	85	int acpi_irq_penalty_init(void);
50eca3eb BM	86	int acpi_pci_link_allocate_irq(acpi_handle handle, int index, int *triggering,
50eca3eb BM	87	int polarity, char *name);
87bec66b	88	int acpi_pci_link_free_irq(acpi_handle handle);
1da177e4	89
1da177e4 LT	90	/* ACPI PCI Device Binding (pci_bind.c) */
	91
	92	struct pci_bus;
	93
2f7bbceb	94	struct pci_dev *acpi_get_pci_dev(acpi_handle);
1da177e4 LT	95
	96	/* Arch-defined function to add a bus to the system */
	97
57283776	98	struct pci_bus pci_acpi_scan_root(struct acpi_pci_root root);
7bc5e3f2	99	void pci_acpi_crs_quirks(void);
1da177e4	100
1da177e4 LT	101	/* --------------------------------------------------------------------------
	102	Processor
	103	-------------------------------------------------------------------------- */
	104
	105	#define ACPI_PROCESSOR_LIMIT_NONE 0x00
	106	#define ACPI_PROCESSOR_LIMIT_INCREMENT 0x01
	107	#define ACPI_PROCESSOR_LIMIT_DECREMENT 0x02
	108
c8f7a62c LB	109	/*--------------------------------------------------------------------------
	110	Dock Station
	111	-------------------------------------------------------------------------- */
1253f7aa	112	struct acpi_dock_ops {
f09ce741	113	acpi_notify_handler fixup;
1253f7aa SL	114	acpi_notify_handler handler;
	115	acpi_notify_handler uevent;
	116	};
	117
e6c215f1	118	#ifdef CONFIG_ACPI_DOCK
c8f7a62c	119	extern int is_dock_device(acpi_handle handle);
c8f7a62c	120	extern int register_hotplug_dock_device(acpi_handle handle,
9c8b04be	121	const struct acpi_dock_ops *ops,
21a31013 RW	122	void *context,
	123	void (init)(void ),
	124	void (release)(void ));
c8f7a62c LB	125	extern void unregister_hotplug_dock_device(acpi_handle handle);
c8f7a62c LB	126	#else
d94d3dff AM	127	static inline int is_dock_device(acpi_handle handle)
	128	{
	129	return 0;
	130	}
d94d3dff	131	static inline int register_hotplug_dock_device(acpi_handle handle,
c1056b42	132	const struct acpi_dock_ops *ops,
21a31013 RW	133	void *context,
	134	void (init)(void ),
	135	void (release)(void ))
d94d3dff AM	136	{
	137	return -ENODEV;
	138	}
	139	static inline void unregister_hotplug_dock_device(acpi_handle handle)
	140	{
	141	}
e6c215f1	142	#endif /* CONFIG_ACPI_DOCK */
aafbcd16	143
1da177e4	144	#endif /__ACPI_DRIVERS_H__/