sys/shell/cmds: add mtd.doc.md

Author: fabian18

sys/shell/cmds/mtd.c

@@ -427,7 +427,8 @@ static int _cmd_mtd(int argc, char **argv)
                "  read_page:        Read a region of memory on the MTD (pagewise addressing)\n"
                "  write:            Write a region of memory on the MTD\n"
                "  write_page_raw:   Write a region of memory on the MTD (pagewise addressing)\n"
-               "  write_page:       Write a region of memory on the MTD (pagewise addressing, read-modify-write)\n"
+               "  write_page:       Write a region of memory on the MTD\n"
+               "                    (pagewise addressing, read-modify-write)\n"
                "  erase:            Erase a region of memory on the MTD\n"
                "  erase_sector:     Erase a sector of memory on the MTD\n"
                "  info:             Print properties of the MTD device\n"

sys/shell/cmds/mtd.doc.md

@@ -0,0 +1,73 @@
+@defgroup   sys_shell_commands_mtd MTD shell command
+@ingroup    sys_shell_commands
+@brief      MTD shell command for low level storage device access
+
+Available MTD Subcommands
+==========================
+
+There are different subcommands available to read and write data to and from an MTD,
+as well as additional subcommands for example to print information or to control
+power states.
+
+Subcommand: read \<addr\> \<len\>
+-----------------------------
+
+The subcommand takes a memory address and a length in bytes of how many bytes to read.
+@see mtd_read
+
+Subcommand: read_page \<page\> \<offset\> \<len\>
+-------------------------------------------
+
+The subcommand takes a page number, an offset within that page and a length in bytes
+of how many bytes to read.
+@see mtd_read_page
+
+Subcommand: write [-b] \<addr\> \<data\>
+------------------------------------
+
+The subcommand takes a memory address and data to write.
+If the optional parameter `-b` is used, it is expected that the provided data only
+consists of hexadecimal digits, else it is expected that the data is a string.
+@see mtd_write
+
+Subcommand: write_page_raw [-b] \<page\> \<offset\> \<data\>
+------------------------------------------------------
+
+The subcommand takes a page number, a byte offset within the page and data to write.
+If the optional parameter `-b` is used, it is expected that the provided data only
+consists of hexadecimal digits, else it is expected that the data is a string.
+@see mtd_write_page_raw
+
+Subcommand: write_page [-b] \<page\> \<offset\> \<data\>
+--------------------------------------------------
+
+The subcommand takes a page number, a byte offset within the page and data to write.
+If the optional parameter `-b` is used, it is expected that the provided data only
+consists of hexadecimal digits, else it is expected that the data is a string.
+The command only can be used when the module `mtd_write_page` is used.
+@see mtd_write_page
+
+Subcommand: erase \<addr\> \<len\>
+------------------------------
+
+The subcommand takes a memory address and a length in bytes of how many bytes to erase.
+@see mtd_erase
+
+Subcommand: erase \<sector\> [count]
+----------------------------------
+
+The subcommand takes a sector number and additionally a number of bytes to erase from this sector.
+@see mtd_erase_sector
+
+Subcommand: info
+----------------
+
+The subcommand takes no additional arguments.
+Information about storage size is printed.
+
+
+Subcommand: power \<on|off\>
+--------------------------
+
+The subcommand takes one parameter to power the MTD on or off, if it is implemented by the MTD driver.
+@see mtd_power