[deliverable/linux.git] / drivers / misc / thinkpad_acpi.h

/*
 *  thinkpad_acpi.h - ThinkPad ACPI Extras
 *
 *
 *  Copyright (C) 2004-2005 Borislav Deianov <borislav@users.sf.net>
 *  Copyright (C) 2006-2007 Henrique de Moraes Holschuh <hmh@hmh.eng.br>
 *
 *  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., 51 Franklin Street, Fifth Floor, Boston, MA
 *  02110-1301, USA.
 */

#ifndef __THINKPAD_ACPI_H__
#define __THINKPAD_ACPI_H__

#include <linux/kernel.h>
#include <linux/module.h>
#include <linux/init.h>
#include <linux/types.h>
#include <linux/string.h>
#include <linux/list.h>
#include <linux/mutex.h>

#include <linux/proc_fs.h>
#include <linux/sysfs.h>
#include <linux/backlight.h>
#include <linux/fb.h>
#include <linux/platform_device.h>
#include <linux/hwmon.h>
#include <linux/hwmon-sysfs.h>
#include <linux/input.h>
#include <asm/uaccess.h>

#include <linux/dmi.h>
#include <linux/jiffies.h>
#include <linux/workqueue.h>

#include <acpi/acpi_drivers.h>
#include <acpi/acnamesp.h>

#include <linux/pci_ids.h>

/****************************************************************************
 * Main driver
 */

#define IBM_NAME "thinkpad"
#define IBM_DESC "ThinkPad ACPI Extras"
#define IBM_FILE "thinkpad_acpi"
#define IBM_URL "http://ibm-acpi.sf.net/"
#define IBM_MAIL "ibm-acpi-devel@lists.sourceforge.net"

#define IBM_PROC_DIR "ibm"
#define IBM_ACPI_EVENT_PREFIX "ibm"
#define IBM_DRVR_NAME IBM_FILE

#define IBM_LOG IBM_FILE ": "
#define IBM_ERR	   KERN_ERR    IBM_LOG
#define IBM_NOTICE KERN_NOTICE IBM_LOG
#define IBM_INFO   KERN_INFO   IBM_LOG
#define IBM_DEBUG  KERN_DEBUG  IBM_LOG

#define IBM_MAX_ACPI_ARGS 3

/* ThinkPad CMOS commands */
#define TP_CMOS_VOLUME_DOWN	0
#define TP_CMOS_VOLUME_UP	1
#define TP_CMOS_VOLUME_MUTE	2
#define TP_CMOS_BRIGHTNESS_UP	4
#define TP_CMOS_BRIGHTNESS_DOWN	5

#define onoff(status,bit) ((status) & (1 << (bit)) ? "on" : "off")
#define enabled(status,bit) ((status) & (1 << (bit)) ? "enabled" : "disabled")
#define strlencmp(a,b) (strncmp((a), (b), strlen(b)))

/* Debugging */
#define TPACPI_DBG_ALL		0xffff
#define TPACPI_DBG_ALL		0xffff
#define TPACPI_DBG_INIT		0x0001
#define TPACPI_DBG_EXIT		0x0002
#define dbg_printk(a_dbg_level, format, arg...) \
	do { if (dbg_level & a_dbg_level) \
		printk(IBM_DEBUG "%s: " format, __func__ , ## arg); } while (0)
#ifdef CONFIG_THINKPAD_ACPI_DEBUG
#define vdbg_printk(a_dbg_level, format, arg...) \
	dbg_printk(a_dbg_level, format, ## arg)
static const char *str_supported(int is_supported);
#else
#define vdbg_printk(a_dbg_level, format, arg...)
#endif

/* Input IDs */
#define TPACPI_HKEY_INPUT_VENDOR	PCI_VENDOR_ID_IBM
#define TPACPI_HKEY_INPUT_PRODUCT	0x5054 /* "TP" */
#define TPACPI_HKEY_INPUT_VERSION	0x4101

/* ACPI HIDs */
#define IBM_HKEY_HID    "IBM0068"

/* ACPI helpers */
static int __must_check acpi_evalf(acpi_handle handle,
		      void *res, char *method, char *fmt, ...);
static int __must_check acpi_ec_read(int i, u8 * p);
static int __must_check acpi_ec_write(int i, u8 v);
static int __must_check _sta(acpi_handle handle);

/* ACPI handles */
static acpi_handle root_handle;			/* root namespace */
static acpi_handle ec_handle;			/* EC */
static acpi_handle ecrd_handle, ecwr_handle;	/* 570 EC access */
static acpi_handle cmos_handle, hkey_handle;	/* basic thinkpad handles */

static void drv_acpi_handle_init(char *name,
		   acpi_handle *handle, acpi_handle parent,
		   char **paths, int num_paths, char **path);
#define IBM_ACPIHANDLE_INIT(object)						\
	drv_acpi_handle_init(#object, &object##_handle, *object##_parent,	\
		object##_paths, ARRAY_SIZE(object##_paths), &object##_path)

/* ThinkPad ACPI helpers */
static int issue_thinkpad_cmos_command(int cmos_cmd);

/* procfs support */
static struct proc_dir_entry *proc_dir;

/* procfs helpers */
static int dispatch_procfs_read(char *page, char **start, off_t off,
		int count, int *eof, void *data);
static int dispatch_procfs_write(struct file *file,
		const char __user * userbuf,
		unsigned long count, void *data);
static char *next_cmd(char **cmds);

/* sysfs support */
struct attribute_set {
	unsigned int members, max_members;
	struct attribute_group group;
};

static struct attribute_set *create_attr_set(unsigned int max_members,
						const char* name);
#define destroy_attr_set(_set) \
	kfree(_set);
static int add_to_attr_set(struct attribute_set* s, struct attribute *attr);
static int add_many_to_attr_set(struct attribute_set* s,
			struct attribute **attr,
			unsigned int count);
#define register_attr_set_with_sysfs(_attr_set, _kobj) \
	sysfs_create_group(_kobj, &_attr_set->group)
static void delete_attr_set(struct attribute_set* s, struct kobject *kobj);

static int parse_strtoul(const char *buf, unsigned long max,
			unsigned long *value);

/* Device model */
static struct platform_device *tpacpi_pdev;
static struct class_device *tpacpi_hwmon;
static struct platform_driver tpacpi_pdriver;
static struct input_dev *tpacpi_inputdev;
static int tpacpi_create_driver_attributes(struct device_driver *drv);
static void tpacpi_remove_driver_attributes(struct device_driver *drv);

/* Module */
static int experimental;
static u32 dbg_level;
static int force_load;

static int thinkpad_acpi_module_init(void);
static void thinkpad_acpi_module_exit(void);


/****************************************************************************
 * Subdrivers
 */

struct ibm_struct;

struct tp_acpi_drv_struct {
	char *hid;
	struct acpi_driver *driver;

	void (*notify) (struct ibm_struct *, u32);
	acpi_handle *handle;
	u32 type;
	struct acpi_device *device;
};

struct ibm_struct {
	char *name;

	int (*read) (char *);
	int (*write) (char *);
	void (*exit) (void);
	void (*resume) (void);

	struct list_head all_drivers;

	struct tp_acpi_drv_struct *acpi;

	struct {
		u8 acpi_driver_registered:1;
		u8 acpi_notify_installed:1;
		u8 proc_created:1;
		u8 init_called:1;
		u8 experimental:1;
	} flags;
};

struct ibm_init_struct {
	char param[32];

	int (*init) (struct ibm_init_struct *);
	struct ibm_struct *data;
};

static struct {
#ifdef CONFIG_THINKPAD_ACPI_BAY
	u16 bay_status:1;
	u16 bay_eject:1;
	u16 bay_status2:1;
	u16 bay_eject2:1;
#endif
	u16 bluetooth:1;
	u16 hotkey:1;
	u16 hotkey_mask:1;
	u16 hotkey_wlsw:1;
	u16 light:1;
	u16 light_status:1;
	u16 wan:1;
	u16 fan_ctrl_status_undef:1;
	u16 input_device_registered:1;
} tp_features;

struct thinkpad_id_data {
	unsigned int vendor;	/* ThinkPad vendor:
				 * PCI_VENDOR_ID_IBM/PCI_VENDOR_ID_LENOVO */

	char *bios_version_str;	/* Something like 1ZET51WW (1.03z) */
	char *ec_version_str;	/* Something like 1ZHT51WW-1.04a */

	u16 bios_model;		/* Big Endian, TP-1Y = 0x5931, 0 = unknown */
	u16 ec_model;

	char *model_str;
};

static struct thinkpad_id_data thinkpad_id;

static struct list_head tpacpi_all_drivers;

static struct ibm_init_struct ibms_init[];
static int set_ibm_param(const char *val, struct kernel_param *kp);
static int ibm_init(struct ibm_init_struct *iibm);
static void ibm_exit(struct ibm_struct *ibm);


/*
 * procfs master subdriver
 */
static int thinkpad_acpi_driver_init(struct ibm_init_struct *iibm);
static int thinkpad_acpi_driver_read(char *p);


/*
 * Bay subdriver
 */

#ifdef CONFIG_THINKPAD_ACPI_BAY
static acpi_handle bay_handle, bay_ej_handle;
static acpi_handle bay2_handle, bay2_ej_handle;

static int bay_init(struct ibm_init_struct *iibm);
static void bay_notify(struct ibm_struct *ibm, u32 event);
static int bay_read(char *p);
static int bay_write(char *buf);
#endif /* CONFIG_THINKPAD_ACPI_BAY */


/*
 * Beep subdriver
 */

static acpi_handle beep_handle;

static int beep_read(char *p);
static int beep_write(char *buf);


/*
 * Bluetooth subdriver
 */

enum {
	/* ACPI GBDC/SBDC bits */
	TP_ACPI_BLUETOOTH_HWPRESENT	= 0x01,	/* Bluetooth hw available */
	TP_ACPI_BLUETOOTH_RADIOSSW	= 0x02,	/* Bluetooth radio enabled */
	TP_ACPI_BLUETOOTH_UNK		= 0x04,	/* unknown function */
};

static int bluetooth_init(struct ibm_init_struct *iibm);
static int bluetooth_get_radiosw(void);
static int bluetooth_set_radiosw(int radio_on);
static int bluetooth_read(char *p);
static int bluetooth_write(char *buf);


/*
 * Brightness (backlight) subdriver
 */

#define TPACPI_BACKLIGHT_DEV_NAME "thinkpad_screen"

static struct backlight_device *ibm_backlight_device;
static int brightness_offset = 0x31;

static int brightness_init(struct ibm_init_struct *iibm);
static void brightness_exit(void);
static int brightness_get(struct backlight_device *bd);
static int brightness_set(int value);
static int brightness_update_status(struct backlight_device *bd);
static int brightness_read(char *p);
static int brightness_write(char *buf);


/*
 * CMOS subdriver
 */

static int cmos_read(char *p);
static int cmos_write(char *buf);


/*
 * Dock subdriver
 */

#ifdef CONFIG_THINKPAD_ACPI_DOCK
static acpi_handle pci_handle;
static acpi_handle dock_handle;

static void dock_notify(struct ibm_struct *ibm, u32 event);
static int dock_read(char *p);
static int dock_write(char *buf);
#endif /* CONFIG_THINKPAD_ACPI_DOCK */


/*
 * EC dump subdriver
 */

static int ecdump_read(char *p) ;
static int ecdump_write(char *buf);


/*
 * Fan subdriver
 */

enum {					/* Fan control constants */
	fan_status_offset = 0x2f,	/* EC register 0x2f */
	fan_rpm_offset = 0x84,		/* EC register 0x84: LSB, 0x85 MSB (RPM)
					 * 0x84 must be read before 0x85 */

	TP_EC_FAN_FULLSPEED = 0x40,	/* EC fan mode: full speed */
	TP_EC_FAN_AUTO	    = 0x80,	/* EC fan mode: auto fan control */

	TPACPI_FAN_LAST_LEVEL = 0x100,	/* Use cached last-seen fan level */
};

enum fan_status_access_mode {
	TPACPI_FAN_NONE = 0,		/* No fan status or control */
	TPACPI_FAN_RD_ACPI_GFAN,	/* Use ACPI GFAN */
	TPACPI_FAN_RD_TPEC,		/* Use ACPI EC regs 0x2f, 0x84-0x85 */
};

enum fan_control_access_mode {
	TPACPI_FAN_WR_NONE = 0,		/* No fan control */
	TPACPI_FAN_WR_ACPI_SFAN,	/* Use ACPI SFAN */
	TPACPI_FAN_WR_TPEC,		/* Use ACPI EC reg 0x2f */
	TPACPI_FAN_WR_ACPI_FANS,	/* Use ACPI FANS and EC reg 0x2f */
};

enum fan_control_commands {
	TPACPI_FAN_CMD_SPEED 	= 0x0001,	/* speed command */
	TPACPI_FAN_CMD_LEVEL 	= 0x0002,	/* level command  */
	TPACPI_FAN_CMD_ENABLE	= 0x0004,	/* enable/disable cmd,
						 * and also watchdog cmd */
};

static int fan_control_allowed;

static enum fan_status_access_mode fan_status_access_mode;
static enum fan_control_access_mode fan_control_access_mode;
static enum fan_control_commands fan_control_commands;
static u8 fan_control_initial_status;
static u8 fan_control_desired_level;
static int fan_watchdog_maxinterval;

static struct mutex fan_mutex;

static acpi_handle fans_handle, gfan_handle, sfan_handle;

static int fan_init(struct ibm_init_struct *iibm);
static void fan_exit(void);
static int fan_get_status(u8 *status);
static int fan_get_status_safe(u8 *status);
static int fan_get_speed(unsigned int *speed);
static void fan_update_desired_level(u8 status);
static void fan_watchdog_fire(struct work_struct *ignored);
static void fan_watchdog_reset(void);
static int fan_set_level(int level);
static int fan_set_level_safe(int level);
static int fan_set_enable(void);
static int fan_set_disable(void);
static int fan_set_speed(int speed);
static int fan_read(char *p);
static int fan_write(char *buf);
static int fan_write_cmd_level(const char *cmd, int *rc);
static int fan_write_cmd_enable(const char *cmd, int *rc);
static int fan_write_cmd_disable(const char *cmd, int *rc);
static int fan_write_cmd_speed(const char *cmd, int *rc);
static int fan_write_cmd_watchdog(const char *cmd, int *rc);


/*
 * Hotkey subdriver
 */

static int hotkey_orig_status;
static u32 hotkey_orig_mask;

static struct mutex hotkey_mutex;

static int hotkey_init(struct ibm_init_struct *iibm);
static void hotkey_exit(void);
static int hotkey_get(int *status, u32 *mask);
static int hotkey_set(int status, u32 mask);
static void hotkey_notify(struct ibm_struct *ibm, u32 event);
static int hotkey_read(char *p);
static int hotkey_write(char *buf);


/*
 * LED subdriver
 */

enum led_access_mode {
	TPACPI_LED_NONE = 0,
	TPACPI_LED_570,	/* 570 */
	TPACPI_LED_OLD,	/* 600e/x, 770e, 770x, A21e, A2xm/p, T20-22, X20-21 */
	TPACPI_LED_NEW,	/* all others */
};

enum {	/* For TPACPI_LED_OLD */
	TPACPI_LED_EC_HLCL = 0x0c,	/* EC reg to get led to power on */
	TPACPI_LED_EC_HLBL = 0x0d,	/* EC reg to blink a lit led */
	TPACPI_LED_EC_HLMS = 0x0e,	/* EC reg to select led to command */
};

static enum led_access_mode led_supported;
static acpi_handle led_handle;

static int led_init(struct ibm_init_struct *iibm);
static int led_read(char *p);
static int led_write(char *buf);

/*
 * Light (thinklight) subdriver
 */

static acpi_handle lght_handle, ledb_handle;

static int light_init(struct ibm_init_struct *iibm);
static int light_read(char *p);
static int light_write(char *buf);


/*
 * Thermal subdriver
 */

enum thermal_access_mode {
	TPACPI_THERMAL_NONE = 0,	/* No thermal support */
	TPACPI_THERMAL_ACPI_TMP07,	/* Use ACPI TMP0-7 */
	TPACPI_THERMAL_ACPI_UPDT,	/* Use ACPI TMP0-7 with UPDT */
	TPACPI_THERMAL_TPEC_8,		/* Use ACPI EC regs, 8 sensors */
	TPACPI_THERMAL_TPEC_16,		/* Use ACPI EC regs, 16 sensors */
};

enum { /* TPACPI_THERMAL_TPEC_* */
	TP_EC_THERMAL_TMP0 = 0x78,	/* ACPI EC regs TMP 0..7 */
	TP_EC_THERMAL_TMP8 = 0xC0,	/* ACPI EC regs TMP 8..15 */
	TP_EC_THERMAL_TMP_NA = -128,	/* ACPI EC sensor not available */
};

#define TPACPI_MAX_THERMAL_SENSORS 16	/* Max thermal sensors supported */
struct ibm_thermal_sensors_struct {
	s32 temp[TPACPI_MAX_THERMAL_SENSORS];
};

static enum thermal_access_mode thermal_read_mode;

static int thermal_init(struct ibm_init_struct *iibm);
static int thermal_get_sensor(int idx, s32 *value);
static int thermal_get_sensors(struct ibm_thermal_sensors_struct *s);
static int thermal_read(char *p);


/*
 * Video subdriver
 */

enum video_access_mode {
	TPACPI_VIDEO_NONE = 0,
	TPACPI_VIDEO_570,	/* 570 */
	TPACPI_VIDEO_770,	/* 600e/x, 770e, 770x */
	TPACPI_VIDEO_NEW,	/* all others */
};

enum {	/* video status flags, based on VIDEO_570 */
	TP_ACPI_VIDEO_S_LCD = 0x01,	/* LCD output enabled */
	TP_ACPI_VIDEO_S_CRT = 0x02,	/* CRT output enabled */
	TP_ACPI_VIDEO_S_DVI = 0x08,	/* DVI output enabled */
};

enum {  /* TPACPI_VIDEO_570 constants */
	TP_ACPI_VIDEO_570_PHSCMD = 0x87,	/* unknown magic constant :( */
	TP_ACPI_VIDEO_570_PHSMASK = 0x03,	/* PHS bits that map to
						 * video_status_flags */
	TP_ACPI_VIDEO_570_PHS2CMD = 0x8b,	/* unknown magic constant :( */
	TP_ACPI_VIDEO_570_PHS2SET = 0x80,	/* unknown magic constant :( */
};

static enum video_access_mode video_supported;
static int video_orig_autosw;
static acpi_handle vid_handle, vid2_handle;

static int video_init(struct ibm_init_struct *iibm);
static void video_exit(void);
static int video_outputsw_get(void);
static int video_outputsw_set(int status);
static int video_autosw_get(void);
static int video_autosw_set(int enable);
static int video_outputsw_cycle(void);
static int video_expand_toggle(void);
static int video_read(char *p);
static int video_write(char *buf);


/*
 * Volume subdriver
 */

static int volume_offset = 0x30;

static int volume_read(char *p);
static int volume_write(char *buf);


/*
 * Wan subdriver
 */

enum {
	/* ACPI GWAN/SWAN bits */
	TP_ACPI_WANCARD_HWPRESENT	= 0x01,	/* Wan hw available */
	TP_ACPI_WANCARD_RADIOSSW	= 0x02,	/* Wan radio enabled */
	TP_ACPI_WANCARD_UNK		= 0x04,	/* unknown function */
};

static int wan_init(struct ibm_init_struct *iibm);
static int wan_get_radiosw(void);
static int wan_set_radiosw(int radio_on);
static int wan_read(char *p);
static int wan_write(char *buf);


#endif /* __THINKPAD_ACPI_H */
Commit	Line	Data
1406cdd1	1	/*
643f12db	2	* thinkpad_acpi.h - ThinkPad ACPI Extras
1406cdd1 HMH	3	*
	4	*
	5	* Copyright (C) 2004-2005 Borislav Deianov <borislav@users.sf.net>
	6	* Copyright (C) 2006-2007 Henrique de Moraes Holschuh <hmh@hmh.eng.br>
	7	*
	8	* This program is free software; you can redistribute it and/or modify
	9	* it under the terms of the GNU General Public License as published by
	10	* the Free Software Foundation; either version 2 of the License, or
	11	* (at your option) any later version.
	12	*
	13	* This program is distributed in the hope that it will be useful,
	14	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	15	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	16	* GNU General Public License for more details.
	17	*
	18	* You should have received a copy of the GNU General Public License
	19	* along with this program; if not, write to the Free Software
	20	* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
	21	* 02110-1301, USA.
	22	*/
	23
643f12db HMH	24	#ifndef __THINKPAD_ACPI_H__
643f12db HMH	25	#define __THINKPAD_ACPI_H__
1406cdd1 HMH	26
	27	#include <linux/kernel.h>
	28	#include <linux/module.h>
	29	#include <linux/init.h>
	30	#include <linux/types.h>
	31	#include <linux/string.h>
a5763f22	32	#include <linux/list.h>
40ca9fdf	33	#include <linux/mutex.h>
1406cdd1 HMH	34
1406cdd1 HMH	35	#include <linux/proc_fs.h>
176750d6	36	#include <linux/sysfs.h>
1406cdd1 HMH	37	#include <linux/backlight.h>
1406cdd1 HMH	38	#include <linux/fb.h>
54ae1501 HMH	39	#include <linux/platform_device.h>
54ae1501 HMH	40	#include <linux/hwmon.h>
2c37aa4e	41	#include <linux/hwmon-sysfs.h>
7f5d1cd6	42	#include <linux/input.h>
1406cdd1 HMH	43	#include <asm/uaccess.h>
	44
	45	#include <linux/dmi.h>
	46	#include <linux/jiffies.h>
	47	#include <linux/workqueue.h>
	48
	49	#include <acpi/acpi_drivers.h>
	50	#include <acpi/acnamesp.h>
	51
7f5d1cd6	52	#include <linux/pci_ids.h>
1406cdd1 HMH	53
	54	/****************************************************************************
	55	* Main driver
	56	*/
	57
643f12db HMH	58	#define IBM_NAME "thinkpad"
	59	#define IBM_DESC "ThinkPad ACPI Extras"
	60	#define IBM_FILE "thinkpad_acpi"
1406cdd1	61	#define IBM_URL "http://ibm-acpi.sf.net/"
8d376cd6	62	#define IBM_MAIL "ibm-acpi-devel@lists.sourceforge.net"
1406cdd1	63
8d376cd6	64	#define IBM_PROC_DIR "ibm"
643f12db	65	#define IBM_ACPI_EVENT_PREFIX "ibm"
54ae1501	66	#define IBM_DRVR_NAME IBM_FILE
1406cdd1 HMH	67
	68	#define IBM_LOG IBM_FILE ": "
	69	#define IBM_ERR KERN_ERR IBM_LOG
	70	#define IBM_NOTICE KERN_NOTICE IBM_LOG
	71	#define IBM_INFO KERN_INFO IBM_LOG
	72	#define IBM_DEBUG KERN_DEBUG IBM_LOG
	73
	74	#define IBM_MAX_ACPI_ARGS 3
	75
	76	/* ThinkPad CMOS commands */
	77	#define TP_CMOS_VOLUME_DOWN 0
	78	#define TP_CMOS_VOLUME_UP 1
	79	#define TP_CMOS_VOLUME_MUTE 2
	80	#define TP_CMOS_BRIGHTNESS_UP 4
	81	#define TP_CMOS_BRIGHTNESS_DOWN 5
	82
	83	#define onoff(status,bit) ((status) & (1 << (bit)) ? "on" : "off")
	84	#define enabled(status,bit) ((status) & (1 << (bit)) ? "enabled" : "disabled")
	85	#define strlencmp(a,b) (strncmp((a), (b), strlen(b)))
	86
132ce091 HMH	87	/* Debugging */
132ce091 HMH	88	#define TPACPI_DBG_ALL 0xffff
fe08bc4b HMH	89	#define TPACPI_DBG_ALL 0xffff
	90	#define TPACPI_DBG_INIT 0x0001
	91	#define TPACPI_DBG_EXIT 0x0002
132ce091 HMH	92	#define dbg_printk(a_dbg_level, format, arg...) \
	93	do { if (dbg_level & a_dbg_level) \
	94	printk(IBM_DEBUG "%s: " format, __func__ , ## arg); } while (0)
	95	#ifdef CONFIG_THINKPAD_ACPI_DEBUG
	96	#define vdbg_printk(a_dbg_level, format, arg...) \
	97	dbg_printk(a_dbg_level, format, ## arg)
fe08bc4b	98	static const char *str_supported(int is_supported);
132ce091 HMH	99	#else
	100	#define vdbg_printk(a_dbg_level, format, arg...)
	101	#endif
	102
7f5d1cd6 HMH	103	/* Input IDs */
	104	#define TPACPI_HKEY_INPUT_VENDOR PCI_VENDOR_ID_IBM
	105	#define TPACPI_HKEY_INPUT_PRODUCT 0x5054 /* "TP" */
	106	#define TPACPI_HKEY_INPUT_VERSION 0x4101
	107
1406cdd1 HMH	108	/* ACPI HIDs */
1406cdd1 HMH	109	#define IBM_HKEY_HID "IBM0068"
1406cdd1 HMH	110
1406cdd1 HMH	111	/* ACPI helpers */
d01320e6	112	static int __must_check acpi_evalf(acpi_handle handle,
1406cdd1	113	void res, char method, char *fmt, ...);
d01320e6 HMH	114	static int __must_check acpi_ec_read(int i, u8 * p);
	115	static int __must_check acpi_ec_write(int i, u8 v);
	116	static int __must_check _sta(acpi_handle handle);
1406cdd1 HMH	117
	118	/* ACPI handles */
	119	static acpi_handle root_handle; /* root namespace */
	120	static acpi_handle ec_handle; /* EC */
	121	static acpi_handle ecrd_handle, ecwr_handle; /* 570 EC access */
	122	static acpi_handle cmos_handle, hkey_handle; /* basic thinkpad handles */
	123
8d376cd6	124	static void drv_acpi_handle_init(char *name,
5fba344c	125	acpi_handle *handle, acpi_handle parent,
1406cdd1	126	char paths, int num_paths, char path);
8d376cd6 HMH	127	#define IBM_ACPIHANDLE_INIT(object) \
8d376cd6 HMH	128	drv_acpi_handle_init(#object, &object##_handle, *object##_parent, \
1406cdd1 HMH	129	object##_paths, ARRAY_SIZE(object##_paths), &object##_path)
1406cdd1 HMH	130
c9bea99c HMH	131	/* ThinkPad ACPI helpers */
	132	static int issue_thinkpad_cmos_command(int cmos_cmd);
	133
1406cdd1 HMH	134	/* procfs support */
1406cdd1 HMH	135	static struct proc_dir_entry *proc_dir;
1406cdd1 HMH	136
1406cdd1 HMH	137	/* procfs helpers */
8d376cd6 HMH	138	static int dispatch_procfs_read(char page, char *start, off_t off,
	139	int count, int eof, void data);
	140	static int dispatch_procfs_write(struct file *file,
	141	const char __user * userbuf,
1406cdd1 HMH	142	unsigned long count, void *data);
	143	static char next_cmd(char *cmds);
	144
7252374a HMH	145	/* sysfs support */
	146	struct attribute_set {
	147	unsigned int members, max_members;
	148	struct attribute_group group;
	149	};
	150
	151	static struct attribute_set *create_attr_set(unsigned int max_members,
	152	const char* name);
	153	#define destroy_attr_set(_set) \
	154	kfree(_set);
	155	static int add_to_attr_set(struct attribute_set* s, struct attribute *attr);
	156	static int add_many_to_attr_set(struct attribute_set* s,
	157	struct attribute **attr,
	158	unsigned int count);
	159	#define register_attr_set_with_sysfs(_attr_set, _kobj) \
	160	sysfs_create_group(_kobj, &_attr_set->group)
	161	static void delete_attr_set(struct attribute_set* s, struct kobject *kobj);
	162
	163	static int parse_strtoul(const char *buf, unsigned long max,
	164	unsigned long *value);
	165
54ae1501 HMH	166	/* Device model */
	167	static struct platform_device *tpacpi_pdev;
	168	static struct class_device *tpacpi_hwmon;
	169	static struct platform_driver tpacpi_pdriver;
7f5d1cd6	170	static struct input_dev *tpacpi_inputdev;
176750d6 HMH	171	static int tpacpi_create_driver_attributes(struct device_driver *drv);
176750d6 HMH	172	static void tpacpi_remove_driver_attributes(struct device_driver *drv);
54ae1501	173
1406cdd1 HMH	174	/* Module */
1406cdd1 HMH	175	static int experimental;
132ce091	176	static u32 dbg_level;
0dcef77c	177	static int force_load;
1406cdd1	178
1def7115 HMH	179	static int thinkpad_acpi_module_init(void);
1def7115 HMH	180	static void thinkpad_acpi_module_exit(void);
1406cdd1 HMH	181
	182
	183	/****************************************************************************
	184	* Subdrivers
	185	*/
	186
8d376cd6	187	struct ibm_struct;
1406cdd1	188
8d376cd6	189	struct tp_acpi_drv_struct {
1406cdd1 HMH	190	char *hid;
	191	struct acpi_driver *driver;
	192
1406cdd1 HMH	193	void (notify) (struct ibm_struct , u32);
1406cdd1 HMH	194	acpi_handle *handle;
8d376cd6	195	u32 type;
1406cdd1	196	struct acpi_device *device;
8d376cd6 HMH	197	};
	198
	199	struct ibm_struct {
	200	char *name;
	201
	202	int (read) (char );
	203	int (write) (char );
	204	void (*exit) (void);
e295e850	205	void (*resume) (void);
1406cdd1	206
a5763f22 HMH	207	struct list_head all_drivers;
a5763f22 HMH	208
8d376cd6 HMH	209	struct tp_acpi_drv_struct *acpi;
8d376cd6 HMH	210
92641177	211	struct {
8d376cd6 HMH	212	u8 acpi_driver_registered:1;
8d376cd6 HMH	213	u8 acpi_notify_installed:1;
92641177 HMH	214	u8 proc_created:1;
92641177 HMH	215	u8 init_called:1;
92641177 HMH	216	u8 experimental:1;
92641177 HMH	217	} flags;
1406cdd1 HMH	218	};
1406cdd1 HMH	219
a5763f22 HMH	220	struct ibm_init_struct {
	221	char param[32];
	222
	223	int (init) (struct ibm_init_struct );
	224	struct ibm_struct *data;
	225	};
	226
d8fd94d9 HMH	227	static struct {
	228	#ifdef CONFIG_THINKPAD_ACPI_BAY
	229	u16 bay_status:1;
	230	u16 bay_eject:1;
	231	u16 bay_status2:1;
	232	u16 bay_eject2:1;
	233	#endif
	234	u16 bluetooth:1;
	235	u16 hotkey:1;
	236	u16 hotkey_mask:1;
74941a69	237	u16 hotkey_wlsw:1;
d8fd94d9 HMH	238	u16 light:1;
	239	u16 light_status:1;
	240	u16 wan:1;
	241	u16 fan_ctrl_status_undef:1;
7f5d1cd6	242	u16 input_device_registered:1;
d8fd94d9 HMH	243	} tp_features;
d8fd94d9 HMH	244
d5a2f2f1 HMH	245	struct thinkpad_id_data {
	246	unsigned int vendor; /* ThinkPad vendor:
	247	* PCI_VENDOR_ID_IBM/PCI_VENDOR_ID_LENOVO */
	248
	249	char bios_version_str; / Something like 1ZET51WW (1.03z) */
	250	char ec_version_str; / Something like 1ZHT51WW-1.04a */
	251
	252	u16 bios_model; /* Big Endian, TP-1Y = 0x5931, 0 = unknown */
	253	u16 ec_model;
	254
	255	char *model_str;
	256	};
	257
	258	static struct thinkpad_id_data thinkpad_id;
	259
a5763f22 HMH	260	static struct list_head tpacpi_all_drivers;
	261
	262	static struct ibm_init_struct ibms_init[];
1406cdd1	263	static int set_ibm_param(const char val, struct kernel_param kp);
a5763f22	264	static int ibm_init(struct ibm_init_struct *iibm);
1406cdd1 HMH	265	static void ibm_exit(struct ibm_struct *ibm);
1406cdd1 HMH	266
a5763f22 HMH	267
	268	/*
	269	* procfs master subdriver
	270	*/
	271	static int thinkpad_acpi_driver_init(struct ibm_init_struct *iibm);
	272	static int thinkpad_acpi_driver_read(char *p);
1406cdd1 HMH	273
	274
	275	/*
	276	* Bay subdriver
	277	*/
	278
85998248	279	#ifdef CONFIG_THINKPAD_ACPI_BAY
1406cdd1 HMH	280	static acpi_handle bay_handle, bay_ej_handle;
	281	static acpi_handle bay2_handle, bay2_ej_handle;
	282
a5763f22	283	static int bay_init(struct ibm_init_struct *iibm);
1406cdd1 HMH	284	static void bay_notify(struct ibm_struct *ibm, u32 event);
	285	static int bay_read(char *p);
	286	static int bay_write(char *buf);
85998248	287	#endif /* CONFIG_THINKPAD_ACPI_BAY */
1406cdd1 HMH	288
	289
	290	/*
	291	* Beep subdriver
	292	*/
	293
	294	static acpi_handle beep_handle;
	295
	296	static int beep_read(char *p);
	297	static int beep_write(char *buf);
	298
	299
	300	/*
	301	* Bluetooth subdriver
	302	*/
	303
d6fdd1e9 HMH	304	enum {
	305	/* ACPI GBDC/SBDC bits */
	306	TP_ACPI_BLUETOOTH_HWPRESENT = 0x01, /* Bluetooth hw available */
	307	TP_ACPI_BLUETOOTH_RADIOSSW = 0x02, /* Bluetooth radio enabled */
	308	TP_ACPI_BLUETOOTH_UNK = 0x04, /* unknown function */
	309	};
	310
a5763f22	311	static int bluetooth_init(struct ibm_init_struct *iibm);
d6fdd1e9 HMH	312	static int bluetooth_get_radiosw(void);
d6fdd1e9 HMH	313	static int bluetooth_set_radiosw(int radio_on);
1406cdd1 HMH	314	static int bluetooth_read(char *p);
	315	static int bluetooth_write(char *buf);
	316
	317
	318	/*
	319	* Brightness (backlight) subdriver
	320	*/
	321
7d5a015e HMH	322	#define TPACPI_BACKLIGHT_DEV_NAME "thinkpad_screen"
7d5a015e HMH	323
1406cdd1 HMH	324	static struct backlight_device *ibm_backlight_device;
	325	static int brightness_offset = 0x31;
	326
a5763f22	327	static int brightness_init(struct ibm_init_struct *iibm);
1406cdd1 HMH	328	static void brightness_exit(void);
	329	static int brightness_get(struct backlight_device *bd);
	330	static int brightness_set(int value);
	331	static int brightness_update_status(struct backlight_device *bd);
	332	static int brightness_read(char *p);
	333	static int brightness_write(char *buf);
	334
	335
	336	/*
	337	* CMOS subdriver
	338	*/
	339
1406cdd1 HMH	340	static int cmos_read(char *p);
	341	static int cmos_write(char *buf);
	342
	343
	344	/*
	345	* Dock subdriver
	346	*/
	347
85998248	348	#ifdef CONFIG_THINKPAD_ACPI_DOCK
5fba344c	349	static acpi_handle pci_handle;
1406cdd1 HMH	350	static acpi_handle dock_handle;
	351
	352	static void dock_notify(struct ibm_struct *ibm, u32 event);
	353	static int dock_read(char *p);
	354	static int dock_write(char *buf);
85998248	355	#endif /* CONFIG_THINKPAD_ACPI_DOCK */
1406cdd1 HMH	356
	357
	358	/*
	359	* EC dump subdriver
	360	*/
	361
	362	static int ecdump_read(char *p) ;
	363	static int ecdump_write(char *buf);
	364
	365
	366	/*
	367	* Fan subdriver
	368	*/
	369
	370	enum { /* Fan control constants */
	371	fan_status_offset = 0x2f, /* EC register 0x2f */
	372	fan_rpm_offset = 0x84, /* EC register 0x84: LSB, 0x85 MSB (RPM)
	373	* 0x84 must be read before 0x85 */
	374
efa27145 HMH	375	TP_EC_FAN_FULLSPEED = 0x40, /* EC fan mode: full speed */
efa27145 HMH	376	TP_EC_FAN_AUTO = 0x80, /* EC fan mode: auto fan control */
fe98a52c HMH	377
fe98a52c HMH	378	TPACPI_FAN_LAST_LEVEL = 0x100, /* Use cached last-seen fan level */
1406cdd1 HMH	379	};
	380
	381	enum fan_status_access_mode {
efa27145 HMH	382	TPACPI_FAN_NONE = 0, /* No fan status or control */
	383	TPACPI_FAN_RD_ACPI_GFAN, /* Use ACPI GFAN */
	384	TPACPI_FAN_RD_TPEC, /* Use ACPI EC regs 0x2f, 0x84-0x85 */
1406cdd1 HMH	385	};
	386
	387	enum fan_control_access_mode {
efa27145 HMH	388	TPACPI_FAN_WR_NONE = 0, /* No fan control */
	389	TPACPI_FAN_WR_ACPI_SFAN, /* Use ACPI SFAN */
	390	TPACPI_FAN_WR_TPEC, /* Use ACPI EC reg 0x2f */
	391	TPACPI_FAN_WR_ACPI_FANS, /* Use ACPI FANS and EC reg 0x2f */
1406cdd1 HMH	392	};
	393
	394	enum fan_control_commands {
efa27145 HMH	395	TPACPI_FAN_CMD_SPEED = 0x0001, /* speed command */
	396	TPACPI_FAN_CMD_LEVEL = 0x0002, /* level command */
	397	TPACPI_FAN_CMD_ENABLE = 0x0004, /* enable/disable cmd,
1406cdd1 HMH	398	* and also watchdog cmd */
	399	};
	400
ecf2a80a HMH	401	static int fan_control_allowed;
ecf2a80a HMH	402
1406cdd1 HMH	403	static enum fan_status_access_mode fan_status_access_mode;
	404	static enum fan_control_access_mode fan_control_access_mode;
	405	static enum fan_control_commands fan_control_commands;
1406cdd1	406	static u8 fan_control_initial_status;
fe98a52c	407	static u8 fan_control_desired_level;
1406cdd1 HMH	408	static int fan_watchdog_maxinterval;
1406cdd1 HMH	409
836a53f4	410	static struct mutex fan_mutex;
40ca9fdf	411
1406cdd1 HMH	412	static acpi_handle fans_handle, gfan_handle, sfan_handle;
1406cdd1 HMH	413
a5763f22	414	static int fan_init(struct ibm_init_struct *iibm);
1406cdd1 HMH	415	static void fan_exit(void);
1406cdd1 HMH	416	static int fan_get_status(u8 *status);
fe98a52c	417	static int fan_get_status_safe(u8 *status);
1406cdd1	418	static int fan_get_speed(unsigned int *speed);
fe98a52c	419	static void fan_update_desired_level(u8 status);
1406cdd1 HMH	420	static void fan_watchdog_fire(struct work_struct *ignored);
	421	static void fan_watchdog_reset(void);
	422	static int fan_set_level(int level);
fe98a52c	423	static int fan_set_level_safe(int level);
1406cdd1 HMH	424	static int fan_set_enable(void);
	425	static int fan_set_disable(void);
	426	static int fan_set_speed(int speed);
	427	static int fan_read(char *p);
	428	static int fan_write(char *buf);
	429	static int fan_write_cmd_level(const char cmd, int rc);
	430	static int fan_write_cmd_enable(const char cmd, int rc);
	431	static int fan_write_cmd_disable(const char cmd, int rc);
	432	static int fan_write_cmd_speed(const char cmd, int rc);
	433	static int fan_write_cmd_watchdog(const char cmd, int rc);
	434
	435
	436	/*
	437	* Hotkey subdriver
	438	*/
	439
1406cdd1	440	static int hotkey_orig_status;
ae92bd17	441	static u32 hotkey_orig_mask;
1406cdd1	442
40ca9fdf HMH	443	static struct mutex hotkey_mutex;
40ca9fdf HMH	444
a5763f22	445	static int hotkey_init(struct ibm_init_struct *iibm);
1406cdd1	446	static void hotkey_exit(void);
ae92bd17 HMH	447	static int hotkey_get(int status, u32 mask);
ae92bd17 HMH	448	static int hotkey_set(int status, u32 mask);
1406cdd1 HMH	449	static void hotkey_notify(struct ibm_struct *ibm, u32 event);
	450	static int hotkey_read(char *p);
	451	static int hotkey_write(char *buf);
	452
	453
	454	/*
	455	* LED subdriver
	456	*/
	457
	458	enum led_access_mode {
efa27145 HMH	459	TPACPI_LED_NONE = 0,
	460	TPACPI_LED_570, /* 570 */
	461	TPACPI_LED_OLD, /* 600e/x, 770e, 770x, A21e, A2xm/p, T20-22, X20-21 */
	462	TPACPI_LED_NEW, /* all others */
1406cdd1 HMH	463	};
1406cdd1 HMH	464
efa27145 HMH	465	enum { /* For TPACPI_LED_OLD */
	466	TPACPI_LED_EC_HLCL = 0x0c, /* EC reg to get led to power on */
	467	TPACPI_LED_EC_HLBL = 0x0d, /* EC reg to blink a lit led */
	468	TPACPI_LED_EC_HLMS = 0x0e, /* EC reg to select led to command */
1406cdd1 HMH	469	};
	470
	471	static enum led_access_mode led_supported;
	472	static acpi_handle led_handle;
	473
a5763f22	474	static int led_init(struct ibm_init_struct *iibm);
1406cdd1 HMH	475	static int led_read(char *p);
	476	static int led_write(char *buf);
	477
	478	/*
	479	* Light (thinklight) subdriver
	480	*/
	481
1406cdd1 HMH	482	static acpi_handle lght_handle, ledb_handle;
1406cdd1 HMH	483
a5763f22	484	static int light_init(struct ibm_init_struct *iibm);
1406cdd1 HMH	485	static int light_read(char *p);
	486	static int light_write(char *buf);
	487
	488
	489	/*
	490	* Thermal subdriver
	491	*/
	492
	493	enum thermal_access_mode {
efa27145 HMH	494	TPACPI_THERMAL_NONE = 0, /* No thermal support */
	495	TPACPI_THERMAL_ACPI_TMP07, /* Use ACPI TMP0-7 */
	496	TPACPI_THERMAL_ACPI_UPDT, /* Use ACPI TMP0-7 with UPDT */
	497	TPACPI_THERMAL_TPEC_8, /* Use ACPI EC regs, 8 sensors */
	498	TPACPI_THERMAL_TPEC_16, /* Use ACPI EC regs, 16 sensors */
1406cdd1 HMH	499	};
1406cdd1 HMH	500
04cc862c HMH	501	enum { /* TPACPI_THERMAL_TPEC_* */
	502	TP_EC_THERMAL_TMP0 = 0x78, /* ACPI EC regs TMP 0..7 */
	503	TP_EC_THERMAL_TMP8 = 0xC0, /* ACPI EC regs TMP 8..15 */
2c37aa4e	504	TP_EC_THERMAL_TMP_NA = -128, /* ACPI EC sensor not available */
04cc862c HMH	505	};
04cc862c HMH	506
efa27145	507	#define TPACPI_MAX_THERMAL_SENSORS 16 /* Max thermal sensors supported */
1406cdd1	508	struct ibm_thermal_sensors_struct {
efa27145	509	s32 temp[TPACPI_MAX_THERMAL_SENSORS];
1406cdd1 HMH	510	};
1406cdd1 HMH	511
04cc862c HMH	512	static enum thermal_access_mode thermal_read_mode;
04cc862c HMH	513
a5763f22	514	static int thermal_init(struct ibm_init_struct *iibm);
04cc862c	515	static int thermal_get_sensor(int idx, s32 *value);
1406cdd1 HMH	516	static int thermal_get_sensors(struct ibm_thermal_sensors_struct *s);
	517	static int thermal_read(char *p);
	518
	519
	520	/*
	521	* Video subdriver
	522	*/
	523
	524	enum video_access_mode {
efa27145 HMH	525	TPACPI_VIDEO_NONE = 0,
	526	TPACPI_VIDEO_570, /* 570 */
	527	TPACPI_VIDEO_770, /* 600e/x, 770e, 770x */
	528	TPACPI_VIDEO_NEW, /* all others */
1406cdd1 HMH	529	};
1406cdd1 HMH	530
83f34724 HMH	531	enum { /* video status flags, based on VIDEO_570 */
	532	TP_ACPI_VIDEO_S_LCD = 0x01, /* LCD output enabled */
	533	TP_ACPI_VIDEO_S_CRT = 0x02, /* CRT output enabled */
	534	TP_ACPI_VIDEO_S_DVI = 0x08, /* DVI output enabled */
	535	};
	536
	537	enum { /* TPACPI_VIDEO_570 constants */
	538	TP_ACPI_VIDEO_570_PHSCMD = 0x87, /* unknown magic constant :( */
	539	TP_ACPI_VIDEO_570_PHSMASK = 0x03, /* PHS bits that map to
	540	* video_status_flags */
	541	TP_ACPI_VIDEO_570_PHS2CMD = 0x8b, /* unknown magic constant :( */
	542	TP_ACPI_VIDEO_570_PHS2SET = 0x80, /* unknown magic constant :( */
	543	};
	544
1406cdd1 HMH	545	static enum video_access_mode video_supported;
	546	static int video_orig_autosw;
	547	static acpi_handle vid_handle, vid2_handle;
	548
a5763f22	549	static int video_init(struct ibm_init_struct *iibm);
1406cdd1	550	static void video_exit(void);
83f34724 HMH	551	static int video_outputsw_get(void);
	552	static int video_outputsw_set(int status);
	553	static int video_autosw_get(void);
	554	static int video_autosw_set(int enable);
	555	static int video_outputsw_cycle(void);
	556	static int video_expand_toggle(void);
1406cdd1 HMH	557	static int video_read(char *p);
	558	static int video_write(char *buf);
	559
	560
	561	/*
	562	* Volume subdriver
	563	*/
	564
	565	static int volume_offset = 0x30;
	566
	567	static int volume_read(char *p);
	568	static int volume_write(char *buf);
	569
	570
	571	/*
	572	* Wan subdriver
	573	*/
	574
d6fdd1e9 HMH	575	enum {
	576	/* ACPI GWAN/SWAN bits */
	577	TP_ACPI_WANCARD_HWPRESENT = 0x01, /* Wan hw available */
	578	TP_ACPI_WANCARD_RADIOSSW = 0x02, /* Wan radio enabled */
	579	TP_ACPI_WANCARD_UNK = 0x04, /* unknown function */
	580	};
	581
a5763f22	582	static int wan_init(struct ibm_init_struct *iibm);
d6fdd1e9 HMH	583	static int wan_get_radiosw(void);
d6fdd1e9 HMH	584	static int wan_set_radiosw(int radio_on);
1406cdd1 HMH	585	static int wan_read(char *p);
	586	static int wan_write(char *buf);
	587
	588
643f12db	589	#endif /* __THINKPAD_ACPI_H */