Skip to content

Commit 8009938

Browse files
aniket-lpraneethbajjuri
aniket-l
authored and
praneethbajjuri
committed
fix(formatting): linux: Foundational_Components_IPC_J7*: Fix indent and use proper code-block
Fix indentation to 3 spaces Replace generic literal blocks "::" by code-block directives as applicable https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-code-block Signed-off-by: Aniket Limaye <[email protected]>
1 parent 1b0ebf5 commit 8009938

6 files changed

+110
-104
lines changed

‎source/linux/Foundational_Components_IPC_J7200.rst‎

Lines changed: 17 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ in the SDK package that can be run from ARM Linux.
4545
The remoteproc driver is hard-coded to look for specific files when
4646
loading the R5F cores. Here are the files it looks for on an J7200 device:
4747

48-
::
48+
.. code-block:: text
4949
5050
+------------------+-----------------+----------------------+-----------------------+
5151
| Core Name | RemoteProc Name | Description | Firmware File Name |
@@ -62,7 +62,7 @@ loading the R5F cores. Here are the files it looks for on an J7200 device:
6262
Generally on a target file system the above files are soft linked to the
6363
intended executable FW files:
6464

65-
::
65+
.. code-block:: console
6666
6767
root@j7200-evm:~# ls -l /lib/firmware/
6868
lrwxrwxrwx 1 root root 65 Mar 9 2018 j7200-main-r5f0_0-fw -> /lib/firmware/ti-eth/j7200/app_remoteswitchcfg_server_strip.xer5f
@@ -76,23 +76,23 @@ For updating MCU (DM) R5F firmware binary, tispl.bin needs to be recompiled with
7676

7777
#. Go to linux installer and replace the existing R5F MCU (DM) firmware binary with the new one
7878

79-
::
79+
.. code-block:: console
8080
81-
host# cp <path_to_new_fw_binary>/ipc_echo_testb_freertos_mcu1_0_release.xer5f <path_to_linux_installer>/board-support/prebuilt-images/ti-dm/j7200/ipc_echo_testb_mcu1_0_release_strip.xer5f
81+
host# cp <path_to_new_fw_binary>/ipc_echo_testb_freertos_mcu1_0_release.xer5f <path_to_linux_installer>/board-support/prebuilt-images/ti-dm/j7200/ipc_echo_testb_mcu1_0_release_strip.xer5f
8282
8383
#. Recompile u-boot to regenerate tispl.bin using the top level makefile.
8484

85-
::
85+
.. code-block:: console
8686
87-
host# make u-boot
87+
host# make u-boot
8888
89-
Please refer to :ref:`top-level-makefile` for more details on Top Level makefile.
89+
Please refer to :ref:`top-level-makefile` for more details on Top Level makefile.
9090

9191
#. Replace the updated tispl.bin containing new R5F firmware binary in the boot partition of sdcard and reboot
9292

93-
::
93+
.. code-block:: console
9494
95-
host# sudo cp board-support/u-boot_build/A72/tispl.bin /media/$USER/boot
95+
host# sudo cp board-support/u-boot_build/A72/tispl.bin /media/$USER/boot
9696
9797
.. _booting_remote_cores_from_Linux_console:
9898

@@ -103,7 +103,7 @@ To reload a remote core with new executables, please follow the below steps.
103103

104104
First, identify the remotproc node associated with the remote core:
105105

106-
::
106+
.. code-block:: console
107107
108108
root@j7200-evm:~# head /sys/class/remoteproc/remoteproc*/name
109109
==> /sys/class/remoteproc/remoteproc0/name <==
@@ -118,20 +118,20 @@ First, identify the remotproc node associated with the remote core:
118118
119119
Then, use the sysfs interface to stop the remote core. For example, to stop the Main R5FSS0
120120

121-
::
121+
.. code-block:: console
122122
123123
root@j7200-evm:~# echo stop > /sys/class/remoteproc/remoteproc1/state
124124
[ 71.804687] remoteproc remoteproc1: stopped remote processor 5c00000.r5f
125125
126126
If needed, update the firmware symbolic link to point to a new firmware:
127127

128-
::
128+
.. code-block:: console
129129
130130
root@j7200-evm:/lib/firmware# ln -sf /lib/firmware/ti-ipc/j7200/ipc_echo_test_mcu2_1_release_strip.xer5f j7200-main-r5f0_1-fw
131131
132132
Finally, use the sysfs interface to start the remote core:
133133

134-
::
134+
.. code-block:: console
135135
136136
root@j7200-evm:~# echo start > /sys/class/remoteproc/remoteproc1/state
137137
[ 110.922899] remoteproc remoteproc1: powering up 5c00000.r5f
@@ -156,7 +156,7 @@ memory carveouts (DMA pools) are shown below.
156156

157157
See the devicetree bindings documentation for more details: `Documentation/devicetree/bindings/remoteproc/ti,k3-r5f-rproc.yaml <https://git.ti.com/cgit/ti-linux-kernel/ti-linux-kernel/tree/Documentation/devicetree/bindings/remoteproc/ti,k3-r5f-rproc.yaml?h=ti-linux-6.6.y>`__
158158

159-
::
159+
.. code-block:: text
160160
161161
+------------------+--------------------+---------+----------------------------+
162162
| Memory Section | Physical Address | Size | Description |
@@ -178,6 +178,8 @@ See the devicetree bindings documentation for more details: `Documentation/devic
178178
| R5F(main) Pool | 0xa3100000 | 15MB | R5F externel code/data mem |
179179
+------------------+--------------------+---------+----------------------------+
180180
181+
.. code-block:: console
182+
181183
root@j7200-evm:~# dmesg | grep Reserved
182184
[ 0.000000] Reserved memory: created DMA memory pool at 0x00000000a0000000, size 1 MiB
183185
[ 0.000000] Reserved memory: created DMA memory pool at 0x00000000a0100000, size 15 MiB
@@ -216,7 +218,7 @@ R5F external memory section sizes in their respective linker mapfiles.
216218

217219
arch/arm64/boot/dts/ti/k3-j7200-som-p0.dtsi
218220

219-
::
221+
.. code-block:: text
220222
221223
reserved_memory: reserved-memory {
222224
#address-cells = <2>;

‎source/linux/Foundational_Components_IPC_J721E.rst‎

Lines changed: 22 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ in the SDK package that can be run from ARM Linux.
4545
The remoteproc driver is hard-coded to look for specific files when
4646
loading the R5F, C66x and C71x cores. Here are the files it looks for on an J721E device:
4747

48-
::
48+
.. code-block:: text
4949
5050
+------------------+-----------------+----------------------+-----------------------+
5151
| Core Name | RemoteProc Name | Description | Firmware File Name |
@@ -58,23 +58,23 @@ loading the R5F, C66x and C71x cores. Here are the files it looks for on an J721
5858
+------------------+-----------------+----------------------+-----------------------+
5959
| C71x | 65800000.c7x | C71x core | j7-c71_1-fw |
6060
+------------------+-----------------+----------------------+-----------------------+
61-
| R5F | 41000000.r5f | R5F core(MCU domain) | j7-mcu-r5f0_0-fw |
61+
| R5F | 41000000.r5f | R5F core(MCU domain) | j7-mcu-r5f0_0-fw |
6262
+------------------+-----------------+----------------------+-----------------------+
63-
| R5F | 41400000.r5f | R5F core(MCU domain) | j7-mcu-r5f0_1-fw |
63+
| R5F | 41400000.r5f | R5F core(MCU domain) | j7-mcu-r5f0_1-fw |
6464
+------------------+-----------------+----------------------+-----------------------+
65-
| R5F | 5c00000.r5f | R5F core(MAIN domain)| j7-main-r5f0_0-fw |
65+
| R5F | 5c00000.r5f | R5F core(MAIN domain)| j7-main-r5f0_0-fw |
6666
+------------------+-----------------+----------------------+-----------------------+
67-
| R5F | 5d00000.r5f | R5F core(MAIN domain)| j7-main-r5f0_1-fw |
67+
| R5F | 5d00000.r5f | R5F core(MAIN domain)| j7-main-r5f0_1-fw |
6868
+------------------+-----------------+----------------------+-----------------------+
69-
| R5F | 5e00000.r5f | R5F core(MAIN domain)| j7-main-r5f1_0-fw |
69+
| R5F | 5e00000.r5f | R5F core(MAIN domain)| j7-main-r5f1_0-fw |
7070
+------------------+-----------------+----------------------+-----------------------+
71-
| R5F | 5f00000.r5f | R5F core(MAIN domain)| j7-main-r5f1_1-fw |
71+
| R5F | 5f00000.r5f | R5F core(MAIN domain)| j7-main-r5f1_1-fw |
7272
+------------------+-----------------+----------------------+-----------------------+
7373
7474
Generally on a target file system the above files are soft linked to the
7575
intended executable FW files:
7676

77-
::
77+
.. code-block:: console
7878
7979
root@j721e-evm:~# ls -l /lib/firmware/
8080
lrwxrwxrwx 1 root root 69 Mar 9 2018 j7-c66_0-fw -> /lib/firmware/ti-ipc/j721e/ipc_echo_test_c66xdsp_1_release_strip.xe66
@@ -98,23 +98,23 @@ For updating MCU (DM) R5F firmware binary, tispl.bin needs to be recompiled with
9898

9999
#. Go to linux installer and replace the existing R5F MCU (DM) firmware binary with the new one
100100

101-
::
101+
.. code-block:: console
102102
103-
host# cp <path_to_new_fw_binary>/ipc_echo_testb_freertos_mcu1_0_release.xer5f <path_to_linux_installer>/board-support/prebuilt-images/ti-dm/j721e/ipc_echo_testb_mcu1_0_release_strip.xer5f
103+
host# cp <path_to_new_fw_binary>/ipc_echo_testb_freertos_mcu1_0_release.xer5f <path_to_linux_installer>/board-support/prebuilt-images/ti-dm/j721e/ipc_echo_testb_mcu1_0_release_strip.xer5f
104104
105105
#. Recompile u-boot to regenerate tispl.bin using the top level makefile.
106106

107-
::
107+
.. code-block:: console
108108
109-
host# make u-boot
109+
host# make u-boot
110110
111-
Please refer to :ref:`top-level-makefile` for more details on Top Level makefile.
111+
Please refer to :ref:`top-level-makefile` for more details on Top Level makefile.
112112

113113
#. Replace the updated tispl.bin containing new R5F firmware binary in the boot partition of sdcard and reboot
114114

115-
::
115+
.. code-block:: console
116116
117-
host# sudo cp board-support/u-boot_build/A72/tispl.bin /media/$USER/boot
117+
host# sudo cp board-support/u-boot_build/A72/tispl.bin /media/$USER/boot
118118
119119
.. _booting_remote_cores_from_Linux_console:
120120

@@ -125,7 +125,7 @@ To reload a remote core with new executables, please follow the below steps.
125125

126126
First, identify the remotproc node associated with the remote core:
127127

128-
::
128+
.. code-block:: console
129129
130130
root@j721e-evm:~# head /sys/class/remoteproc/remoteproc*/name
131131
==> /sys/class/remoteproc/remoteproc0/name <==
@@ -190,20 +190,20 @@ First, identify the remotproc node associated with the remote core:
190190
191191
Then, use the sysfs interface to stop the remote core. For example, to stop the Main R5F0
192192

193-
::
193+
.. code-block:: console
194194
195195
root@j721e-evm:~# echo stop > /sys/class/remoteproc/remoteproc4/state
196196
[ 277.626160] remoteproc remoteproc4: stopped remote processor 5c00000.r5f
197197
198198
If needed, update the firmware symbolic link to point to a new firmware:
199199

200-
::
200+
.. code-block:: console
201201
202202
root@j721e-evm:/lib/firmware# ln -sf /lib/firmware/ti-ipc/j721e/ipc_echo_test_mcu2_1_release_strip.xer5f j7-main-r5f0_1-fw
203203
204204
Finally, use the sysfs interface to start the remote core:
205205

206-
::
206+
.. code-block:: console
207207
208208
root@j721e-evm:~# echo start > /sys/class/remoteproc/remoteproc4/state
209209
[ 311.633427] remoteproc remoteproc4: powering up 5c00000.r5f
@@ -228,7 +228,7 @@ memory carveouts (DMA pools) are shown below.
228228

229229
See the devicetree bindings documentation for more details: `Documentation/devicetree/bindings/remoteproc/ti,k3-r5f-rproc.yaml <https://git.ti.com/cgit/ti-linux-kernel/ti-linux-kernel/tree/Documentation/devicetree/bindings/remoteproc/ti,k3-r5f-rproc.yaml?h=ti-linux-6.6.y>`__
230230

231-
::
231+
.. code-block:: text
232232
233233
+------------------+--------------------+---------+----------------------------+
234234
| Memory Section | Physical Address | Size | Description |
@@ -270,6 +270,7 @@ See the devicetree bindings documentation for more details: `Documentation/devic
270270
| R5F(main) Pool | 0xa5100000 | 15MB | R5F externel code/data mem |
271271
+------------------+--------------------+---------+----------------------------+
272272
273+
.. code-block:: console
273274
274275
root@j721e-evm:~# dmesg | grep Reserved
275276
[ 0.000000] Reserved memory: created CMA memory pool at 0x00000008e0000000, size 512 MiB
@@ -319,7 +320,7 @@ M4F and R5F external memory section sizes in their respective linker mapfiles.
319320

320321
arch/arm64/boot/dts/ti/k3-j721e-som-p0.dtsi
321322

322-
::
323+
.. code-block:: text
323324
324325
reserved_memory: reserved-memory {
325326
#address-cells = <2>;

‎source/linux/Foundational_Components_IPC_J721S2.rst‎

Lines changed: 22 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ in the SDK package that can be run from ARM Linux.
4545
The remoteproc driver is hard-coded to look for specific files when
4646
loading the R5F and C7x cores. Here are the files it looks for on an J721S2 device:
4747

48-
::
48+
.. code-block:: text
4949
5050
+------------------+-----------------+----------------------+-----------------------+
5151
| Core Name | RemoteProc Name | Description | Firmware File Name |
@@ -54,23 +54,23 @@ loading the R5F and C7x cores. Here are the files it looks for on an J721S2 devi
5454
+------------------+-----------------+----------------------+-----------------------+
5555
| C7x | 65800000.c7x | C7x core | j721s2-c71_1-fw |
5656
+------------------+-----------------+----------------------+-----------------------+
57-
| R5F | 41000000.r5f | R5F core(MCU domain) | j721s2-mcu-r5f0_0-fw |
57+
| R5F | 41000000.r5f | R5F core(MCU domain) | j721s2-mcu-r5f0_0-fw |
5858
+------------------+-----------------+----------------------+-----------------------+
59-
| R5F | 41400000.r5f | R5F core(MCU domain) | j721s2-mcu-r5f0_1-fw |
59+
| R5F | 41400000.r5f | R5F core(MCU domain) | j721s2-mcu-r5f0_1-fw |
6060
+------------------+-----------------+----------------------+-----------------------+
61-
| R5F | 5c00000.r5f | R5F core(MAIN domain)| j721s2-main-r5f0_0-fw |
61+
| R5F | 5c00000.r5f | R5F core(MAIN domain)| j721s2-main-r5f0_0-fw |
6262
+------------------+-----------------+----------------------+-----------------------+
63-
| R5F | 5d00000.r5f | R5F core(MAIN domain)| j721s2-main-r5f0_1-fw |
63+
| R5F | 5d00000.r5f | R5F core(MAIN domain)| j721s2-main-r5f0_1-fw |
6464
+------------------+-----------------+----------------------+-----------------------+
65-
| R5F | 5e00000.r5f | R5F core(MAIN domain)| j721s2-main-r5f1_0-fw |
65+
| R5F | 5e00000.r5f | R5F core(MAIN domain)| j721s2-main-r5f1_0-fw |
6666
+------------------+-----------------+----------------------+-----------------------+
67-
| R5F | 5f00000.r5f | R5F core(MAIN domain)| j721s2-main-r5f1_1-fw |
67+
| R5F | 5f00000.r5f | R5F core(MAIN domain)| j721s2-main-r5f1_1-fw |
6868
+------------------+-----------------+----------------------+-----------------------+
6969
7070
Generally on a target file system the above files are soft linked to the
7171
intended executable FW files:
7272

73-
::
73+
.. code-block:: console
7474
7575
root@j721s2-evm:~# ls -l /lib/firmware/
7676
lrwxrwxrwx 1 root root 60 Feb 24 2023 j721s2-c71_0-fw -> /lib/firmware/ti-ipc/j721s2/ipc_echo_test_c7x_1_release_strip.xe71
@@ -86,23 +86,23 @@ For updating MCU (DM) R5F firmware binary, tispl.bin needs to be recompiled with
8686

8787
#. Go to linux installer and replace the existing R5F MCU (DM) firmware binary with the new one
8888

89-
::
89+
.. code-block:: console
9090
91-
host# cp <path_to_new_fw_binary>/ipc_echo_testb_freertos_mcu1_0_release.xer5f <path_to_linux_installer>/board-support/prebuilt-images/ti-dm/j721s2/ipc_echo_testb_mcu1_0_release_strip.xer5f
91+
host# cp <path_to_new_fw_binary>/ipc_echo_testb_freertos_mcu1_0_release.xer5f <path_to_linux_installer>/board-support/prebuilt-images/ti-dm/j721s2/ipc_echo_testb_mcu1_0_release_strip.xer5f
9292
9393
#. Recompile u-boot to regenerate tispl.bin using the top level makefile.
9494

95-
::
95+
.. code-block:: console
9696
97-
host# make u-boot
97+
host# make u-boot
9898
99-
Please refer to :ref:`top-level-makefile` for more details on Top Level makefile.
99+
Please refer to :ref:`top-level-makefile` for more details on Top Level makefile.
100100

101101
#. Replace the updated tispl.bin containing new R5F firmware binary in the boot partition of sdcard and reboot
102102

103-
::
103+
.. code-block:: console
104104
105-
host# sudo cp board-support/u-boot_build/A72/tispl.bin /media/$USER/boot
105+
host# sudo cp board-support/u-boot_build/A72/tispl.bin /media/$USER/boot
106106
107107
.. _booting_remote_cores_from_Linux_console:
108108

@@ -113,7 +113,7 @@ To reload a remote core with new executables, please follow the below steps.
113113

114114
First, identify the remotproc node associated with the remote core:
115115

116-
::
116+
.. code-block:: console
117117
118118
root@j721s2-evm:~# head /sys/class/remoteproc/remoteproc*/name
119119
==> /sys/class/remoteproc/remoteproc0/name <==
@@ -140,20 +140,20 @@ First, identify the remotproc node associated with the remote core:
140140
141141
Then, use the sysfs interface to stop the remote core. For example, to stop the C71x
142142

143-
::
143+
.. code-block:: console
144144
145145
root@j721s2-evm:~# echo stop > /sys/class/remoteproc/remoteproc0/state
146146
[ 1964.316965] remoteproc remoteproc0: stopped remote processor 64800000.dsp
147147
148148
If needed, update the firmware symbolic link to point to a new firmware:
149149

150-
::
150+
.. code-block:: console
151151
152152
root@j721s2-evm:/lib/firmware# ln -sf /lib/firmware/ti-ipc/j721s2/ipc_echo_test_c7x_1_release_strip.xe71 j721s2-c71_0-fw
153153
154154
Finally, use the sysfs interface to start the remote core:
155155

156-
::
156+
.. code-block:: console
157157
158158
root@j721s2-evm:/lib/firmware# echo start > /sys/class/remoteproc/remoteproc0/state
159159
[ 2059.504473] remoteproc remoteproc0: powering up 64800000.dsp
@@ -182,7 +182,7 @@ memory carveouts (DMA pools) are shown below.
182182

183183
See the devicetree bindings documentation for more details: `Documentation/devicetree/bindings/remoteproc/ti,k3-r5f-rproc.yaml <https://git.ti.com/cgit/ti-linux-kernel/ti-linux-kernel/tree/Documentation/devicetree/bindings/remoteproc/ti,k3-r5f-rproc.yaml?h=ti-linux-6.6.y>`__
184184

185-
::
185+
.. code-block:: text
186186
187187
+------------------+--------------------+---------+----------------------------+
188188
| Memory Section | Physical Address | Size | Description |
@@ -220,6 +220,7 @@ See the devicetree bindings documentation for more details: `Documentation/devic
220220
| R5F(main) Pool | 0xa5100000 | 15MB | R5F externel code/data mem |
221221
+------------------+--------------------+---------+----------------------------+
222222
223+
.. code-block:: console
223224
224225
root@j721s2-evm:~# dmesg | grep Reserved
225226
[ 0.000000] Reserved memory: created DMA memory pool at 0x00000000a0000000, size 1 MiB
@@ -267,7 +268,7 @@ M4F and R5F external memory section sizes in their respective linker mapfiles.
267268

268269
arch/arm64/boot/dts/ti/k3-j721s2-som-p0.dtsi
269270

270-
::
271+
.. code-block:: text
271272
272273
reserved_memory: reserved-memory {
273274
#address-cells = <2>;

0 commit comments

Comments
 (0)