[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_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 Scan Handler
 * -----------------
 */

enum acpi_hotplug_mode {
	AHM_GENERIC = 0,
	AHM_CONTAINER,
	AHM_COUNT
};

struct acpi_hotplug_profile {
	struct kobject kobj;
	bool enabled:1;
	enum acpi_hotplug_mode mode;
};

static inline struct acpi_hotplug_profile *to_acpi_hotplug_profile(
						struct kobject *kobj)
{
	return container_of(kobj, struct acpi_hotplug_profile, kobj);
}

struct acpi_scan_handler {
	const struct acpi_device_id *ids;
	struct list_head list_node;
	int (*attach)(struct acpi_device *dev, const struct acpi_device_id *id);
	void (*detach)(struct acpi_device *dev);
	struct acpi_hotplug_profile hotplug;
};

/*
 * 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 removable:1;
	u32 ejectable:1;
	u32 power_manageable:1;
	u32 eject_pending:1;
	u32 match_driver:1;
	u32 reserved:26;
};

/* 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_pnp_type {
	u32 hardware_id:1;
	u32 bus_address:1;
	u32 reserved:30;
};

struct acpi_device_pnp {
	acpi_bus_id bus_id;		/* Object name */
	struct acpi_pnp_type type;	/* ID type */
	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 {
	unsigned int node_id;
	struct list_head node;
	struct device *dev;
	bool put_online:1;
};

/* 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_scan_handler *handler;
	struct acpi_driver *driver;
	void *driver_data;
	struct device dev;
	unsigned int physical_node_count;
	struct list_head physical_node_list;
	struct mutex physical_node_lock;
	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;
};

struct acpi_hp_work {
	struct work_struct work;
	acpi_handle handle;
	u32 type;
	void *context;
};
void alloc_acpi_hp_work(acpi_handle handle, u32 type, void *context,
			void (*func)(struct work_struct *work));

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);
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_device_fix_up_power(struct acpi_device *device);
int acpi_bus_update_power(acpi_handle handle, int *state_p);
bool acpi_bus_power_manageable(acpi_handle handle);

#ifdef CONFIG_PM
bool acpi_bus_can_wakeup(acpi_handle handle);
#else
static inline bool acpi_bus_can_wakeup(acpi_handle handle) { return false; }
#endif

#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

void acpi_scan_lock_acquire(void);
void acpi_scan_lock_release(void);
int acpi_scan_add_handler(struct acpi_scan_handler *handler);
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;
	const char *name;
	bool (*match)(struct device *dev);
	int (*find_device) (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 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);
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_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_pm_device_sleep_state(struct device *d, int *p, int m)
{
	if (p)
		*p = ACPI_STATE_D0;

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