[deliverable/linux.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__

#include <linux/acpi.h>
#include <acpi/acpi_bus.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);
int acpi_pci_bind_root(struct acpi_device *device);

/* 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 handler;
	acpi_notify_handler uevent;
};

#if defined(CONFIG_ACPI_DOCK) || defined(CONFIG_ACPI_DOCK_MODULE)
extern int is_dock_device(acpi_handle handle);
extern int register_dock_notifier(struct notifier_block *nb);
extern void unregister_dock_notifier(struct notifier_block *nb);
extern int register_hotplug_dock_device(acpi_handle handle,
					const struct acpi_dock_ops *ops,
					void *context);
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_dock_notifier(struct notifier_block *nb)
{
	return -ENODEV;
}
static inline void unregister_dock_notifier(struct notifier_block *nb)
{
}
static inline int register_hotplug_dock_device(acpi_handle handle,
					       const struct acpi_dock_ops *ops,
					       void *context)
{
	return -ENODEV;
}
static inline void unregister_hotplug_dock_device(acpi_handle handle)
{
}
#endif

#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
	29	#include <linux/acpi.h>
	30	#include <acpi/acpi_bus.h>
	31
1da177e4 LT	32	#define ACPI_MAX_STRING 80
1da177e4 LT	33
bdd72799 BH	34	/*
	35	* Please update drivers/acpi/debug.c and Documentation/acpi/debug.txt
	36	* if you add to this list.
	37	*/
1da177e4	38	#define ACPI_BUS_COMPONENT 0x00010000
89595b8f BH	39	#define ACPI_AC_COMPONENT 0x00020000
	40	#define ACPI_BATTERY_COMPONENT 0x00040000
	41	#define ACPI_BUTTON_COMPONENT 0x00080000
44342f9e	42	#define ACPI_SBS_COMPONENT 0x00100000
89595b8f BH	43	#define ACPI_FAN_COMPONENT 0x00200000
	44	#define ACPI_PCI_COMPONENT 0x00400000
	45	#define ACPI_POWER_COMPONENT 0x00800000
	46	#define ACPI_CONTAINER_COMPONENT 0x01000000
1da177e4	47	#define ACPI_SYSTEM_COMPONENT 0x02000000
89595b8f BH	48	#define ACPI_THERMAL_COMPONENT 0x04000000
89595b8f BH	49	#define ACPI_MEMORY_DEVICE_COMPONENT 0x08000000
44342f9e BH	50	#define ACPI_VIDEO_COMPONENT 0x10000000
44342f9e BH	51	#define ACPI_PROCESSOR_COMPONENT 0x20000000
1da177e4	52
8c8eb78f TR	53	/*
	54	* _HID definitions
	55	* HIDs must conform to ACPI spec(6.1.4)
	56	* Linux specific HIDs do not apply to this and begin with LNX:
	57	*/
1da177e4	58
8c8eb78f	59	#define ACPI_POWER_HID "LNXPOWER"
b9417f84	60	#define ACPI_PROCESSOR_OBJECT_HID "LNXCPU"
8c8eb78f TR	61	#define ACPI_SYSTEM_HID "LNXSYSTM"
	62	#define ACPI_THERMAL_HID "LNXTHERM"
	63	#define ACPI_BUTTON_HID_POWERF "LNXPWRBN"
	64	#define ACPI_BUTTON_HID_SLEEPF "LNXSLPBN"
	65	#define ACPI_VIDEO_HID "LNXVIDEO"
	66	#define ACPI_BAY_HID "LNXIOBAY"
a340af14	67	#define ACPI_DOCK_HID "LNXDOCK"
222e82ac DW	68	/* Quirk for broken IBM BIOSes */
222e82ac DW	69	#define ACPI_SMBUS_IBM_HID "SMBUSIBM"
8c8eb78f	70
46ec8598 BH	71	/*
	72	* For fixed hardware buttons, we fabricate acpi_devices with HID
	73	* ACPI_BUTTON_HID_POWERF or ACPI_BUTTON_HID_SLEEPF. Fixed hardware
	74	* signals only an event; it doesn't supply a notification value.
	75	* To allow drivers to treat notifications from fixed hardware the
	76	* same as those from real devices, we turn the events into this
	77	* notification value.
	78	*/
	79	#define ACPI_FIXED_HARDWARE_EVENT 0x100
	80
1da177e4 LT	81	/* --------------------------------------------------------------------------
	82	PCI
	83	-------------------------------------------------------------------------- */
	84
1da177e4 LT	85
	86	/* ACPI PCI Interrupt Link (pci_link.c) */
	87
4be44fcd	88	int acpi_irq_penalty_init(void);
50eca3eb BM	89	int acpi_pci_link_allocate_irq(acpi_handle handle, int index, int *triggering,
50eca3eb BM	90	int polarity, char *name);
87bec66b	91	int acpi_pci_link_free_irq(acpi_handle handle);
1da177e4	92
1da177e4 LT	93	/* ACPI PCI Device Binding (pci_bind.c) */
	94
	95	struct pci_bus;
	96
2f7bbceb	97	struct pci_dev *acpi_get_pci_dev(acpi_handle);
499650de	98	int acpi_pci_bind_root(struct acpi_device *device);
1da177e4 LT	99
	100	/* Arch-defined function to add a bus to the system */
	101
57283776	102	struct pci_bus pci_acpi_scan_root(struct acpi_pci_root root);
7bc5e3f2	103	void pci_acpi_crs_quirks(void);
1da177e4	104
1da177e4 LT	105	/* --------------------------------------------------------------------------
	106	Processor
	107	-------------------------------------------------------------------------- */
	108
	109	#define ACPI_PROCESSOR_LIMIT_NONE 0x00
	110	#define ACPI_PROCESSOR_LIMIT_INCREMENT 0x01
	111	#define ACPI_PROCESSOR_LIMIT_DECREMENT 0x02
	112
c8f7a62c LB	113	/*--------------------------------------------------------------------------
	114	Dock Station
	115	-------------------------------------------------------------------------- */
1253f7aa SL	116	struct acpi_dock_ops {
	117	acpi_notify_handler handler;
	118	acpi_notify_handler uevent;
	119	};
	120
c8f7a62c LB	121	#if defined(CONFIG_ACPI_DOCK) \|\| defined(CONFIG_ACPI_DOCK_MODULE)
	122	extern int is_dock_device(acpi_handle handle);
	123	extern int register_dock_notifier(struct notifier_block *nb);
	124	extern void unregister_dock_notifier(struct notifier_block *nb);
	125	extern int register_hotplug_dock_device(acpi_handle handle,
9c8b04be	126	const struct acpi_dock_ops *ops,
fd350943	127	void *context);
c8f7a62c LB	128	extern void unregister_hotplug_dock_device(acpi_handle handle);
c8f7a62c LB	129	#else
d94d3dff AM	130	static inline int is_dock_device(acpi_handle handle)
	131	{
	132	return 0;
	133	}
	134	static inline int register_dock_notifier(struct notifier_block *nb)
	135	{
	136	return -ENODEV;
	137	}
	138	static inline void unregister_dock_notifier(struct notifier_block *nb)
	139	{
	140	}
	141	static inline int register_hotplug_dock_device(acpi_handle handle,
c1056b42	142	const struct acpi_dock_ops *ops,
fd350943	143	void *context)
d94d3dff AM	144	{
	145	return -ENODEV;
	146	}
	147	static inline void unregister_hotplug_dock_device(acpi_handle handle)
	148	{
	149	}
c8f7a62c	150	#endif
aafbcd16	151
1da177e4	152	#endif /__ACPI_DRIVERS_H__/