From 6095c1e90fbeb08e08e3560395a646bd62c452a9 Mon Sep 17 00:00:00 2001 From: Randolph Sapp Date: Sun, 15 Dec 2024 12:41:57 -0600 Subject: [PATCH] fix: all possible title underline warnings Address all the current possible title underline warnings. Signed-off-by: Randolph Sapp --- .../_OMAPL138-C6748_LCDK_Hardware_Setup.rst | 2 + ...ase_Specific_Yocto_layer_Configuration.rst | 1 + .../Application_Demos/Video_Graphics_Test.rst | 1 + .../Kernel/Kernel_Drivers/Camera/CAL.rst | 3 ++ .../Kernel_Drivers/Network/CPSW-PTP.rst | 1 + .../Kernel/Kernel_Drivers/Network/NetCP.rst | 1 + .../linux/Foundational_Components_IPC64x.rst | 47 +++++++++---------- .../HSR_PRP/_HSR_PRP_for_Linux.rst | 2 + .../linux/Industrial_Protocols/PTP/_PTP.rst | 7 +++ source/linux/Industrial_Protocols/_SORTE.rst | 2 + source/linux/Industrial_Protocols_HSR_PRP.rst | 3 ++ 11 files changed, 46 insertions(+), 24 deletions(-) diff --git a/source/common/EVM_Hardware_Setup/_OMAPL138-C6748_LCDK_Hardware_Setup.rst b/source/common/EVM_Hardware_Setup/_OMAPL138-C6748_LCDK_Hardware_Setup.rst index 9b28cdeb7..6d91a60ef 100644 --- a/source/common/EVM_Hardware_Setup/_OMAPL138-C6748_LCDK_Hardware_Setup.rst +++ b/source/common/EVM_Hardware_Setup/_OMAPL138-C6748_LCDK_Hardware_Setup.rst @@ -111,6 +111,7 @@ Connecting to Target and Loading/Running Program The following GEL outputs should appear in the CCS Console view. **OMAP-L138 LCDK:** + :: ARM9_0: Output: Target Connected. @@ -131,6 +132,7 @@ The following GEL outputs should appear in the CCS Console view. ARM9_0: Output: --------------------------------------------- **C6748 LCDK:** + :: C674X_0: Output: Target Connected. diff --git a/source/devices/J7_Family/linux/Release_Specific_Yocto_layer_Configuration.rst b/source/devices/J7_Family/linux/Release_Specific_Yocto_layer_Configuration.rst index d25ea064a..eff96a8f5 100644 --- a/source/devices/J7_Family/linux/Release_Specific_Yocto_layer_Configuration.rst +++ b/source/devices/J7_Family/linux/Release_Specific_Yocto_layer_Configuration.rst @@ -27,6 +27,7 @@ Yocto Layer Configuration ./oe-layertool-setup.sh -f configs/processor-sdk-linux/ The Linux SDK package also has the above tool cloned at the top level. If you have it installed: + :: cd /yocto-build diff --git a/source/linux/Examples_and_Demos/Application_Demos/Video_Graphics_Test.rst b/source/linux/Examples_and_Demos/Application_Demos/Video_Graphics_Test.rst index 5a7b8680d..05b808e7d 100644 --- a/source/linux/Examples_and_Demos/Application_Demos/Video_Graphics_Test.rst +++ b/source/linux/Examples_and_Demos/Application_Demos/Video_Graphics_Test.rst @@ -50,6 +50,7 @@ The APIs required to achieve scaling, overlaying and alpha-blending using the DS Running the Test ---------------- In order for the users to run the video graphics test, please type the following commands on the EVM: + :: target # insmod /lib/modules//extra/galcore.ko baseAddress=0x80000000 physSize=0x80000000 diff --git a/source/linux/Foundational_Components/Kernel/Kernel_Drivers/Camera/CAL.rst b/source/linux/Foundational_Components/Kernel/Kernel_Drivers/Camera/CAL.rst index 3ac6a6f51..f3dbbd978 100644 --- a/source/linux/Foundational_Components/Kernel/Kernel_Drivers/Camera/CAL.rst +++ b/source/linux/Foundational_Components/Kernel/Kernel_Drivers/Camera/CAL.rst @@ -200,6 +200,7 @@ properly configure the DPHY. .. seealso:: `MIPI CSI-2 Kernel API reference `_ As you can see in the above link, typically the pixel rate is calculated as follows: + :: pixel_rate = link_freq * 2 * nr_of_lanes / bits_per_sample @@ -210,6 +211,7 @@ therefore sensor dependent. This is also the most accurate method. Alternatively, if you trust that your sensor is configured correctly for a specific resolution/pixel format and frame interval then the pixel rate can be calculated using this simplified formula: + :: pixel_rate = total horizontal width * total vertical lines * frame per second @@ -218,6 +220,7 @@ Here total horizontal width and total vertical lines includes blanking. This information is also sensor dependent or at least configuration dependent. For example if we take a look at the ov5640 configuration for 1920x1080\@30 fps: + :: total horizontal width = 2500 diff --git a/source/linux/Foundational_Components/Kernel/Kernel_Drivers/Network/CPSW-PTP.rst b/source/linux/Foundational_Components/Kernel/Kernel_Drivers/Network/CPSW-PTP.rst index f3ab40339..c3069ddde 100644 --- a/source/linux/Foundational_Components/Kernel/Kernel_Drivers/Network/CPSW-PTP.rst +++ b/source/linux/Foundational_Components/Kernel/Kernel_Drivers/Network/CPSW-PTP.rst @@ -676,6 +676,7 @@ PTP with Transparent Clock (Switch mode) Use the following ptp config file on the device that acts as the transparent clock: **tc-ptp.cfg** + :: [global] diff --git a/source/linux/Foundational_Components/Kernel/Kernel_Drivers/Network/NetCP.rst b/source/linux/Foundational_Components/Kernel/Kernel_Drivers/Network/NetCP.rst index 0c1b2d924..69a364e4e 100644 --- a/source/linux/Foundational_Components/Kernel/Kernel_Drivers/Network/NetCP.rst +++ b/source/linux/Foundational_Components/Kernel/Kernel_Drivers/Network/NetCP.rst @@ -734,6 +734,7 @@ M / (2^S \* D) = 5000 / (2^10 \* 3) hence M = 5000, S = 10, D = 3 + | Note 3: cpts driver keeps a table of M/S/D for some common frequencies diff --git a/source/linux/Foundational_Components_IPC64x.rst b/source/linux/Foundational_Components_IPC64x.rst index 4abd11533..aa4efccbe 100644 --- a/source/linux/Foundational_Components_IPC64x.rst +++ b/source/linux/Foundational_Components_IPC64x.rst @@ -378,31 +378,30 @@ rpmsg_char_close() `All remote proc ids are defined in rproc_id.h `__ The below table lists the device enumerations as defined in the rpmsg_char_library. The validiaty of the enumerations wrt AM64x is also specified. -:: - +------------------+--------------------+---------+-----------------------------------+ - | Enumeration ID | Device Name | Valid | Description | - +==================+====================+=========+===================================+ - | R5F_MCU0_0 |N/A | No | R5F SS in MCU domain | - +------------------+--------------------+---------+-----------------------------------+ - | R5F_MCU0_1 |N/A | No | R5F SS in MCU domain | - +------------------+--------------------+---------+-----------------------------------+ - | R5F_MAIN0_0 | 78000000.r5f | Yes | R5F Cluster0 Core0 in Main Domain | - +------------------+--------------------+---------+-----------------------------------+ - | R5F_MAIN0_1 | 78200000.r5f | Yes | R5F Cluster0 Core1 in Main Domain | - +------------------+--------------------+---------+-----------------------------------+ - | R5F_MAIN1_0 | 78400000.r5f | Yes | R5F Cluster1 Core0 in Main Domain | - +------------------+--------------------+---------+-----------------------------------+ - | R5F_MAIN1_1 | 78600000.r5f | Yes | R5F Cluster1 Core1 in Main Domain | - +------------------+--------------------+---------+-----------------------------------+ - | DSP_C66_0 |N/A | No | C66 DSP | - +------------------+--------------------+---------+-----------------------------------+ - | DSP_C66_1 |N/A | No | C66 DSP | - +------------------+--------------------+---------+-----------------------------------+ - | DSP_C71_0 |N/A | No | C71 DSP | - +------------------+--------------------+---------+-----------------------------------+ - | M4F_MCU0_0 | 5000000.m4f | Yes | M4F core in MCU Domain | - +------------------+--------------------+---------+-----------------------------------+ ++------------------+--------------------+---------+-----------------------------------+ +| Enumeration ID | Device Name | Valid | Description | ++==================+====================+=========+===================================+ +| R5F_MCU0_0 | N/A | No | R5F SS in MCU domain | ++------------------+--------------------+---------+-----------------------------------+ +| R5F_MCU0_1 | N/A | No | R5F SS in MCU domain | ++------------------+--------------------+---------+-----------------------------------+ +| R5F_MAIN0_0 | 78000000.r5f | Yes | R5F Cluster0 Core0 in Main Domain | ++------------------+--------------------+---------+-----------------------------------+ +| R5F_MAIN0_1 | 78200000.r5f | Yes | R5F Cluster0 Core1 in Main Domain | ++------------------+--------------------+---------+-----------------------------------+ +| R5F_MAIN1_0 | 78400000.r5f | Yes | R5F Cluster1 Core0 in Main Domain | ++------------------+--------------------+---------+-----------------------------------+ +| R5F_MAIN1_1 | 78600000.r5f | Yes | R5F Cluster1 Core1 in Main Domain | ++------------------+--------------------+---------+-----------------------------------+ +| DSP_C66_0 | N/A | No | C66 DSP | ++------------------+--------------------+---------+-----------------------------------+ +| DSP_C66_1 | N/A | No | C66 DSP | ++------------------+--------------------+---------+-----------------------------------+ +| DSP_C71_0 | N/A | No | C71 DSP | ++------------------+--------------------+---------+-----------------------------------+ +| M4F_MCU0_0 | 5000000.m4f | Yes | M4F core in MCU Domain | ++------------------+--------------------+---------+-----------------------------------+ .. note:: diff --git a/source/linux/Industrial_Protocols/HSR_PRP/_HSR_PRP_for_Linux.rst b/source/linux/Industrial_Protocols/HSR_PRP/_HSR_PRP_for_Linux.rst index d7f3ae0ad..d913bfe0e 100644 --- a/source/linux/Industrial_Protocols/HSR_PRP/_HSR_PRP_for_Linux.rst +++ b/source/linux/Industrial_Protocols/HSR_PRP/_HSR_PRP_for_Linux.rst @@ -181,12 +181,14 @@ You can also check which PRU-ICSS an ethernet interface belongs to via command line, e.g. eth2 on different platforms: AM571x: + :: root@am57xx-evm:~# ls -l /sys/class/net/eth2 | grep device lrwxrwxrwx 1 root root 0 Jun 10 11:29 device -> ../../../pruss1_eth AM572x: + :: root@am57xx-evm:~# ls -l /sys/class/net/eth2 | grep device diff --git a/source/linux/Industrial_Protocols/PTP/_PTP.rst b/source/linux/Industrial_Protocols/PTP/_PTP.rst index e2d40dc94..25ceaef50 100644 --- a/source/linux/Industrial_Protocols/PTP/_PTP.rst +++ b/source/linux/Industrial_Protocols/PTP/_PTP.rst @@ -203,6 +203,7 @@ boot using the PPS device tree file. the relevant boot command (e.g. 'bootcmd', mmcboot' or 'netboot') 2. Set the device tree file to be used. + :: setenv fdtfile @@ -432,6 +433,7 @@ configuration file: (where eth2/eth3 are the slave interfaces used for the HSR/PRP interface) HSR: + :: [global] @@ -488,6 +490,7 @@ HSR: fault_reset_interval 0 PRP: + :: [global] @@ -552,6 +555,7 @@ configured using a configuration file similar to the one below: (Note: only supported on PRU-ICSS ports using DualEMAC, and supports slave side only) Telecom: + :: # Telecom Profile (G.8275.x) PTP Config File @@ -1363,6 +1367,7 @@ Refer to the sample linuxptp BC configuration files bc.cfg, bc_hsr.cfg and bc_pr as described below: bc.cfg: BC with GMAC and four ICSS ports + :: [global] @@ -1422,6 +1427,7 @@ bc.cfg: BC with GMAC and four ICSS ports fault_reset_interval 0 bc_prp.cfg: BC with GMAC and two PRP ports: + :: [global] @@ -1509,6 +1515,7 @@ bc_prp.cfg: BC with GMAC and two PRP ports: bc_hsr.cfg: BC with GMAC and two HSR ports: + :: [global] diff --git a/source/linux/Industrial_Protocols/_SORTE.rst b/source/linux/Industrial_Protocols/_SORTE.rst index 5db14a1e2..f0b9bfb6f 100644 --- a/source/linux/Industrial_Protocols/_SORTE.rst +++ b/source/linux/Industrial_Protocols/_SORTE.rst @@ -147,6 +147,7 @@ print will be displayed on console: :name: sorte-sample-log-from-am572x-idk **Master** + :: root@am57xx-evm:~# pruss_app_sorte_master_am572x.out @@ -156,6 +157,7 @@ print will be displayed on console: sorte master: 2 SLAVE devices connected **Slave** + :: root@am57xx-evm:~# pruss_app_sorte_slave_am572x.out diff --git a/source/linux/Industrial_Protocols_HSR_PRP.rst b/source/linux/Industrial_Protocols_HSR_PRP.rst index 40af5996a..274860a8b 100644 --- a/source/linux/Industrial_Protocols_HSR_PRP.rst +++ b/source/linux/Industrial_Protocols_HSR_PRP.rst @@ -18,6 +18,7 @@ and PRU-ICSS ports are eth1/eth2): (This acts as a 2 node ring for HSR, or a 2 node point-to-point for PRP) 2 ) Configure ports to have the same MAC address + :: ifconfig eth1 0.0.0.0 down && ifconfig eth2 0.0.0.0 down @@ -26,6 +27,7 @@ and PRU-ICSS ports are eth1/eth2): 3 ) Configure offload feature, and create HSR/PRP interface (for HSR) + :: ethtool -K eth1 hsr-rx-offload on && ethtool -K eth2 hsr-rx-offload on @@ -34,6 +36,7 @@ and PRU-ICSS ports are eth1/eth2): ifconfig hsr0 192.168.2.20 (for PRP) + :: ethtool -K eth1 prp-rx-offload on && ethtool -K eth2 prp-rx-offload on