Skip to content

Commit c25a838

Browse files
Masami Hiramatsutrini
Masami Hiramatsu
authored andcommitted
doc: usage: DFU: Fix dfu_alt_info document
Fix some typo and wrong information about dfu_alt_info. - Add the parameter format, decimal only or hexadecimal. - Use same parameter name for the same kind of parameters. (e.g. dev -> dev_id) Signed-off-by: Masami Hiramatsu <[email protected]>
1 parent 53b4063 commit c25a838

File tree

1 file changed

+40
-17
lines changed

1 file changed

+40
-17
lines changed

Diff for: doc/usage/dfu.rst

+40-17
Original file line numberDiff line numberDiff line change
@@ -113,9 +113,9 @@ mmc
113113
each element in *dfu_alt_info* being
114114

115115
* <name> raw <offset> <size> [mmcpart <num>] raw access to mmc device
116-
* <name> part <dev> <part_id> [mmcpart <num>] raw access to partition
117-
* <name> fat <dev> <part_id> [mmcpart <num>] file in FAT partition
118-
* <name> ext4 <dev> <part_id> [mmcpart <num>] file in EXT4 partition
116+
* <name> part <dev> <part_id> [offset <byte>] raw access to partition
117+
* <name> fat <dev> <part_id> file in FAT partition
118+
* <name> ext4 <dev> <part_id> file in EXT4 partition
119119
* <name> skip 0 0 ignore flashed data
120120
* <name> script 0 0 execute commands in shell
121121

@@ -169,14 +169,20 @@ nand
169169

170170
each element in *dfu_alt_info* being either of
171171

172-
* <name> raw <offset> <size> raw access to mmc device
173-
* <name> part <dev> <part_id> raw acces to partition
174-
* <name> partubi <dev> <part_id> raw acces to ubi partition
172+
* <name> raw <offset> <size> raw access to nand device
173+
* <name> part <dev_id> <part_id> raw access to partition
174+
* <name> partubi <dev_id> <part_id> raw access to ubi partition
175175

176176
with
177177

178-
partid
179-
is the MTD partition index
178+
offset
179+
is the offset in the nand device (hexadecimal without "0x")
180+
size
181+
is the size of the access area (hexadecimal without "0x")
182+
dev_id
183+
is the NAND device index (decimal only)
184+
part_id
185+
is the NAND partition index (decimal only)
180186

181187
ram
182188
raw access to ram::
@@ -190,6 +196,13 @@ ram
190196

191197
<name> ram <offset> <size> raw access to ram
192198

199+
with
200+
201+
offset
202+
is the offset in the ram device (hexadecimal without "0x")
203+
size
204+
is the size of the access area (hexadecimal without "0x")
205+
193206
sf
194207
serial flash : NOR::
195208

@@ -198,13 +211,19 @@ sf
198211
each element in *dfu_alt_info* being either of:
199212

200213
* <name> raw <offset> <size> raw access to sf device
201-
* <name> part <dev> <part_id> raw acces to partition
202-
* <name> partubi <dev> <part_id> raw acces to ubi partition
214+
* <name> part <dev_id> <part_id> raw acces to partition
215+
* <name> partubi <dev_id> <part_id> raw acces to ubi partition
203216

204217
with
205218

206-
partid
207-
is the MTD partition index
219+
offset
220+
is the offset in the sf device (hexadecimal without "0x")
221+
size
222+
is the size of the access area (hexadecimal without "0x")
223+
dev_id
224+
is the sf device index (the device is "nor<dev_id>") (deximal only)
225+
part_id
226+
is the MTD partition index (decimal only)
208227

209228
mtd
210229
all MTD device: NAND, SPI-NOR, SPI-NAND,...::
@@ -219,14 +238,18 @@ mtd
219238

220239
each element in *dfu_alt_info* being either of:
221240

222-
* <name> raw <offset> <size> forraw access to mtd device
223-
* <name> part <dev> <part_id> for raw acces to partition
224-
* <name> partubi <dev> <part_id> for raw acces to ubi partition
241+
* <name> raw <offset> <size> for raw access to mtd device
242+
* <name> part <part_id> for raw access to partition
243+
* <name> partubi <part_id> for raw access to ubi partition
225244

226245
with
227246

228-
partid
229-
is the MTD partition index
247+
offset
248+
is the offset in the mtd device (hexadecimal without "0x")
249+
size
250+
is the size of the access area (hexadecimal without "0x")
251+
part_id
252+
is the MTD partition index (decimal only)
230253

231254
virt
232255
virtual flash back end for DFU

0 commit comments

Comments
 (0)