Command Mode

The following page details the Lumorphix Command Mode.

Activation

To activate command mode, from the REPL, simply type: command (short-form ‘cmd’ is also accepted).

To deactivate command mode, simply type: exit.

Prompt

The user is prompted by ‘/ ' in this mode. Again, if multiple Cores are enabled, the current Core number will precede the prompt - and the output will only be relevant to that Core. There is also a banner at the end of the command mode page. For example (three dots are essentially 'etc’ - the command mode will occupy the entire Terminal window):

[ #1 ] /


...


COMMAND MODE | Type 'exit' to return to REPL | Type 'list|commands' to print a 
short-list of commands | Type 'list|help' to print a detailed list of commands 

Usage

Getting Help

To access help related information, two important commands are as follows:

Supported Commands

A full list of supported commands, as well as a copy and description of their output is as follows.

List Commands

list|io_capabilities or list|io_caps

Lists the total I/O pins and capabilities of the current Core, for the current Lumorphix build. For example, the current Core has been built to support four I/O pins, and they have been built to support all I/O protocols apart from I2C.

list|io_type_cfg

Lists the current I/O configuration for each I/O pin, for the current Core. For example, the user has configured PIN1 as PWM, PIN2 as GPIO_IN, and PIN3 and PIN4 as UART_OUT.

list|io_baud_cfg

Lists the baud configuration for each I/O pin that is configured as a UART (IN or OUT), for the current Core. For example, if the I/O type configuration remained the same as for the above command, the output of this command might be as follows (PIN3 and PIN4 are 9600 Baud).

list|io_pwm_cfg

This command will list the oscillation frequency for each I/O pin that is configured as a PWM, for the current Core. For example, if the I/O type configuration remained the same as for the above command, the output of this command might be as follows (PIN1 oscillates at 10 KHz).

list|io_spi_cfg

Lists the oscillation frequency for each I/O pin that is configured as a SPI (IN or OUT), for the current Core. For example, if PIN2 was configured as an SPI_OUT, the output of this command might be as follows (PIN3/4, whichever is configured as the SPI_CLK, would oscillate at 10 KHz).

list|timer_cfg

Lists the timer build configuration for the current Core. It lists the enabled / disabled status of the following timers:

If the ‘General Timer’ is disabled, and the user attempts to call a time-related API function, it will hang. For further information, see API.

list|watchdog_cfg

Lists the watchdog build configuration for the current Core, including presence and timeout (if the watchdog is present, and the API function watchdog_reset is not called within the timeout period, the corresponding Core will reboot. See API for further information.

list|bus_cfg

Lists the presence of the FPGA fabric bus for the current Core.

list|xbar_cfg

Lists the Core cross-bar (xbar) build configuration. The cross-bar facilitates synchronization and communication between separate Cores. An example output, if the command was run on Core #1, for a Lumorphix built with four Cores, might be as follows:

The locking mechanism from Core #1 to all other cores has been enabled, with a depth of one. The data transfer to/from Core #1 and all other cores has been enabled, with the return path between Core #3 and Core #1, and Core #4 and Core #1, having a FIFO of depth two. See API for more information.

list|user_comms_cfg

Lists the user communications (i.e. serial / terminal comms) config for the current Lumorphix build. Either internal (there are internal RTL modules per-Core within the IP that handles the user comms) or external (only a single user comms module, external to the IP). The internal option will have a larger LUT footprint, but also have the capability of communicating with each Core simultaneously.

list|clk_freq

Lists the clock frequency that Lumorphix is being clocked at, in MHz.

list|program_count

Lists the number of programs currently hosted on Lumorphix.

list|programs

Lists the programs currently hosted on Lumorphix.

list|start_on_boot_prompt_format

Lists the prompt format that has been configured to be loaded on boot (if any).

list|start_on_boot_program

Lists the program name that has been configured to start automatically on boot (if any).

list|program_code(“<Program Name>”)

Lists the program code of “<Program Name>”.

list|program_bytecode(“<Program Name>”)

Lists the program byte code of “<Program Name>”.

list|repl_history
list|cmd_history

Lists the REPL or Command history, up to a maximum of sixteen entries, each with a maximum length of sixty-four characters (longer input won’t be included).

Set Commands

set|io_type_cfg(PIN<x>, <I/O Type>)

Set PIN<x> (1 - maximum supported) to <I/O Type>. The I/O Type must be supported as per the output of the list|io_caps command.

set|io_baud_cfg(PIN<x>, <Baud Rate>)

Set PIN<x> (1 - maximum supported) that is configured as UART_OUT or UART_IN to have a baud rate of <Baud Rate>. Supported Baud Rates are as follows: 9600, 19200, 28800, 38400, 57600, 76800, 115200, 230400, 460800, 576000, 921600.

set|io_pwm_cfg(PIN<x>, <PWM Freq kHz>)

Set PIN<x> (1 - maximum supported) that is configured as PWM to have an oscillation frequency of <PWM Freq KHz>. Minimum 1 kHz, Maximum 200 Khz.

At the upper range of PWM frequencies, there will be ranges that will be unachievable, depending upon the clock frequency. In this case, the frequency will be set to the closest achievable that is larger than the requested frequency.

set|io_spi_cfg(PIN<x>, <SPI Freq kHz>)

Set PIN<x> (1 - maximum supported) that is configured as SPI (IN or OUT) to have an oscillation frequency of <SPI Freq KHz>. Minimum 1 kHz, Maximum 250 Khz.

set|start_on_boot_io_type_cfg

Set the current I/O type configuration to be the start-on-boot default.

set|start_on_boot_prompt_format

Set the current prompt format to be the start-on-boot default.

set|start_on_boot_program("<Program Name>")

Set <Program Name> to be the start-on-boot default.

Reset Commands

reset|start_on_boot_prompt_format

Reset the prompt format that has been configured to be loaded on boot to ‘Unconfigured’.

reset|start_on_boot_io_type_cfg

Reset the I/O type configuration to be loaded on boot to ‘None’.

reset|start_on_boot_program

No program will start on boot.

reset|io_type_cfg(PIN<x>)

Reset PIN<x> (1 - maximum supported) to Type ‘None’.

reset|all_io_type_cfg

Reset all PINs to Type ‘None’.

Delete Commands

delete|program("<Program Name>")

Delete the program “<Program Name>”.

delete|all_programs

Delete all programs.

Load Commands

load|start_on_boot_io_type_cfg

Load the start-on-boot I/O type configuration.

Upload Commands

upload|program("<Program Name>")

Upload a program “<Program Name>” to the device. Requires the program uploader utility. After running the command, disconnect your terminal program and upload the program from your PC, for example, on Linux (assuming no other USB devices connected - otherwise adjust ‘USB1’ accordingly):

$ python program_uploader.py <program name>.lua /dev/ttyUSB1 921600

Windows (run within your Python IDE and determine the COM port number (<x>) of your device via Device Manager):

<IDE cmd prompt> program_uploader.py <program name>.lua COM<x> 921600

Run Commands

run|program("<Program Name>")

Run the program “<Program Name>”.

This command, if successful, will return the user to REPL mode after the program has completed.

run|reboot

Reboot the current Core.

Cycle Commands

cycle|cpuprompt

Cycle the CPU prompt between unconfigured, on or off.

cycle|timeprompt

Cycle the time prompt between the following:

Memory Commands

memory|free

Display the current memory that is free, in bytes.

memory|total

Display the total memory that the current Core was built with, in bytes.

memory|low_water_mark

Display the minimum amount of memory that was ever free, in bytes.

memory|reset_low_water_mark

Reset the minimum amount of memory that was ever free to the current amount of memory that is free.

Stack Commands

stack|total

Display the total stack size that the current Core was built with, in bytes.

stack|low_water_mark

Display the minimum amount of stack memory that was ever free, in bytes.

stack|reset_low_water_mark

Reset the minimum amount of stack memory that was ever free to the current amount of stack memory that is free.

Other Commands

exit

Return to REPL mode.