SpiFlashCmd.uni 2.0 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152
  1. /*******************************************************************************
  2. Copyright (C) 2016 Marvell International Ltd.
  3. Copyright (c) 2020, Intel Corporation. All rights reserved.
  4. SPDX-License-Identifier: BSD-2-Clause-Patent
  5. *******************************************************************************/
  6. /=#
  7. #langdef en-US "english"
  8. #string STR_GET_HELP_SF #language en-US ""
  9. ".TH sf 0 "Basic SPI flash command."\r\n"
  10. ".SH NAME\r\n"
  11. "Read/write data from/into SPI flash.\r\n"
  12. ".SH SYNOPSIS\r\n"
  13. " \r\n"
  14. "sf [probe | read | readfile | write | writefile | erase | \r\n"
  15. " update | updatefile] \r\n"
  16. ".SH OPTIONS\r\n"
  17. " \r\n"
  18. " Length - Number of bytes to send\r\n"
  19. " Address - Address in RAM to store/load data\r\n"
  20. " Offset - Offset from beginning of SPI flash to store/load data\r\n"
  21. " FilePath - Path to file to read data into or write/update data from \r\n"
  22. ".SH EXAMPLES\r\n"
  23. " \r\n"
  24. "EXAMPLES:\r\n"
  25. "Check if there is response from SPI flash\r\n"
  26. " sf probe\r\n"
  27. "Read 32 bytes from 0xe00000 of SPI flash into RAM at address 0x100000\r\n"
  28. " sf read 0x100000 0xe00000 32\r\n"
  29. "Read 0x20 bytes from 0x200000 of SPI flash into RAM at address 0x300000\r\n"
  30. " sf read 0x300000 0x200000 0x20\r\n"
  31. "Erase 0x10000 bytes from offset 0x100000 of SPI flash\r\n"
  32. " sf erase 0x100000 0x100000\r\n"
  33. "Write 16 bytes from 0x200000 at RAM into SPI flash at address 0x4000000\r\n"
  34. " sf write 0x200000 0x4000000 16\r\n"
  35. "Update 100 bytes from 0x100000 at RAM in SPI flash at address 0xe00000\r\n"
  36. " sf update 0x100000 0xe00000 100\r\n"
  37. "Read 0x3000 bytes from 0x0 of SPI flash into file fs2:file.bin\r\n"
  38. " sf readfile fs2:file.bin 0x0 0x3000\r\n"
  39. "Update data in SPI flash at 0x3000000 from file Linux.efi\r\n"
  40. " sf update Linux.efi 0x3000000\r\n"
  41. ".SH RETURNVALUES\r\n"
  42. " \r\n"
  43. "RETURN VALUES:\r\n"
  44. " SHELL_SUCCESS The action was completed as requested.\r\n"
  45. " SHELL_ABORTED Error while processing command\r\n"