redonkable
/
remarkable-linux
1
0
Fork 0
Code Releases Activity

debugging-via-ohci1394.txt: standardize document format 

Each text file under Documentation follows a different
format. Some doesn't even have titles!

Change its representation to follow the adopted standard,
using ReST markups for it to be parseable by Sphinx:

- Mark and adjust titles;
- Mark and indent literal blocks.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
zero-colors
Mauro Carvalho Chehab 2017-05-17 10:29:58 -03:00 committed by Jonathan Corbet
parent 5d75cf6d37
commit 7c6a2d229d
1 changed files with 11 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
Documentation/debugging-via-ohci1394.txt
View File

@ -1,6 +1,6 @@
===========================================================================
Using physical DMA provided by OHCI-1394 FireWire controllers for debugging Using physical DMA provided by OHCI-1394 FireWire controllers for debugging
--------------------------------------------------------------------------- ===========================================================================
Introduction Introduction
------------ ------------
@ -91,10 +91,10 @@ Step-by-step instructions for using firescope with early OHCI initialization:
1) Verify that your hardware is supported: 1) Verify that your hardware is supported:
Load the firewire-ohci module and check your kernel logs. Load the firewire-ohci module and check your kernel logs.
You should see a line similar to You should see a line similar to::
firewire_ohci 0000:15:00.1: added OHCI v1.0 device as card 2, 4 IR + 4 IT firewire_ohci 0000:15:00.1: added OHCI v1.0 device as card 2, 4 IR + 4 IT
... contexts, quirks 0x11 ... contexts, quirks 0x11
when loading the driver. If you have no supported controller, many PCI, when loading the driver. If you have no supported controller, many PCI,
CardBus and even some Express cards which are fully compliant to OHCI-1394 CardBus and even some Express cards which are fully compliant to OHCI-1394
@ -113,9 +113,9 @@ Step-by-step instructions for using firescope with early OHCI initialization:
stable connection and has matching connectors (there are small 4-pin and stable connection and has matching connectors (there are small 4-pin and
large 6-pin FireWire ports) will do. large 6-pin FireWire ports) will do.
If an driver is running on both machines you should see a line like If an driver is running on both machines you should see a line like::
firewire_core 0000:15:00.1: created device fw1: GUID 00061b0020105917, S400 firewire_core 0000:15:00.1: created device fw1: GUID 00061b0020105917, S400
on both machines in the kernel log when the cable is plugged in on both machines in the kernel log when the cable is plugged in
and connects the two machines. and connects the two machines.
@ -123,7 +123,7 @@ Step-by-step instructions for using firescope with early OHCI initialization:
3) Test physical DMA using firescope: 3) Test physical DMA using firescope:
On the debug host, make sure that /dev/fw* is accessible, On the debug host, make sure that /dev/fw* is accessible,
then start firescope: then start firescope::
$ firescope $ firescope
Port 0 (/dev/fw1) opened, 2 nodes detected Port 0 (/dev/fw1) opened, 2 nodes detected
@ -163,7 +163,7 @@ Step-by-step instructions for using firescope with early OHCI initialization:
host loaded, reboot the debugged machine, booting the kernel which has host loaded, reboot the debugged machine, booting the kernel which has
CONFIG_PROVIDE_OHCI1394_DMA_INIT enabled, with the option ohci1394_dma=early. CONFIG_PROVIDE_OHCI1394_DMA_INIT enabled, with the option ohci1394_dma=early.
Then, on the debugging host, run firescope, for example by using -A: Then, on the debugging host, run firescope, for example by using -A::
firescope -A System.map-of-debug-target-kernel firescope -A System.map-of-debug-target-kernel
@ -178,6 +178,7 @@ Step-by-step instructions for using firescope with early OHCI initialization:
Notes Notes
----- -----
Documentation and specifications: http://halobates.de/firewire/ Documentation and specifications: http://halobates.de/firewire/
FireWire is a trademark of Apple Inc. - for more information please refer to: FireWire is a trademark of Apple Inc. - for more information please refer to: