Linux 2.6.23
[deliverable/linux.git] / drivers / char / i8k.c
CommitLineData
1da177e4
LT
1/*
2 * i8k.c -- Linux driver for accessing the SMM BIOS on Dell laptops.
3 * See http://www.debian.org/~dz/i8k/ for more information
4 * and for latest version of this driver.
5 *
6 * Copyright (C) 2001 Massimo Dal Zotto <dz@debian.org>
7 *
8 * This program is free software; you can redistribute it and/or modify it
9 * under the terms of the GNU General Public License as published by the
10 * Free Software Foundation; either version 2, or (at your option) any
11 * later version.
12 *
13 * This program is distributed in the hope that it will be useful, but
14 * WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * General Public License for more details.
17 */
18
19#include <linux/module.h>
20#include <linux/types.h>
21#include <linux/init.h>
22#include <linux/proc_fs.h>
352f8f8b 23#include <linux/seq_file.h>
e70c9d5e 24#include <linux/dmi.h>
7e80d0d0 25#include <linux/capability.h>
1da177e4
LT
26#include <asm/uaccess.h>
27#include <asm/io.h>
28
29#include <linux/i8k.h>
30
352f8f8b 31#define I8K_VERSION "1.14 21/02/2005"
1da177e4
LT
32
33#define I8K_SMM_FN_STATUS 0x0025
34#define I8K_SMM_POWER_STATUS 0x0069
35#define I8K_SMM_SET_FAN 0x01a3
36#define I8K_SMM_GET_FAN 0x00a3
37#define I8K_SMM_GET_SPEED 0x02a3
38#define I8K_SMM_GET_TEMP 0x10a3
7e0fa31d
DT
39#define I8K_SMM_GET_DELL_SIG1 0xfea3
40#define I8K_SMM_GET_DELL_SIG2 0xffa3
1da177e4
LT
41#define I8K_SMM_BIOS_VERSION 0x00a6
42
43#define I8K_FAN_MULT 30
44#define I8K_MAX_TEMP 127
45
46#define I8K_FN_NONE 0x00
47#define I8K_FN_UP 0x01
48#define I8K_FN_DOWN 0x02
49#define I8K_FN_MUTE 0x04
50#define I8K_FN_MASK 0x07
51#define I8K_FN_SHIFT 8
52
53#define I8K_POWER_AC 0x05
54#define I8K_POWER_BATTERY 0x01
55
56#define I8K_TEMPERATURE_BUG 1
57
e70c9d5e 58static char bios_version[4];
1da177e4
LT
59
60MODULE_AUTHOR("Massimo Dal Zotto (dz@debian.org)");
61MODULE_DESCRIPTION("Driver for accessing SMM BIOS on Dell laptops");
62MODULE_LICENSE("GPL");
63
64static int force;
65module_param(force, bool, 0);
66MODULE_PARM_DESC(force, "Force loading without checking for supported models");
67
e70c9d5e
DT
68static int ignore_dmi;
69module_param(ignore_dmi, bool, 0);
70MODULE_PARM_DESC(ignore_dmi, "Continue probing hardware even if DMI data does not match");
71
1da177e4
LT
72static int restricted;
73module_param(restricted, bool, 0);
74MODULE_PARM_DESC(restricted, "Allow fan control if SYS_ADMIN capability set");
75
76static int power_status;
77module_param(power_status, bool, 0600);
78MODULE_PARM_DESC(power_status, "Report power status in /proc/i8k");
79
352f8f8b 80static int i8k_open_fs(struct inode *inode, struct file *file);
1da177e4
LT
81static int i8k_ioctl(struct inode *, struct file *, unsigned int,
82 unsigned long);
83
62322d25 84static const struct file_operations i8k_fops = {
352f8f8b
DT
85 .open = i8k_open_fs,
86 .read = seq_read,
87 .llseek = seq_lseek,
88 .release = single_release,
89 .ioctl = i8k_ioctl,
1da177e4
LT
90};
91
8378b924 92struct smm_regs {
dec63ec3
DT
93 unsigned int eax;
94 unsigned int ebx __attribute__ ((packed));
95 unsigned int ecx __attribute__ ((packed));
96 unsigned int edx __attribute__ ((packed));
97 unsigned int esi __attribute__ ((packed));
98 unsigned int edi __attribute__ ((packed));
8378b924 99};
1da177e4 100
e70c9d5e
DT
101static inline char *i8k_get_dmi_data(int field)
102{
4f005551
DT
103 char *dmi_data = dmi_get_system_info(field);
104
105 return dmi_data && *dmi_data ? dmi_data : "?";
e70c9d5e 106}
1da177e4
LT
107
108/*
109 * Call the System Management Mode BIOS. Code provided by Jonathan Buzzard.
110 */
8378b924 111static int i8k_smm(struct smm_regs *regs)
1da177e4 112{
dec63ec3
DT
113 int rc;
114 int eax = regs->eax;
115
116 asm("pushl %%eax\n\t"
117 "movl 0(%%eax),%%edx\n\t"
118 "push %%edx\n\t"
119 "movl 4(%%eax),%%ebx\n\t"
120 "movl 8(%%eax),%%ecx\n\t"
121 "movl 12(%%eax),%%edx\n\t"
122 "movl 16(%%eax),%%esi\n\t"
123 "movl 20(%%eax),%%edi\n\t"
124 "popl %%eax\n\t"
125 "out %%al,$0xb2\n\t"
126 "out %%al,$0x84\n\t"
127 "xchgl %%eax,(%%esp)\n\t"
128 "movl %%ebx,4(%%eax)\n\t"
129 "movl %%ecx,8(%%eax)\n\t"
130 "movl %%edx,12(%%eax)\n\t"
131 "movl %%esi,16(%%eax)\n\t"
132 "movl %%edi,20(%%eax)\n\t"
133 "popl %%edx\n\t"
134 "movl %%edx,0(%%eax)\n\t"
135 "lahf\n\t"
136 "shrl $8,%%eax\n\t"
137 "andl $1,%%eax\n":"=a"(rc)
138 : "a"(regs)
139 : "%ebx", "%ecx", "%edx", "%esi", "%edi", "memory");
140
8378b924 141 if (rc != 0 || (regs->eax & 0xffff) == 0xffff || regs->eax == eax)
dec63ec3 142 return -EINVAL;
dec63ec3
DT
143
144 return 0;
1da177e4
LT
145}
146
147/*
148 * Read the bios version. Return the version as an integer corresponding
149 * to the ascii value, for example "A17" is returned as 0x00413137.
150 */
151static int i8k_get_bios_version(void)
152{
8378b924 153 struct smm_regs regs = { .eax = I8K_SMM_BIOS_VERSION, };
1da177e4 154
8378b924 155 return i8k_smm(&regs) ? : regs.eax;
1da177e4
LT
156}
157
1da177e4
LT
158/*
159 * Read the Fn key status.
160 */
161static int i8k_get_fn_status(void)
162{
8378b924 163 struct smm_regs regs = { .eax = I8K_SMM_FN_STATUS, };
dec63ec3
DT
164 int rc;
165
8378b924 166 if ((rc = i8k_smm(&regs)) < 0)
dec63ec3 167 return rc;
dec63ec3
DT
168
169 switch ((regs.eax >> I8K_FN_SHIFT) & I8K_FN_MASK) {
170 case I8K_FN_UP:
171 return I8K_VOL_UP;
172 case I8K_FN_DOWN:
173 return I8K_VOL_DOWN;
174 case I8K_FN_MUTE:
175 return I8K_VOL_MUTE;
176 default:
177 return 0;
178 }
1da177e4
LT
179}
180
181/*
182 * Read the power status.
183 */
184static int i8k_get_power_status(void)
185{
8378b924 186 struct smm_regs regs = { .eax = I8K_SMM_POWER_STATUS, };
dec63ec3
DT
187 int rc;
188
8378b924 189 if ((rc = i8k_smm(&regs)) < 0)
dec63ec3 190 return rc;
dec63ec3 191
8378b924 192 return (regs.eax & 0xff) == I8K_POWER_AC ? I8K_AC : I8K_BATTERY;
1da177e4
LT
193}
194
195/*
196 * Read the fan status.
197 */
198static int i8k_get_fan_status(int fan)
199{
8378b924 200 struct smm_regs regs = { .eax = I8K_SMM_GET_FAN, };
1da177e4 201
dec63ec3 202 regs.ebx = fan & 0xff;
8378b924 203 return i8k_smm(&regs) ? : regs.eax & 0xff;
1da177e4
LT
204}
205
206/*
207 * Read the fan speed in RPM.
208 */
209static int i8k_get_fan_speed(int fan)
210{
8378b924 211 struct smm_regs regs = { .eax = I8K_SMM_GET_SPEED, };
1da177e4 212
dec63ec3 213 regs.ebx = fan & 0xff;
8378b924 214 return i8k_smm(&regs) ? : (regs.eax & 0xffff) * I8K_FAN_MULT;
1da177e4
LT
215}
216
217/*
218 * Set the fan speed (off, low, high). Returns the new fan status.
219 */
220static int i8k_set_fan(int fan, int speed)
221{
8378b924 222 struct smm_regs regs = { .eax = I8K_SMM_SET_FAN, };
1da177e4 223
dec63ec3 224 speed = (speed < 0) ? 0 : ((speed > I8K_FAN_MAX) ? I8K_FAN_MAX : speed);
dec63ec3 225 regs.ebx = (fan & 0xff) | (speed << 8);
1da177e4 226
8378b924 227 return i8k_smm(&regs) ? : i8k_get_fan_status(fan);
1da177e4
LT
228}
229
230/*
231 * Read the cpu temperature.
232 */
7e0fa31d 233static int i8k_get_temp(int sensor)
1da177e4 234{
8378b924 235 struct smm_regs regs = { .eax = I8K_SMM_GET_TEMP, };
dec63ec3
DT
236 int rc;
237 int temp;
1da177e4
LT
238
239#ifdef I8K_TEMPERATURE_BUG
8378b924 240 static int prev;
1da177e4 241#endif
7e0fa31d 242 regs.ebx = sensor & 0xff;
8378b924 243 if ((rc = i8k_smm(&regs)) < 0)
dec63ec3 244 return rc;
8378b924 245
dec63ec3 246 temp = regs.eax & 0xff;
1da177e4
LT
247
248#ifdef I8K_TEMPERATURE_BUG
dec63ec3
DT
249 /*
250 * Sometimes the temperature sensor returns 0x99, which is out of range.
251 * In this case we return (once) the previous cached value. For example:
252 # 1003655137 00000058 00005a4b
253 # 1003655138 00000099 00003a80 <--- 0x99 = 153 degrees
254 # 1003655139 00000054 00005c52
255 */
256 if (temp > I8K_MAX_TEMP) {
257 temp = prev;
258 prev = I8K_MAX_TEMP;
259 } else {
260 prev = temp;
261 }
1da177e4
LT
262#endif
263
dec63ec3 264 return temp;
1da177e4
LT
265}
266
7e0fa31d 267static int i8k_get_dell_signature(int req_fn)
1da177e4 268{
7e0fa31d 269 struct smm_regs regs = { .eax = req_fn, };
dec63ec3 270 int rc;
1da177e4 271
8378b924 272 if ((rc = i8k_smm(&regs)) < 0)
dec63ec3 273 return rc;
1da177e4 274
8378b924 275 return regs.eax == 1145651527 && regs.edx == 1145392204 ? 0 : -1;
1da177e4
LT
276}
277
278static int i8k_ioctl(struct inode *ip, struct file *fp, unsigned int cmd,
279 unsigned long arg)
280{
e70c9d5e 281 int val = 0;
dec63ec3
DT
282 int speed;
283 unsigned char buff[16];
284 int __user *argp = (int __user *)arg;
285
286 if (!argp)
287 return -EINVAL;
288
289 switch (cmd) {
290 case I8K_BIOS_VERSION:
291 val = i8k_get_bios_version();
292 break;
293
294 case I8K_MACHINE_ID:
295 memset(buff, 0, 16);
e70c9d5e 296 strlcpy(buff, i8k_get_dmi_data(DMI_PRODUCT_SERIAL), sizeof(buff));
dec63ec3
DT
297 break;
298
299 case I8K_FN_STATUS:
300 val = i8k_get_fn_status();
301 break;
302
303 case I8K_POWER_STATUS:
304 val = i8k_get_power_status();
305 break;
306
307 case I8K_GET_TEMP:
7e0fa31d 308 val = i8k_get_temp(0);
dec63ec3
DT
309 break;
310
311 case I8K_GET_SPEED:
8378b924 312 if (copy_from_user(&val, argp, sizeof(int)))
dec63ec3 313 return -EFAULT;
8378b924 314
dec63ec3
DT
315 val = i8k_get_fan_speed(val);
316 break;
1da177e4 317
dec63ec3 318 case I8K_GET_FAN:
8378b924 319 if (copy_from_user(&val, argp, sizeof(int)))
dec63ec3 320 return -EFAULT;
8378b924 321
dec63ec3
DT
322 val = i8k_get_fan_status(val);
323 break;
1da177e4 324
dec63ec3 325 case I8K_SET_FAN:
8378b924 326 if (restricted && !capable(CAP_SYS_ADMIN))
dec63ec3 327 return -EPERM;
8378b924
DT
328
329 if (copy_from_user(&val, argp, sizeof(int)))
dec63ec3 330 return -EFAULT;
8378b924
DT
331
332 if (copy_from_user(&speed, argp + 1, sizeof(int)))
dec63ec3 333 return -EFAULT;
8378b924 334
dec63ec3
DT
335 val = i8k_set_fan(val, speed);
336 break;
1da177e4 337
dec63ec3
DT
338 default:
339 return -EINVAL;
1da177e4 340 }
1da177e4 341
8378b924 342 if (val < 0)
dec63ec3 343 return val;
1da177e4 344
dec63ec3
DT
345 switch (cmd) {
346 case I8K_BIOS_VERSION:
8378b924 347 if (copy_to_user(argp, &val, 4))
dec63ec3 348 return -EFAULT;
8378b924 349
dec63ec3
DT
350 break;
351 case I8K_MACHINE_ID:
8378b924 352 if (copy_to_user(argp, buff, 16))
dec63ec3 353 return -EFAULT;
8378b924 354
dec63ec3
DT
355 break;
356 default:
8378b924 357 if (copy_to_user(argp, &val, sizeof(int)))
dec63ec3 358 return -EFAULT;
8378b924 359
dec63ec3 360 break;
1da177e4 361 }
1da177e4 362
dec63ec3 363 return 0;
1da177e4
LT
364}
365
366/*
367 * Print the information for /proc/i8k.
368 */
352f8f8b 369static int i8k_proc_show(struct seq_file *seq, void *offset)
1da177e4 370{
352f8f8b 371 int fn_key, cpu_temp, ac_power;
dec63ec3
DT
372 int left_fan, right_fan, left_speed, right_speed;
373