aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation
diff options
context:
space:
mode:
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/CodingStyle18
-rw-r--r--Documentation/DocBook/Makefile4
-rw-r--r--Documentation/DocBook/genericirq.tmpl4
-rw-r--r--Documentation/DocBook/libata.tmpl2
-rw-r--r--Documentation/SubmitChecklist4
-rw-r--r--Documentation/SubmittingPatches6
-rw-r--r--Documentation/arm/Samsung-S3C24XX/Overview.txt30
-rw-r--r--Documentation/block/biodoc.txt7
-rw-r--r--Documentation/cachetlb.txt5
-rw-r--r--Documentation/feature-removal-schedule.txt68
-rw-r--r--Documentation/filesystems/9p.txt20
-rw-r--r--Documentation/filesystems/Locking8
-rw-r--r--Documentation/filesystems/fuse.txt4
-rw-r--r--Documentation/filesystems/ntfs.txt2
-rw-r--r--Documentation/hwmon/w837938
-rw-r--r--Documentation/i386/boot.txt3
-rw-r--r--Documentation/ibm-acpi.txt151
-rw-r--r--Documentation/kdump/kdump.txt249
-rw-r--r--Documentation/kernel-parameters.txt8
-rw-r--r--Documentation/pci.txt702
-rw-r--r--Documentation/powerpc/booting-without-of.txt19
-rw-r--r--Documentation/powerpc/mpc52xx-device-tree-bindings.txt10
-rw-r--r--Documentation/scsi/aacraid.txt66
-rw-r--r--Documentation/sound/alsa/DocBook/writing-an-alsa-driver.tmpl8
-rw-r--r--Documentation/sysrq.txt66
-rw-r--r--Documentation/tty.txt111
-rw-r--r--Documentation/usb/CREDITS2
-rw-r--r--Documentation/usb/acm.txt4
-rw-r--r--Documentation/x86_64/boot-options.txt4
29 files changed, 1231 insertions, 362 deletions
diff --git a/Documentation/CodingStyle b/Documentation/CodingStyle
index 0ad6dcb5d45f..9069189e78ef 100644
--- a/Documentation/CodingStyle
+++ b/Documentation/CodingStyle
@@ -682,6 +682,24 @@ result. Typical examples would be functions that return pointers; they use
682NULL or the ERR_PTR mechanism to report failure. 682NULL or the ERR_PTR mechanism to report failure.
683 683
684 684
685 Chapter 17: Don't re-invent the kernel macros
686
687The header file include/linux/kernel.h contains a number of macros that
688you should use, rather than explicitly coding some variant of them yourself.
689For example, if you need to calculate the length of an array, take advantage
690of the macro
691
692 #define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]))
693
694Similarly, if you need to calculate the size of some structure member, use
695
696 #define FIELD_SIZEOF(t, f) (sizeof(((t*)0)->f))
697
698There are also min() and max() macros that do strict type checking if you
699need them. Feel free to peruse that header file to see what else is already
700defined that you shouldn't reproduce in your code.
701
702
685 703
686 Appendix I: References 704 Appendix I: References
687 705
diff --git a/Documentation/DocBook/Makefile b/Documentation/DocBook/Makefile
index 36526a1e76d7..867608ab3ca0 100644
--- a/Documentation/DocBook/Makefile
+++ b/Documentation/DocBook/Makefile
@@ -53,8 +53,8 @@ installmandocs: mandocs
53 53
54### 54###
55#External programs used 55#External programs used
56KERNELDOC = scripts/kernel-doc 56KERNELDOC = $(srctree)/scripts/kernel-doc
57DOCPROC = scripts/basic/docproc 57DOCPROC = $(objtree)/scripts/basic/docproc
58 58
59XMLTOFLAGS = -m $(srctree)/Documentation/DocBook/stylesheet.xsl 59XMLTOFLAGS = -m $(srctree)/Documentation/DocBook/stylesheet.xsl
60#XMLTOFLAGS += --skip-validation 60#XMLTOFLAGS += --skip-validation
diff --git a/Documentation/DocBook/genericirq.tmpl b/Documentation/DocBook/genericirq.tmpl
index 0f4a4b6321e4..4215f69ce7e6 100644
--- a/Documentation/DocBook/genericirq.tmpl
+++ b/Documentation/DocBook/genericirq.tmpl
@@ -303,10 +303,10 @@ desc->status |= running;
303do { 303do {
304 if (desc->status & masked) 304 if (desc->status & masked)
305 desc->chip->enable(); 305 desc->chip->enable();
306 desc-status &= ~pending; 306 desc->status &= ~pending;
307 handle_IRQ_event(desc->action); 307 handle_IRQ_event(desc->action);
308} while (status & pending); 308} while (status & pending);
309desc-status &= ~running; 309desc->status &= ~running;
310desc->chip->end(); 310desc->chip->end();
311 </programlisting> 311 </programlisting>
312 </para> 312 </para>
diff --git a/Documentation/DocBook/libata.tmpl b/Documentation/DocBook/libata.tmpl
index 07a635590b36..e2e24b4778d4 100644
--- a/Documentation/DocBook/libata.tmpl
+++ b/Documentation/DocBook/libata.tmpl
@@ -883,7 +883,7 @@ and other resources, etc.
883 </chapter> 883 </chapter>
884 884
885 <chapter id="ataExceptions"> 885 <chapter id="ataExceptions">
886 <title>ATA errors &amp; exceptions</title> 886 <title>ATA errors and exceptions</title>
887 887
888 <para> 888 <para>
889 This chapter tries to identify what error/exception conditions exist 889 This chapter tries to identify what error/exception conditions exist
diff --git a/Documentation/SubmitChecklist b/Documentation/SubmitChecklist
index 2270efa10153..bfbb2718a279 100644
--- a/Documentation/SubmitChecklist
+++ b/Documentation/SubmitChecklist
@@ -72,3 +72,7 @@ kernel patches.
72 72
73 If the new code is substantial, addition of subsystem-specific fault 73 If the new code is substantial, addition of subsystem-specific fault
74 injection might be appropriate. 74 injection might be appropriate.
75
7622: Newly-added code has been compiled with `gcc -W'. This will generate
77 lots of noise, but is good for finding bugs like "warning: comparison
78 between signed and unsigned".
diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches
index 302d148c2e18..b0d0043f7c46 100644
--- a/Documentation/SubmittingPatches
+++ b/Documentation/SubmittingPatches
@@ -134,9 +134,9 @@ Do not send more than 15 patches at once to the vger mailing lists!!!
134 134
135 135
136Linus Torvalds is the final arbiter of all changes accepted into the 136Linus Torvalds is the final arbiter of all changes accepted into the
137Linux kernel. His e-mail address is <torvalds@osdl.org>. He gets 137Linux kernel. His e-mail address is <torvalds@linux-foundation.org>.
138a lot of e-mail, so typically you should do your best to -avoid- sending 138He gets a lot of e-mail, so typically you should do your best to -avoid-
139him e-mail. 139sending him e-mail.
140 140
141Patches which are bug fixes, are "obvious" changes, or similarly 141Patches which are bug fixes, are "obvious" changes, or similarly
142require little discussion should be sent or CC'd to Linus. Patches 142require little discussion should be sent or CC'd to Linus. Patches
diff --git a/Documentation/arm/Samsung-S3C24XX/Overview.txt b/Documentation/arm/Samsung-S3C24XX/Overview.txt
index dda7ecdde87b..28d014714ab8 100644
--- a/Documentation/arm/Samsung-S3C24XX/Overview.txt
+++ b/Documentation/arm/Samsung-S3C24XX/Overview.txt
@@ -76,6 +76,15 @@ Machines
76 A S3C2410 based PDA from Acer. There is a Wiki page at 76 A S3C2410 based PDA from Acer. There is a Wiki page at
77 http://handhelds.org/moin/moin.cgi/AcerN30Documentation . 77 http://handhelds.org/moin/moin.cgi/AcerN30Documentation .
78 78
79 AML M5900
80
81 American Microsystems' M5900
82
83 Nex Vision Nexcoder
84 Nex Vision Otom
85
86 Two machines by Nex Vision
87
79 88
80Adding New Machines 89Adding New Machines
81------------------- 90-------------------
@@ -115,6 +124,10 @@ RTC
115 124
116 Support for the onboard RTC unit, including alarm function. 125 Support for the onboard RTC unit, including alarm function.
117 126
127 This has recently been upgraded to use the new RTC core,
128 and the module has been renamed to rtc-s3c to fit in with
129 the new rtc naming scheme.
130
118 131
119Watchdog 132Watchdog
120-------- 133--------
@@ -128,7 +141,7 @@ NAND
128 141
129 The current kernels now have support for the s3c2410 NAND 142 The current kernels now have support for the s3c2410 NAND
130 controller. If there are any problems the latest linux-mtd 143 controller. If there are any problems the latest linux-mtd
131 CVS can be found from http://www.linux-mtd.infradead.org/ 144 code can be found from http://www.linux-mtd.infradead.org/
132 145
133 146
134Serial 147Serial
@@ -168,6 +181,21 @@ Suspend to RAM
168 See Suspend.txt for more information. 181 See Suspend.txt for more information.
169 182
170 183
184SPI
185---
186
187 SPI drivers are available for both the in-built hardware
188 (although there is no DMA support yet) and a generic
189 GPIO based solution.
190
191
192LEDs
193----
194
195 There is support for GPIO based LEDs via a platform driver
196 in the LED subsystem.
197
198
171Platform Data 199Platform Data
172------------- 200-------------
173 201
diff --git a/Documentation/block/biodoc.txt b/Documentation/block/biodoc.txt
index c6c9a9c10d7f..3adaace328a6 100644
--- a/Documentation/block/biodoc.txt
+++ b/Documentation/block/biodoc.txt
@@ -946,6 +946,13 @@ elevator_merged_fn called when a request in the scheduler has been
946 scheduler for example, to reposition the request 946 scheduler for example, to reposition the request
947 if its sorting order has changed. 947 if its sorting order has changed.
948 948
949elevator_allow_merge_fn called whenever the block layer determines
950 that a bio can be merged into an existing
951 request safely. The io scheduler may still
952 want to stop a merge at this point if it
953 results in some sort of conflict internally,
954 this hook allows it to do that.
955
949elevator_dispatch_fn fills the dispatch queue with ready requests. 956elevator_dispatch_fn fills the dispatch queue with ready requests.
950 I/O schedulers are free to postpone requests by 957 I/O schedulers are free to postpone requests by
951 not filling the dispatch queue unless @force 958 not filling the dispatch queue unless @force
diff --git a/Documentation/cachetlb.txt b/Documentation/cachetlb.txt
index 73e794f0ff09..debf6813934a 100644
--- a/Documentation/cachetlb.txt
+++ b/Documentation/cachetlb.txt
@@ -373,14 +373,15 @@ maps this page at its virtual address.
373 likely that you will need to flush the instruction cache 373 likely that you will need to flush the instruction cache
374 for copy_to_user_page(). 374 for copy_to_user_page().
375 375
376 void flush_anon_page(struct page *page, unsigned long vmaddr) 376 void flush_anon_page(struct vm_area_struct *vma, struct page *page,
377 unsigned long vmaddr)
377 When the kernel needs to access the contents of an anonymous 378 When the kernel needs to access the contents of an anonymous
378 page, it calls this function (currently only 379 page, it calls this function (currently only
379 get_user_pages()). Note: flush_dcache_page() deliberately 380 get_user_pages()). Note: flush_dcache_page() deliberately
380 doesn't work for an anonymous page. The default 381 doesn't work for an anonymous page. The default
381 implementation is a nop (and should remain so for all coherent 382 implementation is a nop (and should remain so for all coherent
382 architectures). For incoherent architectures, it should flush 383 architectures). For incoherent architectures, it should flush
383 the cache of the page at vmaddr in the current user process. 384 the cache of the page at vmaddr.
384 385
385 void flush_kernel_dcache_page(struct page *page) 386 void flush_kernel_dcache_page(struct page *page)
386 When the kernel needs to modify a user page is has obtained 387 When the kernel needs to modify a user page is has obtained
diff --git a/Documentation/feature-removal-schedule.txt b/Documentation/feature-removal-schedule.txt
index 9bc37529f4cd..b3d1ce7e3ba0 100644
--- a/Documentation/feature-removal-schedule.txt
+++ b/Documentation/feature-removal-schedule.txt
@@ -226,6 +226,23 @@ Who: Jean Delvare <khali@linux-fr.org>
226 226
227--------------------------- 227---------------------------
228 228
229What: i2c_adapter.dev
230 i2c_adapter.list
231When: July 2007
232Why: Superfluous, given i2c_adapter.class_dev:
233 * The "dev" was a stand-in for the physical device node that legacy
234 drivers would not have; but now it's almost always present. Any
235 remaining legacy drivers must upgrade (they now trigger warnings).
236 * The "list" duplicates class device children.
237 The delay in removing this is so upgraded lm_sensors and libsensors
238 can get deployed. (Removal causes minor changes in the sysfs layout,
239 notably the location of the adapter type name and parenting the i2c
240 client hardware directly from their controller.)
241Who: Jean Delvare <khali@linux-fr.org>,
242 David Brownell <dbrownell@users.sourceforge.net>
243
244---------------------------
245
229What: IPv4 only connection tracking/NAT/helpers 246What: IPv4 only connection tracking/NAT/helpers
230When: 2.6.22 247When: 2.6.22
231Why: The new layer 3 independant connection tracking replaces the old 248Why: The new layer 3 independant connection tracking replaces the old
@@ -257,6 +274,43 @@ Who: Venkatesh Pallipadi <venkatesh.pallipadi@intel.com>
257 274
258--------------------------- 275---------------------------
259 276
277<<<<<<< test:Documentation/feature-removal-schedule.txt
278What: ACPI hotkey driver (CONFIG_ACPI_HOTKEY)
279When: 2.6.21
280Why: hotkey.c was an attempt to consolidate multiple drivers that use
281 ACPI to implement hotkeys. However, hotkeys are not documented
282 in the ACPI specification, so the drivers used undocumented
283 vendor-specific hooks and turned out to be more different than
284 the same.
285
286 Further, the keys and the features supplied by each platform
287 are different, so there will always be a need for
288 platform-specific drivers.
289
290 So the new plan is to delete hotkey.c and instead, work on the
291 platform specific drivers to try to make them look the same
292 to the user when they supply the same features.
293
294 hotkey.c has always depended on CONFIG_EXPERIMENTAL
295
296Who: Len Brown <len.brown@intel.com>
297
298---------------------------
299
300What: /sys/firmware/acpi/namespace
301When: 2.6.21
302Why: The ACPI namespace is effectively the symbol list for
303 the BIOS. The device names are completely arbitrary
304 and have no place being exposed to user-space.
305
306 For those interested in the BIOS ACPI namespace,
307 the BIOS can be extracted and disassembled with acpidump
308 and iasl as documented in the pmtools package here:
309 http://ftp.kernel.org/pub/linux/kernel/people/lenb/acpi/utils
310Who: Len Brown <len.brown@intel.com>
311
312---------------------------
313
260What: ACPI procfs interface 314What: ACPI procfs interface
261When: July 2007 315When: July 2007
262Why: After ACPI sysfs conversion, ACPI attributes will be duplicated 316Why: After ACPI sysfs conversion, ACPI attributes will be duplicated
@@ -265,3 +319,17 @@ Who: Zhang Rui <rui.zhang@intel.com>
265 319
266--------------------------- 320---------------------------
267 321
322What: /proc/acpi/button
323When: August 2007
324Why: /proc/acpi/button has been replaced by events to the input layer
325 since 2.6.20.
326Who: Len Brown <len.brown@intel.com>
327
328---------------------------
329
330What: JFFS (version 1)
331When: 2.6.21
332Why: Unmaintained for years, superceded by JFFS2 for years.
333Who: Jeff Garzik <jeff@garzik.org>
334
335---------------------------
diff --git a/Documentation/filesystems/9p.txt b/Documentation/filesystems/9p.txt
index 43b89c214d20..4d075a4558f9 100644
--- a/Documentation/filesystems/9p.txt
+++ b/Documentation/filesystems/9p.txt
@@ -73,8 +73,22 @@ OPTIONS
73RESOURCES 73RESOURCES
74========= 74=========
75 75
76The Linux version of the 9p server is now maintained under the npfs project 76Our current recommendation is to use Inferno (http://www.vitanuova.com/inferno)
77on sourceforge (http://sourceforge.net/projects/npfs). 77as the 9p server. You can start a 9p server under Inferno by issuing the
78following command:
79 ; styxlisten -A tcp!*!564 export '#U*'
80
81The -A specifies an unauthenticated export. The 564 is the port # (you may
82have to choose a higher port number if running as a normal user). The '#U*'
83specifies exporting the root of the Linux name space. You may specify a
84subset of the namespace by extending the path: '#U*'/tmp would just export
85/tmp. For more information, see the Inferno manual pages covering styxlisten
86and export.
87
88A Linux version of the 9p server is now maintained under the npfs project
89on sourceforge (http://sourceforge.net/projects/npfs). There is also a
90more stable single-threaded version of the server (named spfs) available from
91the same CVS repository.
78 92
79There are user and developer mailing lists available through the v9fs project 93There are user and developer mailing lists available through the v9fs project
80on sourceforge (http://sourceforge.net/projects/v9fs). 94on sourceforge (http://sourceforge.net/projects/v9fs).
@@ -96,5 +110,5 @@ STATUS
96 110
97The 2.6 kernel support is working on PPC and x86. 111The 2.6 kernel support is working on PPC and x86.
98 112
99PLEASE USE THE SOURCEFORGE BUG-TRACKER TO REPORT PROBLEMS. 113PLEASE USE THE KERNEL BUGZILLA TO REPORT PROBLEMS. (http://bugzilla.kernel.org)
100 114
diff --git a/Documentation/filesystems/Locking b/Documentation/filesystems/Locking
index 790ef6fbe495..28bfea75bcf2 100644
--- a/Documentation/filesystems/Locking
+++ b/Documentation/filesystems/Locking
@@ -171,6 +171,7 @@ prototypes:
171 int (*releasepage) (struct page *, int); 171 int (*releasepage) (struct page *, int);
172 int (*direct_IO)(int, struct kiocb *, const struct iovec *iov, 172 int (*direct_IO)(int, struct kiocb *, const struct iovec *iov,
173 loff_t offset, unsigned long nr_segs); 173 loff_t offset, unsigned long nr_segs);
174 int (*launder_page) (struct page *);
174 175
175locking rules: 176locking rules:
176 All except set_page_dirty may block 177 All except set_page_dirty may block
@@ -188,6 +189,7 @@ bmap: yes
188invalidatepage: no yes 189invalidatepage: no yes
189releasepage: no yes 190releasepage: no yes
190direct_IO: no 191direct_IO: no
192launder_page: no yes
191 193
192 ->prepare_write(), ->commit_write(), ->sync_page() and ->readpage() 194 ->prepare_write(), ->commit_write(), ->sync_page() and ->readpage()
193may be called from the request handler (/dev/loop). 195may be called from the request handler (/dev/loop).
@@ -281,6 +283,12 @@ buffers from the page in preparation for freeing it. It returns zero to
281indicate that the buffers are (or may be) freeable. If ->releasepage is zero, 283indicate that the buffers are (or may be) freeable. If ->releasepage is zero,
282the kernel assumes that the fs has no private interest in the buffers. 284the kernel assumes that the fs has no private interest in the buffers.
283 285
286 ->launder_page() may be called prior to releasing a page if
287it is still found to be dirty. It returns zero if the page was successfully
288cleaned, or an error value if not. Note that in order to prevent the page
289getting mapped back in and redirtied, it needs to be kept locked
290across the entire operation.
291
284 Note: currently almost all instances of address_space methods are 292 Note: currently almost all instances of address_space methods are
285using BKL for internal serialization and that's one of the worst sources 293using BKL for internal serialization and that's one of the worst sources
286of contention. Normally they are calling library functions (in fs/buffer.c) 294of contention. Normally they are calling library functions (in fs/buffer.c)
diff --git a/Documentation/filesystems/fuse.txt b/Documentation/filesystems/fuse.txt
index 345392c4caeb..397a41adb4c3 100644
--- a/Documentation/filesystems/fuse.txt
+++ b/Documentation/filesystems/fuse.txt
@@ -94,8 +94,8 @@ Mount options
94 filesystem is free to implement it's access policy or leave it to 94 filesystem is free to implement it's access policy or leave it to
95 the underlying file access mechanism (e.g. in case of network 95 the underlying file access mechanism (e.g. in case of network
96 filesystems). This option enables permission checking, restricting 96 filesystems). This option enables permission checking, restricting
97 access based on file mode. This is option is usually useful 97 access based on file mode. It is usually useful together with the
98 together with the 'allow_other' mount option. 98 'allow_other' mount option.
99 99
100'allow_other' 100'allow_other'
101 101
diff --git a/Documentation/filesystems/ntfs.txt b/Documentation/filesystems/ntfs.txt
index 13ba649bda75..81779068b09b 100644
--- a/Documentation/filesystems/ntfs.txt
+++ b/Documentation/filesystems/ntfs.txt
@@ -457,6 +457,8 @@ ChangeLog
457 457
458Note, a technical ChangeLog aimed at kernel hackers is in fs/ntfs/ChangeLog. 458Note, a technical ChangeLog aimed at kernel hackers is in fs/ntfs/ChangeLog.
459 459
4602.1.28:
461 - Fix a deadlock.
4602.1.27: 4622.1.27:
461 - Implement page migration support so the kernel can move memory used 463 - Implement page migration support so the kernel can move memory used
462 by NTFS files and directories around for management purposes. 464 by NTFS files and directories around for management purposes.
diff --git a/Documentation/hwmon/w83793 b/Documentation/hwmon/w83793
index 45e5408340e0..51171a83165b 100644
--- a/Documentation/hwmon/w83793
+++ b/Documentation/hwmon/w83793
@@ -45,18 +45,14 @@ This driver implements support for Winbond W83793G/W83793R chips.
45 temp5-6 have a 1 degree Celsiis resolution. 45 temp5-6 have a 1 degree Celsiis resolution.
46 46
47* Temperature sensor types 47* Temperature sensor types
48 Temp1-4 have 3 possible types. It can be read from (and written to) 48 Temp1-4 have 2 possible types. It can be read from (and written to)
49 temp[1-4]_type. 49 temp[1-4]_type.
50 - If the value of 0, the related temperature channel stops
51 monitoring.
52 - If the value is 3, it starts monitoring using a remote termal diode 50 - If the value is 3, it starts monitoring using a remote termal diode
53 (default). 51 (default).
54 - If the value is 5, it starts monitoring using the temperature sensor
55 in AMD CPU and get result by AMDSI.
56 - If the value is 6, it starts monitoring using the temperature sensor 52 - If the value is 6, it starts monitoring using the temperature sensor
57 in Intel CPU and get result by PECI. 53 in Intel CPU and get result by PECI.
58 Temp5-6 can be connected to external thermistors (value of 54 Temp5-6 can be connected to external thermistors (value of
59 temp[5-6]_type is 4). They can also be disabled (value is 0). 55 temp[5-6]_type is 4).
60 56
61* Alarm mechanism 57* Alarm mechanism
62 For voltage sensors, an alarm triggers if the measured value is below 58 For voltage sensors, an alarm triggers if the measured value is below
diff --git a/Documentation/i386/boot.txt b/Documentation/i386/boot.txt
index 9575de300a61..38fe1f03fb14 100644
--- a/Documentation/i386/boot.txt
+++ b/Documentation/i386/boot.txt
@@ -2,7 +2,7 @@
2 ---------------------------- 2 ----------------------------
3 3
4 H. Peter Anvin <hpa@zytor.com> 4 H. Peter Anvin <hpa@zytor.com>
5 Last update 2006-11-17 5 Last update 2007-01-26
6 6
7On the i386 platform, the Linux kernel uses a rather complicated boot 7On the i386 platform, the Linux kernel uses a rather complicated boot
8convention. This has evolved partially due to historical aspects, as 8convention. This has evolved partially due to historical aspects, as
@@ -186,6 +186,7 @@ filled out, however:
186 7 GRuB 186 7 GRuB
187 8 U-BOOT 187 8 U-BOOT
188 9 Xen 188 9 Xen
189 A Gujin
189 190
190 Please contact <hpa@zytor.com> if you need a bootloader ID 191 Please contact <hpa@zytor.com> if you need a bootloader ID
191 value assigned. 192 value assigned.
diff --git a/Documentation/ibm-acpi.txt b/Documentation/ibm-acpi.txt
index e50595bfd8ea..0132d363feb5 100644
--- a/Documentation/ibm-acpi.txt
+++ b/Documentation/ibm-acpi.txt
@@ -398,25 +398,67 @@ Temperature sensors -- /proc/acpi/ibm/thermal
398 398
399Most ThinkPads include six or more separate temperature sensors but 399Most ThinkPads include six or more separate temperature sensors but
400only expose the CPU temperature through the standard ACPI methods. 400only expose the CPU temperature through the standard ACPI methods.
401This feature shows readings from up to eight different sensors. Some 401This feature shows readings from up to eight different sensors on older
402readings may not be valid, e.g. may show large negative values. For 402ThinkPads, and it has experimental support for up to sixteen different
403example, on the X40, a typical output may be: 403sensors on newer ThinkPads. Readings from sensors that are not available
404return -128.
404 405
406No commands can be written to this file.
407
408EXPERIMENTAL: The 16-sensors feature is marked EXPERIMENTAL because the
409implementation directly accesses hardware registers and may not work as
410expected. USE WITH CAUTION! To use this feature, you need to supply the
411experimental=1 parameter when loading the module. When EXPERIMENTAL
412mode is enabled, reading the first 8 sensors on newer ThinkPads will
413also use an new experimental thermal sensor access mode.
414
415For example, on the X40, a typical output may be:
405temperatures: 42 42 45 41 36 -128 33 -128 416temperatures: 42 42 45 41 36 -128 33 -128
406 417
407Thomas Gruber took his R51 apart and traced all six active sensors in 418EXPERIMENTAL: On the T43/p, a typical output may be:
408his laptop (the location of sensors may vary on other models): 419temperatures: 48 48 36 52 38 -128 31 -128 48 52 48 -128 -128 -128 -128 -128
420
421The mapping of thermal sensors to physical locations varies depending on
422system-board model (and thus, on ThinkPad model).
423
424http://thinkwiki.org/wiki/Thermal_Sensors is a public wiki page that
425tries to track down these locations for various models.
426
427Most (newer?) models seem to follow this pattern:
409 428
4101: CPU 4291: CPU
4112: Mini PCI Module 4302: (depends on model)
4123: HDD 4313: (depends on model)
4134: GPU 4324: GPU
4145: Battery 4335: Main battery: main sensor
4156: N/A 4346: Bay battery: main sensor
4167: Battery 4357: Main battery: secondary sensor
4178: N/A 4368: Bay battery: secondary sensor
4379-15: (depends on model)
438
439For the R51 (source: Thomas Gruber):
4402: Mini-PCI
4413: Internal HDD
442
443For the T43, T43/p (source: Shmidoax/Thinkwiki.org)
444http://thinkwiki.org/wiki/Thermal_Sensors#ThinkPad_T43.2C_T43p
4452: System board, left side (near PCMCIA slot), reported as HDAPS temp
4463: PCMCIA slot
4479: MCH (northbridge) to DRAM Bus
44810: ICH (southbridge), under Mini-PCI card, under touchpad
44911: Power regulator, underside of system board, below F2 key
450
451The A31 has a very atypical layout for the thermal sensors
452(source: Milos Popovic, http://thinkwiki.org/wiki/Thermal_Sensors#ThinkPad_A31)
4531: CPU
4542: Main Battery: main sensor
4553: Power Converter
4564: Bay Battery: main sensor
4575: MCH (northbridge)
4586: PCMCIA/ambient
4597: Main Battery: secondary sensor
4608: Bay Battery: secondary sensor
418 461
419No commands can be written to this file.
420 462
421EXPERIMENTAL: Embedded controller register dump -- /proc/acpi/ibm/ecdump 463EXPERIMENTAL: Embedded controller register dump -- /proc/acpi/ibm/ecdump
422------------------------------------------------------------------------ 464------------------------------------------------------------------------
@@ -529,27 +571,57 @@ directly accesses hardware registers and may not work as expected. USE
529WITH CAUTION! To use this feature, you need to supply the 571WITH CAUTION! To use this feature, you need to supply the
530experimental=1 parameter when loading the module. 572experimental=1 parameter when loading the module.
531 573
532This feature attempts to show the current fan speed. The speed is read 574This feature attempts to show the current fan speed, control mode and
533directly from the hardware registers of the embedded controller. This 575other fan data that might be available. The speed is read directly
534is known to work on later R, T and X series ThinkPads but may show a 576from the hardware registers of the embedded controller. This is known
535bogus value on other models. 577to work on later R, T and X series ThinkPads but may show a bogus
578value on other models.
579
580Most ThinkPad fans work in "levels". Level 0 stops the fan. The higher
581the level, the higher the fan speed, although adjacent levels often map
582to the same fan speed. 7 is the highest level, where the fan reaches
583the maximum recommended speed. Level "auto" means the EC changes the
584fan level according to some internal algorithm, usually based on
585readings from the thermal sensors. Level "disengaged" means the EC
586disables the speed-locked closed-loop fan control, and drives the fan as
587fast as it can go, which might exceed hardware limits, so use this level
588with caution.
589
590The fan usually ramps up or down slowly from one speed to another,
591and it is normal for the EC to take several seconds to react to fan
592commands.
536 593
537The fan may be enabled or disabled with the following commands: 594The fan may be enabled or disabled with the following commands:
538 595
539 echo enable >/proc/acpi/ibm/fan 596 echo enable >/proc/acpi/ibm/fan
540 echo disable >/proc/acpi/ibm/fan 597 echo disable >/proc/acpi/ibm/fan
541 598
599Placing a fan on level 0 is the same as disabling it. Enabling a fan
600will try to place it in a safe level if it is too slow or disabled.
601
542WARNING WARNING WARNING: do not leave the fan disabled unless you are 602WARNING WARNING WARNING: do not leave the fan disabled unless you are
543monitoring the temperature sensor readings and you are ready to enable 603monitoring all of the temperature sensor readings and you are ready to
544it if necessary to avoid overheating. 604enable it if necessary to avoid overheating.
545 605
546The fan only runs if it's enabled *and* the various temperature 606An enabled fan in level "auto" may stop spinning if the EC decides the
547sensors which control it read high enough. On the X40, this seems to 607ThinkPad is cool enough and doesn't need the extra airflow. This is
548depend on the CPU and HDD temperatures. Specifically, the fan is 608normal, and the EC will spin the fan up if the varios thermal readings
549turned on when either the CPU temperature climbs to 56 degrees or the 609rise too much.
550HDD temperature climbs to 46 degrees. The fan is turned off when the 610
551CPU temperature drops to 49 degrees and the HDD temperature drops to 611On the X40, this seems to depend on the CPU and HDD temperatures.
55241 degrees. These thresholds cannot currently be controlled. 612Specifically, the fan is turned on when either the CPU temperature
613climbs to 56 degrees or the HDD temperature climbs to 46 degrees. The
614fan is turned off when the CPU temperature drops to 49 degrees and the
615HDD temperature drops to 41 degrees. These thresholds cannot
616currently be controlled.
617
618The fan level can be controlled with the command:
619
620 echo 'level <level>' > /proc/acpi/ibm/thermal
621
622Where <level> is an integer from 0 to 7, or one of the words "auto"
623or "disengaged" (without the quotes). Not all ThinkPads support the
624"auto" and "disengaged" levels.
553 625
554On the X31 and X40 (and ONLY on those models), the fan speed can be 626On the X31 and X40 (and ONLY on those models), the fan speed can be
555controlled to a certain degree. Once the fan is running, it can be 627controlled to a certain degree. Once the fan is running, it can be
@@ -562,12 +634,9 @@ about 3700 to about 7350. Values outside this range either do not have
562any effect or the fan speed eventually settles somewhere in that 634any effect or the fan speed eventually settles somewhere in that
563range. The fan cannot be stopped or started with this command. 635range. The fan cannot be stopped or started with this command.
564 636
565On the 570, temperature readings are not available through this 637The ThinkPad's ACPI DSDT code will reprogram the fan on its own when
566feature and the fan control works a little differently. The fan speed 638certain conditions are met. It will override any fan programming done
567is reported in levels from 0 (off) to 7 (max) and can be controlled 639through ibm-acpi.
568with the following command:
569
570 echo 'level <level>' > /proc/acpi/ibm/thermal
571 640
572EXPERIMENTAL: WAN -- /proc/acpi/ibm/wan 641EXPERIMENTAL: WAN -- /proc/acpi/ibm/wan
573--------------------------------------- 642---------------------------------------
@@ -601,6 +670,26 @@ example:
601 670
602 modprobe ibm_acpi hotkey=enable,0xffff video=auto_disable 671 modprobe ibm_acpi hotkey=enable,0xffff video=auto_disable
603 672
673The ibm-acpi kernel driver can be programmed to revert the fan level
674to a safe setting if userspace does not issue one of the fan commands:
675"enable", "disable", "level" or "watchdog" within a configurable
676ammount of time. To do this, use the "watchdog" command.
677
678 echo 'watchdog <interval>' > /proc/acpi/ibm/fan
679
680Interval is the ammount of time in seconds to wait for one of the
681above mentioned fan commands before reseting the fan level to a safe
682one. If set to zero, the watchdog is disabled (default). When the
683watchdog timer runs out, it does the exact equivalent of the "enable"
684fan command.
685
686Note that the watchdog timer stops after it enables the fan. It will
687be rearmed again automatically (using the same interval) when one of
688the above mentioned fan commands is received. The fan watchdog is,
689therefore, not suitable to protect against fan mode changes made
690through means other than the "enable", "disable", and "level" fan
691commands.
692
604 693
605Example Configuration 694Example Configuration
606--------------------- 695---------------------
diff --git a/Documentation/kdump/kdump.txt b/Documentation/kdump/kdump.txt
index 99f2d4d4bf7d..073306818347 100644
--- a/Documentation/kdump/kdump.txt
+++ b/Documentation/kdump/kdump.txt
@@ -17,7 +17,7 @@ You can use common Linux commands, such as cp and scp, to copy the
17memory image to a dump file on the local disk, or across the network to 17memory image to a dump file on the local disk, or across the network to
18a remote system. 18a remote system.
19 19
20Kdump and kexec are currently supported on the x86, x86_64, and ppc64 20Kdump and kexec are currently supported on the x86, x86_64, ppc64 and ia64
21architectures. 21architectures.
22 22
23When the system kernel boots, it reserves a small section of memory for 23When the system kernel boots, it reserves a small section of memory for
@@ -54,59 +54,69 @@ memory," in two ways:
54Setup and Installation 54Setup and Installation
55====================== 55======================
56 56
57Install kexec-tools and the Kdump patch 57Install kexec-tools
58--------------------------------------- 58-------------------
59 59
601) Login as the root user. 601) Login as the root user.
61 61
622) Download the kexec-tools user-space package from the following URL: 622) Download the kexec-tools user-space package from the following URL:
63 63
64 http://www.xmission.com/~ebiederm/files/kexec/kexec-tools-1.101.tar.gz 64http://www.kernel.org/pub/linux/kernel/people/horms/kexec-tools/kexec-tools-testing.tar.gz
65 65
663) Unpack the tarball with the tar command, as follows: 66This is a symlink to the latest version, which at the time of writing is
67 6720061214, the only release of kexec-tools-testing so far. As other versions
68 tar xvpzf kexec-tools-1.101.tar.gz 68are made released, the older onese will remain available at
69 69http://www.kernel.org/pub/linux/kernel/people/horms/kexec-tools/
704) Download the latest consolidated Kdump patch from the following URL:
71 70
72 http://lse.sourceforge.net/kdump/ 71Note: Latest kexec-tools-testing git tree is available at
73 72
74 (This location is being used until all the user-space Kdump patches 73git://git.kernel.org/pub/scm/linux/kernel/git/horms/kexec-tools-testing.git
75 are integrated with the kexec-tools package.) 74or
75http://www.kernel.org/git/?p=linux/kernel/git/horms/kexec-tools-testing.git;a=summary
76 76
775) Change to the kexec-tools-1.101 directory, as follows: 773) Unpack the tarball with the tar command, as follows:
78 78
79 cd kexec-tools-1.101 79 tar xvpzf kexec-tools-testing.tar.gz
80 80
816) Apply the consolidated patch to the kexec-tools-1.101 source tree 814) Change to the kexec-tools directory, as follows:
82 with the patch command, as follows. (Modify the path to the downloaded
83 patch as necessary.)
84 82
85 patch -p1 < /path-to-kdump-patch/kexec-tools-1.101-kdump.patch 83 cd kexec-tools-testing-VERSION
86 84
877) Configure the package, as follows: 855) Configure the package, as follows:
88 86
89 ./configure 87 ./configure
90 88
918) Compile the package, as follows: 896) Compile the package, as follows:
92 90
93 make 91 make
94 92
959) Install the package, as follows: 937) Install the package, as follows:
96 94
97 make install 95 make install
98 96
99 97
100Download and build the system and dump-capture kernels 98Build the system and dump-capture kernels
101------------------------------------------------------ 99-----------------------------------------
100There are two possible methods of using Kdump.
101
1021) Build a separate custom dump-capture kernel for capturing the
103 kernel core dump.
102 104
103Download the mainline (vanilla) kernel source code (2.6.13-rc1 or newer) 1052) Or use the system kernel binary itself as dump-capture kernel and there is
104from http://www.kernel.org. Two kernels must be built: a system kernel 106 no need to build a separate dump-capture kernel. This is possible
105and a dump-capture kernel. Use the following steps to configure these 107 only with the architecutres which support a relocatable kernel. As
106kernels with the necessary kexec and Kdump features: 108 of today i386 and ia64 architectures support relocatable kernel.
107 109
108System kernel 110Building a relocatable kernel is advantageous from the point of view that
109------------- 111one does not have to build a second kernel for capturing the dump. But
112at the same time one might want to build a custom dump capture kernel
113suitable to his needs.
114
115Following are the configuration setting required for system and
116dump-capture kernels for enabling kdump support.
117
118System kernel config options
119----------------------------
110 120
1111) Enable "kexec system call" in "Processor type and features." 1211) Enable "kexec system call" in "Processor type and features."
112 122
@@ -132,88 +142,182 @@ System kernel
132 analysis tools require a vmlinux with debug symbols in order to read 142 analysis tools require a vmlinux with debug symbols in order to read
133 and analyze a dump file. 143 and analyze a dump file.
134 144
1354) Make and install the kernel and its modules. Update the boot loader 145Dump-capture kernel config options (Arch Independent)
136 (such as grub, yaboot, or lilo) configuration files as necessary. 146-----------------------------------------------------
137 147
1385) Boot the system kernel with the boot parameter "crashkernel=Y@X", 1481) Enable "kernel crash dumps" support under "Processor type and
139 where Y specifies how much memory to reserve for the dump-capture kernel 149 features":
140 and X specifies the beginning of this reserved memory. For example,
141 "crashkernel=64M@16M" tells the system kernel to reserve 64 MB of memory
142 starting at physical address 0x01000000 for the dump-capture kernel.
143
144 On x86 and x86_64, use "crashkernel=64M@16M".
145
146 On ppc64, use "crashkernel=128M@32M".
147 150
151 CONFIG_CRASH_DUMP=y
148 152
149The dump-capture kernel 1532) Enable "/proc/vmcore support" under "Filesystems" -> "Pseudo filesystems".
150-----------------------
151 154
1521) Under "General setup," append "-kdump" to the current string in 155 CONFIG_PROC_VMCORE=y
153 "Local version." 156 (CONFIG_PROC_VMCORE is set by default when CONFIG_CRASH_DUMP is selected.)
154 157
1552) On x86, enable high memory support under "Processor type and 158Dump-capture kernel config options (Arch Dependent, i386)
159--------------------------------------------------------
1601) On x86, enable high memory support under "Processor type and
156 features": 161 features":
157 162
158 CONFIG_HIGHMEM64G=y 163 CONFIG_HIGHMEM64G=y
159 or 164 or
160 CONFIG_HIGHMEM4G 165 CONFIG_HIGHMEM4G
161 166
1623) On x86 and x86_64, disable symmetric multi-processing support 1672) On x86 and x86_64, disable symmetric multi-processing support
163 under "Processor type and features": 168 under "Processor type and features":
164 169
165 CONFIG_SMP=n 170 CONFIG_SMP=n
171
166 (If CONFIG_SMP=y, then specify maxcpus=1 on the kernel command line 172 (If CONFIG_SMP=y, then specify maxcpus=1 on the kernel command line
167 when loading the dump-capture kernel, see section "Load the Dump-capture 173 when loading the dump-capture kernel, see section "Load the Dump-capture
168 Kernel".) 174 Kernel".)
169 175
1704) On ppc64, disable NUMA support and enable EMBEDDED support: 1763) If one wants to build and use a relocatable kernel,
177 Enable "Build a relocatable kernel" support under "Processor type and
178 features"
171 179
172 CONFIG_NUMA=n 180 CONFIG_RELOCATABLE=y
173 CONFIG_EMBEDDED=y
174 CONFIG_EEH=N for the dump-capture kernel
175 181
1765) Enable "kernel crash dumps" support under "Processor type and 1824) Use a suitable value for "Physical address where the kernel is
177 features": 183 loaded" (under "Processor type and features"). This only appears when
184 "kernel crash dumps" is enabled. A suitable value depends upon
185 whether kernel is relocatable or not.
186
187 If you are using a relocatable kernel use CONFIG_PHYSICAL_START=0x100000
188 This will compile the kernel for physical address 1MB, but given the fact
189 kernel is relocatable, it can be run from any physical address hence
190 kexec boot loader will load it in memory region reserved for dump-capture
191 kernel.
192
193 Otherwise it should be the start of memory region reserved for
194 second kernel using boot parameter "crashkernel=Y@X". Here X is
195 start of memory region reserved for dump-capture kernel.
196 Generally X is 16MB (0x1000000). So you can set
197 CONFIG_PHYSICAL_START=0x1000000
198
1995) Make and install the kernel and its modules. DO NOT add this kernel
200 to the boot loader configuration files.
178 201
179 CONFIG_CRASH_DUMP=y 202Dump-capture kernel config options (Arch Dependent, x86_64)
203----------------------------------------------------------
2041) On x86 and x86_64, disable symmetric multi-processing support
205 under "Processor type and features":
180 206
1816) Use a suitable value for "Physical address where the kernel is 207 CONFIG_SMP=n
208
209 (If CONFIG_SMP=y, then specify maxcpus=1 on the kernel command line
210 when loading the dump-capture kernel, see section "Load the Dump-capture
211 Kernel".)
212
2132) Use a suitable value for "Physical address where the kernel is
182 loaded" (under "Processor type and features"). This only appears when 214 loaded" (under "Processor type and features"). This only appears when
183 "kernel crash dumps" is enabled. By default this value is 0x1000000 215 "kernel crash dumps" is enabled. By default this value is 0x1000000
184 (16MB). It should be the same as X in the "crashkernel=Y@X" boot 216 (16MB). It should be the same as X in the "crashkernel=Y@X" boot
185 parameter discussed above. 217 parameter.
186 218
187 On x86 and x86_64, use "CONFIG_PHYSICAL_START=0x1000000". 219 For x86_64, normally "CONFIG_PHYSICAL_START=0x1000000".
188 220
189 On ppc64 the value is automatically set at 32MB when 2213) Make and install the kernel and its modules. DO NOT add this kernel
190 CONFIG_CRASH_DUMP is set. 222 to the boot loader configuration files.
191 223
1926) Optionally enable "/proc/vmcore support" under "Filesystems" -> 224Dump-capture kernel config options (Arch Dependent, ppc64)
193 "Pseudo filesystems". 225----------------------------------------------------------
194 226
195 CONFIG_PROC_VMCORE=y 227- Make and install the kernel and its modules. DO NOT add this kernel
196 (CONFIG_PROC_VMCORE is set by default when CONFIG_CRASH_DUMP is selected.)
197
1987) Make and install the kernel and its modules. DO NOT add this kernel
199 to the boot loader configuration files. 228 to the boot loader configuration files.
200 229
230Dump-capture kernel config options (Arch Dependent, ia64)
231----------------------------------------------------------
232
233- No specific options are required to create a dump-capture kernel
234 for ia64, other than those specified in the arch idependent section
235 above. This means that it is possible to use the system kernel
236 as a dump-capture kernel if desired.
237
238 The crashkernel region can be automatically placed by the system
239 kernel at run time. This is done by specifying the base address as 0,
240 or omitting it all together.
241
242 crashkernel=256M@0
243 or
244 crashkernel=256M
245
246 If the start address is specified, note that the start address of the
247 kernel will be aligned to 64Mb, so if the start address is not then
248 any space below the alignment point will be wasted.
249
250
251Boot into System Kernel
252=======================
253
2541) Make and install the kernel and its modules. Update the boot loader
255 (such as grub, yaboot, or lilo) configuration files as necessary.
256
2572) Boot the system kernel with the boot parameter "crashkernel=Y@X",
258 where Y specifies how much memory to reserve for the dump-capture kernel
259 and X specifies the beginning of this reserved memory. For example,
260 "crashkernel=64M@16M" tells the system kernel to reserve 64 MB of memory
261 starting at physical address 0x01000000 (16MB) for the dump-capture kernel.
262
263 On x86 and x86_64, use "crashkernel=64M@16M".
264
265 On ppc64, use "crashkernel=128M@32M".
266
267 On ia64, 256M@256M is a generous value that typically works.
268 The region may be automatically placed on ia64, see the
269 dump-capture kernel config option notes above.
201 270
202Load the Dump-capture Kernel 271Load the Dump-capture Kernel
203============================ 272============================
204 273
205After booting to the system kernel, load the dump-capture kernel using 274After booting to the system kernel, dump-capture kernel needs to be
206the following command: 275loaded.
276
277Based on the architecture and type of image (relocatable or not), one
278can choose to load the uncompressed vmlinux or compressed bzImage/vmlinuz
279of dump-capture kernel. Following is the summary.
280
281For i386:
282 - Use vmlinux if kernel is not relocatable.
283 - Use bzImage/vmlinuz if kernel is relocatable.
284For x86_64:
285 - Use vmlinux
286For ppc64:
287 - Use vmlinux
288For ia64:
289 - Use vmlinux or vmlinuz.gz
290
207 291
208 kexec -p <dump-capture-kernel> \ 292If you are using a uncompressed vmlinux image then use following command
293to load dump-capture kernel.
294
295 kexec -p <dump-capture-kernel-vmlinux-image> \
209 --initrd=<initrd-for-dump-capture-kernel> --args-linux \ 296 --initrd=<initrd-for-dump-capture-kernel> --args-linux \
210 --append="root=<root-dev> init 1 irqpoll" 297 --append="root=<root-dev> <arch-specific-options>"
211 298
299If you are using a compressed bzImage/vmlinuz, then use following command
300to load dump-capture kernel.
212 301
213Notes on loading the dump-capture kernel: 302 kexec -p <dump-capture-kernel-bzImage> \
303 --initrd=<initrd-for-dump-capture-kernel> \
304 --append="root=<root-dev> <arch-specific-options>"
305
306Please note, that --args-linux does not need to be specified for ia64.
307It is planned to make this a no-op on that architecture, but for now
308it should be omitted
309
310Following are the arch specific command line options to be used while
311loading dump-capture kernel.
214 312
215* <dump-capture-kernel> must be a vmlinux image (that is, an 313For i386, x86_64 and ia64:
216 uncompressed ELF image). bzImage does not work at this time. 314 "init 1 irqpoll maxcpus=1"
315
316For ppc64:
317 "init 1 maxcpus=1 noirqdistrib"
318
319
320Notes on loading the dump-capture kernel:
217 321
218* By default, the ELF headers are stored in ELF64 format to support 322* By default, the ELF headers are stored in ELF64 format to support
219 systems with more than 4GB memory. The --elf32-core-headers option can 323 systems with more than 4GB memory. The --elf32-core-headers option can
@@ -231,6 +335,9 @@ Notes on loading the dump-capture kernel:
231* "init 1" boots the dump-capture kernel into single-user mode without 335* "init 1" boots the dump-capture kernel into single-user mode without
232 networking. If you want networking, use "init 3." 336 networking. If you want networking, use "init 3."
233 337
338* We generally don' have to bring up a SMP kernel just to capture the
339 dump. Hence generally it is useful either to build a UP dump-capture
340 kernel or specify maxcpus=1 option while loading dump-capture kernel.
234 341
235Kernel Panic 342Kernel Panic
236============ 343============
diff --git a/Documentation/kernel-parameters.txt b/Documentation/kernel-parameters.txt
index ef69c75780bf..25d298517104 100644
--- a/Documentation/kernel-parameters.txt
+++ b/Documentation/kernel-parameters.txt
@@ -1714,6 +1714,14 @@ and is between 256 and 4096 characters. It is defined in the file
1714 uart6850= [HW,OSS] 1714 uart6850= [HW,OSS]
1715 Format: <io>,<irq> 1715 Format: <io>,<irq>
1716 1716
1717 uhci-hcd.ignore_oc=
1718 [USB] Ignore overcurrent events (default N).
1719 Some badly-designed motherboards generate lots of
1720 bogus events, for ports that aren't wired to
1721 anything. Set this parameter to avoid log spamming.
1722 Note that genuine overcurrent events won't be
1723 reported either.
1724
1717 usbhid.mousepoll= 1725 usbhid.mousepoll=
1718 [USBHID] The interval which mice are to be polled at. 1726 [USBHID] The interval which mice are to be polled at.
1719 1727
diff --git a/Documentation/pci.txt b/Documentation/pci.txt
index 2b395e478961..fd5028eca13e 100644
--- a/Documentation/pci.txt
+++ b/Documentation/pci.txt
@@ -1,142 +1,231 @@
1 How To Write Linux PCI Drivers
2 1
3 by Martin Mares <mj@ucw.cz> on 07-Feb-2000 2 How To Write Linux PCI Drivers
3
4 by Martin Mares <mj@ucw.cz> on 07-Feb-2000
5 updated by Grant Grundler <grundler@parisc-linux.org> on 23-Dec-2006
4 6
5~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 7~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
6The world of PCI is vast and it's full of (mostly unpleasant) surprises. 8The world of PCI is vast and full of (mostly unpleasant) surprises.
7Different PCI devices have different requirements and different bugs -- 9Since each CPU architecture implements different chip-sets and PCI devices
8because of this, the PCI support layer in Linux kernel is not as trivial 10have different requirements (erm, "features"), the result is the PCI support
9as one would wish. This short pamphlet tries to help all potential driver 11in the Linux kernel is not as trivial as one would wish. This short paper
10authors find their way through the deep forests of PCI handling. 12tries to introduce all potential driver authors to Linux APIs for
13PCI device drivers.
14
15A more complete resource is the third edition of "Linux Device Drivers"
16by Jonathan Corbet, Alessandro Rubini, and Greg Kroah-Hartman.
17LDD3 is available for free (under Creative Commons License) from:
18
19 http://lwn.net/Kernel/LDD3/
20
21However, keep in mind that all documents are subject to "bit rot".
22Refer to the source code if things are not working as described here.
23
24Please send questions/comments/patches about Linux PCI API to the
25"Linux PCI" <linux-pci@atrey.karlin.mff.cuni.cz> mailing list.
26
11 27
12 28
130. Structure of PCI drivers 290. Structure of PCI drivers
14~~~~~~~~~~~~~~~~~~~~~~~~~~~ 30~~~~~~~~~~~~~~~~~~~~~~~~~~~
15There exist two kinds of PCI drivers: new-style ones (which leave most of 31PCI drivers "discover" PCI devices in a system via pci_register_driver().
16probing for devices to the PCI layer and support online insertion and removal 32Actually, it's the other way around. When the PCI generic code discovers
17of devices [thus supporting PCI, hot-pluggable PCI and CardBus in a single 33a new device, the driver with a matching "description" will be notified.
18driver]) and old-style ones which just do all the probing themselves. Unless 34Details on this below.
19you have a very good reason to do so, please don't use the old way of probing 35
20in any new code. After the driver finds the devices it wishes to operate 36pci_register_driver() leaves most of the probing for devices to
21on (either the old or the new way), it needs to perform the following steps: 37the PCI layer and supports online insertion/removal of devices [thus
38supporting hot-pluggable PCI, CardBus, and Express-Card in a single driver].
39pci_register_driver() call requires passing in a table of function
40pointers and thus dictates the high level structure of a driver.
41
42Once the driver knows about a PCI device and takes ownership, the
43driver generally needs to perform the following initialization:
22 44
23 Enable the device 45 Enable the device
24 Access device configuration space 46 Request MMIO/IOP resources
25 Discover resources (addresses and IRQ numbers) provided by the device 47 Set the DMA mask size (for both coherent and streaming DMA)
26 Allocate these resources 48 Allocate and initialize shared control data (pci_allocate_coherent())
27 Communicate with the device 49 Access device configuration space (if needed)
50 Register IRQ handler (request_irq())
51 Initialize non-PCI (i.e. LAN/SCSI/etc parts of the chip)
52 Enable DMA/processing engines
53
54When done using the device, and perhaps the module needs to be unloaded,
55the driver needs to take the follow steps:
56 Disable the device from generating IRQs
57 Release the IRQ (free_irq())
58 Stop all DMA activity
59 Release DMA buffers (both streaming and coherent)
60 Unregister from other subsystems (e.g. scsi or netdev)
61 Release MMIO/IOP resources
28 Disable the device 62 Disable the device
29 63
30Most of these topics are covered by the following sections, for the rest 64Most of these topics are covered in the following sections.
31look at <linux/pci.h>, it's hopefully well commented. 65For the rest look at LDD3 or <linux/pci.h> .
32 66
33If the PCI subsystem is not configured (CONFIG_PCI is not set), most of 67If the PCI subsystem is not configured (CONFIG_PCI is not set), most of
34the functions described below are defined as inline functions either completely 68the PCI functions described below are defined as inline functions either
35empty or just returning an appropriate error codes to avoid lots of ifdefs 69completely empty or just returning an appropriate error codes to avoid
36in the drivers. 70lots of ifdefs in the drivers.
71
37 72
38 73
391. New-style drivers 741. pci_register_driver() call
40~~~~~~~~~~~~~~~~~~~~ 75~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
41The new-style drivers just call pci_register_driver during their initialization
42with a pointer to a structure describing the driver (struct pci_driver) which
43contains:
44 76
45 name Name of the driver 77PCI device drivers call pci_register_driver() during their
78initialization with a pointer to a structure describing the driver
79(struct pci_driver):
80
81 field name Description
82 ---------- ------------------------------------------------------
46 id_table Pointer to table of device ID's the driver is 83 id_table Pointer to table of device ID's the driver is
47 interested in. Most drivers should export this 84 interested in. Most drivers should export this
48 table using MODULE_DEVICE_TABLE(pci,...). 85 table using MODULE_DEVICE_TABLE(pci,...).
49 probe Pointer to a probing function which gets called (during 86
50 execution of pci_register_driver for already existing 87 probe This probing function gets called (during execution
51 devices or later if a new device gets inserted) for all 88 of pci_register_driver() for already existing
52 PCI devices which match the ID table and are not handled 89 devices or later if a new device gets inserted) for
53 by the other drivers yet. This function gets passed a 90 all PCI devices which match the ID table and are not
54 pointer to the pci_dev structure representing the device 91 "owned" by the other drivers yet. This function gets
55 and also which entry in the ID table did the device 92 passed a "struct pci_dev *" for each device whose
56 match. It returns zero when the driver has accepted the 93 entry in the ID table matches the device. The probe
57 device or an error code (negative number) otherwise. 94 function returns zero when the driver chooses to
58 This function always gets called from process context, 95 take "ownership" of the device or an error code
59 so it can sleep. 96 (negative number) otherwise.
60 remove Pointer to a function which gets called whenever a 97 The probe function always gets called from process
61 device being handled by this driver is removed (either 98 context, so it can sleep.
62 during deregistration of the driver or when it's 99
63 manually pulled out of a hot-pluggable slot). This 100 remove The remove() function gets called whenever a device
64 function always gets called from process context, so it 101 being handled by this driver is removed (either during
65 can sleep. 102 deregistration of the driver or when it's manually
66 save_state Save a device's state before it's suspend. 103 pulled out of a hot-pluggable slot).
104 The remove function always gets called from process
105 context, so it can sleep.
106
67 suspend Put device into low power state. 107 suspend Put device into low power state.
108 suspend_late Put device into low power state.
109
110 resume_early Wake device from low power state.
68 resume Wake device from low power state. 111 resume Wake device from low power state.
112
113 (Please see Documentation/power/pci.txt for descriptions
114 of PCI Power Management and the related functions.)
115
69 enable_wake Enable device to generate wake events from a low power 116 enable_wake Enable device to generate wake events from a low power
70 state. 117 state.
71 118
72 (Please see Documentation/power/pci.txt for descriptions 119 shutdown Hook into reboot_notifier_list (kernel/sys.c).
73 of PCI Power Management and the related functions) 120 Intended to stop any idling DMA operations.
121 Useful for enabling wake-on-lan (NIC) or changing
122 the power state of a device before reboot.
123 e.g. drivers/net/e100.c.
124
125 err_handler See Documentation/pci-error-recovery.txt
126
127 multithread_probe Enable multi-threaded probe/scan. Driver must
128 provide its own locking/syncronization for init
129 operations if this is enabled.
130
74 131
75The ID table is an array of struct pci_device_id ending with a all-zero entry. 132The ID table is an array of struct pci_device_id entries ending with an
76Each entry consists of: 133all-zero entry. Each entry consists of:
134
135 vendor,device Vendor and device ID to match (or PCI_ANY_ID)
77 136
78 vendor, device Vendor and device ID to match (or PCI_ANY_ID)
79 subvendor, Subsystem vendor and device ID to match (or PCI_ANY_ID) 137 subvendor, Subsystem vendor and device ID to match (or PCI_ANY_ID)
80 subdevice 138 subdevice,
81 class, Device class to match. The class_mask tells which bits 139
82 class_mask of the class are honored during the comparison. 140 class Device class, subclass, and "interface" to match.
141 See Appendix D of the PCI Local Bus Spec or
142 include/linux/pci_ids.h for a full list of classes.
143 Most drivers do not need to specify class/class_mask
144 as vendor/device is normally sufficient.
145
146 class_mask limit which sub-fields of the class field are compared.
147 See drivers/scsi/sym53c8xx_2/ for example of usage.
148
83 driver_data Data private to the driver. 149 driver_data Data private to the driver.
150 Most drivers don't need to use driver_data field.
151 Best practice is to use driver_data as an index
152 into a static list of equivalent device types,
153 instead of using it as a pointer.
84 154
85Most drivers don't need to use the driver_data field. Best practice
86for use of driver_data is to use it as an index into a static list of
87equivalent device types, not to use it as a pointer.
88 155
89Have a table entry {PCI_ANY_ID, PCI_ANY_ID, PCI_ANY_ID, PCI_ANY_ID} 156Most drivers only need PCI_DEVICE() or PCI_DEVICE_CLASS() to set up
90to have probe() called for every PCI device known to the system. 157a pci_device_id table.
91 158
92New PCI IDs may be added to a device driver at runtime by writing 159New PCI IDs may be added to a device driver pci_ids table at runtime
93to the file /sys/bus/pci/drivers/{driver}/new_id. When added, the 160as shown below:
94driver will probe for all devices it can support.
95 161
96echo "vendor device subvendor subdevice class class_mask driver_data" > \ 162echo "vendor device subvendor subdevice class class_mask driver_data" > \
97 /sys/bus/pci/drivers/{driver}/new_id 163/sys/bus/pci/drivers/{driver}/new_id
98where all fields are passed in as hexadecimal values (no leading 0x). 164
99Users need pass only as many fields as necessary; vendor, device, 165All fields are passed in as hexadecimal values (no leading 0x).
100subvendor, and subdevice fields default to PCI_ANY_ID (FFFFFFFF), 166Users need pass only as many fields as necessary:
101class and classmask fields default to 0, and driver_data defaults to 167 o vendor, device, subvendor, and subdevice fields default
1020UL. Device drivers must initialize use_driver_data in the dynids struct 168 to PCI_ANY_ID (FFFFFFFF),
103in their pci_driver struct prior to calling pci_register_driver in order 169 o class and classmask fields default to 0
104for the driver_data field to get passed to the driver. Otherwise, only a 170 o driver_data defaults to 0UL.
1050 is passed in that field. 171
172Once added, the driver probe routine will be invoked for any unclaimed
173PCI devices listed in its (newly updated) pci_ids list.
106 174
107When the driver exits, it just calls pci_unregister_driver() and the PCI layer 175When the driver exits, it just calls pci_unregister_driver() and the PCI layer
108automatically calls the remove hook for all devices handled by the driver. 176automatically calls the remove hook for all devices handled by the driver.
109 177
178
1791.1 "Attributes" for driver functions/data
180
110Please mark the initialization and cleanup functions where appropriate 181Please mark the initialization and cleanup functions where appropriate
111(the corresponding macros are defined in <linux/init.h>): 182(the corresponding macros are defined in <linux/init.h>):
112 183
113 __init Initialization code. Thrown away after the driver 184 __init Initialization code. Thrown away after the driver
114 initializes. 185 initializes.
115 __exit Exit code. Ignored for non-modular drivers. 186 __exit Exit code. Ignored for non-modular drivers.
116 __devinit Device initialization code. Identical to __init if 187
117 the kernel is not compiled with CONFIG_HOTPLUG, normal 188
118 function otherwise. 189 __devinit Device initialization code.
190 Identical to __init if the kernel is not compiled
191 with CONFIG_HOTPLUG, normal function otherwise.
119 __devexit The same for __exit. 192 __devexit The same for __exit.
120 193
121Tips: 194Tips on when/where to use the above attributes:
122 The module_init()/module_exit() functions (and all initialization 195 o The module_init()/module_exit() functions (and all
123 functions called only from these) should be marked __init/exit. 196 initialization functions called _only_ from these)
124 The struct pci_driver shouldn't be marked with any of these tags. 197 should be marked __init/__exit.
125 The ID table array should be marked __devinitdata.
126 The probe() and remove() functions (and all initialization
127 functions called only from these) should be marked __devinit/exit.
128 If you are sure the driver is not a hotplug driver then use only
129 __init/exit __initdata/exitdata.
130 198
131 Pointers to functions marked as __devexit must be created using 199 o Do not mark the struct pci_driver.
132 __devexit_p(function_name). That will generate the function
133 name or NULL if the __devexit function will be discarded.
134 200
201 o The ID table array should be marked __devinitdata.
135 202
1362. How to find PCI devices manually (the old style) 203 o The probe() and remove() functions should be marked __devinit
137~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 204 and __devexit respectively. All initialization functions
138PCI drivers not using the pci_register_driver() interface search 205 exclusively called by the probe() routine, can be marked __devinit.
139for PCI devices manually using the following constructs: 206 Ditto for remove() and __devexit.
207
208 o If mydriver_probe() is marked with __devinit(), then all address
209 references to mydriver_probe must use __devexit_p(mydriver_probe)
210 (in the struct pci_driver declaration for example).
211 __devexit_p() will generate the function name _or_ NULL if the
212 function will be discarded. For an example, see drivers/net/tg3.c.
213
214 o Do NOT mark a function if you are not sure which mark to use.
215 Better to not mark the function than mark the function wrong.
216
217
218
2192. How to find PCI devices manually
220~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
221
222PCI drivers should have a really good reason for not using the
223pci_register_driver() interface to search for PCI devices.
224The main reason PCI devices are controlled by multiple drivers
225is because one PCI device implements several different HW services.
226E.g. combined serial/parallel port/floppy controller.
227
228A manual search may be performed using the following constructs:
140 229
141Searching by vendor and device ID: 230Searching by vendor and device ID:
142 231
@@ -150,87 +239,311 @@ Searching by class ID (iterate in a similar way):
150 239
151Searching by both vendor/device and subsystem vendor/device ID: 240Searching by both vendor/device and subsystem vendor/device ID:
152 241
153 pci_get_subsys(VENDOR_ID, DEVICE_ID, SUBSYS_VENDOR_ID, SUBSYS_DEVICE_ID, dev). 242 pci_get_subsys(VENDOR_ID,DEVICE_ID, SUBSYS_VENDOR_ID, SUBSYS_DEVICE_ID, dev).
154 243
155 You can use the constant PCI_ANY_ID as a wildcard replacement for 244You can use the constant PCI_ANY_ID as a wildcard replacement for
156VENDOR_ID or DEVICE_ID. This allows searching for any device from a 245VENDOR_ID or DEVICE_ID. This allows searching for any device from a
157specific vendor, for example. 246specific vendor, for example.
158 247
159 These functions are hotplug-safe. They increment the reference count on 248These functions are hotplug-safe. They increment the reference count on
160the pci_dev that they return. You must eventually (possibly at module unload) 249the pci_dev that they return. You must eventually (possibly at module unload)
161decrement the reference count on these devices by calling pci_dev_put(). 250decrement the reference count on these devices by calling pci_dev_put().
162 251
163 252
1643. Enabling and disabling devices
165~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
166 Before you do anything with the device you've found, you need to enable
167it by calling pci_enable_device() which enables I/O and memory regions of
168the device, allocates an IRQ if necessary, assigns missing resources if
169needed and wakes up the device if it was in suspended state. Please note
170that this function can fail.
171 253
172 If you want to use the device in bus mastering mode, call pci_set_master() 2543. Device Initialization Steps
173which enables the bus master bit in PCI_COMMAND register and also fixes 255~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
174the latency timer value if it's set to something bogus by the BIOS. 256
257As noted in the introduction, most PCI drivers need the following steps
258for device initialization:
175 259
176 If you want to use the PCI Memory-Write-Invalidate transaction, 260 Enable the device
261 Request MMIO/IOP resources
262 Set the DMA mask size (for both coherent and streaming DMA)
263 Allocate and initialize shared control data (pci_allocate_coherent())
264 Access device configuration space (if needed)
265 Register IRQ handler (request_irq())
266 Initialize non-PCI (i.e. LAN/SCSI/etc parts of the chip)
267 Enable DMA/processing engines.
268
269The driver can access PCI config space registers at any time.
270(Well, almost. When running BIST, config space can go away...but
271that will just result in a PCI Bus Master Abort and config reads
272will return garbage).
273
274
2753.1 Enable the PCI device
276~~~~~~~~~~~~~~~~~~~~~~~~~
277Before touching any device registers, the driver needs to enable
278the PCI device by calling pci_enable_device(). This will:
279 o wake up the device if it was in suspended state,
280 o allocate I/O and memory regions of the device (if BIOS did not),
281 o allocate an IRQ (if BIOS did not).
282
283NOTE: pci_enable_device() can fail! Check the return value.
284NOTE2: Also see pci_enable_device_bars() below. Drivers can
285 attempt to enable only a subset of BARs they need.
286
287[ OS BUG: we don't check resource allocations before enabling those
288 resources. The sequence would make more sense if we called
289 pci_request_resources() before calling pci_enable_device().
290 Currently, the device drivers can't detect the bug when when two
291 devices have been allocated the same range. This is not a common
292 problem and unlikely to get fixed soon.
293
294 This has been discussed before but not changed as of 2.6.19:
295 http://lkml.org/lkml/2006/3/2/194
296]
297
298pci_set_master() will enable DMA by setting the bus master bit
299in the PCI_COMMAND register. It also fixes the latency timer value if
300it's set to something bogus by the BIOS.
301
302If the PCI device can use the PCI Memory-Write-Invalidate transaction,
177call pci_set_mwi(). This enables the PCI_COMMAND bit for Mem-Wr-Inval 303call pci_set_mwi(). This enables the PCI_COMMAND bit for Mem-Wr-Inval
178and also ensures that the cache line size register is set correctly. 304and also ensures that the cache line size register is set correctly.
179Make sure to check the return value of pci_set_mwi(), not all architectures 305Check the return value of pci_set_mwi() as not all architectures
180may support Memory-Write-Invalidate. 306or chip-sets may support Memory-Write-Invalidate.
307
308
3093.2 Request MMIO/IOP resources
310~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
311Memory (MMIO), and I/O port addresses should NOT be read directly
312from the PCI device config space. Use the values in the pci_dev structure
313as the PCI "bus address" might have been remapped to a "host physical"
314address by the arch/chip-set specific kernel support.
181 315
182 If your driver decides to stop using the device (e.g., there was an 316See Documentation/IO-mapping.txt for how to access device registers
183error while setting it up or the driver module is being unloaded), it 317or device memory.
184should call pci_disable_device() to deallocate any IRQ resources, disable 318
185PCI bus-mastering, etc. You should not do anything with the device after 319The device driver needs to call pci_request_region() to verify
320no other device is already using the same address resource.
321Conversely, drivers should call pci_release_region() AFTER
186calling pci_disable_device(). 322calling pci_disable_device().
323The idea is to prevent two devices colliding on the same address range.
324
325[ See OS BUG comment above. Currently (2.6.19), The driver can only
326 determine MMIO and IO Port resource availability _after_ calling
327 pci_enable_device(). ]
328
329Generic flavors of pci_request_region() are request_mem_region()
330(for MMIO ranges) and request_region() (for IO Port ranges).
331Use these for address resources that are not described by "normal" PCI
332BARs.
333
334Also see pci_request_selected_regions() below.
335
336
3373.3 Set the DMA mask size
338~~~~~~~~~~~~~~~~~~~~~~~~~
339[ If anything below doesn't make sense, please refer to
340 Documentation/DMA-API.txt. This section is just a reminder that
341 drivers need to indicate DMA capabilities of the device and is not
342 an authoritative source for DMA interfaces. ]
343
344While all drivers should explicitly indicate the DMA capability
345(e.g. 32 or 64 bit) of the PCI bus master, devices with more than
34632-bit bus master capability for streaming data need the driver
347to "register" this capability by calling pci_set_dma_mask() with
348appropriate parameters. In general this allows more efficient DMA
349on systems where System RAM exists above 4G _physical_ address.
350
351Drivers for all PCI-X and PCIe compliant devices must call
352pci_set_dma_mask() as they are 64-bit DMA devices.
353
354Similarly, drivers must also "register" this capability if the device
355can directly address "consistent memory" in System RAM above 4G physical
356address by calling pci_set_consistent_dma_mask().
357Again, this includes drivers for all PCI-X and PCIe compliant devices.
358Many 64-bit "PCI" devices (before PCI-X) and some PCI-X devices are
35964-bit DMA capable for payload ("streaming") data but not control
360("consistent") data.
361
362
3633.4 Setup shared control data
364~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
365Once the DMA masks are set, the driver can allocate "consistent" (a.k.a. shared)
366memory. See Documentation/DMA-API.txt for a full description of
367the DMA APIs. This section is just a reminder that it needs to be done
368before enabling DMA on the device.
369
370
3713.5 Initialize device registers
372~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
373Some drivers will need specific "capability" fields programmed
374or other "vendor specific" register initialized or reset.
375E.g. clearing pending interrupts.
376
377
3783.6 Register IRQ handler
379~~~~~~~~~~~~~~~~~~~~~~~~
380While calling request_irq() is the the last step described here,
381this is often just another intermediate step to initialize a device.
382This step can often be deferred until the device is opened for use.
383
384All interrupt handlers for IRQ lines should be registered with IRQF_SHARED
385and use the devid to map IRQs to devices (remember that all PCI IRQ lines
386can be shared).
387
388request_irq() will associate an interrupt handler and device handle
389with an interrupt number. Historically interrupt numbers represent
390IRQ lines which run from the PCI device to the Interrupt controller.
391With MSI and MSI-X (more below) the interrupt number is a CPU "vector".
392
393request_irq() also enables the interrupt. Make sure the device is
394quiesced and does not have any interrupts pending before registering
395the interrupt handler.
396
397MSI and MSI-X are PCI capabilities. Both are "Message Signaled Interrupts"
398which deliver interrupts to the CPU via a DMA write to a Local APIC.
399The fundamental difference between MSI and MSI-X is how multiple
400"vectors" get allocated. MSI requires contiguous blocks of vectors
401while MSI-X can allocate several individual ones.
402
403MSI capability can be enabled by calling pci_enable_msi() or
404pci_enable_msix() before calling request_irq(). This causes
405the PCI support to program CPU vector data into the PCI device
406capability registers.
407
408If your PCI device supports both, try to enable MSI-X first.
409Only one can be enabled at a time. Many architectures, chip-sets,
410or BIOSes do NOT support MSI or MSI-X and the call to pci_enable_msi/msix
411will fail. This is important to note since many drivers have
412two (or more) interrupt handlers: one for MSI/MSI-X and another for IRQs.
413They choose which handler to register with request_irq() based on the
414return value from pci_enable_msi/msix().
415
416There are (at least) two really good reasons for using MSI:
4171) MSI is an exclusive interrupt vector by definition.
418 This means the interrupt handler doesn't have to verify
419 its device caused the interrupt.
420
4212) MSI avoids DMA/IRQ race conditions. DMA to host memory is guaranteed
422 to be visible to the host CPU(s) when the MSI is delivered. This
423 is important for both data coherency and avoiding stale control data.
424 This guarantee allows the driver to omit MMIO reads to flush
425 the DMA stream.
426
427See drivers/infiniband/hw/mthca/ or drivers/net/tg3.c for examples
428of MSI/MSI-X usage.
429
430
431
4324. PCI device shutdown
433~~~~~~~~~~~~~~~~~~~~~~~
434
435When a PCI device driver is being unloaded, most of the following
436steps need to be performed:
437
438 Disable the device from generating IRQs
439 Release the IRQ (free_irq())
440 Stop all DMA activity
441 Release DMA buffers (both streaming and consistent)
442 Unregister from other subsystems (e.g. scsi or netdev)
443 Disable device from responding to MMIO/IO Port addresses
444 Release MMIO/IO Port resource(s)
445
446
4474.1 Stop IRQs on the device
448~~~~~~~~~~~~~~~~~~~~~~~~~~~
449How to do this is chip/device specific. If it's not done, it opens
450the possibility of a "screaming interrupt" if (and only if)
451the IRQ is shared with another device.
452
453When the shared IRQ handler is "unhooked", the remaining devices
454using the same IRQ line will still need the IRQ enabled. Thus if the
455"unhooked" device asserts IRQ line, the system will respond assuming
456it was one of the remaining devices asserted the IRQ line. Since none
457of the other devices will handle the IRQ, the system will "hang" until
458it decides the IRQ isn't going to get handled and masks the IRQ (100,000
459iterations later). Once the shared IRQ is masked, the remaining devices
460will stop functioning properly. Not a nice situation.
461
462This is another reason to use MSI or MSI-X if it's available.
463MSI and MSI-X are defined to be exclusive interrupts and thus
464are not susceptible to the "screaming interrupt" problem.
465
466
4674.2 Release the IRQ
468~~~~~~~~~~~~~~~~~~~
469Once the device is quiesced (no more IRQs), one can call free_irq().
470This function will return control once any pending IRQs are handled,
471"unhook" the drivers IRQ handler from that IRQ, and finally release
472the IRQ if no one else is using it.
473
474
4754.3 Stop all DMA activity
476~~~~~~~~~~~~~~~~~~~~~~~~~
477It's extremely important to stop all DMA operations BEFORE attempting
478to deallocate DMA control data. Failure to do so can result in memory
479corruption, hangs, and on some chip-sets a hard crash.
187 480
1884. How to access PCI config space 481Stopping DMA after stopping the IRQs can avoid races where the
482IRQ handler might restart DMA engines.
483
484While this step sounds obvious and trivial, several "mature" drivers
485didn't get this step right in the past.
486
487
4884.4 Release DMA buffers
489~~~~~~~~~~~~~~~~~~~~~~~
490Once DMA is stopped, clean up streaming DMA first.
491I.e. unmap data buffers and return buffers to "upstream"
492owners if there is one.
493
494Then clean up "consistent" buffers which contain the control data.
495
496See Documentation/DMA-API.txt for details on unmapping interfaces.
497
498
4994.5 Unregister from other subsystems
500~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
501Most low level PCI device drivers support some other subsystem
502like USB, ALSA, SCSI, NetDev, Infiniband, etc. Make sure your
503driver isn't losing resources from that other subsystem.
504If this happens, typically the symptom is an Oops (panic) when
505the subsystem attempts to call into a driver that has been unloaded.
506
507
5084.6 Disable Device from responding to MMIO/IO Port addresses
509~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
510io_unmap() MMIO or IO Port resources and then call pci_disable_device().
511This is the symmetric opposite of pci_enable_device().
512Do not access device registers after calling pci_disable_device().
513
514
5154.7 Release MMIO/IO Port Resource(s)
516~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
517Call pci_release_region() to mark the MMIO or IO Port range as available.
518Failure to do so usually results in the inability to reload the driver.
519
520
521
5225. How to access PCI config space
189~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 523~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
190 You can use pci_(read|write)_config_(byte|word|dword) to access the config 524
525You can use pci_(read|write)_config_(byte|word|dword) to access the config
191space of a device represented by struct pci_dev *. All these functions return 0 526space of a device represented by struct pci_dev *. All these functions return 0
192when successful or an error code (PCIBIOS_...) which can be translated to a text 527when successful or an error code (PCIBIOS_...) which can be translated to a text
193string by pcibios_strerror. Most drivers expect that accesses to valid PCI 528string by pcibios_strerror. Most drivers expect that accesses to valid PCI
194devices don't fail. 529devices don't fail.
195 530
196 If you don't have a struct pci_dev available, you can call 531If you don't have a struct pci_dev available, you can call
197pci_bus_(read|write)_config_(byte|word|dword) to access a given device 532pci_bus_(read|write)_config_(byte|word|dword) to access a given device
198and function on that bus. 533and function on that bus.
199 534
200 If you access fields in the standard portion of the config header, please 535If you access fields in the standard portion of the config header, please
201use symbolic names of locations and bits declared in <linux/pci.h>. 536use symbolic names of locations and bits declared in <linux/pci.h>.
202 537
203 If you need to access Extended PCI Capability registers, just call 538If you need to access Extended PCI Capability registers, just call
204pci_find_capability() for the particular capability and it will find the 539pci_find_capability() for the particular capability and it will find the
205corresponding register block for you. 540corresponding register block for you.
206 541
207 542
2085. Addresses and interrupts
209~~~~~~~~~~~~~~~~~~~~~~~~~~~
210 Memory and port addresses and interrupt numbers should NOT be read from the
211config space. You should use the values in the pci_dev structure as they might
212have been remapped by the kernel.
213
214 See Documentation/IO-mapping.txt for how to access device memory.
215
216 The device driver needs to call pci_request_region() to make sure
217no other device is already using the same resource. The driver is expected
218to determine MMIO and IO Port resource availability _before_ calling
219pci_enable_device(). Conversely, drivers should call pci_release_region()
220_after_ calling pci_disable_device(). The idea is to prevent two devices
221colliding on the same address range.
222
223Generic flavors of pci_request_region() are request_mem_region()
224(for MMIO ranges) and request_region() (for IO Port ranges).
225Use these for address resources that are not described by "normal" PCI
226interfaces (e.g. BAR).
227
228 All interrupt handlers should be registered with IRQF_SHARED and use the devid
229to map IRQs to devices (remember that all PCI interrupts are shared).
230
231 543
2326. Other interesting functions 5446. Other interesting functions
233~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 545~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
546
234pci_find_slot() Find pci_dev corresponding to given bus and 547pci_find_slot() Find pci_dev corresponding to given bus and
235 slot numbers. 548 slot numbers.
236pci_set_power_state() Set PCI Power Management state (0=D0 ... 3=D3) 549pci_set_power_state() Set PCI Power Management state (0=D0 ... 3=D3)
@@ -247,11 +560,12 @@ pci_set_mwi() Enable Memory-Write-Invalidate transactions.
247pci_clear_mwi() Disable Memory-Write-Invalidate transactions. 560pci_clear_mwi() Disable Memory-Write-Invalidate transactions.
248 561
249 562
563
2507. Miscellaneous hints 5647. Miscellaneous hints
251~~~~~~~~~~~~~~~~~~~~~~ 565~~~~~~~~~~~~~~~~~~~~~~
252When displaying PCI slot names to the user (for example when a driver wants 566
253to tell the user what card has it found), please use pci_name(pci_dev) 567When displaying PCI device names to the user (for example when a driver wants
254for this purpose. 568to tell the user what card has it found), please use pci_name(pci_dev).
255 569
256Always refer to the PCI devices by a pointer to the pci_dev structure. 570Always refer to the PCI devices by a pointer to the pci_dev structure.
257All PCI layer functions use this identification and it's the only 571All PCI layer functions use this identification and it's the only
@@ -259,31 +573,113 @@ reasonable one. Don't use bus/slot/function numbers except for very
259special purposes -- on systems with multiple primary buses their semantics 573special purposes -- on systems with multiple primary buses their semantics
260can be pretty complex. 574can be pretty complex.
261 575
262If you're going to use PCI bus mastering DMA, take a look at
263Documentation/DMA-mapping.txt.
264
265Don't try to turn on Fast Back to Back writes in your driver. All devices 576Don't try to turn on Fast Back to Back writes in your driver. All devices
266on the bus need to be capable of doing it, so this is something which needs 577on the bus need to be capable of doing it, so this is something which needs
267to be handled by platform and generic code, not individual drivers. 578to be handled by platform and generic code, not individual drivers.
268 579
269 580
581
2708. Vendor and device identifications 5828. Vendor and device identifications
271~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 583~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
272For the future, let's avoid adding device ids to include/linux/pci_ids.h.
273 584
274PCI_VENDOR_ID_xxx for vendors, and a hex constant for device ids. 585One is not not required to add new device ids to include/linux/pci_ids.h.
586Please add PCI_VENDOR_ID_xxx for vendors and a hex constant for device ids.
587
588PCI_VENDOR_ID_xxx constants are re-used. The device ids are arbitrary
589hex numbers (vendor controlled) and normally used only in a single
590location, the pci_device_id table.
591
592Please DO submit new vendor/device ids to pciids.sourceforge.net project.
593
275 594
276Rationale: PCI_VENDOR_ID_xxx constants are re-used, but device ids are not.
277 Further, device ids are arbitrary hex numbers, normally used only in a
278 single location, the pci_device_id table.
279 595
2809. Obsolete functions 5969. Obsolete functions
281~~~~~~~~~~~~~~~~~~~~~ 597~~~~~~~~~~~~~~~~~~~~~
598
282There are several functions which you might come across when trying to 599There are several functions which you might come across when trying to
283port an old driver to the new PCI interface. They are no longer present 600port an old driver to the new PCI interface. They are no longer present
284in the kernel as they aren't compatible with hotplug or PCI domains or 601in the kernel as they aren't compatible with hotplug or PCI domains or
285having sane locking. 602having sane locking.
286 603
287pci_find_device() Superseded by pci_get_device() 604pci_find_device() Superseded by pci_get_device()
288pci_find_subsys() Superseded by pci_get_subsys() 605pci_find_subsys() Superseded by pci_get_subsys()
289pci_find_slot() Superseded by pci_get_slot() 606pci_find_slot() Superseded by pci_get_slot()
607
608
609The alternative is the traditional PCI device driver that walks PCI
610device lists. This is still possible but discouraged.
611
612
613
61410. pci_enable_device_bars() and Legacy I/O Port space
615~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
616
617Large servers may not be able to provide I/O port resources to all PCI
618devices. I/O Port space is only 64KB on Intel Architecture[1] and is
619likely also fragmented since the I/O base register of PCI-to-PCI
620bridge will usually be aligned to a 4KB boundary[2]. On such systems,
621pci_enable_device() and pci_request_region() will fail when
622attempting to enable I/O Port regions that don't have I/O Port
623resources assigned.
624
625Fortunately, many PCI devices which request I/O Port resources also
626provide access to the same registers via MMIO BARs. These devices can
627be handled without using I/O port space and the drivers typically
628offer a CONFIG_ option to only use MMIO regions
629(e.g. CONFIG_TULIP_MMIO). PCI devices typically provide I/O port
630interface for legacy OSes and will work when I/O port resources are not
631assigned. The "PCI Local Bus Specification Revision 3.0" discusses
632this on p.44, "IMPLEMENTATION NOTE".
633
634If your PCI device driver doesn't need I/O port resources assigned to
635I/O Port BARs, you should use pci_enable_device_bars() instead of
636pci_enable_device() in order not to enable I/O port regions for the
637corresponding devices. In addition, you should use
638pci_request_selected_regions() and pci_release_selected_regions()
639instead of pci_request_regions()/pci_release_regions() in order not to
640request/release I/O port regions for the corresponding devices.
641
642[1] Some systems support 64KB I/O port space per PCI segment.
643[2] Some PCI-to-PCI bridges support optional 1KB aligned I/O base.
644
645
646
64711. MMIO Space and "Write Posting"
648~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
649
650Converting a driver from using I/O Port space to using MMIO space
651often requires some additional changes. Specifically, "write posting"
652needs to be handled. Many drivers (e.g. tg3, acenic, sym53c8xx_2)
653already do this. I/O Port space guarantees write transactions reach the PCI
654device before the CPU can continue. Writes to MMIO space allow the CPU
655to continue before the transaction reaches the PCI device. HW weenies
656call this "Write Posting" because the write completion is "posted" to
657the CPU before the transaction has reached its destination.
658
659Thus, timing sensitive code should add readl() where the CPU is
660expected to wait before doing other work. The classic "bit banging"
661sequence works fine for I/O Port space:
662
663 for (i = 8; --i; val >>= 1) {
664 outb(val & 1, ioport_reg); /* write bit */
665 udelay(10);
666 }
667
668The same sequence for MMIO space should be:
669
670 for (i = 8; --i; val >>= 1) {
671 writeb(val & 1, mmio_reg); /* write bit */
672 readb(safe_mmio_reg); /* flush posted write */
673 udelay(10);
674 }
675
676It is important that "safe_mmio_reg" not have any side effects that
677interferes with the correct operation of the device.
678
679Another case to watch out for is when resetting a PCI device. Use PCI
680Configuration space reads to flush the writel(). This will gracefully
681handle the PCI master abort on all platforms if the PCI device is
682expected to not respond to a readl(). Most x86 platforms will allow
683MMIO reads to master abort (a.k.a. "Soft Fail") and return garbage
684(e.g. ~0). But many RISC platforms will crash (a.k.a."Hard Fail").
685
diff --git a/Documentation/powerpc/booting-without-of.txt b/Documentation/powerpc/booting-without-of.txt
index b3bd36668db3..33994271cb3b 100644
--- a/Documentation/powerpc/booting-without-of.txt
+++ b/Documentation/powerpc/booting-without-of.txt
@@ -1703,29 +1703,32 @@ platforms are moved over to use the flattened-device-tree model.
1703 Required properties: 1703 Required properties:
1704 1704
1705 - device_type : has to be "rom" 1705 - device_type : has to be "rom"
1706 - compatible : Should specify what this ROM device is compatible with 1706 - compatible : Should specify what this flash device is compatible with.
1707 (i.e. "onenand"). Currently, this is most likely to be "direct-mapped" 1707 Currently, this is most likely to be "direct-mapped" (which
1708 (which corresponds to the MTD physmap mapping driver). 1708 corresponds to the MTD physmap mapping driver).
1709 - regs : Offset and length of the register set (or memory mapping) for 1709 - reg : Offset and length of the register set (or memory mapping) for
1710 the device. 1710 the device.
1711 - bank-width : Width of the flash data bus in bytes. Required
1712 for the NOR flashes (compatible == "direct-mapped" and others) ONLY.
1711 1713
1712 Recommended properties : 1714 Recommended properties :
1713 1715
1714 - bank-width : Width of the flash data bus in bytes. Required
1715 for the NOR flashes (compatible == "direct-mapped" and others) ONLY.
1716 - partitions : Several pairs of 32-bit values where the first value is 1716 - partitions : Several pairs of 32-bit values where the first value is
1717 partition's offset from the start of the device and the second one is 1717 partition's offset from the start of the device and the second one is
1718 partition size in bytes with LSB used to signify a read only 1718 partition size in bytes with LSB used to signify a read only
1719 partititon (so, the parition size should always be an even number). 1719 partition (so, the parition size should always be an even number).
1720 - partition-names : The list of concatenated zero terminated strings 1720 - partition-names : The list of concatenated zero terminated strings
1721 representing the partition names. 1721 representing the partition names.
1722 - probe-type : The type of probe which should be done for the chip
1723 (JEDEC vs CFI actually). Valid ONLY for NOR flashes.
1722 1724
1723 Example: 1725 Example:
1724 1726
1725 flash@ff000000 { 1727 flash@ff000000 {
1726 device_type = "rom"; 1728 device_type = "rom";
1727 compatible = "direct-mapped"; 1729 compatible = "direct-mapped";
1728 regs = <ff000000 01000000>; 1730 probe-type = "CFI";
1731 reg = <ff000000 01000000>;
1729 bank-width = <4>; 1732 bank-width = <4>;
1730 partitions = <00000000 00f80000 1733 partitions = <00000000 00f80000
1731 00f80000 00080001>; 1734 00f80000 00080001>;
diff --git a/Documentation/powerpc/mpc52xx-device-tree-bindings.txt b/Documentation/powerpc/mpc52xx-device-tree-bindings.txt
index d077d764f82b..69f016f02bb0 100644
--- a/Documentation/powerpc/mpc52xx-device-tree-bindings.txt
+++ b/Documentation/powerpc/mpc52xx-device-tree-bindings.txt
@@ -4,6 +4,12 @@ MPC52xx Device Tree Bindings
4(c) 2006 Secret Lab Technologies Ltd 4(c) 2006 Secret Lab Technologies Ltd
5Grant Likely <grant.likely at secretlab.ca> 5Grant Likely <grant.likely at secretlab.ca>
6 6
7********** DRAFT ***********
8* WARNING: Do not depend on the stability of these bindings just yet.
9* The MPC5200 device tree conventions are still in flux
10* Keep an eye on the linuxppc-dev mailing list for more details
11********** DRAFT ***********
12
7I - Introduction 13I - Introduction
8================ 14================
9Boards supported by the arch/powerpc architecture require device tree be 15Boards supported by the arch/powerpc architecture require device tree be
@@ -157,8 +163,8 @@ rtc@<addr> rtc *-rtc Real time clock
157mscan@<addr> mscan *-mscan CAN bus controller 163mscan@<addr> mscan *-mscan CAN bus controller
158pci@<addr> pci *-pci PCI bridge 164pci@<addr> pci *-pci PCI bridge
159serial@<addr> serial *-psc-uart PSC in serial mode 165serial@<addr> serial *-psc-uart PSC in serial mode
160i2s@<addr> i2s *-psc-i2s PSC in i2s mode 166i2s@<addr> sound *-psc-i2s PSC in i2s mode
161ac97@<addr> ac97 *-psc-ac97 PSC in ac97 mode 167ac97@<addr> sound *-psc-ac97 PSC in ac97 mode
162spi@<addr> spi *-psc-spi PSC in spi mode 168spi@<addr> spi *-psc-spi PSC in spi mode
163irda@<addr> irda *-psc-irda PSC in IrDA mode 169irda@<addr> irda *-psc-irda PSC in IrDA mode
164spi@<addr> spi *-spi MPC52xx spi device 170spi@<addr> spi *-spi MPC52xx spi device
diff --git a/Documentation/scsi/aacraid.txt b/Documentation/scsi/aacraid.txt
index 3367130e64f6..dc8e44fc650f 100644
--- a/Documentation/scsi/aacraid.txt
+++ b/Documentation/scsi/aacraid.txt
@@ -11,43 +11,42 @@ the original).
11Supported Cards/Chipsets 11Supported Cards/Chipsets
12------------------------- 12-------------------------
13 PCI ID (pci.ids) OEM Product 13 PCI ID (pci.ids) OEM Product
14 9005:0283:9005:0283 Adaptec Catapult (3210S with arc firmware)
15 9005:0284:9005:0284 Adaptec Tomcat (3410S with arc firmware)
16 9005:0285:9005:0285 Adaptec 2200S (Vulcan) 14 9005:0285:9005:0285 Adaptec 2200S (Vulcan)
17 9005:0285:9005:0286 Adaptec 2120S (Crusader) 15 9005:0285:9005:0286 Adaptec 2120S (Crusader)
18 9005:0285:9005:0287 Adaptec 2200S (Vulcan-2m) 16 9005:0285:9005:0287 Adaptec 2200S (Vulcan-2m)
19 9005:0285:9005:0288 Adaptec 3230S (Harrier) 17 9005:0285:9005:0288 Adaptec 3230S (Harrier)
20 9005:0285:9005:0289 Adaptec 3240S (Tornado) 18 9005:0285:9005:0289 Adaptec 3240S (Tornado)
21 9005:0285:9005:028a Adaptec 2020ZCR (Skyhawk) 19 9005:0285:9005:028a Adaptec 2020ZCR (Skyhawk)
22 9005:0285:9005:028b Adaptec 2025ZCR (Terminator) 20 9005:0285:9005:028b Adaptec 2025ZCR (Terminator)
23 9005:0286:9005:028c Adaptec 2230S (Lancer) 21 9005:0286:9005:028c Adaptec 2230S (Lancer)
24 9005:0286:9005:028c Adaptec 2230SLP (Lancer) 22 9005:0286:9005:028c Adaptec 2230SLP (Lancer)
25 9005:0286:9005:028d Adaptec 2130S (Lancer) 23 9005:0286:9005:028d Adaptec 2130S (Lancer)
26 9005:0285:9005:028e Adaptec 2020SA (Skyhawk) 24 9005:0285:9005:028e Adaptec 2020SA (Skyhawk)
27 9005:0285:9005:028f Adaptec 2025SA (Terminator) 25 9005:0285:9005:028f Adaptec 2025SA (Terminator)
28 9005:0285:9005:0290 Adaptec 2410SA (Jaguar) 26 9005:0285:9005:0290 Adaptec 2410SA (Jaguar)
29 9005:0285:103c:3227 Adaptec 2610SA (Bearcat HP release) 27 9005:0285:103c:3227 Adaptec 2610SA (Bearcat HP release)
30 9005:0285:9005:0293 Adaptec 21610SA (Corsair-16) 28 9005:0285:9005:0293 Adaptec 21610SA (Corsair-16)
31 9005:0285:9005:0296 Adaptec 2240S (SabreExpress) 29 9005:0285:9005:0296 Adaptec 2240S (SabreExpress)
32 9005:0285:9005:0292 Adaptec 2810SA (Corsair-8) 30 9005:0285:9005:0292 Adaptec 2810SA (Corsair-8)
33 9005:0285:9005:0294 Adaptec Prowler 31 9005:0285:9005:0297 Adaptec 4005 (AvonPark)
34 9005:0285:9005:0297 Adaptec 4005SAS (AvonPark) 32 9005:0285:9005:0298 Adaptec 4000 (BlackBird)
35 9005:0285:9005:0298 Adaptec 4000SAS (BlackBird)
36 9005:0285:9005:0299 Adaptec 4800SAS (Marauder-X) 33 9005:0285:9005:0299 Adaptec 4800SAS (Marauder-X)
37 9005:0285:9005:029a Adaptec 4805SAS (Marauder-E) 34 9005:0285:9005:029a Adaptec 4805SAS (Marauder-E)
38 9005:0286:9005:029b Adaptec 2820SA (Intruder) 35 9005:0286:9005:029b Adaptec 2820SA (Intruder)
39 9005:0286:9005:029c Adaptec 2620SA (Intruder) 36 9005:0286:9005:029c Adaptec 2620SA (Intruder)
40 9005:0286:9005:029d Adaptec 2420SA (Intruder HP release) 37 9005:0286:9005:029d Adaptec 2420SA (Intruder HP release)
41 9005:0286:9005:02a2 Adaptec 3800SAS (Hurricane44) 38 9005:0286:9005:02ac Adaptec 1800 (Typhoon44)
42 9005:0286:9005:02a7 Adaptec 3805SAS (Hurricane80) 39 9005:0285:9005:02b5 Adaptec 5445 (Voodoo44)
43 9005:0286:9005:02a8 Adaptec 3400SAS (Hurricane40) 40 9005:0285:9005:02b6 Adaptec 5805 (Voodoo80)
44 9005:0286:9005:02ac Adaptec 1800SAS (Typhoon44) 41 9005:0285:9005:02b7 Adaptec 5085 (Voodoo08)
45 9005:0286:9005:02b3 Adaptec 2400SAS (Hurricane40lm) 42 9005:0285:9005:02bb Adaptec 3405 (Marauder40LP)
46 9005:0285:9005:02b5 Adaptec ASR5800 (Voodoo44) 43 9005:0285:9005:02bc Adaptec 3805 (Marauder80LP)
47 9005:0285:9005:02b6 Adaptec ASR5805 (Voodoo80) 44 9005:0285:9005:02c7 Adaptec 3085 (Marauder08ELP)
48 9005:0285:9005:02b7 Adaptec ASR5808 (Voodoo08) 45 9005:0285:9005:02bd Adaptec 31205 (Marauder120)
46 9005:0285:9005:02be Adaptec 31605 (Marauder160)
47 9005:0285:9005:02c3 Adaptec 51205 (Voodoo120)
48 9005:0285:9005:02c4 Adaptec 51605 (Voodoo160)
49 1011:0046:9005:0364 Adaptec 5400S (Mustang) 49 1011:0046:9005:0364 Adaptec 5400S (Mustang)
50 1011:0046:9005:0365 Adaptec 5400S (Mustang)
51 9005:0287:9005:0800 Adaptec Themisto (Jupiter) 50 9005:0287:9005:0800 Adaptec Themisto (Jupiter)
52 9005:0200:9005:0200 Adaptec Themisto (Jupiter) 51 9005:0200:9005:0200 Adaptec Themisto (Jupiter)
53 9005:0286:9005:0800 Adaptec Callisto (Jupiter) 52 9005:0286:9005:0800 Adaptec Callisto (Jupiter)
@@ -68,21 +67,32 @@ Supported Cards/Chipsets
68 9005:0285:17aa:0287 Legend S230 (Vulcan) 67 9005:0285:17aa:0287 Legend S230 (Vulcan)
69 9005:0285:9005:0290 IBM ServeRAID 7t (Jaguar) 68 9005:0285:9005:0290 IBM ServeRAID 7t (Jaguar)
70 9005:0285:1014:02F2 IBM ServeRAID 8i (AvonPark) 69 9005:0285:1014:02F2 IBM ServeRAID 8i (AvonPark)
71 9005:0285:1014:0312 IBM ServeRAID 8i (AvonParkLite)
72 9005:0286:1014:9540 IBM ServeRAID 8k/8k-l4 (AuroraLite) 70 9005:0286:1014:9540 IBM ServeRAID 8k/8k-l4 (AuroraLite)
73 9005:0286:1014:9580 IBM ServeRAID 8k/8k-l8 (Aurora) 71 9005:0286:1014:9580 IBM ServeRAID 8k/8k-l8 (Aurora)
74 9005:0286:1014:034d IBM ServeRAID 8s (Hurricane) 72 9005:0285:1014:034d IBM ServeRAID 8s (Marauder-E)
75 9005:0286:9005:029e ICP ICP9024R0 (Lancer) 73 9005:0286:9005:029e ICP ICP9024RO (Lancer)
76 9005:0286:9005:029f ICP ICP9014R0 (Lancer) 74 9005:0286:9005:029f ICP ICP9014RO (Lancer)
77 9005:0286:9005:02a0 ICP ICP9047MA (Lancer) 75 9005:0286:9005:02a0 ICP ICP9047MA (Lancer)
78 9005:0286:9005:02a1 ICP ICP9087MA (Lancer) 76 9005:0286:9005:02a1 ICP ICP9087MA (Lancer)
79 9005:0286:9005:02a3 ICP ICP5445AU (Hurricane44) 77 9005:0285:9005:02a4 ICP ICP9085LI (Marauder-X)
80 9005:0286:9005:02a4 ICP ICP9085LI (Marauder-X) 78 9005:0285:9005:02a5 ICP ICP5085BR (Marauder-E)
81 9005:0286:9005:02a5 ICP ICP5085BR (Marauder-E)
82 9005:0286:9005:02a6 ICP ICP9067MA (Intruder-6) 79 9005:0286:9005:02a6 ICP ICP9067MA (Intruder-6)
83 9005:0286:9005:02a9 ICP ICP5085AU (Hurricane80) 80 9005:0285:9005:02b2 ICP (Voodoo 8 internal 8 external)
84 9005:0286:9005:02aa ICP ICP5045AU (Hurricane40) 81 9005:0285:9005:02b8 ICP ICP5445SL (Voodoo44)
85 9005:0286:9005:02b4 ICP ICP5045AL (Hurricane40lm) 82 9005:0285:9005:02b9 ICP ICP5085SL (Voodoo80)
83 9005:0285:9005:02ba ICP ICP5805SL (Voodoo08)
84 9005:0285:9005:02bf ICP ICP5045BL (Marauder40LP)
85 9005:0285:9005:02c0 ICP ICP5085BL (Marauder80LP)
86 9005:0285:9005:02c8 ICP ICP5805BL (Marauder08ELP)
87 9005:0285:9005:02c1 ICP ICP5125BR (Marauder120)
88 9005:0285:9005:02c2 ICP ICP5165BR (Marauder160)
89 9005:0285:9005:02c5 ICP ICP5125SL (Voodoo120)
90 9005:0285:9005:02c6 ICP ICP5165SL (Voodoo160)
91 9005:0286:9005:02ab (Typhoon40)
92 9005:0286:9005:02ad (Aurora ARK)
93 9005:0286:9005:02ae (Aurora Lite ARK)
94 9005:0285:9005:02b0 (Sunrise Lake ARK)
95 9005:0285:9005:02b1 Adaptec (Voodoo 8 internal 8 external)
86 96
87People 97People
88------------------------- 98-------------------------
diff --git a/Documentation/sound/alsa/DocBook/writing-an-alsa-driver.tmpl b/Documentation/sound/alsa/DocBook/writing-an-alsa-driver.tmpl
index 077fbe25ebf4..ccd0a953953d 100644
--- a/Documentation/sound/alsa/DocBook/writing-an-alsa-driver.tmpl
+++ b/Documentation/sound/alsa/DocBook/writing-an-alsa-driver.tmpl
@@ -927,7 +927,7 @@
927 <informalexample> 927 <informalexample>
928 <programlisting> 928 <programlisting>
929<![CDATA[ 929<![CDATA[
930 struct mychip *chip = (struct mychip *)card->private_data; 930 struct mychip *chip = card->private_data;
931]]> 931]]>
932 </programlisting> 932 </programlisting>
933 </informalexample> 933 </informalexample>
@@ -1095,7 +1095,7 @@
1095 1095
1096 /* release the irq */ 1096 /* release the irq */
1097 if (chip->irq >= 0) 1097 if (chip->irq >= 0)
1098 free_irq(chip->irq, (void *)chip); 1098 free_irq(chip->irq, chip);
1099 /* release the i/o ports & memory */ 1099 /* release the i/o ports & memory */
1100 pci_release_regions(chip->pci); 1100 pci_release_regions(chip->pci);
1101 /* disable the PCI entry */ 1101 /* disable the PCI entry */
@@ -1148,7 +1148,7 @@
1148 } 1148 }
1149 chip->port = pci_resource_start(pci, 0); 1149 chip->port = pci_resource_start(pci, 0);
1150 if (request_irq(pci->irq, snd_mychip_interrupt, 1150 if (request_irq(pci->irq, snd_mychip_interrupt,
1151 IRQF_DISABLED|IRQF_SHARED, "My Chip", chip)) { 1151 IRQF_SHARED, "My Chip", chip)) {
1152 printk(KERN_ERR "cannot grab irq %d\n", pci->irq); 1152 printk(KERN_ERR "cannot grab irq %d\n", pci->irq);
1153 snd_mychip_free(chip); 1153 snd_mychip_free(chip);
1154 return -EBUSY; 1154 return -EBUSY;
@@ -1387,7 +1387,7 @@
1387 <programlisting> 1387 <programlisting>
1388<![CDATA[ 1388<![CDATA[
1389 if (chip->irq >= 0) 1389 if (chip->irq >= 0)
1390 free_irq(chip->irq, (void *)chip); 1390 free_irq(chip->irq, chip);
1391]]> 1391]]>
1392 </programlisting> 1392 </programlisting>
1393 </informalexample> 1393 </informalexample>
diff --git a/Documentation/sysrq.txt b/Documentation/sysrq.txt
index e0188a23fd5e..61613166981b 100644
--- a/Documentation/sysrq.txt
+++ b/Documentation/sysrq.txt
@@ -1,6 +1,6 @@
1Linux Magic System Request Key Hacks 1Linux Magic System Request Key Hacks
2Documentation for sysrq.c version 1.15 2Documentation for sysrq.c
3Last update: $Date: 2001/01/28 10:15:59 $ 3Last update: 2007-JAN-06
4 4
5* What is the magic SysRq key? 5* What is the magic SysRq key?
6~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 6~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -35,7 +35,7 @@ You can set the value in the file by the following command:
35 35
36Note that the value of /proc/sys/kernel/sysrq influences only the invocation 36Note that the value of /proc/sys/kernel/sysrq influences only the invocation
37via a keyboard. Invocation of any operation via /proc/sysrq-trigger is always 37via a keyboard. Invocation of any operation via /proc/sysrq-trigger is always
38allowed. 38allowed (by a user with admin privileges).
39 39
40* How do I use the magic SysRq key? 40* How do I use the magic SysRq key?
41~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 41~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -58,7 +58,7 @@ On PowerPC - Press 'ALT - Print Screen (or F13) - <command key>,
58On other - If you know of the key combos for other architectures, please 58On other - If you know of the key combos for other architectures, please
59 let me know so I can add them to this section. 59 let me know so I can add them to this section.
60 60
61On all - write a character to /proc/sysrq-trigger. eg: 61On all - write a character to /proc/sysrq-trigger. e.g.:
62 62
63 echo t > /proc/sysrq-trigger 63 echo t > /proc/sysrq-trigger
64 64
@@ -74,6 +74,8 @@ On all - write a character to /proc/sysrq-trigger. eg:
74 74
75'c' - Will perform a kexec reboot in order to take a crashdump. 75'c' - Will perform a kexec reboot in order to take a crashdump.
76 76
77'd' - Shows all locks that are held.
78
77'o' - Will shut your system off (if configured and supported). 79'o' - Will shut your system off (if configured and supported).
78 80
79's' - Will attempt to sync all mounted filesystems. 81's' - Will attempt to sync all mounted filesystems.
@@ -87,38 +89,43 @@ On all - write a character to /proc/sysrq-trigger. eg:
87 89
88'm' - Will dump current memory info to your console. 90'm' - Will dump current memory info to your console.
89 91
92'n' - Used to make RT tasks nice-able
93
90'v' - Dumps Voyager SMP processor info to your console. 94'v' - Dumps Voyager SMP processor info to your console.
91 95
96'w' - Dumps tasks that are in uninterruptable (blocked) state.
97
98'x' - Used by xmon interface on ppc/powerpc platforms.
99
92'0'-'9' - Sets the console log level, controlling which kernel messages 100'0'-'9' - Sets the console log level, controlling which kernel messages
93 will be printed to your console. ('0', for example would make 101 will be printed to your console. ('0', for example would make
94 it so that only emergency messages like PANICs or OOPSes would 102 it so that only emergency messages like PANICs or OOPSes would
95 make it to your console.) 103 make it to your console.)
96 104
97'f' - Will call oom_kill to kill a memory hog process 105'f' - Will call oom_kill to kill a memory hog process.
98 106
99'e' - Send a SIGTERM to all processes, except for init. 107'e' - Send a SIGTERM to all processes, except for init.
100 108
101'i' - Send a SIGKILL to all processes, except for init. 109'g' - Used by kgdb on ppc platforms.
102 110
103'l' - Send a SIGKILL to all processes, INCLUDING init. (Your system 111'i' - Send a SIGKILL to all processes, except for init.
104 will be non-functional after this.)
105 112
106'h' - Will display help ( actually any other key than those listed 113'h' - Will display help (actually any other key than those listed
107 above will display help. but 'h' is easy to remember :-) 114 above will display help. but 'h' is easy to remember :-)
108 115
109* Okay, so what can I use them for? 116* Okay, so what can I use them for?
110~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 117~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
111Well, un'R'aw is very handy when your X server or a svgalib program crashes. 118Well, un'R'aw is very handy when your X server or a svgalib program crashes.
112 119
113sa'K' (Secure Access Key) is useful when you want to be sure there are no 120sa'K' (Secure Access Key) is useful when you want to be sure there is no
114trojan program is running at console and which could grab your password 121trojan program running at console which could grab your password
115when you would try to login. It will kill all programs on given console 122when you would try to login. It will kill all programs on given console,
116and thus letting you make sure that the login prompt you see is actually 123thus letting you make sure that the login prompt you see is actually
117the one from init, not some trojan program. 124the one from init, not some trojan program.
118IMPORTANT: In its true form it is not a true SAK like the one in a :IMPORTANT 125IMPORTANT: In its true form it is not a true SAK like the one in a :IMPORTANT
119IMPORTANT: c2 compliant system, and it should not be mistaken as :IMPORTANT 126IMPORTANT: c2 compliant system, and it should not be mistaken as :IMPORTANT
120IMPORTANT: such. :IMPORTANT 127IMPORTANT: such. :IMPORTANT
121 It seems other find it useful as (System Attention Key) which is 128 It seems others find it useful as (System Attention Key) which is
122useful when you want to exit a program that will not let you switch consoles. 129useful when you want to exit a program that will not let you switch consoles.
123(For example, X or a svgalib program.) 130(For example, X or a svgalib program.)
124 131
@@ -139,8 +146,8 @@ OK or Done message...)
139Again, the unmount (remount read-only) hasn't taken place until you see the 146Again, the unmount (remount read-only) hasn't taken place until you see the
140"OK" and "Done" message appear on the screen. 147"OK" and "Done" message appear on the screen.
141 148
142The loglevel'0'-'9' is useful when your console is being flooded with 149The loglevels '0'-'9' are useful when your console is being flooded with
143kernel messages you do not want to see. Setting '0' will prevent all but 150kernel messages you do not want to see. Selecting '0' will prevent all but
144the most urgent kernel messages from reaching your console. (They will 151the most urgent kernel messages from reaching your console. (They will
145still be logged if syslogd/klogd are alive, though.) 152still be logged if syslogd/klogd are alive, though.)
146 153
@@ -152,7 +159,7 @@ processes.
152~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 159~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
153That happens to me, also. I've found that tapping shift, alt, and control 160That happens to me, also. I've found that tapping shift, alt, and control
154on both sides of the keyboard, and hitting an invalid sysrq sequence again 161on both sides of the keyboard, and hitting an invalid sysrq sequence again
155will fix the problem. (ie, something like alt-sysrq-z). Switching to another 162will fix the problem. (i.e., something like alt-sysrq-z). Switching to another
156virtual console (ALT+Fn) and then back again should also help. 163virtual console (ALT+Fn) and then back again should also help.
157 164
158* I hit SysRq, but nothing seems to happen, what's wrong? 165* I hit SysRq, but nothing seems to happen, what's wrong?
@@ -174,11 +181,11 @@ handler function you will use, B) a help_msg string, that will print when SysRQ
174prints help, and C) an action_msg string, that will print right before your 181prints help, and C) an action_msg string, that will print right before your
175handler is called. Your handler must conform to the prototype in 'sysrq.h'. 182handler is called. Your handler must conform to the prototype in 'sysrq.h'.
176 183
177After the sysrq_key_op is created, you can call the macro 184After the sysrq_key_op is created, you can call the kernel function
178register_sysrq_key(int key, struct sysrq_key_op *op_p) that is defined in 185register_sysrq_key(int key, struct sysrq_key_op *op_p); this will
179sysrq.h, this will register the operation pointed to by 'op_p' at table 186register the operation pointed to by 'op_p' at table key 'key',
180key 'key', if that slot in the table is blank. At module unload time, you must 187if that slot in the table is blank. At module unload time, you must call
181call the macro unregister_sysrq_key(int key, struct sysrq_key_op *op_p), which 188the function unregister_sysrq_key(int key, struct sysrq_key_op *op_p), which
182will remove the key op pointed to by 'op_p' from the key 'key', if and only if 189will remove the key op pointed to by 'op_p' from the key 'key', if and only if
183it is currently registered in that slot. This is in case the slot has been 190it is currently registered in that slot. This is in case the slot has been
184overwritten since you registered it. 191overwritten since you registered it.
@@ -186,15 +193,12 @@ overwritten since you registered it.
186The Magic SysRQ system works by registering key operations against a key op 193The Magic SysRQ system works by registering key operations against a key op
187lookup table, which is defined in 'drivers/char/sysrq.c'. This key table has 194lookup table, which is defined in 'drivers/char/sysrq.c'. This key table has
188a number of operations registered into it at compile time, but is mutable, 195a number of operations registered into it at compile time, but is mutable,
189and 4 functions are exported for interface to it: __sysrq_lock_table, 196and 2 functions are exported for interface to it:
190__sysrq_unlock_table, __sysrq_get_key_op, and __sysrq_put_key_op. The 197 register_sysrq_key and unregister_sysrq_key.
191functions __sysrq_swap_key_ops and __sysrq_swap_key_ops_nolock are defined 198Of course, never ever leave an invalid pointer in the table. I.e., when
192in the header itself, and the REGISTER and UNREGISTER macros are built from 199your module that called register_sysrq_key() exits, it must call
193these. More complex (and dangerous!) manipulations of the table are possible 200unregister_sysrq_key() to clean up the sysrq key table entry that it used.
194using these functions, but you must be careful to always lock the table before 201Null pointers in the table are always safe. :)
195you read or write from it, and to unlock it again when you are done. (And of
196course, to never ever leave an invalid pointer in the table). Null pointers in
197the table are always safe :)
198 202
199If for some reason you feel the need to call the handle_sysrq function from 203If for some reason you feel the need to call the handle_sysrq function from
200within a function called by handle_sysrq, you must be aware that you are in 204within a function called by handle_sysrq, you must be aware that you are in
diff --git a/Documentation/tty.txt b/Documentation/tty.txt
index dab56604745d..5f799e612e03 100644
--- a/Documentation/tty.txt
+++ b/Documentation/tty.txt
@@ -39,28 +39,37 @@ Line Discipline Methods
39 39
40TTY side interfaces: 40TTY side interfaces:
41 41
42open() - Called when the line discipline is attached to
43 the terminal. No other call into the line
44 discipline for this tty will occur until it
45 completes successfully. Can sleep.
46
42close() - This is called on a terminal when the line 47close() - This is called on a terminal when the line
43 discipline is being unplugged. At the point of 48 discipline is being unplugged. At the point of
44 execution no further users will enter the 49 execution no further users will enter the
45 ldisc code for this tty. Can sleep. 50 ldisc code for this tty. Can sleep.
46 51
47open() - Called when the line discipline is attached to 52hangup() - Called when the tty line is hung up.
48 the terminal. No other call into the line 53 The line discipline should cease I/O to the tty.
49 discipline for this tty will occur until it 54 No further calls into the ldisc code will occur.
50 completes successfully. Can sleep. 55 Can sleep.
51 56
52write() - A process is writing data through the line 57write() - A process is writing data through the line
53 discipline. Multiple write calls are serialized 58 discipline. Multiple write calls are serialized
54 by the tty layer for the ldisc. May sleep. 59 by the tty layer for the ldisc. May sleep.
55 60
56flush_buffer() - May be called at any point between open and close. 61flush_buffer() - (optional) May be called at any point between
62 open and close, and instructs the line discipline
63 to empty its input buffer.
57 64
58chars_in_buffer() - Report the number of bytes in the buffer. 65chars_in_buffer() - (optional) Report the number of bytes in the input
66 buffer.
59 67
60set_termios() - Called on termios structure changes. The caller 68set_termios() - (optional) Called on termios structure changes.
61 passes the old termios data and the current data 69 The caller passes the old termios data and the
62 is in the tty. Called under the termios semaphore so 70 current data is in the tty. Called under the
63 allowed to sleep. Serialized against itself only. 71 termios semaphore so allowed to sleep. Serialized
72 against itself only.
64 73
65read() - Move data from the line discipline to the user. 74read() - Move data from the line discipline to the user.
66 Multiple read calls may occur in parallel and the 75 Multiple read calls may occur in parallel and the
@@ -92,6 +101,88 @@ write_wakeup() - May be called at any point between open and close.
92 this function. In such a situation defer it. 101 this function. In such a situation defer it.
93 102
94 103
104Driver Access
105
106Line discipline methods can call the following methods of the underlying
107hardware driver through the function pointers within the tty->driver
108structure:
109
110write() Write a block of characters to the tty device.
111 Returns the number of characters accepted.
112
113put_char() Queues a character for writing to the tty device.
114 If there is no room in the queue, the character is
115 ignored.
116
117flush_chars() (Optional) If defined, must be called after
118 queueing characters with put_char() in order to
119 start transmission.
120
121write_room() Returns the numbers of characters the tty driver
122 will accept for queueing to be written.
123
124ioctl() Invoke device specific ioctl.
125 Expects data pointers to refer to userspace.
126 Returns ENOIOCTLCMD for unrecognized ioctl numbers.
127
128set_termios() Notify the tty driver that the device's termios
129 settings have changed. New settings are in
130 tty->termios. Previous settings should be passed in
131 the "old" argument.
132
133throttle() Notify the tty driver that input buffers for the
134 line discipline are close to full, and it should
135 somehow signal that no more characters should be
136 sent to the tty.
137
138unthrottle() Notify the tty driver that characters can now be
139 sent to the tty without fear of overrunning the
140 input buffers of the line disciplines.
141
142stop() Ask the tty driver to stop outputting characters
143 to the tty device.
144
145start() Ask the tty driver to resume sending characters
146 to the tty device.
147
148hangup() Ask the tty driver to hang up the tty device.
149
150break_ctl() (Optional) Ask the tty driver to turn on or off
151 BREAK status on the RS-232 port. If state is -1,
152 then the BREAK status should be turned on; if
153 state is 0, then BREAK should be turned off.
154 If this routine is not implemented, use ioctls
155 TIOCSBRK / TIOCCBRK instead.
156
157wait_until_sent() Waits until the device has written out all of the
158 characters in its transmitter FIFO.
159
160send_xchar() Send a high-priority XON/XOFF character to the device.
161
162
163Flags
164
165Line discipline methods have access to tty->flags field containing the
166following interesting flags:
167
168TTY_THROTTLED Driver input is throttled. The ldisc should call
169 tty->driver->unthrottle() in order to resume
170 reception when it is ready to process more data.
171
172TTY_DO_WRITE_WAKEUP If set, causes the driver to call the ldisc's
173 write_wakeup() method in order to resume
174 transmission when it can accept more data
175 to transmit.
176
177TTY_IO_ERROR If set, causes all subsequent userspace read/write
178 calls on the tty to fail, returning -EIO.
179
180TTY_OTHER_CLOSED Device is a pty and the other side has closed.
181
182TTY_NO_WRITE_SPLIT Prevent driver from splitting up writes into
183 smaller chunks.
184
185
95Locking 186Locking
96 187
97Callers to the line discipline functions from the tty layer are required to 188Callers to the line discipline functions from the tty layer are required to
diff --git a/Documentation/usb/CREDITS b/Documentation/usb/CREDITS
index 01e7f857ef35..27a721635f92 100644
--- a/Documentation/usb/CREDITS
+++ b/Documentation/usb/CREDITS
@@ -21,7 +21,7 @@ difficult to maintain, add yourself with a patch if desired.
21 Bill Ryder <bryder@sgi.com> 21 Bill Ryder <bryder@sgi.com>
22 Thomas Sailer <sailer@ife.ee.ethz.ch> 22 Thomas Sailer <sailer@ife.ee.ethz.ch>
23 Gregory P. Smith <greg@electricrain.com> 23 Gregory P. Smith <greg@electricrain.com>
24 Linus Torvalds <torvalds@osdl.org> 24 Linus Torvalds <torvalds@linux-foundation.org>
25 Roman Weissgaerber <weissg@vienna.at> 25 Roman Weissgaerber <weissg@vienna.at>
26 <Kazuki.Yasumatsu@fujixerox.co.jp> 26 <Kazuki.Yasumatsu@fujixerox.co.jp>
27 27
diff --git a/Documentation/usb/acm.txt b/Documentation/usb/acm.txt
index 737d6104c3f3..17f5c2e1a570 100644
--- a/Documentation/usb/acm.txt
+++ b/Documentation/usb/acm.txt
@@ -46,6 +46,10 @@ Abstract Control Model (USB CDC ACM) specification.
46 46
47 3Com USR ISDN Pro TA 47 3Com USR ISDN Pro TA
48 48
49 Some cell phones also connect via USB. I know the following phones work:
50
51 SonyEricsson K800i
52
49 Unfortunately many modems and most ISDN TAs use proprietary interfaces and 53 Unfortunately many modems and most ISDN TAs use proprietary interfaces and
50thus won't work with this drivers. Check for ACM compliance before buying. 54thus won't work with this drivers. Check for ACM compliance before buying.
51 55
diff --git a/Documentation/x86_64/boot-options.txt b/Documentation/x86_64/boot-options.txt
index dbdcaf68e3ea..5c86ed6f0448 100644
--- a/Documentation/x86_64/boot-options.txt
+++ b/Documentation/x86_64/boot-options.txt
@@ -52,6 +52,10 @@ APICs
52 apicmaintimer. Useful when your PIT timer is totally 52 apicmaintimer. Useful when your PIT timer is totally
53 broken. 53 broken.
54 54
55 disable_8254_timer / enable_8254_timer
56 Enable interrupt 0 timer routing over the 8254 in addition to over
57 the IO-APIC. The kernel tries to set a sensible default.
58
55Early Console 59Early Console
56 60
57 syntax: earlyprintk=vga 61 syntax: earlyprintk=vga