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

/* 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);
acpi_status acpi_evaluate_ej0(acpi_handle handle);
acpi_status acpi_evaluate_lck(acpi_handle handle, int lock);
bool acpi_ata_match(acpi_handle handle);
bool acpi_bay_match(acpi_handle handle);
bool acpi_dock_match(acpi_handle handle);

bool acpi_check_dsm(acpi_handle handle, const u8 *uuid, int rev, u64 funcs);
union acpi_object *acpi_evaluate_dsm(acpi_handle handle, const u8 *uuid,
			int rev, int func, union acpi_object *argv4);

static inline union acpi_object *
acpi_evaluate_dsm_typed(acpi_handle handle, const u8 *uuid, int rev, int func,
			union acpi_object *argv4, acpi_object_type type)
{
	union acpi_object *obj;

	obj = acpi_evaluate_dsm(handle, uuid, rev, func, argv4);
	if (obj && obj->type != type) {
		ACPI_FREE(obj);
		obj = NULL;
	}

	return obj;
}

#define	ACPI_INIT_DSM_ARGV4(cnt, eles)			\
	{						\
	  .package.type = ACPI_TYPE_PACKAGE,		\
	  .package.count = (cnt),			\
	  .package.elements = (eles)			\
	}

#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
 * -----------------
 */

struct acpi_hotplug_profile {
	struct kobject kobj;
	int (*scan_dependent)(struct acpi_device *adev);
	bool enabled:1;
	bool demand_offline:1;
};

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 match_driver:1;
	u32 initialized:1;
	u32 visited:1;
	u32 no_hotplug:1;
	u32 reserved:24;
};

/* File System */

struct acpi_device_dir {
	struct proc_dir_entry *entry;
};

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

/* Plug and Play */

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

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

struct acpi_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 ignore_parent:1;	/* Power is independent of parent power state */
	u32 reserved:27;
};

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 list_head del_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;
	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)

static inline void acpi_set_device_status(struct acpi_device *adev, u32 sta)
{
	*((u32 *)&adev->status) = sta;
}

/* 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;
};

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 **);
void acpi_bus_no_hotplug(acpi_handle handle);
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 *);

/*
 * External Functions
 */

int acpi_bus_get_device(acpi_handle handle, struct acpi_device **device);
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

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_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 *);

static inline bool acpi_device_enumerated(struct acpi_device *adev)
{
	return adev && adev->flags.initialized && adev->flags.visited;
}

typedef void (*acpi_hp_callback)(void *data, u32 src);

acpi_status acpi_hotplug_execute(acpi_hp_callback func, void *data, u32 src);

/**
 * 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);
	struct acpi_device * (*find_companion)(struct device *);
	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 */

struct acpi_device *acpi_find_child_device(struct acpi_device *parent,
					   u64 address, bool check_children);
int acpi_is_root_bridge(acpi_handle);
struct acpi_pci_root *acpi_pci_find_root(acpi_handle handle);

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