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