Global help

[z180-stamp.git] / avr / command_tbl.c

/*
 * (C) Copyright 2014-2016 Leo C. <erbl259-lmu@yahoo.de>
 *
 * SPDX-License-Identifier:	GPL-2.0
 */

#include "common.h"
#include "command.h"
#include "cmd_mem.h"

extern command_ret_t do_echo(cmd_tbl_t *, uint_fast8_t, int, char * const []);
extern command_ret_t do_sleep(cmd_tbl_t *, uint_fast8_t, int, char * const []);
extern command_ret_t do_env_print(cmd_tbl_t *, uint_fast8_t, int, char * const []);
extern command_ret_t do_env_default(cmd_tbl_t *, uint_fast8_t, int, char * const []);
extern command_ret_t do_env_set(cmd_tbl_t *, uint_fast8_t, int, char * const []);
extern command_ret_t do_env_save(cmd_tbl_t *, uint_fast8_t, int, char * const []);
extern command_ret_t do_loadf(cmd_tbl_t *, uint_fast8_t, int, char * const []);
extern command_ret_t do_bootcf(cmd_tbl_t *, uint_fast8_t, int, char * const []);
extern command_ret_t do_loadcpm3(cmd_tbl_t *, uint_fast8_t, int, char * const []);
extern command_ret_t do_loadihex(cmd_tbl_t *, uint_fast8_t, int, char * const []);
#if defined(CONFIG_CMD_LOADB)
extern command_ret_t do_load_serial_bin(cmd_tbl_t *, uint_fast8_t, int, char * const []);
#endif
extern command_ret_t do_go(cmd_tbl_t *, uint_fast8_t, int, char * const []);
extern command_ret_t do_restart(cmd_tbl_t *, uint_fast8_t, int, char * const []);
extern command_ret_t do_console(cmd_tbl_t *, uint_fast8_t, int, char * const []);
extern command_ret_t do_dump_mem(cmd_tbl_t *, uint_fast8_t, int, char * const []);
extern command_ret_t do_mem_mm_avr(cmd_tbl_t *, uint_fast8_t, int, char * const []);
extern command_ret_t do_mem_nm_avr(cmd_tbl_t *, uint_fast8_t, int, char * const []);
extern command_ret_t do_eep_cp(cmd_tbl_t *, uint_fast8_t, int, char * const []);
extern command_ret_t do_busreq_pulse(cmd_tbl_t *, uint_fast8_t, int, char * const []);
extern command_ret_t do_date(cmd_tbl_t *, uint_fast8_t, int, char * const []);
extern command_ret_t do_gpio(cmd_tbl_t *, uint_fast8_t, int, char * const []);
extern command_ret_t do_sd(cmd_tbl_t *, uint_fast8_t, int, char * const []);
extern command_ret_t do_fat(cmd_tbl_t *, uint_fast8_t, int, char * const []);
extern command_ret_t do_run(cmd_tbl_t *, uint_fast8_t, int, char * const []);
extern command_ret_t do_source(cmd_tbl_t *, uint_fast8_t, int, char * const []);
extern command_ret_t do_attach(cmd_tbl_t *, uint_fast8_t, int, char * const []);
extern command_ret_t do_pr_free_avr(cmd_tbl_t *, uint_fast8_t, int, char * const []);

extern cmd_tbl_t cmd_tbl_fat[];
extern cmd_tbl_t cmd_tbl_sd[];

cmd_tbl_t cmd_tbl[] = {

CMD_TBL_ITEM(
	date,	2,	1,	do_date,
	"get/set date & time",
	"[MMDDhhmm[[CC]YY][.ss]]\n"
	"  - without arguments: print date & time\n"
	"  - with numeric argument: set the system date & time\n"
),

#ifdef DEBUG

CMD_TBL_ITEM(
	!mdr,	3,	1,	do_dump_mem,
	"RAM dump",
	"address [count]"
),
CMD_TBL_ITEM(
	!mde,	3,	1,	do_dump_mem,
	"EEPROM dump",
	"address [count]"
),
CMD_TBL_ITEM(
	!mdf,	3,	1,	do_dump_mem,
	"FLASH dump",
	"address [count]"
),
CMD_TBL_ITEM(
	!cpe,	4,	0,	do_eep_cp,
	"EEPROM copy",
	"source target count"
),
CMD_TBL_ITEM(
	!mm,	2,	1,	do_mem_mm_avr,
	"avr memory modify (auto-incrementing address)",
	"address"
),
CMD_TBL_ITEM(
	!nm,	2,	1,	do_mem_nm_avr,
	"avr memory modify (constant address)",
	"address"
),
CMD_TBL_ITEM(
	!prfree,	2,	1,	do_pr_free_avr,
	"print avr heap free list",
	"address"
),
#endif
CMD_TBL_ITEM(
	mstep,	2,	1,	do_busreq_pulse,
	"execute one M cycle",
	"[count]\n"
	"     - repeat count times"
),
CMD_TBL_ITEM(
	echo,	CONFIG_SYS_MAXARGS,	1,	do_echo,
	"display a line of text",
	"[-n] [argument ...]\n"
	"- echo the argument(s) to console.\n"
	"  -n  do not output the trailing newline"
),
CMD_TBL_ITEM(
	sleep ,    2,    1,     do_sleep,
	"delay execution for some time",
	"N[m][s]\n"
	"    - delay execution for decimal N (milli) seconds"
),
CMD_TBL_ITEM_COMPLETE(
	run,	CONFIG_SYS_MAXARGS,	1,	do_run,
	"run commands in an environment variable",
	"var [...]\n"
	"    - run the commands in the environment variable(s) 'var'",
	var_complete
),
CMD_TBL_ITEM_COMPLETE(
	source,	CONFIG_SYS_MAXARGS,	1,	do_source,
	"run commands from a file",
	"filename\n"
	"    - run the commands in the script file 'filename'",
	var_complete
),
CMD_TBL_ITEM_COMPLETE(
	printenv, CONFIG_SYS_MAXARGS,	1,	do_env_print,
	"print environment variables",
	"[-s] [name ...]\n"
	"    Print value of environment variable(s) 'name'\n"
	"    If no names are given, print values of all environment variables\n"
	"    -s Print in setenv form",
	var_complete
),
CMD_TBL_ITEM_COMPLETE(
	setenv, CONFIG_SYS_MAXARGS,	0,	do_env_set,
	"set environment variables",
	"name value ...\n"
	"    - set environment variable 'name' to 'value ...'\n"
	"setenv name\n"
	"    - delete environment variable 'name'",
	var_complete
),
CMD_TBL_ITEM(
	saveenv,	1,	0,	do_env_save,
	"save environment variables to persistent storage",
	""
),
CMD_TBL_ITEM(
	defaultenv,	1,	0,	do_env_default,
	"set all environment variables to their default values",
	""
),

CMD_TBL_ITEM(
	loadf,	1,	0,	do_loadf,
	"load srec_cat prepared image from controller flash",
	""
),
CMD_TBL_ITEM(
	bootcf,	CONFIG_SYS_MAXARGS,	0,	do_bootcf,
	"boot from cf card",
	"[options]\n"
	"    Load a number of sectors from the first CP/M partition and jump to\n"
	"    the load address.\n"
	"    -a ADDRESS\n"
	"            Load and start address (default 100 hex)\n"
	"    -s NUM\n"
	"            First sector of partition to load (0..255, default 0)\n"
	"    -c NUM\n"
	"            Number of sectors to load (1..127, default 7)\n"
	"    -i NUM\n"
	"            Partition type to look for (default 52 hex)\n"
	"    -n\n"
	"            Load only, do not execute\n"
	"    -t NUM\n"
	"            Timeout for IDE commands (1..65535, default 10000)\n"
	"    -v verbose\n"
	"            TODO: be verbose"
),
CMD_TBL_ITEM(
	loadcpm3, 3,	0,	do_loadcpm3,
	"load CPM3.SYS file",
	"[filename [common-base [banked-base]]] \n"
	"    - Load CP/M 3 system file from FAT filesystem. This command makes\n"
	"      CPMLDR superfluous. Uses the following environment variables if set:\n"
	"         '"ENV_CPM3_SYSFILE"' File to load. Default is '"CONFIG_CPM3_SYSFILE"'.\n"
	"         '"ENV_CPM3_BANKED_BASE"' Default is '"CONFIG_CPM3_BANKED_BASE_STR"'.\n"
	"      Sets the following environment variables after loading:\n"
	"         '"ENV_CPM3_COMMON_BASE"'\n"
	"         '"ENV_STARTADDRESS"'"
),
CMD_TBL_ITEM(
	loadi,	2,	0,	do_loadihex,
	"load intel hex file over serial line",
	"[[-]offset]\n"
	"    - load Intel-Hex-Record file over serial line with offset 'offset'"
),

#if defined(CONFIG_CMD_LOADB)
CMD_TBL_ITEM(
	loadb, 1, 0,	do_load_serial_bin,
	"load binary file over serial line (kermit mode)",
	"    - load binary file over serial line"
),

CMD_TBL_ITEM(
	loadx, 1, 0,	do_load_serial_bin,
	"load binary file over serial line (xmodem mode)",
	"    - load binary file over serial line"
),

CMD_TBL_ITEM(
	loady, 1, 0,	do_load_serial_bin,
	"load binary file over serial line (ymodem mode)",
	"    - load binary file over serial line"
),
#endif	/* CONFIG_CMD_LOADB */

CMD_TBL_ITEM(
	go,	2,	0,	do_go,
	"start application at address 'addr'",
	"addr\n"
	"    - start application at address 'addr'"
//	"\n"
//	"      passing 'arg' as arguments"
),
CMD_TBL_ITEM(
	reset,	1,	0,	do_reset,
	"Keep CPU in RESET state",
	""
),
CMD_TBL_ITEM(
	restart, 1, 1,	do_restart,
	"Perform RESET of the CPU",
	""
),
CMD_TBL_ITEM(
	connect, 1, 0,	do_console,
	"Connect to CPU console i/o",
	"\n"
	"    - type the escape character followed by Q to close the connection, \n"
	"      or followed by ? to see other options. The default escape character \n"
	"      is Ctrl-^ (0x1E). It can be changed by setting env var '"ENV_ESC_CHAR"'."

),

CMD_TBL_ITEM(
	pin, CONFIG_SYS_MAXARGS, 1,	do_gpio,
	"Set or query pin state",
	"[-s] [<pins>]\n"
	"    - print cofiguration and state or frequency of pins\n"
	"      print all pins, if argument is omitted\n"
	"pin <pins> h[igh]|l[ow]\n"
	"    - config pins as output and set to level high or low\n"
	"pin <pins> ts|i[n]|p[ullup]\n"
	"    - config pins as input/tristate or input with pullup\n"
	"pin <pins> value[K|M][Hz]\n"
	"    - output a clock on pins\n"
	"      value is system clock divider or frequency, if 'Hz' is appended\n"
	"      divider is rounded down to next possible value (depends on pin)\n"
	"\n"
	"<pins> is a comma separated list of numbers or ranges, i.e. \"0,9,3-6\"\n"
),

CMD_TBL_ITEM(
	md,	3,	CTBL_REPEAT,	do_mem_md,
	"memory display",
	"address [# of objects]"
),
CMD_TBL_ITEM(
	mm,	2,	CTBL_REPEAT,	do_mem_mm,
	"memory modify (auto-incrementing address)",
	"address"
),
CMD_TBL_ITEM(
	nm,	2,	CTBL_REPEAT,	do_mem_nm,
	"memory modify (constant address)",
	"address"
),
CMD_TBL_ITEM(
	mw,	CONFIG_SYS_MAXARGS,	CTBL_REPEAT,	do_mem_mw,
	"memory write (fill)",
	"[-bwl] address value [count]\n"
	"   -b  write value as byte (8 bit, default)\n"
	"   -w  write value as word (16 bit)\n"
	"   -l  write value as long (32 bit)"
),
CMD_TBL_ITEM(
	cp,	4,	CTBL_REPEAT,	do_mem_cp,
	"memory copy",
	"source target count"
),
CMD_TBL_ITEM(
	cmp,	4,	CTBL_REPEAT,	do_mem_cmp,
	"memory compare",
	"addr1 addr2 count"
),
CMD_TBL_ITEM(
	base,	2,	0,	do_mem_base,
	"print or set address offset",
	"\n"
	"    - print address offset for memory commands\n"
	"base offset\n"
	"    - set address offset for memory commands to 'offset'"
),
CMD_TBL_ITEM(
	mloop,	3,	CTBL_REPEAT,	do_mem_loop,
	"infinite loop on address range",
	"address number_of_bytes"
),
CMD_TBL_ITEM(
	mloopw,	4,	CTBL_REPEAT,	do_mem_loopw,
	"infinite write loop on address range",
	"address number_of_bytes data_to_write"
),

#ifdef CONFIG_CMD_MEMTEST
CMD_TBL_ITEM(
	mtest,	4,	CTBL_REPEAT,	do_mem_mtest,
	"simple RAM read/write test",
	"[start [end [iterations]]]"
),
#endif	/* CONFIG_CMD_MEMTEST */

#ifdef CONFIG_MX_CYCLIC
CMD_TBL_ITEM(
	mdc,	4,	CTBL_REPEAT,	do_mem_mdc,
	"memory display cyclic",
	"address count delay(ms)"
),
CMD_TBL_ITEM(
	mwc,	CONFIG_SYS_MAXARGS,	CTBL_REPEAT,	do_mem_mdc,
	"memory write cyclic",
	"[-bwl] address value delay(ms)\n"
	"   -b  write value as byte (8 bit, default)\n"
	"   -w  write value as word (16 bit)\n"
	"   -l  write value as long (32 bit)"
),
#endif /* CONFIG_MX_CYCLIC */

CMD_TBL_ITEM_TOP(
	sd,   CONFIG_SYS_MAXARGS, 1, do_sd,
	"SD/MMC card handling commands",
	"<subcommand> args ...\n"
	"sd help\n"
	"    - print help on subcommands",
	cmd_tbl_sd
),
CMD_TBL_ITEM_TOP(
	fat,   CONFIG_SYS_MAXARGS, 1, do_fat,
	"fat filesystem commands",
	"<subcommand> args ...\n"
	"fat help\n"
	"    - print help on subcommands",
	cmd_tbl_fat
),

CMD_TBL_ITEM(
	attach,	CONFIG_SYS_MAXARGS,	CTBL_REPEAT,	do_attach,
	"attach filesystem image file to CP/M drive",
	"[-rw] [-o options] dsk<n> diskfile\n"
	"    Attach diskfile to dsk<n>, where n in 0..7\n"
	"    -r      File is read only (write protected)\n"
	"    -w      File is read/write (default)\n"
	"    -o options\n"
	"            Options is a comma-separated list of\n"
	"            ro, rw, debug, nodebug\n"
	"\n"
	"attach [-rw] -o reattach[,other options] dsk<n>\n"
	"    Change options for dsk<n>.\n"
	"    Options as above.\n"
	"\n"
	"attach -d -a|dsk<n>\n"
	"detach -a|dsk<n>\n"
	"    Detach diskfile from dsk<n>.\n"
	"    -a      Detach all.\n"
	"\n"
	"attach\n"
	"    Without arguments, list current assignments"
),
CMD_TBL_ITEM(
	detach,	2,	CTBL_REPEAT,	do_attach,
	"detach file from CP/M drive",
	"dsk<n>]\n"
	"    - alias for 'attach -d dsk<n>'"
),

CMD_TBL_ITEM(
	help,	CONFIG_SYS_MAXARGS,	CTBL_REPEAT,	do_help,
	"print command description/usage",
	"\n"
	"       - print brief description of all commands\n"
	"help command ...\n"
	"       - print detailed usage of 'command'"
),

/* This does not use the CMD_TBL_ITEM macro as ? can't be used in symbol names */
	{FSTR("?"),   CONFIG_SYS_MAXARGS, 1, do_help,
	 FSTR("alias for 'help'"),
#ifdef  CONFIG_SYS_LONGHELP
	FSTR(""),
#endif /* CONFIG_SYS_LONGHELP */
	NULL,
#ifdef CONFIG_AUTO_COMPLETE
	NULL,
#endif
},
/* Mark end of table */
CMD_TBL_END(cmd_tbl)
};