/*******************************************************************************
Copyright (C) 2016 Marvell International Ltd.

Marvell BSD License Option

If you received this File from Marvell, you may opt to use, redistribute and/or
modify this File under the following licensing terms.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:

        * Redistributions of source code must retain the above copyright notice,
          this list of conditions and the following disclaimer.

        * Redistributions in binary form must reproduce the above copyright
          notice, this list of conditions and the following disclaimer in the
          documentation and/or other materials provided with the distribution.

        * Neither the name of Marvell nor the names of its contributors may be
          used to endorse or promote products derived from this software without
          specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

*******************************************************************************/

/=#

#langdef   en-US "english"

#string STR_GET_HELP_SF            #language en-US ""
".TH sf 0 "Basic SPI flash command."\r\n"
".SH NAME\r\n"
"Read/write data from/into SPI flash.\r\n"
".SH SYNOPSIS\r\n"
" \r\n"
"sf [probe | read | readfile | write | writefile | erase | \r\n"
"    update | updatefile] \r\n"
".SH OPTIONS\r\n"
" \r\n"
"   Length        - Number of bytes to send\r\n"
"   Address       - Address in RAM to store/load data\r\n"
"   Offset        - Offset from beggining of SPI flash to store/load data\r\n"
"   FilePath      - Path to file to read data into or write/update data from \r\n"
".SH EXAMPLES\r\n"
" \r\n"
"EXAMPLES:\r\n"
"Check if there is response from SPI flash\r\n"
"  sf probe\r\n"
"Read 32 bytes from 0xe00000 of SPI flash into RAM at address 0x100000\r\n"
"  sf read 0x100000 0xe00000 32\r\n"
"Read 0x20 bytes from 0x200000 of SPI flash into RAM at address 0x300000\r\n"
"  sf read 0x300000 0x200000 0x20\r\n"
"Erase 0x10000 bytes from offset 0x100000 of SPI flash\r\n"
"  sf erase 0x100000 0x100000\r\n"
"Write 16 bytes from 0x200000 at RAM into SPI flash at address 0x4000000\r\n"
"  sf write 0x200000 0x4000000 16\r\n"
"Update 100 bytes from 0x100000 at RAM in SPI flash at address 0xe00000\r\n"
"  sf update 0x100000 0xe00000 100\r\n"
"Read 0x3000 bytes from 0x0 of SPI flash into file fs2:file.bin\r\n"
"  sf readfile fs2:file.bin 0x0 0x3000\r\n"
"Update data in SPI flash at 0x3000000 from file Linux.efi\r\n"
"  sf update Linux.efi 0x3000000\r\n"
".SH RETURNVALUES\r\n"
" \r\n"
"RETURN VALUES:\r\n"
"  SHELL_SUCCESS        The action was completed as requested.\r\n"
"  SHELL_ABORTED        Error while processing command\r\n"


