[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/nvram.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

/* ThinkPad CMOS NVRAM constants */
#define TP_NVRAM_ADDR_BRIGHTNESS       0x5e
#define TP_NVRAM_MASK_LEVEL_BRIGHTNESS 0x07
#define TP_NVRAM_POS_LEVEL_BRIGHTNESS 0

#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 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 unsigned int hotkey_report_mode;

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


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

struct ibm_struct;

struct tp_acpi_drv_struct {
	const struct acpi_device_id *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;
	u16 platform_drv_registered:1;
	u16 platform_drv_attrs_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_mode;

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