aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation
diff options
context:
space:
mode:
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/DocBook/kernel-api.tmpl8
-rw-r--r--Documentation/debugging-via-ohci1394.txt179
-rw-r--r--Documentation/kernel-parameters.txt51
-rw-r--r--Documentation/x86_64/boot-options.txt8
-rw-r--r--Documentation/x86_64/uefi.txt9
5 files changed, 251 insertions, 4 deletions
diff --git a/Documentation/DocBook/kernel-api.tmpl b/Documentation/DocBook/kernel-api.tmpl
index aa38cc5692a0..77436d735013 100644
--- a/Documentation/DocBook/kernel-api.tmpl
+++ b/Documentation/DocBook/kernel-api.tmpl
@@ -419,7 +419,13 @@ X!Edrivers/pnp/system.c
419 419
420 <chapter id="blkdev"> 420 <chapter id="blkdev">
421 <title>Block Devices</title> 421 <title>Block Devices</title>
422!Eblock/ll_rw_blk.c 422!Eblock/blk-core.c
423!Eblock/blk-map.c
424!Iblock/blk-sysfs.c
425!Eblock/blk-settings.c
426!Eblock/blk-exec.c
427!Eblock/blk-barrier.c
428!Eblock/blk-tag.c
423 </chapter> 429 </chapter>
424 430
425 <chapter id="chrdev"> 431 <chapter id="chrdev">
diff --git a/Documentation/debugging-via-ohci1394.txt b/Documentation/debugging-via-ohci1394.txt
new file mode 100644
index 000000000000..de4804e8b396
--- /dev/null
+++ b/Documentation/debugging-via-ohci1394.txt
@@ -0,0 +1,179 @@
1
2 Using physical DMA provided by OHCI-1394 FireWire controllers for debugging
3 ---------------------------------------------------------------------------
4
5Introduction
6------------
7
8Basically all FireWire controllers which are in use today are compliant
9to the OHCI-1394 specification which defines the controller to be a PCI
10bus master which uses DMA to offload data transfers from the CPU and has
11a "Physical Response Unit" which executes specific requests by employing
12PCI-Bus master DMA after applying filters defined by the OHCI-1394 driver.
13
14Once properly configured, remote machines can send these requests to
15ask the OHCI-1394 controller to perform read and write requests on
16physical system memory and, for read requests, send the result of
17the physical memory read back to the requester.
18
19With that, it is possible to debug issues by reading interesting memory
20locations such as buffers like the printk buffer or the process table.
21
22Retrieving a full system memory dump is also possible over the FireWire,
23using data transfer rates in the order of 10MB/s or more.
24
25Memory access is currently limited to the low 4G of physical address
26space which can be a problem on IA64 machines where memory is located
27mostly above that limit, but it is rarely a problem on more common
28hardware such as hardware based on x86, x86-64 and PowerPC.
29
30Together with a early initialization of the OHCI-1394 controller for debugging,
31this facility proved most useful for examining long debugs logs in the printk
32buffer on to debug early boot problems in areas like ACPI where the system
33fails to boot and other means for debugging (serial port) are either not
34available (notebooks) or too slow for extensive debug information (like ACPI).
35
36Drivers
37-------
38
39The OHCI-1394 drivers in drivers/firewire and drivers/ieee1394 initialize
40the OHCI-1394 controllers to a working state and can be used to enable
41physical DMA. By default you only have to load the driver, and physical
42DMA access will be granted to all remote nodes, but it can be turned off
43when using the ohci1394 driver.
44
45Because these drivers depend on the PCI enumeration to be completed, an
46initialization routine which can runs pretty early (long before console_init(),
47which makes the printk buffer appear on the console can be called) was written.
48
49To activate it, enable CONFIG_PROVIDE_OHCI1394_DMA_INIT (Kernel hacking menu:
50Provide code for enabling DMA over FireWire early on boot) and pass the
51parameter "ohci1394_dma=early" to the recompiled kernel on boot.
52
53Tools
54-----
55
56firescope - Originally developed by Benjamin Herrenschmidt, Andi Kleen ported
57it from PowerPC to x86 and x86_64 and added functionality, firescope can now
58be used to view the printk buffer of a remote machine, even with live update.
59
60Bernhard Kaindl enhanced firescope to support accessing 64-bit machines
61from 32-bit firescope and vice versa:
62- ftp://ftp.suse.de/private/bk/firewire/tools/firescope-0.2.2.tar.bz2
63
64and he implemented fast system dump (alpha version - read README.txt):
65- ftp://ftp.suse.de/private/bk/firewire/tools/firedump-0.1.tar.bz2
66
67There is also a gdb proxy for firewire which allows to use gdb to access
68data which can be referenced from symbols found by gdb in vmlinux:
69- ftp://ftp.suse.de/private/bk/firewire/tools/fireproxy-0.33.tar.bz2
70
71The latest version of this gdb proxy (fireproxy-0.34) can communicate (not
72yet stable) with kgdb over an memory-based communication module (kgdbom).
73
74Getting Started
75---------------
76
77The OHCI-1394 specification regulates that the OHCI-1394 controller must
78disable all physical DMA on each bus reset.
79
80This means that if you want to debug an issue in a system state where
81interrupts are disabled and where no polling of the OHCI-1394 controller
82for bus resets takes place, you have to establish any FireWire cable
83connections and fully initialize all FireWire hardware __before__ the
84system enters such state.
85
86Step-by-step instructions for using firescope with early OHCI initialization:
87
881) Verify that your hardware is supported:
89
90 Load the ohci1394 or the fw-ohci module and check your kernel logs.
91 You should see a line similar to
92
93 ohci1394: fw-host0: OHCI-1394 1.1 (PCI): IRQ=[18] MMIO=[fe9ff800-fe9fffff]
94 ... Max Packet=[2048] IR/IT contexts=[4/8]
95
96 when loading the driver. If you have no supported controller, many PCI,
97 CardBus and even some Express cards which are fully compliant to OHCI-1394
98 specification are available. If it requires no driver for Windows operating
99 systems, it most likely is. Only specialized shops have cards which are not
100 compliant, they are based on TI PCILynx chips and require drivers for Win-
101 dows operating systems.
102
1032) Establish a working FireWire cable connection:
104
105 Any FireWire cable, as long at it provides electrically and mechanically
106 stable connection and has matching connectors (there are small 4-pin and
107 large 6-pin FireWire ports) will do.
108
109 If an driver is running on both machines you should see a line like
110
111 ieee1394: Node added: ID:BUS[0-01:1023] GUID[0090270001b84bba]
112
113 on both machines in the kernel log when the cable is plugged in
114 and connects the two machines.
115
1163) Test physical DMA using firescope:
117
118 On the debug host,
119 - load the raw1394 module,
120 - make sure that /dev/raw1394 is accessible,
121 then start firescope:
122
123 $ firescope
124 Port 0 (ohci1394) opened, 2 nodes detected
125
126 FireScope
127 ---------
128 Target : <unspecified>
129 Gen : 1
130 [Ctrl-T] choose target
131 [Ctrl-H] this menu
132 [Ctrl-Q] quit
133
134 ------> Press Ctrl-T now, the output should be similar to:
135
136 2 nodes available, local node is: 0
137 0: ffc0, uuid: 00000000 00000000 [LOCAL]
138 1: ffc1, uuid: 00279000 ba4bb801
139
140 Besides the [LOCAL] node, it must show another node without error message.
141
1424) Prepare for debugging with early OHCI-1394 initialization:
143
144 4.1) Kernel compilation and installation on debug target
145
146 Compile the kernel to be debugged with CONFIG_PROVIDE_OHCI1394_DMA_INIT
147 (Kernel hacking: Provide code for enabling DMA over FireWire early on boot)
148 enabled and install it on the machine to be debugged (debug target).
149
150 4.2) Transfer the System.map of the debugged kernel to the debug host
151
152 Copy the System.map of the kernel be debugged to the debug host (the host
153 which is connected to the debugged machine over the FireWire cable).
154
1555) Retrieving the printk buffer contents:
156
157 With the FireWire cable connected, the OHCI-1394 driver on the debugging
158 host loaded, reboot the debugged machine, booting the kernel which has
159 CONFIG_PROVIDE_OHCI1394_DMA_INIT enabled, with the option ohci1394_dma=early.
160
161 Then, on the debugging host, run firescope, for example by using -A:
162
163 firescope -A System.map-of-debug-target-kernel
164
165 Note: -A automatically attaches to the first non-local node. It only works
166 reliably if only connected two machines are connected using FireWire.
167
168 After having attached to the debug target, press Ctrl-D to view the
169 complete printk buffer or Ctrl-U to enter auto update mode and get an
170 updated live view of recent kernel messages logged on the debug target.
171
172 Call "firescope -h" to get more information on firescope's options.
173
174Notes
175-----
176Documentation and specifications: ftp://ftp.suse.de/private/bk/firewire/docs
177
178FireWire is a trademark of Apple Inc. - for more information please refer to:
179http://en.wikipedia.org/wiki/FireWire
diff --git a/Documentation/kernel-parameters.txt b/Documentation/kernel-parameters.txt
index 880f882160e2..5d171b7b8393 100644
--- a/Documentation/kernel-parameters.txt
+++ b/Documentation/kernel-parameters.txt
@@ -416,8 +416,21 @@ and is between 256 and 4096 characters. It is defined in the file
416 [SPARC64] tick 416 [SPARC64] tick
417 [X86-64] hpet,tsc 417 [X86-64] hpet,tsc
418 418
419 code_bytes [IA32] How many bytes of object code to print in an 419 clearcpuid=BITNUM [X86]
420 oops report. 420 Disable CPUID feature X for the kernel. See
421 include/asm-x86/cpufeature.h for the valid bit numbers.
422 Note the Linux specific bits are not necessarily
423 stable over kernel options, but the vendor specific
424 ones should be.
425 Also note that user programs calling CPUID directly
426 or using the feature without checking anything
427 will still see it. This just prevents it from
428 being used by the kernel or shown in /proc/cpuinfo.
429 Also note the kernel might malfunction if you disable
430 some critical bits.
431
432 code_bytes [IA32/X86_64] How many bytes of object code to print
433 in an oops report.
421 Range: 0 - 8192 434 Range: 0 - 8192
422 Default: 64 435 Default: 64
423 436
@@ -570,6 +583,12 @@ and is between 256 and 4096 characters. It is defined in the file
570 See drivers/char/README.epca and 583 See drivers/char/README.epca and
571 Documentation/digiepca.txt. 584 Documentation/digiepca.txt.
572 585
586 disable_mtrr_trim [X86, Intel and AMD only]
587 By default the kernel will trim any uncacheable
588 memory out of your available memory pool based on
589 MTRR settings. This parameter disables that behavior,
590 possibly causing your machine to run very slowly.
591
573 dmasound= [HW,OSS] Sound subsystem buffers 592 dmasound= [HW,OSS] Sound subsystem buffers
574 593
575 dscc4.setup= [NET] 594 dscc4.setup= [NET]
@@ -660,6 +679,10 @@ and is between 256 and 4096 characters. It is defined in the file
660 679
661 gamma= [HW,DRM] 680 gamma= [HW,DRM]
662 681
682 gart_fix_e820= [X86_64] disable the fix e820 for K8 GART
683 Format: off | on
684 default: on
685
663 gdth= [HW,SCSI] 686 gdth= [HW,SCSI]
664 See header of drivers/scsi/gdth.c. 687 See header of drivers/scsi/gdth.c.
665 688
@@ -794,6 +817,16 @@ and is between 256 and 4096 characters. It is defined in the file
794 for translation below 32 bit and if not available 817 for translation below 32 bit and if not available
795 then look in the higher range. 818 then look in the higher range.
796 819
820 io_delay= [X86-32,X86-64] I/O delay method
821 0x80
822 Standard port 0x80 based delay
823 0xed
824 Alternate port 0xed based delay (needed on some systems)
825 udelay
826 Simple two microseconds delay
827 none
828 No delay
829
797 io7= [HW] IO7 for Marvel based alpha systems 830 io7= [HW] IO7 for Marvel based alpha systems
798 See comment before marvel_specify_io7 in 831 See comment before marvel_specify_io7 in
799 arch/alpha/kernel/core_marvel.c. 832 arch/alpha/kernel/core_marvel.c.
@@ -1059,6 +1092,11 @@ and is between 256 and 4096 characters. It is defined in the file
1059 Multi-Function General Purpose Timers on AMD Geode 1092 Multi-Function General Purpose Timers on AMD Geode
1060 platforms. 1093 platforms.
1061 1094
1095 mfgptfix [X86-32] Fix MFGPT timers on AMD Geode platforms when
1096 the BIOS has incorrectly applied a workaround. TinyBIOS
1097 version 0.98 is known to be affected, 0.99 fixes the
1098 problem by letting the user disable the workaround.
1099
1062 mga= [HW,DRM] 1100 mga= [HW,DRM]
1063 1101
1064 mousedev.tap_time= 1102 mousedev.tap_time=
@@ -1159,6 +1197,8 @@ and is between 256 and 4096 characters. It is defined in the file
1159 1197
1160 nodisconnect [HW,SCSI,M68K] Disables SCSI disconnects. 1198 nodisconnect [HW,SCSI,M68K] Disables SCSI disconnects.
1161 1199
1200 noefi [X86-32,X86-64] Disable EFI runtime services support.
1201
1162 noexec [IA-64] 1202 noexec [IA-64]
1163 1203
1164 noexec [X86-32,X86-64] 1204 noexec [X86-32,X86-64]
@@ -1169,6 +1209,8 @@ and is between 256 and 4096 characters. It is defined in the file
1169 register save and restore. The kernel will only save 1209 register save and restore. The kernel will only save
1170 legacy floating-point registers on task switch. 1210 legacy floating-point registers on task switch.
1171 1211
1212 noclflush [BUGS=X86] Don't use the CLFLUSH instruction
1213
1172 nohlt [BUGS=ARM] 1214 nohlt [BUGS=ARM]
1173 1215
1174 no-hlt [BUGS=X86-32] Tells the kernel that the hlt 1216 no-hlt [BUGS=X86-32] Tells the kernel that the hlt
@@ -1978,6 +2020,11 @@ and is between 256 and 4096 characters. It is defined in the file
1978 vdso=1: enable VDSO (default) 2020 vdso=1: enable VDSO (default)
1979 vdso=0: disable VDSO mapping 2021 vdso=0: disable VDSO mapping
1980 2022
2023 vdso32= [X86-32,X86-64]
2024 vdso32=2: enable compat VDSO (default with COMPAT_VDSO)
2025 vdso32=1: enable 32-bit VDSO (default)
2026 vdso32=0: disable 32-bit VDSO mapping
2027
1981 vector= [IA-64,SMP] 2028 vector= [IA-64,SMP]
1982 vector=percpu: enable percpu vector domain 2029 vector=percpu: enable percpu vector domain
1983 2030
diff --git a/Documentation/x86_64/boot-options.txt b/Documentation/x86_64/boot-options.txt
index 945311840a10..34abae4e9442 100644
--- a/Documentation/x86_64/boot-options.txt
+++ b/Documentation/x86_64/boot-options.txt
@@ -110,12 +110,18 @@ Idle loop
110 110
111Rebooting 111Rebooting
112 112
113 reboot=b[ios] | t[riple] | k[bd] [, [w]arm | [c]old] 113 reboot=b[ios] | t[riple] | k[bd] | a[cpi] | e[fi] [, [w]arm | [c]old]
114 bios Use the CPU reboot vector for warm reset 114 bios Use the CPU reboot vector for warm reset
115 warm Don't set the cold reboot flag 115 warm Don't set the cold reboot flag
116 cold Set the cold reboot flag 116 cold Set the cold reboot flag
117 triple Force a triple fault (init) 117 triple Force a triple fault (init)
118 kbd Use the keyboard controller. cold reset (default) 118 kbd Use the keyboard controller. cold reset (default)
119 acpi Use the ACPI RESET_REG in the FADT. If ACPI is not configured or the
120 ACPI reset does not work, the reboot path attempts the reset using
121 the keyboard controller.
122 efi Use efi reset_system runtime service. If EFI is not configured or the
123 EFI reset does not work, the reboot path attempts the reset using
124 the keyboard controller.
119 125
120 Using warm reset will be much faster especially on big memory 126 Using warm reset will be much faster especially on big memory
121 systems because the BIOS will not go through the memory check. 127 systems because the BIOS will not go through the memory check.
diff --git a/Documentation/x86_64/uefi.txt b/Documentation/x86_64/uefi.txt
index 91a98edfb588..7d77120a5184 100644
--- a/Documentation/x86_64/uefi.txt
+++ b/Documentation/x86_64/uefi.txt
@@ -19,6 +19,10 @@ Mechanics:
19- Build the kernel with the following configuration. 19- Build the kernel with the following configuration.
20 CONFIG_FB_EFI=y 20 CONFIG_FB_EFI=y
21 CONFIG_FRAMEBUFFER_CONSOLE=y 21 CONFIG_FRAMEBUFFER_CONSOLE=y
22 If EFI runtime services are expected, the following configuration should
23 be selected.
24 CONFIG_EFI=y
25 CONFIG_EFI_VARS=y or m # optional
22- Create a VFAT partition on the disk 26- Create a VFAT partition on the disk
23- Copy the following to the VFAT partition: 27- Copy the following to the VFAT partition:
24 elilo bootloader with x86_64 support, elilo configuration file, 28 elilo bootloader with x86_64 support, elilo configuration file,
@@ -27,3 +31,8 @@ Mechanics:
27 can be found in the elilo sourceforge project. 31 can be found in the elilo sourceforge project.
28- Boot to EFI shell and invoke elilo choosing the kernel image built 32- Boot to EFI shell and invoke elilo choosing the kernel image built
29 in first step. 33 in first step.
34- If some or all EFI runtime services don't work, you can try following
35 kernel command line parameters to turn off some or all EFI runtime
36 services.
37 noefi turn off all EFI runtime services
38 reboot_type=k turn off EFI reboot runtime service