[deliverable/linux.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);

bool acpi_has_method(acpi_handle handle, char *name);
acpi_status acpi_execute_simple_method(acpi_handle handle, char *method,
				       u64 arg);

#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 {
	u8 node_id;
	struct list_head node;
	struct device *dev;
	bool put_online:1;
};

/* 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_scan_handler *handler;
	struct acpi_driver *driver;
	void *driver_data;
	struct device dev;
	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;
};

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