Commit 7c6a2d22 authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab Committed by Jonathan Corbet
Browse files

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: default avatarMauro Carvalho Chehab <mchehab@s-opensource.com>
Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
parent 5d75cf6d

Documentation/debugging-via-ohci1394.txt

+11 −10
Original line number Diff line number Diff line 


===========================================================================

Using physical DMA provided by OHCI-1394 FireWire controllers for debugging

  ---------------------------------------------------------------------------

===========================================================================



Introduction

------------
@@ -91,7 +91,7 @@ Step-by-step instructions for using firescope with early OHCI initialization: 
1) Verify that your hardware is supported:



   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

     ... contexts, quirks 0x11
@@ -113,7 +113,7 @@ Step-by-step instructions for using firescope with early OHCI initialization: 
   stable connection and has matching connectors (there are small 4-pin and

   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
@@ -123,7 +123,7 @@ Step-by-step instructions for using firescope with early OHCI initialization: 
3) Test physical DMA using firescope:



   On the debug host, make sure that /dev/fw* is accessible,

   then start firescope:

   then start firescope::



	$ firescope

	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

   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
@@ -178,6 +178,7 @@ Step-by-step instructions for using firescope with early OHCI initialization: 


Notes

-----



Documentation and specifications: http://halobates.de/firewire/



FireWire is a trademark of Apple Inc. - for more information please refer to:

CRA Git | Maintained and supported by SUSTech CRA and CCSE