avr/command_tbl.c

   1 /*
   2  * (C) Copyright 2014 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_loadcpm3(cmd_tbl_t *, int, int, char * const []);
  20 extern command_ret_t do_loadihex(cmd_tbl_t *, int, int, char * const []);
  21 #if defined(CONFIG_CMD_LOADB)
  22 extern command_ret_t do_load_serial_bin(cmd_tbl_t *, int, int, char * const []);
  23 #endif
  24 extern command_ret_t do_go(cmd_tbl_t *, int, int, char * const []);
  25 extern command_ret_t do_restart(cmd_tbl_t *, int, int, char * const []);
  26 extern command_ret_t do_console(cmd_tbl_t *, int, int, char * const []);
  27 extern command_ret_t do_dump_mem(cmd_tbl_t *, int, int, char * const []);
  28 extern command_ret_t do_mem_mm_avr(cmd_tbl_t *, int, int, char * const []);
  29 extern command_ret_t do_mem_nm_avr(cmd_tbl_t *, int, int, char * const []);
  30 extern command_ret_t do_eep_cp(cmd_tbl_t *, int, int, char * const []);
  31 extern command_ret_t do_busreq_pulse(cmd_tbl_t *, int, int, char * const []);
  32 extern command_ret_t do_date(cmd_tbl_t *, int, int, char * const []);
  33 extern command_ret_t do_gpio(cmd_tbl_t *, int, int, char * const []);
  34 extern command_ret_t do_sd(cmd_tbl_t *, int, int, char * const []);
  35 extern command_ret_t do_fat_stat(cmd_tbl_t *, int, int, char * const []);
  36 extern command_ret_t do_fat_ls(cmd_tbl_t *, int, int, char * const []);
  37 //extern command_ret_t do_fat_read(cmd_tbl_t *, int, int, char * const []);
  38 //extern command_ret_t do_fat_write(cmd_tbl_t *, int, int, char * const []);
  39 extern command_ret_t do_fat_rw(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]]\ndate reset\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         printenv, CONFIG_SYS_MAXARGS,   1,      do_env_print,
 119         "print environment variables",
 120         "\n"
 121         "    - print values of all environment variables\n"
 122         "printenv name ...\n"
 123         "    - print value of environment variable 'name'",
 124         var_complete
 125 ),
 126 CMD_TBL_ITEM_COMPLETE(
 127         setenv, CONFIG_SYS_MAXARGS,     0,      do_env_set,
 128         "set environment variables",
 129         "name value ...\n"
 130         "    - set environment variable 'name' to 'value ...'\n"
 131         "setenv name\n"
 132         "    - delete environment variable 'name'",
 133         var_complete
 134 ),
 135 CMD_TBL_ITEM(
 136         saveenv,        1,      0,      do_env_save,
 137         "save environment variables to persistent storage",
 138         ""
 139 ),
 140 CMD_TBL_ITEM(
 141         defaultenv,     1,      0,      do_env_default,
 142         "set all environment variables to their default values",
 143         ""
 144 ),
 145
 146 CMD_TBL_ITEM(
 147         loadf,  1,      0,      do_loadf,
 148         "load srec_cat prepared image from controller flash",
 149         ""
 150 ),
 151 CMD_TBL_ITEM(
 152         loadcpm3, 3,    0,      do_loadcpm3,
 153         "load CPM3.SYS file",
 154         "[filename [common-base [banked-base]]] \n"
 155         "    Load CP/M 3 system file from FAT filesystem. This command makes\n"
 156         "    CPMLDR superfluous. Uses the following environment variable if set:\n"
 157         "    '"ENV_CPM3_SYSFILE"' File to load. Default is '"CONFIG_CPM3_SYSFILE"'.\n"
 158         "    '"ENV_CPM3_COMMON_BASE"' Default is '"CONFIG_CPM3_COMMON_BASE_STR"'.\n"
 159         "    '"ENV_CPM3_BANKED_BASE"' Default is '"CONFIG_CPM3_BANKED_BASE_STR"'.\n"
 160 ),
 161 CMD_TBL_ITEM(
 162         loadi,  2,      0,      do_loadihex,
 163         "load intel hex file over serial line",
 164         "[[-]offset]\n"
 165         "    - load Intel-Hex-Record file over serial line with offset 'offset'"
 166 ),
 167
 168 #if defined(CONFIG_CMD_LOADB)
 169 CMD_TBL_ITEM(
 170         loadb, 1, 0,    do_load_serial_bin,
 171         "load binary file over serial line (kermit mode)",
 172         "    - load binary file over serial line"
 173 ),
 174
 175 CMD_TBL_ITEM(
 176         loadx, 1, 0,    do_load_serial_bin,
 177         "load binary file over serial line (xmodem mode)",
 178         "    - load binary file over serial line"
 179 ),
 180
 181 CMD_TBL_ITEM(
 182         loady, 1, 0,    do_load_serial_bin,
 183         "load binary file over serial line (ymodem mode)",
 184         "    - load binary file over serial line"
 185 ),
 186 #endif  /* CONFIG_CMD_LOADB */
 187
 188 CMD_TBL_ITEM(
 189         go,     2,      0,      do_go,
 190         "start application at address 'addr'",
 191         "addr\n"
 192         "    - start application at address 'addr'"
 193 //      "\n"
 194 //      "      passing 'arg' as arguments"
 195 ),
 196 CMD_TBL_ITEM(
 197         reset,  1,      0,      do_reset,
 198         "Keep CPU in RESET state",
 199         ""
 200 ),
 201 CMD_TBL_ITEM(
 202         restart, 1, 1,  do_restart,
 203         "Perform RESET of the CPU",
 204         ""
 205 ),
 206 CMD_TBL_ITEM(
 207         connect, 1, 0,  do_console,
 208         "Connect to CPU console i/o",
 209         "\n"
 210         "    - type the escape character followed by Q to close the connection, \n"
 211         "      or followed by ? to see other options. The default escape character \n"
 212         "      is Ctrl-^ (0x1E). It can be changed by setting env var '"ENV_ESC_CHAR"'."
 213
 214 ),
 215
 216 CMD_TBL_ITEM(
 217         pin, CONFIG_SYS_MAXARGS, 1,     do_gpio,
 218         "Set or query pin state",
 219         "[-s] [<pins>]\n"
 220         "    - print cofiguration and state or frequency of pins\n"
 221         "      print all pins, if argument is omitted\n"
 222         "pin <pins> h[igh]|l[ow]\n"
 223         "    - config pins as output and set to level high or low\n"
 224         "pin <pins> ts|i[n]|p[ullup]\n"
 225         "    - config pins as input/tristate or input with pullup\n"
 226         "pin <pins> value[K|M][Hz]\n"
 227         "    - output a clock on pins\n"
 228         "      value is system clock divider or frequency, if 'Hz' is appended\n"
 229         "      divider is rounded down to next possible value (depends on pin)\n"
 230         "\n"
 231         "<pins> is a comma separated list of numbers or ranges, i.e. \"0,9,3-6\"\n"
 232 ),
 233
 234 CMD_TBL_ITEM(
 235         md,     3,      1,      do_mem_md,
 236         "memory display",
 237         "address [# of objects]"
 238 ),
 239 CMD_TBL_ITEM(
 240         mm,     2,      1,      do_mem_mm,
 241         "memory modify (auto-incrementing address)",
 242         "address"
 243 ),
 244 CMD_TBL_ITEM(
 245         nm,     2,      1,      do_mem_nm,
 246         "memory modify (constant address)",
 247         "address"
 248 ),
 249 CMD_TBL_ITEM(
 250         mw,     4,      1,      do_mem_mw,
 251         "memory write (fill)",
 252         "address value [count]"
 253 ),
 254 CMD_TBL_ITEM(
 255         cp,     4,      1,      do_mem_cp,
 256         "memory copy",
 257         "source target count"
 258 ),
 259 CMD_TBL_ITEM(
 260         cmp,    4,      1,      do_mem_cmp,
 261         "memory compare",
 262         "addr1 addr2 count"
 263 ),
 264 CMD_TBL_ITEM(
 265         base,   2,      0,      do_mem_base,
 266         "print or set address offset",
 267         "\n"
 268         "    - print address offset for memory commands\n"
 269         "base offset\n"
 270         "    - set address offset for memory commands to 'offset'"
 271 ),
 272 CMD_TBL_ITEM(
 273         mloop,  3,      1,      do_mem_loop,
 274         "infinite loop on address range",
 275         "address number_of_bytes"
 276 ),
 277 CMD_TBL_ITEM(
 278         mloopw, 4,      1,      do_mem_loopw,
 279         "infinite write loop on address range",
 280         "address number_of_bytes data_to_write"
 281 ),
 282
 283 #ifdef CONFIG_CMD_MEMTEST
 284 CMD_TBL_ITEM(
 285         mtest,  4,      1,      do_mem_mtest,
 286         "simple RAM read/write test",
 287         "[start [end [iterations]]]"
 288 ),
 289 #endif  /* CONFIG_CMD_MEMTEST */
 290
 291 #ifdef CONFIG_MX_CYCLIC
 292 CMD_TBL_ITEM(
 293         mdc,    4,      1,      do_mem_mdc,
 294         "memory display cyclic",
 295         "address count delay(ms)"
 296 ),
 297 CMD_TBL_ITEM(
 298         mwc,    4,      1,      do_mem_mdc,
 299         "memory write cyclic",
 300         "address value delay(ms)"
 301 ),
 302 #endif /* CONFIG_MX_CYCLIC */
 303
 304 CMD_TBL_ITEM(
 305         sd,   CONFIG_SYS_MAXARGS, 1, do_sd,
 306         "SD/MMC card handling commands",
 307         "<subcommand> args ...\n"
 308         "sd help\n"
 309         "    - print help on subcommands"
 310 ),
 311
 312 CMD_TBL_ITEM(
 313         fatstat,        2,      1,      do_fat_stat,
 314         "Show logical drive status",
 315         "dev"
 316 ),
 317 CMD_TBL_ITEM(
 318         fatls,  2,      1,      do_fat_ls,
 319         "Directory listing",
 320         "path"
 321 ),
 322 CMD_TBL_ITEM(
 323         fatload,        5,      0,      do_fat_rw,
 324         "load binary file from a dos filesystem",
 325         "<d:/path/filename> <addr> [bytes [pos]]\n"
 326         "    - Load binary file 'path/filename' on logical drive 'd'\n"
 327         "      to address 'addr' from dos filesystem.\n"
 328         "      'pos' gives the file position to start loading from.\n"
 329         "      If 'pos' is omitted, 0 is used. 'pos' requires 'bytes'.\n"
 330         "      'bytes' gives the size to load. If 'bytes' is 0 or omitted,\n"
 331         "      the load stops on end of file."
 332 ),
 333 CMD_TBL_ITEM(
 334         fatwrite,       4,      0,      do_fat_rw,
 335         "write file into a dos filesystem",
 336         "<d:/path/filename> <addr> <bytes>\n"
 337         "    - Write file to 'path/filename' on logical drive 'd' from RAM\n"
 338         "      starting at address 'addr'. 'bytes' gives the size to load.\n"
 339         "      If 'bytes' is 0 or omitted, the load stops on end of file."
 340 ),
 341
 342 CMD_TBL_ITEM(
 343         help,   CONFIG_SYS_MAXARGS,     1,      do_help,
 344         "print command description/usage",
 345         "\n"
 346         "       - print brief description of all commands\n"
 347         "help command ...\n"
 348         "       - print detailed usage of 'command'"
 349 ),
 350
 351 /* This does not use the CMD_TBL_ITEM macro as ? can't be used in symbol names */
 352         {FSTR("?"),   CONFIG_SYS_MAXARGS, 1, do_help,
 353          FSTR("alias for 'help'"),
 354 #ifdef  CONFIG_SYS_LONGHELP
 355         FSTR(""),
 356 #endif /* CONFIG_SYS_LONGHELP */
 357 #ifdef CONFIG_AUTO_COMPLETE
 358         0,
 359 #endif
 360 },
 361 /* Mark end of table */
 362 { 0 },
 363 };