[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);
#ifdef CONFIG_ACPI

#include <linux/proc_fs.h>

#define ACPI_BUS_FILE_ROOT	"acpi"
extern struct proc_dir_entry *acpi_root_dir;

enum acpi_bus_removal_type {
	ACPI_BUS_REMOVAL_NORMAL = 0,
	ACPI_BUS_REMOVAL_EJECT,
	ACPI_BUS_REMOVAL_SUPRISE,
	ACPI_BUS_REMOVAL_TYPE_COUNT
};

enum acpi_bus_device_type {
	ACPI_BUS_TYPE_DEVICE = 0,
	ACPI_BUS_TYPE_POWER,
	ACPI_BUS_TYPE_PROCESSOR,
	ACPI_BUS_TYPE_THERMAL,
	ACPI_BUS_TYPE_POWER_BUTTON,
	ACPI_BUS_TYPE_SLEEP_BUTTON,
	ACPI_BUS_DEVICE_TYPE_COUNT
};

struct acpi_driver;
struct acpi_device;

/*
 * ACPI 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 suprise_removal_ok:1;
	u32 power_manageable:1;
	u32 performance_manageable:1;
	u32 eject_pending:1;
	u32 match_driver: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 reserved:28;
};

struct acpi_device_power_state {
	struct {
		u8 valid:1;
		u8 os_accessible:1;
		u8 explicit_set:1;	/* _PSx present? */
		u8 reserved:6;
	} flags;
	int power;		/* % Power (compared to D0) */
	int latency;		/* Dx->D0 time (microseconds) */
	struct list_head resources;	/* Power resources referenced */
};

struct acpi_device_power {
	int state;		/* Current state */
	struct acpi_device_power_flags flags;
	struct acpi_device_power_state states[ACPI_D_STATE_COUNT];	/* Power states (D0-D3Cold) */
};

/* Performance Management */

struct acpi_device_perf_flags {
	u8 reserved:8;
};

struct acpi_device_perf_state {
	struct {
		u8 valid:1;
		u8 reserved:7;
	} flags;
	u8 power;		/* % Power (compared to P0) */
	u8 performance;		/* % Performance (    "   ) */
	int latency;		/* Px->P0 time (microseconds) */
};

struct acpi_device_perf {
	int state;
	struct acpi_device_perf_flags flags;
	int state_count;
	struct acpi_device_perf_state *states;
};

/* Wakeup Management */
struct acpi_device_wakeup_flags {
	u8 valid:1;		/* Can successfully enable wakeup? */
	u8 run_wake:1;		/* Run-Wake GPE devices */
	u8 notifier_present:1;  /* Wake-up notify handler has been installed */
};

struct acpi_device_wakeup {
	acpi_handle gpe_device;
	u64 gpe_number;
	u64 sleep_state;
	struct list_head resources;
	struct acpi_device_wakeup_flags flags;
	int prepare_count;
};

struct acpi_device_physical_node {
	u8 node_id;
	struct list_head node;
	struct device *dev;
};

/* set maximum of physical nodes to 32 for expansibility */
#define ACPI_MAX_PHYSICAL_NODE	32

/* Device */
struct acpi_device {
	int device_type;
	acpi_handle handle;		/* no handle for fixed hardware */
	struct acpi_device *parent;
	struct list_head children;
	struct list_head node;
	struct list_head wakeup_list;
	struct acpi_device_status status;
	struct acpi_device_flags flags;
	struct acpi_device_pnp pnp;
	struct acpi_device_power power;
	struct acpi_device_wakeup wakeup;
	struct acpi_device_perf performance;
	struct acpi_device_dir dir;
	struct acpi_scan_handler *handler;
	struct acpi_driver *driver;
	void *driver_data;
	struct device dev;
	enum acpi_bus_removal_type removal_type;	/* indicate for different removal type */
	u8 physical_node_count;
	struct list_head physical_node_list;
	struct mutex physical_node_lock;
	DECLARE_BITMAP(physical_node_id_bitmap, ACPI_MAX_PHYSICAL_NODE);
	struct list_head power_dependent;
	void (*remove)(struct acpi_device *);
};

static inline void *acpi_driver_data(struct acpi_device *d)
{
	return d->driver_data;
}

#define to_acpi_device(d)	container_of(d, struct acpi_device, dev)
#define to_acpi_driver(d)	container_of(d, struct acpi_driver, drv)

/* acpi_device.dev.bus == &acpi_bus_type */
extern struct bus_type acpi_bus_type;

/*
 * Events
 * ------
 */

struct acpi_bus_event {
	struct list_head node;
	acpi_device_class device_class;
	acpi_bus_id bus_id;
	u32 type;
	u32 data;
};

struct acpi_eject_event {
	struct acpi_device	*device;
	u32		event;
};

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_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 list_head node;
	struct acpi_device * device;
	struct pci_bus *bus;
	u16 segment;
	struct resource secondary;	/* downstream bus range */

	u32 osc_support_set;	/* _OSC state of support bits */
	u32 osc_control_set;	/* _OSC state of control bits */
	phys_addr_t mcfg_addr;
};

/* helper */
acpi_handle acpi_get_child(acpi_handle, u64);
int acpi_is_root_bridge(acpi_handle);
struct acpi_pci_root *acpi_pci_find_root(acpi_handle handle);
#define DEVICE_ACPI_HANDLE(dev) ((acpi_handle)ACPI_HANDLE(dev))

int acpi_enable_wakeup_device_power(struct acpi_device *dev, int state);
int acpi_disable_wakeup_device_power(struct acpi_device *dev);

#ifdef CONFIG_PM
acpi_status acpi_add_pm_notifier(struct acpi_device *adev,
				 acpi_notify_handler handler, void *context);
acpi_status acpi_remove_pm_notifier(struct acpi_device *adev,
				    acpi_notify_handler handler);
int acpi_device_power_state(struct device *dev, struct acpi_device *adev,
			    u32 target_state, int d_max_in, int *d_min_p);
int acpi_pm_device_sleep_state(struct device *, int *, int);
void acpi_dev_pm_add_dependent(acpi_handle handle, struct device *depdev);
void acpi_dev_pm_remove_dependent(acpi_handle handle, struct device *depdev);
#else
static inline acpi_status acpi_add_pm_notifier(struct acpi_device *adev,
					       acpi_notify_handler handler,
					       void *context)
{
	return AE_SUPPORT;
}
static inline acpi_status acpi_remove_pm_notifier(struct acpi_device *adev,
						  acpi_notify_handler handler)
{
	return AE_SUPPORT;
}
static inline int __acpi_device_power_state(int m, int *p)
{
	if (p)
		*p = ACPI_STATE_D0;
	return (m >= ACPI_STATE_D0 && m <= ACPI_STATE_D3) ? m : ACPI_STATE_D0;
}
static inline int acpi_device_power_state(struct device *dev,
					  struct acpi_device *adev,
					  u32 target_state, int d_max_in,
					  int *d_min_p)
{
	return __acpi_device_power_state(d_max_in, d_min_p);
}
static inline int acpi_pm_device_sleep_state(struct device *d, int *p, int m)
{
	return __acpi_device_power_state(m, p);
}
static inline void acpi_dev_pm_add_dependent(acpi_handle handle,
					     struct device *depdev) {}
static inline void acpi_dev_pm_remove_dependent(acpi_handle handle,
						struct device *depdev) {}
#endif

#ifdef CONFIG_PM_RUNTIME
int __acpi_device_run_wake(struct acpi_device *, bool);
int acpi_pm_device_run_wake(struct device *, bool);
#else
static inline int __acpi_device_run_wake(struct acpi_device *adev, bool en)
{
	return -ENODEV;
}
static inline int acpi_pm_device_run_wake(struct device *dev, bool enable)
{
	return -ENODEV;
}
#endif

#ifdef CONFIG_PM_SLEEP
int __acpi_device_sleep_wake(struct acpi_device *, u32, bool);
int acpi_pm_device_sleep_wake(struct device *, bool);
#else
static inline int __acpi_device_sleep_wake(struct acpi_device *adev,
					   u32 target_state, bool enable)
{
	return -ENODEV;
}
static inline int acpi_pm_device_sleep_wake(struct device *dev, bool enable)
{
	return -ENODEV;
}
#endif

#ifdef CONFIG_ACPI_SLEEP
u32 acpi_target_system_state(void);
#else
static inline u32 acpi_target_system_state(void) { return ACPI_STATE_S0; }
#endif

static inline bool acpi_device_power_manageable(struct acpi_device *adev)
{
	return adev->flags.power_manageable;
}

static inline bool acpi_device_can_wakeup(struct acpi_device *adev)
{
	return adev->wakeup.flags.valid;
}

static inline bool acpi_device_can_poweroff(struct acpi_device *adev)
{
	return adev->power.states[ACPI_STATE_D3_COLD].flags.os_accessible;
}

#else	/* CONFIG_ACPI */

static inline int register_acpi_bus_type(void *bus) { return 0; }
static inline int unregister_acpi_bus_type(void *bus) { return 0; }

#endif				/* CONFIG_ACPI */

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