[linux-2.6-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_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);
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_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 match_driver:1;
	u32 reserved:23;
};

/* 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 list_head 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 list_head 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_driver *driver;
	void *driver_data;
	struct device dev;
	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);
	struct list_head power_dependent;
	void (*remove)(struct acpi_device *);
};

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 {
	struct acpi_device	*device;
	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);

#ifdef CONFIG_PM
int acpi_bus_set_power(acpi_handle handle, int state);
const char *acpi_power_state_string(int state);
int acpi_device_get_power(struct acpi_device *device, int *state);
int acpi_device_set_power(struct acpi_device *device, int state);
int acpi_bus_init_power(struct acpi_device *device);
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);
#else /* !CONFIG_PM */
static inline int acpi_bus_set_power(acpi_handle handle, int state)
{
	return 0;
}
static inline const char *acpi_power_state_string(int state)
{
	return "D0";
}
static inline int acpi_device_get_power(struct acpi_device *device, int *state)
{
	return 0;
}
static inline int acpi_device_set_power(struct acpi_device *device, int state)
{
	return 0;
}
static inline int acpi_bus_init_power(struct acpi_device *device)
{
	return 0;
}
static inline int acpi_bus_update_power(acpi_handle handle, int *state_p)
{
	return 0;
}
static inline bool acpi_bus_power_manageable(acpi_handle handle)
{
	return false;
}
static inline bool acpi_bus_can_wakeup(acpi_handle handle)
{
	return false;
}
#endif /* !CONFIG_PM */

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