Pull vector-domain into release branch
[sfrench/cifs-2.6.git] / arch / i386 / kernel / apm.c
1 /* -*- linux-c -*-
2  * APM BIOS driver for Linux
3  * Copyright 1994-2001 Stephen Rothwell (sfr@canb.auug.org.au)
4  *
5  * Initial development of this driver was funded by NEC Australia P/L
6  *      and NEC Corporation
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  * October 1995, Rik Faith (faith@cs.unc.edu):
19  *    Minor enhancements and updates (to the patch set) for 1.3.x
20  *    Documentation
21  * January 1996, Rik Faith (faith@cs.unc.edu):
22  *    Make /proc/apm easy to format (bump driver version)
23  * March 1996, Rik Faith (faith@cs.unc.edu):
24  *    Prohibit APM BIOS calls unless apm_enabled.
25  *    (Thanks to Ulrich Windl <Ulrich.Windl@rz.uni-regensburg.de>)
26  * April 1996, Stephen Rothwell (sfr@canb.auug.org.au)
27  *    Version 1.0 and 1.1
28  * May 1996, Version 1.2
29  * Feb 1998, Version 1.3
30  * Feb 1998, Version 1.4
31  * Aug 1998, Version 1.5
32  * Sep 1998, Version 1.6
33  * Nov 1998, Version 1.7
34  * Jan 1999, Version 1.8
35  * Jan 1999, Version 1.9
36  * Oct 1999, Version 1.10
37  * Nov 1999, Version 1.11
38  * Jan 2000, Version 1.12
39  * Feb 2000, Version 1.13
40  * Nov 2000, Version 1.14
41  * Oct 2001, Version 1.15
42  * Jan 2002, Version 1.16
43  * Oct 2002, Version 1.16ac
44  *
45  * History:
46  *    0.6b: first version in official kernel, Linux 1.3.46
47  *    0.7: changed /proc/apm format, Linux 1.3.58
48  *    0.8: fixed gcc 2.7.[12] compilation problems, Linux 1.3.59
49  *    0.9: only call bios if bios is present, Linux 1.3.72
50  *    1.0: use fixed device number, consolidate /proc/apm into this file,
51  *         Linux 1.3.85
52  *    1.1: support user-space standby and suspend, power off after system
53  *         halted, Linux 1.3.98
54  *    1.2: When resetting RTC after resume, take care so that the time
55  *         is only incorrect by 30-60mS (vs. 1S previously) (Gabor J. Toth
56  *         <jtoth@princeton.edu>); improve interaction between
57  *         screen-blanking and gpm (Stephen Rothwell); Linux 1.99.4
58  *    1.2a:Simple change to stop mysterious bug reports with SMP also added
59  *         levels to the printk calls. APM is not defined for SMP machines.
60  *         The new replacment for it is, but Linux doesn't yet support this.
61  *         Alan Cox Linux 2.1.55
62  *    1.3: Set up a valid data descriptor 0x40 for buggy BIOS's
63  *    1.4: Upgraded to support APM 1.2. Integrated ThinkPad suspend patch by
64  *         Dean Gaudet <dgaudet@arctic.org>.
65  *         C. Scott Ananian <cananian@alumni.princeton.edu> Linux 2.1.87
66  *    1.5: Fix segment register reloading (in case of bad segments saved
67  *         across BIOS call).
68  *         Stephen Rothwell
69  *    1.6: Cope with complier/assembler differences.
70  *         Only try to turn off the first display device.
71  *         Fix OOPS at power off with no APM BIOS by Jan Echternach
72  *                   <echter@informatik.uni-rostock.de>
73  *         Stephen Rothwell
74  *    1.7: Modify driver's cached copy of the disabled/disengaged flags
75  *         to reflect current state of APM BIOS.
76  *         Chris Rankin <rankinc@bellsouth.net>
77  *         Reset interrupt 0 timer to 100Hz after suspend
78  *         Chad Miller <cmiller@surfsouth.com>
79  *         Add CONFIG_APM_IGNORE_SUSPEND_BOUNCE
80  *         Richard Gooch <rgooch@atnf.csiro.au>
81  *         Allow boot time disabling of APM
82  *         Make boot messages far less verbose by default
83  *         Make asm safer
84  *         Stephen Rothwell
85  *    1.8: Add CONFIG_APM_RTC_IS_GMT
86  *         Richard Gooch <rgooch@atnf.csiro.au>
87  *         change APM_NOINTS to CONFIG_APM_ALLOW_INTS
88  *         remove dependency on CONFIG_PROC_FS
89  *         Stephen Rothwell
90  *    1.9: Fix small typo.  <laslo@wodip.opole.pl>
91  *         Try to cope with BIOS's that need to have all display
92  *         devices blanked and not just the first one.
93  *         Ross Paterson <ross@soi.city.ac.uk>
94  *         Fix segment limit setting it has always been wrong as
95  *         the segments needed to have byte granularity.
96  *         Mark a few things __init.
97  *         Add hack to allow power off of SMP systems by popular request.
98  *         Use CONFIG_SMP instead of __SMP__
99  *         Ignore BOUNCES for three seconds.
100  *         Stephen Rothwell
101  *   1.10: Fix for Thinkpad return code.
102  *         Merge 2.2 and 2.3 drivers.
103  *         Remove APM dependencies in arch/i386/kernel/process.c
104  *         Remove APM dependencies in drivers/char/sysrq.c
105  *         Reset time across standby.
106  *         Allow more inititialisation on SMP.
107  *         Remove CONFIG_APM_POWER_OFF and make it boot time
108  *         configurable (default on).
109  *         Make debug only a boot time parameter (remove APM_DEBUG).
110  *         Try to blank all devices on any error.
111  *   1.11: Remove APM dependencies in drivers/char/console.c
112  *         Check nr_running to detect if we are idle (from
113  *         Borislav Deianov <borislav@lix.polytechnique.fr>)
114  *         Fix for bioses that don't zero the top part of the
115  *         entrypoint offset (Mario Sitta <sitta@al.unipmn.it>)
116  *         (reported by Panos Katsaloulis <teras@writeme.com>).
117  *         Real mode power off patch (Walter Hofmann
118  *         <Walter.Hofmann@physik.stud.uni-erlangen.de>).
119  *   1.12: Remove CONFIG_SMP as the compiler will optimize
120  *         the code away anyway (smp_num_cpus == 1 in UP)
121  *         noted by Artur Skawina <skawina@geocities.com>.
122  *         Make power off under SMP work again.
123  *         Fix thinko with initial engaging of BIOS.
124  *         Make sure power off only happens on CPU 0
125  *         (Paul "Rusty" Russell <rusty@rustcorp.com.au>).
126  *         Do error notification to user mode if BIOS calls fail.
127  *         Move entrypoint offset fix to ...boot/setup.S
128  *         where it belongs (Cosmos <gis88564@cis.nctu.edu.tw>).
129  *         Remove smp-power-off. SMP users must now specify
130  *         "apm=power-off" on the kernel command line. Suggested
131  *         by Jim Avera <jima@hal.com>, modified by Alan Cox
132  *         <alan@lxorguk.ukuu.org.uk>.
133  *         Register the /proc/apm entry even on SMP so that
134  *         scripts that check for it before doing power off
135  *         work (Jim Avera <jima@hal.com>).
136  *   1.13: Changes for new pm_ interfaces (Andy Henroid
137  *         <andy_henroid@yahoo.com>).
138  *         Modularize the code.
139  *         Fix the Thinkpad (again) :-( (CONFIG_APM_IGNORE_MULTIPLE_SUSPENDS
140  *         is now the way life works).
141  *         Fix thinko in suspend() (wrong return).
142  *         Notify drivers on critical suspend.
143  *         Make kapmd absorb more idle time (Pavel Machek <pavel@suse.cz>
144  *         modified by sfr).
145  *         Disable interrupts while we are suspended (Andy Henroid
146  *         <andy_henroid@yahoo.com> fixed by sfr).
147  *         Make power off work on SMP again (Tony Hoyle
148  *         <tmh@magenta-logic.com> and <zlatko@iskon.hr>) modified by sfr.
149  *         Remove CONFIG_APM_SUSPEND_BOUNCE.  The bounce ignore
150  *         interval is now configurable.
151  *   1.14: Make connection version persist across module unload/load.
152  *         Enable and engage power management earlier.
153  *         Disengage power management on module unload.
154  *         Changed to use the sysrq-register hack for registering the
155  *         power off function called by magic sysrq based upon discussions
156  *         in irc://irc.openprojects.net/#kernelnewbies
157  *         (Crutcher Dunnavant <crutcher+kernel@datastacks.com>).
158  *         Make CONFIG_APM_REAL_MODE_POWER_OFF run time configurable.
159  *         (Arjan van de Ven <arjanv@redhat.com>) modified by sfr.
160  *         Work around byte swap bug in one of the Vaio's BIOS's
161  *         (Marc Boucher <marc@mbsi.ca>).
162  *         Exposed the disable flag to dmi so that we can handle known
163  *         broken APM (Alan Cox <alan@redhat.com>).
164  *   1.14ac: If the BIOS says "I slowed the CPU down" then don't spin
165  *         calling it - instead idle. (Alan Cox <alan@redhat.com>)
166  *         If an APM idle fails log it and idle sensibly
167  *   1.15: Don't queue events to clients who open the device O_WRONLY.
168  *         Don't expect replies from clients who open the device O_RDONLY.
169  *         (Idea from Thomas Hood)
170  *         Minor waitqueue cleanups. (John Fremlin <chief@bandits.org>)
171  *   1.16: Fix idle calling. (Andreas Steinmetz <ast@domdv.de> et al.)
172  *         Notify listeners of standby or suspend events before notifying
173  *         drivers. Return EBUSY to ioctl() if suspend is rejected.
174  *         (Russell King <rmk@arm.linux.org.uk> and Thomas Hood)
175  *         Ignore first resume after we generate our own resume event
176  *         after a suspend (Thomas Hood)
177  *         Daemonize now gets rid of our controlling terminal (sfr).
178  *         CONFIG_APM_CPU_IDLE now just affects the default value of
179  *         idle_threshold (sfr).
180  *         Change name of kernel apm daemon (as it no longer idles) (sfr).
181  *   1.16ac: Fix up SMP support somewhat. You can now force SMP on and we
182  *         make _all_ APM calls on the CPU#0. Fix unsafe sign bug.
183  *         TODO: determine if its "boot CPU" or "CPU0" we want to lock to.
184  *
185  * APM 1.1 Reference:
186  *
187  *   Intel Corporation, Microsoft Corporation. Advanced Power Management
188  *   (APM) BIOS Interface Specification, Revision 1.1, September 1993.
189  *   Intel Order Number 241704-001.  Microsoft Part Number 781-110-X01.
190  *
191  * [This document is available free from Intel by calling 800.628.8686 (fax
192  * 916.356.6100) or 800.548.4725; or via anonymous ftp from
193  * ftp://ftp.intel.com/pub/IAL/software_specs/apmv11.doc.  It is also
194  * available from Microsoft by calling 206.882.8080.]
195  *
196  * APM 1.2 Reference:
197  *   Intel Corporation, Microsoft Corporation. Advanced Power Management
198  *   (APM) BIOS Interface Specification, Revision 1.2, February 1996.
199  *
200  * [This document is available from Microsoft at:
201  *    http://www.microsoft.com/whdc/archive/amp_12.mspx]
202  */
203
204 #include <linux/module.h>
205
206 #include <linux/poll.h>
207 #include <linux/types.h>
208 #include <linux/stddef.h>
209 #include <linux/timer.h>
210 #include <linux/fcntl.h>
211 #include <linux/slab.h>
212 #include <linux/stat.h>
213 #include <linux/proc_fs.h>
214 #include <linux/seq_file.h>
215 #include <linux/miscdevice.h>
216 #include <linux/apm_bios.h>
217 #include <linux/init.h>
218 #include <linux/time.h>
219 #include <linux/sched.h>
220 #include <linux/pm.h>
221 #include <linux/pm_legacy.h>
222 #include <linux/capability.h>
223 #include <linux/device.h>
224 #include <linux/kernel.h>
225 #include <linux/freezer.h>
226 #include <linux/smp.h>
227 #include <linux/dmi.h>
228 #include <linux/suspend.h>
229 #include <linux/kthread.h>
230
231 #include <asm/system.h>
232 #include <asm/uaccess.h>
233 #include <asm/desc.h>
234 #include <asm/i8253.h>
235 #include <asm/paravirt.h>
236 #include <asm/reboot.h>
237
238 #include "io_ports.h"
239
240 #if defined(CONFIG_APM_DISPLAY_BLANK) && defined(CONFIG_VT)
241 extern int (*console_blank_hook)(int);
242 #endif
243
244 /*
245  * The apm_bios device is one of the misc char devices.
246  * This is its minor number.
247  */
248 #define APM_MINOR_DEV   134
249
250 /*
251  * See Documentation/Config.help for the configuration options.
252  *
253  * Various options can be changed at boot time as follows:
254  * (We allow underscores for compatibility with the modules code)
255  *      apm=on/off                      enable/disable APM
256  *          [no-]allow[-_]ints          allow interrupts during BIOS calls
257  *          [no-]broken[-_]psr          BIOS has a broken GetPowerStatus call
258  *          [no-]realmode[-_]power[-_]off       switch to real mode before
259  *                                              powering off
260  *          [no-]debug                  log some debugging messages
261  *          [no-]power[-_]off           power off on shutdown
262  *          [no-]smp                    Use apm even on an SMP box
263  *          bounce[-_]interval=<n>      number of ticks to ignore suspend
264  *                                      bounces
265  *          idle[-_]threshold=<n>       System idle percentage above which to
266  *                                      make APM BIOS idle calls. Set it to
267  *                                      100 to disable.
268  *          idle[-_]period=<n>          Period (in 1/100s of a second) over
269  *                                      which the idle percentage is
270  *                                      calculated.
271  */
272
273 /* KNOWN PROBLEM MACHINES:
274  *
275  * U: TI 4000M TravelMate: BIOS is *NOT* APM compliant
276  *                         [Confirmed by TI representative]
277  * ?: ACER 486DX4/75: uses dseg 0040, in violation of APM specification
278  *                    [Confirmed by BIOS disassembly]
279  *                    [This may work now ...]
280  * P: Toshiba 1950S: battery life information only gets updated after resume
281  * P: Midwest Micro Soundbook Elite DX2/66 monochrome: screen blanking
282  *      broken in BIOS [Reported by Garst R. Reese <reese@isn.net>]
283  * ?: AcerNote-950: oops on reading /proc/apm - workaround is a WIP
284  *      Neale Banks <neale@lowendale.com.au> December 2000
285  *
286  * Legend: U = unusable with APM patches
287  *         P = partially usable with APM patches
288  */
289
290 /*
291  * Define as 1 to make the driver always call the APM BIOS busy
292  * routine even if the clock was not reported as slowed by the
293  * idle routine.  Otherwise, define as 0.
294  */
295 #define ALWAYS_CALL_BUSY   1
296
297 /*
298  * Define to make the APM BIOS calls zero all data segment registers (so
299  * that an incorrect BIOS implementation will cause a kernel panic if it
300  * tries to write to arbitrary memory).
301  */
302 #define APM_ZERO_SEGS
303
304 #include "apm.h"
305
306 /*
307  * Define to re-initialize the interrupt 0 timer to 100 Hz after a suspend.
308  * This patched by Chad Miller <cmiller@surfsouth.com>, original code by
309  * David Chen <chen@ctpa04.mit.edu>
310  */
311 #undef INIT_TIMER_AFTER_SUSPEND
312
313 #ifdef INIT_TIMER_AFTER_SUSPEND
314 #include <linux/timex.h>
315 #include <asm/io.h>
316 #include <linux/delay.h>
317 #endif
318
319 /*
320  * Need to poll the APM BIOS every second
321  */
322 #define APM_CHECK_TIMEOUT       (HZ)
323
324 /*
325  * Ignore suspend events for this amount of time after a resume
326  */
327 #define DEFAULT_BOUNCE_INTERVAL         (3 * HZ)
328
329 /*
330  * Maximum number of events stored
331  */
332 #define APM_MAX_EVENTS          20
333
334 /*
335  * The per-file APM data
336  */
337 struct apm_user {
338         int             magic;
339         struct apm_user *       next;
340         unsigned int    suser: 1;
341         unsigned int    writer: 1;
342         unsigned int    reader: 1;
343         unsigned int    suspend_wait: 1;
344         int             suspend_result;
345         int             suspends_pending;
346         int             standbys_pending;
347         int             suspends_read;
348         int             standbys_read;
349         int             event_head;
350         int             event_tail;
351         apm_event_t     events[APM_MAX_EVENTS];
352 };
353
354 /*
355  * The magic number in apm_user
356  */
357 #define APM_BIOS_MAGIC          0x4101
358
359 /*
360  * idle percentage above which bios idle calls are done
361  */
362 #ifdef CONFIG_APM_CPU_IDLE
363 #define DEFAULT_IDLE_THRESHOLD  95
364 #else
365 #define DEFAULT_IDLE_THRESHOLD  100
366 #endif
367 #define DEFAULT_IDLE_PERIOD     (100 / 3)
368
369 /*
370  * Local variables
371  */
372 static struct {
373         unsigned long   offset;
374         unsigned short  segment;
375 }                               apm_bios_entry;
376 static int                      clock_slowed;
377 static int                      idle_threshold __read_mostly = DEFAULT_IDLE_THRESHOLD;
378 static int                      idle_period __read_mostly = DEFAULT_IDLE_PERIOD;
379 static int                      set_pm_idle;
380 static int                      suspends_pending;
381 static int                      standbys_pending;
382 static int                      ignore_sys_suspend;
383 static int                      ignore_normal_resume;
384 static int                      bounce_interval __read_mostly = DEFAULT_BOUNCE_INTERVAL;
385
386 static int                      debug __read_mostly;
387 static int                      smp __read_mostly;
388 static int                      apm_disabled = -1;
389 #ifdef CONFIG_SMP
390 static int                      power_off;
391 #else
392 static int                      power_off = 1;
393 #endif
394 #ifdef CONFIG_APM_REAL_MODE_POWER_OFF
395 static int                      realmode_power_off = 1;
396 #else
397 static int                      realmode_power_off;
398 #endif
399 #ifdef CONFIG_APM_ALLOW_INTS
400 static int                      allow_ints = 1;
401 #else
402 static int                      allow_ints;
403 #endif
404 static int                      broken_psr;
405
406 static DECLARE_WAIT_QUEUE_HEAD(apm_waitqueue);
407 static DECLARE_WAIT_QUEUE_HEAD(apm_suspend_waitqueue);
408 static struct apm_user *        user_list;
409 static DEFINE_SPINLOCK(user_list_lock);
410 static const struct desc_struct bad_bios_desc = { 0, 0x00409200 };
411
412 static const char               driver_version[] = "1.16ac";    /* no spaces */
413
414 static struct task_struct *kapmd_task;
415
416 /*
417  *      APM event names taken from the APM 1.2 specification. These are
418  *      the message codes that the BIOS uses to tell us about events
419  */
420 static const char *     const apm_event_name[] = {
421         "system standby",
422         "system suspend",
423         "normal resume",
424         "critical resume",
425         "low battery",
426         "power status change",
427         "update time",
428         "critical suspend",
429         "user standby",
430         "user suspend",
431         "system standby resume",
432         "capabilities change"
433 };
434 #define NR_APM_EVENT_NAME ARRAY_SIZE(apm_event_name)
435
436 typedef struct lookup_t {
437         int     key;
438         char *  msg;
439 } lookup_t;
440
441 /*
442  *      The BIOS returns a set of standard error codes in AX when the
443  *      carry flag is set.
444  */
445  
446 static const lookup_t error_table[] = {
447 /* N/A  { APM_SUCCESS,          "Operation succeeded" }, */
448         { APM_DISABLED,         "Power management disabled" },
449         { APM_CONNECTED,        "Real mode interface already connected" },
450         { APM_NOT_CONNECTED,    "Interface not connected" },
451         { APM_16_CONNECTED,     "16 bit interface already connected" },
452 /* N/A  { APM_16_UNSUPPORTED,   "16 bit interface not supported" }, */
453         { APM_32_CONNECTED,     "32 bit interface already connected" },
454         { APM_32_UNSUPPORTED,   "32 bit interface not supported" },
455         { APM_BAD_DEVICE,       "Unrecognized device ID" },
456         { APM_BAD_PARAM,        "Parameter out of range" },
457         { APM_NOT_ENGAGED,      "Interface not engaged" },
458         { APM_BAD_FUNCTION,     "Function not supported" },
459         { APM_RESUME_DISABLED,  "Resume timer disabled" },
460         { APM_BAD_STATE,        "Unable to enter requested state" },
461 /* N/A  { APM_NO_EVENTS,        "No events pending" }, */
462         { APM_NO_ERROR,         "BIOS did not set a return code" },
463         { APM_NOT_PRESENT,      "No APM present" }
464 };
465 #define ERROR_COUNT     ARRAY_SIZE(error_table)
466
467 /**
468  *      apm_error       -       display an APM error
469  *      @str: information string
470  *      @err: APM BIOS return code
471  *
472  *      Write a meaningful log entry to the kernel log in the event of
473  *      an APM error.
474  */
475  
476 static void apm_error(char *str, int err)
477 {
478         int     i;
479
480         for (i = 0; i < ERROR_COUNT; i++)
481                 if (error_table[i].key == err) break;
482         if (i < ERROR_COUNT)
483                 printk(KERN_NOTICE "apm: %s: %s\n", str, error_table[i].msg);
484         else
485                 printk(KERN_NOTICE "apm: %s: unknown error code %#2.2x\n",
486                         str, err);
487 }
488
489 /*
490  * Lock APM functionality to physical CPU 0
491  */
492  
493 #ifdef CONFIG_SMP
494
495 static cpumask_t apm_save_cpus(void)
496 {
497         cpumask_t x = current->cpus_allowed;
498         /* Some bioses don't like being called from CPU != 0 */
499         set_cpus_allowed(current, cpumask_of_cpu(0));
500         BUG_ON(smp_processor_id() != 0);
501         return x;
502 }
503
504 static inline void apm_restore_cpus(cpumask_t mask)
505 {
506         set_cpus_allowed(current, mask);
507 }
508
509 #else
510
511 /*
512  *      No CPU lockdown needed on a uniprocessor
513  */
514  
515 #define apm_save_cpus()         (current->cpus_allowed)
516 #define apm_restore_cpus(x)     (void)(x)
517
518 #endif
519
520 /*
521  * These are the actual BIOS calls.  Depending on APM_ZERO_SEGS and
522  * apm_info.allow_ints, we are being really paranoid here!  Not only
523  * are interrupts disabled, but all the segment registers (except SS)
524  * are saved and zeroed this means that if the BIOS tries to reference
525  * any data without explicitly loading the segment registers, the kernel
526  * will fault immediately rather than have some unforeseen circumstances
527  * for the rest of the kernel.  And it will be very obvious!  :-) Doing
528  * this depends on CS referring to the same physical memory as DS so that
529  * DS can be zeroed before the call. Unfortunately, we can't do anything
530  * about the stack segment/pointer.  Also, we tell the compiler that
531  * everything could change.
532  *
533  * Also, we KNOW that for the non error case of apm_bios_call, there
534  * is no useful data returned in the low order 8 bits of eax.
535  */
536
537 static inline unsigned long __apm_irq_save(void)
538 {
539         unsigned long flags;
540         local_save_flags(flags);
541         if (apm_info.allow_ints) {
542                 if (irqs_disabled_flags(flags))
543                         local_irq_enable();
544         } else
545                 local_irq_disable();
546
547         return flags;
548 }
549
550 #define apm_irq_save(flags) \
551         do { flags = __apm_irq_save(); } while (0)
552
553 static inline void apm_irq_restore(unsigned long flags)
554 {
555         if (irqs_disabled_flags(flags))
556                 local_irq_disable();
557         else if (irqs_disabled())
558                 local_irq_enable();
559 }
560
561 #ifdef APM_ZERO_SEGS
562 #       define APM_DECL_SEGS \
563                 unsigned int saved_fs; unsigned int saved_gs;
564 #       define APM_DO_SAVE_SEGS \
565                 savesegment(fs, saved_fs); savesegment(gs, saved_gs)
566 #       define APM_DO_RESTORE_SEGS \
567                 loadsegment(fs, saved_fs); loadsegment(gs, saved_gs)
568 #else
569 #       define APM_DECL_SEGS
570 #       define APM_DO_SAVE_SEGS
571 #       define APM_DO_RESTORE_SEGS
572 #endif
573
574 /**
575  *      apm_bios_call   -       Make an APM BIOS 32bit call
576  *      @func: APM function to execute
577  *      @ebx_in: EBX register for call entry
578  *      @ecx_in: ECX register for call entry
579  *      @eax: EAX register return
580  *      @ebx: EBX register return
581  *      @ecx: ECX register return
582  *      @edx: EDX register return
583  *      @esi: ESI register return
584  *
585  *      Make an APM call using the 32bit protected mode interface. The
586  *      caller is responsible for knowing if APM BIOS is configured and
587  *      enabled. This call can disable interrupts for a long period of
588  *      time on some laptops.  The return value is in AH and the carry
589  *      flag is loaded into AL.  If there is an error, then the error
590  *      code is returned in AH (bits 8-15 of eax) and this function
591  *      returns non-zero.
592  */
593  
594 static u8 apm_bios_call(u32 func, u32 ebx_in, u32 ecx_in,
595         u32 *eax, u32 *ebx, u32 *ecx, u32 *edx, u32 *esi)
596 {
597         APM_DECL_SEGS
598         unsigned long           flags;
599         cpumask_t               cpus;
600         int                     cpu;
601         struct desc_struct      save_desc_40;
602         struct desc_struct      *gdt;
603
604         cpus = apm_save_cpus();
605         
606         cpu = get_cpu();
607         gdt = get_cpu_gdt_table(cpu);
608         save_desc_40 = gdt[0x40 / 8];
609         gdt[0x40 / 8] = bad_bios_desc;
610
611         apm_irq_save(flags);
612         APM_DO_SAVE_SEGS;
613         apm_bios_call_asm(func, ebx_in, ecx_in, eax, ebx, ecx, edx, esi);
614         APM_DO_RESTORE_SEGS;
615         apm_irq_restore(flags);
616         gdt[0x40 / 8] = save_desc_40;
617         put_cpu();
618         apm_restore_cpus(cpus);
619         
620         return *eax & 0xff;
621 }
622
623 /**
624  *      apm_bios_call_simple    -       make a simple APM BIOS 32bit call
625  *      @func: APM function to invoke
626  *      @ebx_in: EBX register value for BIOS call
627  *      @ecx_in: ECX register value for BIOS call
628  *      @eax: EAX register on return from the BIOS call
629  *
630  *      Make a BIOS call that returns one value only, or just status.
631  *      If there is an error, then the error code is returned in AH
632  *      (bits 8-15 of eax) and this function returns non-zero. This is
633  *      used for simpler BIOS operations. This call may hold interrupts
634  *      off for a long time on some laptops.
635  */
636
637 static u8 apm_bios_call_simple(u32 func, u32 ebx_in, u32 ecx_in, u32 *eax)
638 {
639         u8                      error;
640         APM_DECL_SEGS
641         unsigned long           flags;
642         cpumask_t               cpus;
643         int                     cpu;
644         struct desc_struct      save_desc_40;
645         struct desc_struct      *gdt;
646
647         cpus = apm_save_cpus();
648         
649         cpu = get_cpu();
650         gdt = get_cpu_gdt_table(cpu);
651         save_desc_40 = gdt[0x40 / 8];
652         gdt[0x40 / 8] = bad_bios_desc;
653
654         apm_irq_save(flags);
655         APM_DO_SAVE_SEGS;
656         error = apm_bios_call_simple_asm(func, ebx_in, ecx_in, eax);
657         APM_DO_RESTORE_SEGS;
658         apm_irq_restore(flags);
659         gdt[0x40 / 8] = save_desc_40;
660         put_cpu();
661         apm_restore_cpus(cpus);
662         return error;
663 }
664
665 /**
666  *      apm_driver_version      -       APM driver version
667  *      @val:   loaded with the APM version on return
668  *
669  *      Retrieve the APM version supported by the BIOS. This is only
670  *      supported for APM 1.1 or higher. An error indicates APM 1.0 is
671  *      probably present.
672  *
673  *      On entry val should point to a value indicating the APM driver
674  *      version with the high byte being the major and the low byte the
675  *      minor number both in BCD
676  *
677  *      On return it will hold the BIOS revision supported in the
678  *      same format.
679  */
680
681 static int apm_driver_version(u_short *val)
682 {
683         u32     eax;
684
685         if (apm_bios_call_simple(APM_FUNC_VERSION, 0, *val, &eax))
686                 return (eax >> 8) & 0xff;
687         *val = eax;
688         return APM_SUCCESS;
689 }
690
691 /**
692  *      apm_get_event   -       get an APM event from the BIOS
693  *      @event: pointer to the event
694  *      @info: point to the event information
695  *
696  *      The APM BIOS provides a polled information for event
697  *      reporting. The BIOS expects to be polled at least every second
698  *      when events are pending. When a message is found the caller should
699  *      poll until no more messages are present.  However, this causes
700  *      problems on some laptops where a suspend event notification is
701  *      not cleared until it is acknowledged.
702  *
703  *      Additional information is returned in the info pointer, providing
704  *      that APM 1.2 is in use. If no messges are pending the value 0x80
705  *      is returned (No power management events pending).
706  */
707  
708 static int apm_get_event(apm_event_t *event, apm_eventinfo_t *info)
709 {
710         u32     eax;
711         u32     ebx;
712         u32     ecx;
713         u32     dummy;
714
715         if (apm_bios_call(APM_FUNC_GET_EVENT, 0, 0, &eax, &ebx, &ecx,
716                         &dummy, &dummy))
717                 return (eax >> 8) & 0xff;
718         *event = ebx;
719         if (apm_info.connection_version < 0x0102)
720                 *info = ~0; /* indicate info not valid */
721         else
722                 *info = ecx;
723         return APM_SUCCESS;
724 }
725
726 /**
727  *      set_power_state -       set the power management state
728  *      @what: which items to transition
729  *      @state: state to transition to
730  *
731  *      Request an APM change of state for one or more system devices. The
732  *      processor state must be transitioned last of all. what holds the
733  *      class of device in the upper byte and the device number (0xFF for
734  *      all) for the object to be transitioned.
735  *
736  *      The state holds the state to transition to, which may in fact
737  *      be an acceptance of a BIOS requested state change.
738  */
739  
740 static int set_power_state(u_short what, u_short state)
741 {
742         u32     eax;
743
744         if (apm_bios_call_simple(APM_FUNC_SET_STATE, what, state, &eax))
745                 return (eax >> 8) & 0xff;
746         return APM_SUCCESS;
747 }
748
749 /**
750  *      set_system_power_state - set system wide power state
751  *      @state: which state to enter
752  *
753  *      Transition the entire system into a new APM power state.
754  */
755  
756 static int set_system_power_state(u_short state)
757 {
758         return set_power_state(APM_DEVICE_ALL, state);
759 }
760
761 /**
762  *      apm_do_idle     -       perform power saving
763  *
764  *      This function notifies the BIOS that the processor is (in the view
765  *      of the OS) idle. It returns -1 in the event that the BIOS refuses
766  *      to handle the idle request. On a success the function returns 1
767  *      if the BIOS did clock slowing or 0 otherwise.
768  */
769  
770 static int apm_do_idle(void)
771 {
772         u32     eax;
773         u8      ret = 0;
774         int     idled = 0;
775         int     polling;
776
777         polling = !!(current_thread_info()->status & TS_POLLING);
778         if (polling) {
779                 current_thread_info()->status &= ~TS_POLLING;
780                 /*
781                  * TS_POLLING-cleared state must be visible before we
782                  * test NEED_RESCHED:
783                  */
784                 smp_mb();
785         }
786         if (!need_resched()) {
787                 idled = 1;
788                 ret = apm_bios_call_simple(APM_FUNC_IDLE, 0, 0, &eax);
789         }
790         if (polling)
791                 current_thread_info()->status |= TS_POLLING;
792
793         if (!idled)
794                 return 0;
795
796         if (ret) {
797                 static unsigned long t;
798
799                 /* This always fails on some SMP boards running UP kernels.
800                  * Only report the failure the first 5 times.
801                  */
802                 if (++t < 5)
803                 {
804                         printk(KERN_DEBUG "apm_do_idle failed (%d)\n",
805                                         (eax >> 8) & 0xff);
806                         t = jiffies;
807                 }
808                 return -1;
809         }
810         clock_slowed = (apm_info.bios.flags & APM_IDLE_SLOWS_CLOCK) != 0;
811         return clock_slowed;
812 }
813
814 /**
815  *      apm_do_busy     -       inform the BIOS the CPU is busy
816  *
817  *      Request that the BIOS brings the CPU back to full performance. 
818  */
819  
820 static void apm_do_busy(void)
821 {
822         u32     dummy;
823
824         if (clock_slowed || ALWAYS_CALL_BUSY) {
825                 (void) apm_bios_call_simple(APM_FUNC_BUSY, 0, 0, &dummy);
826                 clock_slowed = 0;
827         }
828 }
829
830 /*
831  * If no process has really been interested in
832  * the CPU for some time, we want to call BIOS
833  * power management - we probably want
834  * to conserve power.
835  */
836 #define IDLE_CALC_LIMIT   (HZ * 100)
837 #define IDLE_LEAKY_MAX    16
838
839 static void (*original_pm_idle)(void) __read_mostly;
840
841 /**
842  * apm_cpu_idle         -       cpu idling for APM capable Linux
843  *
844  * This is the idling function the kernel executes when APM is available. It 
845  * tries to do BIOS powermanagement based on the average system idle time.
846  * Furthermore it calls the system default idle routine.
847  */
848
849 static void apm_cpu_idle(void)
850 {
851         static int use_apm_idle; /* = 0 */
852         static unsigned int last_jiffies; /* = 0 */
853         static unsigned int last_stime; /* = 0 */
854
855         int apm_idle_done = 0;
856         unsigned int jiffies_since_last_check = jiffies - last_jiffies;
857         unsigned int bucket;
858
859 recalc:
860         if (jiffies_since_last_check > IDLE_CALC_LIMIT) {
861                 use_apm_idle = 0;
862                 last_jiffies = jiffies;
863                 last_stime = current->stime;
864         } else if (jiffies_since_last_check > idle_period) {
865                 unsigned int idle_percentage;
866
867                 idle_percentage = current->stime - last_stime;
868                 idle_percentage *= 100;
869                 idle_percentage /= jiffies_since_last_check;
870                 use_apm_idle = (idle_percentage > idle_threshold);
871                 if (apm_info.forbid_idle)
872                         use_apm_idle = 0;
873                 last_jiffies = jiffies;
874                 last_stime = current->stime;
875         }
876
877         bucket = IDLE_LEAKY_MAX;
878
879         while (!need_resched()) {
880                 if (use_apm_idle) {
881                         unsigned int t;
882
883                         t = jiffies;
884                         switch (apm_do_idle()) {
885                         case 0: apm_idle_done = 1;
886                                 if (t != jiffies) {
887                                         if (bucket) {
888                                                 bucket = IDLE_LEAKY_MAX;
889                                                 continue;
890                                         }
891                                 } else if (bucket) {
892                                         bucket--;
893                                         continue;
894                                 }
895                                 break;
896                         case 1: apm_idle_done = 1;
897                                 break;
898                         default: /* BIOS refused */
899                                 break;
900                         }
901                 }
902                 if (original_pm_idle)
903                         original_pm_idle();
904                 else
905                         default_idle();
906                 jiffies_since_last_check = jiffies - last_jiffies;
907                 if (jiffies_since_last_check > idle_period)
908                         goto recalc;
909         }
910
911         if (apm_idle_done)
912                 apm_do_busy();
913 }
914
915 /**
916  *      apm_power_off   -       ask the BIOS to power off
917  *
918  *      Handle the power off sequence. This is the one piece of code we
919  *      will execute even on SMP machines. In order to deal with BIOS
920  *      bugs we support real mode APM BIOS power off calls. We also make
921  *      the SMP call on CPU0 as some systems will only honour this call
922  *      on their first cpu.
923  */
924  
925 static void apm_power_off(void)
926 {
927         unsigned char   po_bios_call[] = {
928                 0xb8, 0x00, 0x10,       /* movw  $0x1000,ax  */
929                 0x8e, 0xd0,             /* movw  ax,ss       */
930                 0xbc, 0x00, 0xf0,       /* movw  $0xf000,sp  */
931                 0xb8, 0x07, 0x53,       /* movw  $0x5307,ax  */
932                 0xbb, 0x01, 0x00,       /* movw  $0x0001,bx  */
933                 0xb9, 0x03, 0x00,       /* movw  $0x0003,cx  */
934                 0xcd, 0x15              /* int   $0x15       */
935         };
936
937         /* Some bioses don't like being called from CPU != 0 */
938         if (apm_info.realmode_power_off)
939         {
940                 (void)apm_save_cpus();
941                 machine_real_restart(po_bios_call, sizeof(po_bios_call));
942         }
943         else
944                 (void) set_system_power_state(APM_STATE_OFF);
945 }
946
947 #ifdef CONFIG_APM_DO_ENABLE
948
949 /**
950  *      apm_enable_power_management - enable BIOS APM power management
951  *      @enable: enable yes/no
952  *
953  *      Enable or disable the APM BIOS power services. 
954  */
955  
956 static int apm_enable_power_management(int enable)
957 {
958         u32     eax;
959
960         if ((enable == 0) && (apm_info.bios.flags & APM_BIOS_DISENGAGED))
961                 return APM_NOT_ENGAGED;
962         if (apm_bios_call_simple(APM_FUNC_ENABLE_PM, APM_DEVICE_BALL,
963                         enable, &eax))
964                 return (eax >> 8) & 0xff;
965         if (enable)
966                 apm_info.bios.flags &= ~APM_BIOS_DISABLED;
967         else
968                 apm_info.bios.flags |= APM_BIOS_DISABLED;
969         return APM_SUCCESS;
970 }
971 #endif
972
973 /**
974  *      apm_get_power_status    -       get current power state
975  *      @status: returned status
976  *      @bat: battery info
977  *      @life: estimated life
978  *
979  *      Obtain the current power status from the APM BIOS. We return a
980  *      status which gives the rough battery status, and current power
981  *      source. The bat value returned give an estimate as a percentage
982  *      of life and a status value for the battery. The estimated life
983  *      if reported is a lifetime in secodnds/minutes at current powwer
984  *      consumption.
985  */
986  
987 static int apm_get_power_status(u_short *status, u_short *bat, u_short *life)
988 {
989         u32     eax;
990         u32     ebx;
991         u32     ecx;
992         u32     edx;
993         u32     dummy;
994
995         if (apm_info.get_power_status_broken)
996                 return APM_32_UNSUPPORTED;
997         if (apm_bios_call(APM_FUNC_GET_STATUS, APM_DEVICE_ALL, 0,
998                         &eax, &ebx, &ecx, &edx, &dummy))
999                 return (eax >> 8) & 0xff;
1000         *status = ebx;
1001         *bat = ecx;
1002         if (apm_info.get_power_status_swabinminutes) {
1003                 *life = swab16((u16)edx);
1004                 *life |= 0x8000;
1005         } else
1006                 *life = edx;
1007         return APM_SUCCESS;
1008 }
1009
1010 #if 0
1011 static int apm_get_battery_status(u_short which, u_short *status,
1012                                   u_short *bat, u_short *life, u_short *nbat)
1013 {
1014         u32     eax;
1015         u32     ebx;
1016         u32     ecx;
1017         u32     edx;
1018         u32     esi;
1019
1020         if (apm_info.connection_version < 0x0102) {
1021                 /* pretend we only have one battery. */
1022                 if (which != 1)
1023                         return APM_BAD_DEVICE;
1024                 *nbat = 1;
1025                 return apm_get_power_status(status, bat, life);
1026         }
1027
1028         if (apm_bios_call(APM_FUNC_GET_STATUS, (0x8000 | (which)), 0, &eax,
1029                         &ebx, &ecx, &edx, &esi))
1030                 return (eax >> 8) & 0xff;
1031         *status = ebx;
1032         *bat = ecx;
1033         *life = edx;
1034         *nbat = esi;
1035         return APM_SUCCESS;
1036 }
1037 #endif
1038
1039 /**
1040  *      apm_engage_power_management     -       enable PM on a device
1041  *      @device: identity of device
1042  *      @enable: on/off
1043  *
1044  *      Activate or deactive power management on either a specific device
1045  *      or the entire system (%APM_DEVICE_ALL).
1046  */
1047  
1048 static int apm_engage_power_management(u_short device, int enable)
1049 {
1050         u32     eax;
1051
1052         if ((enable == 0) && (device == APM_DEVICE_ALL)
1053             && (apm_info.bios.flags & APM_BIOS_DISABLED))
1054                 return APM_DISABLED;
1055         if (apm_bios_call_simple(APM_FUNC_ENGAGE_PM, device, enable, &eax))
1056                 return (eax >> 8) & 0xff;
1057         if (device == APM_DEVICE_ALL) {
1058                 if (enable)
1059                         apm_info.bios.flags &= ~APM_BIOS_DISENGAGED;
1060                 else
1061                         apm_info.bios.flags |= APM_BIOS_DISENGAGED;
1062         }
1063         return APM_SUCCESS;
1064 }
1065
1066 #if defined(CONFIG_APM_DISPLAY_BLANK) && defined(CONFIG_VT)
1067
1068 /**
1069  *      apm_console_blank       -       blank the display
1070  *      @blank: on/off
1071  *
1072  *      Attempt to blank the console, firstly by blanking just video device
1073  *      zero, and if that fails (some BIOSes don't support it) then it blanks
1074  *      all video devices. Typically the BIOS will do laptop backlight and
1075  *      monitor powerdown for us.
1076  */
1077  
1078 static int apm_console_blank(int blank)
1079 {
1080         int error = APM_NOT_ENGAGED; /* silence gcc */
1081         int i;
1082         u_short state;
1083         static const u_short dev[3] = { 0x100, 0x1FF, 0x101 };
1084
1085         state = blank ? APM_STATE_STANDBY : APM_STATE_READY;
1086
1087         for (i = 0; i < ARRAY_SIZE(dev); i++) {
1088                 error = set_power_state(dev[i], state);
1089
1090                 if ((error == APM_SUCCESS) || (error == APM_NO_ERROR))
1091                         return 1;
1092
1093                 if (error == APM_NOT_ENGAGED)
1094                         break;
1095         }
1096
1097         if (error == APM_NOT_ENGAGED) {
1098                 static int tried;
1099                 int eng_error;
1100                 if (tried++ == 0) {
1101                         eng_error = apm_engage_power_management(APM_DEVICE_ALL, 1);
1102                         if (eng_error) {
1103                                 apm_error("set display", error);
1104                                 apm_error("engage interface", eng_error);
1105                                 return 0;
1106                         } else
1107                                 return apm_console_blank(blank);
1108                 }
1109         }
1110         apm_error("set display", error);
1111         return 0;
1112 }
1113 #endif
1114
1115 static int queue_empty(struct apm_user *as)
1116 {
1117         return as->event_head == as->event_tail;
1118 }
1119
1120 static apm_event_t get_queued_event(struct apm_user *as)
1121 {
1122         if (++as->event_tail >= APM_MAX_EVENTS)
1123                 as->event_tail = 0;
1124         return as->events[as->event_tail];
1125 }
1126
1127 static void queue_event(apm_event_t event, struct apm_user *sender)
1128 {
1129         struct apm_user *       as;
1130
1131         spin_lock(&user_list_lock);
1132         if (user_list == NULL)
1133                 goto out;
1134         for (as = user_list; as != NULL; as = as->next) {
1135                 if ((as == sender) || (!as->reader))
1136                         continue;
1137                 if (++as->event_head >= APM_MAX_EVENTS)
1138                         as->event_head = 0;
1139
1140                 if (as->event_head == as->event_tail) {
1141                         static int notified;
1142
1143                         if (notified++ == 0)
1144                             printk(KERN_ERR "apm: an event queue overflowed\n");
1145                         if (++as->event_tail >= APM_MAX_EVENTS)
1146                                 as->event_tail = 0;
1147                 }
1148                 as->events[as->event_head] = event;
1149                 if ((!as->suser) || (!as->writer))
1150                         continue;
1151                 switch (event) {
1152                 case APM_SYS_SUSPEND:
1153                 case APM_USER_SUSPEND:
1154                         as->suspends_pending++;
1155                         suspends_pending++;
1156                         break;
1157
1158                 case APM_SYS_STANDBY:
1159                 case APM_USER_STANDBY:
1160                         as->standbys_pending++;
1161                         standbys_pending++;
1162                         break;
1163                 }
1164         }
1165         wake_up_interruptible(&apm_waitqueue);
1166 out:
1167         spin_unlock(&user_list_lock);
1168 }
1169
1170 static void reinit_timer(void)
1171 {
1172 #ifdef INIT_TIMER_AFTER_SUSPEND
1173         unsigned long flags;
1174
1175         spin_lock_irqsave(&i8253_lock, flags);
1176         /* set the clock to HZ */
1177         outb_p(0x34, PIT_MODE);         /* binary, mode 2, LSB/MSB, ch 0 */
1178         udelay(10);
1179         outb_p(LATCH & 0xff, PIT_CH0);  /* LSB */
1180         udelay(10);
1181         outb(LATCH >> 8, PIT_CH0);      /* MSB */
1182         udelay(10);
1183         spin_unlock_irqrestore(&i8253_lock, flags);
1184 #endif
1185 }
1186
1187 static int suspend(int vetoable)
1188 {
1189         int             err;
1190         struct apm_user *as;
1191
1192         if (pm_send_all(PM_SUSPEND, (void *)3)) {
1193                 /* Vetoed */
1194                 if (vetoable) {
1195                         if (apm_info.connection_version > 0x100)
1196                                 set_system_power_state(APM_STATE_REJECT);
1197                         err = -EBUSY;
1198                         ignore_sys_suspend = 0;
1199                         printk(KERN_WARNING "apm: suspend was vetoed.\n");
1200                         goto out;
1201                 }
1202                 printk(KERN_CRIT "apm: suspend was vetoed, but suspending anyway.\n");
1203         }
1204
1205         device_suspend(PMSG_SUSPEND);
1206         local_irq_disable();
1207         device_power_down(PMSG_SUSPEND);
1208
1209         local_irq_enable();
1210
1211         save_processor_state();
1212         err = set_system_power_state(APM_STATE_SUSPEND);
1213         ignore_normal_resume = 1;
1214         restore_processor_state();
1215
1216         local_irq_disable();
1217         reinit_timer();
1218
1219         if (err == APM_NO_ERROR)
1220                 err = APM_SUCCESS;
1221         if (err != APM_SUCCESS)
1222                 apm_error("suspend", err);
1223         err = (err == APM_SUCCESS) ? 0 : -EIO;
1224         device_power_up();
1225         local_irq_enable();
1226         device_resume();
1227         pm_send_all(PM_RESUME, (void *)0);
1228         queue_event(APM_NORMAL_RESUME, NULL);
1229  out:
1230         spin_lock(&user_list_lock);
1231         for (as = user_list; as != NULL; as = as->next) {
1232                 as->suspend_wait = 0;
1233                 as->suspend_result = err;
1234         }
1235         spin_unlock(&user_list_lock);
1236         wake_up_interruptible(&apm_suspend_waitqueue);
1237         return err;
1238 }
1239
1240 static void standby(void)
1241 {
1242         int     err;
1243
1244         local_irq_disable();
1245         device_power_down(PMSG_SUSPEND);
1246         local_irq_enable();
1247
1248         err = set_system_power_state(APM_STATE_STANDBY);
1249         if ((err != APM_SUCCESS) && (err != APM_NO_ERROR))
1250                 apm_error("standby", err);
1251
1252         local_irq_disable();
1253         device_power_up();
1254         local_irq_enable();
1255 }
1256
1257 static apm_event_t get_event(void)
1258 {
1259         int             error;
1260         apm_event_t     event = APM_NO_EVENTS; /* silence gcc */
1261         apm_eventinfo_t info;
1262
1263         static int notified;
1264
1265         /* we don't use the eventinfo */
1266         error = apm_get_event(&event, &info);
1267         if (error == APM_SUCCESS)
1268                 return event;
1269
1270         if ((error != APM_NO_EVENTS) && (notified++ == 0))
1271                 apm_error("get_event", error);
1272
1273         return 0;
1274 }
1275
1276 static void check_events(void)
1277 {
1278         apm_event_t             event;
1279         static unsigned long    last_resume;
1280         static int              ignore_bounce;
1281
1282         while ((event = get_event()) != 0) {
1283                 if (debug) {
1284                         if (event <= NR_APM_EVENT_NAME)
1285                                 printk(KERN_DEBUG "apm: received %s notify\n",
1286                                        apm_event_name[event - 1]);
1287                         else
1288                                 printk(KERN_DEBUG "apm: received unknown "
1289                                        "event 0x%02x\n", event);
1290                 }
1291                 if (ignore_bounce
1292                     && ((jiffies - last_resume) > bounce_interval))
1293                         ignore_bounce = 0;
1294
1295                 switch (event) {
1296                 case APM_SYS_STANDBY:
1297                 case APM_USER_STANDBY:
1298                         queue_event(event, NULL);
1299                         if (standbys_pending <= 0)
1300                                 standby();
1301                         break;
1302
1303                 case APM_USER_SUSPEND:
1304 #ifdef CONFIG_APM_IGNORE_USER_SUSPEND
1305                         if (apm_info.connection_version > 0x100)
1306                                 set_system_power_state(APM_STATE_REJECT);
1307                         break;
1308 #endif
1309                 case APM_SYS_SUSPEND:
1310                         if (ignore_bounce) {
1311                                 if (apm_info.connection_version > 0x100)
1312                                         set_system_power_state(APM_STATE_REJECT);
1313                                 break;
1314                         }
1315                         /*
1316                          * If we are already processing a SUSPEND,
1317                          * then further SUSPEND events from the BIOS
1318                          * will be ignored.  We also return here to
1319                          * cope with the fact that the Thinkpads keep
1320                          * sending a SUSPEND event until something else
1321                          * happens!
1322                          */
1323                         if (ignore_sys_suspend)
1324                                 return;
1325                         ignore_sys_suspend = 1;
1326                         queue_event(event, NULL);
1327                         if (suspends_pending <= 0)
1328                                 (void) suspend(1);
1329                         break;
1330
1331                 case APM_NORMAL_RESUME:
1332                 case APM_CRITICAL_RESUME:
1333                 case APM_STANDBY_RESUME:
1334                         ignore_sys_suspend = 0;
1335                         last_resume = jiffies;
1336                         ignore_bounce = 1;
1337                         if ((event != APM_NORMAL_RESUME)
1338                             || (ignore_normal_resume == 0)) {
1339                                 device_resume();
1340                                 pm_send_all(PM_RESUME, (void *)0);
1341                                 queue_event(event, NULL);
1342                         }
1343                         ignore_normal_resume = 0;
1344                         break;
1345
1346                 case APM_CAPABILITY_CHANGE:
1347                 case APM_LOW_BATTERY:
1348                 case APM_POWER_STATUS_CHANGE:
1349                         queue_event(event, NULL);
1350                         /* If needed, notify drivers here */
1351                         break;
1352
1353                 case APM_UPDATE_TIME:
1354                         break;
1355
1356                 case APM_CRITICAL_SUSPEND:
1357                         /*
1358                          * We are not allowed to reject a critical suspend.
1359                          */
1360                         (void) suspend(0);
1361                         break;
1362                 }
1363         }
1364 }
1365
1366 static void apm_event_handler(void)
1367 {
1368         static int      pending_count = 4;
1369         int             err;
1370
1371         if ((standbys_pending > 0) || (suspends_pending > 0)) {
1372                 if ((apm_info.connection_version > 0x100) &&
1373                                 (pending_count-- <= 0)) {
1374                         pending_count = 4;
1375                         if (debug)
1376                                 printk(KERN_DEBUG "apm: setting state busy\n");
1377                         err = set_system_power_state(APM_STATE_BUSY);
1378                         if (err)
1379                                 apm_error("busy", err);
1380                 }
1381         } else
1382                 pending_count = 4;
1383         check_events();
1384 }
1385
1386 /*
1387  * This is the APM thread main loop.
1388  */
1389
1390 static void apm_mainloop(void)
1391 {
1392         DECLARE_WAITQUEUE(wait, current);
1393
1394         add_wait_queue(&apm_waitqueue, &wait);
1395         set_current_state(TASK_INTERRUPTIBLE);
1396         for (;;) {
1397                 schedule_timeout(APM_CHECK_TIMEOUT);
1398                 if (kthread_should_stop())
1399                         break;
1400                 /*
1401                  * Ok, check all events, check for idle (and mark us sleeping
1402                  * so as not to count towards the load average)..
1403                  */
1404                 set_current_state(TASK_INTERRUPTIBLE);
1405                 apm_event_handler();
1406         }
1407         remove_wait_queue(&apm_waitqueue, &wait);
1408 }
1409
1410 static int check_apm_user(struct apm_user *as, const char *func)
1411 {
1412         if ((as == NULL) || (as->magic != APM_BIOS_MAGIC)) {
1413                 printk(KERN_ERR "apm: %s passed bad filp\n", func);
1414                 return 1;
1415         }
1416         return 0;
1417 }
1418
1419 static ssize_t do_read(struct file *fp, char __user *buf, size_t count, loff_t *ppos)
1420 {
1421         struct apm_user *       as;
1422         int                     i;
1423         apm_event_t             event;
1424
1425         as = fp->private_data;
1426         if (check_apm_user(as, "read"))
1427                 return -EIO;
1428         if ((int)count < sizeof(apm_event_t))
1429                 return -EINVAL;
1430         if ((queue_empty(as)) && (fp->f_flags & O_NONBLOCK))
1431                 return -EAGAIN;
1432         wait_event_interruptible(apm_waitqueue, !queue_empty(as));
1433         i = count;
1434         while ((i >= sizeof(event)) && !queue_empty(as)) {
1435                 event = get_queued_event(as);
1436                 if (copy_to_user(buf, &event, sizeof(event))) {
1437                         if (i < count)
1438                                 break;
1439                         return -EFAULT;
1440                 }
1441                 switch (event) {
1442                 case APM_SYS_SUSPEND:
1443                 case APM_USER_SUSPEND:
1444                         as->suspends_read++;
1445                         break;
1446
1447                 case APM_SYS_STANDBY:
1448                 case APM_USER_STANDBY:
1449                         as->standbys_read++;
1450                         break;
1451                 }
1452                 buf += sizeof(event);
1453                 i -= sizeof(event);
1454         }
1455         if (i < count)
1456                 return count - i;
1457         if (signal_pending(current))
1458                 return -ERESTARTSYS;
1459         return 0;
1460 }
1461
1462 static unsigned int do_poll(struct file *fp, poll_table * wait)
1463 {
1464         struct apm_user * as;
1465
1466         as = fp->private_data;
1467         if (check_apm_user(as, "poll"))
1468                 return 0;
1469         poll_wait(fp, &apm_waitqueue, wait);
1470         if (!queue_empty(as))
1471                 return POLLIN | POLLRDNORM;
1472         return 0;
1473 }
1474
1475 static int do_ioctl(struct inode * inode, struct file *filp,
1476                     u_int cmd, u_long arg)
1477 {
1478         struct apm_user *       as;
1479
1480         as = filp->private_data;
1481         if (check_apm_user(as, "ioctl"))
1482                 return -EIO;
1483         if ((!as->suser) || (!as->writer))
1484                 return -EPERM;
1485         switch (cmd) {
1486         case APM_IOC_STANDBY:
1487                 if (as->standbys_read > 0) {
1488                         as->standbys_read--;
1489                         as->standbys_pending--;
1490                         standbys_pending--;
1491                 } else
1492                         queue_event(APM_USER_STANDBY, as);
1493                 if (standbys_pending <= 0)
1494                         standby();
1495                 break;
1496         case APM_IOC_SUSPEND:
1497                 if (as->suspends_read > 0) {
1498                         as->suspends_read--;
1499                         as->suspends_pending--;
1500                         suspends_pending--;
1501                 } else
1502                         queue_event(APM_USER_SUSPEND, as);
1503                 if (suspends_pending <= 0) {
1504                         return suspend(1);
1505                 } else {
1506                         as->suspend_wait = 1;
1507                         wait_event_interruptible(apm_suspend_waitqueue,
1508                                         as->suspend_wait == 0);
1509                         return as->suspend_result;
1510                 }
1511                 break;
1512         default:
1513                 return -EINVAL;
1514         }
1515         return 0;
1516 }
1517
1518 static int do_release(struct inode * inode, struct file * filp)
1519 {
1520         struct apm_user *       as;
1521
1522         as = filp->private_data;
1523         if (check_apm_user(as, "release"))
1524                 return 0;
1525         filp->private_data = NULL;
1526         if (as->standbys_pending > 0) {
1527                 standbys_pending -= as->standbys_pending;
1528                 if (standbys_pending <= 0)
1529                         standby();
1530         }
1531         if (as->suspends_pending > 0) {
1532                 suspends_pending -= as->suspends_pending;
1533                 if (suspends_pending <= 0)
1534                         (void) suspend(1);
1535         }
1536         spin_lock(&user_list_lock);
1537         if (user_list == as)
1538                 user_list = as->next;
1539         else {
1540                 struct apm_user *       as1;
1541
1542                 for (as1 = user_list;
1543                      (as1 != NULL) && (as1->next != as);
1544                      as1 = as1->next)
1545                         ;
1546                 if (as1 == NULL)
1547                         printk(KERN_ERR "apm: filp not in user list\n");
1548                 else
1549                         as1->next = as->next;
1550         }
1551         spin_unlock(&user_list_lock);
1552         kfree(as);
1553         return 0;
1554 }
1555
1556 static int do_open(struct inode * inode, struct file * filp)
1557 {
1558         struct apm_user *       as;
1559
1560         as = kmalloc(sizeof(*as), GFP_KERNEL);
1561         if (as == NULL) {
1562                 printk(KERN_ERR "apm: cannot allocate struct of size %d bytes\n",
1563                        sizeof(*as));
1564                 return -ENOMEM;
1565         }
1566         as->magic = APM_BIOS_MAGIC;
1567         as->event_tail = as->event_head = 0;
1568         as->suspends_pending = as->standbys_pending = 0;
1569         as->suspends_read = as->standbys_read = 0;
1570         /*
1571          * XXX - this is a tiny bit broken, when we consider BSD
1572          * process accounting. If the device is opened by root, we
1573          * instantly flag that we used superuser privs. Who knows,
1574          * we might close the device immediately without doing a
1575          * privileged operation -- cevans
1576          */
1577         as->suser = capable(CAP_SYS_ADMIN);
1578         as->writer = (filp->f_mode & FMODE_WRITE) == FMODE_WRITE;
1579         as->reader = (filp->f_mode & FMODE_READ) == FMODE_READ;
1580         spin_lock(&user_list_lock);
1581         as->next = user_list;
1582         user_list = as;
1583         spin_unlock(&user_list_lock);
1584         filp->private_data = as;
1585         return 0;
1586 }
1587
1588 static int proc_apm_show(struct seq_file *m, void *v)
1589 {
1590         unsigned short  bx;
1591         unsigned short  cx;
1592         unsigned short  dx;
1593         int             error;
1594         unsigned short  ac_line_status = 0xff;
1595         unsigned short  battery_status = 0xff;
1596         unsigned short  battery_flag   = 0xff;
1597         int             percentage     = -1;
1598         int             time_units     = -1;
1599         char            *units         = "?";
1600
1601         if ((num_online_cpus() == 1) &&
1602             !(error = apm_get_power_status(&bx, &cx, &dx))) {
1603                 ac_line_status = (bx >> 8) & 0xff;
1604                 battery_status = bx & 0xff;
1605                 if ((cx & 0xff) != 0xff)
1606                         percentage = cx & 0xff;
1607
1608                 if (apm_info.connection_version > 0x100) {
1609                         battery_flag = (cx >> 8) & 0xff;
1610                         if (dx != 0xffff) {
1611                                 units = (dx & 0x8000) ? "min" : "sec";
1612                                 time_units = dx & 0x7fff;
1613                         }
1614                 }
1615         }
1616         /* Arguments, with symbols from linux/apm_bios.h.  Information is
1617            from the Get Power Status (0x0a) call unless otherwise noted.
1618
1619            0) Linux driver version (this will change if format changes)
1620            1) APM BIOS Version.  Usually 1.0, 1.1 or 1.2.
1621            2) APM flags from APM Installation Check (0x00):
1622               bit 0: APM_16_BIT_SUPPORT
1623               bit 1: APM_32_BIT_SUPPORT
1624               bit 2: APM_IDLE_SLOWS_CLOCK
1625               bit 3: APM_BIOS_DISABLED
1626               bit 4: APM_BIOS_DISENGAGED
1627            3) AC line status
1628               0x00: Off-line
1629               0x01: On-line
1630               0x02: On backup power (BIOS >= 1.1 only)
1631               0xff: Unknown
1632            4) Battery status
1633               0x00: High
1634               0x01: Low
1635               0x02: Critical
1636               0x03: Charging
1637               0x04: Selected battery not present (BIOS >= 1.2 only)
1638               0xff: Unknown
1639            5) Battery flag
1640               bit 0: High
1641               bit 1: Low
1642               bit 2: Critical
1643               bit 3: Charging
1644               bit 7: No system battery
1645               0xff: Unknown
1646            6) Remaining battery life (percentage of charge):
1647               0-100: valid
1648               -1: Unknown
1649            7) Remaining battery life (time units):
1650               Number of remaining minutes or seconds
1651               -1: Unknown
1652            8) min = minutes; sec = seconds */
1653
1654         seq_printf(m, "%s %d.%d 0x%02x 0x%02x 0x%02x 0x%02x %d%% %d %s\n",
1655                      driver_version,
1656                      (apm_info.bios.version >> 8) & 0xff,
1657                      apm_info.bios.version & 0xff,
1658                      apm_info.bios.flags,
1659                      ac_line_status,
1660                      battery_status,
1661                      battery_flag,
1662                      percentage,
1663                      time_units,
1664                      units);
1665         return 0;
1666 }
1667
1668 static int proc_apm_open(struct inode *inode, struct file *file)
1669 {
1670         return single_open(file, proc_apm_show, NULL);
1671 }
1672
1673 static const struct file_operations apm_file_ops = {
1674         .owner          = THIS_MODULE,
1675         .open           = proc_apm_open,
1676         .read           = seq_read,
1677         .llseek         = seq_lseek,
1678         .release        = single_release,
1679 };
1680
1681 static int apm(void *unused)
1682 {
1683         unsigned short  bx;
1684         unsigned short  cx;
1685         unsigned short  dx;
1686         int             error;
1687         char *          power_stat;
1688         char *          bat_stat;
1689
1690 #ifdef CONFIG_SMP
1691         /* 2002/08/01 - WT
1692          * This is to avoid random crashes at boot time during initialization
1693          * on SMP systems in case of "apm=power-off" mode. Seen on ASUS A7M266D.
1694          * Some bioses don't like being called from CPU != 0.
1695          * Method suggested by Ingo Molnar.
1696          */
1697         set_cpus_allowed(current, cpumask_of_cpu(0));
1698         BUG_ON(smp_processor_id() != 0);
1699 #endif
1700
1701         if (apm_info.connection_version == 0) {
1702                 apm_info.connection_version = apm_info.bios.version;
1703                 if (apm_info.connection_version > 0x100) {
1704                         /*
1705                          * We only support BIOSs up to version 1.2
1706                          */
1707                         if (apm_info.connection_version > 0x0102)
1708                                 apm_info.connection_version = 0x0102;
1709                         error = apm_driver_version(&apm_info.connection_version);
1710                         if (error != APM_SUCCESS) {
1711                                 apm_error("driver version", error);
1712                                 /* Fall back to an APM 1.0 connection. */
1713                                 apm_info.connection_version = 0x100;
1714                         }
1715                 }
1716         }
1717
1718         if (debug)
1719                 printk(KERN_INFO "apm: Connection version %d.%d\n",
1720                         (apm_info.connection_version >> 8) & 0xff,
1721                         apm_info.connection_version & 0xff);
1722
1723 #ifdef CONFIG_APM_DO_ENABLE
1724         if (apm_info.bios.flags & APM_BIOS_DISABLED) {
1725                 /*
1726                  * This call causes my NEC UltraLite Versa 33/C to hang if it
1727                  * is booted with PM disabled but not in the docking station.
1728                  * Unfortunate ...
1729                  */
1730                 error = apm_enable_power_management(1);
1731                 if (error) {
1732                         apm_error("enable power management", error);
1733                         return -1;
1734                 }
1735         }
1736 #endif
1737
1738         if ((apm_info.bios.flags & APM_BIOS_DISENGAGED)
1739             && (apm_info.connection_version > 0x0100)) {
1740                 error = apm_engage_power_management(APM_DEVICE_ALL, 1);
1741                 if (error) {
1742                         apm_error("engage power management", error);
1743                         return -1;
1744                 }
1745         }
1746
1747         if (debug && (num_online_cpus() == 1 || smp )) {
1748                 error = apm_get_power_status(&bx, &cx, &dx);
1749                 if (error)
1750                         printk(KERN_INFO "apm: power status not available\n");
1751                 else {
1752                         switch ((bx >> 8) & 0xff) {
1753                         case 0: power_stat = "off line"; break;
1754                         case 1: power_stat = "on line"; break;
1755                         case 2: power_stat = "on backup power"; break;
1756                         default: power_stat = "unknown"; break;
1757                         }
1758                         switch (bx & 0xff) {
1759                         case 0: bat_stat = "high"; break;
1760                         case 1: bat_stat = "low"; break;
1761                         case 2: bat_stat = "critical"; break;
1762                         case 3: bat_stat = "charging"; break;
1763                         default: bat_stat = "unknown"; break;
1764                         }
1765                         printk(KERN_INFO
1766                                "apm: AC %s, battery status %s, battery life ",
1767                                power_stat, bat_stat);
1768                         if ((cx & 0xff) == 0xff)
1769                                 printk("unknown\n");
1770                         else
1771                                 printk("%d%%\n", cx & 0xff);
1772                         if (apm_info.connection_version > 0x100) {
1773                                 printk(KERN_INFO
1774                                        "apm: battery flag 0x%02x, battery life ",
1775                                        (cx >> 8) & 0xff);
1776                                 if (dx == 0xffff)
1777                                         printk("unknown\n");
1778                                 else
1779                                         printk("%d %s\n", dx & 0x7fff,
1780                                                 (dx & 0x8000) ?
1781                                                 "minutes" : "seconds");
1782                         }
1783                 }
1784         }
1785
1786         /* Install our power off handler.. */
1787         if (power_off)
1788                 pm_power_off = apm_power_off;
1789
1790         if (num_online_cpus() == 1 || smp) {
1791 #if defined(CONFIG_APM_DISPLAY_BLANK) && defined(CONFIG_VT)
1792                 console_blank_hook = apm_console_blank;
1793 #endif
1794                 apm_mainloop();
1795 #if defined(CONFIG_APM_DISPLAY_BLANK) && defined(CONFIG_VT)
1796                 console_blank_hook = NULL;
1797 #endif
1798         }
1799
1800         return 0;
1801 }
1802
1803 #ifndef MODULE
1804 static int __init apm_setup(char *str)
1805 {
1806         int     invert;
1807
1808         while ((str != NULL) && (*str != '\0')) {
1809                 if (strncmp(str, "off", 3) == 0)
1810                         apm_disabled = 1;
1811                 if (strncmp(str, "on", 2) == 0)
1812                         apm_disabled = 0;
1813                 if ((strncmp(str, "bounce-interval=", 16) == 0) ||
1814                     (strncmp(str, "bounce_interval=", 16) == 0))
1815                         bounce_interval = simple_strtol(str + 16, NULL, 0);
1816                 if ((strncmp(str, "idle-threshold=", 15) == 0) ||
1817                     (strncmp(str, "idle_threshold=", 15) == 0))
1818                         idle_threshold = simple_strtol(str + 15, NULL, 0);
1819                 if ((strncmp(str, "idle-period=", 12) == 0) ||
1820                     (strncmp(str, "idle_period=", 12) == 0))
1821                         idle_period = simple_strtol(str + 12, NULL, 0);
1822                 invert = (strncmp(str, "no-", 3) == 0) ||
1823                         (strncmp(str, "no_", 3) == 0);
1824                 if (invert)
1825                         str += 3;
1826                 if (strncmp(str, "debug", 5) == 0)
1827                         debug = !invert;
1828                 if ((strncmp(str, "power-off", 9) == 0) ||
1829                     (strncmp(str, "power_off", 9) == 0))
1830                         power_off = !invert;
1831                 if (strncmp(str, "smp", 3) == 0)
1832                 {
1833                         smp = !invert;
1834                         idle_threshold = 100;
1835                 }
1836                 if ((strncmp(str, "allow-ints", 10) == 0) ||
1837                     (strncmp(str, "allow_ints", 10) == 0))
1838                         apm_info.allow_ints = !invert;
1839                 if ((strncmp(str, "broken-psr", 10) == 0) ||
1840                     (strncmp(str, "broken_psr", 10) == 0))
1841                         apm_info.get_power_status_broken = !invert;
1842                 if ((strncmp(str, "realmode-power-off", 18) == 0) ||
1843                     (strncmp(str, "realmode_power_off", 18) == 0))
1844                         apm_info.realmode_power_off = !invert;
1845                 str = strchr(str, ',');
1846                 if (str != NULL)
1847                         str += strspn(str, ", \t");
1848         }
1849         return 1;
1850 }
1851
1852 __setup("apm=", apm_setup);
1853 #endif
1854
1855 static const struct file_operations apm_bios_fops = {
1856         .owner          = THIS_MODULE,
1857         .read           = do_read,
1858         .poll           = do_poll,
1859         .ioctl          = do_ioctl,
1860         .open           = do_open,
1861         .release        = do_release,
1862 };
1863
1864 static struct miscdevice apm_device = {
1865         APM_MINOR_DEV,
1866         "apm_bios",
1867         &apm_bios_fops
1868 };
1869
1870
1871 /* Simple "print if true" callback */
1872 static int __init print_if_true(struct dmi_system_id *d)
1873 {
1874         printk("%s\n", d->ident);
1875         return 0;
1876 }
1877
1878 /*
1879  * Some Bioses enable the PS/2 mouse (touchpad) at resume, even if it was
1880  * disabled before the suspend. Linux used to get terribly confused by that.
1881  */
1882 static int __init broken_ps2_resume(struct dmi_system_id *d)
1883 {
1884         printk(KERN_INFO "%s machine detected. Mousepad Resume Bug workaround hopefully not needed.\n", d->ident);
1885         return 0;
1886 }
1887
1888 /* Some bioses have a broken protected mode poweroff and need to use realmode */
1889 static int __init set_realmode_power_off(struct dmi_system_id *d)
1890 {
1891         if (apm_info.realmode_power_off == 0) {
1892                 apm_info.realmode_power_off = 1;
1893                 printk(KERN_INFO "%s bios detected. Using realmode poweroff only.\n", d->ident);
1894         }
1895         return 0;
1896 }
1897
1898 /* Some laptops require interrupts to be enabled during APM calls */
1899 static int __init set_apm_ints(struct dmi_system_id *d)
1900 {
1901         if (apm_info.allow_ints == 0) {
1902                 apm_info.allow_ints = 1;
1903                 printk(KERN_INFO "%s machine detected. Enabling interrupts during APM calls.\n", d->ident);
1904         }
1905         return 0;
1906 }
1907
1908 /* Some APM bioses corrupt memory or just plain do not work */
1909 static int __init apm_is_horked(struct dmi_system_id *d)
1910 {
1911         if (apm_info.disabled == 0) {
1912                 apm_info.disabled = 1;
1913                 printk(KERN_INFO "%s machine detected. Disabling APM.\n", d->ident);
1914         }
1915         return 0;
1916 }
1917
1918 static int __init apm_is_horked_d850md(struct dmi_system_id *d)
1919 {
1920         if (apm_info.disabled == 0) {
1921                 apm_info.disabled = 1;
1922                 printk(KERN_INFO "%s machine detected. Disabling APM.\n", d->ident);
1923                 printk(KERN_INFO "This bug is fixed in bios P15 which is available for \n");
1924                 printk(KERN_INFO "download from support.intel.com \n");
1925         }
1926         return 0;
1927 }
1928
1929 /* Some APM bioses hang on APM idle calls */
1930 static int __init apm_likes_to_melt(struct dmi_system_id *d)
1931 {
1932         if (apm_info.forbid_idle == 0) {
1933                 apm_info.forbid_idle = 1;
1934                 printk(KERN_INFO "%s machine detected. Disabling APM idle calls.\n", d->ident);
1935         }
1936         return 0;
1937 }
1938
1939 /*
1940  *  Check for clue free BIOS implementations who use
1941  *  the following QA technique
1942  *
1943  *      [ Write BIOS Code ]<------
1944  *               |                ^
1945  *      < Does it Compile >----N--
1946  *               |Y               ^
1947  *      < Does it Boot Win98 >-N--
1948  *               |Y
1949  *           [Ship It]
1950  *
1951  *      Phoenix A04  08/24/2000 is known bad (Dell Inspiron 5000e)
1952  *      Phoenix A07  09/29/2000 is known good (Dell Inspiron 5000)
1953  */
1954 static int __init broken_apm_power(struct dmi_system_id *d)
1955 {
1956         apm_info.get_power_status_broken = 1;
1957         printk(KERN_WARNING "BIOS strings suggest APM bugs, disabling power status reporting.\n");
1958         return 0;
1959 }
1960
1961 /*
1962  * This bios swaps the APM minute reporting bytes over (Many sony laptops
1963  * have this problem).
1964  */
1965 static int __init swab_apm_power_in_minutes(struct dmi_system_id *d)
1966 {
1967         apm_info.get_power_status_swabinminutes = 1;
1968         printk(KERN_WARNING "BIOS strings suggest APM reports battery life in minutes and wrong byte order.\n");
1969         return 0;
1970 }
1971
1972 static struct dmi_system_id __initdata apm_dmi_table[] = {
1973         {
1974                 print_if_true,
1975                 KERN_WARNING "IBM T23 - BIOS 1.03b+ and controller firmware 1.02+ may be needed for Linux APM.",
1976                 {       DMI_MATCH(DMI_SYS_VENDOR, "IBM"),
1977                         DMI_MATCH(DMI_BIOS_VERSION, "1AET38WW (1.01b)"), },
1978         },
1979         {       /* Handle problems with APM on the C600 */
1980                 broken_ps2_resume, "Dell Latitude C600",
1981                 {       DMI_MATCH(DMI_SYS_VENDOR, "Dell"),
1982                         DMI_MATCH(DMI_PRODUCT_NAME, "Latitude C600"), },
1983         },
1984         {       /* Allow interrupts during suspend on Dell Latitude laptops*/
1985                 set_apm_ints, "Dell Latitude",
1986                 {       DMI_MATCH(DMI_SYS_VENDOR, "Dell Computer Corporation"),
1987                         DMI_MATCH(DMI_PRODUCT_NAME, "Latitude C510"), }
1988         },
1989         {       /* APM crashes */
1990                 apm_is_horked, "Dell Inspiron 2500",
1991                 {       DMI_MATCH(DMI_SYS_VENDOR, "Dell Computer Corporation"),
1992                         DMI_MATCH(DMI_PRODUCT_NAME, "Inspiron 2500"),
1993                         DMI_MATCH(DMI_BIOS_VENDOR,"Phoenix Technologies LTD"),
1994                         DMI_MATCH(DMI_BIOS_VERSION,"A11"), },
1995         },
1996         {       /* Allow interrupts during suspend on Dell Inspiron laptops*/
1997                 set_apm_ints, "Dell Inspiron", {
1998                         DMI_MATCH(DMI_SYS_VENDOR, "Dell Computer Corporation"),
1999                         DMI_MATCH(DMI_PRODUCT_NAME, "Inspiron 4000"), },
2000         },
2001         {       /* Handle problems with APM on Inspiron 5000e */
2002                 broken_apm_power, "Dell Inspiron 5000e",
2003                 {       DMI_MATCH(DMI_BIOS_VENDOR, "Phoenix Technologies LTD"),
2004                         DMI_MATCH(DMI_BIOS_VERSION, "A04"),
2005                         DMI_MATCH(DMI_BIOS_DATE, "08/24/2000"), },
2006         },
2007         {       /* Handle problems with APM on Inspiron 2500 */
2008                 broken_apm_power, "Dell Inspiron 2500",
2009                 {       DMI_MATCH(DMI_BIOS_VENDOR, "Phoenix Technologies LTD"),
2010                         DMI_MATCH(DMI_BIOS_VERSION, "A12"),
2011                         DMI_MATCH(DMI_BIOS_DATE, "02/04/2002"), },
2012         },
2013         {       /* APM crashes */
2014                 apm_is_horked, "Dell Dimension 4100",
2015                 {       DMI_MATCH(DMI_SYS_VENDOR, "Dell Computer Corporation"),
2016                         DMI_MATCH(DMI_PRODUCT_NAME, "XPS-Z"),
2017                         DMI_MATCH(DMI_BIOS_VENDOR,"Intel Corp."),
2018                         DMI_MATCH(DMI_BIOS_VERSION,"A11"), },
2019         },
2020         {       /* Allow interrupts during suspend on Compaq Laptops*/
2021                 set_apm_ints, "Compaq 12XL125",
2022                 {       DMI_MATCH(DMI_SYS_VENDOR, "Compaq"),
2023                         DMI_MATCH(DMI_PRODUCT_NAME, "Compaq PC"),
2024                         DMI_MATCH(DMI_BIOS_VENDOR, "Phoenix Technologies LTD"),
2025                         DMI_MATCH(DMI_BIOS_VERSION,"4.06"), },
2026         },
2027         {       /* Allow interrupts during APM or the clock goes slow */
2028                 set_apm_ints, "ASUSTeK",
2029                 {       DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK Computer Inc."),
2030                         DMI_MATCH(DMI_PRODUCT_NAME, "L8400K series Notebook PC"), },
2031         },
2032         {       /* APM blows on shutdown */
2033                 apm_is_horked, "ABIT KX7-333[R]",
2034                 {       DMI_MATCH(DMI_BOARD_VENDOR, "ABIT"),
2035                         DMI_MATCH(DMI_BOARD_NAME, "VT8367-8233A (KX7-333[R])"), },
2036         },
2037         {       /* APM crashes */
2038                 apm_is_horked, "Trigem Delhi3",
2039                 {       DMI_MATCH(DMI_SYS_VENDOR, "TriGem Computer, Inc"),
2040                         DMI_MATCH(DMI_PRODUCT_NAME, "Delhi3"), },
2041         },
2042         {       /* APM crashes */
2043                 apm_is_horked, "Fujitsu-Siemens",
2044                 {       DMI_MATCH(DMI_BIOS_VENDOR, "hoenix/FUJITSU SIEMENS"),
2045                         DMI_MATCH(DMI_BIOS_VERSION, "Version1.01"), },
2046         },
2047         {       /* APM crashes */
2048                 apm_is_horked_d850md, "Intel D850MD",
2049                 {       DMI_MATCH(DMI_BIOS_VENDOR, "Intel Corp."),
2050                         DMI_MATCH(DMI_BIOS_VERSION, "MV85010A.86A.0016.P07.0201251536"), },
2051         },
2052         {       /* APM crashes */
2053                 apm_is_horked, "Intel D810EMO",
2054                 {       DMI_MATCH(DMI_BIOS_VENDOR, "Intel Corp."),
2055                         DMI_MATCH(DMI_BIOS_VERSION, "MO81010A.86A.0008.P04.0004170800"), },
2056         },
2057         {       /* APM crashes */
2058                 apm_is_horked, "Dell XPS-Z",
2059                 {       DMI_MATCH(DMI_BIOS_VENDOR, "Intel Corp."),
2060                         DMI_MATCH(DMI_BIOS_VERSION, "A11"),
2061                         DMI_MATCH(DMI_PRODUCT_NAME, "XPS-Z"), },
2062         },
2063         {       /* APM crashes */
2064                 apm_is_horked, "Sharp PC-PJ/AX",
2065                 {       DMI_MATCH(DMI_SYS_VENDOR, "SHARP"),
2066                         DMI_MATCH(DMI_PRODUCT_NAME, "PC-PJ/AX"),
2067                         DMI_MATCH(DMI_BIOS_VENDOR,"SystemSoft"),
2068                         DMI_MATCH(DMI_BIOS_VERSION,"Version R2.08"), },
2069         },
2070         {       /* APM crashes */
2071                 apm_is_horked, "Dell Inspiron 2500",
2072                 {       DMI_MATCH(DMI_SYS_VENDOR, "Dell Computer Corporation"),
2073                         DMI_MATCH(DMI_PRODUCT_NAME, "Inspiron 2500"),
2074                         DMI_MATCH(DMI_BIOS_VENDOR,"Phoenix Technologies LTD"),
2075                         DMI_MATCH(DMI_BIOS_VERSION,"A11"), },
2076         },
2077         {       /* APM idle hangs */
2078                 apm_likes_to_melt, "Jabil AMD",
2079                 {       DMI_MATCH(DMI_BIOS_VENDOR, "American Megatrends Inc."),
2080                         DMI_MATCH(DMI_BIOS_VERSION, "0AASNP06"), },
2081         },
2082         {       /* APM idle hangs */
2083                 apm_likes_to_melt, "AMI Bios",
2084                 {       DMI_MATCH(DMI_BIOS_VENDOR, "American Megatrends Inc."),
2085                         DMI_MATCH(DMI_BIOS_VERSION, "0AASNP05"), },
2086         },
2087         {       /* Handle problems with APM on Sony Vaio PCG-N505X(DE) */
2088                 swab_apm_power_in_minutes, "Sony VAIO",
2089                 {       DMI_MATCH(DMI_BIOS_VENDOR, "Phoenix Technologies LTD"),
2090                         DMI_MATCH(DMI_BIOS_VERSION, "R0206H"),
2091                         DMI_MATCH(DMI_BIOS_DATE, "08/23/99"), },
2092         },
2093         {       /* Handle problems with APM on Sony Vaio PCG-N505VX */
2094                 swab_apm_power_in_minutes, "Sony VAIO",
2095                 {       DMI_MATCH(DMI_BIOS_VENDOR, "Phoenix Technologies LTD"),
2096                         DMI_MATCH(DMI_BIOS_VERSION, "W2K06H0"),
2097                         DMI_MATCH(DMI_BIOS_DATE, "02/03/00"), },
2098         },
2099         {       /* Handle problems with APM on Sony Vaio PCG-XG29 */
2100                 swab_apm_power_in_minutes, "Sony VAIO",
2101                 {       DMI_MATCH(DMI_BIOS_VENDOR, "Phoenix Technologies LTD"),
2102                         DMI_MATCH(DMI_BIOS_VERSION, "R0117A0"),
2103                         DMI_MATCH(DMI_BIOS_DATE, "04/25/00"), },
2104         },
2105         {       /* Handle problems with APM on Sony Vaio PCG-Z600NE */
2106                 swab_apm_power_in_minutes, "Sony VAIO",
2107                 {       DMI_MATCH(DMI_BIOS_VENDOR, "Phoenix Technologies LTD"),
2108                         DMI_MATCH(DMI_BIOS_VERSION, "R0121Z1"),
2109                         DMI_MATCH(DMI_BIOS_DATE, "05/11/00"), },
2110         },
2111         {       /* Handle problems with APM on Sony Vaio PCG-Z600NE */
2112                 swab_apm_power_in_minutes, "Sony VAIO",
2113                 {       DMI_MATCH(DMI_BIOS_VENDOR, "Phoenix Technologies LTD"),
2114                         DMI_MATCH(DMI_BIOS_VERSION, "WME01Z1"),
2115                         DMI_MATCH(DMI_BIOS_DATE, "08/11/00"), },
2116         },
2117         {       /* Handle problems with APM on Sony Vaio PCG-Z600LEK(DE) */
2118                 swab_apm_power_in_minutes, "Sony VAIO",
2119                 {       DMI_MATCH(DMI_BIOS_VENDOR, "Phoenix Technologies LTD"),
2120                         DMI_MATCH(DMI_BIOS_VERSION, "R0206Z3"),
2121                         DMI_MATCH(DMI_BIOS_DATE, "12/25/00"), },
2122         },
2123         {       /* Handle problems with APM on Sony Vaio PCG-Z505LS */
2124                 swab_apm_power_in_minutes, "Sony VAIO",
2125                 {       DMI_MATCH(DMI_BIOS_VENDOR, "Phoenix Technologies LTD"),
2126                         DMI_MATCH(DMI_BIOS_VERSION, "R0203D0"),
2127                         DMI_MATCH(DMI_BIOS_DATE, "05/12/00"), },
2128         },
2129         {       /* Handle problems with APM on Sony Vaio PCG-Z505LS */
2130                 swab_apm_power_in_minutes, "Sony VAIO",
2131                 {       DMI_MATCH(DMI_BIOS_VENDOR, "Phoenix Technologies LTD"),
2132                         DMI_MATCH(DMI_BIOS_VERSION, "R0203Z3"),
2133                         DMI_MATCH(DMI_BIOS_DATE, "08/25/00"), },
2134         },
2135         {       /* Handle problems with APM on Sony Vaio PCG-Z505LS (with updated BIOS) */
2136                 swab_apm_power_in_minutes, "Sony VAIO",
2137                 {       DMI_MATCH(DMI_BIOS_VENDOR, "Phoenix Technologies LTD"),
2138                         DMI_MATCH(DMI_BIOS_VERSION, "R0209Z3"),
2139                         DMI_MATCH(DMI_BIOS_DATE, "05/12/01"), },
2140         },
2141         {       /* Handle problems with APM on Sony Vaio PCG-F104K */
2142                 swab_apm_power_in_minutes, "Sony VAIO",
2143                 {       DMI_MATCH(DMI_BIOS_VENDOR, "Phoenix Technologies LTD"),
2144                         DMI_MATCH(DMI_BIOS_VERSION, "R0204K2"),
2145                         DMI_MATCH(DMI_BIOS_DATE, "08/28/00"), },
2146         },
2147
2148         {       /* Handle problems with APM on Sony Vaio PCG-C1VN/C1VE */
2149                 swab_apm_power_in_minutes, "Sony VAIO",
2150                 {       DMI_MATCH(DMI_BIOS_VENDOR, "Phoenix Technologies LTD"),
2151                         DMI_MATCH(DMI_BIOS_VERSION, "R0208P1"),
2152                         DMI_MATCH(DMI_BIOS_DATE, "11/09/00"), },
2153         },
2154         {       /* Handle problems with APM on Sony Vaio PCG-C1VE */
2155                 swab_apm_power_in_minutes, "Sony VAIO",
2156                 {       DMI_MATCH(DMI_BIOS_VENDOR, "Phoenix Technologies LTD"),
2157                         DMI_MATCH(DMI_BIOS_VERSION, "R0204P1"),
2158                         DMI_MATCH(DMI_BIOS_DATE, "09/12/00"), },
2159         },
2160         {       /* Handle problems with APM on Sony Vaio PCG-C1VE */
2161                 swab_apm_power_in_minutes, "Sony VAIO",
2162                 {       DMI_MATCH(DMI_BIOS_VENDOR, "Phoenix Technologies LTD"),
2163                         DMI_MATCH(DMI_BIOS_VERSION, "WXPO1Z3"),
2164                         DMI_MATCH(DMI_BIOS_DATE, "10/26/01"), },
2165         },
2166         {       /* broken PM poweroff bios */
2167                 set_realmode_power_off, "Award Software v4.60 PGMA",
2168                 {       DMI_MATCH(DMI_BIOS_VENDOR, "Award Software International, Inc."),
2169                         DMI_MATCH(DMI_BIOS_VERSION, "4.60 PGMA"),
2170                         DMI_MATCH(DMI_BIOS_DATE, "134526184"), },
2171         },
2172
2173         /* Generic per vendor APM settings  */
2174
2175         {       /* Allow interrupts during suspend on IBM laptops */
2176                 set_apm_ints, "IBM",
2177                 {       DMI_MATCH(DMI_SYS_VENDOR, "IBM"), },
2178         },
2179
2180         { }
2181 };
2182
2183 /*
2184  * Just start the APM thread. We do NOT want to do APM BIOS
2185  * calls from anything but the APM thread, if for no other reason
2186  * than the fact that we don't trust the APM BIOS. This way,
2187  * most common APM BIOS problems that lead to protection errors
2188  * etc will have at least some level of being contained...
2189  *
2190  * In short, if something bad happens, at least we have a choice
2191  * of just killing the apm thread..
2192  */
2193 static int __init apm_init(void)
2194 {
2195         struct proc_dir_entry *apm_proc;
2196         struct desc_struct *gdt;
2197         int err;
2198
2199         dmi_check_system(apm_dmi_table);
2200
2201         if (apm_info.bios.version == 0 || paravirt_enabled()) {
2202                 printk(KERN_INFO "apm: BIOS not found.\n");
2203                 return -ENODEV;
2204         }
2205         printk(KERN_INFO
2206                 "apm: BIOS version %d.%d Flags 0x%02x (Driver version %s)\n",
2207                 ((apm_info.bios.version >> 8) & 0xff),
2208                 (apm_info.bios.version & 0xff),
2209                 apm_info.bios.flags,
2210                 driver_version);
2211         if ((apm_info.bios.flags & APM_32_BIT_SUPPORT) == 0) {
2212                 printk(KERN_INFO "apm: no 32 bit BIOS support\n");
2213                 return -ENODEV;
2214         }
2215
2216         if (allow_ints)
2217                 apm_info.allow_ints = 1;
2218         if (broken_psr)
2219                 apm_info.get_power_status_broken = 1;
2220         if (realmode_power_off)
2221                 apm_info.realmode_power_off = 1;
2222         /* User can override, but default is to trust DMI */
2223         if (apm_disabled != -1)
2224                 apm_info.disabled = apm_disabled;
2225
2226         /*
2227          * Fix for the Compaq Contura 3/25c which reports BIOS version 0.1
2228          * but is reportedly a 1.0 BIOS.
2229          */
2230         if (apm_info.bios.version == 0x001)
2231                 apm_info.bios.version = 0x100;
2232
2233         /* BIOS < 1.2 doesn't set cseg_16_len */
2234         if (apm_info.bios.version < 0x102)
2235                 apm_info.bios.cseg_16_len = 0; /* 64k */
2236
2237         if (debug) {
2238                 printk(KERN_INFO "apm: entry %x:%lx cseg16 %x dseg %x",
2239                         apm_info.bios.cseg, apm_info.bios.offset,
2240                         apm_info.bios.cseg_16, apm_info.bios.dseg);
2241                 if (apm_info.bios.version > 0x100)
2242                         printk(" cseg len %x, dseg len %x",
2243                                 apm_info.bios.cseg_len,
2244                                 apm_info.bios.dseg_len);
2245                 if (apm_info.bios.version > 0x101)
2246                         printk(" cseg16 len %x", apm_info.bios.cseg_16_len);
2247                 printk("\n");
2248         }
2249
2250         if (apm_info.disabled) {
2251                 printk(KERN_NOTICE "apm: disabled on user request.\n");
2252                 return -ENODEV;
2253         }
2254         if ((num_online_cpus() > 1) && !power_off && !smp) {
2255                 printk(KERN_NOTICE "apm: disabled - APM is not SMP safe.\n");
2256                 apm_info.disabled = 1;
2257                 return -ENODEV;
2258         }
2259         if (PM_IS_ACTIVE()) {
2260                 printk(KERN_NOTICE "apm: overridden by ACPI.\n");
2261                 apm_info.disabled = 1;
2262                 return -ENODEV;
2263         }
2264 #ifdef CONFIG_PM_LEGACY
2265         pm_active = 1;
2266 #endif
2267
2268         /*
2269          * Set up a segment that references the real mode segment 0x40
2270          * that extends up to the end of page zero (that we have reserved).
2271          * This is for buggy BIOS's that refer to (real mode) segment 0x40
2272          * even though they are called in protected mode.
2273          */
2274         set_base(bad_bios_desc, __va((unsigned long)0x40 << 4));
2275         _set_limit((char *)&bad_bios_desc, 4095 - (0x40 << 4));
2276
2277         /*
2278          * Set up the long jump entry point to the APM BIOS, which is called
2279          * from inline assembly.
2280          */
2281         apm_bios_entry.offset = apm_info.bios.offset;
2282         apm_bios_entry.segment = APM_CS;
2283
2284         /*
2285          * The APM 1.1 BIOS is supposed to provide limit information that it
2286          * recognizes.  Many machines do this correctly, but many others do
2287          * not restrict themselves to their claimed limit.  When this happens,
2288          * they will cause a segmentation violation in the kernel at boot time.
2289          * Most BIOS's, however, will respect a 64k limit, so we use that.
2290          *
2291          * Note we only set APM segments on CPU zero, since we pin the APM
2292          * code to that CPU.
2293          */
2294         gdt = get_cpu_gdt_table(0);
2295         set_base(gdt[APM_CS >> 3],
2296                  __va((unsigned long)apm_info.bios.cseg << 4));
2297         set_base(gdt[APM_CS_16 >> 3],
2298                  __va((unsigned long)apm_info.bios.cseg_16 << 4));
2299         set_base(gdt[APM_DS >> 3],
2300                  __va((unsigned long)apm_info.bios.dseg << 4));
2301
2302         apm_proc = create_proc_entry("apm", 0, NULL);
2303         if (apm_proc)
2304                 apm_proc->proc_fops = &apm_file_ops;
2305
2306         kapmd_task = kthread_create(apm, NULL, "kapmd");
2307         if (IS_ERR(kapmd_task)) {
2308                 printk(KERN_ERR "apm: disabled - Unable to start kernel "
2309                                 "thread.\n");
2310                 err = PTR_ERR(kapmd_task);
2311                 kapmd_task = NULL;
2312                 remove_proc_entry("apm", NULL);
2313                 return err;
2314         }
2315         wake_up_process(kapmd_task);
2316
2317         if (num_online_cpus() > 1 && !smp ) {
2318                 printk(KERN_NOTICE
2319                    "apm: disabled - APM is not SMP safe (power off active).\n");
2320                 return 0;
2321         }
2322
2323         /*
2324          * Note we don't actually care if the misc_device cannot be registered.
2325          * this driver can do its job without it, even if userspace can't
2326          * control it.  just log the error
2327          */
2328         if (misc_register(&apm_device))
2329                 printk(KERN_WARNING "apm: Could not register misc device.\n");
2330
2331         if (HZ != 100)
2332                 idle_period = (idle_period * HZ) / 100;
2333         if (idle_threshold < 100) {
2334                 original_pm_idle = pm_idle;
2335                 pm_idle  = apm_cpu_idle;
2336                 set_pm_idle = 1;
2337         }
2338
2339         return 0;
2340 }
2341
2342 static void __exit apm_exit(void)
2343 {
2344         int     error;
2345
2346         if (set_pm_idle) {
2347                 pm_idle = original_pm_idle;
2348                 /*
2349                  * We are about to unload the current idle thread pm callback
2350                  * (pm_idle), Wait for all processors to update cached/local
2351                  * copies of pm_idle before proceeding.
2352                  */
2353                 cpu_idle_wait();
2354         }
2355         if (((apm_info.bios.flags & APM_BIOS_DISENGAGED) == 0)
2356             && (apm_info.connection_version > 0x0100)) {
2357                 error = apm_engage_power_management(APM_DEVICE_ALL, 0);
2358                 if (error)
2359                         apm_error("disengage power management", error);
2360         }
2361         misc_deregister(&apm_device);
2362         remove_proc_entry("apm", NULL);
2363         if (power_off)
2364                 pm_power_off = NULL;
2365         if (kapmd_task) {
2366                 kthread_stop(kapmd_task);
2367                 kapmd_task = NULL;
2368         }
2369 #ifdef CONFIG_PM_LEGACY
2370         pm_active = 0;
2371 #endif
2372 }
2373
2374 module_init(apm_init);
2375 module_exit(apm_exit);
2376
2377 MODULE_AUTHOR("Stephen Rothwell");
2378 MODULE_DESCRIPTION("Advanced Power Management");
2379 MODULE_LICENSE("GPL");
2380 module_param(debug, bool, 0644);
2381 MODULE_PARM_DESC(debug, "Enable debug mode");
2382 module_param(power_off, bool, 0444);
2383 MODULE_PARM_DESC(power_off, "Enable power off");
2384 module_param(bounce_interval, int, 0444);
2385 MODULE_PARM_DESC(bounce_interval,
2386                 "Set the number of ticks to ignore suspend bounces");
2387 module_param(allow_ints, bool, 0444);
2388 MODULE_PARM_DESC(allow_ints, "Allow interrupts during BIOS calls");
2389 module_param(broken_psr, bool, 0444);
2390 MODULE_PARM_DESC(broken_psr, "BIOS has a broken GetPowerStatus call");
2391 module_param(realmode_power_off, bool, 0444);
2392 MODULE_PARM_DESC(realmode_power_off,
2393                 "Switch to real mode before powering off");
2394 module_param(idle_threshold, int, 0444);
2395 MODULE_PARM_DESC(idle_threshold,
2396         "System idle percentage above which to make APM BIOS idle calls");
2397 module_param(idle_period, int, 0444);
2398 MODULE_PARM_DESC(idle_period,
2399         "Period (in sec/100) over which to caculate the idle percentage");
2400 module_param(smp, bool, 0444);
2401 MODULE_PARM_DESC(smp,
2402         "Set this to enable APM use on an SMP platform. Use with caution on older systems");
2403 MODULE_ALIAS_MISCDEV(APM_MINOR_DEV);