avr/command_tbl.c

   1 /*
   2  * (C) Copyright 2014-2016 Leo C. <erbl259-lmu@yahoo.de>
   3  *
   4  * SPDX-License-Identifier:     GPL-2.0
   5  */
   6
   7 #include "common.h"
   8 #include "command.h"
   9 #include "cmd_mem.h"
  10
  11 extern command_ret_t do_help(cmd_tbl_t *, int, int, char * const []);
  12 extern command_ret_t do_echo(cmd_tbl_t *, int, int, char * const []);
  13 extern command_ret_t do_sleep(cmd_tbl_t *, int, int, char * const []);
  14 extern command_ret_t do_env_print(cmd_tbl_t *, int, int, char * const []);
  15 extern command_ret_t do_env_default(cmd_tbl_t *, int, int, char * const []);
  16 extern command_ret_t do_env_set(cmd_tbl_t *, int, int, char * const []);
  17 extern command_ret_t do_env_save(cmd_tbl_t *, int, int, char * const []);
  18 extern command_ret_t do_loadf(cmd_tbl_t *, int, int, char * const []);
  19 extern command_ret_t do_bootcf(cmd_tbl_t *, int, int, char * const []);
  20 extern command_ret_t do_loadcpm3(cmd_tbl_t *, int, int, char * const []);
  21 extern command_ret_t do_loadihex(cmd_tbl_t *, int, int, char * const []);
  22 #if defined(CONFIG_CMD_LOADB)
  23 extern command_ret_t do_load_serial_bin(cmd_tbl_t *, int, int, char * const []);
  24 #endif
  25 extern command_ret_t do_go(cmd_tbl_t *, int, int, char * const []);
  26 extern command_ret_t do_restart(cmd_tbl_t *, int, int, char * const []);
  27 extern command_ret_t do_console(cmd_tbl_t *, int, int, char * const []);
  28 extern command_ret_t do_dump_mem(cmd_tbl_t *, int, int, char * const []);
  29 extern command_ret_t do_mem_mm_avr(cmd_tbl_t *, int, int, char * const []);
  30 extern command_ret_t do_mem_nm_avr(cmd_tbl_t *, int, int, char * const []);
  31 extern command_ret_t do_eep_cp(cmd_tbl_t *, int, int, char * const []);
  32 extern command_ret_t do_busreq_pulse(cmd_tbl_t *, int, int, char * const []);
  33 extern command_ret_t do_date(cmd_tbl_t *, int, int, char * const []);
  34 extern command_ret_t do_gpio(cmd_tbl_t *, int, int, char * const []);
  35 extern command_ret_t do_sd(cmd_tbl_t *, int, int, char * const []);
  36 extern command_ret_t do_fat(cmd_tbl_t *, int, int, char * const []);
  37 extern command_ret_t do_run(cmd_tbl_t *, int, int, char * const []);
  38 extern command_ret_t do_source(cmd_tbl_t *, int, int, char * const []);
  39 extern command_ret_t do_attach(cmd_tbl_t *, int, int, char * const []);
  40
  41 #ifdef CONFIG_SYS_LONGHELP
  42 const FLASH char sd_help_text[] =
  43         "bla \t- do bla\n"
  44         ;
  45 #endif /* CONFIG_SYS_LONGHELP */
  46
  47
  48 cmd_tbl_t cmd_tbl[] = {
  49
  50 CMD_TBL_ITEM(
  51         date,   2,      1,      do_date,
  52         "get/set date & time",
  53         "[MMDDhhmm[[CC]YY][.ss]]\n"
  54         "  - without arguments: print date & time\n"
  55         "  - with numeric argument: set the system date & time\n"
  56 ),
  57
  58 #ifdef DEBUG
  59
  60 CMD_TBL_ITEM(
  61         !mdr,   3,      1,      do_dump_mem,
  62         "RAM dump",
  63         "address [count]"
  64 ),
  65 CMD_TBL_ITEM(
  66         !mde,   3,      1,      do_dump_mem,
  67         "EEPROM dump",
  68         "address [count]"
  69 ),
  70 CMD_TBL_ITEM(
  71         !mdf,   3,      1,      do_dump_mem,
  72         "FLASH dump",
  73         "address [count]"
  74 ),
  75 CMD_TBL_ITEM(
  76         !cpe,   4,      0,      do_eep_cp,
  77         "EEPROM copy",
  78         "source target count"
  79 ),
  80 CMD_TBL_ITEM(
  81         !mm,    2,      1,      do_mem_mm_avr,
  82         "avr memory modify (auto-incrementing address)",
  83         "address"
  84 ),
  85 CMD_TBL_ITEM(
  86         !nm,    2,      1,      do_mem_nm_avr,
  87         "avr memory modify (constant address)",
  88         "address"
  89 ),
  90 #endif
  91 CMD_TBL_ITEM(
  92         mstep,  2,      1,      do_busreq_pulse,
  93         "execute one M cycle",
  94         "[count]\n"
  95         "     - repeat count times"
  96 ),
  97 CMD_TBL_ITEM(
  98         echo,   CONFIG_SYS_MAXARGS,     1,      do_echo,
  99         "display a line of text",
 100         "[-n] [argument ...]\n"
 101         "- echo the argument(s) to console.\n"
 102         "  -n  do not output the trailing newline"
 103 ),
 104 CMD_TBL_ITEM(
 105         sleep ,    2,    1,     do_sleep,
 106         "delay execution for some time",
 107         "N[m][s]\n"
 108         "    - delay execution for decimal N (milli) seconds"
 109 ),
 110 CMD_TBL_ITEM_COMPLETE(
 111         run,    CONFIG_SYS_MAXARGS,     1,      do_run,
 112         "run commands in an environment variable",
 113         "var [...]\n"
 114         "    - run the commands in the environment variable(s) 'var'",
 115         var_complete
 116 ),
 117 CMD_TBL_ITEM_COMPLETE(
 118         source, CONFIG_SYS_MAXARGS,     1,      do_source,
 119         "run commands from a file",
 120         "filename\n"
 121         "    - run the commands in the script file 'filename'",
 122         var_complete
 123 ),
 124 CMD_TBL_ITEM_COMPLETE(
 125         printenv, CONFIG_SYS_MAXARGS,   1,      do_env_print,
 126         "print environment variables",
 127         "\n"
 128         "    - print values of all environment variables\n"
 129         "printenv name ...\n"
 130         "    - print value of environment variable 'name'",
 131         var_complete
 132 ),
 133 CMD_TBL_ITEM_COMPLETE(
 134         setenv, CONFIG_SYS_MAXARGS,     0,      do_env_set,
 135         "set environment variables",
 136         "name value ...\n"
 137         "    - set environment variable 'name' to 'value ...'\n"
 138         "setenv name\n"
 139         "    - delete environment variable 'name'",
 140         var_complete
 141 ),
 142 CMD_TBL_ITEM(
 143         saveenv,        1,      0,      do_env_save,
 144         "save environment variables to persistent storage",
 145         ""
 146 ),
 147 CMD_TBL_ITEM(
 148         defaultenv,     1,      0,      do_env_default,
 149         "set all environment variables to their default values",
 150         ""
 151 ),
 152
 153 CMD_TBL_ITEM(
 154         loadf,  1,      0,      do_loadf,
 155         "load srec_cat prepared image from controller flash",
 156         ""
 157 ),
 158 CMD_TBL_ITEM(
 159         bootcf, CONFIG_SYS_MAXARGS,     0,      do_bootcf,
 160         "boot from cf card",
 161         "[options]\n"
 162         "    Load a number of sectors from the first CP/M partition and jump to\n"
 163         "    the load address.\n"
 164         "    -a ADDRESS\n"
 165         "            Load and start address (default 100 hex)\n"
 166         "    -s NUM\n"
 167         "            First sector of partition to load (0..255, default 0)\n"
 168         "    -c NUM\n"
 169         "            Number of sectors to load (1..127, default 7)\n"
 170         "    -i NUM\n"
 171         "            Partition type to look for (default 52 hex)\n"
 172         "    -n\n"
 173         "            Load only, do not execute\n"
 174         "    -t NUM\n"
 175         "            Timeout for IDE commands (1..65535, default 10000)\n"
 176         "    -v verbose\n"
 177         "            TODO: be verbose"
 178 ),
 179 CMD_TBL_ITEM(
 180         loadcpm3, 3,    0,      do_loadcpm3,
 181         "load CPM3.SYS file",
 182         "[filename [common-base [banked-base]]] \n"
 183         "    - Load CP/M 3 system file from FAT filesystem. This command makes\n"
 184         "      CPMLDR superfluous. Uses the following environment variables if set:\n"
 185         "         '"ENV_CPM3_SYSFILE"' File to load. Default is '"CONFIG_CPM3_SYSFILE"'.\n"
 186         "         '"ENV_CPM3_BANKED_BASE"' Default is '"CONFIG_CPM3_BANKED_BASE_STR"'.\n"
 187         "      Sets the following environment variables after loading:\n"
 188         "         '"ENV_CPM3_COMMON_BASE"'\n"
 189         "         '"ENV_STARTADDRESS"'"
 190 ),
 191 CMD_TBL_ITEM(
 192         loadi,  2,      0,      do_loadihex,
 193         "load intel hex file over serial line",
 194         "[[-]offset]\n"
 195         "    - load Intel-Hex-Record file over serial line with offset 'offset'"
 196 ),
 197
 198 #if defined(CONFIG_CMD_LOADB)
 199 CMD_TBL_ITEM(
 200         loadb, 1, 0,    do_load_serial_bin,
 201         "load binary file over serial line (kermit mode)",
 202         "    - load binary file over serial line"
 203 ),
 204
 205 CMD_TBL_ITEM(
 206         loadx, 1, 0,    do_load_serial_bin,
 207         "load binary file over serial line (xmodem mode)",
 208         "    - load binary file over serial line"
 209 ),
 210
 211 CMD_TBL_ITEM(
 212         loady, 1, 0,    do_load_serial_bin,
 213         "load binary file over serial line (ymodem mode)",
 214         "    - load binary file over serial line"
 215 ),
 216 #endif  /* CONFIG_CMD_LOADB */
 217
 218 CMD_TBL_ITEM(
 219         go,     2,      0,      do_go,
 220         "start application at address 'addr'",
 221         "addr\n"
 222         "    - start application at address 'addr'"
 223 //      "\n"
 224 //      "      passing 'arg' as arguments"
 225 ),
 226 CMD_TBL_ITEM(
 227         reset,  1,      0,      do_reset,
 228         "Keep CPU in RESET state",
 229         ""
 230 ),
 231 CMD_TBL_ITEM(
 232         restart, 1, 1,  do_restart,
 233         "Perform RESET of the CPU",
 234         ""
 235 ),
 236 CMD_TBL_ITEM(
 237         connect, 1, 0,  do_console,
 238         "Connect to CPU console i/o",
 239         "\n"
 240         "    - type the escape character followed by Q to close the connection, \n"
 241         "      or followed by ? to see other options. The default escape character \n"
 242         "      is Ctrl-^ (0x1E). It can be changed by setting env var '"ENV_ESC_CHAR"'."
 243
 244 ),
 245
 246 CMD_TBL_ITEM(
 247         pin, CONFIG_SYS_MAXARGS, 1,     do_gpio,
 248         "Set or query pin state",
 249         "[-s] [<pins>]\n"
 250         "    - print cofiguration and state or frequency of pins\n"
 251         "      print all pins, if argument is omitted\n"
 252         "pin <pins> h[igh]|l[ow]\n"
 253         "    - config pins as output and set to level high or low\n"
 254         "pin <pins> ts|i[n]|p[ullup]\n"
 255         "    - config pins as input/tristate or input with pullup\n"
 256         "pin <pins> value[K|M][Hz]\n"
 257         "    - output a clock on pins\n"
 258         "      value is system clock divider or frequency, if 'Hz' is appended\n"
 259         "      divider is rounded down to next possible value (depends on pin)\n"
 260         "\n"
 261         "<pins> is a comma separated list of numbers or ranges, i.e. \"0,9,3-6\"\n"
 262 ),
 263
 264 CMD_TBL_ITEM(
 265         md,     3,      1,      do_mem_md,
 266         "memory display",
 267         "address [# of objects]"
 268 ),
 269 CMD_TBL_ITEM(
 270         mm,     2,      1,      do_mem_mm,
 271         "memory modify (auto-incrementing address)",
 272         "address"
 273 ),
 274 CMD_TBL_ITEM(
 275         nm,     2,      1,      do_mem_nm,
 276         "memory modify (constant address)",
 277         "address"
 278 ),
 279 CMD_TBL_ITEM(
 280         mw,     CONFIG_SYS_MAXARGS,     1,      do_mem_mw,
 281         "memory write (fill)",
 282         "[-bwl] address value [count]\n"
 283         "   -b  write value as byte (8 bit, default)\n"
 284         "   -w  write value as word (16 bit)\n"
 285         "   -l  write value as long (32 bit)"
 286 ),
 287 CMD_TBL_ITEM(
 288         cp,     4,      1,      do_mem_cp,
 289         "memory copy",
 290         "source target count"
 291 ),
 292 CMD_TBL_ITEM(
 293         cmp,    4,      1,      do_mem_cmp,
 294         "memory compare",
 295         "addr1 addr2 count"
 296 ),
 297 CMD_TBL_ITEM(
 298         base,   2,      0,      do_mem_base,
 299         "print or set address offset",
 300         "\n"
 301         "    - print address offset for memory commands\n"
 302         "base offset\n"
 303         "    - set address offset for memory commands to 'offset'"
 304 ),
 305 CMD_TBL_ITEM(
 306         mloop,  3,      1,      do_mem_loop,
 307         "infinite loop on address range",
 308         "address number_of_bytes"
 309 ),
 310 CMD_TBL_ITEM(
 311         mloopw, 4,      1,      do_mem_loopw,
 312         "infinite write loop on address range",
 313         "address number_of_bytes data_to_write"
 314 ),
 315
 316 #ifdef CONFIG_CMD_MEMTEST
 317 CMD_TBL_ITEM(
 318         mtest,  4,      1,      do_mem_mtest,
 319         "simple RAM read/write test",
 320         "[start [end [iterations]]]"
 321 ),
 322 #endif  /* CONFIG_CMD_MEMTEST */
 323
 324 #ifdef CONFIG_MX_CYCLIC
 325 CMD_TBL_ITEM(
 326         mdc,    4,      1,      do_mem_mdc,
 327         "memory display cyclic",
 328         "address count delay(ms)"
 329 ),
 330 CMD_TBL_ITEM(
 331         mwc,    CONFIG_SYS_MAXARGS,     1,      do_mem_mdc,
 332         "memory write cyclic",
 333         "[-bwl] address value delay(ms)\n"
 334         "   -b  write value as byte (8 bit, default)\n"
 335         "   -w  write value as word (16 bit)\n"
 336         "   -l  write value as long (32 bit)"
 337 ),
 338 #endif /* CONFIG_MX_CYCLIC */
 339
 340 CMD_TBL_ITEM(
 341         sd,   CONFIG_SYS_MAXARGS, 1, do_sd,
 342         "SD/MMC card handling commands",
 343         "<subcommand> args ...\n"
 344         "sd help\n"
 345         "    - print help on subcommands"
 346 ),
 347 CMD_TBL_ITEM(
 348         fat,   CONFIG_SYS_MAXARGS, 1, do_fat,
 349         "fat filesystem commands",
 350         "<subcommand> args ...\n"
 351         "fat help\n"
 352         "    - print help on subcommands"
 353 ),
 354
 355 CMD_TBL_ITEM(
 356         attach, CONFIG_SYS_MAXARGS,     1,      do_attach,
 357         "attach filesystem image file to CP/M drive",
 358         "[-rw] [-o options] dsk<n> diskfile\n"
 359         "    Attach diskfile to dsk<n>, where n in 0..7\n"
 360         "    -r      File is read only (write protected)\n"
 361         "    -w      File is read/write (default)\n"
 362         "    -o options\n"
 363         "            Options is a comma-separated list of\n"
 364         "            ro, rw, debug, nodebug\n"
 365         "\n"
 366         "attach [-rw] -o reattach[,other options] dsk<n>\n"
 367         "    Change options for dsk<n>.\n"
 368         "    Options as above.\n"
 369         "\n"
 370         "attach -d -a|dsk<n>\n"
 371         "detach -a|dsk<n>\n"
 372         "    Detach diskfile from dsk<n>.\n"
 373         "    -a      Detach all.\n"
 374         "\n"
 375         "attach\n"
 376         "    Without arguments, list current assignments\n"
 377 ),
 378 CMD_TBL_ITEM(
 379         detach, 2,      1,      do_attach,
 380         "detach file from CP/M drive",
 381         "dsk<n>]\n"
 382         "    - alias for 'attach -d dsk<n>'"
 383 ),
 384
 385 CMD_TBL_ITEM(
 386         help,   CONFIG_SYS_MAXARGS,     1,      do_help,
 387         "print command description/usage",
 388         "\n"
 389         "       - print brief description of all commands\n"
 390         "help command ...\n"
 391         "       - print detailed usage of 'command'"
 392 ),
 393
 394 /* This does not use the CMD_TBL_ITEM macro as ? can't be used in symbol names */
 395         {FSTR("?"),   CONFIG_SYS_MAXARGS, 1, do_help,
 396          FSTR("alias for 'help'"),
 397 #ifdef  CONFIG_SYS_LONGHELP
 398         FSTR(""),
 399 #endif /* CONFIG_SYS_LONGHELP */
 400 #ifdef CONFIG_AUTO_COMPLETE
 401         0,
 402 #endif
 403 },
 404 /* Mark end of table */
 405 { 0 },
 406 };