Skip to content

Commit a42bfdb

Browse files
sinha-shreyashsinha-shreyash
committed
fix(docs): J7*: Update SD card creation guide for ADAS SDK
 - wic image is not packaged as a part of ADAS SDK release as mentioned in this bug [0]. Excluding this part for J7 devices. [0]: https://jira.itg.ti.com/browse/ADASVISION-6706 Signed-off-by: Shreyash Sinha <s-sinha@ti.com>
1 parent 064e58e commit a42bfdb

File tree

1 file changed

+84
-61
lines changed

1 file changed

+84
-61
lines changed

‎source/linux/Overview/Processor_SDK_Linux_create_SD_card.rst‎

Lines changed: 84 additions & 61 deletions
Original file line numberDiff line numberDiff line change
@@ -8,17 +8,29 @@ Overview
88

99
This section provides guides to create SD cards for the following use cases:
1010

11-
#. Create SD cards with default images:
11+
.. ifconfig:: CONFIG_image_type in ('adas')
1212

13-
- :ref:`Create SD cards with default images using balenaEtcher <processor-sdk-linux-create-sd-card-using-balena>`
13+
#. Create SD cards with default images:
1414

15-
- :ref:`Create SD cards with default images using bmap-tools <processor-sdk-linux-create-sd-card-using-bmap>`
15+
- :ref:`Create SD cards with default images using script packaged in installer <processor-sdk-linux-sd-card-with-default-images>`
1616

17-
- :ref:`Create SD cards with default images using script packaged in installer <processor-sdk-linux-sd-card-with-default-images>`
17+
#. Create SD cards with custom images:
1818

19-
#. Create SD cards with custom images:
19+
- :ref:`Create SD cards with custom images <processor-sdk-linux-create-sd-card-with-custom-images>`
2020

21-
- :ref:`Create SD cards with custom images <processor-sdk-linux-create-sd-card-with-custom-images>`
21+
.. ifconfig:: CONFIG_image_type not in ('adas')
22+
23+
#. Create SD cards with default images:
24+
25+
- :ref:`Create SD cards with default images using balenaEtcher <processor-sdk-linux-create-sd-card-using-balena>`
26+
27+
- :ref:`Create SD cards with default images using bmap-tools <processor-sdk-linux-create-sd-card-using-bmap>`
28+
29+
- :ref:`Create SD cards with default images using script packaged in installer <processor-sdk-linux-sd-card-with-default-images>`
30+
31+
#. Create SD cards with custom images:
32+
33+
- :ref:`Create SD cards with custom images <processor-sdk-linux-create-sd-card-with-custom-images>`
2234

2335
.. ifconfig:: CONFIG_part_variant in ('AM62X', 'AM62AX', 'AM64X')
2436

@@ -48,33 +60,39 @@ This section provides guides to create SD cards for the following use cases:
4860
host# sudo cp /media/$USER/boot/tiboot3-am65x_sr2-hs-evm.bin /media/$USER/boot/tiboot3.bin
4961
host# sudo cp /media/$USER/boot/sysfw-am65x_sr2-hs-evm.itb /media/$USER/boot/sysfw.itb
5062
63+
5164
.. _processor-sdk-linux-create-sd-card-using-balena:
5265

5366
Create SD Card using balenaEtcher
5467
----------------------------------
5568

5669
1. Download the default bootable SD card image (WIC file) available on the release page as
5770

58-
.. parsed-literal::
71+
.. parsed-literal::
5972
60-
tisdk-|__IMAGE_TYPE__|-image-<machine>-<version>.rootfs.wic.xz
73+
tisdk-|__IMAGE_TYPE__|-image-<machine>-<version>.rootfs.wic.xz
6174
6275
2. Download and install the balenaEtcher tool
6376

64-
- Balena Etcher is an open-source utility that can be installed on both Linux and Windows. Download the tool from `this link <https://www.balena.io/etcher/>`__ and install it.
77+
- Balena Etcher is an open-source utility that can be installed on both Linux and Windows. Download the tool from `this link <https://www.balena.io/etcher/>`__ and install it.
6578

6679
3. Flash the WIC image to the SD card
6780

68-
- Insert a micro SD card into the USB SD card reader and start Etcher.Choose the default WIC
69-
image to be flashed, choose the USB SD card reader as the target, and then click "Flash".
70-
Etcher will decompress the image and write it to the SD card, as shown below
81+
- Insert a micro SD card into the USB SD card reader and start Etcher.Choose the default WIC
82+
image to be flashed, choose the USB SD card reader as the target, and then click "Flash".
83+
Etcher will decompress the image and write it to the SD card, as shown below
7184

72-
.. Image:: /images/balena_etcher.png
73-
:height: 400
85+
.. Image:: /images/balena_etcher.png
86+
:height: 400
7487

75-
.. danger::
88+
.. danger::
7689

77-
This operation **WILL ERASE** the contents of your SD card.
90+
This operation **WILL ERASE** the contents of your SD card.
91+
92+
.. note::
93+
94+
We do not release WIC images for J7 platforms (J784S4, J742S2, J722S, J721E, J721S2).
95+
Please refer to :ref:`Create SD Card with custom images <processor-sdk-linux-sd-card-with-default-images>` for flashing image.
7896

7997
.. _processor-sdk-linux-create-sd-card-using-bmap:
8098

@@ -84,81 +102,86 @@ Create SD Card using bmap-tools
84102

85103
1. Download the default bootable SD card image (WIC file) available on the release page as
86104

87-
.. parsed-literal::
105+
.. parsed-literal::
88106
89-
tisdk-|__IMAGE_TYPE__|-image-<machine>-<version>.rootfs.wic.xz
107+
tisdk-|__IMAGE_TYPE__|-image-<machine>-<version>.rootfs.wic.xz
90108
91109
2. Decompress the tisdk-|__IMAGE_TYPE__|-image-<machine>-<version>.rootfs.wic.xz to tisdk-|__IMAGE_TYPE__|-image-<machine>-<version>.rootfs.wic
92110

93-
- For Linux:
111+
- For Linux:
94112

95-
.. parsed-literal::
113+
.. parsed-literal::
96114
97-
cd <PSDK_PATH>/filesystem
98-
unxz tisdk-|__IMAGE_TYPE__|-image-<machine>-<version>.rootfs.wic.xz
115+
cd <PSDK_PATH>/filesystem
116+
unxz tisdk-|__IMAGE_TYPE__|-image-<machine>-<version>.rootfs.wic.xz
99117
100118
3. Flash the WIC image to SD card
101119

102-
a) First, make sure that the SD card is unmounted. You can use lsblk to
103-
inspect whether the SD card partitions have a MOUNTPOINT. If the SD
104-
card is mounted, use umount to unmount the partitions.
120+
a) First, make sure that the SD card is unmounted. You can use lsblk to
121+
inspect whether the SD card partitions have a MOUNTPOINT. If the SD
122+
card is mounted, use umount to unmount the partitions.
105123

106-
For example, if lsblk returned this:
124+
For example, if lsblk returned this:
107125

108-
.. code-block:: console
126+
.. code-block:: console
109127
110-
$ lsblk
111-
NAME MAJ:MIN RM SIZE RO TYPE MOUNTPOINT
112-
:
113-
:
114-
sdc 8:32 1 15G 0 disk
115-
├─sdc1 8:33 1 131.8M 0 part /media/$USER/boot
116-
└─sdc2 8:34 1 765.9M 0 part /media/$USER/root
128+
$ lsblk
129+
NAME MAJ:MIN RM SIZE RO TYPE MOUNTPOINT
130+
:
131+
:
132+
sdc 8:32 1 15G 0 disk
133+
├─sdc1 8:33 1 131.8M 0 part /media/$USER/boot
134+
└─sdc2 8:34 1 765.9M 0 part /media/$USER/root
117135
118-
Then we would want to unmount sdc1 and sdc2:
136+
Then we would want to unmount sdc1 and sdc2:
119137

120-
.. code-block:: console
138+
.. code-block:: console
121139
122-
$ sudo umount /media/$USER/boot
123-
$ sudo umount /media/$USER/root
124-
$ lsblk
125-
NAME MAJ:MIN RM SIZE RO TYPE MOUNTPOINT
126-
:
127-
:
128-
sdc 8:32 1 15G 0 disk
129-
├─sdc1 8:33 1 131.8M 0 part
130-
└─sdc2 8:34 1 765.9M 0 part
140+
$ sudo umount /media/$USER/boot
141+
$ sudo umount /media/$USER/root
142+
$ lsblk
143+
NAME MAJ:MIN RM SIZE RO TYPE MOUNTPOINT
144+
:
145+
:
146+
sdc 8:32 1 15G 0 disk
147+
├─sdc1 8:33 1 131.8M 0 part
148+
└─sdc2 8:34 1 765.9M 0 part
131149
132-
b) Next, install bmap-tools using the following command:
150+
b) Next, install bmap-tools using the following command:
133151

134-
.. code-block:: console
152+
.. code-block:: console
153+
154+
sudo apt-get install bmap-tools
155+
156+
Then generate a bmap file from the decompressed WIC image with the following command.
157+
This step can be skipped but the bmap file significantly reduces the time taken to flash the SD card.
135158

136-
sudo apt-get install bmap-tools
159+
.. parsed-literal::
137160
138-
Then generate a bmap file from the decompressed WIC image with the following command.
139-
This step can be skipped but the bmap file significantly reduces the time taken to flash the SD card.
161+
bmaptool create -o tisdk-|__IMAGE_TYPE__|-image-<machine>-<version>.rootfs.bmap tisdk-|__IMAGE_TYPE__|-image-<machine>-<version>.rootfs.wic
140162
141-
.. parsed-literal::
163+
c) Then write the WIC image to the SD card with the following command:
142164

143-
bmaptool create -o tisdk-|__IMAGE_TYPE__|-image-<machine>-<version>.rootfs.bmap tisdk-|__IMAGE_TYPE__|-image-<machine>-<version>.rootfs.wic
165+
.. parsed-literal::
144166
145-
c) Then write the WIC image to the SD card with the following command:
167+
sudo bmaptool copy --bmap tisdk-|__IMAGE_TYPE__|-image-<machine>-<version>.rootfs.bmap tisdk-|__IMAGE_TYPE__|-image-<machine>-<version>.rootfs.wic /dev/sdx
146168
147-
.. parsed-literal::
148169
149-
sudo bmaptool copy --bmap tisdk-|__IMAGE_TYPE__|-image-<machine>-<version>.rootfs.bmap tisdk-|__IMAGE_TYPE__|-image-<machine>-<version>.rootfs.wic /dev/sdx
170+
.. danger::
150171

172+
The above operation **WILL ERASE** the contents of your SD card.
151173

152-
.. danger::
174+
In the above example, the SD card is at /dev/sdc. In that case, the
175+
image write command would look like this:
153176

154-
The above operation **WILL ERASE** the contents of your SD card.
177+
.. parsed-literal::
155178
156-
In the above example, the SD card is at /dev/sdc. In that case, the
157-
image write command would look like this:
179+
sudo bmaptool copy --bmap tisdk-|__IMAGE_TYPE__|-image-<machine>-<version>.rootfs.bmap tisdk-|__IMAGE_TYPE__|-image-<machine>-<version>.rootfs.wic /dev/sdc
158180
159-
.. parsed-literal::
181+
.. note::
160182

161-
sudo bmaptool copy --bmap tisdk-|__IMAGE_TYPE__|-image-<machine>-<version>.rootfs.bmap tisdk-|__IMAGE_TYPE__|-image-<machine>-<version>.rootfs.wic /dev/sdc
183+
We do not release WIC images for J7 platforms (J784S4, J742S2, J722S, J721E, J721S2).
184+
Please refer to :ref:`Create SD Card with custom images <processor-sdk-linux-sd-card-with-default-images>` for flashing image.
162185

163186
.. _processor-sdk-linux-create-sd-card-with-custom-images:
164187

0 commit comments

Comments
 (0)