diff options
Diffstat (limited to 'Documentation')
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 | |||
682 | NULL or the ERR_PTR mechanism to report failure. | 682 | NULL or the ERR_PTR mechanism to report failure. |
683 | 683 | ||
684 | 684 | ||
685 | Chapter 17: Don't re-invent the kernel macros | ||
686 | |||
687 | The header file include/linux/kernel.h contains a number of macros that | ||
688 | you should use, rather than explicitly coding some variant of them yourself. | ||
689 | For example, if you need to calculate the length of an array, take advantage | ||
690 | of the macro | ||
691 | |||
692 | #define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0])) | ||
693 | |||
694 | Similarly, if you need to calculate the size of some structure member, use | ||
695 | |||
696 | #define FIELD_SIZEOF(t, f) (sizeof(((t*)0)->f)) | ||
697 | |||
698 | There are also min() and max() macros that do strict type checking if you | ||
699 | need them. Feel free to peruse that header file to see what else is already | ||
700 | defined 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 |
56 | KERNELDOC = scripts/kernel-doc | 56 | KERNELDOC = $(srctree)/scripts/kernel-doc |
57 | DOCPROC = scripts/basic/docproc | 57 | DOCPROC = $(objtree)/scripts/basic/docproc |
58 | 58 | ||
59 | XMLTOFLAGS = -m $(srctree)/Documentation/DocBook/stylesheet.xsl | 59 | XMLTOFLAGS = -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; | |||
303 | do { | 303 | do { |
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); |
309 | desc-status &= ~running; | 309 | desc->status &= ~running; |
310 | desc->chip->end(); | 310 | desc->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 & 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 | |||
76 | 22: 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 | ||
136 | Linus Torvalds is the final arbiter of all changes accepted into the | 136 | Linus Torvalds is the final arbiter of all changes accepted into the |
137 | Linux kernel. His e-mail address is <torvalds@osdl.org>. He gets | 137 | Linux kernel. His e-mail address is <torvalds@linux-foundation.org>. |
138 | a lot of e-mail, so typically you should do your best to -avoid- sending | 138 | He gets a lot of e-mail, so typically you should do your best to -avoid- |
139 | him e-mail. | 139 | sending him e-mail. |
140 | 140 | ||
141 | Patches which are bug fixes, are "obvious" changes, or similarly | 141 | Patches which are bug fixes, are "obvious" changes, or similarly |
142 | require little discussion should be sent or CC'd to Linus. Patches | 142 | require 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 | ||
80 | Adding New Machines | 89 | Adding 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 | ||
119 | Watchdog | 132 | Watchdog |
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 | ||
134 | Serial | 147 | Serial |
@@ -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 | ||
184 | SPI | ||
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 | |||
192 | LEDs | ||
193 | ---- | ||
194 | |||
195 | There is support for GPIO based LEDs via a platform driver | ||
196 | in the LED subsystem. | ||
197 | |||
198 | |||
171 | Platform Data | 199 | Platform 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 | ||
949 | elevator_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 | |||
949 | elevator_dispatch_fn fills the dispatch queue with ready requests. | 956 | elevator_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 | ||
229 | What: i2c_adapter.dev | ||
230 | i2c_adapter.list | ||
231 | When: July 2007 | ||
232 | Why: 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.) | ||
241 | Who: Jean Delvare <khali@linux-fr.org>, | ||
242 | David Brownell <dbrownell@users.sourceforge.net> | ||
243 | |||
244 | --------------------------- | ||
245 | |||
229 | What: IPv4 only connection tracking/NAT/helpers | 246 | What: IPv4 only connection tracking/NAT/helpers |
230 | When: 2.6.22 | 247 | When: 2.6.22 |
231 | Why: The new layer 3 independant connection tracking replaces the old | 248 | Why: 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 | ||
278 | What: ACPI hotkey driver (CONFIG_ACPI_HOTKEY) | ||
279 | When: 2.6.21 | ||
280 | Why: 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 | |||
296 | Who: Len Brown <len.brown@intel.com> | ||
297 | |||
298 | --------------------------- | ||
299 | |||
300 | What: /sys/firmware/acpi/namespace | ||
301 | When: 2.6.21 | ||
302 | Why: 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 | ||
310 | Who: Len Brown <len.brown@intel.com> | ||
311 | |||
312 | --------------------------- | ||
313 | |||
260 | What: ACPI procfs interface | 314 | What: ACPI procfs interface |
261 | When: July 2007 | 315 | When: July 2007 |
262 | Why: After ACPI sysfs conversion, ACPI attributes will be duplicated | 316 | Why: 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 | ||
322 | What: /proc/acpi/button | ||
323 | When: August 2007 | ||
324 | Why: /proc/acpi/button has been replaced by events to the input layer | ||
325 | since 2.6.20. | ||
326 | Who: Len Brown <len.brown@intel.com> | ||
327 | |||
328 | --------------------------- | ||
329 | |||
330 | What: JFFS (version 1) | ||
331 | When: 2.6.21 | ||
332 | Why: Unmaintained for years, superceded by JFFS2 for years. | ||
333 | Who: 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 | |||
73 | RESOURCES | 73 | RESOURCES |
74 | ========= | 74 | ========= |
75 | 75 | ||
76 | The Linux version of the 9p server is now maintained under the npfs project | 76 | Our current recommendation is to use Inferno (http://www.vitanuova.com/inferno) |
77 | on sourceforge (http://sourceforge.net/projects/npfs). | 77 | as the 9p server. You can start a 9p server under Inferno by issuing the |
78 | following command: | ||
79 | ; styxlisten -A tcp!*!564 export '#U*' | ||
80 | |||
81 | The -A specifies an unauthenticated export. The 564 is the port # (you may | ||
82 | have to choose a higher port number if running as a normal user). The '#U*' | ||
83 | specifies exporting the root of the Linux name space. You may specify a | ||
84 | subset of the namespace by extending the path: '#U*'/tmp would just export | ||
85 | /tmp. For more information, see the Inferno manual pages covering styxlisten | ||
86 | and export. | ||
87 | |||
88 | A Linux version of the 9p server is now maintained under the npfs project | ||
89 | on sourceforge (http://sourceforge.net/projects/npfs). There is also a | ||
90 | more stable single-threaded version of the server (named spfs) available from | ||
91 | the same CVS repository. | ||
78 | 92 | ||
79 | There are user and developer mailing lists available through the v9fs project | 93 | There are user and developer mailing lists available through the v9fs project |
80 | on sourceforge (http://sourceforge.net/projects/v9fs). | 94 | on sourceforge (http://sourceforge.net/projects/v9fs). |
@@ -96,5 +110,5 @@ STATUS | |||
96 | 110 | ||
97 | The 2.6 kernel support is working on PPC and x86. | 111 | The 2.6 kernel support is working on PPC and x86. |
98 | 112 | ||
99 | PLEASE USE THE SOURCEFORGE BUG-TRACKER TO REPORT PROBLEMS. | 113 | PLEASE 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 | ||
175 | locking rules: | 176 | locking rules: |
176 | All except set_page_dirty may block | 177 | All except set_page_dirty may block |
@@ -188,6 +189,7 @@ bmap: yes | |||
188 | invalidatepage: no yes | 189 | invalidatepage: no yes |
189 | releasepage: no yes | 190 | releasepage: no yes |
190 | direct_IO: no | 191 | direct_IO: no |
192 | launder_page: no yes | ||
191 | 193 | ||
192 | ->prepare_write(), ->commit_write(), ->sync_page() and ->readpage() | 194 | ->prepare_write(), ->commit_write(), ->sync_page() and ->readpage() |
193 | may be called from the request handler (/dev/loop). | 195 | may 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 | |||
281 | indicate that the buffers are (or may be) freeable. If ->releasepage is zero, | 283 | indicate that the buffers are (or may be) freeable. If ->releasepage is zero, |
282 | the kernel assumes that the fs has no private interest in the buffers. | 284 | the 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 | ||
287 | it is still found to be dirty. It returns zero if the page was successfully | ||
288 | cleaned, or an error value if not. Note that in order to prevent the page | ||
289 | getting mapped back in and redirtied, it needs to be kept locked | ||
290 | across 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 |
285 | using BKL for internal serialization and that's one of the worst sources | 293 | using BKL for internal serialization and that's one of the worst sources |
286 | of contention. Normally they are calling library functions (in fs/buffer.c) | 294 | of 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 | ||
458 | Note, a technical ChangeLog aimed at kernel hackers is in fs/ntfs/ChangeLog. | 458 | Note, a technical ChangeLog aimed at kernel hackers is in fs/ntfs/ChangeLog. |
459 | 459 | ||
460 | 2.1.28: | ||
461 | - Fix a deadlock. | ||
460 | 2.1.27: | 462 | 2.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 | ||
7 | On the i386 platform, the Linux kernel uses a rather complicated boot | 7 | On the i386 platform, the Linux kernel uses a rather complicated boot |
8 | convention. This has evolved partially due to historical aspects, as | 8 | convention. 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 | ||
399 | Most ThinkPads include six or more separate temperature sensors but | 399 | Most ThinkPads include six or more separate temperature sensors but |
400 | only expose the CPU temperature through the standard ACPI methods. | 400 | only expose the CPU temperature through the standard ACPI methods. |
401 | This feature shows readings from up to eight different sensors. Some | 401 | This feature shows readings from up to eight different sensors on older |
402 | readings may not be valid, e.g. may show large negative values. For | 402 | ThinkPads, and it has experimental support for up to sixteen different |
403 | example, on the X40, a typical output may be: | 403 | sensors on newer ThinkPads. Readings from sensors that are not available |
404 | return -128. | ||
404 | 405 | ||
406 | No commands can be written to this file. | ||
407 | |||
408 | EXPERIMENTAL: The 16-sensors feature is marked EXPERIMENTAL because the | ||
409 | implementation directly accesses hardware registers and may not work as | ||
410 | expected. USE WITH CAUTION! To use this feature, you need to supply the | ||
411 | experimental=1 parameter when loading the module. When EXPERIMENTAL | ||
412 | mode is enabled, reading the first 8 sensors on newer ThinkPads will | ||
413 | also use an new experimental thermal sensor access mode. | ||
414 | |||
415 | For example, on the X40, a typical output may be: | ||
405 | temperatures: 42 42 45 41 36 -128 33 -128 | 416 | temperatures: 42 42 45 41 36 -128 33 -128 |
406 | 417 | ||
407 | Thomas Gruber took his R51 apart and traced all six active sensors in | 418 | EXPERIMENTAL: On the T43/p, a typical output may be: |
408 | his laptop (the location of sensors may vary on other models): | 419 | temperatures: 48 48 36 52 38 -128 31 -128 48 52 48 -128 -128 -128 -128 -128 |
420 | |||
421 | The mapping of thermal sensors to physical locations varies depending on | ||
422 | system-board model (and thus, on ThinkPad model). | ||
423 | |||
424 | http://thinkwiki.org/wiki/Thermal_Sensors is a public wiki page that | ||
425 | tries to track down these locations for various models. | ||
426 | |||
427 | Most (newer?) models seem to follow this pattern: | ||
409 | 428 | ||
410 | 1: CPU | 429 | 1: CPU |
411 | 2: Mini PCI Module | 430 | 2: (depends on model) |
412 | 3: HDD | 431 | 3: (depends on model) |
413 | 4: GPU | 432 | 4: GPU |
414 | 5: Battery | 433 | 5: Main battery: main sensor |
415 | 6: N/A | 434 | 6: Bay battery: main sensor |
416 | 7: Battery | 435 | 7: Main battery: secondary sensor |
417 | 8: N/A | 436 | 8: Bay battery: secondary sensor |
437 | 9-15: (depends on model) | ||
438 | |||
439 | For the R51 (source: Thomas Gruber): | ||
440 | 2: Mini-PCI | ||
441 | 3: Internal HDD | ||
442 | |||
443 | For the T43, T43/p (source: Shmidoax/Thinkwiki.org) | ||
444 | http://thinkwiki.org/wiki/Thermal_Sensors#ThinkPad_T43.2C_T43p | ||
445 | 2: System board, left side (near PCMCIA slot), reported as HDAPS temp | ||
446 | 3: PCMCIA slot | ||
447 | 9: MCH (northbridge) to DRAM Bus | ||
448 | 10: ICH (southbridge), under Mini-PCI card, under touchpad | ||
449 | 11: Power regulator, underside of system board, below F2 key | ||
450 | |||
451 | The A31 has a very atypical layout for the thermal sensors | ||
452 | (source: Milos Popovic, http://thinkwiki.org/wiki/Thermal_Sensors#ThinkPad_A31) | ||
453 | 1: CPU | ||
454 | 2: Main Battery: main sensor | ||
455 | 3: Power Converter | ||
456 | 4: Bay Battery: main sensor | ||
457 | 5: MCH (northbridge) | ||
458 | 6: PCMCIA/ambient | ||
459 | 7: Main Battery: secondary sensor | ||
460 | 8: Bay Battery: secondary sensor | ||
418 | 461 | ||
419 | No commands can be written to this file. | ||
420 | 462 | ||
421 | EXPERIMENTAL: Embedded controller register dump -- /proc/acpi/ibm/ecdump | 463 | EXPERIMENTAL: 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 | |||
529 | WITH CAUTION! To use this feature, you need to supply the | 571 | WITH CAUTION! To use this feature, you need to supply the |
530 | experimental=1 parameter when loading the module. | 572 | experimental=1 parameter when loading the module. |
531 | 573 | ||
532 | This feature attempts to show the current fan speed. The speed is read | 574 | This feature attempts to show the current fan speed, control mode and |
533 | directly from the hardware registers of the embedded controller. This | 575 | other fan data that might be available. The speed is read directly |
534 | is known to work on later R, T and X series ThinkPads but may show a | 576 | from the hardware registers of the embedded controller. This is known |
535 | bogus value on other models. | 577 | to work on later R, T and X series ThinkPads but may show a bogus |
578 | value on other models. | ||
579 | |||
580 | Most ThinkPad fans work in "levels". Level 0 stops the fan. The higher | ||
581 | the level, the higher the fan speed, although adjacent levels often map | ||
582 | to the same fan speed. 7 is the highest level, where the fan reaches | ||
583 | the maximum recommended speed. Level "auto" means the EC changes the | ||
584 | fan level according to some internal algorithm, usually based on | ||
585 | readings from the thermal sensors. Level "disengaged" means the EC | ||
586 | disables the speed-locked closed-loop fan control, and drives the fan as | ||
587 | fast as it can go, which might exceed hardware limits, so use this level | ||
588 | with caution. | ||
589 | |||
590 | The fan usually ramps up or down slowly from one speed to another, | ||
591 | and it is normal for the EC to take several seconds to react to fan | ||
592 | commands. | ||
536 | 593 | ||
537 | The fan may be enabled or disabled with the following commands: | 594 | The 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 | ||
599 | Placing a fan on level 0 is the same as disabling it. Enabling a fan | ||
600 | will try to place it in a safe level if it is too slow or disabled. | ||
601 | |||
542 | WARNING WARNING WARNING: do not leave the fan disabled unless you are | 602 | WARNING WARNING WARNING: do not leave the fan disabled unless you are |
543 | monitoring the temperature sensor readings and you are ready to enable | 603 | monitoring all of the temperature sensor readings and you are ready to |
544 | it if necessary to avoid overheating. | 604 | enable it if necessary to avoid overheating. |
545 | 605 | ||
546 | The fan only runs if it's enabled *and* the various temperature | 606 | An enabled fan in level "auto" may stop spinning if the EC decides the |
547 | sensors which control it read high enough. On the X40, this seems to | 607 | ThinkPad is cool enough and doesn't need the extra airflow. This is |
548 | depend on the CPU and HDD temperatures. Specifically, the fan is | 608 | normal, and the EC will spin the fan up if the varios thermal readings |
549 | turned on when either the CPU temperature climbs to 56 degrees or the | 609 | rise too much. |
550 | HDD temperature climbs to 46 degrees. The fan is turned off when the | 610 | |
551 | CPU temperature drops to 49 degrees and the HDD temperature drops to | 611 | On the X40, this seems to depend on the CPU and HDD temperatures. |
552 | 41 degrees. These thresholds cannot currently be controlled. | 612 | Specifically, the fan is turned on when either the CPU temperature |
613 | climbs to 56 degrees or the HDD temperature climbs to 46 degrees. The | ||
614 | fan is turned off when the CPU temperature drops to 49 degrees and the | ||
615 | HDD temperature drops to 41 degrees. These thresholds cannot | ||
616 | currently be controlled. | ||
617 | |||
618 | The fan level can be controlled with the command: | ||
619 | |||
620 | echo 'level <level>' > /proc/acpi/ibm/thermal | ||
621 | |||
622 | Where <level> is an integer from 0 to 7, or one of the words "auto" | ||
623 | or "disengaged" (without the quotes). Not all ThinkPads support the | ||
624 | "auto" and "disengaged" levels. | ||
553 | 625 | ||
554 | On the X31 and X40 (and ONLY on those models), the fan speed can be | 626 | On the X31 and X40 (and ONLY on those models), the fan speed can be |
555 | controlled to a certain degree. Once the fan is running, it can be | 627 | controlled 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 | |||
562 | any effect or the fan speed eventually settles somewhere in that | 634 | any effect or the fan speed eventually settles somewhere in that |
563 | range. The fan cannot be stopped or started with this command. | 635 | range. The fan cannot be stopped or started with this command. |
564 | 636 | ||
565 | On the 570, temperature readings are not available through this | 637 | The ThinkPad's ACPI DSDT code will reprogram the fan on its own when |
566 | feature and the fan control works a little differently. The fan speed | 638 | certain conditions are met. It will override any fan programming done |
567 | is reported in levels from 0 (off) to 7 (max) and can be controlled | 639 | through ibm-acpi. |
568 | with the following command: | ||
569 | |||
570 | echo 'level <level>' > /proc/acpi/ibm/thermal | ||
571 | 640 | ||
572 | EXPERIMENTAL: WAN -- /proc/acpi/ibm/wan | 641 | EXPERIMENTAL: 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 | ||
673 | The ibm-acpi kernel driver can be programmed to revert the fan level | ||
674 | to a safe setting if userspace does not issue one of the fan commands: | ||
675 | "enable", "disable", "level" or "watchdog" within a configurable | ||
676 | ammount of time. To do this, use the "watchdog" command. | ||
677 | |||
678 | echo 'watchdog <interval>' > /proc/acpi/ibm/fan | ||
679 | |||
680 | Interval is the ammount of time in seconds to wait for one of the | ||
681 | above mentioned fan commands before reseting the fan level to a safe | ||
682 | one. If set to zero, the watchdog is disabled (default). When the | ||
683 | watchdog timer runs out, it does the exact equivalent of the "enable" | ||
684 | fan command. | ||
685 | |||
686 | Note that the watchdog timer stops after it enables the fan. It will | ||
687 | be rearmed again automatically (using the same interval) when one of | ||
688 | the above mentioned fan commands is received. The fan watchdog is, | ||
689 | therefore, not suitable to protect against fan mode changes made | ||
690 | through means other than the "enable", "disable", and "level" fan | ||
691 | commands. | ||
692 | |||
604 | 693 | ||
605 | Example Configuration | 694 | Example 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 | |||
17 | memory image to a dump file on the local disk, or across the network to | 17 | memory image to a dump file on the local disk, or across the network to |
18 | a remote system. | 18 | a remote system. |
19 | 19 | ||
20 | Kdump and kexec are currently supported on the x86, x86_64, and ppc64 | 20 | Kdump and kexec are currently supported on the x86, x86_64, ppc64 and ia64 |
21 | architectures. | 21 | architectures. |
22 | 22 | ||
23 | When the system kernel boots, it reserves a small section of memory for | 23 | When the system kernel boots, it reserves a small section of memory for |
@@ -54,59 +54,69 @@ memory," in two ways: | |||
54 | Setup and Installation | 54 | Setup and Installation |
55 | ====================== | 55 | ====================== |
56 | 56 | ||
57 | Install kexec-tools and the Kdump patch | 57 | Install kexec-tools |
58 | --------------------------------------- | 58 | ------------------- |
59 | 59 | ||
60 | 1) Login as the root user. | 60 | 1) Login as the root user. |
61 | 61 | ||
62 | 2) Download the kexec-tools user-space package from the following URL: | 62 | 2) 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 | 64 | http://www.kernel.org/pub/linux/kernel/people/horms/kexec-tools/kexec-tools-testing.tar.gz |
65 | 65 | ||
66 | 3) Unpack the tarball with the tar command, as follows: | 66 | This is a symlink to the latest version, which at the time of writing is |
67 | 67 | 20061214, the only release of kexec-tools-testing so far. As other versions | |
68 | tar xvpzf kexec-tools-1.101.tar.gz | 68 | are made released, the older onese will remain available at |
69 | 69 | http://www.kernel.org/pub/linux/kernel/people/horms/kexec-tools/ | |
70 | 4) Download the latest consolidated Kdump patch from the following URL: | ||
71 | 70 | ||
72 | http://lse.sourceforge.net/kdump/ | 71 | Note: Latest kexec-tools-testing git tree is available at |
73 | 72 | ||
74 | (This location is being used until all the user-space Kdump patches | 73 | git://git.kernel.org/pub/scm/linux/kernel/git/horms/kexec-tools-testing.git |
75 | are integrated with the kexec-tools package.) | 74 | or |
75 | http://www.kernel.org/git/?p=linux/kernel/git/horms/kexec-tools-testing.git;a=summary | ||
76 | 76 | ||
77 | 5) Change to the kexec-tools-1.101 directory, as follows: | 77 | 3) 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 | ||
81 | 6) Apply the consolidated patch to the kexec-tools-1.101 source tree | 81 | 4) 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 | ||
87 | 7) Configure the package, as follows: | 85 | 5) Configure the package, as follows: |
88 | 86 | ||
89 | ./configure | 87 | ./configure |
90 | 88 | ||
91 | 8) Compile the package, as follows: | 89 | 6) Compile the package, as follows: |
92 | 90 | ||
93 | make | 91 | make |
94 | 92 | ||
95 | 9) Install the package, as follows: | 93 | 7) Install the package, as follows: |
96 | 94 | ||
97 | make install | 95 | make install |
98 | 96 | ||
99 | 97 | ||
100 | Download and build the system and dump-capture kernels | 98 | Build the system and dump-capture kernels |
101 | ------------------------------------------------------ | 99 | ----------------------------------------- |
100 | There are two possible methods of using Kdump. | ||
101 | |||
102 | 1) Build a separate custom dump-capture kernel for capturing the | ||
103 | kernel core dump. | ||
102 | 104 | ||
103 | Download the mainline (vanilla) kernel source code (2.6.13-rc1 or newer) | 105 | 2) Or use the system kernel binary itself as dump-capture kernel and there is |
104 | from 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 |
105 | and a dump-capture kernel. Use the following steps to configure these | 107 | only with the architecutres which support a relocatable kernel. As |
106 | kernels with the necessary kexec and Kdump features: | 108 | of today i386 and ia64 architectures support relocatable kernel. |
107 | 109 | ||
108 | System kernel | 110 | Building a relocatable kernel is advantageous from the point of view that |
109 | ------------- | 111 | one does not have to build a second kernel for capturing the dump. But |
112 | at the same time one might want to build a custom dump capture kernel | ||
113 | suitable to his needs. | ||
114 | |||
115 | Following are the configuration setting required for system and | ||
116 | dump-capture kernels for enabling kdump support. | ||
117 | |||
118 | System kernel config options | ||
119 | ---------------------------- | ||
110 | 120 | ||
111 | 1) Enable "kexec system call" in "Processor type and features." | 121 | 1) 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 | ||
135 | 4) Make and install the kernel and its modules. Update the boot loader | 145 | Dump-capture kernel config options (Arch Independent) |
136 | (such as grub, yaboot, or lilo) configuration files as necessary. | 146 | ----------------------------------------------------- |
137 | 147 | ||
138 | 5) Boot the system kernel with the boot parameter "crashkernel=Y@X", | 148 | 1) 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 | ||
149 | The dump-capture kernel | 153 | 2) Enable "/proc/vmcore support" under "Filesystems" -> "Pseudo filesystems". |
150 | ----------------------- | ||
151 | 154 | ||
152 | 1) 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 | ||
155 | 2) On x86, enable high memory support under "Processor type and | 158 | Dump-capture kernel config options (Arch Dependent, i386) |
159 | -------------------------------------------------------- | ||
160 | 1) 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 | ||
162 | 3) On x86 and x86_64, disable symmetric multi-processing support | 167 | 2) 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 | ||
170 | 4) On ppc64, disable NUMA support and enable EMBEDDED support: | 176 | 3) 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 | ||
176 | 5) Enable "kernel crash dumps" support under "Processor type and | 182 | 4) 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 | |||
199 | 5) 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 | 202 | Dump-capture kernel config options (Arch Dependent, x86_64) |
203 | ---------------------------------------------------------- | ||
204 | 1) On x86 and x86_64, disable symmetric multi-processing support | ||
205 | under "Processor type and features": | ||
180 | 206 | ||
181 | 6) 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 | |||
213 | 2) 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 | 221 | 3) 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 | ||
192 | 6) Optionally enable "/proc/vmcore support" under "Filesystems" -> | 224 | Dump-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 | |||
198 | 7) 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 | ||
230 | Dump-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 | |||
251 | Boot into System Kernel | ||
252 | ======================= | ||
253 | |||
254 | 1) Make and install the kernel and its modules. Update the boot loader | ||
255 | (such as grub, yaboot, or lilo) configuration files as necessary. | ||
256 | |||
257 | 2) 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 | ||
202 | Load the Dump-capture Kernel | 271 | Load the Dump-capture Kernel |
203 | ============================ | 272 | ============================ |
204 | 273 | ||
205 | After booting to the system kernel, load the dump-capture kernel using | 274 | After booting to the system kernel, dump-capture kernel needs to be |
206 | the following command: | 275 | loaded. |
276 | |||
277 | Based on the architecture and type of image (relocatable or not), one | ||
278 | can choose to load the uncompressed vmlinux or compressed bzImage/vmlinuz | ||
279 | of dump-capture kernel. Following is the summary. | ||
280 | |||
281 | For i386: | ||
282 | - Use vmlinux if kernel is not relocatable. | ||
283 | - Use bzImage/vmlinuz if kernel is relocatable. | ||
284 | For x86_64: | ||
285 | - Use vmlinux | ||
286 | For ppc64: | ||
287 | - Use vmlinux | ||
288 | For ia64: | ||
289 | - Use vmlinux or vmlinuz.gz | ||
290 | |||
207 | 291 | ||
208 | kexec -p <dump-capture-kernel> \ | 292 | If you are using a uncompressed vmlinux image then use following command |
293 | to 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 | ||
299 | If you are using a compressed bzImage/vmlinuz, then use following command | ||
300 | to load dump-capture kernel. | ||
212 | 301 | ||
213 | Notes 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 | |||
306 | Please note, that --args-linux does not need to be specified for ia64. | ||
307 | It is planned to make this a no-op on that architecture, but for now | ||
308 | it should be omitted | ||
309 | |||
310 | Following are the arch specific command line options to be used while | ||
311 | loading dump-capture kernel. | ||
214 | 312 | ||
215 | * <dump-capture-kernel> must be a vmlinux image (that is, an | 313 | For i386, x86_64 and ia64: |
216 | uncompressed ELF image). bzImage does not work at this time. | 314 | "init 1 irqpoll maxcpus=1" |
315 | |||
316 | For ppc64: | ||
317 | "init 1 maxcpus=1 noirqdistrib" | ||
318 | |||
319 | |||
320 | Notes 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 | ||
235 | Kernel Panic | 342 | Kernel 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 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
6 | The world of PCI is vast and it's full of (mostly unpleasant) surprises. | 8 | The world of PCI is vast and full of (mostly unpleasant) surprises. |
7 | Different PCI devices have different requirements and different bugs -- | 9 | Since each CPU architecture implements different chip-sets and PCI devices |
8 | because of this, the PCI support layer in Linux kernel is not as trivial | 10 | have different requirements (erm, "features"), the result is the PCI support |
9 | as one would wish. This short pamphlet tries to help all potential driver | 11 | in the Linux kernel is not as trivial as one would wish. This short paper |
10 | authors find their way through the deep forests of PCI handling. | 12 | tries to introduce all potential driver authors to Linux APIs for |
13 | PCI device drivers. | ||
14 | |||
15 | A more complete resource is the third edition of "Linux Device Drivers" | ||
16 | by Jonathan Corbet, Alessandro Rubini, and Greg Kroah-Hartman. | ||
17 | LDD3 is available for free (under Creative Commons License) from: | ||
18 | |||
19 | http://lwn.net/Kernel/LDD3/ | ||
20 | |||
21 | However, keep in mind that all documents are subject to "bit rot". | ||
22 | Refer to the source code if things are not working as described here. | ||
23 | |||
24 | Please 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 | ||
13 | 0. Structure of PCI drivers | 29 | 0. Structure of PCI drivers |
14 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 30 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
15 | There exist two kinds of PCI drivers: new-style ones (which leave most of | 31 | PCI drivers "discover" PCI devices in a system via pci_register_driver(). |
16 | probing for devices to the PCI layer and support online insertion and removal | 32 | Actually, it's the other way around. When the PCI generic code discovers |
17 | of devices [thus supporting PCI, hot-pluggable PCI and CardBus in a single | 33 | a new device, the driver with a matching "description" will be notified. |
18 | driver]) and old-style ones which just do all the probing themselves. Unless | 34 | Details on this below. |
19 | you have a very good reason to do so, please don't use the old way of probing | 35 | |
20 | in any new code. After the driver finds the devices it wishes to operate | 36 | pci_register_driver() leaves most of the probing for devices to |
21 | on (either the old or the new way), it needs to perform the following steps: | 37 | the PCI layer and supports online insertion/removal of devices [thus |
38 | supporting hot-pluggable PCI, CardBus, and Express-Card in a single driver]. | ||
39 | pci_register_driver() call requires passing in a table of function | ||
40 | pointers and thus dictates the high level structure of a driver. | ||
41 | |||
42 | Once the driver knows about a PCI device and takes ownership, the | ||
43 | driver 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 | |||
54 | When done using the device, and perhaps the module needs to be unloaded, | ||
55 | the 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 | ||
30 | Most of these topics are covered by the following sections, for the rest | 64 | Most of these topics are covered in the following sections. |
31 | look at <linux/pci.h>, it's hopefully well commented. | 65 | For the rest look at LDD3 or <linux/pci.h> . |
32 | 66 | ||
33 | If the PCI subsystem is not configured (CONFIG_PCI is not set), most of | 67 | If the PCI subsystem is not configured (CONFIG_PCI is not set), most of |
34 | the functions described below are defined as inline functions either completely | 68 | the PCI functions described below are defined as inline functions either |
35 | empty or just returning an appropriate error codes to avoid lots of ifdefs | 69 | completely empty or just returning an appropriate error codes to avoid |
36 | in the drivers. | 70 | lots of ifdefs in the drivers. |
71 | |||
37 | 72 | ||
38 | 73 | ||
39 | 1. New-style drivers | 74 | 1. pci_register_driver() call |
40 | ~~~~~~~~~~~~~~~~~~~~ | 75 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
41 | The new-style drivers just call pci_register_driver during their initialization | ||
42 | with a pointer to a structure describing the driver (struct pci_driver) which | ||
43 | contains: | ||
44 | 76 | ||
45 | name Name of the driver | 77 | PCI device drivers call pci_register_driver() during their |
78 | initialization 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 | ||
75 | The ID table is an array of struct pci_device_id ending with a all-zero entry. | 132 | The ID table is an array of struct pci_device_id entries ending with an |
76 | Each entry consists of: | 133 | all-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 | ||
85 | Most drivers don't need to use the driver_data field. Best practice | ||
86 | for use of driver_data is to use it as an index into a static list of | ||
87 | equivalent device types, not to use it as a pointer. | ||
88 | 155 | ||
89 | Have a table entry {PCI_ANY_ID, PCI_ANY_ID, PCI_ANY_ID, PCI_ANY_ID} | 156 | Most drivers only need PCI_DEVICE() or PCI_DEVICE_CLASS() to set up |
90 | to have probe() called for every PCI device known to the system. | 157 | a pci_device_id table. |
91 | 158 | ||
92 | New PCI IDs may be added to a device driver at runtime by writing | 159 | New PCI IDs may be added to a device driver pci_ids table at runtime |
93 | to the file /sys/bus/pci/drivers/{driver}/new_id. When added, the | 160 | as shown below: |
94 | driver will probe for all devices it can support. | ||
95 | 161 | ||
96 | echo "vendor device subvendor subdevice class class_mask driver_data" > \ | 162 | echo "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 |
98 | where all fields are passed in as hexadecimal values (no leading 0x). | 164 | |
99 | Users need pass only as many fields as necessary; vendor, device, | 165 | All fields are passed in as hexadecimal values (no leading 0x). |
100 | subvendor, and subdevice fields default to PCI_ANY_ID (FFFFFFFF), | 166 | Users need pass only as many fields as necessary: |
101 | class and classmask fields default to 0, and driver_data defaults to | 167 | o vendor, device, subvendor, and subdevice fields default |
102 | 0UL. Device drivers must initialize use_driver_data in the dynids struct | 168 | to PCI_ANY_ID (FFFFFFFF), |
103 | in their pci_driver struct prior to calling pci_register_driver in order | 169 | o class and classmask fields default to 0 |
104 | for the driver_data field to get passed to the driver. Otherwise, only a | 170 | o driver_data defaults to 0UL. |
105 | 0 is passed in that field. | 171 | |
172 | Once added, the driver probe routine will be invoked for any unclaimed | ||
173 | PCI devices listed in its (newly updated) pci_ids list. | ||
106 | 174 | ||
107 | When the driver exits, it just calls pci_unregister_driver() and the PCI layer | 175 | When the driver exits, it just calls pci_unregister_driver() and the PCI layer |
108 | automatically calls the remove hook for all devices handled by the driver. | 176 | automatically calls the remove hook for all devices handled by the driver. |
109 | 177 | ||
178 | |||
179 | 1.1 "Attributes" for driver functions/data | ||
180 | |||
110 | Please mark the initialization and cleanup functions where appropriate | 181 | Please 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 | ||
121 | Tips: | 194 | Tips 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 | ||
136 | 2. 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 |
138 | PCI drivers not using the pci_register_driver() interface search | 205 | exclusively called by the probe() routine, can be marked __devinit. |
139 | for 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 | |||
219 | 2. How to find PCI devices manually | ||
220 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
221 | |||
222 | PCI drivers should have a really good reason for not using the | ||
223 | pci_register_driver() interface to search for PCI devices. | ||
224 | The main reason PCI devices are controlled by multiple drivers | ||
225 | is because one PCI device implements several different HW services. | ||
226 | E.g. combined serial/parallel port/floppy controller. | ||
227 | |||
228 | A manual search may be performed using the following constructs: | ||
140 | 229 | ||
141 | Searching by vendor and device ID: | 230 | Searching by vendor and device ID: |
142 | 231 | ||
@@ -150,87 +239,311 @@ Searching by class ID (iterate in a similar way): | |||
150 | 239 | ||
151 | Searching by both vendor/device and subsystem vendor/device ID: | 240 | Searching 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 | 244 | You can use the constant PCI_ANY_ID as a wildcard replacement for |
156 | VENDOR_ID or DEVICE_ID. This allows searching for any device from a | 245 | VENDOR_ID or DEVICE_ID. This allows searching for any device from a |
157 | specific vendor, for example. | 246 | specific vendor, for example. |
158 | 247 | ||
159 | These functions are hotplug-safe. They increment the reference count on | 248 | These functions are hotplug-safe. They increment the reference count on |
160 | the pci_dev that they return. You must eventually (possibly at module unload) | 249 | the pci_dev that they return. You must eventually (possibly at module unload) |
161 | decrement the reference count on these devices by calling pci_dev_put(). | 250 | decrement the reference count on these devices by calling pci_dev_put(). |
162 | 251 | ||
163 | 252 | ||
164 | 3. Enabling and disabling devices | ||
165 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
166 | Before you do anything with the device you've found, you need to enable | ||
167 | it by calling pci_enable_device() which enables I/O and memory regions of | ||
168 | the device, allocates an IRQ if necessary, assigns missing resources if | ||
169 | needed and wakes up the device if it was in suspended state. Please note | ||
170 | that this function can fail. | ||
171 | 253 | ||
172 | If you want to use the device in bus mastering mode, call pci_set_master() | 254 | 3. Device Initialization Steps |
173 | which enables the bus master bit in PCI_COMMAND register and also fixes | 255 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
174 | the latency timer value if it's set to something bogus by the BIOS. | 256 | |
257 | As noted in the introduction, most PCI drivers need the following steps | ||
258 | for 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 | |||
269 | The driver can access PCI config space registers at any time. | ||
270 | (Well, almost. When running BIST, config space can go away...but | ||
271 | that will just result in a PCI Bus Master Abort and config reads | ||
272 | will return garbage). | ||
273 | |||
274 | |||
275 | 3.1 Enable the PCI device | ||
276 | ~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
277 | Before touching any device registers, the driver needs to enable | ||
278 | the 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 | |||
283 | NOTE: pci_enable_device() can fail! Check the return value. | ||
284 | NOTE2: 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 | |||
298 | pci_set_master() will enable DMA by setting the bus master bit | ||
299 | in the PCI_COMMAND register. It also fixes the latency timer value if | ||
300 | it's set to something bogus by the BIOS. | ||
301 | |||
302 | If the PCI device can use the PCI Memory-Write-Invalidate transaction, | ||
177 | call pci_set_mwi(). This enables the PCI_COMMAND bit for Mem-Wr-Inval | 303 | call pci_set_mwi(). This enables the PCI_COMMAND bit for Mem-Wr-Inval |
178 | and also ensures that the cache line size register is set correctly. | 304 | and also ensures that the cache line size register is set correctly. |
179 | Make sure to check the return value of pci_set_mwi(), not all architectures | 305 | Check the return value of pci_set_mwi() as not all architectures |
180 | may support Memory-Write-Invalidate. | 306 | or chip-sets may support Memory-Write-Invalidate. |
307 | |||
308 | |||
309 | 3.2 Request MMIO/IOP resources | ||
310 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
311 | Memory (MMIO), and I/O port addresses should NOT be read directly | ||
312 | from the PCI device config space. Use the values in the pci_dev structure | ||
313 | as the PCI "bus address" might have been remapped to a "host physical" | ||
314 | address 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 | 316 | See Documentation/IO-mapping.txt for how to access device registers |
183 | error while setting it up or the driver module is being unloaded), it | 317 | or device memory. |
184 | should call pci_disable_device() to deallocate any IRQ resources, disable | 318 | |
185 | PCI bus-mastering, etc. You should not do anything with the device after | 319 | The device driver needs to call pci_request_region() to verify |
320 | no other device is already using the same address resource. | ||
321 | Conversely, drivers should call pci_release_region() AFTER | ||
186 | calling pci_disable_device(). | 322 | calling pci_disable_device(). |
323 | The 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 | |||
329 | Generic flavors of pci_request_region() are request_mem_region() | ||
330 | (for MMIO ranges) and request_region() (for IO Port ranges). | ||
331 | Use these for address resources that are not described by "normal" PCI | ||
332 | BARs. | ||
333 | |||
334 | Also see pci_request_selected_regions() below. | ||
335 | |||
336 | |||
337 | 3.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 | |||
344 | While all drivers should explicitly indicate the DMA capability | ||
345 | (e.g. 32 or 64 bit) of the PCI bus master, devices with more than | ||
346 | 32-bit bus master capability for streaming data need the driver | ||
347 | to "register" this capability by calling pci_set_dma_mask() with | ||
348 | appropriate parameters. In general this allows more efficient DMA | ||
349 | on systems where System RAM exists above 4G _physical_ address. | ||
350 | |||
351 | Drivers for all PCI-X and PCIe compliant devices must call | ||
352 | pci_set_dma_mask() as they are 64-bit DMA devices. | ||
353 | |||
354 | Similarly, drivers must also "register" this capability if the device | ||
355 | can directly address "consistent memory" in System RAM above 4G physical | ||
356 | address by calling pci_set_consistent_dma_mask(). | ||
357 | Again, this includes drivers for all PCI-X and PCIe compliant devices. | ||
358 | Many 64-bit "PCI" devices (before PCI-X) and some PCI-X devices are | ||
359 | 64-bit DMA capable for payload ("streaming") data but not control | ||
360 | ("consistent") data. | ||
361 | |||
362 | |||
363 | 3.4 Setup shared control data | ||
364 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
365 | Once the DMA masks are set, the driver can allocate "consistent" (a.k.a. shared) | ||
366 | memory. See Documentation/DMA-API.txt for a full description of | ||
367 | the DMA APIs. This section is just a reminder that it needs to be done | ||
368 | before enabling DMA on the device. | ||
369 | |||
370 | |||
371 | 3.5 Initialize device registers | ||
372 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
373 | Some drivers will need specific "capability" fields programmed | ||
374 | or other "vendor specific" register initialized or reset. | ||
375 | E.g. clearing pending interrupts. | ||
376 | |||
377 | |||
378 | 3.6 Register IRQ handler | ||
379 | ~~~~~~~~~~~~~~~~~~~~~~~~ | ||
380 | While calling request_irq() is the the last step described here, | ||
381 | this is often just another intermediate step to initialize a device. | ||
382 | This step can often be deferred until the device is opened for use. | ||
383 | |||
384 | All interrupt handlers for IRQ lines should be registered with IRQF_SHARED | ||
385 | and use the devid to map IRQs to devices (remember that all PCI IRQ lines | ||
386 | can be shared). | ||
387 | |||
388 | request_irq() will associate an interrupt handler and device handle | ||
389 | with an interrupt number. Historically interrupt numbers represent | ||
390 | IRQ lines which run from the PCI device to the Interrupt controller. | ||
391 | With MSI and MSI-X (more below) the interrupt number is a CPU "vector". | ||
392 | |||
393 | request_irq() also enables the interrupt. Make sure the device is | ||
394 | quiesced and does not have any interrupts pending before registering | ||
395 | the interrupt handler. | ||
396 | |||
397 | MSI and MSI-X are PCI capabilities. Both are "Message Signaled Interrupts" | ||
398 | which deliver interrupts to the CPU via a DMA write to a Local APIC. | ||
399 | The fundamental difference between MSI and MSI-X is how multiple | ||
400 | "vectors" get allocated. MSI requires contiguous blocks of vectors | ||
401 | while MSI-X can allocate several individual ones. | ||
402 | |||
403 | MSI capability can be enabled by calling pci_enable_msi() or | ||
404 | pci_enable_msix() before calling request_irq(). This causes | ||
405 | the PCI support to program CPU vector data into the PCI device | ||
406 | capability registers. | ||
407 | |||
408 | If your PCI device supports both, try to enable MSI-X first. | ||
409 | Only one can be enabled at a time. Many architectures, chip-sets, | ||
410 | or BIOSes do NOT support MSI or MSI-X and the call to pci_enable_msi/msix | ||
411 | will fail. This is important to note since many drivers have | ||
412 | two (or more) interrupt handlers: one for MSI/MSI-X and another for IRQs. | ||
413 | They choose which handler to register with request_irq() based on the | ||
414 | return value from pci_enable_msi/msix(). | ||
415 | |||
416 | There are (at least) two really good reasons for using MSI: | ||
417 | 1) 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 | |||
421 | 2) 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 | |||
427 | See drivers/infiniband/hw/mthca/ or drivers/net/tg3.c for examples | ||
428 | of MSI/MSI-X usage. | ||
429 | |||
430 | |||
431 | |||
432 | 4. PCI device shutdown | ||
433 | ~~~~~~~~~~~~~~~~~~~~~~~ | ||
434 | |||
435 | When a PCI device driver is being unloaded, most of the following | ||
436 | steps 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 | |||
447 | 4.1 Stop IRQs on the device | ||
448 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
449 | How to do this is chip/device specific. If it's not done, it opens | ||
450 | the possibility of a "screaming interrupt" if (and only if) | ||
451 | the IRQ is shared with another device. | ||
452 | |||
453 | When the shared IRQ handler is "unhooked", the remaining devices | ||
454 | using the same IRQ line will still need the IRQ enabled. Thus if the | ||
455 | "unhooked" device asserts IRQ line, the system will respond assuming | ||
456 | it was one of the remaining devices asserted the IRQ line. Since none | ||
457 | of the other devices will handle the IRQ, the system will "hang" until | ||
458 | it decides the IRQ isn't going to get handled and masks the IRQ (100,000 | ||
459 | iterations later). Once the shared IRQ is masked, the remaining devices | ||
460 | will stop functioning properly. Not a nice situation. | ||
461 | |||
462 | This is another reason to use MSI or MSI-X if it's available. | ||
463 | MSI and MSI-X are defined to be exclusive interrupts and thus | ||
464 | are not susceptible to the "screaming interrupt" problem. | ||
465 | |||
466 | |||
467 | 4.2 Release the IRQ | ||
468 | ~~~~~~~~~~~~~~~~~~~ | ||
469 | Once the device is quiesced (no more IRQs), one can call free_irq(). | ||
470 | This function will return control once any pending IRQs are handled, | ||
471 | "unhook" the drivers IRQ handler from that IRQ, and finally release | ||
472 | the IRQ if no one else is using it. | ||
473 | |||
474 | |||
475 | 4.3 Stop all DMA activity | ||
476 | ~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
477 | It's extremely important to stop all DMA operations BEFORE attempting | ||
478 | to deallocate DMA control data. Failure to do so can result in memory | ||
479 | corruption, hangs, and on some chip-sets a hard crash. | ||
187 | 480 | ||
188 | 4. How to access PCI config space | 481 | Stopping DMA after stopping the IRQs can avoid races where the |
482 | IRQ handler might restart DMA engines. | ||
483 | |||
484 | While this step sounds obvious and trivial, several "mature" drivers | ||
485 | didn't get this step right in the past. | ||
486 | |||
487 | |||
488 | 4.4 Release DMA buffers | ||
489 | ~~~~~~~~~~~~~~~~~~~~~~~ | ||
490 | Once DMA is stopped, clean up streaming DMA first. | ||
491 | I.e. unmap data buffers and return buffers to "upstream" | ||
492 | owners if there is one. | ||
493 | |||
494 | Then clean up "consistent" buffers which contain the control data. | ||
495 | |||
496 | See Documentation/DMA-API.txt for details on unmapping interfaces. | ||
497 | |||
498 | |||
499 | 4.5 Unregister from other subsystems | ||
500 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
501 | Most low level PCI device drivers support some other subsystem | ||
502 | like USB, ALSA, SCSI, NetDev, Infiniband, etc. Make sure your | ||
503 | driver isn't losing resources from that other subsystem. | ||
504 | If this happens, typically the symptom is an Oops (panic) when | ||
505 | the subsystem attempts to call into a driver that has been unloaded. | ||
506 | |||
507 | |||
508 | 4.6 Disable Device from responding to MMIO/IO Port addresses | ||
509 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
510 | io_unmap() MMIO or IO Port resources and then call pci_disable_device(). | ||
511 | This is the symmetric opposite of pci_enable_device(). | ||
512 | Do not access device registers after calling pci_disable_device(). | ||
513 | |||
514 | |||
515 | 4.7 Release MMIO/IO Port Resource(s) | ||
516 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
517 | Call pci_release_region() to mark the MMIO or IO Port range as available. | ||
518 | Failure to do so usually results in the inability to reload the driver. | ||
519 | |||
520 | |||
521 | |||
522 | 5. How to access PCI config space | ||
189 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 523 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
190 | You can use pci_(read|write)_config_(byte|word|dword) to access the config | 524 | |
525 | You can use pci_(read|write)_config_(byte|word|dword) to access the config | ||
191 | space of a device represented by struct pci_dev *. All these functions return 0 | 526 | space of a device represented by struct pci_dev *. All these functions return 0 |
192 | when successful or an error code (PCIBIOS_...) which can be translated to a text | 527 | when successful or an error code (PCIBIOS_...) which can be translated to a text |
193 | string by pcibios_strerror. Most drivers expect that accesses to valid PCI | 528 | string by pcibios_strerror. Most drivers expect that accesses to valid PCI |
194 | devices don't fail. | 529 | devices don't fail. |
195 | 530 | ||
196 | If you don't have a struct pci_dev available, you can call | 531 | If you don't have a struct pci_dev available, you can call |
197 | pci_bus_(read|write)_config_(byte|word|dword) to access a given device | 532 | pci_bus_(read|write)_config_(byte|word|dword) to access a given device |
198 | and function on that bus. | 533 | and function on that bus. |
199 | 534 | ||
200 | If you access fields in the standard portion of the config header, please | 535 | If you access fields in the standard portion of the config header, please |
201 | use symbolic names of locations and bits declared in <linux/pci.h>. | 536 | use 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 | 538 | If you need to access Extended PCI Capability registers, just call |
204 | pci_find_capability() for the particular capability and it will find the | 539 | pci_find_capability() for the particular capability and it will find the |
205 | corresponding register block for you. | 540 | corresponding register block for you. |
206 | 541 | ||
207 | 542 | ||
208 | 5. Addresses and interrupts | ||
209 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
210 | Memory and port addresses and interrupt numbers should NOT be read from the | ||
211 | config space. You should use the values in the pci_dev structure as they might | ||
212 | have 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 | ||
217 | no other device is already using the same resource. The driver is expected | ||
218 | to determine MMIO and IO Port resource availability _before_ calling | ||
219 | pci_enable_device(). Conversely, drivers should call pci_release_region() | ||
220 | _after_ calling pci_disable_device(). The idea is to prevent two devices | ||
221 | colliding on the same address range. | ||
222 | |||
223 | Generic flavors of pci_request_region() are request_mem_region() | ||
224 | (for MMIO ranges) and request_region() (for IO Port ranges). | ||
225 | Use these for address resources that are not described by "normal" PCI | ||
226 | interfaces (e.g. BAR). | ||
227 | |||
228 | All interrupt handlers should be registered with IRQF_SHARED and use the devid | ||
229 | to map IRQs to devices (remember that all PCI interrupts are shared). | ||
230 | |||
231 | 543 | ||
232 | 6. Other interesting functions | 544 | 6. Other interesting functions |
233 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 545 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
546 | |||
234 | pci_find_slot() Find pci_dev corresponding to given bus and | 547 | pci_find_slot() Find pci_dev corresponding to given bus and |
235 | slot numbers. | 548 | slot numbers. |
236 | pci_set_power_state() Set PCI Power Management state (0=D0 ... 3=D3) | 549 | pci_set_power_state() Set PCI Power Management state (0=D0 ... 3=D3) |
@@ -247,11 +560,12 @@ pci_set_mwi() Enable Memory-Write-Invalidate transactions. | |||
247 | pci_clear_mwi() Disable Memory-Write-Invalidate transactions. | 560 | pci_clear_mwi() Disable Memory-Write-Invalidate transactions. |
248 | 561 | ||
249 | 562 | ||
563 | |||
250 | 7. Miscellaneous hints | 564 | 7. Miscellaneous hints |
251 | ~~~~~~~~~~~~~~~~~~~~~~ | 565 | ~~~~~~~~~~~~~~~~~~~~~~ |
252 | When displaying PCI slot names to the user (for example when a driver wants | 566 | |
253 | to tell the user what card has it found), please use pci_name(pci_dev) | 567 | When displaying PCI device names to the user (for example when a driver wants |
254 | for this purpose. | 568 | to tell the user what card has it found), please use pci_name(pci_dev). |
255 | 569 | ||
256 | Always refer to the PCI devices by a pointer to the pci_dev structure. | 570 | Always refer to the PCI devices by a pointer to the pci_dev structure. |
257 | All PCI layer functions use this identification and it's the only | 571 | All 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 | |||
259 | special purposes -- on systems with multiple primary buses their semantics | 573 | special purposes -- on systems with multiple primary buses their semantics |
260 | can be pretty complex. | 574 | can be pretty complex. |
261 | 575 | ||
262 | If you're going to use PCI bus mastering DMA, take a look at | ||
263 | Documentation/DMA-mapping.txt. | ||
264 | |||
265 | Don't try to turn on Fast Back to Back writes in your driver. All devices | 576 | Don't try to turn on Fast Back to Back writes in your driver. All devices |
266 | on the bus need to be capable of doing it, so this is something which needs | 577 | on the bus need to be capable of doing it, so this is something which needs |
267 | to be handled by platform and generic code, not individual drivers. | 578 | to be handled by platform and generic code, not individual drivers. |
268 | 579 | ||
269 | 580 | ||
581 | |||
270 | 8. Vendor and device identifications | 582 | 8. Vendor and device identifications |
271 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 583 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
272 | For the future, let's avoid adding device ids to include/linux/pci_ids.h. | ||
273 | 584 | ||
274 | PCI_VENDOR_ID_xxx for vendors, and a hex constant for device ids. | 585 | One is not not required to add new device ids to include/linux/pci_ids.h. |
586 | Please add PCI_VENDOR_ID_xxx for vendors and a hex constant for device ids. | ||
587 | |||
588 | PCI_VENDOR_ID_xxx constants are re-used. The device ids are arbitrary | ||
589 | hex numbers (vendor controlled) and normally used only in a single | ||
590 | location, the pci_device_id table. | ||
591 | |||
592 | Please DO submit new vendor/device ids to pciids.sourceforge.net project. | ||
593 | |||
275 | 594 | ||
276 | Rationale: 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 | ||
280 | 9. Obsolete functions | 596 | 9. Obsolete functions |
281 | ~~~~~~~~~~~~~~~~~~~~~ | 597 | ~~~~~~~~~~~~~~~~~~~~~ |
598 | |||
282 | There are several functions which you might come across when trying to | 599 | There are several functions which you might come across when trying to |
283 | port an old driver to the new PCI interface. They are no longer present | 600 | port an old driver to the new PCI interface. They are no longer present |
284 | in the kernel as they aren't compatible with hotplug or PCI domains or | 601 | in the kernel as they aren't compatible with hotplug or PCI domains or |
285 | having sane locking. | 602 | having sane locking. |
286 | 603 | ||
287 | pci_find_device() Superseded by pci_get_device() | 604 | pci_find_device() Superseded by pci_get_device() |
288 | pci_find_subsys() Superseded by pci_get_subsys() | 605 | pci_find_subsys() Superseded by pci_get_subsys() |
289 | pci_find_slot() Superseded by pci_get_slot() | 606 | pci_find_slot() Superseded by pci_get_slot() |
607 | |||
608 | |||
609 | The alternative is the traditional PCI device driver that walks PCI | ||
610 | device lists. This is still possible but discouraged. | ||
611 | |||
612 | |||
613 | |||
614 | 10. pci_enable_device_bars() and Legacy I/O Port space | ||
615 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
616 | |||
617 | Large servers may not be able to provide I/O port resources to all PCI | ||
618 | devices. I/O Port space is only 64KB on Intel Architecture[1] and is | ||
619 | likely also fragmented since the I/O base register of PCI-to-PCI | ||
620 | bridge will usually be aligned to a 4KB boundary[2]. On such systems, | ||
621 | pci_enable_device() and pci_request_region() will fail when | ||
622 | attempting to enable I/O Port regions that don't have I/O Port | ||
623 | resources assigned. | ||
624 | |||
625 | Fortunately, many PCI devices which request I/O Port resources also | ||
626 | provide access to the same registers via MMIO BARs. These devices can | ||
627 | be handled without using I/O port space and the drivers typically | ||
628 | offer a CONFIG_ option to only use MMIO regions | ||
629 | (e.g. CONFIG_TULIP_MMIO). PCI devices typically provide I/O port | ||
630 | interface for legacy OSes and will work when I/O port resources are not | ||
631 | assigned. The "PCI Local Bus Specification Revision 3.0" discusses | ||
632 | this on p.44, "IMPLEMENTATION NOTE". | ||
633 | |||
634 | If your PCI device driver doesn't need I/O port resources assigned to | ||
635 | I/O Port BARs, you should use pci_enable_device_bars() instead of | ||
636 | pci_enable_device() in order not to enable I/O port regions for the | ||
637 | corresponding devices. In addition, you should use | ||
638 | pci_request_selected_regions() and pci_release_selected_regions() | ||
639 | instead of pci_request_regions()/pci_release_regions() in order not to | ||
640 | request/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 | |||
647 | 11. MMIO Space and "Write Posting" | ||
648 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
649 | |||
650 | Converting a driver from using I/O Port space to using MMIO space | ||
651 | often requires some additional changes. Specifically, "write posting" | ||
652 | needs to be handled. Many drivers (e.g. tg3, acenic, sym53c8xx_2) | ||
653 | already do this. I/O Port space guarantees write transactions reach the PCI | ||
654 | device before the CPU can continue. Writes to MMIO space allow the CPU | ||
655 | to continue before the transaction reaches the PCI device. HW weenies | ||
656 | call this "Write Posting" because the write completion is "posted" to | ||
657 | the CPU before the transaction has reached its destination. | ||
658 | |||
659 | Thus, timing sensitive code should add readl() where the CPU is | ||
660 | expected to wait before doing other work. The classic "bit banging" | ||
661 | sequence 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 | |||
668 | The 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 | |||
676 | It is important that "safe_mmio_reg" not have any side effects that | ||
677 | interferes with the correct operation of the device. | ||
678 | |||
679 | Another case to watch out for is when resetting a PCI device. Use PCI | ||
680 | Configuration space reads to flush the writel(). This will gracefully | ||
681 | handle the PCI master abort on all platforms if the PCI device is | ||
682 | expected to not respond to a readl(). Most x86 platforms will allow | ||
683 | MMIO 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 |
5 | Grant Likely <grant.likely at secretlab.ca> | 5 | Grant 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 | |||
7 | I - Introduction | 13 | I - Introduction |
8 | ================ | 14 | ================ |
9 | Boards supported by the arch/powerpc architecture require device tree be | 15 | Boards supported by the arch/powerpc architecture require device tree be |
@@ -157,8 +163,8 @@ rtc@<addr> rtc *-rtc Real time clock | |||
157 | mscan@<addr> mscan *-mscan CAN bus controller | 163 | mscan@<addr> mscan *-mscan CAN bus controller |
158 | pci@<addr> pci *-pci PCI bridge | 164 | pci@<addr> pci *-pci PCI bridge |
159 | serial@<addr> serial *-psc-uart PSC in serial mode | 165 | serial@<addr> serial *-psc-uart PSC in serial mode |
160 | i2s@<addr> i2s *-psc-i2s PSC in i2s mode | 166 | i2s@<addr> sound *-psc-i2s PSC in i2s mode |
161 | ac97@<addr> ac97 *-psc-ac97 PSC in ac97 mode | 167 | ac97@<addr> sound *-psc-ac97 PSC in ac97 mode |
162 | spi@<addr> spi *-psc-spi PSC in spi mode | 168 | spi@<addr> spi *-psc-spi PSC in spi mode |
163 | irda@<addr> irda *-psc-irda PSC in IrDA mode | 169 | irda@<addr> irda *-psc-irda PSC in IrDA mode |
164 | spi@<addr> spi *-spi MPC52xx spi device | 170 | spi@<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). | |||
11 | Supported Cards/Chipsets | 11 | Supported 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 | ||
87 | People | 97 | People |
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 @@ | |||
1 | Linux Magic System Request Key Hacks | 1 | Linux Magic System Request Key Hacks |
2 | Documentation for sysrq.c version 1.15 | 2 | Documentation for sysrq.c |
3 | Last update: $Date: 2001/01/28 10:15:59 $ | 3 | Last 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 | ||
36 | Note that the value of /proc/sys/kernel/sysrq influences only the invocation | 36 | Note that the value of /proc/sys/kernel/sysrq influences only the invocation |
37 | via a keyboard. Invocation of any operation via /proc/sysrq-trigger is always | 37 | via a keyboard. Invocation of any operation via /proc/sysrq-trigger is always |
38 | allowed. | 38 | allowed (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>, | |||
58 | On other - If you know of the key combos for other architectures, please | 58 | On 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 | ||
61 | On all - write a character to /proc/sysrq-trigger. eg: | 61 | On 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 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
111 | Well, un'R'aw is very handy when your X server or a svgalib program crashes. | 118 | Well, un'R'aw is very handy when your X server or a svgalib program crashes. |
112 | 119 | ||
113 | sa'K' (Secure Access Key) is useful when you want to be sure there are no | 120 | sa'K' (Secure Access Key) is useful when you want to be sure there is no |
114 | trojan program is running at console and which could grab your password | 121 | trojan program running at console which could grab your password |
115 | when you would try to login. It will kill all programs on given console | 122 | when you would try to login. It will kill all programs on given console, |
116 | and thus letting you make sure that the login prompt you see is actually | 123 | thus letting you make sure that the login prompt you see is actually |
117 | the one from init, not some trojan program. | 124 | the one from init, not some trojan program. |
118 | IMPORTANT: In its true form it is not a true SAK like the one in a :IMPORTANT | 125 | IMPORTANT: In its true form it is not a true SAK like the one in a :IMPORTANT |
119 | IMPORTANT: c2 compliant system, and it should not be mistaken as :IMPORTANT | 126 | IMPORTANT: c2 compliant system, and it should not be mistaken as :IMPORTANT |
120 | IMPORTANT: such. :IMPORTANT | 127 | IMPORTANT: 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 |
122 | useful when you want to exit a program that will not let you switch consoles. | 129 | useful 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...) | |||
139 | Again, the unmount (remount read-only) hasn't taken place until you see the | 146 | Again, 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 | ||
142 | The loglevel'0'-'9' is useful when your console is being flooded with | 149 | The loglevels '0'-'9' are useful when your console is being flooded with |
143 | kernel messages you do not want to see. Setting '0' will prevent all but | 150 | kernel messages you do not want to see. Selecting '0' will prevent all but |
144 | the most urgent kernel messages from reaching your console. (They will | 151 | the most urgent kernel messages from reaching your console. (They will |
145 | still be logged if syslogd/klogd are alive, though.) | 152 | still be logged if syslogd/klogd are alive, though.) |
146 | 153 | ||
@@ -152,7 +159,7 @@ processes. | |||
152 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 159 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
153 | That happens to me, also. I've found that tapping shift, alt, and control | 160 | That happens to me, also. I've found that tapping shift, alt, and control |
154 | on both sides of the keyboard, and hitting an invalid sysrq sequence again | 161 | on both sides of the keyboard, and hitting an invalid sysrq sequence again |
155 | will fix the problem. (ie, something like alt-sysrq-z). Switching to another | 162 | will fix the problem. (i.e., something like alt-sysrq-z). Switching to another |
156 | virtual console (ALT+Fn) and then back again should also help. | 163 | virtual 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 | |||
174 | prints help, and C) an action_msg string, that will print right before your | 181 | prints help, and C) an action_msg string, that will print right before your |
175 | handler is called. Your handler must conform to the prototype in 'sysrq.h'. | 182 | handler is called. Your handler must conform to the prototype in 'sysrq.h'. |
176 | 183 | ||
177 | After the sysrq_key_op is created, you can call the macro | 184 | After the sysrq_key_op is created, you can call the kernel function |
178 | register_sysrq_key(int key, struct sysrq_key_op *op_p) that is defined in | 185 | register_sysrq_key(int key, struct sysrq_key_op *op_p); this will |
179 | sysrq.h, this will register the operation pointed to by 'op_p' at table | 186 | register the operation pointed to by 'op_p' at table key 'key', |
180 | key 'key', if that slot in the table is blank. At module unload time, you must | 187 | if that slot in the table is blank. At module unload time, you must call |
181 | call the macro unregister_sysrq_key(int key, struct sysrq_key_op *op_p), which | 188 | the function unregister_sysrq_key(int key, struct sysrq_key_op *op_p), which |
182 | will remove the key op pointed to by 'op_p' from the key 'key', if and only if | 189 | will remove the key op pointed to by 'op_p' from the key 'key', if and only if |
183 | it is currently registered in that slot. This is in case the slot has been | 190 | it is currently registered in that slot. This is in case the slot has been |
184 | overwritten since you registered it. | 191 | overwritten since you registered it. |
@@ -186,15 +193,12 @@ overwritten since you registered it. | |||
186 | The Magic SysRQ system works by registering key operations against a key op | 193 | The Magic SysRQ system works by registering key operations against a key op |
187 | lookup table, which is defined in 'drivers/char/sysrq.c'. This key table has | 194 | lookup table, which is defined in 'drivers/char/sysrq.c'. This key table has |
188 | a number of operations registered into it at compile time, but is mutable, | 195 | a number of operations registered into it at compile time, but is mutable, |
189 | and 4 functions are exported for interface to it: __sysrq_lock_table, | 196 | and 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. |
191 | functions __sysrq_swap_key_ops and __sysrq_swap_key_ops_nolock are defined | 198 | Of course, never ever leave an invalid pointer in the table. I.e., when |
192 | in the header itself, and the REGISTER and UNREGISTER macros are built from | 199 | your module that called register_sysrq_key() exits, it must call |
193 | these. More complex (and dangerous!) manipulations of the table are possible | 200 | unregister_sysrq_key() to clean up the sysrq key table entry that it used. |
194 | using these functions, but you must be careful to always lock the table before | 201 | Null pointers in the table are always safe. :) |
195 | you read or write from it, and to unlock it again when you are done. (And of | ||
196 | course, to never ever leave an invalid pointer in the table). Null pointers in | ||
197 | the table are always safe :) | ||
198 | 202 | ||
199 | If for some reason you feel the need to call the handle_sysrq function from | 203 | If for some reason you feel the need to call the handle_sysrq function from |
200 | within a function called by handle_sysrq, you must be aware that you are in | 204 | within 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 | ||
40 | TTY side interfaces: | 40 | TTY side interfaces: |
41 | 41 | ||
42 | open() - 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 | |||
42 | close() - This is called on a terminal when the line | 47 | close() - 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 | ||
47 | open() - Called when the line discipline is attached to | 52 | hangup() - 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 | ||
52 | write() - A process is writing data through the line | 57 | write() - 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 | ||
56 | flush_buffer() - May be called at any point between open and close. | 61 | flush_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 | ||
58 | chars_in_buffer() - Report the number of bytes in the buffer. | 65 | chars_in_buffer() - (optional) Report the number of bytes in the input |
66 | buffer. | ||
59 | 67 | ||
60 | set_termios() - Called on termios structure changes. The caller | 68 | set_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 | ||
65 | read() - Move data from the line discipline to the user. | 74 | read() - 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 | ||
104 | Driver Access | ||
105 | |||
106 | Line discipline methods can call the following methods of the underlying | ||
107 | hardware driver through the function pointers within the tty->driver | ||
108 | structure: | ||
109 | |||
110 | write() Write a block of characters to the tty device. | ||
111 | Returns the number of characters accepted. | ||
112 | |||
113 | put_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 | |||
117 | flush_chars() (Optional) If defined, must be called after | ||
118 | queueing characters with put_char() in order to | ||
119 | start transmission. | ||
120 | |||
121 | write_room() Returns the numbers of characters the tty driver | ||
122 | will accept for queueing to be written. | ||
123 | |||
124 | ioctl() Invoke device specific ioctl. | ||
125 | Expects data pointers to refer to userspace. | ||
126 | Returns ENOIOCTLCMD for unrecognized ioctl numbers. | ||
127 | |||
128 | set_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 | |||
133 | throttle() 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 | |||
138 | unthrottle() 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 | |||
142 | stop() Ask the tty driver to stop outputting characters | ||
143 | to the tty device. | ||
144 | |||
145 | start() Ask the tty driver to resume sending characters | ||
146 | to the tty device. | ||
147 | |||
148 | hangup() Ask the tty driver to hang up the tty device. | ||
149 | |||
150 | break_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 | |||
157 | wait_until_sent() Waits until the device has written out all of the | ||
158 | characters in its transmitter FIFO. | ||
159 | |||
160 | send_xchar() Send a high-priority XON/XOFF character to the device. | ||
161 | |||
162 | |||
163 | Flags | ||
164 | |||
165 | Line discipline methods have access to tty->flags field containing the | ||
166 | following interesting flags: | ||
167 | |||
168 | TTY_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 | |||
172 | TTY_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 | |||
177 | TTY_IO_ERROR If set, causes all subsequent userspace read/write | ||
178 | calls on the tty to fail, returning -EIO. | ||
179 | |||
180 | TTY_OTHER_CLOSED Device is a pty and the other side has closed. | ||
181 | |||
182 | TTY_NO_WRITE_SPLIT Prevent driver from splitting up writes into | ||
183 | smaller chunks. | ||
184 | |||
185 | |||
95 | Locking | 186 | Locking |
96 | 187 | ||
97 | Callers to the line discipline functions from the tty layer are required to | 188 | Callers 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 |
50 | thus won't work with this drivers. Check for ACM compliance before buying. | 54 | thus 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 | |||
55 | Early Console | 59 | Early Console |
56 | 60 | ||
57 | syntax: earlyprintk=vga | 61 | syntax: earlyprintk=vga |