[mirror_ubuntu-bionic-kernel.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.
 *
 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 */

#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"
#define ACPI_ECDT_HID			"LNXEC"
/* 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);

#ifdef CONFIG_X86
void pci_acpi_crs_quirks(void);
#else
static inline void pci_acpi_crs_quirks(void) { }
#endif

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

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

/*--------------------------------------------------------------------------
                                  Dock Station
  -------------------------------------------------------------------------- */

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