diff options
Diffstat (limited to 'Documentation')
55 files changed, 2633 insertions, 835 deletions
diff --git a/Documentation/ABI/obsolete/devfs b/Documentation/ABI/removed/devfs index b8b87399bc8f..8195c4e0d0a1 100644 --- a/Documentation/ABI/obsolete/devfs +++ b/Documentation/ABI/removed/devfs | |||
@@ -1,13 +1,12 @@ | |||
1 | What: devfs | 1 | What: devfs |
2 | Date: July 2005 | 2 | Date: July 2005 (scheduled), finally removed in kernel v2.6.18 |
3 | Contact: Greg Kroah-Hartman <gregkh@suse.de> | 3 | Contact: Greg Kroah-Hartman <gregkh@suse.de> |
4 | Description: | 4 | Description: |
5 | devfs has been unmaintained for a number of years, has unfixable | 5 | devfs has been unmaintained for a number of years, has unfixable |
6 | races, contains a naming policy within the kernel that is | 6 | races, contains a naming policy within the kernel that is |
7 | against the LSB, and can be replaced by using udev. | 7 | against the LSB, and can be replaced by using udev. |
8 | The files fs/devfs/*, include/linux/devfs_fs*.h will be removed, | 8 | The files fs/devfs/*, include/linux/devfs_fs*.h were removed, |
9 | along with the the assorted devfs function calls throughout the | 9 | along with the the assorted devfs function calls throughout the |
10 | kernel tree. | 10 | kernel tree. |
11 | 11 | ||
12 | Users: | 12 | Users: |
13 | |||
diff --git a/Documentation/ABI/testing/sysfs-power b/Documentation/ABI/testing/sysfs-power new file mode 100644 index 000000000000..d882f8093871 --- /dev/null +++ b/Documentation/ABI/testing/sysfs-power | |||
@@ -0,0 +1,88 @@ | |||
1 | What: /sys/power/ | ||
2 | Date: August 2006 | ||
3 | Contact: Rafael J. Wysocki <rjw@sisk.pl> | ||
4 | Description: | ||
5 | The /sys/power directory will contain files that will | ||
6 | provide a unified interface to the power management | ||
7 | subsystem. | ||
8 | |||
9 | What: /sys/power/state | ||
10 | Date: August 2006 | ||
11 | Contact: Rafael J. Wysocki <rjw@sisk.pl> | ||
12 | Description: | ||
13 | The /sys/power/state file controls the system power state. | ||
14 | Reading from this file returns what states are supported, | ||
15 | which is hard-coded to 'standby' (Power-On Suspend), 'mem' | ||
16 | (Suspend-to-RAM), and 'disk' (Suspend-to-Disk). | ||
17 | |||
18 | Writing to this file one of these strings causes the system to | ||
19 | transition into that state. Please see the file | ||
20 | Documentation/power/states.txt for a description of each of | ||
21 | these states. | ||
22 | |||
23 | What: /sys/power/disk | ||
24 | Date: August 2006 | ||
25 | Contact: Rafael J. Wysocki <rjw@sisk.pl> | ||
26 | Description: | ||
27 | The /sys/power/disk file controls the operating mode of the | ||
28 | suspend-to-disk mechanism. Reading from this file returns | ||
29 | the name of the method by which the system will be put to | ||
30 | sleep on the next suspend. There are four methods supported: | ||
31 | 'firmware' - means that the memory image will be saved to disk | ||
32 | by some firmware, in which case we also assume that the | ||
33 | firmware will handle the system suspend. | ||
34 | 'platform' - the memory image will be saved by the kernel and | ||
35 | the system will be put to sleep by the platform driver (e.g. | ||
36 | ACPI or other PM registers). | ||
37 | 'shutdown' - the memory image will be saved by the kernel and | ||
38 | the system will be powered off. | ||
39 | 'reboot' - the memory image will be saved by the kernel and | ||
40 | the system will be rebooted. | ||
41 | |||
42 | The suspend-to-disk method may be chosen by writing to this | ||
43 | file one of the accepted strings: | ||
44 | |||
45 | 'firmware' | ||
46 | 'platform' | ||
47 | 'shutdown' | ||
48 | 'reboot' | ||
49 | |||
50 | It will only change to 'firmware' or 'platform' if the system | ||
51 | supports that. | ||
52 | |||
53 | What: /sys/power/image_size | ||
54 | Date: August 2006 | ||
55 | Contact: Rafael J. Wysocki <rjw@sisk.pl> | ||
56 | Description: | ||
57 | The /sys/power/image_size file controls the size of the image | ||
58 | created by the suspend-to-disk mechanism. It can be written a | ||
59 | string representing a non-negative integer that will be used | ||
60 | as an upper limit of the image size, in bytes. The kernel's | ||
61 | suspend-to-disk code will do its best to ensure the image size | ||
62 | will not exceed this number. However, if it turns out to be | ||
63 | impossible, the kernel will try to suspend anyway using the | ||
64 | smallest image possible. In particular, if "0" is written to | ||
65 | this file, the suspend image will be as small as possible. | ||
66 | |||
67 | Reading from this file will display the current image size | ||
68 | limit, which is set to 500 MB by default. | ||
69 | |||
70 | What: /sys/power/pm_trace | ||
71 | Date: August 2006 | ||
72 | Contact: Rafael J. Wysocki <rjw@sisk.pl> | ||
73 | Description: | ||
74 | The /sys/power/pm_trace file controls the code which saves the | ||
75 | last PM event point in the RTC across reboots, so that you can | ||
76 | debug a machine that just hangs during suspend (or more | ||
77 | commonly, during resume). Namely, the RTC is only used to save | ||
78 | the last PM event point if this file contains '1'. Initially | ||
79 | it contains '0' which may be changed to '1' by writing a | ||
80 | string representing a nonzero integer into it. | ||
81 | |||
82 | To use this debugging feature you should attempt to suspend | ||
83 | the machine, then reboot it and run | ||
84 | |||
85 | dmesg -s 1000000 | grep 'hash matches' | ||
86 | |||
87 | CAUTION: Using it will cause your machine's real-time (CMOS) | ||
88 | clock to be set to a random invalid time after a resume. | ||
diff --git a/Documentation/CodingStyle b/Documentation/CodingStyle index 6d2412ec91ed..29c18966b050 100644 --- a/Documentation/CodingStyle +++ b/Documentation/CodingStyle | |||
@@ -532,6 +532,40 @@ appears outweighs the potential value of the hint that tells gcc to do | |||
532 | something it would have done anyway. | 532 | something it would have done anyway. |
533 | 533 | ||
534 | 534 | ||
535 | Chapter 16: Function return values and names | ||
536 | |||
537 | Functions can return values of many different kinds, and one of the | ||
538 | most common is a value indicating whether the function succeeded or | ||
539 | failed. Such a value can be represented as an error-code integer | ||
540 | (-Exxx = failure, 0 = success) or a "succeeded" boolean (0 = failure, | ||
541 | non-zero = success). | ||
542 | |||
543 | Mixing up these two sorts of representations is a fertile source of | ||
544 | difficult-to-find bugs. If the C language included a strong distinction | ||
545 | between integers and booleans then the compiler would find these mistakes | ||
546 | for us... but it doesn't. To help prevent such bugs, always follow this | ||
547 | convention: | ||
548 | |||
549 | If the name of a function is an action or an imperative command, | ||
550 | the function should return an error-code integer. If the name | ||
551 | is a predicate, the function should return a "succeeded" boolean. | ||
552 | |||
553 | For example, "add work" is a command, and the add_work() function returns 0 | ||
554 | for success or -EBUSY for failure. In the same way, "PCI device present" is | ||
555 | a predicate, and the pci_dev_present() function returns 1 if it succeeds in | ||
556 | finding a matching device or 0 if it doesn't. | ||
557 | |||
558 | All EXPORTed functions must respect this convention, and so should all | ||
559 | public functions. Private (static) functions need not, but it is | ||
560 | recommended that they do. | ||
561 | |||
562 | Functions whose return value is the actual result of a computation, rather | ||
563 | than an indication of whether the computation succeeded, are not subject to | ||
564 | this rule. Generally they indicate failure by returning some out-of-range | ||
565 | result. Typical examples would be functions that return pointers; they use | ||
566 | NULL or the ERR_PTR mechanism to report failure. | ||
567 | |||
568 | |||
535 | 569 | ||
536 | Appendix I: References | 570 | Appendix I: References |
537 | 571 | ||
diff --git a/Documentation/DocBook/kernel-api.tmpl b/Documentation/DocBook/kernel-api.tmpl index f8fe882e33dc..49c745720f47 100644 --- a/Documentation/DocBook/kernel-api.tmpl +++ b/Documentation/DocBook/kernel-api.tmpl | |||
@@ -181,27 +181,6 @@ X!Ilib/string.c | |||
181 | </sect1> | 181 | </sect1> |
182 | </chapter> | 182 | </chapter> |
183 | 183 | ||
184 | <chapter id="proc"> | ||
185 | <title>The proc filesystem</title> | ||
186 | |||
187 | <sect1><title>sysctl interface</title> | ||
188 | !Ekernel/sysctl.c | ||
189 | </sect1> | ||
190 | |||
191 | <sect1><title>proc filesystem interface</title> | ||
192 | !Ifs/proc/base.c | ||
193 | </sect1> | ||
194 | </chapter> | ||
195 | |||
196 | <chapter id="debugfs"> | ||
197 | <title>The debugfs filesystem</title> | ||
198 | |||
199 | <sect1><title>debugfs interface</title> | ||
200 | !Efs/debugfs/inode.c | ||
201 | !Efs/debugfs/file.c | ||
202 | </sect1> | ||
203 | </chapter> | ||
204 | |||
205 | <chapter id="vfs"> | 184 | <chapter id="vfs"> |
206 | <title>The Linux VFS</title> | 185 | <title>The Linux VFS</title> |
207 | <sect1><title>The Filesystem types</title> | 186 | <sect1><title>The Filesystem types</title> |
@@ -234,6 +213,50 @@ X!Ilib/string.c | |||
234 | </sect1> | 213 | </sect1> |
235 | </chapter> | 214 | </chapter> |
236 | 215 | ||
216 | <chapter id="proc"> | ||
217 | <title>The proc filesystem</title> | ||
218 | |||
219 | <sect1><title>sysctl interface</title> | ||
220 | !Ekernel/sysctl.c | ||
221 | </sect1> | ||
222 | |||
223 | <sect1><title>proc filesystem interface</title> | ||
224 | !Ifs/proc/base.c | ||
225 | </sect1> | ||
226 | </chapter> | ||
227 | |||
228 | <chapter id="sysfs"> | ||
229 | <title>The Filesystem for Exporting Kernel Objects</title> | ||
230 | !Efs/sysfs/file.c | ||
231 | !Efs/sysfs/symlink.c | ||
232 | !Efs/sysfs/bin.c | ||
233 | </chapter> | ||
234 | |||
235 | <chapter id="debugfs"> | ||
236 | <title>The debugfs filesystem</title> | ||
237 | |||
238 | <sect1><title>debugfs interface</title> | ||
239 | !Efs/debugfs/inode.c | ||
240 | !Efs/debugfs/file.c | ||
241 | </sect1> | ||
242 | </chapter> | ||
243 | |||
244 | <chapter id="relayfs"> | ||
245 | <title>relay interface support</title> | ||
246 | |||
247 | <para> | ||
248 | Relay interface support | ||
249 | is designed to provide an efficient mechanism for tools and | ||
250 | facilities to relay large amounts of data from kernel space to | ||
251 | user space. | ||
252 | </para> | ||
253 | |||
254 | <sect1><title>relay interface</title> | ||
255 | !Ekernel/relay.c | ||
256 | !Ikernel/relay.c | ||
257 | </sect1> | ||
258 | </chapter> | ||
259 | |||
237 | <chapter id="netcore"> | 260 | <chapter id="netcore"> |
238 | <title>Linux Networking</title> | 261 | <title>Linux Networking</title> |
239 | <sect1><title>Networking Base Types</title> | 262 | <sect1><title>Networking Base Types</title> |
@@ -302,8 +325,13 @@ X!Ekernel/module.c | |||
302 | !Ekernel/irq/manage.c | 325 | !Ekernel/irq/manage.c |
303 | </sect1> | 326 | </sect1> |
304 | 327 | ||
328 | <sect1><title>DMA Channels</title> | ||
329 | !Ekernel/dma.c | ||
330 | </sect1> | ||
331 | |||
305 | <sect1><title>Resources Management</title> | 332 | <sect1><title>Resources Management</title> |
306 | !Ikernel/resource.c | 333 | !Ikernel/resource.c |
334 | !Ekernel/resource.c | ||
307 | </sect1> | 335 | </sect1> |
308 | 336 | ||
309 | <sect1><title>MTRR Handling</title> | 337 | <sect1><title>MTRR Handling</title> |
@@ -349,13 +377,6 @@ X!Earch/i386/kernel/mca.c | |||
349 | </sect1> | 377 | </sect1> |
350 | </chapter> | 378 | </chapter> |
351 | 379 | ||
352 | <chapter id="sysfs"> | ||
353 | <title>The Filesystem for Exporting Kernel Objects</title> | ||
354 | !Efs/sysfs/file.c | ||
355 | !Efs/sysfs/symlink.c | ||
356 | !Efs/sysfs/bin.c | ||
357 | </chapter> | ||
358 | |||
359 | <chapter id="security"> | 380 | <chapter id="security"> |
360 | <title>Security Framework</title> | 381 | <title>Security Framework</title> |
361 | !Esecurity/security.c | 382 | !Esecurity/security.c |
@@ -386,6 +407,7 @@ X!Iinclude/linux/device.h | |||
386 | --> | 407 | --> |
387 | !Edrivers/base/driver.c | 408 | !Edrivers/base/driver.c |
388 | !Edrivers/base/core.c | 409 | !Edrivers/base/core.c |
410 | !Edrivers/base/class.c | ||
389 | !Edrivers/base/firmware_class.c | 411 | !Edrivers/base/firmware_class.c |
390 | !Edrivers/base/transport_class.c | 412 | !Edrivers/base/transport_class.c |
391 | !Edrivers/base/dmapool.c | 413 | !Edrivers/base/dmapool.c |
@@ -437,6 +459,11 @@ X!Edrivers/pnp/system.c | |||
437 | !Eblock/ll_rw_blk.c | 459 | !Eblock/ll_rw_blk.c |
438 | </chapter> | 460 | </chapter> |
439 | 461 | ||
462 | <chapter id="chrdev"> | ||
463 | <title>Char devices</title> | ||
464 | !Efs/char_dev.c | ||
465 | </chapter> | ||
466 | |||
440 | <chapter id="miscdev"> | 467 | <chapter id="miscdev"> |
441 | <title>Miscellaneous Devices</title> | 468 | <title>Miscellaneous Devices</title> |
442 | !Edrivers/char/misc.c | 469 | !Edrivers/char/misc.c |
diff --git a/Documentation/DocBook/usb.tmpl b/Documentation/DocBook/usb.tmpl index 320af25de3a2..3608472d7b74 100644 --- a/Documentation/DocBook/usb.tmpl +++ b/Documentation/DocBook/usb.tmpl | |||
@@ -43,59 +43,52 @@ | |||
43 | 43 | ||
44 | <para>A Universal Serial Bus (USB) is used to connect a host, | 44 | <para>A Universal Serial Bus (USB) is used to connect a host, |
45 | such as a PC or workstation, to a number of peripheral | 45 | such as a PC or workstation, to a number of peripheral |
46 | devices. USB uses a tree structure, with the host at the | 46 | devices. USB uses a tree structure, with the host as the |
47 | root (the system's master), hubs as interior nodes, and | 47 | root (the system's master), hubs as interior nodes, and |
48 | peripheral devices as leaves (and slaves). | 48 | peripherals as leaves (and slaves). |
49 | Modern PCs support several such trees of USB devices, usually | 49 | Modern PCs support several such trees of USB devices, usually |
50 | one USB 2.0 tree (480 Mbit/sec each) with | 50 | one USB 2.0 tree (480 Mbit/sec each) with |
51 | a few USB 1.1 trees (12 Mbit/sec each) that are used when you | 51 | a few USB 1.1 trees (12 Mbit/sec each) that are used when you |
52 | connect a USB 1.1 device directly to the machine's "root hub". | 52 | connect a USB 1.1 device directly to the machine's "root hub". |
53 | </para> | 53 | </para> |
54 | 54 | ||
55 | <para>That master/slave asymmetry was designed in part for | 55 | <para>That master/slave asymmetry was designed-in for a number of |
56 | ease of use. It is not physically possible to assemble | 56 | reasons, one being ease of use. It is not physically possible to |
57 | (legal) USB cables incorrectly: all upstream "to-the-host" | 57 | assemble (legal) USB cables incorrectly: all upstream "to the host" |
58 | connectors are the rectangular type, matching the sockets on | 58 | connectors are the rectangular type (matching the sockets on |
59 | root hubs, and the downstream type are the squarish type | 59 | root hubs), and all downstream connectors are the squarish type |
60 | (or they are built in to the peripheral). | 60 | (or they are built into the peripheral). |
61 | Software doesn't need to deal with distributed autoconfiguration | 61 | Also, the host software doesn't need to deal with distributed |
62 | since the pre-designated master node manages all that. | 62 | auto-configuration since the pre-designated master node manages all that. |
63 | At the electrical level, bus protocol overhead is reduced by | 63 | And finally, at the electrical level, bus protocol overhead is reduced by |
64 | eliminating arbitration and moving scheduling into host software. | 64 | eliminating arbitration and moving scheduling into the host software. |
65 | </para> | 65 | </para> |
66 | 66 | ||
67 | <para>USB 1.0 was announced in January 1996, and was revised | 67 | <para>USB 1.0 was announced in January 1996 and was revised |
68 | as USB 1.1 (with improvements in hub specification and | 68 | as USB 1.1 (with improvements in hub specification and |
69 | support for interrupt-out transfers) in September 1998. | 69 | support for interrupt-out transfers) in September 1998. |
70 | USB 2.0 was released in April 2000, including high speed | 70 | USB 2.0 was released in April 2000, adding high-speed |
71 | transfers and transaction translating hubs (used for USB 1.1 | 71 | transfers and transaction-translating hubs (used for USB 1.1 |
72 | and 1.0 backward compatibility). | 72 | and 1.0 backward compatibility). |
73 | </para> | 73 | </para> |
74 | 74 | ||
75 | <para>USB support was added to Linux early in the 2.2 kernel series | 75 | <para>Kernel developers added USB support to Linux early in the 2.2 kernel |
76 | shortly before the 2.3 development forked off. Updates | 76 | series, shortly before 2.3 development forked. Updates from 2.3 were |
77 | from 2.3 were regularly folded back into 2.2 releases, bringing | 77 | regularly folded back into 2.2 releases, which improved reliability and |
78 | new features such as <filename>/sbin/hotplug</filename> support, | 78 | brought <filename>/sbin/hotplug</filename> support as well more drivers. |
79 | more drivers, and more robustness. | 79 | Such improvements were continued in the 2.5 kernel series, where they added |
80 | The 2.5 kernel series continued such improvements, and also | 80 | USB 2.0 support, improved performance, and made the host controller drivers |
81 | worked on USB 2.0 support, | 81 | (HCDs) more consistent. They also simplified the API (to make bugs less |
82 | higher performance, | 82 | likely) and added internal "kerneldoc" documentation. |
83 | better consistency between host controller drivers, | ||
84 | API simplification (to make bugs less likely), | ||
85 | and providing internal "kerneldoc" documentation. | ||
86 | </para> | 83 | </para> |
87 | 84 | ||
88 | <para>Linux can run inside USB devices as well as on | 85 | <para>Linux can run inside USB devices as well as on |
89 | the hosts that control the devices. | 86 | the hosts that control the devices. |
90 | Because the Linux 2.x USB support evolved to support mass market | 87 | But USB device drivers running inside those peripherals |
91 | platforms such as Apple Macintosh or PC-compatible systems, | ||
92 | it didn't address design concerns for those types of USB systems. | ||
93 | So it can't be used inside mass-market PDAs, or other peripherals. | ||
94 | USB device drivers running inside those Linux peripherals | ||
95 | don't do the same things as the ones running inside hosts, | 88 | don't do the same things as the ones running inside hosts, |
96 | and so they've been given a different name: | 89 | so they've been given a different name: |
97 | they're called <emphasis>gadget drivers</emphasis>. | 90 | <emphasis>gadget drivers</emphasis>. |
98 | This document does not present gadget drivers. | 91 | This document does not cover gadget drivers. |
99 | </para> | 92 | </para> |
100 | 93 | ||
101 | </chapter> | 94 | </chapter> |
@@ -103,17 +96,14 @@ | |||
103 | <chapter id="host"> | 96 | <chapter id="host"> |
104 | <title>USB Host-Side API Model</title> | 97 | <title>USB Host-Side API Model</title> |
105 | 98 | ||
106 | <para>Within the kernel, | 99 | <para>Host-side drivers for USB devices talk to the "usbcore" APIs. |
107 | host-side drivers for USB devices talk to the "usbcore" APIs. | 100 | There are two. One is intended for |
108 | There are two types of public "usbcore" APIs, targetted at two different | 101 | <emphasis>general-purpose</emphasis> drivers (exposed through |
109 | layers of USB driver. Those are | 102 | driver frameworks), and the other is for drivers that are |
110 | <emphasis>general purpose</emphasis> drivers, exposed through | 103 | <emphasis>part of the core</emphasis>. |
111 | driver frameworks such as block, character, or network devices; | 104 | Such core drivers include the <emphasis>hub</emphasis> driver |
112 | and drivers that are <emphasis>part of the core</emphasis>, | 105 | (which manages trees of USB devices) and several different kinds |
113 | which are involved in managing a USB bus. | 106 | of <emphasis>host controller drivers</emphasis>, |
114 | Such core drivers include the <emphasis>hub</emphasis> driver, | ||
115 | which manages trees of USB devices, and several different kinds | ||
116 | of <emphasis>host controller driver (HCD)</emphasis>, | ||
117 | which control individual busses. | 107 | which control individual busses. |
118 | </para> | 108 | </para> |
119 | 109 | ||
@@ -122,21 +112,21 @@ | |||
122 | 112 | ||
123 | <itemizedlist> | 113 | <itemizedlist> |
124 | 114 | ||
125 | <listitem><para>USB supports four kinds of data transfer | 115 | <listitem><para>USB supports four kinds of data transfers |
126 | (control, bulk, interrupt, and isochronous). Two transfer | 116 | (control, bulk, interrupt, and isochronous). Two of them (control |
127 | types use bandwidth as it's available (control and bulk), | 117 | and bulk) use bandwidth as it's available, |
128 | while the other two types of transfer (interrupt and isochronous) | 118 | while the other two (interrupt and isochronous) |
129 | are scheduled to provide guaranteed bandwidth. | 119 | are scheduled to provide guaranteed bandwidth. |
130 | </para></listitem> | 120 | </para></listitem> |
131 | 121 | ||
132 | <listitem><para>The device description model includes one or more | 122 | <listitem><para>The device description model includes one or more |
133 | "configurations" per device, only one of which is active at a time. | 123 | "configurations" per device, only one of which is active at a time. |
134 | Devices that are capable of high speed operation must also support | 124 | Devices that are capable of high-speed operation must also support |
135 | full speed configurations, along with a way to ask about the | 125 | full-speed configurations, along with a way to ask about the |
136 | "other speed" configurations that might be used. | 126 | "other speed" configurations which might be used. |
137 | </para></listitem> | 127 | </para></listitem> |
138 | 128 | ||
139 | <listitem><para>Configurations have one or more "interface", each | 129 | <listitem><para>Configurations have one or more "interfaces", each |
140 | of which may have "alternate settings". Interfaces may be | 130 | of which may have "alternate settings". Interfaces may be |
141 | standardized by USB "Class" specifications, or may be specific to | 131 | standardized by USB "Class" specifications, or may be specific to |
142 | a vendor or device.</para> | 132 | a vendor or device.</para> |
@@ -162,7 +152,7 @@ | |||
162 | </para></listitem> | 152 | </para></listitem> |
163 | 153 | ||
164 | <listitem><para>The Linux USB API supports synchronous calls for | 154 | <listitem><para>The Linux USB API supports synchronous calls for |
165 | control and bulk messaging. | 155 | control and bulk messages. |
166 | It also supports asynchnous calls for all kinds of data transfer, | 156 | It also supports asynchnous calls for all kinds of data transfer, |
167 | using request structures called "URBs" (USB Request Blocks). | 157 | using request structures called "URBs" (USB Request Blocks). |
168 | </para></listitem> | 158 | </para></listitem> |
@@ -463,14 +453,25 @@ | |||
463 | file in your Linux kernel sources. | 453 | file in your Linux kernel sources. |
464 | </para> | 454 | </para> |
465 | 455 | ||
466 | <para>Otherwise the main use for this file from programs | 456 | <para>This file, in combination with the poll() system call, can |
467 | is to poll() it to get notifications of usb devices | 457 | also be used to detect when devices are added or removed: |
468 | as they're plugged or unplugged. | 458 | <programlisting>int fd; |
469 | To see what changed, you'd need to read the file and | 459 | struct pollfd pfd; |
470 | compare "before" and "after" contents, scan the filesystem, | 460 | |
471 | or see its hotplug event. | 461 | fd = open("/proc/bus/usb/devices", O_RDONLY); |
462 | pfd = { fd, POLLIN, 0 }; | ||
463 | for (;;) { | ||
464 | /* The first time through, this call will return immediately. */ | ||
465 | poll(&pfd, 1, -1); | ||
466 | |||
467 | /* To see what's changed, compare the file's previous and current | ||
468 | contents or scan the filesystem. (Scanning is more precise.) */ | ||
469 | }</programlisting> | ||
470 | Note that this behavior is intended to be used for informational | ||
471 | and debug purposes. It would be more appropriate to use programs | ||
472 | such as udev or HAL to initialize a device or start a user-mode | ||
473 | helper program, for instance. | ||
472 | </para> | 474 | </para> |
473 | |||
474 | </sect1> | 475 | </sect1> |
475 | 476 | ||
476 | <sect1> | 477 | <sect1> |
diff --git a/Documentation/HOWTO b/Documentation/HOWTO index 915ae8c986c6..d6f3dd1a3464 100644 --- a/Documentation/HOWTO +++ b/Documentation/HOWTO | |||
@@ -358,7 +358,8 @@ Here is a list of some of the different kernel trees available: | |||
358 | quilt trees: | 358 | quilt trees: |
359 | - USB, PCI, Driver Core, and I2C, Greg Kroah-Hartman <gregkh@suse.de> | 359 | - USB, PCI, Driver Core, and I2C, Greg Kroah-Hartman <gregkh@suse.de> |
360 | kernel.org/pub/linux/kernel/people/gregkh/gregkh-2.6/ | 360 | kernel.org/pub/linux/kernel/people/gregkh/gregkh-2.6/ |
361 | 361 | - x86-64, partly i386, Andi Kleen <ak@suse.de> | |
362 | ftp.firstfloor.org:/pub/ak/x86_64/quilt/ | ||
362 | 363 | ||
363 | Bug Reporting | 364 | Bug Reporting |
364 | ------------- | 365 | ------------- |
@@ -374,6 +375,26 @@ of information is needed by the kernel developers to help track down the | |||
374 | problem. | 375 | problem. |
375 | 376 | ||
376 | 377 | ||
378 | Managing bug reports | ||
379 | -------------------- | ||
380 | |||
381 | One of the best ways to put into practice your hacking skills is by fixing | ||
382 | bugs reported by other people. Not only you will help to make the kernel | ||
383 | more stable, you'll learn to fix real world problems and you will improve | ||
384 | your skills, and other developers will be aware of your presence. Fixing | ||
385 | bugs is one of the best ways to earn merit amongst the developers, because | ||
386 | not many people like wasting time fixing other people's bugs. | ||
387 | |||
388 | To work in the already reported bug reports, go to http://bugzilla.kernel.org. | ||
389 | If you want to be advised of the future bug reports, you can subscribe to the | ||
390 | bugme-new mailing list (only new bug reports are mailed here) or to the | ||
391 | bugme-janitor mailing list (every change in the bugzilla is mailed here) | ||
392 | |||
393 | http://lists.osdl.org/mailman/listinfo/bugme-new | ||
394 | http://lists.osdl.org/mailman/listinfo/bugme-janitors | ||
395 | |||
396 | |||
397 | |||
377 | Mailing lists | 398 | Mailing lists |
378 | ------------- | 399 | ------------- |
379 | 400 | ||
diff --git a/Documentation/IPMI.txt b/Documentation/IPMI.txt index 0256805b548f..9f08d73d90bf 100644 --- a/Documentation/IPMI.txt +++ b/Documentation/IPMI.txt | |||
@@ -326,9 +326,12 @@ for events, they will all receive all events that come in. | |||
326 | 326 | ||
327 | For receiving commands, you have to individually register commands you | 327 | For receiving commands, you have to individually register commands you |
328 | want to receive. Call ipmi_register_for_cmd() and supply the netfn | 328 | want to receive. Call ipmi_register_for_cmd() and supply the netfn |
329 | and command name for each command you want to receive. Only one user | 329 | and command name for each command you want to receive. You also |
330 | may be registered for each netfn/cmd, but different users may register | 330 | specify a bitmask of the channels you want to receive the command from |
331 | for different commands. | 331 | (or use IPMI_CHAN_ALL for all channels if you don't care). Only one |
332 | user may be registered for each netfn/cmd/channel, but different users | ||
333 | may register for different commands, or the same command if the | ||
334 | channel bitmasks do not overlap. | ||
332 | 335 | ||
333 | From userland, equivalent IOCTLs are provided to do these functions. | 336 | From userland, equivalent IOCTLs are provided to do these functions. |
334 | 337 | ||
@@ -361,6 +364,7 @@ You can change this at module load time (for a module) with: | |||
361 | regspacings=<sp1>,<sp2>,... regsizes=<size1>,<size2>,... | 364 | regspacings=<sp1>,<sp2>,... regsizes=<size1>,<size2>,... |
362 | regshifts=<shift1>,<shift2>,... | 365 | regshifts=<shift1>,<shift2>,... |
363 | slave_addrs=<addr1>,<addr2>,... | 366 | slave_addrs=<addr1>,<addr2>,... |
367 | force_kipmid=<enable1>,<enable2>,... | ||
364 | 368 | ||
365 | Each of these except si_trydefaults is a list, the first item for the | 369 | Each of these except si_trydefaults is a list, the first item for the |
366 | first interface, second item for the second interface, etc. | 370 | first interface, second item for the second interface, etc. |
@@ -406,7 +410,13 @@ The slave_addrs specifies the IPMI address of the local BMC. This is | |||
406 | usually 0x20 and the driver defaults to that, but in case it's not, it | 410 | usually 0x20 and the driver defaults to that, but in case it's not, it |
407 | can be specified when the driver starts up. | 411 | can be specified when the driver starts up. |
408 | 412 | ||
409 | When compiled into the kernel, the addresses can be specified on the | 413 | The force_ipmid parameter forcefully enables (if set to 1) or disables |
414 | (if set to 0) the kernel IPMI daemon. Normally this is auto-detected | ||
415 | by the driver, but systems with broken interrupts might need an enable, | ||
416 | or users that don't want the daemon (don't need the performance, don't | ||
417 | want the CPU hit) can disable it. | ||
418 | |||
419 | When compiled into the kernel, the parameters can be specified on the | ||
410 | kernel command line as: | 420 | kernel command line as: |
411 | 421 | ||
412 | ipmi_si.type=<type1>,<type2>... | 422 | ipmi_si.type=<type1>,<type2>... |
@@ -416,6 +426,7 @@ kernel command line as: | |||
416 | ipmi_si.regsizes=<size1>,<size2>,... | 426 | ipmi_si.regsizes=<size1>,<size2>,... |
417 | ipmi_si.regshifts=<shift1>,<shift2>,... | 427 | ipmi_si.regshifts=<shift1>,<shift2>,... |
418 | ipmi_si.slave_addrs=<addr1>,<addr2>,... | 428 | ipmi_si.slave_addrs=<addr1>,<addr2>,... |
429 | ipmi_si.force_kipmid=<enable1>,<enable2>,... | ||
419 | 430 | ||
420 | It works the same as the module parameters of the same names. | 431 | It works the same as the module parameters of the same names. |
421 | 432 | ||
diff --git a/Documentation/SubmitChecklist b/Documentation/SubmitChecklist index a10bfb6ecd9f..7ac61f60037a 100644 --- a/Documentation/SubmitChecklist +++ b/Documentation/SubmitChecklist | |||
@@ -61,3 +61,8 @@ kernel patches. | |||
61 | Documentation/kernel-parameters.txt. | 61 | Documentation/kernel-parameters.txt. |
62 | 62 | ||
63 | 18: All new module parameters are documented with MODULE_PARM_DESC() | 63 | 18: All new module parameters are documented with MODULE_PARM_DESC() |
64 | |||
65 | 19: All new userspace interfaces are documented in Documentation/ABI/. | ||
66 | See Documentation/ABI/README for more information. | ||
67 | |||
68 | 20: Check that it all passes `make headers_check'. | ||
diff --git a/Documentation/SubmittingDrivers b/Documentation/SubmittingDrivers index 6bd30fdd0786..58bead05eabb 100644 --- a/Documentation/SubmittingDrivers +++ b/Documentation/SubmittingDrivers | |||
@@ -59,11 +59,11 @@ Copyright: The copyright owner must agree to use of GPL. | |||
59 | are the same person/entity. If not, the name of | 59 | are the same person/entity. If not, the name of |
60 | the person/entity authorizing use of GPL should be | 60 | the person/entity authorizing use of GPL should be |
61 | listed in case it's necessary to verify the will of | 61 | listed in case it's necessary to verify the will of |
62 | the copright owner. | 62 | the copyright owner. |
63 | 63 | ||
64 | Interfaces: If your driver uses existing interfaces and behaves like | 64 | Interfaces: If your driver uses existing interfaces and behaves like |
65 | other drivers in the same class it will be much more likely | 65 | other drivers in the same class it will be much more likely |
66 | to be accepted than if it invents gratuitous new ones. | 66 | to be accepted than if it invents gratuitous new ones. |
67 | If you need to implement a common API over Linux and NT | 67 | If you need to implement a common API over Linux and NT |
68 | drivers do it in userspace. | 68 | drivers do it in userspace. |
69 | 69 | ||
@@ -88,7 +88,7 @@ Clarity: It helps if anyone can see how to fix the driver. It helps | |||
88 | it will go in the bitbucket. | 88 | it will go in the bitbucket. |
89 | 89 | ||
90 | Control: In general if there is active maintainance of a driver by | 90 | Control: In general if there is active maintainance of a driver by |
91 | the author then patches will be redirected to them unless | 91 | the author then patches will be redirected to them unless |
92 | they are totally obvious and without need of checking. | 92 | they are totally obvious and without need of checking. |
93 | If you want to be the contact and update point for the | 93 | If you want to be the contact and update point for the |
94 | driver it is a good idea to state this in the comments, | 94 | driver it is a good idea to state this in the comments, |
@@ -100,7 +100,7 @@ What Criteria Do Not Determine Acceptance | |||
100 | Vendor: Being the hardware vendor and maintaining the driver is | 100 | Vendor: Being the hardware vendor and maintaining the driver is |
101 | often a good thing. If there is a stable working driver from | 101 | often a good thing. If there is a stable working driver from |
102 | other people already in the tree don't expect 'we are the | 102 | other people already in the tree don't expect 'we are the |
103 | vendor' to get your driver chosen. Ideally work with the | 103 | vendor' to get your driver chosen. Ideally work with the |
104 | existing driver author to build a single perfect driver. | 104 | existing driver author to build a single perfect driver. |
105 | 105 | ||
106 | Author: It doesn't matter if a large Linux company wrote the driver, | 106 | Author: It doesn't matter if a large Linux company wrote the driver, |
@@ -116,17 +116,13 @@ Linux kernel master tree: | |||
116 | ftp.??.kernel.org:/pub/linux/kernel/... | 116 | ftp.??.kernel.org:/pub/linux/kernel/... |
117 | ?? == your country code, such as "us", "uk", "fr", etc. | 117 | ?? == your country code, such as "us", "uk", "fr", etc. |
118 | 118 | ||
119 | Linux kernel mailing list: | 119 | Linux kernel mailing list: |
120 | linux-kernel@vger.kernel.org | 120 | linux-kernel@vger.kernel.org |
121 | [mail majordomo@vger.kernel.org to subscribe] | 121 | [mail majordomo@vger.kernel.org to subscribe] |
122 | 122 | ||
123 | Linux Device Drivers, Third Edition (covers 2.6.10): | 123 | Linux Device Drivers, Third Edition (covers 2.6.10): |
124 | http://lwn.net/Kernel/LDD3/ (free version) | 124 | http://lwn.net/Kernel/LDD3/ (free version) |
125 | 125 | ||
126 | Kernel traffic: | ||
127 | Weekly summary of kernel list activity (much easier to read) | ||
128 | http://www.kerneltraffic.org/kernel-traffic/ | ||
129 | |||
130 | LWN.net: | 126 | LWN.net: |
131 | Weekly summary of kernel development activity - http://lwn.net/ | 127 | Weekly summary of kernel development activity - http://lwn.net/ |
132 | 2.6 API changes: | 128 | 2.6 API changes: |
@@ -145,11 +141,8 @@ KernelNewbies: | |||
145 | Linux USB project: | 141 | Linux USB project: |
146 | http://www.linux-usb.org/ | 142 | http://www.linux-usb.org/ |
147 | 143 | ||
148 | How to NOT write kernel driver by arjanv@redhat.com | 144 | How to NOT write kernel driver by Arjan van de Ven: |
149 | http://people.redhat.com/arjanv/olspaper.pdf | 145 | http://www.fenrus.org/how-to-not-write-a-device-driver-paper.pdf |
150 | 146 | ||
151 | Kernel Janitor: | 147 | Kernel Janitor: |
152 | http://janitor.kernelnewbies.org/ | 148 | http://janitor.kernelnewbies.org/ |
153 | |||
154 | -- | ||
155 | Last updated on 17 Nov 2005. | ||
diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches index d42ab4c9e893..302d148c2e18 100644 --- a/Documentation/SubmittingPatches +++ b/Documentation/SubmittingPatches | |||
@@ -173,15 +173,15 @@ For small patches you may want to CC the Trivial Patch Monkey | |||
173 | trivial@kernel.org managed by Adrian Bunk; which collects "trivial" | 173 | trivial@kernel.org managed by Adrian Bunk; which collects "trivial" |
174 | patches. Trivial patches must qualify for one of the following rules: | 174 | patches. Trivial patches must qualify for one of the following rules: |
175 | Spelling fixes in documentation | 175 | Spelling fixes in documentation |
176 | Spelling fixes which could break grep(1). | 176 | Spelling fixes which could break grep(1) |
177 | Warning fixes (cluttering with useless warnings is bad) | 177 | Warning fixes (cluttering with useless warnings is bad) |
178 | Compilation fixes (only if they are actually correct) | 178 | Compilation fixes (only if they are actually correct) |
179 | Runtime fixes (only if they actually fix things) | 179 | Runtime fixes (only if they actually fix things) |
180 | Removing use of deprecated functions/macros (eg. check_region). | 180 | Removing use of deprecated functions/macros (eg. check_region) |
181 | Contact detail and documentation fixes | 181 | Contact detail and documentation fixes |
182 | Non-portable code replaced by portable code (even in arch-specific, | 182 | Non-portable code replaced by portable code (even in arch-specific, |
183 | since people copy, as long as it's trivial) | 183 | since people copy, as long as it's trivial) |
184 | Any fix by the author/maintainer of the file. (ie. patch monkey | 184 | Any fix by the author/maintainer of the file (ie. patch monkey |
185 | in re-transmission mode) | 185 | in re-transmission mode) |
186 | URL: <http://www.kernel.org/pub/linux/kernel/people/bunk/trivial/> | 186 | URL: <http://www.kernel.org/pub/linux/kernel/people/bunk/trivial/> |
187 | 187 | ||
@@ -209,6 +209,19 @@ Exception: If your mailer is mangling patches then someone may ask | |||
209 | you to re-send them using MIME. | 209 | you to re-send them using MIME. |
210 | 210 | ||
211 | 211 | ||
212 | WARNING: Some mailers like Mozilla send your messages with | ||
213 | ---- message header ---- | ||
214 | Content-Type: text/plain; charset=us-ascii; format=flowed | ||
215 | ---- message header ---- | ||
216 | The problem is that "format=flowed" makes some of the mailers | ||
217 | on receiving side to replace TABs with spaces and do similar | ||
218 | changes. Thus the patches from you can look corrupted. | ||
219 | |||
220 | To fix this just make your mozilla defaults/pref/mailnews.js file to look like: | ||
221 | pref("mailnews.send_plaintext_flowed", false); // RFC 2646======= | ||
222 | pref("mailnews.display.disable_format_flowed_support", true); | ||
223 | |||
224 | |||
212 | 225 | ||
213 | 7) E-mail size. | 226 | 7) E-mail size. |
214 | 227 | ||
@@ -245,13 +258,13 @@ updated change. | |||
245 | It is quite common for Linus to "drop" your patch without comment. | 258 | It is quite common for Linus to "drop" your patch without comment. |
246 | That's the nature of the system. If he drops your patch, it could be | 259 | That's the nature of the system. If he drops your patch, it could be |
247 | due to | 260 | due to |
248 | * Your patch did not apply cleanly to the latest kernel version | 261 | * Your patch did not apply cleanly to the latest kernel version. |
249 | * Your patch was not sufficiently discussed on linux-kernel. | 262 | * Your patch was not sufficiently discussed on linux-kernel. |
250 | * A style issue (see section 2), | 263 | * A style issue (see section 2). |
251 | * An e-mail formatting issue (re-read this section) | 264 | * An e-mail formatting issue (re-read this section). |
252 | * A technical problem with your change | 265 | * A technical problem with your change. |
253 | * He gets tons of e-mail, and yours got lost in the shuffle | 266 | * He gets tons of e-mail, and yours got lost in the shuffle. |
254 | * You are being annoying (See Figure 1) | 267 | * You are being annoying. |
255 | 268 | ||
256 | When in doubt, solicit comments on linux-kernel mailing list. | 269 | When in doubt, solicit comments on linux-kernel mailing list. |
257 | 270 | ||
@@ -476,10 +489,10 @@ SECTION 3 - REFERENCES | |||
476 | Andrew Morton, "The perfect patch" (tpp). | 489 | Andrew Morton, "The perfect patch" (tpp). |
477 | <http://www.zip.com.au/~akpm/linux/patches/stuff/tpp.txt> | 490 | <http://www.zip.com.au/~akpm/linux/patches/stuff/tpp.txt> |
478 | 491 | ||
479 | Jeff Garzik, "Linux kernel patch submission format." | 492 | Jeff Garzik, "Linux kernel patch submission format". |
480 | <http://linux.yyz.us/patch-format.html> | 493 | <http://linux.yyz.us/patch-format.html> |
481 | 494 | ||
482 | Greg Kroah-Hartman "How to piss off a kernel subsystem maintainer". | 495 | Greg Kroah-Hartman, "How to piss off a kernel subsystem maintainer". |
483 | <http://www.kroah.com/log/2005/03/31/> | 496 | <http://www.kroah.com/log/2005/03/31/> |
484 | <http://www.kroah.com/log/2005/07/08/> | 497 | <http://www.kroah.com/log/2005/07/08/> |
485 | <http://www.kroah.com/log/2005/10/19/> | 498 | <http://www.kroah.com/log/2005/10/19/> |
@@ -488,9 +501,9 @@ Greg Kroah-Hartman "How to piss off a kernel subsystem maintainer". | |||
488 | NO!!!! No more huge patch bombs to linux-kernel@vger.kernel.org people! | 501 | NO!!!! No more huge patch bombs to linux-kernel@vger.kernel.org people! |
489 | <http://marc.theaimsgroup.com/?l=linux-kernel&m=112112749912944&w=2> | 502 | <http://marc.theaimsgroup.com/?l=linux-kernel&m=112112749912944&w=2> |
490 | 503 | ||
491 | Kernel Documentation/CodingStyle | 504 | Kernel Documentation/CodingStyle: |
492 | <http://sosdg.org/~coywolf/lxr/source/Documentation/CodingStyle> | 505 | <http://sosdg.org/~coywolf/lxr/source/Documentation/CodingStyle> |
493 | 506 | ||
494 | Linus Torvald's mail on the canonical patch format: | 507 | Linus Torvalds's mail on the canonical patch format: |
495 | <http://lkml.org/lkml/2005/4/7/183> | 508 | <http://lkml.org/lkml/2005/4/7/183> |
496 | -- | 509 | -- |
diff --git a/Documentation/accounting/getdelays.c b/Documentation/accounting/getdelays.c index 795ca3911cc5..b11792abd6b6 100644 --- a/Documentation/accounting/getdelays.c +++ b/Documentation/accounting/getdelays.c | |||
@@ -285,7 +285,7 @@ int main(int argc, char *argv[]) | |||
285 | if (maskset) { | 285 | if (maskset) { |
286 | rc = send_cmd(nl_sd, id, mypid, TASKSTATS_CMD_GET, | 286 | rc = send_cmd(nl_sd, id, mypid, TASKSTATS_CMD_GET, |
287 | TASKSTATS_CMD_ATTR_REGISTER_CPUMASK, | 287 | TASKSTATS_CMD_ATTR_REGISTER_CPUMASK, |
288 | &cpumask, sizeof(cpumask)); | 288 | &cpumask, strlen(cpumask) + 1); |
289 | PRINTF("Sent register cpumask, retval %d\n", rc); | 289 | PRINTF("Sent register cpumask, retval %d\n", rc); |
290 | if (rc < 0) { | 290 | if (rc < 0) { |
291 | printf("error sending register cpumask\n"); | 291 | printf("error sending register cpumask\n"); |
@@ -315,7 +315,8 @@ int main(int argc, char *argv[]) | |||
315 | } | 315 | } |
316 | if (msg.n.nlmsg_type == NLMSG_ERROR || | 316 | if (msg.n.nlmsg_type == NLMSG_ERROR || |
317 | !NLMSG_OK((&msg.n), rep_len)) { | 317 | !NLMSG_OK((&msg.n), rep_len)) { |
318 | printf("fatal reply error, errno %d\n", errno); | 318 | struct nlmsgerr *err = NLMSG_DATA(&msg); |
319 | printf("fatal reply error, errno %d\n", err->error); | ||
319 | goto done; | 320 | goto done; |
320 | } | 321 | } |
321 | 322 | ||
@@ -383,7 +384,7 @@ done: | |||
383 | if (maskset) { | 384 | if (maskset) { |
384 | rc = send_cmd(nl_sd, id, mypid, TASKSTATS_CMD_GET, | 385 | rc = send_cmd(nl_sd, id, mypid, TASKSTATS_CMD_GET, |
385 | TASKSTATS_CMD_ATTR_DEREGISTER_CPUMASK, | 386 | TASKSTATS_CMD_ATTR_DEREGISTER_CPUMASK, |
386 | &cpumask, sizeof(cpumask)); | 387 | &cpumask, strlen(cpumask) + 1); |
387 | printf("Sent deregister mask, retval %d\n", rc); | 388 | printf("Sent deregister mask, retval %d\n", rc); |
388 | if (rc < 0) | 389 | if (rc < 0) |
389 | err(rc, "error sending deregister cpumask\n"); | 390 | err(rc, "error sending deregister cpumask\n"); |
diff --git a/Documentation/accounting/taskstats-struct.txt b/Documentation/accounting/taskstats-struct.txt new file mode 100644 index 000000000000..661c797eaf79 --- /dev/null +++ b/Documentation/accounting/taskstats-struct.txt | |||
@@ -0,0 +1,161 @@ | |||
1 | The struct taskstats | ||
2 | -------------------- | ||
3 | |||
4 | This document contains an explanation of the struct taskstats fields. | ||
5 | |||
6 | There are three different groups of fields in the struct taskstats: | ||
7 | |||
8 | 1) Common and basic accounting fields | ||
9 | If CONFIG_TASKSTATS is set, the taskstats inteface is enabled and | ||
10 | the common fields and basic accounting fields are collected for | ||
11 | delivery at do_exit() of a task. | ||
12 | 2) Delay accounting fields | ||
13 | These fields are placed between | ||
14 | /* Delay accounting fields start */ | ||
15 | and | ||
16 | /* Delay accounting fields end */ | ||
17 | Their values are collected if CONFIG_TASK_DELAY_ACCT is set. | ||
18 | 3) Extended accounting fields | ||
19 | These fields are placed between | ||
20 | /* Extended accounting fields start */ | ||
21 | and | ||
22 | /* Extended accounting fields end */ | ||
23 | Their values are collected if CONFIG_TASK_XACCT is set. | ||
24 | |||
25 | Future extension should add fields to the end of the taskstats struct, and | ||
26 | should not change the relative position of each field within the struct. | ||
27 | |||
28 | |||
29 | struct taskstats { | ||
30 | |||
31 | 1) Common and basic accounting fields: | ||
32 | /* The version number of this struct. This field is always set to | ||
33 | * TAKSTATS_VERSION, which is defined in <linux/taskstats.h>. | ||
34 | * Each time the struct is changed, the value should be incremented. | ||
35 | */ | ||
36 | __u16 version; | ||
37 | |||
38 | /* The exit code of a task. */ | ||
39 | __u32 ac_exitcode; /* Exit status */ | ||
40 | |||
41 | /* The accounting flags of a task as defined in <linux/acct.h> | ||
42 | * Defined values are AFORK, ASU, ACOMPAT, ACORE, and AXSIG. | ||
43 | */ | ||
44 | __u8 ac_flag; /* Record flags */ | ||
45 | |||
46 | /* The value of task_nice() of a task. */ | ||
47 | __u8 ac_nice; /* task_nice */ | ||
48 | |||
49 | /* The name of the command that started this task. */ | ||
50 | char ac_comm[TS_COMM_LEN]; /* Command name */ | ||
51 | |||
52 | /* The scheduling discipline as set in task->policy field. */ | ||
53 | __u8 ac_sched; /* Scheduling discipline */ | ||
54 | |||
55 | __u8 ac_pad[3]; | ||
56 | __u32 ac_uid; /* User ID */ | ||
57 | __u32 ac_gid; /* Group ID */ | ||
58 | __u32 ac_pid; /* Process ID */ | ||
59 | __u32 ac_ppid; /* Parent process ID */ | ||
60 | |||
61 | /* The time when a task begins, in [secs] since 1970. */ | ||
62 | __u32 ac_btime; /* Begin time [sec since 1970] */ | ||
63 | |||
64 | /* The elapsed time of a task, in [usec]. */ | ||
65 | __u64 ac_etime; /* Elapsed time [usec] */ | ||
66 | |||
67 | /* The user CPU time of a task, in [usec]. */ | ||
68 | __u64 ac_utime; /* User CPU time [usec] */ | ||
69 | |||
70 | /* The system CPU time of a task, in [usec]. */ | ||
71 | __u64 ac_stime; /* System CPU time [usec] */ | ||
72 | |||
73 | /* The minor page fault count of a task, as set in task->min_flt. */ | ||
74 | __u64 ac_minflt; /* Minor Page Fault Count */ | ||
75 | |||
76 | /* The major page fault count of a task, as set in task->maj_flt. */ | ||
77 | __u64 ac_majflt; /* Major Page Fault Count */ | ||
78 | |||
79 | |||
80 | 2) Delay accounting fields: | ||
81 | /* Delay accounting fields start | ||
82 | * | ||
83 | * All values, until the comment "Delay accounting fields end" are | ||
84 | * available only if delay accounting is enabled, even though the last | ||
85 | * few fields are not delays | ||
86 | * | ||
87 | * xxx_count is the number of delay values recorded | ||
88 | * xxx_delay_total is the corresponding cumulative delay in nanoseconds | ||
89 | * | ||
90 | * xxx_delay_total wraps around to zero on overflow | ||
91 | * xxx_count incremented regardless of overflow | ||
92 | */ | ||
93 | |||
94 | /* Delay waiting for cpu, while runnable | ||
95 | * count, delay_total NOT updated atomically | ||
96 | */ | ||
97 | __u64 cpu_count; | ||
98 | __u64 cpu_delay_total; | ||
99 | |||
100 | /* Following four fields atomically updated using task->delays->lock */ | ||
101 | |||
102 | /* Delay waiting for synchronous block I/O to complete | ||
103 | * does not account for delays in I/O submission | ||
104 | */ | ||
105 | __u64 blkio_count; | ||
106 | __u64 blkio_delay_total; | ||
107 | |||
108 | /* Delay waiting for page fault I/O (swap in only) */ | ||
109 | __u64 swapin_count; | ||
110 | __u64 swapin_delay_total; | ||
111 | |||
112 | /* cpu "wall-clock" running time | ||
113 | * On some architectures, value will adjust for cpu time stolen | ||
114 | * from the kernel in involuntary waits due to virtualization. | ||
115 | * Value is cumulative, in nanoseconds, without a corresponding count | ||
116 | * and wraps around to zero silently on overflow | ||
117 | */ | ||
118 | __u64 cpu_run_real_total; | ||
119 | |||
120 | /* cpu "virtual" running time | ||
121 | * Uses time intervals seen by the kernel i.e. no adjustment | ||
122 | * for kernel's involuntary waits due to virtualization. | ||
123 | * Value is cumulative, in nanoseconds, without a corresponding count | ||
124 | * and wraps around to zero silently on overflow | ||
125 | */ | ||
126 | __u64 cpu_run_virtual_total; | ||
127 | /* Delay accounting fields end */ | ||
128 | /* version 1 ends here */ | ||
129 | |||
130 | |||
131 | 3) Extended accounting fields | ||
132 | /* Extended accounting fields start */ | ||
133 | |||
134 | /* Accumulated RSS usage in duration of a task, in MBytes-usecs. | ||
135 | * The current rss usage is added to this counter every time | ||
136 | * a tick is charged to a task's system time. So, at the end we | ||
137 | * will have memory usage multiplied by system time. Thus an | ||
138 | * average usage per system time unit can be calculated. | ||
139 | */ | ||
140 | __u64 coremem; /* accumulated RSS usage in MB-usec */ | ||
141 | |||
142 | /* Accumulated virtual memory usage in duration of a task. | ||
143 | * Same as acct_rss_mem1 above except that we keep track of VM usage. | ||
144 | */ | ||
145 | __u64 virtmem; /* accumulated VM usage in MB-usec */ | ||
146 | |||
147 | /* High watermark of RSS usage in duration of a task, in KBytes. */ | ||
148 | __u64 hiwater_rss; /* High-watermark of RSS usage */ | ||
149 | |||
150 | /* High watermark of VM usage in duration of a task, in KBytes. */ | ||
151 | __u64 hiwater_vm; /* High-water virtual memory usage */ | ||
152 | |||
153 | /* The following four fields are I/O statistics of a task. */ | ||
154 | __u64 read_char; /* bytes read */ | ||
155 | __u64 write_char; /* bytes written */ | ||
156 | __u64 read_syscalls; /* read syscalls */ | ||
157 | __u64 write_syscalls; /* write syscalls */ | ||
158 | |||
159 | /* Extended accounting fields end */ | ||
160 | |||
161 | } | ||
diff --git a/Documentation/cpusets.txt b/Documentation/cpusets.txt index 76b44290c154..842f0d1ab216 100644 --- a/Documentation/cpusets.txt +++ b/Documentation/cpusets.txt | |||
@@ -217,11 +217,11 @@ exclusive cpuset. Also, the use of a Linux virtual file system (vfs) | |||
217 | to represent the cpuset hierarchy provides for a familiar permission | 217 | to represent the cpuset hierarchy provides for a familiar permission |
218 | and name space for cpusets, with a minimum of additional kernel code. | 218 | and name space for cpusets, with a minimum of additional kernel code. |
219 | 219 | ||
220 | The cpus file in the root (top_cpuset) cpuset is read-only. | 220 | The cpus and mems files in the root (top_cpuset) cpuset are |
221 | It automatically tracks the value of cpu_online_map, using a CPU | 221 | read-only. The cpus file automatically tracks the value of |
222 | hotplug notifier. If and when memory nodes can be hotplugged, | 222 | cpu_online_map using a CPU hotplug notifier, and the mems file |
223 | we expect to make the mems file in the root cpuset read-only | 223 | automatically tracks the value of node_online_map using the |
224 | as well, and have it track the value of node_online_map. | 224 | cpuset_track_online_nodes() hook. |
225 | 225 | ||
226 | 226 | ||
227 | 1.4 What are exclusive cpusets ? | 227 | 1.4 What are exclusive cpusets ? |
diff --git a/Documentation/devices.txt b/Documentation/devices.txt index 66c725f530f3..addc67b1d770 100644 --- a/Documentation/devices.txt +++ b/Documentation/devices.txt | |||
@@ -2543,6 +2543,9 @@ Your cooperation is appreciated. | |||
2543 | 64 = /dev/usb/rio500 Diamond Rio 500 | 2543 | 64 = /dev/usb/rio500 Diamond Rio 500 |
2544 | 65 = /dev/usb/usblcd USBLCD Interface (info@usblcd.de) | 2544 | 65 = /dev/usb/usblcd USBLCD Interface (info@usblcd.de) |
2545 | 66 = /dev/usb/cpad0 Synaptics cPad (mouse/LCD) | 2545 | 66 = /dev/usb/cpad0 Synaptics cPad (mouse/LCD) |
2546 | 67 = /dev/usb/adutux0 1st Ontrak ADU device | ||
2547 | ... | ||
2548 | 76 = /dev/usb/adutux10 10th Ontrak ADU device | ||
2546 | 96 = /dev/usb/hiddev0 1st USB HID device | 2549 | 96 = /dev/usb/hiddev0 1st USB HID device |
2547 | ... | 2550 | ... |
2548 | 111 = /dev/usb/hiddev15 16th USB HID device | 2551 | 111 = /dev/usb/hiddev15 16th USB HID device |
diff --git a/Documentation/fb/intel810.txt b/Documentation/fb/intel810.txt index 4f0d6bc789ef..be3e7836abef 100644 --- a/Documentation/fb/intel810.txt +++ b/Documentation/fb/intel810.txt | |||
@@ -9,8 +9,9 @@ Intel 810/815 Framebuffer driver | |||
9 | ================================================================ | 9 | ================================================================ |
10 | 10 | ||
11 | A. Introduction | 11 | A. Introduction |
12 | |||
12 | This is a framebuffer driver for various Intel 810/815 compatible | 13 | This is a framebuffer driver for various Intel 810/815 compatible |
13 | graphics devices. These would include: | 14 | graphics devices. These include: |
14 | 15 | ||
15 | Intel 810 | 16 | Intel 810 |
16 | Intel 810E | 17 | Intel 810E |
@@ -21,136 +22,136 @@ graphics devices. These would include: | |||
21 | 22 | ||
22 | B. Features | 23 | B. Features |
23 | 24 | ||
24 | - Choice of using Discrete Video Timings, VESA Generalized Timing | 25 | - Choice of using Discrete Video Timings, VESA Generalized Timing |
25 | Formula, or a framebuffer specific database to set the video mode | 26 | Formula, or a framebuffer specific database to set the video mode |
26 | 27 | ||
27 | - Supports a variable range of horizontal and vertical resolution, and | 28 | - Supports a variable range of horizontal and vertical resolution and |
28 | vertical refresh rates if the VESA Generalized Timing Formula is | 29 | vertical refresh rates if the VESA Generalized Timing Formula is |
29 | enabled. | 30 | enabled. |
30 | 31 | ||
31 | - Supports color depths of 8, 16, 24 and 32 bits per pixel | 32 | - Supports color depths of 8, 16, 24 and 32 bits per pixel |
32 | 33 | ||
33 | - Supports pseudocolor, directcolor, or truecolor visuals | 34 | - Supports pseudocolor, directcolor, or truecolor visuals |
34 | 35 | ||
35 | - Full and optimized hardware acceleration at 8, 16 and 24 bpp | 36 | - Full and optimized hardware acceleration at 8, 16 and 24 bpp |
36 | 37 | ||
37 | - Robust video state save and restore | 38 | - Robust video state save and restore |
38 | 39 | ||
39 | - MTRR support | 40 | - MTRR support |
40 | 41 | ||
41 | - Utilizes user-entered monitor specifications to automatically | 42 | - Utilizes user-entered monitor specifications to automatically |
42 | calculate required video mode parameters. | 43 | calculate required video mode parameters. |
43 | 44 | ||
44 | - Can concurrently run with xfree86 running with native i810 drivers | 45 | - Can concurrently run with xfree86 running with native i810 drivers |
45 | 46 | ||
46 | - Hardware Cursor Support | 47 | - Hardware Cursor Support |
47 | 48 | ||
48 | - Supports EDID probing either by DDC/I2C or through the BIOS | 49 | - Supports EDID probing either by DDC/I2C or through the BIOS |
49 | 50 | ||
50 | C. List of available options | 51 | C. List of available options |
51 | 52 | ||
52 | a. "video=i810fb" | 53 | a. "video=i810fb" |
53 | enables the i810 driver | 54 | enables the i810 driver |
54 | 55 | ||
55 | Recommendation: required | 56 | Recommendation: required |
56 | 57 | ||
57 | b. "xres:<value>" | 58 | b. "xres:<value>" |
58 | select horizontal resolution in pixels. (This parameter will be | 59 | select horizontal resolution in pixels. (This parameter will be |
59 | ignored if 'mode_option' is specified. See 'o' below). | 60 | ignored if 'mode_option' is specified. See 'o' below). |
60 | 61 | ||
61 | Recommendation: user preference | 62 | Recommendation: user preference |
62 | (default = 640) | 63 | (default = 640) |
63 | 64 | ||
64 | c. "yres:<value>" | 65 | c. "yres:<value>" |
65 | select vertical resolution in scanlines. If Discrete Video Timings | 66 | select vertical resolution in scanlines. If Discrete Video Timings |
66 | is enabled, this will be ignored and computed as 3*xres/4. (This | 67 | is enabled, this will be ignored and computed as 3*xres/4. (This |
67 | parameter will be ignored if 'mode_option' is specified. See 'o' | 68 | parameter will be ignored if 'mode_option' is specified. See 'o' |
68 | below) | 69 | below) |
69 | 70 | ||
70 | Recommendation: user preference | 71 | Recommendation: user preference |
71 | (default = 480) | 72 | (default = 480) |
72 | 73 | ||
73 | d. "vyres:<value>" | 74 | d. "vyres:<value>" |
74 | select virtual vertical resolution in scanlines. If (0) or none | 75 | select virtual vertical resolution in scanlines. If (0) or none |
75 | is specified, this will be computed against maximum available memory. | 76 | is specified, this will be computed against maximum available memory. |
76 | 77 | ||
77 | Recommendation: do not set | 78 | Recommendation: do not set |
78 | (default = 480) | 79 | (default = 480) |
79 | 80 | ||
80 | e. "vram:<value>" | 81 | e. "vram:<value>" |
81 | select amount of system RAM in MB to allocate for the video memory | 82 | select amount of system RAM in MB to allocate for the video memory |
82 | 83 | ||
83 | Recommendation: 1 - 4 MB. | 84 | Recommendation: 1 - 4 MB. |
84 | (default = 4) | 85 | (default = 4) |
85 | 86 | ||
86 | f. "bpp:<value>" | 87 | f. "bpp:<value>" |
87 | select desired pixel depth | 88 | select desired pixel depth |
88 | 89 | ||
89 | Recommendation: 8 | 90 | Recommendation: 8 |
90 | (default = 8) | 91 | (default = 8) |
91 | 92 | ||
92 | g. "hsync1/hsync2:<value>" | 93 | g. "hsync1/hsync2:<value>" |
93 | select the minimum and maximum Horizontal Sync Frequency of the | 94 | select the minimum and maximum Horizontal Sync Frequency of the |
94 | monitor in KHz. If a using a fixed frequency monitor, hsync1 must | 95 | monitor in kHz. If using a fixed frequency monitor, hsync1 must |
95 | be equal to hsync2. If EDID probing is successful, these will be | 96 | be equal to hsync2. If EDID probing is successful, these will be |
96 | ignored and values will be taken from the EDID block. | 97 | ignored and values will be taken from the EDID block. |
97 | 98 | ||
98 | Recommendation: check monitor manual for correct values | 99 | Recommendation: check monitor manual for correct values |
99 | default (29/30) | 100 | (default = 29/30) |
100 | 101 | ||
101 | h. "vsync1/vsync2:<value>" | 102 | h. "vsync1/vsync2:<value>" |
102 | select the minimum and maximum Vertical Sync Frequency of the monitor | 103 | select the minimum and maximum Vertical Sync Frequency of the monitor |
103 | in Hz. You can also use this option to lock your monitor's refresh | 104 | in Hz. You can also use this option to lock your monitor's refresh |
104 | rate. If EDID probing is successful, these will be ignored and values | 105 | rate. If EDID probing is successful, these will be ignored and values |
105 | will be taken from the EDID block. | 106 | will be taken from the EDID block. |
106 | 107 | ||
107 | Recommendation: check monitor manual for correct values | 108 | Recommendation: check monitor manual for correct values |
108 | (default = 60/60) | 109 | (default = 60/60) |
109 | 110 | ||
110 | IMPORTANT: If you need to clamp your timings, try to give some | 111 | IMPORTANT: If you need to clamp your timings, try to give some |
111 | leeway for computational errors (over/underflows). Example: if | 112 | leeway for computational errors (over/underflows). Example: if |
112 | using vsync1/vsync2 = 60/60, make sure hsync1/hsync2 has at least | 113 | using vsync1/vsync2 = 60/60, make sure hsync1/hsync2 has at least |
113 | a 1 unit difference, and vice versa. | 114 | a 1 unit difference, and vice versa. |
114 | 115 | ||
115 | i. "voffset:<value>" | 116 | i. "voffset:<value>" |
116 | select at what offset in MB of the logical memory to allocate the | 117 | select at what offset in MB of the logical memory to allocate the |
117 | framebuffer memory. The intent is to avoid the memory blocks | 118 | framebuffer memory. The intent is to avoid the memory blocks |
118 | used by standard graphics applications (XFree86). The default | 119 | used by standard graphics applications (XFree86). The default |
119 | offset (16 MB for a 64MB aperture, 8 MB for a 32MB aperture) will | 120 | offset (16 MB for a 64 MB aperture, 8 MB for a 32 MB aperture) will |
120 | avoid XFree86's usage and allows up to 7MB/15MB of framebuffer | 121 | avoid XFree86's usage and allows up to 7 MB/15 MB of framebuffer |
121 | memory. Depending on your usage, adjust the value up or down, | 122 | memory. Depending on your usage, adjust the value up or down |
122 | (0 for maximum usage, 31/63 MB for the least amount). Note, an | 123 | (0 for maximum usage, 31/63 MB for the least amount). Note, an |
123 | arbitrary setting may conflict with XFree86. | 124 | arbitrary setting may conflict with XFree86. |
124 | 125 | ||
125 | Recommendation: do not set | 126 | Recommendation: do not set |
126 | (default = 8 or 16 MB) | 127 | (default = 8 or 16 MB) |
127 | 128 | ||
128 | j. "accel" | 129 | j. "accel" |
129 | enable text acceleration. This can be enabled/reenabled anytime | 130 | enable text acceleration. This can be enabled/reenabled anytime |
130 | by using 'fbset -accel true/false'. | 131 | by using 'fbset -accel true/false'. |
131 | 132 | ||
132 | Recommendation: enable | 133 | Recommendation: enable |
133 | (default = not set) | 134 | (default = not set) |
134 | 135 | ||
135 | k. "mtrr" | 136 | k. "mtrr" |
136 | enable MTRR. This allows data transfers to the framebuffer memory | 137 | enable MTRR. This allows data transfers to the framebuffer memory |
137 | to occur in bursts which can significantly increase performance. | 138 | to occur in bursts which can significantly increase performance. |
138 | Not very helpful with the i810/i815 because of 'shared memory'. | 139 | Not very helpful with the i810/i815 because of 'shared memory'. |
139 | 140 | ||
140 | Recommendation: do not set | 141 | Recommendation: do not set |
141 | (default = not set) | 142 | (default = not set) |
142 | 143 | ||
143 | l. "extvga" | 144 | l. "extvga" |
144 | if specified, secondary/external VGA output will always be enabled. | 145 | if specified, secondary/external VGA output will always be enabled. |
145 | Useful if the BIOS turns off the VGA port when no monitor is attached. | 146 | Useful if the BIOS turns off the VGA port when no monitor is attached. |
146 | The external VGA monitor can then be attached without rebooting. | 147 | The external VGA monitor can then be attached without rebooting. |
147 | 148 | ||
148 | Recommendation: do not set | 149 | Recommendation: do not set |
149 | (default = not set) | 150 | (default = not set) |
150 | 151 | ||
151 | m. "sync" | 152 | m. "sync" |
152 | Forces the hardware engine to do a "sync" or wait for the hardware | 153 | Forces the hardware engine to do a "sync" or wait for the hardware |
153 | to finish before starting another instruction. This will produce a | 154 | to finish before starting another instruction. This will produce a |
154 | more stable setup, but will be slower. | 155 | more stable setup, but will be slower. |
155 | 156 | ||
156 | Recommendation: do not set | 157 | Recommendation: do not set |
@@ -162,6 +163,7 @@ C. List of available options | |||
162 | 163 | ||
163 | Recommendation: do not set | 164 | Recommendation: do not set |
164 | (default = not set) | 165 | (default = not set) |
166 | |||
165 | o. <xres>x<yres>[-<bpp>][@<refresh>] | 167 | o. <xres>x<yres>[-<bpp>][@<refresh>] |
166 | The driver will now accept specification of boot mode option. If this | 168 | The driver will now accept specification of boot mode option. If this |
167 | is specified, the options 'xres' and 'yres' will be ignored. See | 169 | is specified, the options 'xres' and 'yres' will be ignored. See |
@@ -183,8 +185,8 @@ append="video=i810fb:vram:2,xres:1024,yres:768,bpp:8,hsync1:30,hsync2:55, \ | |||
183 | vsync1:50,vsync2:85,accel,mtrr" | 185 | vsync1:50,vsync2:85,accel,mtrr" |
184 | 186 | ||
185 | This will initialize the framebuffer to 1024x768 at 8bpp. The framebuffer | 187 | This will initialize the framebuffer to 1024x768 at 8bpp. The framebuffer |
186 | will use 2 MB of System RAM. MTRR support will be enabled. The refresh rate | 188 | will use 2 MB of System RAM. MTRR support will be enabled. The refresh rate |
187 | will be computed based on the hsync1/hsync2 and vsync1/vsync2 values. | 189 | will be computed based on the hsync1/hsync2 and vsync1/vsync2 values. |
188 | 190 | ||
189 | IMPORTANT: | 191 | IMPORTANT: |
190 | You must include hsync1, hsync2, vsync1 and vsync2 to enable video modes | 192 | You must include hsync1, hsync2, vsync1 and vsync2 to enable video modes |
@@ -194,10 +196,10 @@ vsync1 and vsync2 parameters. These parameters will be taken from the EDID | |||
194 | block. | 196 | block. |
195 | 197 | ||
196 | E. Module options | 198 | E. Module options |
197 | 199 | ||
198 | The module parameters are essentially similar to the kernel | 200 | The module parameters are essentially similar to the kernel |
199 | parameters. The main difference is that you need to include a Boolean value | 201 | parameters. The main difference is that you need to include a Boolean value |
200 | (1 for TRUE, and 0 for FALSE) for those options which don't need a value. | 202 | (1 for TRUE, and 0 for FALSE) for those options which don't need a value. |
201 | 203 | ||
202 | Example, to enable MTRR, include "mtrr=1". | 204 | Example, to enable MTRR, include "mtrr=1". |
203 | 205 | ||
@@ -214,62 +216,62 @@ Or just add the following to /etc/modprobe.conf | |||
214 | options i810fb vram=2 xres=1024 bpp=16 hsync1=30 hsync2=55 vsync1=50 \ | 216 | options i810fb vram=2 xres=1024 bpp=16 hsync1=30 hsync2=55 vsync1=50 \ |
215 | vsync2=85 accel=1 mtrr=1 | 217 | vsync2=85 accel=1 mtrr=1 |
216 | 218 | ||
217 | and just do a | 219 | and just do a |
218 | 220 | ||
219 | modprobe i810fb | 221 | modprobe i810fb |
220 | 222 | ||
221 | 223 | ||
222 | F. Setup | 224 | F. Setup |
223 | 225 | ||
224 | a. Do your usual method of configuring the kernel. | 226 | a. Do your usual method of configuring the kernel. |
225 | 227 | ||
226 | make menuconfig/xconfig/config | 228 | make menuconfig/xconfig/config |
227 | 229 | ||
228 | b. Under "Code Maturity Options", enable "Prompt for experimental/ | 230 | b. Under "Code maturity level options" enable "Prompt for development |
229 | incomplete code/drivers". | 231 | and/or incomplete code/drivers". |
230 | 232 | ||
231 | c. Enable agpgart support for the Intel 810/815 on-board graphics. | 233 | c. Enable agpgart support for the Intel 810/815 on-board graphics. |
232 | This is required. The option is under "Character Devices" | 234 | This is required. The option is under "Character Devices". |
233 | 235 | ||
234 | d. Under "Graphics Support", select "Intel 810/815" either statically | 236 | d. Under "Graphics Support", select "Intel 810/815" either statically |
235 | or as a module. Choose "use VESA Generalized Timing Formula" if | 237 | or as a module. Choose "use VESA Generalized Timing Formula" if |
236 | you need to maximize the capability of your display. To be on the | 238 | you need to maximize the capability of your display. To be on the |
237 | safe side, you can leave this unselected. | 239 | safe side, you can leave this unselected. |
238 | 240 | ||
239 | e. If you want support for DDC/I2C probing (Plug and Play Displays), | 241 | e. If you want support for DDC/I2C probing (Plug and Play Displays), |
240 | set 'Enable DDC Support' to 'y'. To make this option appear, set | 242 | set 'Enable DDC Support' to 'y'. To make this option appear, set |
241 | 'use VESA Generalized Timing Formula' to 'y'. | 243 | 'use VESA Generalized Timing Formula' to 'y'. |
242 | 244 | ||
243 | f. If you want a framebuffer console, enable it under "Console | 245 | f. If you want a framebuffer console, enable it under "Console |
244 | Drivers" | 246 | Drivers". |
247 | |||
248 | g. Compile your kernel. | ||
249 | |||
250 | h. Load the driver as described in sections D and E. | ||
245 | 251 | ||
246 | g. Compile your kernel. | ||
247 | |||
248 | h. Load the driver as described in section D and E. | ||
249 | |||
250 | i. Try the DirectFB (http://www.directfb.org) + the i810 gfxdriver | 252 | i. Try the DirectFB (http://www.directfb.org) + the i810 gfxdriver |
251 | patch to see the chipset in action (or inaction :-). | 253 | patch to see the chipset in action (or inaction :-). |
252 | 254 | ||
253 | G. Acknowledgment: | 255 | G. Acknowledgment: |
254 | 256 | ||
255 | 1. Geert Uytterhoeven - his excellent howto and the virtual | 257 | 1. Geert Uytterhoeven - his excellent howto and the virtual |
256 | framebuffer driver code made this possible. | 258 | framebuffer driver code made this possible. |
257 | 259 | ||
258 | 2. Jeff Hartmann for his agpgart code. | 260 | 2. Jeff Hartmann for his agpgart code. |
259 | 261 | ||
260 | 3. The X developers. Insights were provided just by reading the | 262 | 3. The X developers. Insights were provided just by reading the |
261 | XFree86 source code. | 263 | XFree86 source code. |
262 | 264 | ||
263 | 4. Intel(c). For this value-oriented chipset driver and for | 265 | 4. Intel(c). For this value-oriented chipset driver and for |
264 | providing documentation. | 266 | providing documentation. |
265 | 267 | ||
266 | 5. Matt Sottek. His inputs and ideas helped in making some | 268 | 5. Matt Sottek. His inputs and ideas helped in making some |
267 | optimizations possible. | 269 | optimizations possible. |
268 | 270 | ||
269 | H. Home Page: | 271 | H. Home Page: |
270 | 272 | ||
271 | A more complete, and probably updated information is provided at | 273 | A more complete, and probably updated information is provided at |
272 | http://i810fb.sourceforge.net. | 274 | http://i810fb.sourceforge.net. |
273 | 275 | ||
274 | ########################### | 276 | ########################### |
275 | Tony | 277 | Tony |
diff --git a/Documentation/fb/intelfb.txt b/Documentation/fb/intelfb.txt index c12d39a23c3d..da5ee74219e8 100644 --- a/Documentation/fb/intelfb.txt +++ b/Documentation/fb/intelfb.txt | |||
@@ -1,16 +1,19 @@ | |||
1 | Intel 830M/845G/852GM/855GM/865G/915G Framebuffer driver | 1 | Intel 830M/845G/852GM/855GM/865G/915G/945G Framebuffer driver |
2 | ================================================================ | 2 | ================================================================ |
3 | 3 | ||
4 | A. Introduction | 4 | A. Introduction |
5 | This is a framebuffer driver for various Intel 810/815 compatible | 5 | This is a framebuffer driver for various Intel 8xx/9xx compatible |
6 | graphics devices. These would include: | 6 | graphics devices. These would include: |
7 | 7 | ||
8 | Intel 830M | 8 | Intel 830M |
9 | Intel 810E845G | 9 | Intel 845G |
10 | Intel 852GM | 10 | Intel 852GM |
11 | Intel 855GM | 11 | Intel 855GM |
12 | Intel 865G | 12 | Intel 865G |
13 | Intel 915G | 13 | Intel 915G |
14 | Intel 915GM | ||
15 | Intel 945G | ||
16 | Intel 945GM | ||
14 | 17 | ||
15 | B. List of available options | 18 | B. List of available options |
16 | 19 | ||
@@ -78,19 +81,27 @@ C. Kernel booting | |||
78 | Separate each option/option-pair by commas (,) and the option from its value | 81 | Separate each option/option-pair by commas (,) and the option from its value |
79 | with an equals sign (=) as in the following: | 82 | with an equals sign (=) as in the following: |
80 | 83 | ||
81 | video=i810fb:option1,option2=value2 | 84 | video=intelfb:option1,option2=value2 |
82 | 85 | ||
83 | Sample Usage | 86 | Sample Usage |
84 | ------------ | 87 | ------------ |
85 | 88 | ||
86 | In /etc/lilo.conf, add the line: | 89 | In /etc/lilo.conf, add the line: |
87 | 90 | ||
88 | append="video=intelfb:800x600-32@75,accel,hwcursor,vram=8" | 91 | append="video=intelfb:mode=800x600-32@75,accel,hwcursor,vram=8" |
89 | 92 | ||
90 | This will initialize the framebuffer to 800x600 at 32bpp and 75Hz. The | 93 | This will initialize the framebuffer to 800x600 at 32bpp and 75Hz. The |
91 | framebuffer will use 8 MB of System RAM. hw acceleration of text and cursor | 94 | framebuffer will use 8 MB of System RAM. hw acceleration of text and cursor |
92 | will be enabled. | 95 | will be enabled. |
93 | 96 | ||
97 | Remarks | ||
98 | ------- | ||
99 | |||
100 | If setting this parameter doesn't work (you stay in a 80x25 text-mode), | ||
101 | you might need to set the "vga=<mode>" parameter too - see vesafb.txt | ||
102 | in this directory. | ||
103 | |||
104 | |||
94 | D. Module options | 105 | D. Module options |
95 | 106 | ||
96 | The module parameters are essentially similar to the kernel | 107 | The module parameters are essentially similar to the kernel |
diff --git a/Documentation/feature-removal-schedule.txt b/Documentation/feature-removal-schedule.txt index 552507fe9a7e..2e410f5aa750 100644 --- a/Documentation/feature-removal-schedule.txt +++ b/Documentation/feature-removal-schedule.txt | |||
@@ -6,6 +6,21 @@ be removed from this file. | |||
6 | 6 | ||
7 | --------------------------- | 7 | --------------------------- |
8 | 8 | ||
9 | What: /sys/devices/.../power/state | ||
10 | dev->power.power_state | ||
11 | dpm_runtime_{suspend,resume)() | ||
12 | When: July 2007 | ||
13 | Why: Broken design for runtime control over driver power states, confusing | ||
14 | driver-internal runtime power management with: mechanisms to support | ||
15 | system-wide sleep state transitions; event codes that distinguish | ||
16 | different phases of swsusp "sleep" transitions; and userspace policy | ||
17 | inputs. This framework was never widely used, and most attempts to | ||
18 | use it were broken. Drivers should instead be exposing domain-specific | ||
19 | interfaces either to kernel or to userspace. | ||
20 | Who: Pavel Machek <pavel@suse.cz> | ||
21 | |||
22 | --------------------------- | ||
23 | |||
9 | What: RAW driver (CONFIG_RAW_DRIVER) | 24 | What: RAW driver (CONFIG_RAW_DRIVER) |
10 | When: December 2005 | 25 | When: December 2005 |
11 | Why: declared obsolete since kernel 2.6.3 | 26 | Why: declared obsolete since kernel 2.6.3 |
@@ -31,17 +46,8 @@ Who: Jody McIntyre <scjody@modernduck.com> | |||
31 | 46 | ||
32 | --------------------------- | 47 | --------------------------- |
33 | 48 | ||
34 | What: sbp2: module parameter "force_inquiry_hack" | ||
35 | When: July 2006 | ||
36 | Why: Superceded by parameter "workarounds". Both parameters are meant to be | ||
37 | used ad-hoc and for single devices only, i.e. not in modprobe.conf, | ||
38 | therefore the impact of this feature replacement should be low. | ||
39 | Who: Stefan Richter <stefanr@s5r6.in-berlin.de> | ||
40 | |||
41 | --------------------------- | ||
42 | |||
43 | What: Video4Linux API 1 ioctls and video_decoder.h from Video devices. | 49 | What: Video4Linux API 1 ioctls and video_decoder.h from Video devices. |
44 | When: July 2006 | 50 | When: December 2006 |
45 | Why: V4L1 AP1 was replaced by V4L2 API. during migration from 2.4 to 2.6 | 51 | Why: V4L1 AP1 was replaced by V4L2 API. during migration from 2.4 to 2.6 |
46 | series. The old API have lots of drawbacks and don't provide enough | 52 | series. The old API have lots of drawbacks and don't provide enough |
47 | means to work with all video and audio standards. The newer API is | 53 | means to work with all video and audio standards. The newer API is |
@@ -55,6 +61,18 @@ Who: Mauro Carvalho Chehab <mchehab@brturbo.com.br> | |||
55 | 61 | ||
56 | --------------------------- | 62 | --------------------------- |
57 | 63 | ||
64 | What: sys_sysctl | ||
65 | When: January 2007 | ||
66 | Why: The same information is available through /proc/sys and that is the | ||
67 | interface user space prefers to use. And there do not appear to be | ||
68 | any existing user in user space of sys_sysctl. The additional | ||
69 | maintenance overhead of keeping a set of binary names gets | ||
70 | in the way of doing a good job of maintaining this interface. | ||
71 | |||
72 | Who: Eric Biederman <ebiederm@xmission.com> | ||
73 | |||
74 | --------------------------- | ||
75 | |||
58 | What: PCMCIA control ioctl (needed for pcmcia-cs [cardmgr, cardctl]) | 76 | What: PCMCIA control ioctl (needed for pcmcia-cs [cardmgr, cardctl]) |
59 | When: November 2005 | 77 | When: November 2005 |
60 | Files: drivers/pcmcia/: pcmcia_ioctl.c | 78 | Files: drivers/pcmcia/: pcmcia_ioctl.c |
@@ -104,15 +122,6 @@ Who: Arjan van de Ven | |||
104 | 122 | ||
105 | --------------------------- | 123 | --------------------------- |
106 | 124 | ||
107 | What: START_ARRAY ioctl for md | ||
108 | When: July 2006 | ||
109 | Files: drivers/md/md.c | ||
110 | Why: Not reliable by design - can fail when most needed. | ||
111 | Alternatives exist | ||
112 | Who: NeilBrown <neilb@suse.de> | ||
113 | |||
114 | --------------------------- | ||
115 | |||
116 | What: eepro100 network driver | 125 | What: eepro100 network driver |
117 | When: January 2007 | 126 | When: January 2007 |
118 | Why: replaced by the e100 driver | 127 | Why: replaced by the e100 driver |
@@ -202,50 +211,6 @@ Who: Nick Piggin <npiggin@suse.de> | |||
202 | 211 | ||
203 | --------------------------- | 212 | --------------------------- |
204 | 213 | ||
205 | What: Support for the MIPS EV96100 evaluation board | ||
206 | When: September 2006 | ||
207 | Why: Does no longer build since at least November 15, 2003, apparently | ||
208 | no userbase left. | ||
209 | Who: Ralf Baechle <ralf@linux-mips.org> | ||
210 | |||
211 | --------------------------- | ||
212 | |||
213 | What: Support for the Momentum / PMC-Sierra Jaguar ATX evaluation board | ||
214 | When: September 2006 | ||
215 | Why: Does no longer build since quite some time, and was never popular, | ||
216 | due to the platform being replaced by successor models. Apparently | ||
217 | no user base left. It also is one of the last users of | ||
218 | WANT_PAGE_VIRTUAL. | ||
219 | Who: Ralf Baechle <ralf@linux-mips.org> | ||
220 | |||
221 | --------------------------- | ||
222 | |||
223 | What: Support for the Momentum Ocelot, Ocelot 3, Ocelot C and Ocelot G | ||
224 | When: September 2006 | ||
225 | Why: Some do no longer build and apparently there is no user base left | ||
226 | for these platforms. | ||
227 | Who: Ralf Baechle <ralf@linux-mips.org> | ||
228 | |||
229 | --------------------------- | ||
230 | |||
231 | What: Support for MIPS Technologies' Altas and SEAD evaluation board | ||
232 | When: September 2006 | ||
233 | Why: Some do no longer build and apparently there is no user base left | ||
234 | for these platforms. Hardware out of production since several years. | ||
235 | Who: Ralf Baechle <ralf@linux-mips.org> | ||
236 | |||
237 | --------------------------- | ||
238 | |||
239 | What: Support for the IT8172-based platforms, ITE 8172G and Globespan IVR | ||
240 | When: September 2006 | ||
241 | Why: Code does no longer build since at least 2.6.0, apparently there is | ||
242 | no user base left for these platforms. Hardware out of production | ||
243 | since several years and hardly a trace of the manufacturer left on | ||
244 | the net. | ||
245 | Who: Ralf Baechle <ralf@linux-mips.org> | ||
246 | |||
247 | --------------------------- | ||
248 | |||
249 | What: Interrupt only SA_* flags | 214 | What: Interrupt only SA_* flags |
250 | When: Januar 2007 | 215 | When: Januar 2007 |
251 | Why: The interrupt related SA_* flags are replaced by IRQF_* to move them | 216 | Why: The interrupt related SA_* flags are replaced by IRQF_* to move them |
@@ -294,3 +259,32 @@ Why: The frame diverter is included in most distribution kernels, but is | |||
294 | It is not clear if anyone is still using it. | 259 | It is not clear if anyone is still using it. |
295 | Who: Stephen Hemminger <shemminger@osdl.org> | 260 | Who: Stephen Hemminger <shemminger@osdl.org> |
296 | 261 | ||
262 | --------------------------- | ||
263 | |||
264 | |||
265 | What: PHYSDEVPATH, PHYSDEVBUS, PHYSDEVDRIVER in the uevent environment | ||
266 | When: Oktober 2008 | ||
267 | Why: The stacking of class devices makes these values misleading and | ||
268 | inconsistent. | ||
269 | Class devices should not carry any of these properties, and bus | ||
270 | devices have SUBSYTEM and DRIVER as a replacement. | ||
271 | Who: Kay Sievers <kay.sievers@suse.de> | ||
272 | |||
273 | --------------------------- | ||
274 | |||
275 | What: i2c-isa | ||
276 | When: December 2006 | ||
277 | Why: i2c-isa is a non-sense and doesn't fit in the device driver | ||
278 | model. Drivers relying on it are better implemented as platform | ||
279 | drivers. | ||
280 | Who: Jean Delvare <khali@linux-fr.org> | ||
281 | |||
282 | --------------------------- | ||
283 | |||
284 | What: ftape | ||
285 | When: 2.6.20 | ||
286 | Why: Orphaned for ages. SMP bugs long unfixed. Few users left | ||
287 | in the world. | ||
288 | Who: Jeff Garzik <jeff@garzik.org> | ||
289 | |||
290 | --------------------------- | ||
diff --git a/Documentation/filesystems/Locking b/Documentation/filesystems/Locking index 247d7f619aa2..eb1a6cad21e6 100644 --- a/Documentation/filesystems/Locking +++ b/Documentation/filesystems/Locking | |||
@@ -356,10 +356,9 @@ The last two are called only from check_disk_change(). | |||
356 | prototypes: | 356 | prototypes: |
357 | loff_t (*llseek) (struct file *, loff_t, int); | 357 | loff_t (*llseek) (struct file *, loff_t, int); |
358 | ssize_t (*read) (struct file *, char __user *, size_t, loff_t *); | 358 | ssize_t (*read) (struct file *, char __user *, size_t, loff_t *); |
359 | ssize_t (*aio_read) (struct kiocb *, char __user *, size_t, loff_t); | ||
360 | ssize_t (*write) (struct file *, const char __user *, size_t, loff_t *); | 359 | ssize_t (*write) (struct file *, const char __user *, size_t, loff_t *); |
361 | ssize_t (*aio_write) (struct kiocb *, const char __user *, size_t, | 360 | ssize_t (*aio_read) (struct kiocb *, const struct iovec *, unsigned long, loff_t); |
362 | loff_t); | 361 | ssize_t (*aio_write) (struct kiocb *, const struct iovec *, unsigned long, loff_t); |
363 | int (*readdir) (struct file *, void *, filldir_t); | 362 | int (*readdir) (struct file *, void *, filldir_t); |
364 | unsigned int (*poll) (struct file *, struct poll_table_struct *); | 363 | unsigned int (*poll) (struct file *, struct poll_table_struct *); |
365 | int (*ioctl) (struct inode *, struct file *, unsigned int, | 364 | int (*ioctl) (struct inode *, struct file *, unsigned int, |
diff --git a/Documentation/filesystems/proc.txt b/Documentation/filesystems/proc.txt index 99902ae6804e..7240ee7515de 100644 --- a/Documentation/filesystems/proc.txt +++ b/Documentation/filesystems/proc.txt | |||
@@ -39,6 +39,8 @@ Table of Contents | |||
39 | 2.9 Appletalk | 39 | 2.9 Appletalk |
40 | 2.10 IPX | 40 | 2.10 IPX |
41 | 2.11 /proc/sys/fs/mqueue - POSIX message queues filesystem | 41 | 2.11 /proc/sys/fs/mqueue - POSIX message queues filesystem |
42 | 2.12 /proc/<pid>/oom_adj - Adjust the oom-killer score | ||
43 | 2.13 /proc/<pid>/oom_score - Display current oom-killer score | ||
42 | 44 | ||
43 | ------------------------------------------------------------------------------ | 45 | ------------------------------------------------------------------------------ |
44 | Preface | 46 | Preface |
@@ -1124,11 +1126,15 @@ debugging information is displayed on console. | |||
1124 | NMI switch that most IA32 servers have fires unknown NMI up, for example. | 1126 | NMI switch that most IA32 servers have fires unknown NMI up, for example. |
1125 | If a system hangs up, try pressing the NMI switch. | 1127 | If a system hangs up, try pressing the NMI switch. |
1126 | 1128 | ||
1127 | [NOTE] | 1129 | nmi_watchdog |
1128 | This function and oprofile share a NMI callback. Therefore this function | 1130 | ------------ |
1129 | cannot be enabled when oprofile is activated. | 1131 | |
1130 | And NMI watchdog will be disabled when the value in this file is set to | 1132 | Enables/Disables the NMI watchdog on x86 systems. When the value is non-zero |
1131 | non-zero. | 1133 | the NMI watchdog is enabled and will continuously test all online cpus to |
1134 | determine whether or not they are still functioning properly. | ||
1135 | |||
1136 | Because the NMI watchdog shares registers with oprofile, by disabling the NMI | ||
1137 | watchdog, oprofile may have more registers to utilize. | ||
1132 | 1138 | ||
1133 | 1139 | ||
1134 | 2.4 /proc/sys/vm - The virtual memory subsystem | 1140 | 2.4 /proc/sys/vm - The virtual memory subsystem |
@@ -1958,6 +1964,22 @@ a queue must be less or equal then msg_max. | |||
1958 | maximum message size value (it is every message queue's attribute set during | 1964 | maximum message size value (it is every message queue's attribute set during |
1959 | its creation). | 1965 | its creation). |
1960 | 1966 | ||
1967 | 2.12 /proc/<pid>/oom_adj - Adjust the oom-killer score | ||
1968 | ------------------------------------------------------ | ||
1969 | |||
1970 | This file can be used to adjust the score used to select which processes | ||
1971 | should be killed in an out-of-memory situation. Giving it a high score will | ||
1972 | increase the likelihood of this process being killed by the oom-killer. Valid | ||
1973 | values are in the range -16 to +15, plus the special value -17, which disables | ||
1974 | oom-killing altogether for this process. | ||
1975 | |||
1976 | 2.13 /proc/<pid>/oom_score - Display current oom-killer score | ||
1977 | ------------------------------------------------------------- | ||
1978 | |||
1979 | ------------------------------------------------------------------------------ | ||
1980 | This file can be used to check the current score used by the oom-killer is for | ||
1981 | any given <pid>. Use it together with /proc/<pid>/oom_adj to tune which | ||
1982 | process should be killed in an out-of-memory situation. | ||
1961 | 1983 | ||
1962 | ------------------------------------------------------------------------------ | 1984 | ------------------------------------------------------------------------------ |
1963 | Summary | 1985 | Summary |
diff --git a/Documentation/filesystems/vfs.txt b/Documentation/filesystems/vfs.txt index 1cb7e8be927a..cd07c21b8400 100644 --- a/Documentation/filesystems/vfs.txt +++ b/Documentation/filesystems/vfs.txt | |||
@@ -699,9 +699,9 @@ This describes how the VFS can manipulate an open file. As of kernel | |||
699 | struct file_operations { | 699 | struct file_operations { |
700 | loff_t (*llseek) (struct file *, loff_t, int); | 700 | loff_t (*llseek) (struct file *, loff_t, int); |
701 | ssize_t (*read) (struct file *, char __user *, size_t, loff_t *); | 701 | ssize_t (*read) (struct file *, char __user *, size_t, loff_t *); |
702 | ssize_t (*aio_read) (struct kiocb *, char __user *, size_t, loff_t); | ||
703 | ssize_t (*write) (struct file *, const char __user *, size_t, loff_t *); | 702 | ssize_t (*write) (struct file *, const char __user *, size_t, loff_t *); |
704 | ssize_t (*aio_write) (struct kiocb *, const char __user *, size_t, loff_t); | 703 | ssize_t (*aio_read) (struct kiocb *, const struct iovec *, unsigned long, loff_t); |
704 | ssize_t (*aio_write) (struct kiocb *, const struct iovec *, unsigned long, loff_t); | ||
705 | int (*readdir) (struct file *, void *, filldir_t); | 705 | int (*readdir) (struct file *, void *, filldir_t); |
706 | unsigned int (*poll) (struct file *, struct poll_table_struct *); | 706 | unsigned int (*poll) (struct file *, struct poll_table_struct *); |
707 | int (*ioctl) (struct inode *, struct file *, unsigned int, unsigned long); | 707 | int (*ioctl) (struct inode *, struct file *, unsigned int, unsigned long); |
diff --git a/Documentation/hwmon/it87 b/Documentation/hwmon/it87 index 9555be1ed999..e783fd62e308 100644 --- a/Documentation/hwmon/it87 +++ b/Documentation/hwmon/it87 | |||
@@ -13,12 +13,25 @@ Supported chips: | |||
13 | from Super I/O config space (8 I/O ports) | 13 | from Super I/O config space (8 I/O ports) |
14 | Datasheet: Publicly available at the ITE website | 14 | Datasheet: Publicly available at the ITE website |
15 | http://www.ite.com.tw/ | 15 | http://www.ite.com.tw/ |
16 | * IT8716F | ||
17 | Prefix: 'it8716' | ||
18 | Addresses scanned: from Super I/O config space (8 I/O ports) | ||
19 | Datasheet: Publicly available at the ITE website | ||
20 | http://www.ite.com.tw/product_info/file/pc/IT8716F_V0.3.ZIP | ||
21 | * IT8718F | ||
22 | Prefix: 'it8718' | ||
23 | Addresses scanned: from Super I/O config space (8 I/O ports) | ||
24 | Datasheet: Publicly available at the ITE website | ||
25 | http://www.ite.com.tw/product_info/file/pc/IT8718F_V0.2.zip | ||
26 | http://www.ite.com.tw/product_info/file/pc/IT8718F_V0%203_(for%20C%20version).zip | ||
16 | * SiS950 [clone of IT8705F] | 27 | * SiS950 [clone of IT8705F] |
17 | Prefix: 'it87' | 28 | Prefix: 'it87' |
18 | Addresses scanned: from Super I/O config space (8 I/O ports) | 29 | Addresses scanned: from Super I/O config space (8 I/O ports) |
19 | Datasheet: No longer be available | 30 | Datasheet: No longer be available |
20 | 31 | ||
21 | Author: Christophe Gauthron <chrisg@0-in.com> | 32 | Authors: |
33 | Christophe Gauthron <chrisg@0-in.com> | ||
34 | Jean Delvare <khali@linux-fr.org> | ||
22 | 35 | ||
23 | 36 | ||
24 | Module Parameters | 37 | Module Parameters |
@@ -43,26 +56,46 @@ Module Parameters | |||
43 | Description | 56 | Description |
44 | ----------- | 57 | ----------- |
45 | 58 | ||
46 | This driver implements support for the IT8705F, IT8712F and SiS950 chips. | 59 | This driver implements support for the IT8705F, IT8712F, IT8716F, |
47 | 60 | IT8718F and SiS950 chips. | |
48 | This driver also supports IT8712F, which adds SMBus access, and a VID | ||
49 | input, used to report the Vcore voltage of the Pentium processor. | ||
50 | The IT8712F additionally features VID inputs. | ||
51 | 61 | ||
52 | These chips are 'Super I/O chips', supporting floppy disks, infrared ports, | 62 | These chips are 'Super I/O chips', supporting floppy disks, infrared ports, |
53 | joysticks and other miscellaneous stuff. For hardware monitoring, they | 63 | joysticks and other miscellaneous stuff. For hardware monitoring, they |
54 | include an 'environment controller' with 3 temperature sensors, 3 fan | 64 | include an 'environment controller' with 3 temperature sensors, 3 fan |
55 | rotation speed sensors, 8 voltage sensors, and associated alarms. | 65 | rotation speed sensors, 8 voltage sensors, and associated alarms. |
56 | 66 | ||
67 | The IT8712F and IT8716F additionally feature VID inputs, used to report | ||
68 | the Vcore voltage of the processor. The early IT8712F have 5 VID pins, | ||
69 | the IT8716F and late IT8712F have 6. They are shared with other functions | ||
70 | though, so the functionality may not be available on a given system. | ||
71 | The driver dumbly assume it is there. | ||
72 | |||
73 | The IT8718F also features VID inputs (up to 8 pins) but the value is | ||
74 | stored in the Super-I/O configuration space. Due to technical limitations, | ||
75 | this value can currently only be read once at initialization time, so | ||
76 | the driver won't notice and report changes in the VID value. The two | ||
77 | upper VID bits share their pins with voltage inputs (in5 and in6) so you | ||
78 | can't have both on a given board. | ||
79 | |||
80 | The IT8716F, IT8718F and later IT8712F revisions have support for | ||
81 | 2 additional fans. They are not yet supported by the driver. | ||
82 | |||
83 | The IT8716F and IT8718F, and late IT8712F and IT8705F also have optional | ||
84 | 16-bit tachometer counters for fans 1 to 3. This is better (no more fan | ||
85 | clock divider mess) but not compatible with the older chips and | ||
86 | revisions. For now, the driver only uses the 16-bit mode on the | ||
87 | IT8716F and IT8718F. | ||
88 | |||
57 | Temperatures are measured in degrees Celsius. An alarm is triggered once | 89 | Temperatures are measured in degrees Celsius. An alarm is triggered once |
58 | when the Overtemperature Shutdown limit is crossed. | 90 | when the Overtemperature Shutdown limit is crossed. |
59 | 91 | ||
60 | Fan rotation speeds are reported in RPM (rotations per minute). An alarm is | 92 | Fan rotation speeds are reported in RPM (rotations per minute). An alarm is |
61 | triggered if the rotation speed has dropped below a programmable limit. Fan | 93 | triggered if the rotation speed has dropped below a programmable limit. When |
62 | readings can be divided by a programmable divider (1, 2, 4 or 8) to give the | 94 | 16-bit tachometer counters aren't used, fan readings can be divided by |
63 | readings more range or accuracy. Not all RPM values can accurately be | 95 | a programmable divider (1, 2, 4 or 8) to give the readings more range or |
64 | represented, so some rounding is done. With a divider of 2, the lowest | 96 | accuracy. With a divider of 2, the lowest representable value is around |
65 | representable value is around 2600 RPM. | 97 | 2600 RPM. Not all RPM values can accurately be represented, so some rounding |
98 | is done. | ||
66 | 99 | ||
67 | Voltage sensors (also known as IN sensors) report their values in volts. An | 100 | Voltage sensors (also known as IN sensors) report their values in volts. An |
68 | alarm is triggered if the voltage has crossed a programmable minimum or | 101 | alarm is triggered if the voltage has crossed a programmable minimum or |
@@ -71,9 +104,9 @@ zero'; this is important for negative voltage measurements. All voltage | |||
71 | inputs can measure voltages between 0 and 4.08 volts, with a resolution of | 104 | inputs can measure voltages between 0 and 4.08 volts, with a resolution of |
72 | 0.016 volt. The battery voltage in8 does not have limit registers. | 105 | 0.016 volt. The battery voltage in8 does not have limit registers. |
73 | 106 | ||
74 | The VID lines (IT8712F only) encode the core voltage value: the voltage | 107 | The VID lines (IT8712F/IT8716F/IT8718F) encode the core voltage value: |
75 | level your processor should work with. This is hardcoded by the mainboard | 108 | the voltage level your processor should work with. This is hardcoded by |
76 | and/or processor itself. It is a value in volts. | 109 | the mainboard and/or processor itself. It is a value in volts. |
77 | 110 | ||
78 | If an alarm triggers, it will remain triggered until the hardware register | 111 | If an alarm triggers, it will remain triggered until the hardware register |
79 | is read at least once. This means that the cause for the alarm may already | 112 | is read at least once. This means that the cause for the alarm may already |
diff --git a/Documentation/hwmon/k8temp b/Documentation/hwmon/k8temp new file mode 100644 index 000000000000..bab445ab0f52 --- /dev/null +++ b/Documentation/hwmon/k8temp | |||
@@ -0,0 +1,52 @@ | |||
1 | Kernel driver k8temp | ||
2 | ==================== | ||
3 | |||
4 | Supported chips: | ||
5 | * AMD K8 CPU | ||
6 | Prefix: 'k8temp' | ||
7 | Addresses scanned: PCI space | ||
8 | Datasheet: http://www.amd.com/us-en/assets/content_type/white_papers_and_tech_docs/32559.pdf | ||
9 | |||
10 | Author: Rudolf Marek | ||
11 | Contact: Rudolf Marek <r.marek@sh.cvut.cz> | ||
12 | |||
13 | Description | ||
14 | ----------- | ||
15 | |||
16 | This driver permits reading temperature sensor(s) embedded inside AMD K8 CPUs. | ||
17 | Official documentation says that it works from revision F of K8 core, but | ||
18 | in fact it seems to be implemented for all revisions of K8 except the first | ||
19 | two revisions (SH-B0 and SH-B3). | ||
20 | |||
21 | There can be up to four temperature sensors inside single CPU. The driver | ||
22 | will auto-detect the sensors and will display only temperatures from | ||
23 | implemented sensors. | ||
24 | |||
25 | Mapping of /sys files is as follows: | ||
26 | |||
27 | temp1_input - temperature of Core 0 and "place" 0 | ||
28 | temp2_input - temperature of Core 0 and "place" 1 | ||
29 | temp3_input - temperature of Core 1 and "place" 0 | ||
30 | temp4_input - temperature of Core 1 and "place" 1 | ||
31 | |||
32 | Temperatures are measured in degrees Celsius and measurement resolution is | ||
33 | 1 degree C. It is expected that future CPU will have better resolution. The | ||
34 | temperature is updated once a second. Valid temperatures are from -49 to | ||
35 | 206 degrees C. | ||
36 | |||
37 | Temperature known as TCaseMax was specified for processors up to revision E. | ||
38 | This temperature is defined as temperature between heat-spreader and CPU | ||
39 | case, so the internal CPU temperature supplied by this driver can be higher. | ||
40 | There is no easy way how to measure the temperature which will correlate | ||
41 | with TCaseMax temperature. | ||
42 | |||
43 | For newer revisions of CPU (rev F, socket AM2) there is a mathematically | ||
44 | computed temperature called TControl, which must be lower than TControlMax. | ||
45 | |||
46 | The relationship is following: | ||
47 | |||
48 | temp1_input - TjOffset*2 < TControlMax, | ||
49 | |||
50 | TjOffset is not yet exported by the driver, TControlMax is usually | ||
51 | 70 degrees C. The rule of the thumb -> CPU temperature should not cross | ||
52 | 60 degrees C too much. | ||
diff --git a/Documentation/hwmon/vt1211 b/Documentation/hwmon/vt1211 new file mode 100644 index 000000000000..77fa633b97a8 --- /dev/null +++ b/Documentation/hwmon/vt1211 | |||
@@ -0,0 +1,206 @@ | |||
1 | Kernel driver vt1211 | ||
2 | ==================== | ||
3 | |||
4 | Supported chips: | ||
5 | * VIA VT1211 | ||
6 | Prefix: 'vt1211' | ||
7 | Addresses scanned: none, address read from Super-I/O config space | ||
8 | Datasheet: Provided by VIA upon request and under NDA | ||
9 | |||
10 | Authors: Juerg Haefliger <juergh@gmail.com> | ||
11 | |||
12 | This driver is based on the driver for kernel 2.4 by Mark D. Studebaker and | ||
13 | its port to kernel 2.6 by Lars Ekman. | ||
14 | |||
15 | Thanks to Joseph Chan and Fiona Gatt from VIA for providing documentation and | ||
16 | technical support. | ||
17 | |||
18 | |||
19 | Module Parameters | ||
20 | ----------------- | ||
21 | |||
22 | * uch_config: int Override the BIOS default universal channel (UCH) | ||
23 | configuration for channels 1-5. | ||
24 | Legal values are in the range of 0-31. Bit 0 maps to | ||
25 | UCH1, bit 1 maps to UCH2 and so on. Setting a bit to 1 | ||
26 | enables the thermal input of that particular UCH and | ||
27 | setting a bit to 0 enables the voltage input. | ||
28 | |||
29 | * int_mode: int Override the BIOS default temperature interrupt mode. | ||
30 | The only possible value is 0 which forces interrupt | ||
31 | mode 0. In this mode, any pending interrupt is cleared | ||
32 | when the status register is read but is regenerated as | ||
33 | long as the temperature stays above the hysteresis | ||
34 | limit. | ||
35 | |||
36 | Be aware that overriding BIOS defaults might cause some unwanted side effects! | ||
37 | |||
38 | |||
39 | Description | ||
40 | ----------- | ||
41 | |||
42 | The VIA VT1211 Super-I/O chip includes complete hardware monitoring | ||
43 | capabilities. It monitors 2 dedicated temperature sensor inputs (temp1 and | ||
44 | temp2), 1 dedicated voltage (in5) and 2 fans. Additionally, the chip | ||
45 | implements 5 universal input channels (UCH1-5) that can be individually | ||
46 | programmed to either monitor a voltage or a temperature. | ||
47 | |||
48 | This chip also provides manual and automatic control of fan speeds (according | ||
49 | to the datasheet). The driver only supports automatic control since the manual | ||
50 | mode doesn't seem to work as advertised in the datasheet. In fact I couldn't | ||
51 | get manual mode to work at all! Be aware that automatic mode hasn't been | ||
52 | tested very well (due to the fact that my EPIA M10000 doesn't have the fans | ||
53 | connected to the PWM outputs of the VT1211 :-(). | ||
54 | |||
55 | The following table shows the relationship between the vt1211 inputs and the | ||
56 | sysfs nodes. | ||
57 | |||
58 | Sensor Voltage Mode Temp Mode Default Use (from the datasheet) | ||
59 | ------ ------------ --------- -------------------------------- | ||
60 | Reading 1 temp1 Intel thermal diode | ||
61 | Reading 3 temp2 Internal thermal diode | ||
62 | UCH1/Reading2 in0 temp3 NTC type thermistor | ||
63 | UCH2 in1 temp4 +2.5V | ||
64 | UCH3 in2 temp5 VccP (processor core) | ||
65 | UCH4 in3 temp6 +5V | ||
66 | UCH5 in4 temp7 +12V | ||
67 | +3.3V in5 Internal VCC (+3.3V) | ||
68 | |||
69 | |||
70 | Voltage Monitoring | ||
71 | ------------------ | ||
72 | |||
73 | Voltages are sampled by an 8-bit ADC with a LSB of ~10mV. The supported input | ||
74 | range is thus from 0 to 2.60V. Voltage values outside of this range need | ||
75 | external scaling resistors. This external scaling needs to be compensated for | ||
76 | via compute lines in sensors.conf, like: | ||
77 | |||
78 | compute inx @*(1+R1/R2), @/(1+R1/R2) | ||
79 | |||
80 | The board level scaling resistors according to VIA's recommendation are as | ||
81 | follows. And this is of course totally dependent on the actual board | ||
82 | implementation :-) You will have to find documentation for your own | ||
83 | motherboard and edit sensors.conf accordingly. | ||
84 | |||
85 | Expected | ||
86 | Voltage R1 R2 Divider Raw Value | ||
87 | ----------------------------------------------- | ||
88 | +2.5V 2K 10K 1.2 2083 mV | ||
89 | VccP --- --- 1.0 1400 mV (1) | ||
90 | +5V 14K 10K 2.4 2083 mV | ||
91 | +12V 47K 10K 5.7 2105 mV | ||
92 | +3.3V (int) 2K 3.4K 1.588 3300 mV (2) | ||
93 | +3.3V (ext) 6.8K 10K 1.68 1964 mV | ||
94 | |||
95 | (1) Depending on the CPU (1.4V is for a VIA C3 Nehemiah). | ||
96 | (2) R1 and R2 for 3.3V (int) are internal to the VT1211 chip and the driver | ||
97 | performs the scaling and returns the properly scaled voltage value. | ||
98 | |||
99 | Each measured voltage has an associated low and high limit which triggers an | ||
100 | alarm when crossed. | ||
101 | |||
102 | |||
103 | Temperature Monitoring | ||
104 | ---------------------- | ||
105 | |||
106 | Temperatures are reported in millidegree Celsius. Each measured temperature | ||
107 | has a high limit which triggers an alarm if crossed. There is an associated | ||
108 | hysteresis value with each temperature below which the temperature has to drop | ||
109 | before the alarm is cleared (this is only true for interrupt mode 0). The | ||
110 | interrupt mode can be forced to 0 in case the BIOS doesn't do it | ||
111 | automatically. See the 'Module Parameters' section for details. | ||
112 | |||
113 | All temperature channels except temp2 are external. Temp2 is the VT1211 | ||
114 | internal thermal diode and the driver does all the scaling for temp2 and | ||
115 | returns the temperature in millidegree Celsius. For the external channels | ||
116 | temp1 and temp3-temp7, scaling depends on the board implementation and needs | ||
117 | to be performed in userspace via sensors.conf. | ||
118 | |||
119 | Temp1 is an Intel-type thermal diode which requires the following formula to | ||
120 | convert between sysfs readings and real temperatures: | ||
121 | |||
122 | compute temp1 (@-Offset)/Gain, (@*Gain)+Offset | ||
123 | |||
124 | According to the VIA VT1211 BIOS porting guide, the following gain and offset | ||
125 | values should be used: | ||
126 | |||
127 | Diode Type Offset Gain | ||
128 | ---------- ------ ---- | ||
129 | Intel CPU 88.638 0.9528 | ||
130 | 65.000 0.9686 *) | ||
131 | VIA C3 Ezra 83.869 0.9528 | ||
132 | VIA C3 Ezra-T 73.869 0.9528 | ||
133 | |||
134 | *) This is the formula from the lm_sensors 2.10.0 sensors.conf file. I don't | ||
135 | know where it comes from or how it was derived, it's just listed here for | ||
136 | completeness. | ||
137 | |||
138 | Temp3-temp7 support NTC thermistors. For these channels, the driver returns | ||
139 | the voltages as seen at the individual pins of UCH1-UCH5. The voltage at the | ||
140 | pin (Vpin) is formed by a voltage divider made of the thermistor (Rth) and a | ||
141 | scaling resistor (Rs): | ||
142 | |||
143 | Vpin = 2200 * Rth / (Rs + Rth) (2200 is the ADC max limit of 2200 mV) | ||
144 | |||
145 | The equation for the thermistor is as follows (google it if you want to know | ||
146 | more about it): | ||
147 | |||
148 | Rth = Ro * exp(B * (1 / T - 1 / To)) (To is 298.15K (25C) and Ro is the | ||
149 | nominal resistance at 25C) | ||
150 | |||
151 | Mingling the above two equations and assuming Rs = Ro and B = 3435 yields the | ||
152 | following formula for sensors.conf: | ||
153 | |||
154 | compute tempx 1 / (1 / 298.15 - (` (2200 / @ - 1)) / 3435) - 273.15, | ||
155 | 2200 / (1 + (^ (3435 / 298.15 - 3435 / (273.15 + @)))) | ||
156 | |||
157 | |||
158 | Fan Speed Control | ||
159 | ----------------- | ||
160 | |||
161 | The VT1211 provides 2 programmable PWM outputs to control the speeds of 2 | ||
162 | fans. Writing a 2 to any of the two pwm[1-2]_enable sysfs nodes will put the | ||
163 | PWM controller in automatic mode. There is only a single controller that | ||
164 | controls both PWM outputs but each PWM output can be individually enabled and | ||
165 | disabled. | ||
166 | |||
167 | Each PWM has 4 associated distinct output duty-cycles: full, high, low and | ||
168 | off. Full and off are internally hard-wired to 255 (100%) and 0 (0%), | ||
169 | respectively. High and low can be programmed via | ||
170 | pwm[1-2]_auto_point[2-3]_pwm. Each PWM output can be associated with a | ||
171 | different thermal input but - and here's the weird part - only one set of | ||
172 | thermal thresholds exist that controls both PWMs output duty-cycles. The | ||
173 | thermal thresholds are accessible via pwm[1-2]_auto_point[1-4]_temp. Note | ||
174 | that even though there are 2 sets of 4 auto points each, they map to the same | ||
175 | registers in the VT1211 and programming one set is sufficient (actually only | ||
176 | the first set pwm1_auto_point[1-4]_temp is writable, the second set is | ||
177 | read-only). | ||
178 | |||
179 | PWM Auto Point PWM Output Duty-Cycle | ||
180 | ------------------------------------------------ | ||
181 | pwm[1-2]_auto_point4_pwm full speed duty-cycle (hard-wired to 255) | ||
182 | pwm[1-2]_auto_point3_pwm high speed duty-cycle | ||
183 | pwm[1-2]_auto_point2_pwm low speed duty-cycle | ||
184 | pwm[1-2]_auto_point1_pwm off duty-cycle (hard-wired to 0) | ||
185 | |||
186 | Temp Auto Point Thermal Threshold | ||
187 | --------------------------------------------- | ||
188 | pwm[1-2]_auto_point4_temp full speed temp | ||
189 | pwm[1-2]_auto_point3_temp high speed temp | ||
190 | pwm[1-2]_auto_point2_temp low speed temp | ||
191 | pwm[1-2]_auto_point1_temp off temp | ||
192 | |||
193 | Long story short, the controller implements the following algorithm to set the | ||
194 | PWM output duty-cycle based on the input temperature: | ||
195 | |||
196 | Thermal Threshold Output Duty-Cycle | ||
197 | (Rising Temp) (Falling Temp) | ||
198 | ---------------------------------------------------------- | ||
199 | full speed duty-cycle full speed duty-cycle | ||
200 | full speed temp | ||
201 | high speed duty-cycle full speed duty-cycle | ||
202 | high speed temp | ||
203 | low speed duty-cycle high speed duty-cycle | ||
204 | low speed temp | ||
205 | off duty-cycle low speed duty-cycle | ||
206 | off temp | ||
diff --git a/Documentation/hwmon/w83627ehf b/Documentation/hwmon/w83627ehf new file mode 100644 index 000000000000..fae3b781d82d --- /dev/null +++ b/Documentation/hwmon/w83627ehf | |||
@@ -0,0 +1,85 @@ | |||
1 | Kernel driver w83627ehf | ||
2 | ======================= | ||
3 | |||
4 | Supported chips: | ||
5 | * Winbond W83627EHF/EHG (ISA access ONLY) | ||
6 | Prefix: 'w83627ehf' | ||
7 | Addresses scanned: ISA address retrieved from Super I/O registers | ||
8 | Datasheet: http://www.winbond-usa.com/products/winbond_products/pdfs/PCIC/W83627EHF_%20W83627EHGb.pdf | ||
9 | |||
10 | Authors: | ||
11 | Jean Delvare <khali@linux-fr.org> | ||
12 | Yuan Mu (Winbond) | ||
13 | Rudolf Marek <r.marek@sh.cvut.cz> | ||
14 | |||
15 | Description | ||
16 | ----------- | ||
17 | |||
18 | This driver implements support for the Winbond W83627EHF and W83627EHG | ||
19 | super I/O chips. We will refer to them collectively as Winbond chips. | ||
20 | |||
21 | The chips implement three temperature sensors, five fan rotation | ||
22 | speed sensors, ten analog voltage sensors, alarms with beep warnings (control | ||
23 | unimplemented), and some automatic fan regulation strategies (plus manual | ||
24 | fan control mode). | ||
25 | |||
26 | Temperatures are measured in degrees Celsius and measurement resolution is 1 | ||
27 | degC for temp1 and 0.5 degC for temp2 and temp3. An alarm is triggered when | ||
28 | the temperature gets higher than high limit; it stays on until the temperature | ||
29 | falls below the Hysteresis value. | ||
30 | |||
31 | Fan rotation speeds are reported in RPM (rotations per minute). An alarm is | ||
32 | triggered if the rotation speed has dropped below a programmable limit. Fan | ||
33 | readings can be divided by a programmable divider (1, 2, 4, 8, 16, 32, 64 or | ||
34 | 128) to give the readings more range or accuracy. The driver sets the most | ||
35 | suitable fan divisor itself. Some fans might not be present because they | ||
36 | share pins with other functions. | ||
37 | |||
38 | Voltage sensors (also known as IN sensors) report their values in millivolts. | ||
39 | An alarm is triggered if the voltage has crossed a programmable minimum | ||
40 | or maximum limit. | ||
41 | |||
42 | The driver supports automatic fan control mode known as Thermal Cruise. | ||
43 | In this mode, the chip attempts to keep the measured temperature in a | ||
44 | predefined temperature range. If the temperature goes out of range, fan | ||
45 | is driven slower/faster to reach the predefined range again. | ||
46 | |||
47 | The mode works for fan1-fan4. Mapping of temperatures to pwm outputs is as | ||
48 | follows: | ||
49 | |||
50 | temp1 -> pwm1 | ||
51 | temp2 -> pwm2 | ||
52 | temp3 -> pwm3 | ||
53 | prog -> pwm4 (the programmable setting is not supported by the driver) | ||
54 | |||
55 | /sys files | ||
56 | ---------- | ||
57 | |||
58 | pwm[1-4] - this file stores PWM duty cycle or DC value (fan speed) in range: | ||
59 | 0 (stop) to 255 (full) | ||
60 | |||
61 | pwm[1-4]_enable - this file controls mode of fan/temperature control: | ||
62 | * 1 Manual Mode, write to pwm file any value 0-255 (full speed) | ||
63 | * 2 Thermal Cruise | ||
64 | |||
65 | Thermal Cruise mode | ||
66 | ------------------- | ||
67 | |||
68 | If the temperature is in the range defined by: | ||
69 | |||
70 | pwm[1-4]_target - set target temperature, unit millidegree Celcius | ||
71 | (range 0 - 127000) | ||
72 | pwm[1-4]_tolerance - tolerance, unit millidegree Celcius (range 0 - 15000) | ||
73 | |||
74 | there are no changes to fan speed. Once the temperature leaves the interval, | ||
75 | fan speed increases (temp is higher) or decreases if lower than desired. | ||
76 | There are defined steps and times, but not exported by the driver yet. | ||
77 | |||
78 | pwm[1-4]_min_output - minimum fan speed (range 1 - 255), when the temperature | ||
79 | is below defined range. | ||
80 | pwm[1-4]_stop_time - how many milliseconds [ms] must elapse to switch | ||
81 | corresponding fan off. (when the temperature was below | ||
82 | defined range). | ||
83 | |||
84 | Note: last two functions are influenced by other control bits, not yet exported | ||
85 | by the driver, so a change might not have any effect. | ||
diff --git a/Documentation/hwmon/w83791d b/Documentation/hwmon/w83791d index 83a3836289c2..19b2ed739fa1 100644 --- a/Documentation/hwmon/w83791d +++ b/Documentation/hwmon/w83791d | |||
@@ -5,7 +5,7 @@ Supported chips: | |||
5 | * Winbond W83791D | 5 | * Winbond W83791D |
6 | Prefix: 'w83791d' | 6 | Prefix: 'w83791d' |
7 | Addresses scanned: I2C 0x2c - 0x2f | 7 | Addresses scanned: I2C 0x2c - 0x2f |
8 | Datasheet: http://www.winbond-usa.com/products/winbond_products/pdfs/PCIC/W83791Da.pdf | 8 | Datasheet: http://www.winbond-usa.com/products/winbond_products/pdfs/PCIC/W83791D_W83791Gb.pdf |
9 | 9 | ||
10 | Author: Charles Spirakis <bezaur@gmail.com> | 10 | Author: Charles Spirakis <bezaur@gmail.com> |
11 | 11 | ||
@@ -20,6 +20,9 @@ Credits: | |||
20 | Chunhao Huang <DZShen@Winbond.com.tw>, | 20 | Chunhao Huang <DZShen@Winbond.com.tw>, |
21 | Rudolf Marek <r.marek@sh.cvut.cz> | 21 | Rudolf Marek <r.marek@sh.cvut.cz> |
22 | 22 | ||
23 | Additional contributors: | ||
24 | Sven Anders <anders@anduras.de> | ||
25 | |||
23 | Module Parameters | 26 | Module Parameters |
24 | ----------------- | 27 | ----------------- |
25 | 28 | ||
@@ -46,7 +49,8 @@ Module Parameters | |||
46 | Description | 49 | Description |
47 | ----------- | 50 | ----------- |
48 | 51 | ||
49 | This driver implements support for the Winbond W83791D chip. | 52 | This driver implements support for the Winbond W83791D chip. The W83791G |
53 | chip appears to be the same as the W83791D but is lead free. | ||
50 | 54 | ||
51 | Detection of the chip can sometimes be foiled because it can be in an | 55 | Detection of the chip can sometimes be foiled because it can be in an |
52 | internal state that allows no clean access (Bank with ID register is not | 56 | internal state that allows no clean access (Bank with ID register is not |
@@ -71,34 +75,36 @@ Voltage sensors (also known as IN sensors) report their values in millivolts. | |||
71 | An alarm is triggered if the voltage has crossed a programmable minimum | 75 | An alarm is triggered if the voltage has crossed a programmable minimum |
72 | or maximum limit. | 76 | or maximum limit. |
73 | 77 | ||
74 | Alarms are provided as output from a "realtime status register". The | 78 | The bit ordering for the alarm "realtime status register" and the |
75 | following bits are defined: | 79 | "beep enable registers" are different. |
76 | 80 | ||
77 | bit - alarm on: | 81 | in0 (VCORE) : alarms: 0x000001 beep_enable: 0x000001 |
78 | 0 - Vcore | 82 | in1 (VINR0) : alarms: 0x000002 beep_enable: 0x002000 <== mismatch |
79 | 1 - VINR0 | 83 | in2 (+3.3VIN): alarms: 0x000004 beep_enable: 0x000004 |
80 | 2 - +3.3VIN | 84 | in3 (5VDD) : alarms: 0x000008 beep_enable: 0x000008 |
81 | 3 - 5VDD | 85 | in4 (+12VIN) : alarms: 0x000100 beep_enable: 0x000100 |
82 | 4 - temp1 | 86 | in5 (-12VIN) : alarms: 0x000200 beep_enable: 0x000200 |
83 | 5 - temp2 | 87 | in6 (-5VIN) : alarms: 0x000400 beep_enable: 0x000400 |
84 | 6 - fan1 | 88 | in7 (VSB) : alarms: 0x080000 beep_enable: 0x010000 <== mismatch |
85 | 7 - fan2 | 89 | in8 (VBAT) : alarms: 0x100000 beep_enable: 0x020000 <== mismatch |
86 | 8 - +12VIN | 90 | in9 (VINR1) : alarms: 0x004000 beep_enable: 0x004000 |
87 | 9 - -12VIN | 91 | temp1 : alarms: 0x000010 beep_enable: 0x000010 |
88 | 10 - -5VIN | 92 | temp2 : alarms: 0x000020 beep_enable: 0x000020 |
89 | 11 - fan3 | 93 | temp3 : alarms: 0x002000 beep_enable: 0x000002 <== mismatch |
90 | 12 - chassis | 94 | fan1 : alarms: 0x000040 beep_enable: 0x000040 |
91 | 13 - temp3 | 95 | fan2 : alarms: 0x000080 beep_enable: 0x000080 |
92 | 14 - VINR1 | 96 | fan3 : alarms: 0x000800 beep_enable: 0x000800 |
93 | 15 - reserved | 97 | fan4 : alarms: 0x200000 beep_enable: 0x200000 |
94 | 16 - tart1 | 98 | fan5 : alarms: 0x400000 beep_enable: 0x400000 |
95 | 17 - tart2 | 99 | tart1 : alarms: 0x010000 beep_enable: 0x040000 <== mismatch |
96 | 18 - tart3 | 100 | tart2 : alarms: 0x020000 beep_enable: 0x080000 <== mismatch |
97 | 19 - VSB | 101 | tart3 : alarms: 0x040000 beep_enable: 0x100000 <== mismatch |
98 | 20 - VBAT | 102 | case_open : alarms: 0x001000 beep_enable: 0x001000 |
99 | 21 - fan4 | 103 | user_enable : alarms: -------- beep_enable: 0x800000 |
100 | 22 - fan5 | 104 | |
101 | 23 - reserved | 105 | *** NOTE: It is the responsibility of user-space code to handle the fact |
106 | that the beep enable and alarm bits are in different positions when using that | ||
107 | feature of the chip. | ||
102 | 108 | ||
103 | When an alarm goes off, you can be warned by a beeping signal through your | 109 | When an alarm goes off, you can be warned by a beeping signal through your |
104 | computer speaker. It is possible to enable all beeping globally, or only | 110 | computer speaker. It is possible to enable all beeping globally, or only |
@@ -109,5 +115,6 @@ often will do no harm, but will return 'old' values. | |||
109 | 115 | ||
110 | W83791D TODO: | 116 | W83791D TODO: |
111 | --------------- | 117 | --------------- |
112 | Provide a patch for per-file alarms as discussed on the mailing list | 118 | Provide a patch for per-file alarms and beep enables as defined in the hwmon |
119 | documentation (Documentation/hwmon/sysfs-interface) | ||
113 | Provide a patch for smart-fan control (still need appropriate motherboard/fans) | 120 | Provide a patch for smart-fan control (still need appropriate motherboard/fans) |
diff --git a/Documentation/i2c/busses/i2c-viapro b/Documentation/i2c/busses/i2c-viapro index 16775663b9f5..25680346e0ac 100644 --- a/Documentation/i2c/busses/i2c-viapro +++ b/Documentation/i2c/busses/i2c-viapro | |||
@@ -7,9 +7,12 @@ Supported adapters: | |||
7 | * VIA Technologies, Inc. VT82C686A/B | 7 | * VIA Technologies, Inc. VT82C686A/B |
8 | Datasheet: Sometimes available at the VIA website | 8 | Datasheet: Sometimes available at the VIA website |
9 | 9 | ||
10 | * VIA Technologies, Inc. VT8231, VT8233, VT8233A, VT8235, VT8237R | 10 | * VIA Technologies, Inc. VT8231, VT8233, VT8233A |
11 | Datasheet: available on request from VIA | 11 | Datasheet: available on request from VIA |
12 | 12 | ||
13 | * VIA Technologies, Inc. VT8235, VT8237R, VT8237A, VT8251 | ||
14 | Datasheet: available on request and under NDA from VIA | ||
15 | |||
13 | Authors: | 16 | Authors: |
14 | Kyösti Mälkki <kmalkki@cc.hut.fi>, | 17 | Kyösti Mälkki <kmalkki@cc.hut.fi>, |
15 | Mark D. Studebaker <mdsxyz123@yahoo.com>, | 18 | Mark D. Studebaker <mdsxyz123@yahoo.com>, |
@@ -39,6 +42,8 @@ Your lspci -n listing must show one of these : | |||
39 | device 1106:8235 (VT8231 function 4) | 42 | device 1106:8235 (VT8231 function 4) |
40 | device 1106:3177 (VT8235) | 43 | device 1106:3177 (VT8235) |
41 | device 1106:3227 (VT8237R) | 44 | device 1106:3227 (VT8237R) |
45 | device 1106:3337 (VT8237A) | ||
46 | device 1106:3287 (VT8251) | ||
42 | 47 | ||
43 | If none of these show up, you should look in the BIOS for settings like | 48 | If none of these show up, you should look in the BIOS for settings like |
44 | enable ACPI / SMBus or even USB. | 49 | enable ACPI / SMBus or even USB. |
diff --git a/Documentation/i2c/i2c-stub b/Documentation/i2c/i2c-stub index d6dcb138abf5..9cc081e69764 100644 --- a/Documentation/i2c/i2c-stub +++ b/Documentation/i2c/i2c-stub | |||
@@ -6,9 +6,12 @@ This module is a very simple fake I2C/SMBus driver. It implements four | |||
6 | types of SMBus commands: write quick, (r/w) byte, (r/w) byte data, and | 6 | types of SMBus commands: write quick, (r/w) byte, (r/w) byte data, and |
7 | (r/w) word data. | 7 | (r/w) word data. |
8 | 8 | ||
9 | You need to provide a chip address as a module parameter when loading | ||
10 | this driver, which will then only react to SMBus commands to this address. | ||
11 | |||
9 | No hardware is needed nor associated with this module. It will accept write | 12 | No hardware is needed nor associated with this module. It will accept write |
10 | quick commands to all addresses; it will respond to the other commands (also | 13 | quick commands to one address; it will respond to the other commands (also |
11 | to all addresses) by reading from or writing to an array in memory. It will | 14 | to one address) by reading from or writing to an array in memory. It will |
12 | also spam the kernel logs for every command it handles. | 15 | also spam the kernel logs for every command it handles. |
13 | 16 | ||
14 | A pointer register with auto-increment is implemented for all byte | 17 | A pointer register with auto-increment is implemented for all byte |
@@ -21,6 +24,11 @@ The typical use-case is like this: | |||
21 | 3. load the target sensors chip driver module | 24 | 3. load the target sensors chip driver module |
22 | 4. observe its behavior in the kernel log | 25 | 4. observe its behavior in the kernel log |
23 | 26 | ||
27 | PARAMETERS: | ||
28 | |||
29 | int chip_addr: | ||
30 | The SMBus address to emulate a chip at. | ||
31 | |||
24 | CAVEATS: | 32 | CAVEATS: |
25 | 33 | ||
26 | There are independent arrays for byte/data and word/data commands. Depending | 34 | There are independent arrays for byte/data and word/data commands. Depending |
@@ -33,6 +41,9 @@ If the hardware for your driver has banked registers (e.g. Winbond sensors | |||
33 | chips) this module will not work well - although it could be extended to | 41 | chips) this module will not work well - although it could be extended to |
34 | support that pretty easily. | 42 | support that pretty easily. |
35 | 43 | ||
44 | Only one chip address is supported - although this module could be | ||
45 | extended to support more. | ||
46 | |||
36 | If you spam it hard enough, printk can be lossy. This module really wants | 47 | If you spam it hard enough, printk can be lossy. This module really wants |
37 | something like relayfs. | 48 | something like relayfs. |
38 | 49 | ||
diff --git a/Documentation/ia64/serial.txt b/Documentation/ia64/serial.txt index f51eb4bc2ff1..040b9773209f 100644 --- a/Documentation/ia64/serial.txt +++ b/Documentation/ia64/serial.txt | |||
@@ -124,6 +124,13 @@ TROUBLESHOOTING SERIAL CONSOLE PROBLEMS | |||
124 | 124 | ||
125 | - Add entry to /etc/securetty for console tty. | 125 | - Add entry to /etc/securetty for console tty. |
126 | 126 | ||
127 | No ACPI serial devices found in 2.6.17 or later: | ||
128 | |||
129 | - Turn on CONFIG_PNP and CONFIG_PNPACPI. Prior to 2.6.17, ACPI | ||
130 | serial devices were discovered by 8250_acpi. In 2.6.17, | ||
131 | 8250_acpi was replaced by the combination of 8250_pnp and | ||
132 | CONFIG_PNPACPI. | ||
133 | |||
127 | 134 | ||
128 | 135 | ||
129 | [1] http://www.dig64.org/specifications/DIG64_PCDPv20.pdf | 136 | [1] http://www.dig64.org/specifications/DIG64_PCDPv20.pdf |
diff --git a/Documentation/input/ff.txt b/Documentation/input/ff.txt index c7e10eaff203..c53b1c11aa40 100644 --- a/Documentation/input/ff.txt +++ b/Documentation/input/ff.txt | |||
@@ -1,67 +1,37 @@ | |||
1 | Force feedback for Linux. | 1 | Force feedback for Linux. |
2 | By Johann Deneux <deneux@ifrance.com> on 2001/04/22. | 2 | By Johann Deneux <deneux@ifrance.com> on 2001/04/22. |
3 | Updated by Anssi Hannula <anssi.hannula@gmail.com> on 2006/04/09. | ||
3 | You may redistribute this file. Please remember to include shape.fig and | 4 | You may redistribute this file. Please remember to include shape.fig and |
4 | interactive.fig as well. | 5 | interactive.fig as well. |
5 | ---------------------------------------------------------------------------- | 6 | ---------------------------------------------------------------------------- |
6 | 7 | ||
7 | 0. Introduction | 8 | 1. Introduction |
8 | ~~~~~~~~~~~~~~~ | 9 | ~~~~~~~~~~~~~~~ |
9 | This document describes how to use force feedback devices under Linux. The | 10 | This document describes how to use force feedback devices under Linux. The |
10 | goal is not to support these devices as if they were simple input-only devices | 11 | goal is not to support these devices as if they were simple input-only devices |
11 | (as it is already the case), but to really enable the rendering of force | 12 | (as it is already the case), but to really enable the rendering of force |
12 | effects. | 13 | effects. |
13 | At the moment, only I-Force devices are supported, and not officially. That | 14 | This document only describes the force feedback part of the Linux input |
14 | means I had to find out how the protocol works on my own. Of course, the | 15 | interface. Please read joystick.txt and input.txt before reading further this |
15 | information I managed to grasp is far from being complete, and I can not | 16 | document. |
16 | guarranty that this driver will work for you. | ||
17 | This document only describes the force feedback part of the driver for I-Force | ||
18 | devices. Please read joystick.txt before reading further this document. | ||
19 | 17 | ||
20 | 2. Instructions to the user | 18 | 2. Instructions to the user |
21 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 19 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
22 | Here are instructions on how to compile and use the driver. In fact, this | 20 | To enable force feedback, you have to: |
23 | driver is the normal iforce, input and evdev drivers written by Vojtech | 21 | |
24 | Pavlik, plus additions to support force feedback. | 22 | 1. have your kernel configured with evdev and a driver that supports your |
23 | device. | ||
24 | 2. make sure evdev module is loaded and /dev/input/event* device files are | ||
25 | created. | ||
25 | 26 | ||
26 | Before you start, let me WARN you that some devices shake violently during the | 27 | Before you start, let me WARN you that some devices shake violently during the |
27 | initialisation phase. This happens for example with my "AVB Top Shot Pegasus". | 28 | initialisation phase. This happens for example with my "AVB Top Shot Pegasus". |
28 | To stop this annoying behaviour, move you joystick to its limits. Anyway, you | 29 | To stop this annoying behaviour, move you joystick to its limits. Anyway, you |
29 | should keep a hand on your device, in order to avoid it to brake down if | 30 | should keep a hand on your device, in order to avoid it to break down if |
30 | something goes wrong. | 31 | something goes wrong. |
31 | 32 | ||
32 | At the kernel's compilation: | 33 | If you have a serial iforce device, you need to start inputattach. See |
33 | - Enable IForce/Serial | 34 | joystick.txt for details. |
34 | - Enable Event interface | ||
35 | |||
36 | Compile the modules, install them. | ||
37 | |||
38 | You also need inputattach. | ||
39 | |||
40 | You then need to insert the modules into the following order: | ||
41 | % modprobe joydev | ||
42 | % modprobe serport # Only for serial | ||
43 | % modprobe iforce | ||
44 | % modprobe evdev | ||
45 | % ./inputattach -ifor $2 & # Only for serial | ||
46 | If you are using USB, you don't need the inputattach step. | ||
47 | |||
48 | Please check that you have all the /dev/input entries needed: | ||
49 | cd /dev | ||
50 | rm js* | ||
51 | mkdir input | ||
52 | mknod input/js0 c 13 0 | ||
53 | mknod input/js1 c 13 1 | ||
54 | mknod input/js2 c 13 2 | ||
55 | mknod input/js3 c 13 3 | ||
56 | ln -s input/js0 js0 | ||
57 | ln -s input/js1 js1 | ||
58 | ln -s input/js2 js2 | ||
59 | ln -s input/js3 js3 | ||
60 | |||
61 | mknod input/event0 c 13 64 | ||
62 | mknod input/event1 c 13 65 | ||
63 | mknod input/event2 c 13 66 | ||
64 | mknod input/event3 c 13 67 | ||
65 | 35 | ||
66 | 2.1 Does it work ? | 36 | 2.1 Does it work ? |
67 | ~~~~~~~~~~~~~~~~~~ | 37 | ~~~~~~~~~~~~~~~~~~ |
@@ -70,9 +40,9 @@ There is an utility called fftest that will allow you to test the driver. | |||
70 | 40 | ||
71 | 3. Instructions to the developper | 41 | 3. Instructions to the developper |
72 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 42 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
73 | All interactions are done using the event API. That is, you can use ioctl() | 43 | All interactions are done using the event API. That is, you can use ioctl() |
74 | and write() on /dev/input/eventXX. | 44 | and write() on /dev/input/eventXX. |
75 | This information is subject to change. | 45 | This information is subject to change. |
76 | 46 | ||
77 | 3.1 Querying device capabilities | 47 | 3.1 Querying device capabilities |
78 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 48 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
@@ -86,18 +56,29 @@ int ioctl(int file_descriptor, int request, unsigned long *features); | |||
86 | 56 | ||
87 | Returns the features supported by the device. features is a bitfield with the | 57 | Returns the features supported by the device. features is a bitfield with the |
88 | following bits: | 58 | following bits: |
89 | - FF_X has an X axis (usually joysticks) | ||
90 | - FF_Y has an Y axis (usually joysticks) | ||
91 | - FF_WHEEL has a wheel (usually sterring wheels) | ||
92 | - FF_CONSTANT can render constant force effects | 59 | - FF_CONSTANT can render constant force effects |
93 | - FF_PERIODIC can render periodic effects (sine, triangle, square...) | 60 | - FF_PERIODIC can render periodic effects with the following waveforms: |
61 | - FF_SQUARE square waveform | ||
62 | - FF_TRIANGLE triangle waveform | ||
63 | - FF_SINE sine waveform | ||
64 | - FF_SAW_UP sawtooth up waveform | ||
65 | - FF_SAW_DOWN sawtooth down waveform | ||
66 | - FF_CUSTOM custom waveform | ||
94 | - FF_RAMP can render ramp effects | 67 | - FF_RAMP can render ramp effects |
95 | - FF_SPRING can simulate the presence of a spring | 68 | - FF_SPRING can simulate the presence of a spring |
96 | - FF_FRICTION can simulate friction | 69 | - FF_FRICTION can simulate friction |
97 | - FF_DAMPER can simulate damper effects | 70 | - FF_DAMPER can simulate damper effects |
98 | - FF_RUMBLE rumble effects (normally the only effect supported by rumble | 71 | - FF_RUMBLE rumble effects |
99 | pads) | ||
100 | - FF_INERTIA can simulate inertia | 72 | - FF_INERTIA can simulate inertia |
73 | - FF_GAIN gain is adjustable | ||
74 | - FF_AUTOCENTER autocenter is adjustable | ||
75 | |||
76 | Note: In most cases you should use FF_PERIODIC instead of FF_RUMBLE. All | ||
77 | devices that support FF_RUMBLE support FF_PERIODIC (square, triangle, | ||
78 | sine) and the other way around. | ||
79 | |||
80 | Note: The exact syntax FF_CUSTOM is undefined for the time being as no driver | ||
81 | supports it yet. | ||
101 | 82 | ||
102 | 83 | ||
103 | int ioctl(int fd, EVIOCGEFFECTS, int *n); | 84 | int ioctl(int fd, EVIOCGEFFECTS, int *n); |
@@ -108,7 +89,7 @@ Returns the number of effects the device can keep in its memory. | |||
108 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 89 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
109 | #include <linux/input.h> | 90 | #include <linux/input.h> |
110 | #include <sys/ioctl.h> | 91 | #include <sys/ioctl.h> |
111 | 92 | ||
112 | int ioctl(int file_descriptor, int request, struct ff_effect *effect); | 93 | int ioctl(int file_descriptor, int request, struct ff_effect *effect); |
113 | 94 | ||
114 | "request" must be EVIOCSFF. | 95 | "request" must be EVIOCSFF. |
@@ -120,6 +101,9 @@ to the unique id assigned by the driver. This data is required for performing | |||
120 | some operations (removing an effect, controlling the playback). | 101 | some operations (removing an effect, controlling the playback). |
121 | This if field must be set to -1 by the user in order to tell the driver to | 102 | This if field must be set to -1 by the user in order to tell the driver to |
122 | allocate a new effect. | 103 | allocate a new effect. |
104 | |||
105 | Effects are file descriptor specific. | ||
106 | |||
123 | See <linux/input.h> for a description of the ff_effect struct. You should also | 107 | See <linux/input.h> for a description of the ff_effect struct. You should also |
124 | find help in a few sketches, contained in files shape.fig and interactive.fig. | 108 | find help in a few sketches, contained in files shape.fig and interactive.fig. |
125 | You need xfig to visualize these files. | 109 | You need xfig to visualize these files. |
@@ -128,8 +112,8 @@ You need xfig to visualize these files. | |||
128 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 112 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
129 | int ioctl(int fd, EVIOCRMFF, effect.id); | 113 | int ioctl(int fd, EVIOCRMFF, effect.id); |
130 | 114 | ||
131 | This makes room for new effects in the device's memory. Please note this won't | 115 | This makes room for new effects in the device's memory. Note that this also |
132 | stop the effect if it was playing. | 116 | stops the effect if it was playing. |
133 | 117 | ||
134 | 3.4 Controlling the playback of effects | 118 | 3.4 Controlling the playback of effects |
135 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 119 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
@@ -149,22 +133,21 @@ Control of playing is done with write(). Below is an example: | |||
149 | play.type = EV_FF; | 133 | play.type = EV_FF; |
150 | play.code = effect.id; | 134 | play.code = effect.id; |
151 | play.value = 3; | 135 | play.value = 3; |
152 | 136 | ||
153 | write(fd, (const void*) &play, sizeof(play)); | 137 | write(fd, (const void*) &play, sizeof(play)); |
154 | ... | 138 | ... |
155 | /* Stop an effect */ | 139 | /* Stop an effect */ |
156 | stop.type = EV_FF; | 140 | stop.type = EV_FF; |
157 | stop.code = effect.id; | 141 | stop.code = effect.id; |
158 | stop.value = 0; | 142 | stop.value = 0; |
159 | 143 | ||
160 | write(fd, (const void*) &play, sizeof(stop)); | 144 | write(fd, (const void*) &play, sizeof(stop)); |
161 | 145 | ||
162 | 3.5 Setting the gain | 146 | 3.5 Setting the gain |
163 | ~~~~~~~~~~~~~~~~~~~~ | 147 | ~~~~~~~~~~~~~~~~~~~~ |
164 | Not all devices have the same strength. Therefore, users should set a gain | 148 | Not all devices have the same strength. Therefore, users should set a gain |
165 | factor depending on how strong they want effects to be. This setting is | 149 | factor depending on how strong they want effects to be. This setting is |
166 | persistent across access to the driver, so you should not care about it if | 150 | persistent across access to the driver. |
167 | you are writing games, as another utility probably already set this for you. | ||
168 | 151 | ||
169 | /* Set the gain of the device | 152 | /* Set the gain of the device |
170 | int gain; /* between 0 and 100 */ | 153 | int gain; /* between 0 and 100 */ |
@@ -204,11 +187,14 @@ type of device, not all parameters can be dynamically updated. For example, | |||
204 | the direction of an effect cannot be updated with iforce devices. In this | 187 | the direction of an effect cannot be updated with iforce devices. In this |
205 | case, the driver stops the effect, up-load it, and restart it. | 188 | case, the driver stops the effect, up-load it, and restart it. |
206 | 189 | ||
190 | Therefore it is recommended to dynamically change direction while the effect | ||
191 | is playing only when it is ok to restart the effect with a replay count of 1. | ||
207 | 192 | ||
208 | 3.8 Information about the status of effects | 193 | 3.8 Information about the status of effects |
209 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 194 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
210 | Every time the status of an effect is changed, an event is sent. The values | 195 | Every time the status of an effect is changed, an event is sent. The values |
211 | and meanings of the fields of the event are as follows: | 196 | and meanings of the fields of the event are as follows: |
197 | |||
212 | struct input_event { | 198 | struct input_event { |
213 | /* When the status of the effect changed */ | 199 | /* When the status of the effect changed */ |
214 | struct timeval time; | 200 | struct timeval time; |
@@ -225,3 +211,9 @@ struct input_event { | |||
225 | 211 | ||
226 | FF_STATUS_STOPPED The effect stopped playing | 212 | FF_STATUS_STOPPED The effect stopped playing |
227 | FF_STATUS_PLAYING The effect started to play | 213 | FF_STATUS_PLAYING The effect started to play |
214 | |||
215 | NOTE: Status feedback is only supported by iforce driver. If you have | ||
216 | a really good reason to use this, please contact | ||
217 | linux-joystick@atrey.karlin.mff.cuni.cz or anssi.hannula@gmail.com | ||
218 | so that support for it can be added to the rest of the drivers. | ||
219 | |||
diff --git a/Documentation/kbuild/makefiles.txt b/Documentation/kbuild/makefiles.txt index b7d6abb501a6..e2cbd59cf2d0 100644 --- a/Documentation/kbuild/makefiles.txt +++ b/Documentation/kbuild/makefiles.txt | |||
@@ -421,6 +421,11 @@ more details, with real examples. | |||
421 | The second argument is optional, and if supplied will be used | 421 | The second argument is optional, and if supplied will be used |
422 | if first argument is not supported. | 422 | if first argument is not supported. |
423 | 423 | ||
424 | as-instr | ||
425 | as-instr checks if the assembler reports a specific instruction | ||
426 | and then outputs either option1 or option2 | ||
427 | C escapes are supported in the test instruction | ||
428 | |||
424 | cc-option | 429 | cc-option |
425 | cc-option is used to check if $(CC) supports a given option, and not | 430 | cc-option is used to check if $(CC) supports a given option, and not |
426 | supported to use an optional second option. | 431 | supported to use an optional second option. |
diff --git a/Documentation/kbuild/modules.txt b/Documentation/kbuild/modules.txt index 2e7702e94a78..769ee05ee4d1 100644 --- a/Documentation/kbuild/modules.txt +++ b/Documentation/kbuild/modules.txt | |||
@@ -43,7 +43,7 @@ are not planned to be included in the kernel tree. | |||
43 | What is covered within this file is mainly information to authors | 43 | What is covered within this file is mainly information to authors |
44 | of modules. The author of an external module should supply | 44 | of modules. The author of an external module should supply |
45 | a makefile that hides most of the complexity, so one only has to type | 45 | a makefile that hides most of the complexity, so one only has to type |
46 | 'make' to build the module. A complete example will be present in | 46 | 'make' to build the module. A complete example will be presented in |
47 | chapter 4, "Creating a kbuild file for an external module". | 47 | chapter 4, "Creating a kbuild file for an external module". |
48 | 48 | ||
49 | 49 | ||
@@ -61,6 +61,7 @@ when building an external module. | |||
61 | make -C <path-to-kernel> M=`pwd` | 61 | make -C <path-to-kernel> M=`pwd` |
62 | 62 | ||
63 | For the running kernel use: | 63 | For the running kernel use: |
64 | |||
64 | make -C /lib/modules/`uname -r`/build M=`pwd` | 65 | make -C /lib/modules/`uname -r`/build M=`pwd` |
65 | 66 | ||
66 | For the above command to succeed, the kernel must have been | 67 | For the above command to succeed, the kernel must have been |
@@ -130,10 +131,10 @@ when building an external module. | |||
130 | 131 | ||
131 | To make sure the kernel contains the information required to | 132 | To make sure the kernel contains the information required to |
132 | build external modules the target 'modules_prepare' must be used. | 133 | build external modules the target 'modules_prepare' must be used. |
133 | 'module_prepare' exists solely as a simple way to prepare | 134 | 'modules_prepare' exists solely as a simple way to prepare |
134 | a kernel source tree for building external modules. | 135 | a kernel source tree for building external modules. |
135 | Note: modules_prepare will not build Module.symvers even if | 136 | Note: modules_prepare will not build Module.symvers even if |
136 | CONFIG_MODULEVERSIONING is set. Therefore a full kernel build | 137 | CONFIG_MODVERSIONS is set. Therefore a full kernel build |
137 | needs to be executed to make module versioning work. | 138 | needs to be executed to make module versioning work. |
138 | 139 | ||
139 | --- 2.5 Building separate files for a module | 140 | --- 2.5 Building separate files for a module |
@@ -450,7 +451,7 @@ kernel refuses to load the module. | |||
450 | 451 | ||
451 | Module.symvers contains a list of all exported symbols from a kernel build. | 452 | Module.symvers contains a list of all exported symbols from a kernel build. |
452 | 453 | ||
453 | --- 7.1 Symbols fron the kernel (vmlinux + modules) | 454 | --- 7.1 Symbols from the kernel (vmlinux + modules) |
454 | 455 | ||
455 | During a kernel build, a file named Module.symvers will be generated. | 456 | During a kernel build, a file named Module.symvers will be generated. |
456 | Module.symvers contains all exported symbols from the kernel and | 457 | Module.symvers contains all exported symbols from the kernel and |
diff --git a/Documentation/kernel-parameters.txt b/Documentation/kernel-parameters.txt index 71d05f481727..137e993f4329 100644 --- a/Documentation/kernel-parameters.txt +++ b/Documentation/kernel-parameters.txt | |||
@@ -110,6 +110,13 @@ be entered as an environment variable, whereas its absence indicates that | |||
110 | it will appear as a kernel argument readable via /proc/cmdline by programs | 110 | it will appear as a kernel argument readable via /proc/cmdline by programs |
111 | running once the system is up. | 111 | running once the system is up. |
112 | 112 | ||
113 | The number of kernel parameters is not limited, but the length of the | ||
114 | complete command line (parameters including spaces etc.) is limited to | ||
115 | a fixed number of characters. This limit depends on the architecture | ||
116 | and is between 256 and 4096 characters. It is defined in the file | ||
117 | ./include/asm/setup.h as COMMAND_LINE_SIZE. | ||
118 | |||
119 | |||
113 | 53c7xx= [HW,SCSI] Amiga SCSI controllers | 120 | 53c7xx= [HW,SCSI] Amiga SCSI controllers |
114 | See header of drivers/scsi/53c7xx.c. | 121 | See header of drivers/scsi/53c7xx.c. |
115 | See also Documentation/scsi/ncr53c7xx.txt. | 122 | See also Documentation/scsi/ncr53c7xx.txt. |
@@ -573,8 +580,6 @@ running once the system is up. | |||
573 | gscd= [HW,CD] | 580 | gscd= [HW,CD] |
574 | Format: <io> | 581 | Format: <io> |
575 | 582 | ||
576 | gt96100eth= [NET] MIPS GT96100 Advanced Communication Controller | ||
577 | |||
578 | gus= [HW,OSS] | 583 | gus= [HW,OSS] |
579 | Format: <io>,<irq>,<dma>,<dma16> | 584 | Format: <io>,<irq>,<dma>,<dma16> |
580 | 585 | ||
@@ -1240,7 +1245,11 @@ running once the system is up. | |||
1240 | bootloader. This is currently used on | 1245 | bootloader. This is currently used on |
1241 | IXP2000 systems where the bus has to be | 1246 | IXP2000 systems where the bus has to be |
1242 | configured a certain way for adjunct CPUs. | 1247 | configured a certain way for adjunct CPUs. |
1243 | 1248 | noearly [X86] Don't do any early type 1 scanning. | |
1249 | This might help on some broken boards which | ||
1250 | machine check when some devices' config space | ||
1251 | is read. But various workarounds are disabled | ||
1252 | and some IOMMU drivers will not work. | ||
1244 | pcmv= [HW,PCMCIA] BadgePAD 4 | 1253 | pcmv= [HW,PCMCIA] BadgePAD 4 |
1245 | 1254 | ||
1246 | pd. [PARIDE] | 1255 | pd. [PARIDE] |
@@ -1322,7 +1331,7 @@ running once the system is up. | |||
1322 | pt. [PARIDE] | 1331 | pt. [PARIDE] |
1323 | See Documentation/paride.txt. | 1332 | See Documentation/paride.txt. |
1324 | 1333 | ||
1325 | quiet= [KNL] Disable log messages | 1334 | quiet [KNL] Disable most log messages |
1326 | 1335 | ||
1327 | r128= [HW,DRM] | 1336 | r128= [HW,DRM] |
1328 | 1337 | ||
@@ -1363,6 +1372,14 @@ running once the system is up. | |||
1363 | 1372 | ||
1364 | reserve= [KNL,BUGS] Force the kernel to ignore some iomem area | 1373 | reserve= [KNL,BUGS] Force the kernel to ignore some iomem area |
1365 | 1374 | ||
1375 | reservetop= [IA-32] | ||
1376 | Format: nn[KMG] | ||
1377 | Reserves a hole at the top of the kernel virtual | ||
1378 | address space. | ||
1379 | |||
1380 | reset_devices [KNL] Force drivers to reset the underlying device | ||
1381 | during initialization. | ||
1382 | |||
1366 | resume= [SWSUSP] | 1383 | resume= [SWSUSP] |
1367 | Specify the partition device for software suspend | 1384 | Specify the partition device for software suspend |
1368 | 1385 | ||
diff --git a/Documentation/kprobes.txt b/Documentation/kprobes.txt index 2c3b1eae4280..ba26201d5023 100644 --- a/Documentation/kprobes.txt +++ b/Documentation/kprobes.txt | |||
@@ -151,9 +151,9 @@ So that you can load and unload Kprobes-based instrumentation modules, | |||
151 | make sure "Loadable module support" (CONFIG_MODULES) and "Module | 151 | make sure "Loadable module support" (CONFIG_MODULES) and "Module |
152 | unloading" (CONFIG_MODULE_UNLOAD) are set to "y". | 152 | unloading" (CONFIG_MODULE_UNLOAD) are set to "y". |
153 | 153 | ||
154 | You may also want to ensure that CONFIG_KALLSYMS and perhaps even | 154 | Also make sure that CONFIG_KALLSYMS and perhaps even CONFIG_KALLSYMS_ALL |
155 | CONFIG_KALLSYMS_ALL are set to "y", since kallsyms_lookup_name() | 155 | are set to "y", since kallsyms_lookup_name() is used by the in-kernel |
156 | is a handy, version-independent way to find a function's address. | 156 | kprobe address resolution code. |
157 | 157 | ||
158 | If you need to insert a probe in the middle of a function, you may find | 158 | If you need to insert a probe in the middle of a function, you may find |
159 | it useful to "Compile the kernel with debug info" (CONFIG_DEBUG_INFO), | 159 | it useful to "Compile the kernel with debug info" (CONFIG_DEBUG_INFO), |
@@ -179,6 +179,27 @@ occurs during execution of kp->pre_handler or kp->post_handler, | |||
179 | or during single-stepping of the probed instruction, Kprobes calls | 179 | or during single-stepping of the probed instruction, Kprobes calls |
180 | kp->fault_handler. Any or all handlers can be NULL. | 180 | kp->fault_handler. Any or all handlers can be NULL. |
181 | 181 | ||
182 | NOTE: | ||
183 | 1. With the introduction of the "symbol_name" field to struct kprobe, | ||
184 | the probepoint address resolution will now be taken care of by the kernel. | ||
185 | The following will now work: | ||
186 | |||
187 | kp.symbol_name = "symbol_name"; | ||
188 | |||
189 | (64-bit powerpc intricacies such as function descriptors are handled | ||
190 | transparently) | ||
191 | |||
192 | 2. Use the "offset" field of struct kprobe if the offset into the symbol | ||
193 | to install a probepoint is known. This field is used to calculate the | ||
194 | probepoint. | ||
195 | |||
196 | 3. Specify either the kprobe "symbol_name" OR the "addr". If both are | ||
197 | specified, kprobe registration will fail with -EINVAL. | ||
198 | |||
199 | 4. With CISC architectures (such as i386 and x86_64), the kprobes code | ||
200 | does not validate if the kprobe.addr is at an instruction boundary. | ||
201 | Use "offset" with caution. | ||
202 | |||
182 | register_kprobe() returns 0 on success, or a negative errno otherwise. | 203 | register_kprobe() returns 0 on success, or a negative errno otherwise. |
183 | 204 | ||
184 | User's pre-handler (kp->pre_handler): | 205 | User's pre-handler (kp->pre_handler): |
@@ -225,6 +246,12 @@ control to Kprobes.) If the probed function is declared asmlinkage, | |||
225 | fastcall, or anything else that affects how args are passed, the | 246 | fastcall, or anything else that affects how args are passed, the |
226 | handler's declaration must match. | 247 | handler's declaration must match. |
227 | 248 | ||
249 | NOTE: A macro JPROBE_ENTRY is provided to handle architecture-specific | ||
250 | aliasing of jp->entry. In the interest of portability, it is advised | ||
251 | to use: | ||
252 | |||
253 | jp->entry = JPROBE_ENTRY(handler); | ||
254 | |||
228 | register_jprobe() returns 0 on success, or a negative errno otherwise. | 255 | register_jprobe() returns 0 on success, or a negative errno otherwise. |
229 | 256 | ||
230 | 4.3 register_kretprobe | 257 | 4.3 register_kretprobe |
@@ -251,6 +278,11 @@ of interest: | |||
251 | - ret_addr: the return address | 278 | - ret_addr: the return address |
252 | - rp: points to the corresponding kretprobe object | 279 | - rp: points to the corresponding kretprobe object |
253 | - task: points to the corresponding task struct | 280 | - task: points to the corresponding task struct |
281 | |||
282 | The regs_return_value(regs) macro provides a simple abstraction to | ||
283 | extract the return value from the appropriate register as defined by | ||
284 | the architecture's ABI. | ||
285 | |||
254 | The handler's return value is currently ignored. | 286 | The handler's return value is currently ignored. |
255 | 287 | ||
256 | 4.4 unregister_*probe | 288 | 4.4 unregister_*probe |
@@ -369,7 +401,6 @@ stack trace and selected i386 registers when do_fork() is called. | |||
369 | #include <linux/kernel.h> | 401 | #include <linux/kernel.h> |
370 | #include <linux/module.h> | 402 | #include <linux/module.h> |
371 | #include <linux/kprobes.h> | 403 | #include <linux/kprobes.h> |
372 | #include <linux/kallsyms.h> | ||
373 | #include <linux/sched.h> | 404 | #include <linux/sched.h> |
374 | 405 | ||
375 | /*For each probe you need to allocate a kprobe structure*/ | 406 | /*For each probe you need to allocate a kprobe structure*/ |
@@ -403,18 +434,14 @@ int handler_fault(struct kprobe *p, struct pt_regs *regs, int trapnr) | |||
403 | return 0; | 434 | return 0; |
404 | } | 435 | } |
405 | 436 | ||
406 | int init_module(void) | 437 | static int __init kprobe_init(void) |
407 | { | 438 | { |
408 | int ret; | 439 | int ret; |
409 | kp.pre_handler = handler_pre; | 440 | kp.pre_handler = handler_pre; |
410 | kp.post_handler = handler_post; | 441 | kp.post_handler = handler_post; |
411 | kp.fault_handler = handler_fault; | 442 | kp.fault_handler = handler_fault; |
412 | kp.addr = (kprobe_opcode_t*) kallsyms_lookup_name("do_fork"); | 443 | kp.symbol_name = "do_fork"; |
413 | /* register the kprobe now */ | 444 | |
414 | if (!kp.addr) { | ||
415 | printk("Couldn't find %s to plant kprobe\n", "do_fork"); | ||
416 | return -1; | ||
417 | } | ||
418 | if ((ret = register_kprobe(&kp) < 0)) { | 445 | if ((ret = register_kprobe(&kp) < 0)) { |
419 | printk("register_kprobe failed, returned %d\n", ret); | 446 | printk("register_kprobe failed, returned %d\n", ret); |
420 | return -1; | 447 | return -1; |
@@ -423,12 +450,14 @@ int init_module(void) | |||
423 | return 0; | 450 | return 0; |
424 | } | 451 | } |
425 | 452 | ||
426 | void cleanup_module(void) | 453 | static void __exit kprobe_exit(void) |
427 | { | 454 | { |
428 | unregister_kprobe(&kp); | 455 | unregister_kprobe(&kp); |
429 | printk("kprobe unregistered\n"); | 456 | printk("kprobe unregistered\n"); |
430 | } | 457 | } |
431 | 458 | ||
459 | module_init(kprobe_init) | ||
460 | module_exit(kprobe_exit) | ||
432 | MODULE_LICENSE("GPL"); | 461 | MODULE_LICENSE("GPL"); |
433 | ----- cut here ----- | 462 | ----- cut here ----- |
434 | 463 | ||
@@ -463,7 +492,6 @@ the arguments of do_fork(). | |||
463 | #include <linux/fs.h> | 492 | #include <linux/fs.h> |
464 | #include <linux/uio.h> | 493 | #include <linux/uio.h> |
465 | #include <linux/kprobes.h> | 494 | #include <linux/kprobes.h> |
466 | #include <linux/kallsyms.h> | ||
467 | 495 | ||
468 | /* | 496 | /* |
469 | * Jumper probe for do_fork. | 497 | * Jumper probe for do_fork. |
@@ -485,17 +513,13 @@ long jdo_fork(unsigned long clone_flags, unsigned long stack_start, | |||
485 | } | 513 | } |
486 | 514 | ||
487 | static struct jprobe my_jprobe = { | 515 | static struct jprobe my_jprobe = { |
488 | .entry = (kprobe_opcode_t *) jdo_fork | 516 | .entry = JPROBE_ENTRY(jdo_fork) |
489 | }; | 517 | }; |
490 | 518 | ||
491 | int init_module(void) | 519 | static int __init jprobe_init(void) |
492 | { | 520 | { |
493 | int ret; | 521 | int ret; |
494 | my_jprobe.kp.addr = (kprobe_opcode_t *) kallsyms_lookup_name("do_fork"); | 522 | my_jprobe.kp.symbol_name = "do_fork"; |
495 | if (!my_jprobe.kp.addr) { | ||
496 | printk("Couldn't find %s to plant jprobe\n", "do_fork"); | ||
497 | return -1; | ||
498 | } | ||
499 | 523 | ||
500 | if ((ret = register_jprobe(&my_jprobe)) <0) { | 524 | if ((ret = register_jprobe(&my_jprobe)) <0) { |
501 | printk("register_jprobe failed, returned %d\n", ret); | 525 | printk("register_jprobe failed, returned %d\n", ret); |
@@ -506,12 +530,14 @@ int init_module(void) | |||
506 | return 0; | 530 | return 0; |
507 | } | 531 | } |
508 | 532 | ||
509 | void cleanup_module(void) | 533 | static void __exit jprobe_exit(void) |
510 | { | 534 | { |
511 | unregister_jprobe(&my_jprobe); | 535 | unregister_jprobe(&my_jprobe); |
512 | printk("jprobe unregistered\n"); | 536 | printk("jprobe unregistered\n"); |
513 | } | 537 | } |
514 | 538 | ||
539 | module_init(jprobe_init) | ||
540 | module_exit(jprobe_exit) | ||
515 | MODULE_LICENSE("GPL"); | 541 | MODULE_LICENSE("GPL"); |
516 | ----- cut here ----- | 542 | ----- cut here ----- |
517 | 543 | ||
@@ -530,16 +556,13 @@ report failed calls to sys_open(). | |||
530 | #include <linux/kernel.h> | 556 | #include <linux/kernel.h> |
531 | #include <linux/module.h> | 557 | #include <linux/module.h> |
532 | #include <linux/kprobes.h> | 558 | #include <linux/kprobes.h> |
533 | #include <linux/kallsyms.h> | ||
534 | 559 | ||
535 | static const char *probed_func = "sys_open"; | 560 | static const char *probed_func = "sys_open"; |
536 | 561 | ||
537 | /* Return-probe handler: If the probed function fails, log the return value. */ | 562 | /* Return-probe handler: If the probed function fails, log the return value. */ |
538 | static int ret_handler(struct kretprobe_instance *ri, struct pt_regs *regs) | 563 | static int ret_handler(struct kretprobe_instance *ri, struct pt_regs *regs) |
539 | { | 564 | { |
540 | // Substitute the appropriate register name for your architecture -- | 565 | int retval = regs_return_value(regs); |
541 | // e.g., regs->rax for x86_64, regs->gpr[3] for ppc64. | ||
542 | int retval = (int) regs->eax; | ||
543 | if (retval < 0) { | 566 | if (retval < 0) { |
544 | printk("%s returns %d\n", probed_func, retval); | 567 | printk("%s returns %d\n", probed_func, retval); |
545 | } | 568 | } |
@@ -552,15 +575,11 @@ static struct kretprobe my_kretprobe = { | |||
552 | .maxactive = 20 | 575 | .maxactive = 20 |
553 | }; | 576 | }; |
554 | 577 | ||
555 | int init_module(void) | 578 | static int __init kretprobe_init(void) |
556 | { | 579 | { |
557 | int ret; | 580 | int ret; |
558 | my_kretprobe.kp.addr = | 581 | my_kretprobe.kp.symbol_name = (char *)probed_func; |
559 | (kprobe_opcode_t *) kallsyms_lookup_name(probed_func); | 582 | |
560 | if (!my_kretprobe.kp.addr) { | ||
561 | printk("Couldn't find %s to plant return probe\n", probed_func); | ||
562 | return -1; | ||
563 | } | ||
564 | if ((ret = register_kretprobe(&my_kretprobe)) < 0) { | 583 | if ((ret = register_kretprobe(&my_kretprobe)) < 0) { |
565 | printk("register_kretprobe failed, returned %d\n", ret); | 584 | printk("register_kretprobe failed, returned %d\n", ret); |
566 | return -1; | 585 | return -1; |
@@ -569,7 +588,7 @@ int init_module(void) | |||
569 | return 0; | 588 | return 0; |
570 | } | 589 | } |
571 | 590 | ||
572 | void cleanup_module(void) | 591 | static void __exit kretprobe_exit(void) |
573 | { | 592 | { |
574 | unregister_kretprobe(&my_kretprobe); | 593 | unregister_kretprobe(&my_kretprobe); |
575 | printk("kretprobe unregistered\n"); | 594 | printk("kretprobe unregistered\n"); |
@@ -578,6 +597,8 @@ void cleanup_module(void) | |||
578 | my_kretprobe.nmissed, probed_func); | 597 | my_kretprobe.nmissed, probed_func); |
579 | } | 598 | } |
580 | 599 | ||
600 | module_init(kretprobe_init) | ||
601 | module_exit(kretprobe_exit) | ||
581 | MODULE_LICENSE("GPL"); | 602 | MODULE_LICENSE("GPL"); |
582 | ----- cut here ----- | 603 | ----- cut here ----- |
583 | 604 | ||
@@ -590,3 +611,5 @@ messages.) | |||
590 | For additional information on Kprobes, refer to the following URLs: | 611 | For additional information on Kprobes, refer to the following URLs: |
591 | http://www-106.ibm.com/developerworks/library/l-kprobes.html?ca=dgr-lnxw42Kprobe | 612 | http://www-106.ibm.com/developerworks/library/l-kprobes.html?ca=dgr-lnxw42Kprobe |
592 | http://www.redhat.com/magazine/005mar05/features/kprobes/ | 613 | http://www.redhat.com/magazine/005mar05/features/kprobes/ |
614 | http://www-users.cs.umn.edu/~boutcher/kprobes/ | ||
615 | http://www.linuxsymposium.org/2006/linuxsymposium_procv2.pdf (pages 101-115) | ||
diff --git a/Documentation/lockdep-design.txt b/Documentation/lockdep-design.txt index 00d93605bfd3..55a7e4fa8cc2 100644 --- a/Documentation/lockdep-design.txt +++ b/Documentation/lockdep-design.txt | |||
@@ -36,6 +36,28 @@ The validator tracks lock-class usage history into 5 separate state bits: | |||
36 | 36 | ||
37 | - 'ever used' [ == !unused ] | 37 | - 'ever used' [ == !unused ] |
38 | 38 | ||
39 | When locking rules are violated, these 4 state bits are presented in the | ||
40 | locking error messages, inside curlies. A contrived example: | ||
41 | |||
42 | modprobe/2287 is trying to acquire lock: | ||
43 | (&sio_locks[i].lock){--..}, at: [<c02867fd>] mutex_lock+0x21/0x24 | ||
44 | |||
45 | but task is already holding lock: | ||
46 | (&sio_locks[i].lock){--..}, at: [<c02867fd>] mutex_lock+0x21/0x24 | ||
47 | |||
48 | |||
49 | The bit position indicates hardirq, softirq, hardirq-read, | ||
50 | softirq-read respectively, and the character displayed in each | ||
51 | indicates: | ||
52 | |||
53 | '.' acquired while irqs enabled | ||
54 | '+' acquired in irq context | ||
55 | '-' acquired in process context with irqs disabled | ||
56 | '?' read-acquired both with irqs enabled and in irq context | ||
57 | |||
58 | Unused mutexes cannot be part of the cause of an error. | ||
59 | |||
60 | |||
39 | Single-lock state rules: | 61 | Single-lock state rules: |
40 | ------------------------ | 62 | ------------------------ |
41 | 63 | ||
diff --git a/Documentation/md.txt b/Documentation/md.txt index 0668f9dc9d29..9ae9e4078985 100644 --- a/Documentation/md.txt +++ b/Documentation/md.txt | |||
@@ -154,11 +154,12 @@ contains further md-specific information about the device. | |||
154 | 154 | ||
155 | All md devices contain: | 155 | All md devices contain: |
156 | level | 156 | level |
157 | a text file indicating the 'raid level'. This may be a standard | 157 | a text file indicating the 'raid level'. e.g. raid0, raid1, |
158 | numerical level prefixed by "RAID-" - e.g. "RAID-5", or some | 158 | raid5, linear, multipath, faulty. |
159 | other name such as "linear" or "multipath". | ||
160 | If no raid level has been set yet (array is still being | 159 | If no raid level has been set yet (array is still being |
161 | assembled), this file will be empty. | 160 | assembled), the value will reflect whatever has been written |
161 | to it, which may be a name like the above, or may be a number | ||
162 | such as '0', '5', etc. | ||
162 | 163 | ||
163 | raid_disks | 164 | raid_disks |
164 | a text file with a simple number indicating the number of devices | 165 | a text file with a simple number indicating the number of devices |
@@ -192,14 +193,6 @@ All md devices contain: | |||
192 | 1.2 (newer format in varying locations) or "none" indicating that | 193 | 1.2 (newer format in varying locations) or "none" indicating that |
193 | the kernel isn't managing metadata at all. | 194 | the kernel isn't managing metadata at all. |
194 | 195 | ||
195 | level | ||
196 | The raid 'level' for this array. The name will often (but not | ||
197 | always) be the same as the name of the module that implements the | ||
198 | level. To be auto-loaded the module must have an alias | ||
199 | md-$LEVEL e.g. md-raid5 | ||
200 | This can be written only while the array is being assembled, not | ||
201 | after it is started. | ||
202 | |||
203 | layout | 196 | layout |
204 | The "layout" for the array for the particular level. This is | 197 | The "layout" for the array for the particular level. This is |
205 | simply a number that is interpretted differently by different | 198 | simply a number that is interpretted differently by different |
@@ -410,6 +403,15 @@ also have | |||
410 | than sectors, this my be larger than the number of actual errors | 403 | than sectors, this my be larger than the number of actual errors |
411 | by a factor of the number of sectors in a page. | 404 | by a factor of the number of sectors in a page. |
412 | 405 | ||
406 | bitmap_set_bits | ||
407 | If the array has a write-intent bitmap, then writing to this | ||
408 | attribute can set bits in the bitmap, indicating that a resync | ||
409 | would need to check the corresponding blocks. Either individual | ||
410 | numbers or start-end pairs can be written. Multiple numbers | ||
411 | can be separated by a space. | ||
412 | Note that the numbers are 'bit' numbers, not 'block' numbers. | ||
413 | They should be scaled by the bitmap_chunksize. | ||
414 | |||
413 | Each active md device may also have attributes specific to the | 415 | Each active md device may also have attributes specific to the |
414 | personality module that manages it. | 416 | personality module that manages it. |
415 | These are specific to the implementation of the module and could | 417 | These are specific to the implementation of the module and could |
diff --git a/Documentation/networking/bonding.txt b/Documentation/networking/bonding.txt index afac780445cd..dc942eaf490f 100644 --- a/Documentation/networking/bonding.txt +++ b/Documentation/networking/bonding.txt | |||
@@ -192,6 +192,17 @@ or, for backwards compatibility, the option value. E.g., | |||
192 | arp_interval | 192 | arp_interval |
193 | 193 | ||
194 | Specifies the ARP link monitoring frequency in milliseconds. | 194 | Specifies the ARP link monitoring frequency in milliseconds. |
195 | |||
196 | The ARP monitor works by periodically checking the slave | ||
197 | devices to determine whether they have sent or received | ||
198 | traffic recently (the precise criteria depends upon the | ||
199 | bonding mode, and the state of the slave). Regular traffic is | ||
200 | generated via ARP probes issued for the addresses specified by | ||
201 | the arp_ip_target option. | ||
202 | |||
203 | This behavior can be modified by the arp_validate option, | ||
204 | below. | ||
205 | |||
195 | If ARP monitoring is used in an etherchannel compatible mode | 206 | If ARP monitoring is used in an etherchannel compatible mode |
196 | (modes 0 and 2), the switch should be configured in a mode | 207 | (modes 0 and 2), the switch should be configured in a mode |
197 | that evenly distributes packets across all links. If the | 208 | that evenly distributes packets across all links. If the |
@@ -213,6 +224,54 @@ arp_ip_target | |||
213 | maximum number of targets that can be specified is 16. The | 224 | maximum number of targets that can be specified is 16. The |
214 | default value is no IP addresses. | 225 | default value is no IP addresses. |
215 | 226 | ||
227 | arp_validate | ||
228 | |||
229 | Specifies whether or not ARP probes and replies should be | ||
230 | validated in the active-backup mode. This causes the ARP | ||
231 | monitor to examine the incoming ARP requests and replies, and | ||
232 | only consider a slave to be up if it is receiving the | ||
233 | appropriate ARP traffic. | ||
234 | |||
235 | Possible values are: | ||
236 | |||
237 | none or 0 | ||
238 | |||
239 | No validation is performed. This is the default. | ||
240 | |||
241 | active or 1 | ||
242 | |||
243 | Validation is performed only for the active slave. | ||
244 | |||
245 | backup or 2 | ||
246 | |||
247 | Validation is performed only for backup slaves. | ||
248 | |||
249 | all or 3 | ||
250 | |||
251 | Validation is performed for all slaves. | ||
252 | |||
253 | For the active slave, the validation checks ARP replies to | ||
254 | confirm that they were generated by an arp_ip_target. Since | ||
255 | backup slaves do not typically receive these replies, the | ||
256 | validation performed for backup slaves is on the ARP request | ||
257 | sent out via the active slave. It is possible that some | ||
258 | switch or network configurations may result in situations | ||
259 | wherein the backup slaves do not receive the ARP requests; in | ||
260 | such a situation, validation of backup slaves must be | ||
261 | disabled. | ||
262 | |||
263 | This option is useful in network configurations in which | ||
264 | multiple bonding hosts are concurrently issuing ARPs to one or | ||
265 | more targets beyond a common switch. Should the link between | ||
266 | the switch and target fail (but not the switch itself), the | ||
267 | probe traffic generated by the multiple bonding instances will | ||
268 | fool the standard ARP monitor into considering the links as | ||
269 | still up. Use of the arp_validate option can resolve this, as | ||
270 | the ARP monitor will only consider ARP requests and replies | ||
271 | associated with its own instance of bonding. | ||
272 | |||
273 | This option was added in bonding version 3.1.0. | ||
274 | |||
216 | downdelay | 275 | downdelay |
217 | 276 | ||
218 | Specifies the time, in milliseconds, to wait before disabling | 277 | Specifies the time, in milliseconds, to wait before disabling |
diff --git a/Documentation/networking/pktgen.txt b/Documentation/networking/pktgen.txt index 44f2f769e865..18d385c068fc 100644 --- a/Documentation/networking/pktgen.txt +++ b/Documentation/networking/pktgen.txt | |||
@@ -100,6 +100,7 @@ Examples: | |||
100 | are: IPSRC_RND #IP Source is random (between min/max), | 100 | are: IPSRC_RND #IP Source is random (between min/max), |
101 | IPDST_RND, UDPSRC_RND, | 101 | IPDST_RND, UDPSRC_RND, |
102 | UDPDST_RND, MACSRC_RND, MACDST_RND | 102 | UDPDST_RND, MACSRC_RND, MACDST_RND |
103 | MPLS_RND, VID_RND, SVID_RND | ||
103 | 104 | ||
104 | pgset "udp_src_min 9" set UDP source port min, If < udp_src_max, then | 105 | pgset "udp_src_min 9" set UDP source port min, If < udp_src_max, then |
105 | cycle through the port range. | 106 | cycle through the port range. |
@@ -125,6 +126,21 @@ Examples: | |||
125 | 126 | ||
126 | pgset "mpls 0" turn off mpls (or any invalid argument works too!) | 127 | pgset "mpls 0" turn off mpls (or any invalid argument works too!) |
127 | 128 | ||
129 | pgset "vlan_id 77" set VLAN ID 0-4095 | ||
130 | pgset "vlan_p 3" set priority bit 0-7 (default 0) | ||
131 | pgset "vlan_cfi 0" set canonical format identifier 0-1 (default 0) | ||
132 | |||
133 | pgset "svlan_id 22" set SVLAN ID 0-4095 | ||
134 | pgset "svlan_p 3" set priority bit 0-7 (default 0) | ||
135 | pgset "svlan_cfi 0" set canonical format identifier 0-1 (default 0) | ||
136 | |||
137 | pgset "vlan_id 9999" > 4095 remove vlan and svlan tags | ||
138 | pgset "svlan 9999" > 4095 remove svlan tag | ||
139 | |||
140 | |||
141 | pgset "tos XX" set former IPv4 TOS field (e.g. "tos 28" for AF11 no ECN, default 00) | ||
142 | pgset "traffic_class XX" set former IPv6 TRAFFIC CLASS (e.g. "traffic_class B8" for EF no ECN, default 00) | ||
143 | |||
128 | pgset stop aborts injection. Also, ^C aborts generator. | 144 | pgset stop aborts injection. Also, ^C aborts generator. |
129 | 145 | ||
130 | 146 | ||
diff --git a/Documentation/nommu-mmap.txt b/Documentation/nommu-mmap.txt index b88ebe4d808c..7714f57caad5 100644 --- a/Documentation/nommu-mmap.txt +++ b/Documentation/nommu-mmap.txt | |||
@@ -116,6 +116,9 @@ FURTHER NOTES ON NO-MMU MMAP | |||
116 | (*) A list of all the mappings on the system is visible through /proc/maps in | 116 | (*) A list of all the mappings on the system is visible through /proc/maps in |
117 | no-MMU mode. | 117 | no-MMU mode. |
118 | 118 | ||
119 | (*) A list of all the mappings in use by a process is visible through | ||
120 | /proc/<pid>/maps in no-MMU mode. | ||
121 | |||
119 | (*) Supplying MAP_FIXED or a requesting a particular mapping address will | 122 | (*) Supplying MAP_FIXED or a requesting a particular mapping address will |
120 | result in an error. | 123 | result in an error. |
121 | 124 | ||
@@ -125,6 +128,49 @@ FURTHER NOTES ON NO-MMU MMAP | |||
125 | error will result if they don't. This is most likely to be encountered | 128 | error will result if they don't. This is most likely to be encountered |
126 | with character device files, pipes, fifos and sockets. | 129 | with character device files, pipes, fifos and sockets. |
127 | 130 | ||
131 | |||
132 | ========================== | ||
133 | INTERPROCESS SHARED MEMORY | ||
134 | ========================== | ||
135 | |||
136 | Both SYSV IPC SHM shared memory and POSIX shared memory is supported in NOMMU | ||
137 | mode. The former through the usual mechanism, the latter through files created | ||
138 | on ramfs or tmpfs mounts. | ||
139 | |||
140 | |||
141 | ======= | ||
142 | FUTEXES | ||
143 | ======= | ||
144 | |||
145 | Futexes are supported in NOMMU mode if the arch supports them. An error will | ||
146 | be given if an address passed to the futex system call lies outside the | ||
147 | mappings made by a process or if the mapping in which the address lies does not | ||
148 | support futexes (such as an I/O chardev mapping). | ||
149 | |||
150 | |||
151 | ============= | ||
152 | NO-MMU MREMAP | ||
153 | ============= | ||
154 | |||
155 | The mremap() function is partially supported. It may change the size of a | ||
156 | mapping, and may move it[*] if MREMAP_MAYMOVE is specified and if the new size | ||
157 | of the mapping exceeds the size of the slab object currently occupied by the | ||
158 | memory to which the mapping refers, or if a smaller slab object could be used. | ||
159 | |||
160 | MREMAP_FIXED is not supported, though it is ignored if there's no change of | ||
161 | address and the object does not need to be moved. | ||
162 | |||
163 | Shared mappings may not be moved. Shareable mappings may not be moved either, | ||
164 | even if they are not currently shared. | ||
165 | |||
166 | The mremap() function must be given an exact match for base address and size of | ||
167 | a previously mapped object. It may not be used to create holes in existing | ||
168 | mappings, move parts of existing mappings or resize parts of mappings. It must | ||
169 | act on a complete mapping. | ||
170 | |||
171 | [*] Not currently supported. | ||
172 | |||
173 | |||
128 | ============================================ | 174 | ============================================ |
129 | PROVIDING SHAREABLE CHARACTER DEVICE SUPPORT | 175 | PROVIDING SHAREABLE CHARACTER DEVICE SUPPORT |
130 | ============================================ | 176 | ============================================ |
diff --git a/Documentation/pcieaer-howto.txt b/Documentation/pcieaer-howto.txt new file mode 100644 index 000000000000..16c251230c82 --- /dev/null +++ b/Documentation/pcieaer-howto.txt | |||
@@ -0,0 +1,253 @@ | |||
1 | The PCI Express Advanced Error Reporting Driver Guide HOWTO | ||
2 | T. Long Nguyen <tom.l.nguyen@intel.com> | ||
3 | Yanmin Zhang <yanmin.zhang@intel.com> | ||
4 | 07/29/2006 | ||
5 | |||
6 | |||
7 | 1. Overview | ||
8 | |||
9 | 1.1 About this guide | ||
10 | |||
11 | This guide describes the basics of the PCI Express Advanced Error | ||
12 | Reporting (AER) driver and provides information on how to use it, as | ||
13 | well as how to enable the drivers of endpoint devices to conform with | ||
14 | PCI Express AER driver. | ||
15 | |||
16 | 1.2 Copyright © Intel Corporation 2006. | ||
17 | |||
18 | 1.3 What is the PCI Express AER Driver? | ||
19 | |||
20 | PCI Express error signaling can occur on the PCI Express link itself | ||
21 | or on behalf of transactions initiated on the link. PCI Express | ||
22 | defines two error reporting paradigms: the baseline capability and | ||
23 | the Advanced Error Reporting capability. The baseline capability is | ||
24 | required of all PCI Express components providing a minimum defined | ||
25 | set of error reporting requirements. Advanced Error Reporting | ||
26 | capability is implemented with a PCI Express advanced error reporting | ||
27 | extended capability structure providing more robust error reporting. | ||
28 | |||
29 | The PCI Express AER driver provides the infrastructure to support PCI | ||
30 | Express Advanced Error Reporting capability. The PCI Express AER | ||
31 | driver provides three basic functions: | ||
32 | |||
33 | - Gathers the comprehensive error information if errors occurred. | ||
34 | - Reports error to the users. | ||
35 | - Performs error recovery actions. | ||
36 | |||
37 | AER driver only attaches root ports which support PCI-Express AER | ||
38 | capability. | ||
39 | |||
40 | |||
41 | 2. User Guide | ||
42 | |||
43 | 2.1 Include the PCI Express AER Root Driver into the Linux Kernel | ||
44 | |||
45 | The PCI Express AER Root driver is a Root Port service driver attached | ||
46 | to the PCI Express Port Bus driver. If a user wants to use it, the driver | ||
47 | has to be compiled. Option CONFIG_PCIEAER supports this capability. It | ||
48 | depends on CONFIG_PCIEPORTBUS, so pls. set CONFIG_PCIEPORTBUS=y and | ||
49 | CONFIG_PCIEAER = y. | ||
50 | |||
51 | 2.2 Load PCI Express AER Root Driver | ||
52 | There is a case where a system has AER support in BIOS. Enabling the AER | ||
53 | Root driver and having AER support in BIOS may result unpredictable | ||
54 | behavior. To avoid this conflict, a successful load of the AER Root driver | ||
55 | requires ACPI _OSC support in the BIOS to allow the AER Root driver to | ||
56 | request for native control of AER. See the PCI FW 3.0 Specification for | ||
57 | details regarding OSC usage. Currently, lots of firmwares don't provide | ||
58 | _OSC support while they use PCI Express. To support such firmwares, | ||
59 | forceload, a parameter of type bool, could enable AER to continue to | ||
60 | be initiated although firmwares have no _OSC support. To enable the | ||
61 | walkaround, pls. add aerdriver.forceload=y to kernel boot parameter line | ||
62 | when booting kernel. Note that forceload=n by default. | ||
63 | |||
64 | 2.3 AER error output | ||
65 | When a PCI-E AER error is captured, an error message will be outputed to | ||
66 | console. If it's a correctable error, it is outputed as a warning. | ||
67 | Otherwise, it is printed as an error. So users could choose different | ||
68 | log level to filter out correctable error messages. | ||
69 | |||
70 | Below shows an example. | ||
71 | +------ PCI-Express Device Error -----+ | ||
72 | Error Severity : Uncorrected (Fatal) | ||
73 | PCIE Bus Error type : Transaction Layer | ||
74 | Unsupported Request : First | ||
75 | Requester ID : 0500 | ||
76 | VendorID=8086h, DeviceID=0329h, Bus=05h, Device=00h, Function=00h | ||
77 | TLB Header: | ||
78 | 04000001 00200a03 05010000 00050100 | ||
79 | |||
80 | In the example, 'Requester ID' means the ID of the device who sends | ||
81 | the error message to root port. Pls. refer to pci express specs for | ||
82 | other fields. | ||
83 | |||
84 | |||
85 | 3. Developer Guide | ||
86 | |||
87 | To enable AER aware support requires a software driver to configure | ||
88 | the AER capability structure within its device and to provide callbacks. | ||
89 | |||
90 | To support AER better, developers need understand how AER does work | ||
91 | firstly. | ||
92 | |||
93 | PCI Express errors are classified into two types: correctable errors | ||
94 | and uncorrectable errors. This classification is based on the impacts | ||
95 | of those errors, which may result in degraded performance or function | ||
96 | failure. | ||
97 | |||
98 | Correctable errors pose no impacts on the functionality of the | ||
99 | interface. The PCI Express protocol can recover without any software | ||
100 | intervention or any loss of data. These errors are detected and | ||
101 | corrected by hardware. Unlike correctable errors, uncorrectable | ||
102 | errors impact functionality of the interface. Uncorrectable errors | ||
103 | can cause a particular transaction or a particular PCI Express link | ||
104 | to be unreliable. Depending on those error conditions, uncorrectable | ||
105 | errors are further classified into non-fatal errors and fatal errors. | ||
106 | Non-fatal errors cause the particular transaction to be unreliable, | ||
107 | but the PCI Express link itself is fully functional. Fatal errors, on | ||
108 | the other hand, cause the link to be unreliable. | ||
109 | |||
110 | When AER is enabled, a PCI Express device will automatically send an | ||
111 | error message to the PCIE root port above it when the device captures | ||
112 | an error. The Root Port, upon receiving an error reporting message, | ||
113 | internally processes and logs the error message in its PCI Express | ||
114 | capability structure. Error information being logged includes storing | ||
115 | the error reporting agent's requestor ID into the Error Source | ||
116 | Identification Registers and setting the error bits of the Root Error | ||
117 | Status Register accordingly. If AER error reporting is enabled in Root | ||
118 | Error Command Register, the Root Port generates an interrupt if an | ||
119 | error is detected. | ||
120 | |||
121 | Note that the errors as described above are related to the PCI Express | ||
122 | hierarchy and links. These errors do not include any device specific | ||
123 | errors because device specific errors will still get sent directly to | ||
124 | the device driver. | ||
125 | |||
126 | 3.1 Configure the AER capability structure | ||
127 | |||
128 | AER aware drivers of PCI Express component need change the device | ||
129 | control registers to enable AER. They also could change AER registers, | ||
130 | including mask and severity registers. Helper function | ||
131 | pci_enable_pcie_error_reporting could be used to enable AER. See | ||
132 | section 3.3. | ||
133 | |||
134 | 3.2. Provide callbacks | ||
135 | |||
136 | 3.2.1 callback reset_link to reset pci express link | ||
137 | |||
138 | This callback is used to reset the pci express physical link when a | ||
139 | fatal error happens. The root port aer service driver provides a | ||
140 | default reset_link function, but different upstream ports might | ||
141 | have different specifications to reset pci express link, so all | ||
142 | upstream ports should provide their own reset_link functions. | ||
143 | |||
144 | In struct pcie_port_service_driver, a new pointer, reset_link, is | ||
145 | added. | ||
146 | |||
147 | pci_ers_result_t (*reset_link) (struct pci_dev *dev); | ||
148 | |||
149 | Section 3.2.2.2 provides more detailed info on when to call | ||
150 | reset_link. | ||
151 | |||
152 | 3.2.2 PCI error-recovery callbacks | ||
153 | |||
154 | The PCI Express AER Root driver uses error callbacks to coordinate | ||
155 | with downstream device drivers associated with a hierarchy in question | ||
156 | when performing error recovery actions. | ||
157 | |||
158 | Data struct pci_driver has a pointer, err_handler, to point to | ||
159 | pci_error_handlers who consists of a couple of callback function | ||
160 | pointers. AER driver follows the rules defined in | ||
161 | pci-error-recovery.txt except pci express specific parts (e.g. | ||
162 | reset_link). Pls. refer to pci-error-recovery.txt for detailed | ||
163 | definitions of the callbacks. | ||
164 | |||
165 | Below sections specify when to call the error callback functions. | ||
166 | |||
167 | 3.2.2.1 Correctable errors | ||
168 | |||
169 | Correctable errors pose no impacts on the functionality of | ||
170 | the interface. The PCI Express protocol can recover without any | ||
171 | software intervention or any loss of data. These errors do not | ||
172 | require any recovery actions. The AER driver clears the device's | ||
173 | correctable error status register accordingly and logs these errors. | ||
174 | |||
175 | 3.2.2.2 Non-correctable (non-fatal and fatal) errors | ||
176 | |||
177 | If an error message indicates a non-fatal error, performing link reset | ||
178 | at upstream is not required. The AER driver calls error_detected(dev, | ||
179 | pci_channel_io_normal) to all drivers associated within a hierarchy in | ||
180 | question. for example, | ||
181 | EndPoint<==>DownstreamPort B<==>UpstreamPort A<==>RootPort. | ||
182 | If Upstream port A captures an AER error, the hierarchy consists of | ||
183 | Downstream port B and EndPoint. | ||
184 | |||
185 | A driver may return PCI_ERS_RESULT_CAN_RECOVER, | ||
186 | PCI_ERS_RESULT_DISCONNECT, or PCI_ERS_RESULT_NEED_RESET, depending on | ||
187 | whether it can recover or the AER driver calls mmio_enabled as next. | ||
188 | |||
189 | If an error message indicates a fatal error, kernel will broadcast | ||
190 | error_detected(dev, pci_channel_io_frozen) to all drivers within | ||
191 | a hierarchy in question. Then, performing link reset at upstream is | ||
192 | necessary. As different kinds of devices might use different approaches | ||
193 | to reset link, AER port service driver is required to provide the | ||
194 | function to reset link. Firstly, kernel looks for if the upstream | ||
195 | component has an aer driver. If it has, kernel uses the reset_link | ||
196 | callback of the aer driver. If the upstream component has no aer driver | ||
197 | and the port is downstream port, we will use the aer driver of the | ||
198 | root port who reports the AER error. As for upstream ports, | ||
199 | they should provide their own aer service drivers with reset_link | ||
200 | function. If error_detected returns PCI_ERS_RESULT_CAN_RECOVER and | ||
201 | reset_link returns PCI_ERS_RESULT_RECOVERED, the error handling goes | ||
202 | to mmio_enabled. | ||
203 | |||
204 | 3.3 helper functions | ||
205 | |||
206 | 3.3.1 int pci_find_aer_capability(struct pci_dev *dev); | ||
207 | pci_find_aer_capability locates the PCI Express AER capability | ||
208 | in the device configuration space. If the device doesn't support | ||
209 | PCI-Express AER, the function returns 0. | ||
210 | |||
211 | 3.3.2 int pci_enable_pcie_error_reporting(struct pci_dev *dev); | ||
212 | pci_enable_pcie_error_reporting enables the device to send error | ||
213 | messages to root port when an error is detected. Note that devices | ||
214 | don't enable the error reporting by default, so device drivers need | ||
215 | call this function to enable it. | ||
216 | |||
217 | 3.3.3 int pci_disable_pcie_error_reporting(struct pci_dev *dev); | ||
218 | pci_disable_pcie_error_reporting disables the device to send error | ||
219 | messages to root port when an error is detected. | ||
220 | |||
221 | 3.3.4 int pci_cleanup_aer_uncorrect_error_status(struct pci_dev *dev); | ||
222 | pci_cleanup_aer_uncorrect_error_status cleanups the uncorrectable | ||
223 | error status register. | ||
224 | |||
225 | 3.4 Frequent Asked Questions | ||
226 | |||
227 | Q: What happens if a PCI Express device driver does not provide an | ||
228 | error recovery handler (pci_driver->err_handler is equal to NULL)? | ||
229 | |||
230 | A: The devices attached with the driver won't be recovered. If the | ||
231 | error is fatal, kernel will print out warning messages. Please refer | ||
232 | to section 3 for more information. | ||
233 | |||
234 | Q: What happens if an upstream port service driver does not provide | ||
235 | callback reset_link? | ||
236 | |||
237 | A: Fatal error recovery will fail if the errors are reported by the | ||
238 | upstream ports who are attached by the service driver. | ||
239 | |||
240 | Q: How does this infrastructure deal with driver that is not PCI | ||
241 | Express aware? | ||
242 | |||
243 | A: This infrastructure calls the error callback functions of the | ||
244 | driver when an error happens. But if the driver is not aware of | ||
245 | PCI Express, the device might not report its own errors to root | ||
246 | port. | ||
247 | |||
248 | Q: What modifications will that driver need to make it compatible | ||
249 | with the PCI Express AER Root driver? | ||
250 | |||
251 | A: It could call the helper functions to enable AER in devices and | ||
252 | cleanup uncorrectable status register. Pls. refer to section 3.3. | ||
253 | |||
diff --git a/Documentation/power/devices.txt b/Documentation/power/devices.txt index fba1e05c47c7..d0e79d5820a5 100644 --- a/Documentation/power/devices.txt +++ b/Documentation/power/devices.txt | |||
@@ -1,208 +1,553 @@ | |||
1 | Most of the code in Linux is device drivers, so most of the Linux power | ||
2 | management code is also driver-specific. Most drivers will do very little; | ||
3 | others, especially for platforms with small batteries (like cell phones), | ||
4 | will do a lot. | ||
5 | |||
6 | This writeup gives an overview of how drivers interact with system-wide | ||
7 | power management goals, emphasizing the models and interfaces that are | ||
8 | shared by everything that hooks up to the driver model core. Read it as | ||
9 | background for the domain-specific work you'd do with any specific driver. | ||
10 | |||
11 | |||
12 | Two Models for Device Power Management | ||
13 | ====================================== | ||
14 | Drivers will use one or both of these models to put devices into low-power | ||
15 | states: | ||
16 | |||
17 | System Sleep model: | ||
18 | Drivers can enter low power states as part of entering system-wide | ||
19 | low-power states like "suspend-to-ram", or (mostly for systems with | ||
20 | disks) "hibernate" (suspend-to-disk). | ||
21 | |||
22 | This is something that device, bus, and class drivers collaborate on | ||
23 | by implementing various role-specific suspend and resume methods to | ||
24 | cleanly power down hardware and software subsystems, then reactivate | ||
25 | them without loss of data. | ||
26 | |||
27 | Some drivers can manage hardware wakeup events, which make the system | ||
28 | leave that low-power state. This feature may be disabled using the | ||
29 | relevant /sys/devices/.../power/wakeup file; enabling it may cost some | ||
30 | power usage, but let the whole system enter low power states more often. | ||
31 | |||
32 | Runtime Power Management model: | ||
33 | Drivers may also enter low power states while the system is running, | ||
34 | independently of other power management activity. Upstream drivers | ||
35 | will normally not know (or care) if the device is in some low power | ||
36 | state when issuing requests; the driver will auto-resume anything | ||
37 | that's needed when it gets a request. | ||
38 | |||
39 | This doesn't have, or need much infrastructure; it's just something you | ||
40 | should do when writing your drivers. For example, clk_disable() unused | ||
41 | clocks as part of minimizing power drain for currently-unused hardware. | ||
42 | Of course, sometimes clusters of drivers will collaborate with each | ||
43 | other, which could involve task-specific power management. | ||
44 | |||
45 | There's not a lot to be said about those low power states except that they | ||
46 | are very system-specific, and often device-specific. Also, that if enough | ||
47 | drivers put themselves into low power states (at "runtime"), the effect may be | ||
48 | the same as entering some system-wide low-power state (system sleep) ... and | ||
49 | that synergies exist, so that several drivers using runtime pm might put the | ||
50 | system into a state where even deeper power saving options are available. | ||
51 | |||
52 | Most suspended devices will have quiesced all I/O: no more DMA or irqs, no | ||
53 | more data read or written, and requests from upstream drivers are no longer | ||
54 | accepted. A given bus or platform may have different requirements though. | ||
55 | |||
56 | Examples of hardware wakeup events include an alarm from a real time clock, | ||
57 | network wake-on-LAN packets, keyboard or mouse activity, and media insertion | ||
58 | or removal (for PCMCIA, MMC/SD, USB, and so on). | ||
59 | |||
60 | |||
61 | Interfaces for Entering System Sleep States | ||
62 | =========================================== | ||
63 | Most of the programming interfaces a device driver needs to know about | ||
64 | relate to that first model: entering a system-wide low power state, | ||
65 | rather than just minimizing power consumption by one device. | ||
66 | |||
67 | |||
68 | Bus Driver Methods | ||
69 | ------------------ | ||
70 | The core methods to suspend and resume devices reside in struct bus_type. | ||
71 | These are mostly of interest to people writing infrastructure for busses | ||
72 | like PCI or USB, or because they define the primitives that device drivers | ||
73 | may need to apply in domain-specific ways to their devices: | ||
1 | 74 | ||
2 | Device Power Management | 75 | struct bus_type { |
76 | ... | ||
77 | int (*suspend)(struct device *dev, pm_message_t state); | ||
78 | int (*suspend_late)(struct device *dev, pm_message_t state); | ||
3 | 79 | ||
80 | int (*resume_early)(struct device *dev); | ||
81 | int (*resume)(struct device *dev); | ||
82 | }; | ||
4 | 83 | ||
5 | Device power management encompasses two areas - the ability to save | 84 | Bus drivers implement those methods as appropriate for the hardware and |
6 | state and transition a device to a low-power state when the system is | 85 | the drivers using it; PCI works differently from USB, and so on. Not many |
7 | entering a low-power state; and the ability to transition a device to | 86 | people write bus drivers; most driver code is a "device driver" that |
8 | a low-power state while the system is running (and independently of | 87 | builds on top of bus-specific framework code. |
9 | any other power management activity). | 88 | |
89 | For more information on these driver calls, see the description later; | ||
90 | they are called in phases for every device, respecting the parent-child | ||
91 | sequencing in the driver model tree. Note that as this is being written, | ||
92 | only the suspend() and resume() are widely available; not many bus drivers | ||
93 | leverage all of those phases, or pass them down to lower driver levels. | ||
94 | |||
95 | |||
96 | /sys/devices/.../power/wakeup files | ||
97 | ----------------------------------- | ||
98 | All devices in the driver model have two flags to control handling of | ||
99 | wakeup events, which are hardware signals that can force the device and/or | ||
100 | system out of a low power state. These are initialized by bus or device | ||
101 | driver code using device_init_wakeup(dev,can_wakeup). | ||
102 | |||
103 | The "can_wakeup" flag just records whether the device (and its driver) can | ||
104 | physically support wakeup events. When that flag is clear, the sysfs | ||
105 | "wakeup" file is empty, and device_may_wakeup() returns false. | ||
106 | |||
107 | For devices that can issue wakeup events, a separate flag controls whether | ||
108 | that device should try to use its wakeup mechanism. The initial value of | ||
109 | device_may_wakeup() will be true, so that the device's "wakeup" file holds | ||
110 | the value "enabled". Userspace can change that to "disabled" so that | ||
111 | device_may_wakeup() returns false; or change it back to "enabled" (so that | ||
112 | it returns true again). | ||
113 | |||
114 | |||
115 | EXAMPLE: PCI Device Driver Methods | ||
116 | ----------------------------------- | ||
117 | PCI framework software calls these methods when the PCI device driver bound | ||
118 | to a device device has provided them: | ||
119 | |||
120 | struct pci_driver { | ||
121 | ... | ||
122 | int (*suspend)(struct pci_device *pdev, pm_message_t state); | ||
123 | int (*suspend_late)(struct pci_device *pdev, pm_message_t state); | ||
124 | |||
125 | int (*resume_early)(struct pci_device *pdev); | ||
126 | int (*resume)(struct pci_device *pdev); | ||
127 | }; | ||
10 | 128 | ||
129 | Drivers will implement those methods, and call PCI-specific procedures | ||
130 | like pci_set_power_state(), pci_enable_wake(), pci_save_state(), and | ||
131 | pci_restore_state() to manage PCI-specific mechanisms. (PCI config space | ||
132 | could be saved during driver probe, if it weren't for the fact that some | ||
133 | systems rely on userspace tweaking using setpci.) Devices are suspended | ||
134 | before their bridges enter low power states, and likewise bridges resume | ||
135 | before their devices. | ||
136 | |||
137 | |||
138 | Upper Layers of Driver Stacks | ||
139 | ----------------------------- | ||
140 | Device drivers generally have at least two interfaces, and the methods | ||
141 | sketched above are the ones which apply to the lower level (nearer PCI, USB, | ||
142 | or other bus hardware). The network and block layers are examples of upper | ||
143 | level interfaces, as is a character device talking to userspace. | ||
144 | |||
145 | Power management requests normally need to flow through those upper levels, | ||
146 | which often use domain-oriented requests like "blank that screen". In | ||
147 | some cases those upper levels will have power management intelligence that | ||
148 | relates to end-user activity, or other devices that work in cooperation. | ||
149 | |||
150 | When those interfaces are structured using class interfaces, there is a | ||
151 | standard way to have the upper layer stop issuing requests to a given | ||
152 | class device (and restart later): | ||
153 | |||
154 | struct class { | ||
155 | ... | ||
156 | int (*suspend)(struct device *dev, pm_message_t state); | ||
157 | int (*resume)(struct device *dev); | ||
158 | }; | ||
11 | 159 | ||
12 | Methods | 160 | Those calls are issued in specific phases of the process by which the |
161 | system enters a low power "suspend" state, or resumes from it. | ||
162 | |||
163 | |||
164 | Calling Drivers to Enter System Sleep States | ||
165 | ============================================ | ||
166 | When the system enters a low power state, each device's driver is asked | ||
167 | to suspend the device by putting it into state compatible with the target | ||
168 | system state. That's usually some version of "off", but the details are | ||
169 | system-specific. Also, wakeup-enabled devices will usually stay partly | ||
170 | functional in order to wake the system. | ||
171 | |||
172 | When the system leaves that low power state, the device's driver is asked | ||
173 | to resume it. The suspend and resume operations always go together, and | ||
174 | both are multi-phase operations. | ||
175 | |||
176 | For simple drivers, suspend might quiesce the device using the class code | ||
177 | and then turn its hardware as "off" as possible with late_suspend. The | ||
178 | matching resume calls would then completely reinitialize the hardware | ||
179 | before reactivating its class I/O queues. | ||
180 | |||
181 | More power-aware drivers drivers will use more than one device low power | ||
182 | state, either at runtime or during system sleep states, and might trigger | ||
183 | system wakeup events. | ||
184 | |||
185 | |||
186 | Call Sequence Guarantees | ||
187 | ------------------------ | ||
188 | To ensure that bridges and similar links needed to talk to a device are | ||
189 | available when the device is suspended or resumed, the device tree is | ||
190 | walked in a bottom-up order to suspend devices. A top-down order is | ||
191 | used to resume those devices. | ||
192 | |||
193 | The ordering of the device tree is defined by the order in which devices | ||
194 | get registered: a child can never be registered, probed or resumed before | ||
195 | its parent; and can't be removed or suspended after that parent. | ||
196 | |||
197 | The policy is that the device tree should match hardware bus topology. | ||
198 | (Or at least the control bus, for devices which use multiple busses.) | ||
199 | |||
200 | |||
201 | Suspending Devices | ||
202 | ------------------ | ||
203 | Suspending a given device is done in several phases. Suspending the | ||
204 | system always includes every phase, executing calls for every device | ||
205 | before the next phase begins. Not all busses or classes support all | ||
206 | these callbacks; and not all drivers use all the callbacks. | ||
207 | |||
208 | The phases are seen by driver notifications issued in this order: | ||
209 | |||
210 | 1 class.suspend(dev, message) is called after tasks are frozen, for | ||
211 | devices associated with a class that has such a method. This | ||
212 | method may sleep. | ||
213 | |||
214 | Since I/O activity usually comes from such higher layers, this is | ||
215 | a good place to quiesce all drivers of a given type (and keep such | ||
216 | code out of those drivers). | ||
217 | |||
218 | 2 bus.suspend(dev, message) is called next. This method may sleep, | ||
219 | and is often morphed into a device driver call with bus-specific | ||
220 | parameters and/or rules. | ||
221 | |||
222 | This call should handle parts of device suspend logic that require | ||
223 | sleeping. It probably does work to quiesce the device which hasn't | ||
224 | been abstracted into class.suspend() or bus.suspend_late(). | ||
225 | |||
226 | 3 bus.suspend_late(dev, message) is called with IRQs disabled, and | ||
227 | with only one CPU active. Until the bus.resume_early() phase | ||
228 | completes (see later), IRQs are not enabled again. This method | ||
229 | won't be exposed by all busses; for message based busses like USB, | ||
230 | I2C, or SPI, device interactions normally require IRQs. This bus | ||
231 | call may be morphed into a driver call with bus-specific parameters. | ||
232 | |||
233 | This call might save low level hardware state that might otherwise | ||
234 | be lost in the upcoming low power state, and actually put the | ||
235 | device into a low power state ... so that in some cases the device | ||
236 | may stay partly usable until this late. This "late" call may also | ||
237 | help when coping with hardware that behaves badly. | ||
238 | |||
239 | The pm_message_t parameter is currently used to refine those semantics | ||
240 | (described later). | ||
241 | |||
242 | At the end of those phases, drivers should normally have stopped all I/O | ||
243 | transactions (DMA, IRQs), saved enough state that they can re-initialize | ||
244 | or restore previous state (as needed by the hardware), and placed the | ||
245 | device into a low-power state. On many platforms they will also use | ||
246 | clk_disable() to gate off one or more clock sources; sometimes they will | ||
247 | also switch off power supplies, or reduce voltages. Drivers which have | ||
248 | runtime PM support may already have performed some or all of the steps | ||
249 | needed to prepare for the upcoming system sleep state. | ||
250 | |||
251 | When any driver sees that its device_can_wakeup(dev), it should make sure | ||
252 | to use the relevant hardware signals to trigger a system wakeup event. | ||
253 | For example, enable_irq_wake() might identify GPIO signals hooked up to | ||
254 | a switch or other external hardware, and pci_enable_wake() does something | ||
255 | similar for PCI's PME# signal. | ||
256 | |||
257 | If a driver (or bus, or class) fails it suspend method, the system won't | ||
258 | enter the desired low power state; it will resume all the devices it's | ||
259 | suspended so far. | ||
260 | |||
261 | Note that drivers may need to perform different actions based on the target | ||
262 | system lowpower/sleep state. At this writing, there are only platform | ||
263 | specific APIs through which drivers could determine those target states. | ||
264 | |||
265 | |||
266 | Device Low Power (suspend) States | ||
267 | --------------------------------- | ||
268 | Device low-power states aren't very standard. One device might only handle | ||
269 | "on" and "off, while another might support a dozen different versions of | ||
270 | "on" (how many engines are active?), plus a state that gets back to "on" | ||
271 | faster than from a full "off". | ||
272 | |||
273 | Some busses define rules about what different suspend states mean. PCI | ||
274 | gives one example: after the suspend sequence completes, a non-legacy | ||
275 | PCI device may not perform DMA or issue IRQs, and any wakeup events it | ||
276 | issues would be issued through the PME# bus signal. Plus, there are | ||
277 | several PCI-standard device states, some of which are optional. | ||
278 | |||
279 | In contrast, integrated system-on-chip processors often use irqs as the | ||
280 | wakeup event sources (so drivers would call enable_irq_wake) and might | ||
281 | be able to treat DMA completion as a wakeup event (sometimes DMA can stay | ||
282 | active too, it'd only be the CPU and some peripherals that sleep). | ||
283 | |||
284 | Some details here may be platform-specific. Systems may have devices that | ||
285 | can be fully active in certain sleep states, such as an LCD display that's | ||
286 | refreshed using DMA while most of the system is sleeping lightly ... and | ||
287 | its frame buffer might even be updated by a DSP or other non-Linux CPU while | ||
288 | the Linux control processor stays idle. | ||
289 | |||
290 | Moreover, the specific actions taken may depend on the target system state. | ||
291 | One target system state might allow a given device to be very operational; | ||
292 | another might require a hard shut down with re-initialization on resume. | ||
293 | And two different target systems might use the same device in different | ||
294 | ways; the aforementioned LCD might be active in one product's "standby", | ||
295 | but a different product using the same SOC might work differently. | ||
296 | |||
297 | |||
298 | Meaning of pm_message_t.event | ||
299 | ----------------------------- | ||
300 | Parameters to suspend calls include the device affected and a message of | ||
301 | type pm_message_t, which has one field: the event. If driver does not | ||
302 | recognize the event code, suspend calls may abort the request and return | ||
303 | a negative errno. However, most drivers will be fine if they implement | ||
304 | PM_EVENT_SUSPEND semantics for all messages. | ||
305 | |||
306 | The event codes are used to refine the goal of suspending the device, and | ||
307 | mostly matter when creating or resuming system memory image snapshots, as | ||
308 | used with suspend-to-disk: | ||
309 | |||
310 | PM_EVENT_SUSPEND -- quiesce the driver and put hardware into a low-power | ||
311 | state. When used with system sleep states like "suspend-to-RAM" or | ||
312 | "standby", the upcoming resume() call will often be able to rely on | ||
313 | state kept in hardware, or issue system wakeup events. When used | ||
314 | instead with suspend-to-disk, few devices support this capability; | ||
315 | most are completely powered off. | ||
316 | |||
317 | PM_EVENT_FREEZE -- quiesce the driver, but don't necessarily change into | ||
318 | any low power mode. A system snapshot is about to be taken, often | ||
319 | followed by a call to the driver's resume() method. Neither wakeup | ||
320 | events nor DMA are allowed. | ||
321 | |||
322 | PM_EVENT_PRETHAW -- quiesce the driver, knowing that the upcoming resume() | ||
323 | will restore a suspend-to-disk snapshot from a different kernel image. | ||
324 | Drivers that are smart enough to look at their hardware state during | ||
325 | resume() processing need that state to be correct ... a PRETHAW could | ||
326 | be used to invalidate that state (by resetting the device), like a | ||
327 | shutdown() invocation would before a kexec() or system halt. Other | ||
328 | drivers might handle this the same way as PM_EVENT_FREEZE. Neither | ||
329 | wakeup events nor DMA are allowed. | ||
330 | |||
331 | To enter "standby" (ACPI S1) or "Suspend to RAM" (STR, ACPI S3) states, or | ||
332 | the similarly named APM states, only PM_EVENT_SUSPEND is used; for "Suspend | ||
333 | to Disk" (STD, hibernate, ACPI S4), all of those event codes are used. | ||
334 | |||
335 | There's also PM_EVENT_ON, a value which never appears as a suspend event | ||
336 | but is sometimes used to record the "not suspended" device state. | ||
337 | |||
338 | |||
339 | Resuming Devices | ||
340 | ---------------- | ||
341 | Resuming is done in multiple phases, much like suspending, with all | ||
342 | devices processing each phase's calls before the next phase begins. | ||
343 | |||
344 | The phases are seen by driver notifications issued in this order: | ||
345 | |||
346 | 1 bus.resume_early(dev) is called with IRQs disabled, and with | ||
347 | only one CPU active. As with bus.suspend_late(), this method | ||
348 | won't be supported on busses that require IRQs in order to | ||
349 | interact with devices. | ||
350 | |||
351 | This reverses the effects of bus.suspend_late(). | ||
352 | |||
353 | 2 bus.resume(dev) is called next. This may be morphed into a device | ||
354 | driver call with bus-specific parameters; implementations may sleep. | ||
355 | |||
356 | This reverses the effects of bus.suspend(). | ||
357 | |||
358 | 3 class.resume(dev) is called for devices associated with a class | ||
359 | that has such a method. Implementations may sleep. | ||
360 | |||
361 | This reverses the effects of class.suspend(), and would usually | ||
362 | reactivate the device's I/O queue. | ||
363 | |||
364 | At the end of those phases, drivers should normally be as functional as | ||
365 | they were before suspending: I/O can be performed using DMA and IRQs, and | ||
366 | the relevant clocks are gated on. The device need not be "fully on"; it | ||
367 | might be in a runtime lowpower/suspend state that acts as if it were. | ||
368 | |||
369 | However, the details here may again be platform-specific. For example, | ||
370 | some systems support multiple "run" states, and the mode in effect at | ||
371 | the end of resume() might not be the one which preceded suspension. | ||
372 | That means availability of certain clocks or power supplies changed, | ||
373 | which could easily affect how a driver works. | ||
374 | |||
375 | |||
376 | Drivers need to be able to handle hardware which has been reset since the | ||
377 | suspend methods were called, for example by complete reinitialization. | ||
378 | This may be the hardest part, and the one most protected by NDA'd documents | ||
379 | and chip errata. It's simplest if the hardware state hasn't changed since | ||
380 | the suspend() was called, but that can't always be guaranteed. | ||
381 | |||
382 | Drivers must also be prepared to notice that the device has been removed | ||
383 | while the system was powered off, whenever that's physically possible. | ||
384 | PCMCIA, MMC, USB, Firewire, SCSI, and even IDE are common examples of busses | ||
385 | where common Linux platforms will see such removal. Details of how drivers | ||
386 | will notice and handle such removals are currently bus-specific, and often | ||
387 | involve a separate thread. | ||
13 | 388 | ||
14 | The methods to suspend and resume devices reside in struct bus_type: | ||
15 | 389 | ||
16 | struct bus_type { | 390 | Note that the bus-specific runtime PM wakeup mechanism can exist, and might |
17 | ... | 391 | be defined to share some of the same driver code as for system wakeup. For |
18 | int (*suspend)(struct device * dev, pm_message_t state); | 392 | example, a bus-specific device driver's resume() method might be used there, |
19 | int (*resume)(struct device * dev); | 393 | so it wouldn't only be called from bus.resume() during system-wide wakeup. |
20 | }; | 394 | See bus-specific information about how runtime wakeup events are handled. |
21 | 395 | ||
22 | Each bus driver is responsible implementing these methods, translating | ||
23 | the call into a bus-specific request and forwarding the call to the | ||
24 | bus-specific drivers. For example, PCI drivers implement suspend() and | ||
25 | resume() methods in struct pci_driver. The PCI core is simply | ||
26 | responsible for translating the pointers to PCI-specific ones and | ||
27 | calling the low-level driver. | ||
28 | |||
29 | This is done to a) ease transition to the new power management methods | ||
30 | and leverage the existing PM code in various bus drivers; b) allow | ||
31 | buses to implement generic and default PM routines for devices, and c) | ||
32 | make the flow of execution obvious to the reader. | ||
33 | |||
34 | |||
35 | System Power Management | ||
36 | |||
37 | When the system enters a low-power state, the device tree is walked in | ||
38 | a depth-first fashion to transition each device into a low-power | ||
39 | state. The ordering of the device tree is guaranteed by the order in | ||
40 | which devices get registered - children are never registered before | ||
41 | their ancestors, and devices are placed at the back of the list when | ||
42 | registered. By walking the list in reverse order, we are guaranteed to | ||
43 | suspend devices in the proper order. | ||
44 | |||
45 | Devices are suspended once with interrupts enabled. Drivers are | ||
46 | expected to stop I/O transactions, save device state, and place the | ||
47 | device into a low-power state. Drivers may sleep, allocate memory, | ||
48 | etc. at will. | ||
49 | |||
50 | Some devices are broken and will inevitably have problems powering | ||
51 | down or disabling themselves with interrupts enabled. For these | ||
52 | special cases, they may return -EAGAIN. This will put the device on a | ||
53 | list to be taken care of later. When interrupts are disabled, before | ||
54 | we enter the low-power state, their drivers are called again to put | ||
55 | their device to sleep. | ||
56 | |||
57 | On resume, the devices that returned -EAGAIN will be called to power | ||
58 | themselves back on with interrupts disabled. Once interrupts have been | ||
59 | re-enabled, the rest of the drivers will be called to resume their | ||
60 | devices. On resume, a driver is responsible for powering back on each | ||
61 | device, restoring state, and re-enabling I/O transactions for that | ||
62 | device. | ||
63 | 396 | ||
397 | System Devices | ||
398 | -------------- | ||
64 | System devices follow a slightly different API, which can be found in | 399 | System devices follow a slightly different API, which can be found in |
65 | 400 | ||
66 | include/linux/sysdev.h | 401 | include/linux/sysdev.h |
67 | drivers/base/sys.c | 402 | drivers/base/sys.c |
68 | 403 | ||
69 | System devices will only be suspended with interrupts disabled, and | 404 | System devices will only be suspended with interrupts disabled, and after |
70 | after all other devices have been suspended. On resume, they will be | 405 | all other devices have been suspended. On resume, they will be resumed |
71 | resumed before any other devices, and also with interrupts disabled. | 406 | before any other devices, and also with interrupts disabled. |
72 | 407 | ||
408 | That is, IRQs are disabled, the suspend_late() phase begins, then the | ||
409 | sysdev_driver.suspend() phase, and the system enters a sleep state. Then | ||
410 | the sysdev_driver.resume() phase begins, followed by the resume_early() | ||
411 | phase, after which IRQs are enabled. | ||
73 | 412 | ||
74 | Runtime Power Management | 413 | Code to actually enter and exit the system-wide low power state sometimes |
75 | 414 | involves hardware details that are only known to the boot firmware, and | |
76 | Many devices are able to dynamically power down while the system is | 415 | may leave a CPU running software (from SRAM or flash memory) that monitors |
77 | still running. This feature is useful for devices that are not being | 416 | the system and manages its wakeup sequence. |
78 | used, and can offer significant power savings on a running system. | ||
79 | |||
80 | In each device's directory, there is a 'power' directory, which | ||
81 | contains at least a 'state' file. Reading from this file displays what | ||
82 | power state the device is currently in. Writing to this file initiates | ||
83 | a transition to the specified power state, which must be a decimal in | ||
84 | the range 1-3, inclusive; or 0 for 'On'. | ||
85 | 417 | ||
86 | The PM core will call the ->suspend() method in the bus_type object | ||
87 | that the device belongs to if the specified state is not 0, or | ||
88 | ->resume() if it is. | ||
89 | 418 | ||
90 | Nothing will happen if the specified state is the same state the | 419 | Runtime Power Management |
91 | device is currently in. | 420 | ======================== |
92 | 421 | Many devices are able to dynamically power down while the system is still | |
93 | If the device is already in a low-power state, and the specified state | 422 | running. This feature is useful for devices that are not being used, and |
94 | is another, but different, low-power state, the ->resume() method will | 423 | can offer significant power savings on a running system. These devices |
95 | first be called to power the device back on, then ->suspend() will be | 424 | often support a range of runtime power states, which might use names such |
96 | called again with the new state. | 425 | as "off", "sleep", "idle", "active", and so on. Those states will in some |
97 | 426 | cases (like PCI) be partially constrained by a bus the device uses, and will | |
98 | The driver is responsible for saving the working state of the device | 427 | usually include hardware states that are also used in system sleep states. |
99 | and putting it into the low-power state specified. If this was | 428 | |
100 | successful, it returns 0, and the device's power_state field is | 429 | However, note that if a driver puts a device into a runtime low power state |
101 | updated. | 430 | and the system then goes into a system-wide sleep state, it normally ought |
102 | 431 | to resume into that runtime low power state rather than "full on". Such | |
103 | The driver must take care to know whether or not it is able to | 432 | distinctions would be part of the driver-internal state machine for that |
104 | properly resume the device, including all step of reinitialization | 433 | hardware; the whole point of runtime power management is to be sure that |
105 | necessary. (This is the hardest part, and the one most protected by | 434 | drivers are decoupled in that way from the state machine governing phases |
106 | NDA'd documents). | 435 | of the system-wide power/sleep state transitions. |
107 | 436 | ||
108 | The driver must also take care not to suspend a device that is | 437 | |
109 | currently in use. It is their responsibility to provide their own | 438 | Power Saving Techniques |
110 | exclusion mechanisms. | 439 | ----------------------- |
111 | 440 | Normally runtime power management is handled by the drivers without specific | |
112 | The runtime power transition happens with interrupts enabled. If a | 441 | userspace or kernel intervention, by device-aware use of techniques like: |
113 | device cannot support being powered down with interrupts, it may | 442 | |
114 | return -EAGAIN (as it would during a system power management | 443 | Using information provided by other system layers |
115 | transition), but it will _not_ be called again, and the transaction | 444 | - stay deeply "off" except between open() and close() |
116 | will fail. | 445 | - if transceiver/PHY indicates "nobody connected", stay "off" |
117 | 446 | - application protocols may include power commands or hints | |
118 | There is currently no way to know what states a device or driver | 447 | |
119 | supports a priori. This will change in the future. | 448 | Using fewer CPU cycles |
120 | 449 | - using DMA instead of PIO | |
121 | pm_message_t meaning | 450 | - removing timers, or making them lower frequency |
122 | 451 | - shortening "hot" code paths | |
123 | pm_message_t has two fields. event ("major"), and flags. If driver | 452 | - eliminating cache misses |
124 | does not know event code, it aborts the request, returning error. Some | 453 | - (sometimes) offloading work to device firmware |
125 | drivers may need to deal with special cases based on the actual type | 454 | |
126 | of suspend operation being done at the system level. This is why | 455 | Reducing other resource costs |
127 | there are flags. | 456 | - gating off unused clocks in software (or hardware) |
128 | 457 | - switching off unused power supplies | |
129 | Event codes are: | 458 | - eliminating (or delaying/merging) IRQs |
130 | 459 | - tuning DMA to use word and/or burst modes | |
131 | ON -- no need to do anything except special cases like broken | 460 | |
132 | HW. | 461 | Using device-specific low power states |
133 | 462 | - using lower voltages | |
134 | # NOTIFICATION -- pretty much same as ON? | 463 | - avoiding needless DMA transfers |
135 | 464 | ||
136 | FREEZE -- stop DMA and interrupts, and be prepared to reinit HW from | 465 | Read your hardware documentation carefully to see the opportunities that |
137 | scratch. That probably means stop accepting upstream requests, the | 466 | may be available. If you can, measure the actual power usage and check |
138 | actual policy of what to do with them being specific to a given | 467 | it against the budget established for your project. |
139 | driver. It's acceptable for a network driver to just drop packets | 468 | |
140 | while a block driver is expected to block the queue so no request is | 469 | |
141 | lost. (Use IDE as an example on how to do that). FREEZE requires no | 470 | Examples: USB hosts, system timer, system CPU |
142 | power state change, and it's expected for drivers to be able to | 471 | ---------------------------------------------- |
143 | quickly transition back to operating state. | 472 | USB host controllers make interesting, if complex, examples. In many cases |
144 | 473 | these have no work to do: no USB devices are connected, or all of them are | |
145 | SUSPEND -- like FREEZE, but also put hardware into low-power state. If | 474 | in the USB "suspend" state. Linux host controller drivers can then disable |
146 | there's need to distinguish several levels of sleep, additional flag | 475 | periodic DMA transfers that would otherwise be a constant power drain on the |
147 | is probably best way to do that. | 476 | memory subsystem, and enter a suspend state. In power-aware controllers, |
148 | 477 | entering that suspend state may disable the clock used with USB signaling, | |
149 | Transitions are only from a resumed state to a suspended state, never | 478 | saving a certain amount of power. |
150 | between 2 suspended states. (ON -> FREEZE or ON -> SUSPEND can happen, | 479 | |
151 | FREEZE -> SUSPEND or SUSPEND -> FREEZE can not). | 480 | The controller will be woken from that state (with an IRQ) by changes to the |
152 | 481 | signal state on the data lines of a given port, for example by an existing | |
153 | All events are: | 482 | peripheral requesting "remote wakeup" or by plugging a new peripheral. The |
154 | 483 | same wakeup mechanism usually works from "standby" sleep states, and on some | |
155 | [NOTE NOTE NOTE: If you are driver author, you should not care; you | 484 | systems also from "suspend to RAM" (or even "suspend to disk") states. |
156 | should only look at event, and ignore flags.] | 485 | (Except that ACPI may be involved instead of normal IRQs, on some hardware.) |
157 | 486 | ||
158 | #Prepare for suspend -- userland is still running but we are going to | 487 | System devices like timers and CPUs may have special roles in the platform |
159 | #enter suspend state. This gives drivers chance to load firmware from | 488 | power management scheme. For example, system timers using a "dynamic tick" |
160 | #disk and store it in memory, or do other activities taht require | 489 | approach don't just save CPU cycles (by eliminating needless timer IRQs), |
161 | #operating userland, ability to kmalloc GFP_KERNEL, etc... All of these | 490 | but they may also open the door to using lower power CPU "idle" states that |
162 | #are forbiden once the suspend dance is started.. event = ON, flags = | 491 | cost more than a jiffie to enter and exit. On x86 systems these are states |
163 | #PREPARE_TO_SUSPEND | 492 | like "C3"; note that periodic DMA transfers from a USB host controller will |
164 | 493 | also prevent entry to a C3 state, much like a periodic timer IRQ. | |
165 | Apm standby -- prepare for APM event. Quiesce devices to make life | 494 | |
166 | easier for APM BIOS. event = FREEZE, flags = APM_STANDBY | 495 | That kind of runtime mechanism interaction is common. "System On Chip" (SOC) |
167 | 496 | processors often have low power idle modes that can't be entered unless | |
168 | Apm suspend -- same as APM_STANDBY, but it we should probably avoid | 497 | certain medium-speed clocks (often 12 or 48 MHz) are gated off. When the |
169 | spinning down disks. event = FREEZE, flags = APM_SUSPEND | 498 | drivers gate those clocks effectively, then the system idle task may be able |
170 | 499 | to use the lower power idle modes and thereby increase battery life. | |
171 | System halt, reboot -- quiesce devices to make life easier for BIOS. event | 500 | |
172 | = FREEZE, flags = SYSTEM_HALT or SYSTEM_REBOOT | 501 | If the CPU can have a "cpufreq" driver, there also may be opportunities |
173 | 502 | to shift to lower voltage settings and reduce the power cost of executing | |
174 | System shutdown -- at least disks need to be spun down, or data may be | 503 | a given number of instructions. (Without voltage adjustment, it's rare |
175 | lost. Quiesce devices, just to make life easier for BIOS. event = | 504 | for cpufreq to save much power; the cost-per-instruction must go down.) |
176 | FREEZE, flags = SYSTEM_SHUTDOWN | 505 | |
177 | 506 | ||
178 | Kexec -- turn off DMAs and put hardware into some state where new | 507 | /sys/devices/.../power/state files |
179 | kernel can take over. event = FREEZE, flags = KEXEC | 508 | ================================== |
180 | 509 | For now you can also test some of this functionality using sysfs. | |
181 | Powerdown at end of swsusp -- very similar to SYSTEM_SHUTDOWN, except wake | 510 | |
182 | may need to be enabled on some devices. This actually has at least 3 | 511 | DEPRECATED: USE "power/state" ONLY FOR DRIVER TESTING, AND |
183 | subtypes, system can reboot, enter S4 and enter S5 at the end of | 512 | AVOID USING dev->power.power_state IN DRIVERS. |
184 | swsusp. event = FREEZE, flags = SWSUSP and one of SYSTEM_REBOOT, | 513 | |
185 | SYSTEM_SHUTDOWN, SYSTEM_S4 | 514 | THESE WILL BE REMOVED. IF THE "power/state" FILE GETS REPLACED, |
186 | 515 | IT WILL BECOME SOMETHING COUPLED TO THE BUS OR DRIVER. | |
187 | Suspend to ram -- put devices into low power state. event = SUSPEND, | 516 | |
188 | flags = SUSPEND_TO_RAM | 517 | In each device's directory, there is a 'power' directory, which contains |
189 | 518 | at least a 'state' file. The value of this field is effectively boolean, | |
190 | Freeze for swsusp snapshot -- stop DMA and interrupts. No need to put | 519 | PM_EVENT_ON or PM_EVENT_SUSPEND. |
191 | devices into low power mode, but you must be able to reinitialize | 520 | |
192 | device from scratch in resume method. This has two flavors, its done | 521 | * Reading from this file displays a value corresponding to |
193 | once on suspending kernel, once on resuming kernel. event = FREEZE, | 522 | the power.power_state.event field. All nonzero values are |
194 | flags = DURING_SUSPEND or DURING_RESUME | 523 | displayed as "2", corresponding to a low power state; zero |
195 | 524 | is displayed as "0", corresponding to normal operation. | |
196 | Device detach requested from /sys -- deinitialize device; proably same as | 525 | |
197 | SYSTEM_SHUTDOWN, I do not understand this one too much. probably event | 526 | * Writing to this file initiates a transition using the |
198 | = FREEZE, flags = DEV_DETACH. | 527 | specified event code number; only '0', '2', and '3' are |
199 | 528 | accepted (without a newline); '2' and '3' are both | |
200 | #These are not really events sent: | 529 | mapped to PM_EVENT_SUSPEND. |
201 | # | 530 | |
202 | #System fully on -- device is working normally; this is probably never | 531 | On writes, the PM core relies on that recorded event code and the device/bus |
203 | #passed to suspend() method... event = ON, flags = 0 | 532 | capabilities to determine whether it uses a partial suspend() or resume() |
204 | # | 533 | sequence to change things so that the recorded event corresponds to the |
205 | #Ready after resume -- userland is now running, again. Time to free any | 534 | numeric parameter. |
206 | #memory you ate during prepare to suspend... event = ON, flags = | 535 | |
207 | #READY_AFTER_RESUME | 536 | - If the bus requires the irqs-disabled suspend_late()/resume_early() |
208 | # | 537 | phases, writes fail because those operations are not supported here. |
538 | |||
539 | - If the recorded value is the expected value, nothing is done. | ||
540 | |||
541 | - If the recorded value is nonzero, the device is partially resumed, | ||
542 | using the bus.resume() and/or class.resume() methods. | ||
543 | |||
544 | - If the target value is nonzero, the device is partially suspended, | ||
545 | using the class.suspend() and/or bus.suspend() methods and the | ||
546 | PM_EVENT_SUSPEND message. | ||
547 | |||
548 | Drivers have no way to tell whether their suspend() and resume() calls | ||
549 | have come through the sysfs power/state file or as part of entering a | ||
550 | system sleep state, except that when accessed through sysfs the normal | ||
551 | parent/child sequencing rules are ignored. Drivers (such as bus, bridge, | ||
552 | or hub drivers) which expose child devices may need to enforce those rules | ||
553 | on their own. | ||
diff --git a/Documentation/power/interface.txt b/Documentation/power/interface.txt index 4117802af0f8..a66bec222b16 100644 --- a/Documentation/power/interface.txt +++ b/Documentation/power/interface.txt | |||
@@ -52,3 +52,18 @@ suspend image will be as small as possible. | |||
52 | 52 | ||
53 | Reading from this file will display the current image size limit, which | 53 | Reading from this file will display the current image size limit, which |
54 | is set to 500 MB by default. | 54 | is set to 500 MB by default. |
55 | |||
56 | /sys/power/pm_trace controls the code which saves the last PM event point in | ||
57 | the RTC across reboots, so that you can debug a machine that just hangs | ||
58 | during suspend (or more commonly, during resume). Namely, the RTC is only | ||
59 | used to save the last PM event point if this file contains '1'. Initially it | ||
60 | contains '0' which may be changed to '1' by writing a string representing a | ||
61 | nonzero integer into it. | ||
62 | |||
63 | To use this debugging feature you should attempt to suspend the machine, then | ||
64 | reboot it and run | ||
65 | |||
66 | dmesg -s 1000000 | grep 'hash matches' | ||
67 | |||
68 | CAUTION: Using it will cause your machine's real-time (CMOS) clock to be | ||
69 | set to a random invalid time after a resume. | ||
diff --git a/Documentation/rt-mutex-design.txt b/Documentation/rt-mutex-design.txt index c472ffacc2f6..4b736d24da7a 100644 --- a/Documentation/rt-mutex-design.txt +++ b/Documentation/rt-mutex-design.txt | |||
@@ -333,11 +333,11 @@ cmpxchg is basically the following function performed atomically: | |||
333 | 333 | ||
334 | unsigned long _cmpxchg(unsigned long *A, unsigned long *B, unsigned long *C) | 334 | unsigned long _cmpxchg(unsigned long *A, unsigned long *B, unsigned long *C) |
335 | { | 335 | { |
336 | unsigned long T = *A; | 336 | unsigned long T = *A; |
337 | if (*A == *B) { | 337 | if (*A == *B) { |
338 | *A = *C; | 338 | *A = *C; |
339 | } | 339 | } |
340 | return T; | 340 | return T; |
341 | } | 341 | } |
342 | #define cmpxchg(a,b,c) _cmpxchg(&a,&b,&c) | 342 | #define cmpxchg(a,b,c) _cmpxchg(&a,&b,&c) |
343 | 343 | ||
@@ -582,7 +582,7 @@ contention). | |||
582 | try_to_take_rt_mutex is used every time the task tries to grab a mutex in the | 582 | try_to_take_rt_mutex is used every time the task tries to grab a mutex in the |
583 | slow path. The first thing that is done here is an atomic setting of | 583 | slow path. The first thing that is done here is an atomic setting of |
584 | the "Has Waiters" flag of the mutex's owner field. Yes, this could really | 584 | the "Has Waiters" flag of the mutex's owner field. Yes, this could really |
585 | be false, because if the the mutex has no owner, there are no waiters and | 585 | be false, because if the mutex has no owner, there are no waiters and |
586 | the current task also won't have any waiters. But we don't have the lock | 586 | the current task also won't have any waiters. But we don't have the lock |
587 | yet, so we assume we are going to be a waiter. The reason for this is to | 587 | yet, so we assume we are going to be a waiter. The reason for this is to |
588 | play nice for those architectures that do have CMPXCHG. By setting this flag | 588 | play nice for those architectures that do have CMPXCHG. By setting this flag |
@@ -735,7 +735,7 @@ do have CMPXCHG, that check is done in the fast path, but it is still needed | |||
735 | in the slow path too. If a waiter of a mutex woke up because of a signal | 735 | in the slow path too. If a waiter of a mutex woke up because of a signal |
736 | or timeout between the time the owner failed the fast path CMPXCHG check and | 736 | or timeout between the time the owner failed the fast path CMPXCHG check and |
737 | the grabbing of the wait_lock, the mutex may not have any waiters, thus the | 737 | the grabbing of the wait_lock, the mutex may not have any waiters, thus the |
738 | owner still needs to make this check. If there are no waiters than the mutex | 738 | owner still needs to make this check. If there are no waiters then the mutex |
739 | owner field is set to NULL, the wait_lock is released and nothing more is | 739 | owner field is set to NULL, the wait_lock is released and nothing more is |
740 | needed. | 740 | needed. |
741 | 741 | ||
diff --git a/Documentation/seclvl.txt b/Documentation/seclvl.txt deleted file mode 100644 index 97274d122d0e..000000000000 --- a/Documentation/seclvl.txt +++ /dev/null | |||
@@ -1,97 +0,0 @@ | |||
1 | BSD Secure Levels Linux Security Module | ||
2 | Michael A. Halcrow <mike@halcrow.us> | ||
3 | |||
4 | |||
5 | Introduction | ||
6 | |||
7 | Under the BSD Secure Levels security model, sets of policies are | ||
8 | associated with levels. Levels range from -1 to 2, with -1 being the | ||
9 | weakest and 2 being the strongest. These security policies are | ||
10 | enforced at the kernel level, so not even the superuser is able to | ||
11 | disable or circumvent them. This hardens the machine against attackers | ||
12 | who gain root access to the system. | ||
13 | |||
14 | |||
15 | Levels and Policies | ||
16 | |||
17 | Level -1 (Permanently Insecure): | ||
18 | - Cannot increase the secure level | ||
19 | |||
20 | Level 0 (Insecure): | ||
21 | - Cannot ptrace the init process | ||
22 | |||
23 | Level 1 (Default): | ||
24 | - /dev/mem and /dev/kmem are read-only | ||
25 | - IMMUTABLE and APPEND extended attributes, if set, may not be unset | ||
26 | - Cannot load or unload kernel modules | ||
27 | - Cannot write directly to a mounted block device | ||
28 | - Cannot perform raw I/O operations | ||
29 | - Cannot perform network administrative tasks | ||
30 | - Cannot setuid any file | ||
31 | |||
32 | Level 2 (Secure): | ||
33 | - Cannot decrement the system time | ||
34 | - Cannot write to any block device, whether mounted or not | ||
35 | - Cannot unmount any mounted filesystems | ||
36 | |||
37 | |||
38 | Compilation | ||
39 | |||
40 | To compile the BSD Secure Levels LSM, seclvl.ko, enable the | ||
41 | SECURITY_SECLVL configuration option. This is found under Security | ||
42 | options -> BSD Secure Levels in the kernel configuration menu. | ||
43 | |||
44 | |||
45 | Basic Usage | ||
46 | |||
47 | Once the machine is in a running state, with all the necessary modules | ||
48 | loaded and all the filesystems mounted, you can load the seclvl.ko | ||
49 | module: | ||
50 | |||
51 | # insmod seclvl.ko | ||
52 | |||
53 | The module defaults to secure level 1, except when compiled directly | ||
54 | into the kernel, in which case it defaults to secure level 0. To raise | ||
55 | the secure level to 2, the administrator writes ``2'' to the | ||
56 | seclvl/seclvl file under the sysfs mount point (assumed to be /sys in | ||
57 | these examples): | ||
58 | |||
59 | # echo -n "2" > /sys/seclvl/seclvl | ||
60 | |||
61 | Alternatively, you can initialize the module at secure level 2 with | ||
62 | the initlvl module parameter: | ||
63 | |||
64 | # insmod seclvl.ko initlvl=2 | ||
65 | |||
66 | At this point, it is impossible to remove the module or reduce the | ||
67 | secure level. If the administrator wishes to have the option of doing | ||
68 | so, he must provide a module parameter, sha1_passwd, that specifies | ||
69 | the SHA1 hash of the password that can be used to reduce the secure | ||
70 | level to 0. | ||
71 | |||
72 | To generate this SHA1 hash, the administrator can use OpenSSL: | ||
73 | |||
74 | # echo -n "boogabooga" | openssl sha1 | ||
75 | abeda4e0f33defa51741217592bf595efb8d289c | ||
76 | |||
77 | In order to use password-instigated secure level reduction, the SHA1 | ||
78 | crypto module must be loaded or compiled into the kernel: | ||
79 | |||
80 | # insmod sha1.ko | ||
81 | |||
82 | The administrator can then insmod the seclvl module, including the | ||
83 | SHA1 hash of the password: | ||
84 | |||
85 | # insmod seclvl.ko | ||
86 | sha1_passwd=abeda4e0f33defa51741217592bf595efb8d289c | ||
87 | |||
88 | To reduce the secure level, write the password to seclvl/passwd under | ||
89 | your sysfs mount point: | ||
90 | |||
91 | # echo -n "boogabooga" > /sys/seclvl/passwd | ||
92 | |||
93 | The September 2004 edition of Sys Admin Magazine has an article about | ||
94 | the BSD Secure Levels LSM. I encourage you to refer to that article | ||
95 | for a more in-depth treatment of this security module: | ||
96 | |||
97 | http://www.samag.com/documents/s=9304/sam0409a/0409a.htm | ||
diff --git a/Documentation/sh/new-machine.txt b/Documentation/sh/new-machine.txt index eb2dd2e6993b..73988e0d112b 100644 --- a/Documentation/sh/new-machine.txt +++ b/Documentation/sh/new-machine.txt | |||
@@ -41,11 +41,6 @@ Board-specific code: | |||
41 | | | 41 | | |
42 | .. more boards here ... | 42 | .. more boards here ... |
43 | 43 | ||
44 | It should also be noted that each board is required to have some certain | ||
45 | headers. At the time of this writing, io.h is the only thing that needs | ||
46 | to be provided for each board, and can generally just reference generic | ||
47 | functions (with the exception of isa_port2addr). | ||
48 | |||
49 | Next, for companion chips: | 44 | Next, for companion chips: |
50 | . | 45 | . |
51 | `-- arch | 46 | `-- arch |
@@ -104,12 +99,13 @@ and then populate that with sub-directories for each member of the family. | |||
104 | Both the Solution Engine and the hp6xx boards are an example of this. | 99 | Both the Solution Engine and the hp6xx boards are an example of this. |
105 | 100 | ||
106 | After you have setup your new arch/sh/boards/ directory, remember that you | 101 | After you have setup your new arch/sh/boards/ directory, remember that you |
107 | also must add a directory in include/asm-sh for headers localized to this | 102 | should also add a directory in include/asm-sh for headers localized to this |
108 | board. In order to interoperate seamlessly with the build system, it's best | 103 | board (if there are going to be more than one). In order to interoperate |
109 | to have this directory the same as the arch/sh/boards/ directory name, | 104 | seamlessly with the build system, it's best to have this directory the same |
110 | though if your board is again part of a family, the build system has ways | 105 | as the arch/sh/boards/ directory name, though if your board is again part of |
111 | of dealing with this, and you can feel free to name the directory after | 106 | a family, the build system has ways of dealing with this (via incdir-y |
112 | the family member itself. | 107 | overloading), and you can feel free to name the directory after the family |
108 | member itself. | ||
113 | 109 | ||
114 | There are a few things that each board is required to have, both in the | 110 | There are a few things that each board is required to have, both in the |
115 | arch/sh/boards and the include/asm-sh/ heirarchy. In order to better | 111 | arch/sh/boards and the include/asm-sh/ heirarchy. In order to better |
@@ -122,6 +118,7 @@ might look something like: | |||
122 | * arch/sh/boards/vapor/setup.c - Setup code for imaginary board | 118 | * arch/sh/boards/vapor/setup.c - Setup code for imaginary board |
123 | */ | 119 | */ |
124 | #include <linux/init.h> | 120 | #include <linux/init.h> |
121 | #include <asm/rtc.h> /* for board_time_init() */ | ||
125 | 122 | ||
126 | const char *get_system_type(void) | 123 | const char *get_system_type(void) |
127 | { | 124 | { |
@@ -152,79 +149,57 @@ int __init platform_setup(void) | |||
152 | } | 149 | } |
153 | 150 | ||
154 | Our new imaginary board will also have to tie into the machvec in order for it | 151 | Our new imaginary board will also have to tie into the machvec in order for it |
155 | to be of any use. Currently the machvec is slowly on its way out, but is still | 152 | to be of any use. |
156 | required for the time being. As such, let us take a look at what needs to be | ||
157 | done for the machvec assignment. | ||
158 | 153 | ||
159 | machvec functions fall into a number of categories: | 154 | machvec functions fall into a number of categories: |
160 | 155 | ||
161 | - I/O functions to IO memory (inb etc) and PCI/main memory (readb etc). | 156 | - I/O functions to IO memory (inb etc) and PCI/main memory (readb etc). |
162 | - I/O remapping functions (ioremap etc) | 157 | - I/O mapping functions (ioport_map, ioport_unmap, etc). |
163 | - some initialisation functions | 158 | - a 'heartbeat' function. |
164 | - a 'heartbeat' function | 159 | - PCI and IRQ initialization routines. |
165 | - some miscellaneous flags | 160 | - Consistent allocators (for boards that need special allocators, |
166 | 161 | particularly for allocating out of some board-specific SRAM for DMA | |
167 | The tree can be built in two ways: | 162 | handles). |
168 | - as a fully generic build. All drivers are linked in, and all functions | 163 | |
169 | go through the machvec | 164 | There are machvec functions added and removed over time, so always be sure to |
170 | - as a machine specific build. In this case only the required drivers | 165 | consult include/asm-sh/machvec.h for the current state of the machvec. |
171 | will be linked in, and some macros may be redefined to not go through | 166 | |
172 | the machvec where performance is important (in particular IO functions). | 167 | The kernel will automatically wrap in generic routines for undefined function |
173 | 168 | pointers in the machvec at boot time, as machvec functions are referenced | |
174 | There are three ways in which IO can be performed: | 169 | unconditionally throughout most of the tree. Some boards have incredibly |
175 | - none at all. This is really only useful for the 'unknown' machine type, | 170 | sparse machvecs (such as the dreamcast and sh03), whereas others must define |
176 | which us designed to run on a machine about which we know nothing, and | 171 | virtually everything (rts7751r2d). |
177 | so all all IO instructions do nothing. | 172 | |
178 | - fully custom. In this case all IO functions go to a machine specific | 173 | Adding a new machine is relatively trivial (using vapor as an example): |
179 | set of functions which can do what they like | 174 | |
180 | - a generic set of functions. These will cope with most situations, | 175 | If the board-specific definitions are quite minimalistic, as is the case for |
181 | and rely on a single function, mv_port2addr, which is called through the | 176 | the vast majority of boards, simply having a single board-specific header is |
182 | machine vector, and converts an IO address into a memory address, which | 177 | sufficient. |
183 | can be read from/written to directly. | 178 | |
184 | 179 | - add a new file include/asm-sh/vapor.h which contains prototypes for | |
185 | Thus adding a new machine involves the following steps (I will assume I am | ||
186 | adding a machine called vapor): | ||
187 | |||
188 | - add a new file include/asm-sh/vapor/io.h which contains prototypes for | ||
189 | any machine specific IO functions prefixed with the machine name, for | 180 | any machine specific IO functions prefixed with the machine name, for |
190 | example vapor_inb. These will be needed when filling out the machine | 181 | example vapor_inb. These will be needed when filling out the machine |
191 | vector. | 182 | vector. |
192 | 183 | ||
193 | This is the minimum that is required, however there are ample | 184 | Note that these prototypes are generated automatically by setting |
194 | opportunities to optimise this. In particular, by making the prototypes | 185 | __IO_PREFIX to something sensible. A typical example would be: |
195 | inline function definitions, it is possible to inline the function when | 186 | |
196 | building machine specific versions. Note that the machine vector | 187 | #define __IO_PREFIX vapor |
197 | functions will still be needed, so that a module built for a generic | 188 | #include <asm/io_generic.h> |
198 | setup can be loaded. | 189 | |
199 | 190 | somewhere in the board-specific header. Any boards being ported that still | |
200 | - add a new file arch/sh/boards/vapor/mach.c. This contains the definition | 191 | have a legacy io.h should remove it entirely and switch to the new model. |
201 | of the machine vector. When building the machine specific version, this | 192 | |
202 | will be the real machine vector (via an alias), while in the generic | 193 | - Add machine vector definitions to the board's setup.c. At a bare minimum, |
203 | version is used to initialise the machine vector, and then freed, by | 194 | this must be defined as something like: |
204 | making it initdata. This should be defined as: | 195 | |
205 | 196 | struct sh_machine_vector mv_vapor __initmv = { | |
206 | struct sh_machine_vector mv_vapor __initmv = { | 197 | .mv_name = "vapor", |
207 | .mv_name = "vapor", | 198 | }; |
208 | } | 199 | ALIAS_MV(vapor) |
209 | ALIAS_MV(vapor) | 200 | |
210 | 201 | - finally add a file arch/sh/boards/vapor/io.c, which contains definitions of | |
211 | - finally add a file arch/sh/boards/vapor/io.c, which contains | 202 | the machine specific io functions (if there are enough to warrant it). |
212 | definitions of the machine specific io functions. | ||
213 | |||
214 | A note about initialisation functions. Three initialisation functions are | ||
215 | provided in the machine vector: | ||
216 | - mv_arch_init - called very early on from setup_arch | ||
217 | - mv_init_irq - called from init_IRQ, after the generic SH interrupt | ||
218 | initialisation | ||
219 | - mv_init_pci - currently not used | ||
220 | |||
221 | Any other remaining functions which need to be called at start up can be | ||
222 | added to the list using the __initcalls macro (or module_init if the code | ||
223 | can be built as a module). Many generic drivers probe to see if the device | ||
224 | they are targeting is present, however this may not always be appropriate, | ||
225 | so a flag can be added to the machine vector which will be set on those | ||
226 | machines which have the hardware in question, reducing the probe to a | ||
227 | single conditional. | ||
228 | 203 | ||
229 | 3. Hooking into the Build System | 204 | 3. Hooking into the Build System |
230 | ================================ | 205 | ================================ |
@@ -303,4 +278,3 @@ which will in turn copy the defconfig for this board, run it through | |||
303 | oldconfig (prompting you for any new options since the time of creation), | 278 | oldconfig (prompting you for any new options since the time of creation), |
304 | and start you on your way to having a functional kernel for your new | 279 | and start you on your way to having a functional kernel for your new |
305 | board. | 280 | board. |
306 | |||
diff --git a/Documentation/sh/register-banks.txt b/Documentation/sh/register-banks.txt new file mode 100644 index 000000000000..a6719f2f6594 --- /dev/null +++ b/Documentation/sh/register-banks.txt | |||
@@ -0,0 +1,33 @@ | |||
1 | Notes on register bank usage in the kernel | ||
2 | ========================================== | ||
3 | |||
4 | Introduction | ||
5 | ------------ | ||
6 | |||
7 | The SH-3 and SH-4 CPU families traditionally include a single partial register | ||
8 | bank (selected by SR.RB, only r0 ... r7 are banked), whereas other families | ||
9 | may have more full-featured banking or simply no such capabilities at all. | ||
10 | |||
11 | SR.RB banking | ||
12 | ------------- | ||
13 | |||
14 | In the case of this type of banking, banked registers are mapped directly to | ||
15 | r0 ... r7 if SR.RB is set to the bank we are interested in, otherwise ldc/stc | ||
16 | can still be used to reference the banked registers (as r0_bank ... r7_bank) | ||
17 | when in the context of another bank. The developer must keep the SR.RB value | ||
18 | in mind when writing code that utilizes these banked registers, for obvious | ||
19 | reasons. Userspace is also not able to poke at the bank1 values, so these can | ||
20 | be used rather effectively as scratch registers by the kernel. | ||
21 | |||
22 | Presently the kernel uses several of these registers. | ||
23 | |||
24 | - r0_bank, r1_bank (referenced as k0 and k1, used for scratch | ||
25 | registers when doing exception handling). | ||
26 | - r2_bank (used to track the EXPEVT/INTEVT code) | ||
27 | - Used by do_IRQ() and friends for doing irq mapping based off | ||
28 | of the interrupt exception vector jump table offset | ||
29 | - r6_bank (global interrupt mask) | ||
30 | - The SR.IMASK interrupt handler makes use of this to set the | ||
31 | interrupt priority level (used by local_irq_enable()) | ||
32 | - r7_bank (current) | ||
33 | |||
diff --git a/Documentation/sysctl/vm.txt b/Documentation/sysctl/vm.txt index 7cee90223d3a..20d0d797f539 100644 --- a/Documentation/sysctl/vm.txt +++ b/Documentation/sysctl/vm.txt | |||
@@ -29,6 +29,7 @@ Currently, these files are in /proc/sys/vm: | |||
29 | - drop-caches | 29 | - drop-caches |
30 | - zone_reclaim_mode | 30 | - zone_reclaim_mode |
31 | - min_unmapped_ratio | 31 | - min_unmapped_ratio |
32 | - min_slab_ratio | ||
32 | - panic_on_oom | 33 | - panic_on_oom |
33 | 34 | ||
34 | ============================================================== | 35 | ============================================================== |
@@ -138,7 +139,6 @@ This is value ORed together of | |||
138 | 1 = Zone reclaim on | 139 | 1 = Zone reclaim on |
139 | 2 = Zone reclaim writes dirty pages out | 140 | 2 = Zone reclaim writes dirty pages out |
140 | 4 = Zone reclaim swaps pages | 141 | 4 = Zone reclaim swaps pages |
141 | 8 = Also do a global slab reclaim pass | ||
142 | 142 | ||
143 | zone_reclaim_mode is set during bootup to 1 if it is determined that pages | 143 | zone_reclaim_mode is set during bootup to 1 if it is determined that pages |
144 | from remote zones will cause a measurable performance reduction. The | 144 | from remote zones will cause a measurable performance reduction. The |
@@ -162,18 +162,13 @@ Allowing regular swap effectively restricts allocations to the local | |||
162 | node unless explicitly overridden by memory policies or cpuset | 162 | node unless explicitly overridden by memory policies or cpuset |
163 | configurations. | 163 | configurations. |
164 | 164 | ||
165 | It may be advisable to allow slab reclaim if the system makes heavy | ||
166 | use of files and builds up large slab caches. However, the slab | ||
167 | shrink operation is global, may take a long time and free slabs | ||
168 | in all nodes of the system. | ||
169 | |||
170 | ============================================================= | 165 | ============================================================= |
171 | 166 | ||
172 | min_unmapped_ratio: | 167 | min_unmapped_ratio: |
173 | 168 | ||
174 | This is available only on NUMA kernels. | 169 | This is available only on NUMA kernels. |
175 | 170 | ||
176 | A percentage of the file backed pages in each zone. Zone reclaim will only | 171 | A percentage of the total pages in each zone. Zone reclaim will only |
177 | occur if more than this percentage of pages are file backed and unmapped. | 172 | occur if more than this percentage of pages are file backed and unmapped. |
178 | This is to insure that a minimal amount of local pages is still available for | 173 | This is to insure that a minimal amount of local pages is still available for |
179 | file I/O even if the node is overallocated. | 174 | file I/O even if the node is overallocated. |
@@ -182,6 +177,24 @@ The default is 1 percent. | |||
182 | 177 | ||
183 | ============================================================= | 178 | ============================================================= |
184 | 179 | ||
180 | min_slab_ratio: | ||
181 | |||
182 | This is available only on NUMA kernels. | ||
183 | |||
184 | A percentage of the total pages in each zone. On Zone reclaim | ||
185 | (fallback from the local zone occurs) slabs will be reclaimed if more | ||
186 | than this percentage of pages in a zone are reclaimable slab pages. | ||
187 | This insures that the slab growth stays under control even in NUMA | ||
188 | systems that rarely perform global reclaim. | ||
189 | |||
190 | The default is 5 percent. | ||
191 | |||
192 | Note that slab reclaim is triggered in a per zone / node fashion. | ||
193 | The process of reclaiming slab memory is currently not node specific | ||
194 | and may not be fast. | ||
195 | |||
196 | ============================================================= | ||
197 | |||
185 | panic_on_oom | 198 | panic_on_oom |
186 | 199 | ||
187 | This enables or disables panic on out-of-memory feature. If this is set to 1, | 200 | This enables or disables panic on out-of-memory feature. If this is set to 1, |
diff --git a/Documentation/usb/error-codes.txt b/Documentation/usb/error-codes.txt index 867f4c38f356..39c68f8c4e6c 100644 --- a/Documentation/usb/error-codes.txt +++ b/Documentation/usb/error-codes.txt | |||
@@ -98,13 +98,13 @@ one or more packets could finish before an error stops further endpoint I/O. | |||
98 | error, a failure to respond (often caused by | 98 | error, a failure to respond (often caused by |
99 | device disconnect), or some other fault. | 99 | device disconnect), or some other fault. |
100 | 100 | ||
101 | -ETIMEDOUT (**) No response packet received within the prescribed | 101 | -ETIME (**) No response packet received within the prescribed |
102 | bus turn-around time. This error may instead be | 102 | bus turn-around time. This error may instead be |
103 | reported as -EPROTO or -EILSEQ. | 103 | reported as -EPROTO or -EILSEQ. |
104 | 104 | ||
105 | Note that the synchronous USB message functions | 105 | -ETIMEDOUT Synchronous USB message functions use this code |
106 | also use this code to indicate timeout expired | 106 | to indicate timeout expired before the transfer |
107 | before the transfer completed. | 107 | completed, and no other error was reported by HC. |
108 | 108 | ||
109 | -EPIPE (**) Endpoint stalled. For non-control endpoints, | 109 | -EPIPE (**) Endpoint stalled. For non-control endpoints, |
110 | reset this status with usb_clear_halt(). | 110 | reset this status with usb_clear_halt(). |
@@ -163,6 +163,3 @@ usb_get_*/usb_set_*(): | |||
163 | usb_control_msg(): | 163 | usb_control_msg(): |
164 | usb_bulk_msg(): | 164 | usb_bulk_msg(): |
165 | -ETIMEDOUT Timeout expired before the transfer completed. | 165 | -ETIMEDOUT Timeout expired before the transfer completed. |
166 | In the future this code may change to -ETIME, | ||
167 | whose definition is a closer match to this sort | ||
168 | of error. | ||
diff --git a/Documentation/usb/usb-serial.txt b/Documentation/usb/usb-serial.txt index 02b0f7beb6d1..a2dee6e6190d 100644 --- a/Documentation/usb/usb-serial.txt +++ b/Documentation/usb/usb-serial.txt | |||
@@ -433,6 +433,11 @@ Options supported: | |||
433 | See http://www.uuhaus.de/linux/palmconnect.html for up-to-date | 433 | See http://www.uuhaus.de/linux/palmconnect.html for up-to-date |
434 | information on this driver. | 434 | information on this driver. |
435 | 435 | ||
436 | AIRcable USB Dongle Bluetooth driver | ||
437 | If there is the cdc_acm driver loaded in the system, you will find that the | ||
438 | cdc_acm claims the device before AIRcable can. This is simply corrected | ||
439 | by unloading both modules and then loading the aircable module before | ||
440 | cdc_acm module | ||
436 | 441 | ||
437 | Generic Serial driver | 442 | Generic Serial driver |
438 | 443 | ||
diff --git a/Documentation/video4linux/CARDLIST.cx88 b/Documentation/video4linux/CARDLIST.cx88 index 00d9a1f2a54c..126e59d935cd 100644 --- a/Documentation/video4linux/CARDLIST.cx88 +++ b/Documentation/video4linux/CARDLIST.cx88 | |||
@@ -7,16 +7,16 @@ | |||
7 | 6 -> AverTV Studio 303 (M126) [1461:000b] | 7 | 6 -> AverTV Studio 303 (M126) [1461:000b] |
8 | 7 -> MSI TV-@nywhere Master [1462:8606] | 8 | 7 -> MSI TV-@nywhere Master [1462:8606] |
9 | 8 -> Leadtek Winfast DV2000 [107d:6620] | 9 | 8 -> Leadtek Winfast DV2000 [107d:6620] |
10 | 9 -> Leadtek PVR 2000 [107d:663b,107d:663C] | 10 | 9 -> Leadtek PVR 2000 [107d:663b,107d:663c,107d:6632] |
11 | 10 -> IODATA GV-VCP3/PCI [10fc:d003] | 11 | 10 -> IODATA GV-VCP3/PCI [10fc:d003] |
12 | 11 -> Prolink PlayTV PVR | 12 | 11 -> Prolink PlayTV PVR |
13 | 12 -> ASUS PVR-416 [1043:4823] | 13 | 12 -> ASUS PVR-416 [1043:4823,1461:c111] |
14 | 13 -> MSI TV-@nywhere | 14 | 13 -> MSI TV-@nywhere |
15 | 14 -> KWorld/VStream XPert DVB-T [17de:08a6] | 15 | 14 -> KWorld/VStream XPert DVB-T [17de:08a6] |
16 | 15 -> DViCO FusionHDTV DVB-T1 [18ac:db00] | 16 | 15 -> DViCO FusionHDTV DVB-T1 [18ac:db00] |
17 | 16 -> KWorld LTV883RF | 17 | 16 -> KWorld LTV883RF |
18 | 17 -> DViCO FusionHDTV 3 Gold-Q [18ac:d810,18ac:d800] | 18 | 17 -> DViCO FusionHDTV 3 Gold-Q [18ac:d810,18ac:d800] |
19 | 18 -> Hauppauge Nova-T DVB-T [0070:9002,0070:9001] | 19 | 18 -> Hauppauge Nova-T DVB-T [0070:9002,0070:9001,0070:9000] |
20 | 19 -> Conexant DVB-T reference design [14f1:0187] | 20 | 19 -> Conexant DVB-T reference design [14f1:0187] |
21 | 20 -> Provideo PV259 [1540:2580] | 21 | 20 -> Provideo PV259 [1540:2580] |
22 | 21 -> DViCO FusionHDTV DVB-T Plus [18ac:db10,18ac:db11] | 22 | 21 -> DViCO FusionHDTV DVB-T Plus [18ac:db10,18ac:db11] |
@@ -41,7 +41,7 @@ | |||
41 | 40 -> Hauppauge WinTV-HVR1100 DVB-T/Hybrid [0070:9400,0070:9402] | 41 | 40 -> Hauppauge WinTV-HVR1100 DVB-T/Hybrid [0070:9400,0070:9402] |
42 | 41 -> Hauppauge WinTV-HVR1100 DVB-T/Hybrid (Low Profile) [0070:9800,0070:9802] | 42 | 41 -> Hauppauge WinTV-HVR1100 DVB-T/Hybrid (Low Profile) [0070:9800,0070:9802] |
43 | 42 -> digitalnow DNTV Live! DVB-T Pro [1822:0025,1822:0019] | 43 | 42 -> digitalnow DNTV Live! DVB-T Pro [1822:0025,1822:0019] |
44 | 43 -> KWorld/VStream XPert DVB-T with cx22702 [17de:08a1] | 44 | 43 -> KWorld/VStream XPert DVB-T with cx22702 [17de:08a1,12ab:2300] |
45 | 44 -> DViCO FusionHDTV DVB-T Dual Digital [18ac:db50,18ac:db54] | 45 | 44 -> DViCO FusionHDTV DVB-T Dual Digital [18ac:db50,18ac:db54] |
46 | 45 -> KWorld HardwareMpegTV XPert [17de:0840] | 46 | 45 -> KWorld HardwareMpegTV XPert [17de:0840] |
47 | 46 -> DViCO FusionHDTV DVB-T Hybrid [18ac:db40,18ac:db44] | 47 | 46 -> DViCO FusionHDTV DVB-T Hybrid [18ac:db40,18ac:db44] |
@@ -51,3 +51,7 @@ | |||
51 | 50 -> NPG Tech Real TV FM Top 10 [14f1:0842] | 51 | 50 -> NPG Tech Real TV FM Top 10 [14f1:0842] |
52 | 51 -> WinFast DTV2000 H [107d:665e] | 52 | 51 -> WinFast DTV2000 H [107d:665e] |
53 | 52 -> Geniatech DVB-S [14f1:0084] | 53 | 52 -> Geniatech DVB-S [14f1:0084] |
54 | 53 -> Hauppauge WinTV-HVR3000 TriMode Analog/DVB-S/DVB-T [0070:1404] | ||
55 | 54 -> Norwood Micro TV Tuner | ||
56 | 55 -> Shenzhen Tungsten Ages Tech TE-DTV-250 / Swann OEM [c180:c980] | ||
57 | 56 -> Hauppauge WinTV-HVR1300 DVB-T/Hybrid MPEG Encoder [0070:9600,0070:9601,0070:9602] | ||
diff --git a/Documentation/video4linux/CARDLIST.saa7134 b/Documentation/video4linux/CARDLIST.saa7134 index 9068b669f5ee..6fb82ac3bef0 100644 --- a/Documentation/video4linux/CARDLIST.saa7134 +++ b/Documentation/video4linux/CARDLIST.saa7134 | |||
@@ -58,7 +58,7 @@ | |||
58 | 57 -> Avermedia AVerTV GO 007 FM [1461:f31f] | 58 | 57 -> Avermedia AVerTV GO 007 FM [1461:f31f] |
59 | 58 -> ADS Tech Instant TV (saa7135) [1421:0350,1421:0351,1421:0370,1421:1370] | 59 | 58 -> ADS Tech Instant TV (saa7135) [1421:0350,1421:0351,1421:0370,1421:1370] |
60 | 59 -> Kworld/Tevion V-Stream Xpert TV PVR7134 | 60 | 59 -> Kworld/Tevion V-Stream Xpert TV PVR7134 |
61 | 60 -> LifeView/Typhoon FlyDVB-T Duo Cardbus [5168:0502,4e42:0502] | 61 | 60 -> LifeView/Typhoon/Genius FlyDVB-T Duo Cardbus [5168:0502,4e42:0502,1489:0502] |
62 | 61 -> Philips TOUGH DVB-T reference design [1131:2004] | 62 | 61 -> Philips TOUGH DVB-T reference design [1131:2004] |
63 | 62 -> Compro VideoMate TV Gold+II | 63 | 62 -> Compro VideoMate TV Gold+II |
64 | 63 -> Kworld Xpert TV PVR7134 | 64 | 63 -> Kworld Xpert TV PVR7134 |
@@ -83,7 +83,7 @@ | |||
83 | 82 -> MSI TV@Anywhere plus [1462:6231] | 83 | 82 -> MSI TV@Anywhere plus [1462:6231] |
84 | 83 -> Terratec Cinergy 250 PCI TV [153b:1160] | 84 | 83 -> Terratec Cinergy 250 PCI TV [153b:1160] |
85 | 84 -> LifeView FlyDVB Trio [5168:0319] | 85 | 84 -> LifeView FlyDVB Trio [5168:0319] |
86 | 85 -> AverTV DVB-T 777 [1461:2c05] | 86 | 85 -> AverTV DVB-T 777 [1461:2c05,1461:2c05] |
87 | 86 -> LifeView FlyDVB-T / Genius VideoWonder DVB-T [5168:0301,1489:0301] | 87 | 86 -> LifeView FlyDVB-T / Genius VideoWonder DVB-T [5168:0301,1489:0301] |
88 | 87 -> ADS Instant TV Duo Cardbus PTV331 [0331:1421] | 88 | 87 -> ADS Instant TV Duo Cardbus PTV331 [0331:1421] |
89 | 88 -> Tevion/KWorld DVB-T 220RF [17de:7201] | 89 | 88 -> Tevion/KWorld DVB-T 220RF [17de:7201] |
@@ -94,3 +94,7 @@ | |||
94 | 93 -> Medion 7134 Bridge #2 [16be:0005] | 94 | 93 -> Medion 7134 Bridge #2 [16be:0005] |
95 | 94 -> LifeView FlyDVB-T Hybrid Cardbus [5168:3306,5168:3502] | 95 | 94 -> LifeView FlyDVB-T Hybrid Cardbus [5168:3306,5168:3502] |
96 | 95 -> LifeView FlyVIDEO3000 (NTSC) [5169:0138] | 96 | 95 -> LifeView FlyVIDEO3000 (NTSC) [5169:0138] |
97 | 96 -> Medion Md8800 Quadro [16be:0007,16be:0008] | ||
98 | 97 -> LifeView FlyDVB-S /Acorp TV134DS [5168:0300,4e42:0300] | ||
99 | 98 -> Proteus Pro 2309 [0919:2003] | ||
100 | 99 -> AVerMedia TV Hybrid A16AR [1461:2c00] | ||
diff --git a/Documentation/video4linux/bttv/Insmod-options b/Documentation/video4linux/bttv/Insmod-options index fc94ff235ffa..bb7c2cac7917 100644 --- a/Documentation/video4linux/bttv/Insmod-options +++ b/Documentation/video4linux/bttv/Insmod-options | |||
@@ -54,6 +54,12 @@ bttv.o | |||
54 | dropouts. | 54 | dropouts. |
55 | chroma_agc=0/1 AGC of chroma signal, off by default. | 55 | chroma_agc=0/1 AGC of chroma signal, off by default. |
56 | adc_crush=0/1 Luminance ADC crush, on by default. | 56 | adc_crush=0/1 Luminance ADC crush, on by default. |
57 | i2c_udelay= Allow reduce I2C speed. Default is 5 usecs | ||
58 | (meaning 66,67 Kbps). The default is the | ||
59 | maximum supported speed by kernel bitbang | ||
60 | algoritm. You may use lower numbers, if I2C | ||
61 | messages are lost (16 is known to work on | ||
62 | all supported cards). | ||
57 | 63 | ||
58 | bttv_gpio=0/1 | 64 | bttv_gpio=0/1 |
59 | gpiomask= | 65 | gpiomask= |
diff --git a/Documentation/video4linux/cx2341x/README.hm12 b/Documentation/video4linux/cx2341x/README.hm12 new file mode 100644 index 000000000000..0e213ed095e6 --- /dev/null +++ b/Documentation/video4linux/cx2341x/README.hm12 | |||
@@ -0,0 +1,116 @@ | |||
1 | The cx23416 can produce (and the cx23415 can also read) raw YUV output. The | ||
2 | format of a YUV frame is specific to this chip and is called HM12. 'HM' stands | ||
3 | for 'Hauppauge Macroblock', which is a misnomer as 'Conexant Macroblock' would | ||
4 | be more accurate. | ||
5 | |||
6 | The format is YUV 4:2:0 which uses 1 Y byte per pixel and 1 U and V byte per | ||
7 | four pixels. | ||
8 | |||
9 | The data is encoded as two macroblock planes, the first containing the Y | ||
10 | values, the second containing UV macroblocks. | ||
11 | |||
12 | The Y plane is divided into blocks of 16x16 pixels from left to right | ||
13 | and from top to bottom. Each block is transmitted in turn, line-by-line. | ||
14 | |||
15 | So the first 16 bytes are the first line of the top-left block, the | ||
16 | second 16 bytes are the second line of the top-left block, etc. After | ||
17 | transmitting this block the first line of the block on the right to the | ||
18 | first block is transmitted, etc. | ||
19 | |||
20 | The UV plane is divided into blocks of 16x8 UV values going from left | ||
21 | to right, top to bottom. Each block is transmitted in turn, line-by-line. | ||
22 | |||
23 | So the first 16 bytes are the first line of the top-left block and | ||
24 | contain 8 UV value pairs (16 bytes in total). The second 16 bytes are the | ||
25 | second line of 8 UV pairs of the top-left block, etc. After transmitting | ||
26 | this block the first line of the block on the right to the first block is | ||
27 | transmitted, etc. | ||
28 | |||
29 | The code below is given as an example on how to convert HM12 to separate | ||
30 | Y, U and V planes. This code assumes frames of 720x576 (PAL) pixels. | ||
31 | |||
32 | The width of a frame is always 720 pixels, regardless of the actual specified | ||
33 | width. | ||
34 | |||
35 | -------------------------------------------------------------------------- | ||
36 | |||
37 | #include <stdio.h> | ||
38 | #include <stdlib.h> | ||
39 | #include <string.h> | ||
40 | |||
41 | static unsigned char frame[576*720*3/2]; | ||
42 | static unsigned char framey[576*720]; | ||
43 | static unsigned char frameu[576*720 / 4]; | ||
44 | static unsigned char framev[576*720 / 4]; | ||
45 | |||
46 | static void de_macro_y(unsigned char* dst, unsigned char *src, int dstride, int w, int h) | ||
47 | { | ||
48 | unsigned int y, x, i; | ||
49 | |||
50 | // descramble Y plane | ||
51 | // dstride = 720 = w | ||
52 | // The Y plane is divided into blocks of 16x16 pixels | ||
53 | // Each block in transmitted in turn, line-by-line. | ||
54 | for (y = 0; y < h; y += 16) { | ||
55 | for (x = 0; x < w; x += 16) { | ||
56 | for (i = 0; i < 16; i++) { | ||
57 | memcpy(dst + x + (y + i) * dstride, src, 16); | ||
58 | src += 16; | ||
59 | } | ||
60 | } | ||
61 | } | ||
62 | } | ||
63 | |||
64 | static void de_macro_uv(unsigned char *dstu, unsigned char *dstv, unsigned char *src, int dstride, int w, int h) | ||
65 | { | ||
66 | unsigned int y, x, i; | ||
67 | |||
68 | // descramble U/V plane | ||
69 | // dstride = 720 / 2 = w | ||
70 | // The U/V values are interlaced (UVUV...). | ||
71 | // Again, the UV plane is divided into blocks of 16x16 UV values. | ||
72 | // Each block in transmitted in turn, line-by-line. | ||
73 | for (y = 0; y < h; y += 16) { | ||
74 | for (x = 0; x < w; x += 8) { | ||
75 | for (i = 0; i < 16; i++) { | ||
76 | int idx = x + (y + i) * dstride; | ||
77 | |||
78 | dstu[idx+0] = src[0]; dstv[idx+0] = src[1]; | ||
79 | dstu[idx+1] = src[2]; dstv[idx+1] = src[3]; | ||
80 | dstu[idx+2] = src[4]; dstv[idx+2] = src[5]; | ||
81 | dstu[idx+3] = src[6]; dstv[idx+3] = src[7]; | ||
82 | dstu[idx+4] = src[8]; dstv[idx+4] = src[9]; | ||
83 | dstu[idx+5] = src[10]; dstv[idx+5] = src[11]; | ||
84 | dstu[idx+6] = src[12]; dstv[idx+6] = src[13]; | ||
85 | dstu[idx+7] = src[14]; dstv[idx+7] = src[15]; | ||
86 | src += 16; | ||
87 | } | ||
88 | } | ||
89 | } | ||
90 | } | ||
91 | |||
92 | /*************************************************************************/ | ||
93 | int main(int argc, char **argv) | ||
94 | { | ||
95 | FILE *fin; | ||
96 | int i; | ||
97 | |||
98 | if (argc == 1) fin = stdin; | ||
99 | else fin = fopen(argv[1], "r"); | ||
100 | |||
101 | if (fin == NULL) { | ||
102 | fprintf(stderr, "cannot open input\n"); | ||
103 | exit(-1); | ||
104 | } | ||
105 | while (fread(frame, sizeof(frame), 1, fin) == 1) { | ||
106 | de_macro_y(framey, frame, 720, 720, 576); | ||
107 | de_macro_uv(frameu, framev, frame + 720 * 576, 720 / 2, 720 / 2, 576 / 2); | ||
108 | fwrite(framey, sizeof(framey), 1, stdout); | ||
109 | fwrite(framev, sizeof(framev), 1, stdout); | ||
110 | fwrite(frameu, sizeof(frameu), 1, stdout); | ||
111 | } | ||
112 | fclose(fin); | ||
113 | return 0; | ||
114 | } | ||
115 | |||
116 | -------------------------------------------------------------------------- | ||
diff --git a/Documentation/video4linux/cx2341x/README.vbi b/Documentation/video4linux/cx2341x/README.vbi new file mode 100644 index 000000000000..5807cf156173 --- /dev/null +++ b/Documentation/video4linux/cx2341x/README.vbi | |||
@@ -0,0 +1,45 @@ | |||
1 | |||
2 | Format of embedded V4L2_MPEG_STREAM_VBI_FMT_IVTV VBI data | ||
3 | ========================================================= | ||
4 | |||
5 | This document describes the V4L2_MPEG_STREAM_VBI_FMT_IVTV format of the VBI data | ||
6 | embedded in an MPEG-2 program stream. This format is in part dictated by some | ||
7 | hardware limitations of the ivtv driver (the driver for the Conexant cx23415/6 | ||
8 | chips), in particular a maximum size for the VBI data. Anything longer is cut | ||
9 | off when the MPEG stream is played back through the cx23415. | ||
10 | |||
11 | The advantage of this format is it is very compact and that all VBI data for | ||
12 | all lines can be stored while still fitting within the maximum allowed size. | ||
13 | |||
14 | The stream ID of the VBI data is 0xBD. The maximum size of the embedded data is | ||
15 | 4 + 43 * 36, which is 4 bytes for a header and 2 * 18 VBI lines with a 1 byte | ||
16 | header and a 42 bytes payload each. Anything beyond this limit is cut off by | ||
17 | the cx23415/6 firmware. Besides the data for the VBI lines we also need 36 bits | ||
18 | for a bitmask determining which lines are captured and 4 bytes for a magic cookie, | ||
19 | signifying that this data package contains V4L2_MPEG_STREAM_VBI_FMT_IVTV VBI data. | ||
20 | If all lines are used, then there is no longer room for the bitmask. To solve this | ||
21 | two different magic numbers were introduced: | ||
22 | |||
23 | 'itv0': After this magic number two unsigned longs follow. Bits 0-17 of the first | ||
24 | unsigned long denote which lines of the first field are captured. Bits 18-31 of | ||
25 | the first unsigned long and bits 0-3 of the second unsigned long are used for the | ||
26 | second field. | ||
27 | |||
28 | 'ITV0': This magic number assumes all VBI lines are captured, i.e. it implicitly | ||
29 | implies that the bitmasks are 0xffffffff and 0xf. | ||
30 | |||
31 | After these magic cookies (and the 8 byte bitmask in case of cookie 'itv0') the | ||
32 | captured VBI lines start: | ||
33 | |||
34 | For each line the least significant 4 bits of the first byte contain the data type. | ||
35 | Possible values are shown in the table below. The payload is in the following 42 | ||
36 | bytes. | ||
37 | |||
38 | Here is the list of possible data types: | ||
39 | |||
40 | #define IVTV_SLICED_TYPE_TELETEXT 0x1 // Teletext (uses lines 6-22 for PAL) | ||
41 | #define IVTV_SLICED_TYPE_CC 0x4 // Closed Captions (line 21 NTSC) | ||
42 | #define IVTV_SLICED_TYPE_WSS 0x5 // Wide Screen Signal (line 23 PAL) | ||
43 | #define IVTV_SLICED_TYPE_VPS 0x7 // Video Programming System (PAL) (line 16) | ||
44 | |||
45 | Hans Verkuil <hverkuil@xs4all.nl> | ||
diff --git a/Documentation/x86_64/boot-options.txt b/Documentation/x86_64/boot-options.txt index 6da24e7a56cb..74b77f9e91bc 100644 --- a/Documentation/x86_64/boot-options.txt +++ b/Documentation/x86_64/boot-options.txt | |||
@@ -199,6 +199,11 @@ IOMMU | |||
199 | allowed overwrite iommu off workarounds for specific chipsets. | 199 | allowed overwrite iommu off workarounds for specific chipsets. |
200 | soft Use software bounce buffering (default for Intel machines) | 200 | soft Use software bounce buffering (default for Intel machines) |
201 | noaperture Don't touch the aperture for AGP. | 201 | noaperture Don't touch the aperture for AGP. |
202 | allowdac Allow DMA >4GB | ||
203 | When off all DMA over >4GB is forced through an IOMMU or bounce | ||
204 | buffering. | ||
205 | nodac Forbid DMA >4GB | ||
206 | panic Always panic when IOMMU overflows | ||
202 | 207 | ||
203 | swiotlb=pages[,force] | 208 | swiotlb=pages[,force] |
204 | 209 | ||
@@ -245,6 +250,13 @@ Debugging | |||
245 | newfallback: use new unwinder but fall back to old if it gets | 250 | newfallback: use new unwinder but fall back to old if it gets |
246 | stuck (default) | 251 | stuck (default) |
247 | 252 | ||
253 | call_trace=[old|both|newfallback|new] | ||
254 | old: use old inexact backtracer | ||
255 | new: use new exact dwarf2 unwinder | ||
256 | both: print entries from both | ||
257 | newfallback: use new unwinder but fall back to old if it gets | ||
258 | stuck (default) | ||
259 | |||
248 | Misc | 260 | Misc |
249 | 261 | ||
250 | noreplacement Don't replace instructions with more appropriate ones | 262 | noreplacement Don't replace instructions with more appropriate ones |
diff --git a/Documentation/x86_64/kernel-stacks b/Documentation/x86_64/kernel-stacks new file mode 100644 index 000000000000..bddfddd466ab --- /dev/null +++ b/Documentation/x86_64/kernel-stacks | |||
@@ -0,0 +1,99 @@ | |||
1 | Most of the text from Keith Owens, hacked by AK | ||
2 | |||
3 | x86_64 page size (PAGE_SIZE) is 4K. | ||
4 | |||
5 | Like all other architectures, x86_64 has a kernel stack for every | ||
6 | active thread. These thread stacks are THREAD_SIZE (2*PAGE_SIZE) big. | ||
7 | These stacks contain useful data as long as a thread is alive or a | ||
8 | zombie. While the thread is in user space the kernel stack is empty | ||
9 | except for the thread_info structure at the bottom. | ||
10 | |||
11 | In addition to the per thread stacks, there are specialized stacks | ||
12 | associated with each cpu. These stacks are only used while the kernel | ||
13 | is in control on that cpu, when a cpu returns to user space the | ||
14 | specialized stacks contain no useful data. The main cpu stacks is | ||
15 | |||
16 | * Interrupt stack. IRQSTACKSIZE | ||
17 | |||
18 | Used for external hardware interrupts. If this is the first external | ||
19 | hardware interrupt (i.e. not a nested hardware interrupt) then the | ||
20 | kernel switches from the current task to the interrupt stack. Like | ||
21 | the split thread and interrupt stacks on i386 (with CONFIG_4KSTACKS), | ||
22 | this gives more room for kernel interrupt processing without having | ||
23 | to increase the size of every per thread stack. | ||
24 | |||
25 | The interrupt stack is also used when processing a softirq. | ||
26 | |||
27 | Switching to the kernel interrupt stack is done by software based on a | ||
28 | per CPU interrupt nest counter. This is needed because x86-64 "IST" | ||
29 | hardware stacks cannot nest without races. | ||
30 | |||
31 | x86_64 also has a feature which is not available on i386, the ability | ||
32 | to automatically switch to a new stack for designated events such as | ||
33 | double fault or NMI, which makes it easier to handle these unusual | ||
34 | events on x86_64. This feature is called the Interrupt Stack Table | ||
35 | (IST). There can be up to 7 IST entries per cpu. The IST code is an | ||
36 | index into the Task State Segment (TSS), the IST entries in the TSS | ||
37 | point to dedicated stacks, each stack can be a different size. | ||
38 | |||
39 | An IST is selected by an non-zero value in the IST field of an | ||
40 | interrupt-gate descriptor. When an interrupt occurs and the hardware | ||
41 | loads such a descriptor, the hardware automatically sets the new stack | ||
42 | pointer based on the IST value, then invokes the interrupt handler. If | ||
43 | software wants to allow nested IST interrupts then the handler must | ||
44 | adjust the IST values on entry to and exit from the interrupt handler. | ||
45 | (this is occasionally done, e.g. for debug exceptions) | ||
46 | |||
47 | Events with different IST codes (i.e. with different stacks) can be | ||
48 | nested. For example, a debug interrupt can safely be interrupted by an | ||
49 | NMI. arch/x86_64/kernel/entry.S::paranoidentry adjusts the stack | ||
50 | pointers on entry to and exit from all IST events, in theory allowing | ||
51 | IST events with the same code to be nested. However in most cases, the | ||
52 | stack size allocated to an IST assumes no nesting for the same code. | ||
53 | If that assumption is ever broken then the stacks will become corrupt. | ||
54 | |||
55 | The currently assigned IST stacks are :- | ||
56 | |||
57 | * STACKFAULT_STACK. EXCEPTION_STKSZ (PAGE_SIZE). | ||
58 | |||
59 | Used for interrupt 12 - Stack Fault Exception (#SS). | ||
60 | |||
61 | This allows to recover from invalid stack segments. Rarely | ||
62 | happens. | ||
63 | |||
64 | * DOUBLEFAULT_STACK. EXCEPTION_STKSZ (PAGE_SIZE). | ||
65 | |||
66 | Used for interrupt 8 - Double Fault Exception (#DF). | ||
67 | |||
68 | Invoked when handling a exception causes another exception. Happens | ||
69 | when the kernel is very confused (e.g. kernel stack pointer corrupt) | ||
70 | Using a separate stack allows to recover from it well enough in many | ||
71 | cases to still output an oops. | ||
72 | |||
73 | * NMI_STACK. EXCEPTION_STKSZ (PAGE_SIZE). | ||
74 | |||
75 | Used for non-maskable interrupts (NMI). | ||
76 | |||
77 | NMI can be delivered at any time, including when the kernel is in the | ||
78 | middle of switching stacks. Using IST for NMI events avoids making | ||
79 | assumptions about the previous state of the kernel stack. | ||
80 | |||
81 | * DEBUG_STACK. DEBUG_STKSZ | ||
82 | |||
83 | Used for hardware debug interrupts (interrupt 1) and for software | ||
84 | debug interrupts (INT3). | ||
85 | |||
86 | When debugging a kernel, debug interrupts (both hardware and | ||
87 | software) can occur at any time. Using IST for these interrupts | ||
88 | avoids making assumptions about the previous state of the kernel | ||
89 | stack. | ||
90 | |||
91 | * MCE_STACK. EXCEPTION_STKSZ (PAGE_SIZE). | ||
92 | |||
93 | Used for interrupt 18 - Machine Check Exception (#MC). | ||
94 | |||
95 | MCE can be delivered at any time, including when the kernel is in the | ||
96 | middle of switching stacks. Using IST for MCE events avoids making | ||
97 | assumptions about the previous state of the kernel stack. | ||
98 | |||
99 | For more details see the Intel IA32 or AMD AMD64 architecture manuals. | ||