[linux-block.git] / include / acpi / acpi_bus.h

/*
 *  acpi_bus.h - ACPI Bus Driver ($Revision: 22 $)
 *
 *  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_BUS_H__
#define __ACPI_BUS_H__

#include <linux/device.h>

#include <acpi/acpi.h>

/* TBD: Make dynamic */
#define ACPI_MAX_HANDLES	10
struct acpi_handle_list {
	u32 count;
	acpi_handle handles[ACPI_MAX_HANDLES];
};

/* acpi_utils.h */
acpi_status
acpi_extract_package(union acpi_object *package,
		     struct acpi_buffer *format, struct acpi_buffer *buffer);
acpi_status
acpi_evaluate_integer(acpi_handle handle,
		      acpi_string pathname,
		      struct acpi_object_list *arguments, unsigned long long *data);
acpi_status
acpi_evaluate_reference(acpi_handle handle,
			acpi_string pathname,
			struct acpi_object_list *arguments,
			struct acpi_handle_list *list);
acpi_status
acpi_evaluate_hotplug_ost(acpi_handle handle, u32 source_event,
			u32 status_code, struct acpi_buffer *status_buf);

acpi_status
acpi_get_physical_device_location(acpi_handle handle, struct acpi_pld_info **pld);
#ifdef CONFIG_ACPI

#include <linux/proc_fs.h>

#define ACPI_BUS_FILE_ROOT	"acpi"
extern struct proc_dir_entry *acpi_root_dir;

enum acpi_bus_add_type {
	ACPI_BUS_ADD_BASIC = 0,
	ACPI_BUS_ADD_MATCH,
	ACPI_BUS_ADD_START,
	ACPI_BUS_ADD_TYPE_COUNT
};

enum acpi_bus_removal_type {
	ACPI_BUS_REMOVAL_NORMAL = 0,
	ACPI_BUS_REMOVAL_EJECT,
	ACPI_BUS_REMOVAL_SUPRISE,
	ACPI_BUS_REMOVAL_TYPE_COUNT
};

enum acpi_bus_device_type {
	ACPI_BUS_TYPE_DEVICE = 0,
	ACPI_BUS_TYPE_POWER,
	ACPI_BUS_TYPE_PROCESSOR,
	ACPI_BUS_TYPE_THERMAL,
	ACPI_BUS_TYPE_POWER_BUTTON,
	ACPI_BUS_TYPE_SLEEP_BUTTON,
	ACPI_BUS_DEVICE_TYPE_COUNT
};

struct acpi_driver;
struct acpi_device;

/*
 * ACPI Driver
 * -----------
 */

typedef int (*acpi_op_add) (struct acpi_device * device);
typedef int (*acpi_op_remove) (struct acpi_device * device, int type);
typedef int (*acpi_op_start) (struct acpi_device * device);
typedef int (*acpi_op_bind) (struct acpi_device * device);
typedef int (*acpi_op_unbind) (struct acpi_device * device);
typedef void (*acpi_op_notify) (struct acpi_device * device, u32 event);

struct acpi_device_ops {
	acpi_op_add add;
	acpi_op_remove remove;
	acpi_op_start start;
	acpi_op_bind bind;
	acpi_op_unbind unbind;
	acpi_op_notify notify;
};

#define ACPI_DRIVER_ALL_NOTIFY_EVENTS	0x1	/* system AND device events */

struct acpi_driver {
	char name[80];
	char class[80];
	const struct acpi_device_id *ids; /* Supported Hardware IDs */
	unsigned int flags;
	struct acpi_device_ops ops;
	struct device_driver drv;
	struct module *owner;
};

/*
 * ACPI Device
 * -----------
 */

/* Status (_STA) */

struct acpi_device_status {
	u32 present:1;
	u32 enabled:1;
	u32 show_in_ui:1;
	u32 functional:1;
	u32 battery_present:1;
	u32 reserved:27;
};

/* Flags */

struct acpi_device_flags {
	u32 dynamic_status:1;
	u32 bus_address:1;
	u32 removable:1;
	u32 ejectable:1;
	u32 suprise_removal_ok:1;
	u32 power_manageable:1;
	u32 performance_manageable:1;
	u32 eject_pending:1;
	u32 reserved:24;
};

/* File System */

struct acpi_device_dir {
	struct proc_dir_entry *entry;
};

#define acpi_device_dir(d)	((d)->dir.entry)

/* Plug and Play */

typedef char acpi_bus_id[8];
typedef unsigned long acpi_bus_address;
typedef char acpi_device_name[40];
typedef char acpi_device_class[20];

struct acpi_hardware_id {
	struct list_head list;
	char *id;
};

struct acpi_device_pnp {
	acpi_bus_id bus_id;	/* Object name */
	acpi_bus_address bus_address;	/* _ADR */
	char *unique_id;	/* _UID */
	struct list_head ids;		/* _HID and _CIDs */
	acpi_device_name device_name;	/* Driver-determined */
	acpi_device_class device_class;	/*        "          */
	union acpi_object *str_obj;	/* unicode string for _STR method */
	unsigned long sun;		/* _SUN */
};

#define acpi_device_bid(d)	((d)->pnp.bus_id)
#define acpi_device_adr(d)	((d)->pnp.bus_address)
const char *acpi_device_hid(struct acpi_device *device);
#define acpi_device_name(d)	((d)->pnp.device_name)
#define acpi_device_class(d)	((d)->pnp.device_class)

/* Power Management */

struct acpi_device_power_flags {
	u32 explicit_get:1;	/* _PSC present? */
	u32 power_resources:1;	/* Power resources */
	u32 inrush_current:1;	/* Serialize Dx->D0 */
	u32 power_removed:1;	/* Optimize Dx->D0 */
	u32 reserved:28;
};

struct acpi_device_power_state {
	struct {
		u8 valid:1;
		u8 os_accessible:1;
		u8 explicit_set:1;	/* _PSx present? */
		u8 reserved:6;
	} flags;
	int power;		/* % Power (compared to D0) */
	int latency;		/* Dx->D0 time (microseconds) */
	struct acpi_handle_list resources;	/* Power resources referenced */
};

struct acpi_device_power {
	int state;		/* Current state */
	struct acpi_device_power_flags flags;
	struct acpi_device_power_state states[ACPI_D_STATE_COUNT];	/* Power states (D0-D3Cold) */
};

/* Performance Management */

struct acpi_device_perf_flags {
	u8 reserved:8;
};

struct acpi_device_perf_state {
	struct {
		u8 valid:1;
		u8 reserved:7;
	} flags;
	u8 power;		/* % Power (compared to P0) */
	u8 performance;		/* % Performance (    "   ) */
	int latency;		/* Px->P0 time (microseconds) */
};

struct acpi_device_perf {
	int state;
	struct acpi_device_perf_flags flags;
	int state_count;
	struct acpi_device_perf_state *states;
};

/* Wakeup Management */
struct acpi_device_wakeup_flags {
	u8 valid:1;		/* Can successfully enable wakeup? */
	u8 run_wake:1;		/* Run-Wake GPE devices */
	u8 notifier_present:1;  /* Wake-up notify handler has been installed */
};

struct acpi_device_wakeup {
	acpi_handle gpe_device;
	u64 gpe_number;
	u64 sleep_state;
	struct acpi_handle_list resources;
	struct acpi_device_wakeup_flags flags;
	int prepare_count;
};

struct acpi_device_physical_node {
	u8 node_id;
	struct list_head node;
	struct device *dev;
};

/* set maximum of physical nodes to 32 for expansibility */
#define ACPI_MAX_PHYSICAL_NODE	32

/* Device */
struct acpi_device {
	int device_type;
	acpi_handle handle;		/* no handle for fixed hardware */
	struct acpi_device *parent;
	struct list_head children;
	struct list_head node;
	struct list_head wakeup_list;
	struct acpi_device_status status;
	struct acpi_device_flags flags;
	struct acpi_device_pnp pnp;
	struct acpi_device_power power;
	struct acpi_device_wakeup wakeup;
	struct acpi_device_perf performance;
	struct acpi_device_dir dir;
	struct acpi_device_ops ops;
	struct acpi_driver *driver;
	void *driver_data;
	struct device dev;
	enum acpi_bus_add_type add_type;	/* how to handle adding */
	enum acpi_bus_removal_type removal_type;	/* indicate for different removal type */
	u8 physical_node_count;
	struct list_head physical_node_list;
	struct mutex physical_node_lock;
	DECLARE_BITMAP(physical_node_id_bitmap, ACPI_MAX_PHYSICAL_NODE);
};

static inline void *acpi_driver_data(struct acpi_device *d)
{
	return d->driver_data;
}

#define to_acpi_device(d)	container_of(d, struct acpi_device, dev)
#define to_acpi_driver(d)	container_of(d, struct acpi_driver, drv)

/* acpi_device.dev.bus == &acpi_bus_type */
extern struct bus_type acpi_bus_type;

/*
 * Events
 * ------
 */

struct acpi_bus_event {
	struct list_head node;
	acpi_device_class device_class;
	acpi_bus_id bus_id;
	u32 type;
	u32 data;
};

struct acpi_eject_event {
	acpi_handle	handle;
	u32		event;
};

extern struct kobject *acpi_kobj;
extern int acpi_bus_generate_netlink_event(const char*, const char*, u8, int);
void acpi_bus_private_data_handler(acpi_handle, void *);
int acpi_bus_get_private_data(acpi_handle, void **);
extern int acpi_notifier_call_chain(struct acpi_device *, u32, u32);
extern int register_acpi_notifier(struct notifier_block *);
extern int unregister_acpi_notifier(struct notifier_block *);

extern int register_acpi_bus_notifier(struct notifier_block *nb);
extern void unregister_acpi_bus_notifier(struct notifier_block *nb);
/*
 * External Functions
 */

int acpi_bus_get_device(acpi_handle handle, struct acpi_device **device);
void acpi_bus_data_handler(acpi_handle handle, void *context);
acpi_status acpi_bus_get_status_handle(acpi_handle handle,
				       unsigned long long *sta);
int acpi_bus_get_status(struct acpi_device *device);
int acpi_bus_set_power(acpi_handle handle, int state);
int acpi_device_set_power(struct acpi_device *device, int state);
int acpi_bus_update_power(acpi_handle handle, int *state_p);
bool acpi_bus_power_manageable(acpi_handle handle);
bool acpi_bus_can_wakeup(acpi_handle handle);
int acpi_power_resource_register_device(struct device *dev, acpi_handle handle);
void acpi_power_resource_unregister_device(struct device *dev, acpi_handle handle);
#ifdef CONFIG_ACPI_PROC_EVENT
int acpi_bus_generate_proc_event(struct acpi_device *device, u8 type, int data);
int acpi_bus_generate_proc_event4(const char *class, const char *bid, u8 type, int data);
int acpi_bus_receive_event(struct acpi_bus_event *event);
#else
static inline int acpi_bus_generate_proc_event(struct acpi_device *device, u8 type, int data)
	{ return 0; }
#endif
int acpi_bus_register_driver(struct acpi_driver *driver);
void acpi_bus_unregister_driver(struct acpi_driver *driver);
int acpi_bus_add(acpi_handle handle, struct acpi_device **ret);
void acpi_bus_hot_remove_device(void *context);
int acpi_bus_trim(struct acpi_device *start, int rmdevice);
acpi_status acpi_bus_get_ejd(acpi_handle handle, acpi_handle * ejd);
int acpi_match_device_ids(struct acpi_device *device,
			  const struct acpi_device_id *ids);
int acpi_create_dir(struct acpi_device *);
void acpi_remove_dir(struct acpi_device *);


/**
 * module_acpi_driver(acpi_driver) - Helper macro for registering an ACPI driver
 * @__acpi_driver: acpi_driver struct
 *
 * Helper macro for ACPI drivers which do not do anything special in module
 * init/exit. This eliminates a lot of boilerplate. Each module may only
 * use this macro once, and calling it replaces module_init() and module_exit()
 */
#define module_acpi_driver(__acpi_driver) \
	module_driver(__acpi_driver, acpi_bus_register_driver, \
		      acpi_bus_unregister_driver)

/*
 * Bind physical devices with ACPI devices
 */
struct acpi_bus_type {
	struct list_head list;
	struct bus_type *bus;
	/* For general devices under the bus */
	int (*find_device) (struct device *, acpi_handle *);
	/* For bridges, such as PCI root bridge, IDE controller */
	int (*find_bridge) (struct device *, acpi_handle *);
};
int register_acpi_bus_type(struct acpi_bus_type *);
int unregister_acpi_bus_type(struct acpi_bus_type *);

struct acpi_pci_root {
	struct list_head node;
	struct acpi_device * device;
	struct acpi_pci_id id;
	struct pci_bus *bus;
	u16 segment;
	struct resource secondary;	/* downstream bus range */

	u32 osc_support_set;	/* _OSC state of support bits */
	u32 osc_control_set;	/* _OSC state of control bits */
	phys_addr_t mcfg_addr;
};

/* helper */
acpi_handle acpi_get_child(acpi_handle, u64);
int acpi_is_root_bridge(acpi_handle);
acpi_handle acpi_get_pci_rootbridge_handle(unsigned int, unsigned int);
struct acpi_pci_root *acpi_pci_find_root(acpi_handle handle);
#define DEVICE_ACPI_HANDLE(dev) ((acpi_handle)ACPI_HANDLE(dev))

int acpi_enable_wakeup_device_power(struct acpi_device *dev, int state);
int acpi_disable_wakeup_device_power(struct acpi_device *dev);

#ifdef CONFIG_PM
acpi_status acpi_add_pm_notifier(struct acpi_device *adev,
				 acpi_notify_handler handler, void *context);
acpi_status acpi_remove_pm_notifier(struct acpi_device *adev,
				    acpi_notify_handler handler);
int acpi_device_power_state(struct device *dev, struct acpi_device *adev,
			    u32 target_state, int d_max_in, int *d_min_p);
int acpi_pm_device_sleep_state(struct device *, int *, int);
#else
static inline acpi_status acpi_add_pm_notifier(struct acpi_device *adev,
					       acpi_notify_handler handler,
					       void *context)
{
	return AE_SUPPORT;
}
static inline acpi_status acpi_remove_pm_notifier(struct acpi_device *adev,
						  acpi_notify_handler handler)
{
	return AE_SUPPORT;
}
static inline int __acpi_device_power_state(int m, int *p)
{
	if (p)
		*p = ACPI_STATE_D0;
	return (m >= ACPI_STATE_D0 && m <= ACPI_STATE_D3) ? m : ACPI_STATE_D0;
}
static inline int acpi_device_power_state(struct device *dev,
					  struct acpi_device *adev,
					  u32 target_state, int d_max_in,
					  int *d_min_p)
{
	return __acpi_device_power_state(d_max_in, d_min_p);
}
static inline int acpi_pm_device_sleep_state(struct device *d, int *p, int m)
{
	return __acpi_device_power_state(m, p);
}
#endif

#ifdef CONFIG_PM_RUNTIME
int __acpi_device_run_wake(struct acpi_device *, bool);
int acpi_pm_device_run_wake(struct device *, bool);
#else
static inline int __acpi_device_run_wake(struct acpi_device *adev, bool en)
{
	return -ENODEV;
}
static inline int acpi_pm_device_run_wake(struct device *dev, bool enable)
{
	return -ENODEV;
}
#endif

#ifdef CONFIG_PM_SLEEP
int __acpi_device_sleep_wake(struct acpi_device *, u32, bool);
int acpi_pm_device_sleep_wake(struct device *, bool);
#else
static inline int __acpi_device_sleep_wake(struct acpi_device *adev,
					   u32 target_state, bool enable)
{
	return -ENODEV;
}
static inline int acpi_pm_device_sleep_wake(struct device *dev, bool enable)
{
	return -ENODEV;
}
#endif

#ifdef CONFIG_ACPI_SLEEP
u32 acpi_target_system_state(void);
#else
static inline u32 acpi_target_system_state(void) { return ACPI_STATE_S0; }
#endif

static inline bool acpi_device_power_manageable(struct acpi_device *adev)
{
	return adev->flags.power_manageable;
}

static inline bool acpi_device_can_wakeup(struct acpi_device *adev)
{
	return adev->wakeup.flags.valid;
}

static inline bool acpi_device_can_poweroff(struct acpi_device *adev)
{
	return adev->power.states[ACPI_STATE_D3_COLD].flags.os_accessible;
}

#else	/* CONFIG_ACPI */

static inline int register_acpi_bus_type(void *bus) { return 0; }
static inline int unregister_acpi_bus_type(void *bus) { return 0; }

#endif				/* CONFIG_ACPI */

#endif /*__ACPI_BUS_H__*/
Commit	Line	Data
1da177e4 LT	1	/*
	2	* acpi_bus.h - ACPI Bus Driver ($Revision: 22 $)
	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_BUS_H__
	27	#define __ACPI_BUS_H__
	28
5b327265	29	#include <linux/device.h>
1da177e4 LT	30
	31	#include <acpi/acpi.h>
	32
1da177e4 LT	33	/* TBD: Make dynamic */
	34	#define ACPI_MAX_HANDLES 10
	35	struct acpi_handle_list {
4be44fcd LB	36	u32 count;
4be44fcd LB	37	acpi_handle handles[ACPI_MAX_HANDLES];
1da177e4 LT	38	};
1da177e4 LT	39
1da177e4 LT	40	/* acpi_utils.h */
1da177e4 LT	41	acpi_status
4be44fcd LB	42	acpi_extract_package(union acpi_object *package,
4be44fcd LB	43	struct acpi_buffer format, struct acpi_buffer buffer);
1da177e4	44	acpi_status
4be44fcd LB	45	acpi_evaluate_integer(acpi_handle handle,
4be44fcd LB	46	acpi_string pathname,
27663c58	47	struct acpi_object_list arguments, unsigned long long data);
1da177e4	48	acpi_status
4be44fcd LB	49	acpi_evaluate_reference(acpi_handle handle,
	50	acpi_string pathname,
	51	struct acpi_object_list *arguments,
	52	struct acpi_handle_list *list);
275c58d7 TK	53	acpi_status
	54	acpi_evaluate_hotplug_ost(acpi_handle handle, u32 source_event,
	55	u32 status_code, struct acpi_buffer *status_buf);
1da177e4	56
38ac0f1b	57	acpi_status
8ede06ab	58	acpi_get_physical_device_location(acpi_handle handle, struct acpi_pld_info **pld);
76f58584	59	#ifdef CONFIG_ACPI
1da177e4 LT	60
	61	#include <linux/proc_fs.h>
	62
	63	#define ACPI_BUS_FILE_ROOT "acpi"
4be44fcd	64	extern struct proc_dir_entry *acpi_root_dir;
1da177e4	65
a2d06a1a RW	66	enum acpi_bus_add_type {
	67	ACPI_BUS_ADD_BASIC = 0,
	68	ACPI_BUS_ADD_MATCH,
	69	ACPI_BUS_ADD_START,
	70	ACPI_BUS_ADD_TYPE_COUNT
	71	};
	72
1da177e4	73	enum acpi_bus_removal_type {
4be44fcd	74	ACPI_BUS_REMOVAL_NORMAL = 0,
1da177e4 LT	75	ACPI_BUS_REMOVAL_EJECT,
	76	ACPI_BUS_REMOVAL_SUPRISE,
	77	ACPI_BUS_REMOVAL_TYPE_COUNT
	78	};
	79
	80	enum acpi_bus_device_type {
4be44fcd	81	ACPI_BUS_TYPE_DEVICE = 0,
1da177e4 LT	82	ACPI_BUS_TYPE_POWER,
	83	ACPI_BUS_TYPE_PROCESSOR,
	84	ACPI_BUS_TYPE_THERMAL,
1da177e4 LT	85	ACPI_BUS_TYPE_POWER_BUTTON,
	86	ACPI_BUS_TYPE_SLEEP_BUTTON,
	87	ACPI_BUS_DEVICE_TYPE_COUNT
	88	};
	89
	90	struct acpi_driver;
	91	struct acpi_device;
	92
1da177e4 LT	93	/*
	94	* ACPI Driver
	95	* -----------
	96	*/
	97
4be44fcd LB	98	typedef int (acpi_op_add) (struct acpi_device device);
4be44fcd LB	99	typedef int (acpi_op_remove) (struct acpi_device device, int type);
4be44fcd	100	typedef int (acpi_op_start) (struct acpi_device device);
4be44fcd LB	101	typedef int (acpi_op_bind) (struct acpi_device device);
4be44fcd LB	102	typedef int (acpi_op_unbind) (struct acpi_device device);
46ec8598	103	typedef void (acpi_op_notify) (struct acpi_device device, u32 event);
1da177e4 LT	104
1da177e4 LT	105	struct acpi_device_ops {
4be44fcd LB	106	acpi_op_add add;
4be44fcd LB	107	acpi_op_remove remove;
4be44fcd	108	acpi_op_start start;
4be44fcd LB	109	acpi_op_bind bind;
4be44fcd LB	110	acpi_op_unbind unbind;
46ec8598	111	acpi_op_notify notify;
1da177e4 LT	112	};
1da177e4 LT	113
6d278131 BH	114	#define ACPI_DRIVER_ALL_NOTIFY_EVENTS 0x1 /* system AND device events */
6d278131 BH	115
1da177e4	116	struct acpi_driver {
4be44fcd LB	117	char name[80];
4be44fcd LB	118	char class[80];
8c8eb78f	119	const struct acpi_device_id ids; / Supported Hardware IDs */
6d278131	120	unsigned int flags;
4be44fcd	121	struct acpi_device_ops ops;
d43ec68e	122	struct device_driver drv;
1890a97a	123	struct module *owner;
1da177e4 LT	124	};
	125
	126	/*
	127	* ACPI Device
	128	* -----------
	129	*/
	130
	131	/* Status (_STA) */
	132
	133	struct acpi_device_status {
4be44fcd LB	134	u32 present:1;
	135	u32 enabled:1;
	136	u32 show_in_ui:1;
	137	u32 functional:1;
	138	u32 battery_present:1;
	139	u32 reserved:27;
1da177e4 LT	140	};
1da177e4 LT	141
1da177e4 LT	142	/* Flags */
	143
	144	struct acpi_device_flags {
4be44fcd	145	u32 dynamic_status:1;
4be44fcd	146	u32 bus_address:1;
4be44fcd LB	147	u32 removable:1;
4be44fcd LB	148	u32 ejectable:1;
4be44fcd LB	149	u32 suprise_removal_ok:1;
	150	u32 power_manageable:1;
	151	u32 performance_manageable:1;
c4753e57	152	u32 eject_pending:1;
f4fa0e01	153	u32 reserved:24;
1da177e4 LT	154	};
1da177e4 LT	155
1da177e4 LT	156	/* File System */
	157
	158	struct acpi_device_dir {
4be44fcd	159	struct proc_dir_entry *entry;
1da177e4 LT	160	};
	161
	162	#define acpi_device_dir(d) ((d)->dir.entry)
	163
1da177e4 LT	164	/* Plug and Play */
1da177e4 LT	165
24c5c4c2	166	typedef char acpi_bus_id[8];
4be44fcd	167	typedef unsigned long acpi_bus_address;
4be44fcd LB	168	typedef char acpi_device_name[40];
4be44fcd LB	169	typedef char acpi_device_class[20];
1da177e4	170
7f47fa6c BH	171	struct acpi_hardware_id {
	172	struct list_head list;
	173	char *id;
	174	};
	175
1da177e4	176	struct acpi_device_pnp {
4be44fcd LB	177	acpi_bus_id bus_id; /* Object name */
4be44fcd LB	178	acpi_bus_address bus_address; /* _ADR */
15b8dd53	179	char unique_id; / _UID */
7f47fa6c	180	struct list_head ids; /* _HID and _CIDs */
4be44fcd LB	181	acpi_device_name device_name; /* Driver-determined */
4be44fcd LB	182	acpi_device_class device_class; /* " */
d1efe3c3	183	union acpi_object str_obj; / unicode string for _STR method */
bb74ac23	184	unsigned long sun; /* _SUN */
1da177e4 LT	185	};
	186
	187	#define acpi_device_bid(d) ((d)->pnp.bus_id)
	188	#define acpi_device_adr(d) ((d)->pnp.bus_address)
620e112c	189	const char acpi_device_hid(struct acpi_device device);
1da177e4 LT	190	#define acpi_device_name(d) ((d)->pnp.device_name)
	191	#define acpi_device_class(d) ((d)->pnp.device_class)
	192
1da177e4 LT	193	/* Power Management */
	194
	195	struct acpi_device_power_flags {
4be44fcd LB	196	u32 explicit_get:1; /* _PSC present? */
	197	u32 power_resources:1; /* Power resources */
	198	u32 inrush_current:1; /* Serialize Dx->D0 */
	199	u32 power_removed:1; /* Optimize Dx->D0 */
	200	u32 reserved:28;
1da177e4 LT	201	};
	202
	203	struct acpi_device_power_state {
	204	struct {
4be44fcd	205	u8 valid:1;
1399dfcd	206	u8 os_accessible:1;
4be44fcd LB	207	u8 explicit_set:1; /* _PSx present? */
	208	u8 reserved:6;
	209	} flags;
	210	int power; /* % Power (compared to D0) */
	211	int latency; /* Dx->D0 time (microseconds) */
	212	struct acpi_handle_list resources; /* Power resources referenced */
1da177e4 LT	213	};
	214
	215	struct acpi_device_power {
4be44fcd	216	int state; /* Current state */
1da177e4	217	struct acpi_device_power_flags flags;
b4a03b9a	218	struct acpi_device_power_state states[ACPI_D_STATE_COUNT]; /* Power states (D0-D3Cold) */
1da177e4 LT	219	};
1da177e4 LT	220
1da177e4 LT	221	/* Performance Management */
	222
	223	struct acpi_device_perf_flags {
4be44fcd	224	u8 reserved:8;
1da177e4 LT	225	};
	226
	227	struct acpi_device_perf_state {
	228	struct {
4be44fcd LB	229	u8 valid:1;
	230	u8 reserved:7;
	231	} flags;
	232	u8 power; /* % Power (compared to P0) */
	233	u8 performance; /* % Performance ( " ) */
	234	int latency; /* Px->P0 time (microseconds) */
1da177e4 LT	235	};
	236
	237	struct acpi_device_perf {
4be44fcd	238	int state;
1da177e4	239	struct acpi_device_perf_flags flags;
4be44fcd	240	int state_count;
1da177e4 LT	241	struct acpi_device_perf_state *states;
	242	};
	243
	244	/* Wakeup Management */
	245	struct acpi_device_wakeup_flags {
4be44fcd LB	246	u8 valid:1; /* Can successfully enable wakeup? */
4be44fcd LB	247	u8 run_wake:1; /* Run-Wake GPE devices */
b67ea761	248	u8 notifier_present:1; /* Wake-up notify handler has been installed */
1da177e4 LT	249	};
1da177e4 LT	250
1da177e4	251	struct acpi_device_wakeup {
4be44fcd	252	acpi_handle gpe_device;
439913ff LM	253	u64 gpe_number;
439913ff LM	254	u64 sleep_state;
4be44fcd	255	struct acpi_handle_list resources;
4be44fcd	256	struct acpi_device_wakeup_flags flags;
9b83ccd2	257	int prepare_count;
1da177e4 LT	258	};
1da177e4 LT	259
1033f904 LT	260	struct acpi_device_physical_node {
	261	u8 node_id;
	262	struct list_head node;
	263	struct device *dev;
	264	};
1da177e4	265
1033f904 LT	266	/* set maximum of physical nodes to 32 for expansibility */
1033f904 LT	267	#define ACPI_MAX_PHYSICAL_NODE 32
1da177e4	268
1033f904	269	/* Device */
1da177e4	270	struct acpi_device {
caaa6efb BH	271	int device_type;
caaa6efb BH	272	acpi_handle handle; /* no handle for fixed hardware */
4be44fcd LB	273	struct acpi_device *parent;
	274	struct list_head children;
	275	struct list_head node;
	276	struct list_head wakeup_list;
1da177e4 LT	277	struct acpi_device_status status;
1da177e4 LT	278	struct acpi_device_flags flags;
4be44fcd	279	struct acpi_device_pnp pnp;
1da177e4 LT	280	struct acpi_device_power power;
1da177e4 LT	281	struct acpi_device_wakeup wakeup;
4be44fcd LB	282	struct acpi_device_perf performance;
	283	struct acpi_device_dir dir;
	284	struct acpi_device_ops ops;
	285	struct acpi_driver *driver;
	286	void *driver_data;
5b327265	287	struct device dev;
a2d06a1a	288	enum acpi_bus_add_type add_type; /* how to handle adding */
fd350943	289	enum acpi_bus_removal_type removal_type; /* indicate for different removal type */
1033f904 LT	290	u8 physical_node_count;
	291	struct list_head physical_node_list;
	292	struct mutex physical_node_lock;
	293	DECLARE_BITMAP(physical_node_id_bitmap, ACPI_MAX_PHYSICAL_NODE);
1da177e4 LT	294	};
1da177e4 LT	295
db89b4f0 PM	296	static inline void acpi_driver_data(struct acpi_device d)
	297	{
	298	return d->driver_data;
	299	}
	300
d43ec68e PM	301	#define to_acpi_device(d) container_of(d, struct acpi_device, dev)
d43ec68e PM	302	#define to_acpi_driver(d) container_of(d, struct acpi_driver, drv)
1da177e4	303
55955aad DB	304	/* acpi_device.dev.bus == &acpi_bus_type */
	305	extern struct bus_type acpi_bus_type;
	306
1da177e4 LT	307	/*
	308	* Events
	309	* ------
	310	*/
	311
	312	struct acpi_bus_event {
4be44fcd LB	313	struct list_head node;
	314	acpi_device_class device_class;
	315	acpi_bus_id bus_id;
	316	u32 type;
	317	u32 data;
1da177e4 LT	318	};
1da177e4 LT	319
c4753e57 TK	320	struct acpi_eject_event {
	321	acpi_handle handle;
	322	u32 event;
	323	};
	324
99e0d2fc	325	extern struct kobject *acpi_kobj;
962ce8ca	326	extern int acpi_bus_generate_netlink_event(const char, const char, u8, int);
8e4319c4	327	void acpi_bus_private_data_handler(acpi_handle, void *);
20733939	328	int acpi_bus_get_private_data(acpi_handle, void **);
9ee85241 ZR	329	extern int acpi_notifier_call_chain(struct acpi_device *, u32, u32);
	330	extern int register_acpi_notifier(struct notifier_block *);
	331	extern int unregister_acpi_notifier(struct notifier_block *);
6bd00a61 SL	332
	333	extern int register_acpi_bus_notifier(struct notifier_block *nb);
	334	extern void unregister_acpi_bus_notifier(struct notifier_block *nb);
1da177e4 LT	335	/*
	336	* External Functions
	337	*/
	338
	339	int acpi_bus_get_device(acpi_handle handle, struct acpi_device **device);
8e4319c4	340	void acpi_bus_data_handler(acpi_handle handle, void *context);
402ac536 BH	341	acpi_status acpi_bus_get_status_handle(acpi_handle handle,
402ac536 BH	342	unsigned long long *sta);
4be44fcd	343	int acpi_bus_get_status(struct acpi_device *device);
4be44fcd	344	int acpi_bus_set_power(acpi_handle handle, int state);
078eb126	345	int acpi_device_set_power(struct acpi_device *device, int state);
25eed407	346	int acpi_bus_update_power(acpi_handle handle, int *state_p);
3737b2b1	347	bool acpi_bus_power_manageable(acpi_handle handle);
eb9d0fe4	348	bool acpi_bus_can_wakeup(acpi_handle handle);
0090def6 LM	349	int acpi_power_resource_register_device(struct device *dev, acpi_handle handle);
0090def6 LM	350	void acpi_power_resource_unregister_device(struct device *dev, acpi_handle handle);
14e04fb3 LB	351	#ifdef CONFIG_ACPI_PROC_EVENT
14e04fb3 LB	352	int acpi_bus_generate_proc_event(struct acpi_device *device, u8 type, int data);
8db85d4c	353	int acpi_bus_generate_proc_event4(const char class, const char bid, u8 type, int data);
4be44fcd	354	int acpi_bus_receive_event(struct acpi_bus_event *event);
14e04fb3 LB	355	#else
	356	static inline int acpi_bus_generate_proc_event(struct acpi_device *device, u8 type, int data)
	357	{ return 0; }
	358	#endif
4be44fcd	359	int acpi_bus_register_driver(struct acpi_driver *driver);
06ea8e08	360	void acpi_bus_unregister_driver(struct acpi_driver *driver);
636458de	361	int acpi_bus_add(acpi_handle handle, struct acpi_device **ret);
c4753e57	362	void acpi_bus_hot_remove_device(void *context);
ceaba663	363	int acpi_bus_trim(struct acpi_device *start, int rmdevice);
fd350943	364	acpi_status acpi_bus_get_ejd(acpi_handle handle, acpi_handle * ejd);
8c8eb78f TR	365	int acpi_match_device_ids(struct acpi_device *device,
8c8eb78f TR	366	const struct acpi_device_id *ids);
1da177e4 LT	367	int acpi_create_dir(struct acpi_device *);
	368	void acpi_remove_dir(struct acpi_device *);
	369
0d2cf8f5 MW	370
	371	/**
	372	* module_acpi_driver(acpi_driver) - Helper macro for registering an ACPI driver
	373	* @__acpi_driver: acpi_driver struct
	374	*
	375	* Helper macro for ACPI drivers which do not do anything special in module
	376	* init/exit. This eliminates a lot of boilerplate. Each module may only
	377	* use this macro once, and calling it replaces module_init() and module_exit()
	378	*/
	379	#define module_acpi_driver(__acpi_driver) \
	380	module_driver(__acpi_driver, acpi_bus_register_driver, \
	381	acpi_bus_unregister_driver)
	382
4e10d12a DSL	383	/*
	384	* Bind physical devices with ACPI devices
	385	*/
4e10d12a	386	struct acpi_bus_type {
4be44fcd LB	387	struct list_head list;
	388	struct bus_type *bus;
	389	/* For general devices under the bus */
	390	int (find_device) (struct device , acpi_handle *);
4e10d12a	391	/* For bridges, such as PCI root bridge, IDE controller */
4be44fcd	392	int (find_bridge) (struct device , acpi_handle *);
4e10d12a DSL	393	};
	394	int register_acpi_bus_type(struct acpi_bus_type *);
	395	int unregister_acpi_bus_type(struct acpi_bus_type *);
22c13f9d	396
76d56de5 AC	397	struct acpi_pci_root {
	398	struct list_head node;
	399	struct acpi_device * device;
	400	struct acpi_pci_id id;
	401	struct pci_bus *bus;
	402	u16 segment;
6ad95513	403	struct resource secondary; /* downstream bus range */
76d56de5 AC	404
	405	u32 osc_support_set; /* _OSC state of support bits */
	406	u32 osc_control_set; /* _OSC state of control bits */
f4b57a3b	407	phys_addr_t mcfg_addr;
76d56de5 AC	408	};
76d56de5 AC	409
4e10d12a	410	/* helper */
439913ff	411	acpi_handle acpi_get_child(acpi_handle, u64);
27558203	412	int acpi_is_root_bridge(acpi_handle);
4e10d12a	413	acpi_handle acpi_get_pci_rootbridge_handle(unsigned int, unsigned int);
76d56de5	414	struct acpi_pci_root *acpi_pci_find_root(acpi_handle handle);
95f8a082	415	#define DEVICE_ACPI_HANDLE(dev) ((acpi_handle)ACPI_HANDLE(dev))
4e10d12a	416
b67ea761 RW	417	int acpi_enable_wakeup_device_power(struct acpi_device *dev, int state);
	418	int acpi_disable_wakeup_device_power(struct acpi_device *dev);
	419
aa338601	420	#ifdef CONFIG_PM
ec2cd81c RW	421	acpi_status acpi_add_pm_notifier(struct acpi_device *adev,
	422	acpi_notify_handler handler, void *context);
	423	acpi_status acpi_remove_pm_notifier(struct acpi_device *adev,
	424	acpi_notify_handler handler);
86b3832c RW	425	int acpi_device_power_state(struct device dev, struct acpi_device adev,
86b3832c RW	426	u32 target_state, int d_max_in, int *d_min_p);
ee85f543	427	int acpi_pm_device_sleep_state(struct device , int , int);
761afb86	428	#else
ec2cd81c RW	429	static inline acpi_status acpi_add_pm_notifier(struct acpi_device *adev,
	430	acpi_notify_handler handler,
	431	void *context)
	432	{
	433	return AE_SUPPORT;
	434	}
	435	static inline acpi_status acpi_remove_pm_notifier(struct acpi_device *adev,
	436	acpi_notify_handler handler)
	437	{
	438	return AE_SUPPORT;
	439	}
86b3832c	440	static inline int __acpi_device_power_state(int m, int *p)
296699de RW	441	{
	442	if (p)
	443	*p = ACPI_STATE_D0;
ee85f543	444	return (m >= ACPI_STATE_D0 && m <= ACPI_STATE_D3) ? m : ACPI_STATE_D0;
296699de	445	}
86b3832c RW	446	static inline int acpi_device_power_state(struct device *dev,
	447	struct acpi_device *adev,
	448	u32 target_state, int d_max_in,
	449	int *d_min_p)
	450	{
	451	return __acpi_device_power_state(d_max_in, d_min_p);
	452	}
	453	static inline int acpi_pm_device_sleep_state(struct device d, int p, int m)
	454	{
	455	return __acpi_device_power_state(m, p);
	456	}
761afb86 RW	457	#endif
761afb86 RW	458
bdda27fb	459	#ifdef CONFIG_PM_RUNTIME
dee8370c	460	int __acpi_device_run_wake(struct acpi_device *, bool);
b24e5098	461	int acpi_pm_device_run_wake(struct device *, bool);
761afb86	462	#else
dee8370c RW	463	static inline int __acpi_device_run_wake(struct acpi_device *adev, bool en)
	464	{
	465	return -ENODEV;
	466	}
b24e5098 LM	467	static inline int acpi_pm_device_run_wake(struct device *dev, bool enable)
	468	{
	469	return -ENODEV;
	470	}
bdda27fb RW	471	#endif
	472
	473	#ifdef CONFIG_PM_SLEEP
dee8370c	474	int __acpi_device_sleep_wake(struct acpi_device *, u32, bool);
bdda27fb RW	475	int acpi_pm_device_sleep_wake(struct device *, bool);
bdda27fb RW	476	#else
dee8370c RW	477	static inline int __acpi_device_sleep_wake(struct acpi_device *adev,
	478	u32 target_state, bool enable)
	479	{
	480	return -ENODEV;
	481	}
f7a1b860 DH	482	static inline int acpi_pm_device_sleep_wake(struct device *dev, bool enable)
	483	{
	484	return -ENODEV;
	485	}
761afb86	486	#endif
fd4aff1a	487
99926a8c DR	488	#ifdef CONFIG_ACPI_SLEEP
	489	u32 acpi_target_system_state(void);
	490	#else
	491	static inline u32 acpi_target_system_state(void) { return ACPI_STATE_S0; }
	492	#endif
	493
078eb126 RW	494	static inline bool acpi_device_power_manageable(struct acpi_device *adev)
	495	{
	496	return adev->flags.power_manageable;
	497	}
	498
	499	static inline bool acpi_device_can_wakeup(struct acpi_device *adev)
	500	{
	501	return adev->wakeup.flags.valid;
	502	}
	503
1399dfcd AL	504	static inline bool acpi_device_can_poweroff(struct acpi_device *adev)
	505	{
	506	return adev->power.states[ACPI_STATE_D3_COLD].flags.os_accessible;
	507	}
	508
66886d6f MG	509	#else /* CONFIG_ACPI */
66886d6f MG	510
7ae30986 LB	511	static inline int register_acpi_bus_type(void *bus) { return 0; }
7ae30986 LB	512	static inline int unregister_acpi_bus_type(void *bus) { return 0; }
66886d6f	513
fd350943	514	#endif /* CONFIG_ACPI */
1da177e4 LT	515
1da177e4 LT	516	#endif /__ACPI_BUS_H__/