[PATCH V2] doc: mmc man-page

[Jaehoon Chung]

On 4/23/21 11:23 PM, Heinrich Schuchardt wrote:
> On 02.04.21 02:15, Jaehoon Chung wrote:
>> Provide a man-pages for the mmc command.
>>
>> Signed-off-by: Jaehoon Chung <jh80.chung at samsung.com>
>> ---
>> Changelog on V2
>> - Add missing empty line
>> - Add bootbus's arguments descriptions
>> ---
>>  doc/usage/index.rst |   1 +
>>  doc/usage/mmc.rst   | 212 ++++++++++++++++++++++++++++++++++++++++++++
>>  2 files changed, 213 insertions(+)
>>  create mode 100644 doc/usage/mmc.rst
>>
>> diff --git a/doc/usage/index.rst b/doc/usage/index.rst
>> index 6c59bbadab45..15c682ceface 100644
>> --- a/doc/usage/index.rst
>> +++ b/doc/usage/index.rst
>> @@ -30,6 +30,7 @@ Shell commands
>>     load
>>     loady
>>     mbr
>> +   mmc
>>     pstore
>>     qfw
>>     sbi
>> diff --git a/doc/usage/mmc.rst b/doc/usage/mmc.rst
>> new file mode 100644
>> index 000000000000..57284ed6741e
>> --- /dev/null
>> +++ b/doc/usage/mmc.rst
>> @@ -0,0 +1,212 @@
>> +.. SPDX-License-Identifier: GPL-2.0+:
>> +
>> +mmc command
>> +============
>> +
>> +Synopsis
>> +--------
>> +
>> +::
>> +
>> +    mmc info
>> +    mmc read addr blk# cnt
>> +    mmc write addr blk# cnt
>> +    mmc erase blk# cnt
>> +    mmc rescan
>> +    mmc part
>> +    mmc dev [dev] [part]
>> +    mmc list
>> +    mmc wp
>> +    mmc bootbus <dev> <boot_bus_width> <reset_boot_bus_width> <boot_mode>
>> +    mmc bootpart-resize <dev> <dev part size MB> <RPMB part size MB>
>> +    mmc partconf <dev> [boot_ack boot_partition partition_access]
>> +    mmc rst-function <dev> <value>
>> +
>> +Description
>> +-----------
>> +
>> +The mmc command is used to control MMC(eMMC/SD) device.
>> +
>> +The 'mmc info' command displays information (Manufacturer ID, OEM, Name, Bus Speed, Mode, ...) of MMC device.
>> +
>> +The 'mmc read' command reads raw data to memory address from MMC device with block offset and count.
>> +
>> +The 'mmc write' command writes raw data to MMC device from memory address with block offset and count.
>> +
>> +    addr
>> +        memory address
>> +    blk#
>> +        start block offset
>> +    cnt
>> +        block count
>> +
>> +The 'mmc erase' command erases MMC device from block offset until count.
> 
> Shouldn't this be:
> 
> The 'mmc erase' command erases *count* blocks on the MMC device starting
> at block *blk#*?

Will update.

Thanks!

Best Regards,
Jaehoon Chung

> 
> Best regards
> 
> Heinrich
> 
>> +
>> +    blk#
>> +        start block offset
>> +    cnt
>> +        block count
>> +
> <snip />
>