Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

CLI mode provide wide set of commands to manipulate module.
To enter CLI mode, switch COM port "Baudrate" to "123456".
In this mode firmware read user input and process commands. Commands is case sensitive and should be lower-case. "Backspace" can be used for command line correction. "Enter" with empty command line cause re-execution of previous command.

 

Scroll Title
titleCLI mode command set

Command

Description

ver

Print firmware version

power off

Disable FPGA power supply

power on

Enable FPGA power supply

flash status

Print SPI Flash Status registers

flash id

Print SPI Flash IDCODE

flash erase

SPI Flash "Bulk erase"

flash unlock

Clear SPI Flash "Status register"

flash read

Read data from SPI Flash

fpga status

Print status of FPGA pins

fpga reset

Reset FPGA

quit

Quit from CLI mode to COM mode

...

The "flash status" command read and print SPI Flash "Status register 1" and "Status register 2" values. Please refer your Flash datasheet to registers bit layout.

Note

...

To get full control on SPI bus firmware disable FPGA power supply before this operation. After each flash command, use "power on" command and "fpga reset" command to run FPGA.

Example:
> flash status
SR1 00 SR2 00

...

The "flash id" command read and print first 3 bytes from result of SPI Flash "READ IDENTIFICATION" command.

 

Scroll Title
title"READ IDENTIFICATION" result layout

Byte

Description

1

Manufacturer ID

2

Memory Type

3

Memory Capacity

...

Scroll Title
titleFlash IDCODEs

Flash

Manufacturer ID

Memory Type

Capacity

M25P32

20h - Micron

20h

16h

W25Q64FV

EFh - Winbond

40h

17h

Note

...

To get full control on SPI bus firmware disable FPGA power supply before this operation. After each flash command, use "power on" command and "fpga reset" command to run FPGA.

Example:
> flash id
IDCODE EF4017
W25Q64FV

...

The "flash erase" command execute SPI Flash "Bulk Erase" command. Processing of this command usually require some time. User should wait command to complete before power off module or enter next command. Refer your Flash chip datasheet for maximum required time.

Note

...

To get full control on SPI bus firmware disable FPGA power supply before this operation. After each flash command, use "power on" command and "fpga reset" command to run FPGA.

Example:
> flash erase
Done

...

The "flash unlock" command write zero value to status register. This command can be used to clear protection bits. Refer to your Flash chip datasheet for status register layout. Note:

Note
To get full control on SPI bus firmware disable FPGA power supply before this operation. After each flash command, use "power on" command and "fpga reset" command to run FPGA.

Example:
> flash unlock
Done

...

The "flash read" command read and print data from SPI Flash. Firmware read 8 bytes of data from current flash address and increment address to 8 after execution. Note:

Note
To get full control on SPI bus firmware disable FPGA power supply before this operation. After each flash command, use "power on" command and "fpga reset" command to run FPGA.

Example:
> flash read
FF FF FF FF FF FF FF FF
>
FF FF FF FF FF FF FF FF
>
AA 99 55 66 30 A1 00 07
>
20 00 31 A1 06 28 31 41
>
3D 00 31 61 89 EE 31 C2

...

The "fpga status" command print FPGA pins information. Information printed in 6 chars sequence {d|D}{i|I}{s|S}{p|P}{|0}{|1}. 

Scroll Title
title"fpga status" FPGA pins information printed in 6 chars sequence

Char

Value

Description

1

d

"Done" pin is 0

 

D

"Done" pin is 1

2

i

"Init" pin is 0

 

I

"Init" pin is 1

3

s

FPGA Power supply disabled

 

S

FPGA Power supply enabled

4

p

"PROG_B" pin is 0

 

P

"PROG_B" pin is 1

5

-

"Int0" pin is 0

 

0

"Int1" pin is 1

6

-

"Int1" pin is 0

 

1

"Int1" pin is 1

...