[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	"ACPI_CPU"
#define ACPI_PROCESSOR_HID		"ACPI0007"
#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"

/*
 * 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 Interrupt Routing (pci_irq.c) */

int acpi_pci_irq_add_prt(acpi_handle handle, int segment, int bus);
void acpi_pci_irq_del_prt(int segment, int bus);

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

struct pci_bus;

struct pci_dev *acpi_get_pci_dev(acpi_handle);
acpi_status acpi_get_pci_id(acpi_handle handle, struct acpi_pci_id *id);
int acpi_pci_bind_root(struct acpi_device *device, struct acpi_pci_id *id,
		       struct pci_bus *bus);

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

struct pci_bus *pci_acpi_scan_root(struct acpi_device *device, int domain,
				   int bus);

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

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

int acpi_processor_set_thermal_limit(acpi_handle handle, int type);

/*--------------------------------------------------------------------------
                                  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,
					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,
					       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"
ad93a765	60	#define ACPI_PROCESSOR_OBJECT_HID "ACPI_CPU"
11bf04c4	61	#define ACPI_PROCESSOR_HID "ACPI0007"
8c8eb78f TR	62	#define ACPI_SYSTEM_HID "LNXSYSTM"
	63	#define ACPI_THERMAL_HID "LNXTHERM"
	64	#define ACPI_BUTTON_HID_POWERF "LNXPWRBN"
	65	#define ACPI_BUTTON_HID_SLEEPF "LNXSLPBN"
	66	#define ACPI_VIDEO_HID "LNXVIDEO"
	67	#define ACPI_BAY_HID "LNXIOBAY"
a340af14	68	#define ACPI_DOCK_HID "LNXDOCK"
8c8eb78f	69
46ec8598 BH	70	/*
	71	* For fixed hardware buttons, we fabricate acpi_devices with HID
	72	* ACPI_BUTTON_HID_POWERF or ACPI_BUTTON_HID_SLEEPF. Fixed hardware
	73	* signals only an event; it doesn't supply a notification value.
	74	* To allow drivers to treat notifications from fixed hardware the
	75	* same as those from real devices, we turn the events into this
	76	* notification value.
	77	*/
	78	#define ACPI_FIXED_HARDWARE_EVENT 0x100
	79
1da177e4 LT	80	/* --------------------------------------------------------------------------
	81	PCI
	82	-------------------------------------------------------------------------- */
	83
1da177e4 LT	84
	85	/* ACPI PCI Interrupt Link (pci_link.c) */
	86
4be44fcd	87	int acpi_irq_penalty_init(void);
50eca3eb BM	88	int acpi_pci_link_allocate_irq(acpi_handle handle, int index, int *triggering,
50eca3eb BM	89	int polarity, char *name);
87bec66b	90	int acpi_pci_link_free_irq(acpi_handle handle);
1da177e4 LT	91
	92	/* ACPI PCI Interrupt Routing (pci_irq.c) */
	93
4be44fcd LB	94	int acpi_pci_irq_add_prt(acpi_handle handle, int segment, int bus);
4be44fcd LB	95	void acpi_pci_irq_del_prt(int segment, int bus);
1da177e4 LT	96
	97	/* ACPI PCI Device Binding (pci_bind.c) */
	98
	99	struct pci_bus;
	100
2f7bbceb	101	struct pci_dev *acpi_get_pci_dev(acpi_handle);
4be44fcd	102	acpi_status acpi_get_pci_id(acpi_handle handle, struct acpi_pci_id *id);
4be44fcd LB	103	int acpi_pci_bind_root(struct acpi_device device, struct acpi_pci_id id,
4be44fcd LB	104	struct pci_bus *bus);
1da177e4 LT	105
	106	/* Arch-defined function to add a bus to the system */
	107
4be44fcd LB	108	struct pci_bus pci_acpi_scan_root(struct acpi_device device, int domain,
4be44fcd LB	109	int bus);
1da177e4	110
1da177e4 LT	111	/* --------------------------------------------------------------------------
	112	Processor
	113	-------------------------------------------------------------------------- */
	114
	115	#define ACPI_PROCESSOR_LIMIT_NONE 0x00
	116	#define ACPI_PROCESSOR_LIMIT_INCREMENT 0x01
	117	#define ACPI_PROCESSOR_LIMIT_DECREMENT 0x02
	118
	119	int acpi_processor_set_thermal_limit(acpi_handle handle, int type);
	120
c8f7a62c LB	121	/*--------------------------------------------------------------------------
	122	Dock Station
	123	-------------------------------------------------------------------------- */
1253f7aa SL	124	struct acpi_dock_ops {
	125	acpi_notify_handler handler;
	126	acpi_notify_handler uevent;
	127	};
	128
c8f7a62c LB	129	#if defined(CONFIG_ACPI_DOCK) \|\| defined(CONFIG_ACPI_DOCK_MODULE)
	130	extern int is_dock_device(acpi_handle handle);
	131	extern int register_dock_notifier(struct notifier_block *nb);
	132	extern void unregister_dock_notifier(struct notifier_block *nb);
	133	extern int register_hotplug_dock_device(acpi_handle handle,
1253f7aa	134	struct acpi_dock_ops *ops,
fd350943	135	void *context);
c8f7a62c LB	136	extern void unregister_hotplug_dock_device(acpi_handle handle);
c8f7a62c LB	137	#else
d94d3dff AM	138	static inline int is_dock_device(acpi_handle handle)
	139	{
	140	return 0;
	141	}
	142	static inline int register_dock_notifier(struct notifier_block *nb)
	143	{
	144	return -ENODEV;
	145	}
	146	static inline void unregister_dock_notifier(struct notifier_block *nb)
	147	{
	148	}
	149	static inline int register_hotplug_dock_device(acpi_handle handle,
1253f7aa	150	struct acpi_dock_ops *ops,
fd350943	151	void *context)
d94d3dff AM	152	{
	153	return -ENODEV;
	154	}
	155	static inline void unregister_hotplug_dock_device(acpi_handle handle)
	156	{
	157	}
c8f7a62c	158	#endif
aafbcd16	159
1da177e4	160	#endif /__ACPI_DRIVERS_H__/