[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>

#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);
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);

#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;
	bool ignore: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 match_driver:1;
	u32 no_hotplug: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 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 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)

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

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