Loading...
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 | /* * Copyright (c) 2015 Intel Corporation * * SPDX-License-Identifier: Apache-2.0 */ /** * @file * @brief Console handler implementation of shell.h API */ #include <zephyr.h> #include <stdio.h> #include <string.h> #include <console/console.h> #include <misc/printk.h> #include <misc/util.h> #ifdef CONFIG_UART_CONSOLE #include <console/uart_console.h> #endif #ifdef CONFIG_TELNET_CONSOLE #include <console/telnet_console.h> #endif #include <shell/shell.h> #define ARGC_MAX 10 #define COMMAND_MAX_LEN 50 #define MODULE_NAME_MAX_LEN 20 /* additional chars are " >" (include '\0' )*/ #define PROMPT_SUFFIX 3 #define PROMPT_MAX_LEN (MODULE_NAME_MAX_LEN + PROMPT_SUFFIX) /* command table is located in the dedicated memory segment (.shell_) */ extern struct shell_module __shell_cmd_start[]; extern struct shell_module __shell_cmd_end[]; #define NUM_OF_SHELL_ENTITIES (__shell_cmd_end - __shell_cmd_start) static const char *prompt; static char default_module_prompt[PROMPT_MAX_LEN]; static int default_module = -1; #define STACKSIZE CONFIG_CONSOLE_SHELL_STACKSIZE static K_THREAD_STACK_DEFINE(stack, STACKSIZE); static struct k_thread shell_thread; #define MAX_CMD_QUEUED CONFIG_CONSOLE_SHELL_MAX_CMD_QUEUED static struct console_input buf[MAX_CMD_QUEUED]; static struct k_fifo avail_queue; static struct k_fifo cmds_queue; static shell_cmd_function_t app_cmd_handler; static shell_prompt_function_t app_prompt_handler; static const char *get_prompt(void) { if (app_prompt_handler) { const char *str; str = app_prompt_handler(); if (str) { return str; } } if (default_module != -1) { if (__shell_cmd_start[default_module].prompt) { const char *ret; ret = __shell_cmd_start[default_module].prompt(); if (ret) { return ret; } } return default_module_prompt; } return prompt; } static void line_queue_init(void) { int i; for (i = 0; i < MAX_CMD_QUEUED; i++) { k_fifo_put(&avail_queue, &buf[i]); } } static size_t line2argv(char *str, char *argv[], size_t size) { size_t argc = 0; if (!strlen(str)) { return 0; } while (*str && *str == ' ') { str++; } if (!*str) { return 0; } argv[argc++] = str; while ((str = strchr(str, ' '))) { *str++ = '\0'; while (*str && *str == ' ') { str++; } if (!*str) { break; } argv[argc++] = str; if (argc == size) { printk("Too many parameters (max %zu)\n", size - 1); return 0; } } /* keep it POSIX style where argv[argc] is required to be NULL */ argv[argc] = NULL; return argc; } static int get_destination_module(const char *module_str) { int i; for (i = 0; i < NUM_OF_SHELL_ENTITIES; i++) { if (!strncmp(module_str, __shell_cmd_start[i].module_name, MODULE_NAME_MAX_LEN)) { return i; } } return -1; } /* For a specific command: argv[0] = module name, argv[1] = command name * If a default module was selected: argv[0] = command name */ static const char *get_command_and_module(char *argv[], int *module) { *module = -1; if (!argv[0]) { printk("Unrecognized command\n"); return NULL; } if (default_module == -1) { if (!argv[1] || argv[1][0] == '\0') { printk("Unrecognized command: %s\n", argv[0]); return NULL; } *module = get_destination_module(argv[0]); if (*module == -1) { printk("Illegal module %s\n", argv[0]); return NULL; } return argv[1]; } *module = default_module; return argv[0]; } static int show_cmd_help(char *argv[]) { const char *command = NULL; int module = -1; const struct shell_module *shell_module; int i; command = get_command_and_module(argv, &module); if ((module == -1) || (command == NULL)) { return 0; } shell_module = &__shell_cmd_start[module]; for (i = 0; shell_module->commands[i].cmd_name; i++) { if (!strcmp(command, shell_module->commands[i].cmd_name)) { printk("%s %s\n", shell_module->commands[i].cmd_name, shell_module->commands[i].help ? shell_module->commands[i].help : ""); return 0; } } printk("Unrecognized command: %s\n", argv[0]); return -EINVAL; } static void print_module_commands(const int module) { const struct shell_module *shell_module = &__shell_cmd_start[module]; int i; printk("help\n"); for (i = 0; shell_module->commands[i].cmd_name; i++) { printk("%s\n", shell_module->commands[i].cmd_name); } } static int show_help(int argc, char *argv[]) { int module; /* help per command */ if ((argc > 2) || ((default_module != -1) && (argc == 2))) { return show_cmd_help(&argv[1]); } /* help per module */ if ((argc == 2) || ((default_module != -1) && (argc == 1))) { if (default_module == -1) { module = get_destination_module(argv[1]); if (module == -1) { printk("Illegal module %s\n", argv[1]); return -EINVAL; } } else { module = default_module; } print_module_commands(module); printk("\nEnter 'exit' to leave current module.\n"); } else { /* help for all entities */ printk("Available modules:\n"); for (module = 0; module < NUM_OF_SHELL_ENTITIES; module++) { printk("%s\n", __shell_cmd_start[module].module_name); } printk("\nTo select a module, enter 'select <module name>'.\n"); } return 0; } static int set_default_module(const char *name) { int module; if (strlen(name) > MODULE_NAME_MAX_LEN) { printk("Module name %s is too long, default is not changed\n", name); return -EINVAL; } module = get_destination_module(name); if (module == -1) { printk("Illegal module %s, default is not changed\n", name); return -EINVAL; } default_module = module; strncpy(default_module_prompt, name, MODULE_NAME_MAX_LEN); strcat(default_module_prompt, "> "); return 0; } static int select_module(int argc, char *argv[]) { if (argc == 1) { default_module = -1; return 0; } return set_default_module(argv[1]); } static int exit_module(int argc, char *argv[]) { if (argc == 1) { default_module = -1; } return 0; } static shell_cmd_function_t get_cb(int *argc, char *argv[], int *module) { const char *first_string = argv[0]; const struct shell_module *shell_module; const char *command; int i; if (!first_string || first_string[0] == '\0') { printk("Illegal parameter\n"); return NULL; } if (!strcmp(first_string, "help")) { return show_help; } if (!strcmp(first_string, "select")) { return select_module; } if (!strcmp(first_string, "exit")) { return exit_module; } if ((*argc == 1) && (default_module == -1)) { printk("Missing parameter\n"); return NULL; } command = get_command_and_module(argv, module); if ((*module == -1) || (command == NULL)) { return NULL; } shell_module = &__shell_cmd_start[*module]; for (i = 0; shell_module->commands[i].cmd_name; i++) { if (!strcmp(command, shell_module->commands[i].cmd_name)) { return shell_module->commands[i].cb; } } return NULL; } static inline void print_cmd_unknown(char *argv) { printk("Unrecognized command: %s\n", argv); printk("Type 'help' for list of available commands\n"); } int shell_exec(char *line) { char *argv[ARGC_MAX + 1]; int argc; int module = default_module; int err; shell_cmd_function_t cb; argc = line2argv(line, argv, ARRAY_SIZE(argv)); if (!argc) { return -EINVAL; } err = argc; cb = get_cb(&argc, argv, &module); if (!cb) { if (app_cmd_handler != NULL) { cb = app_cmd_handler; } else { print_cmd_unknown(argv[0]); return -EINVAL; } } /* Execute callback with arguments */ if (module != -1 && module != default_module) { /* Ajust parameters to point to the actual command */ err = cb(argc - 1, &argv[1]); } else { err = cb(argc, argv); } if (err < 0) { show_cmd_help(argv); } return err; } static void shell(void *p1, void *p2, void *p3) { ARG_UNUSED(p1); ARG_UNUSED(p2); ARG_UNUSED(p3); while (1) { struct console_input *cmd; printk("%s", get_prompt()); cmd = k_fifo_get(&cmds_queue, K_FOREVER); shell_exec(cmd->line); k_fifo_put(&avail_queue, cmd); } } static int get_command_to_complete(char *str, char **command_prefix) { char dest_str[MODULE_NAME_MAX_LEN]; int dest = -1; char *start; /* remove ' ' at the beginning of the line */ while (*str && *str == ' ') { str++; } if (!*str) { return -1; } start = str; if (default_module != -1) { dest = default_module; /* caller function already checks str len and put '\0' */ *command_prefix = str; } /* * In case of a default module: only one parameter is possible. * Otherwise, only two parameters are possibles. */ str = strchr(str, ' '); if (default_module != -1) { return (str == NULL) ? dest : -1; } if (str == NULL) { return -1; } if ((str - start + 1) >= MODULE_NAME_MAX_LEN) { return -1; } strncpy(dest_str, start, (str - start + 1)); dest_str[str - start] = '\0'; dest = get_destination_module(dest_str); if (dest == -1) { return -1; } str++; /* caller func has already checked str len and put '\0' at the end */ *command_prefix = str; str = strchr(str, ' '); /* only two parameters are possibles in case of no default module */ return (str == NULL) ? dest : -1; } static u8_t completion(char *line, u8_t len) { const char *first_match = NULL; int common_chars = -1, space = 0; int i, dest, command_len; const struct shell_module *module; char *command_prefix; if (len >= (MODULE_NAME_MAX_LEN + COMMAND_MAX_LEN - 1)) { return 0; } /* * line to completion is not ended by '\0' as the line that gets from * k_fifo_get function */ line[len] = '\0'; dest = get_command_to_complete(line, &command_prefix); if (dest == -1) { return 0; } command_len = strlen(command_prefix); module = &__shell_cmd_start[dest]; for (i = 0; module->commands[i].cmd_name; i++) { int j; if (strncmp(command_prefix, module->commands[i].cmd_name, command_len)) { continue; } if (!first_match) { first_match = module->commands[i].cmd_name; continue; } /* more commands match, print first match */ if (first_match && (common_chars < 0)) { printk("\n%s\n", first_match); common_chars = strlen(first_match); } /* cut common part of matching names */ for (j = 0; j < common_chars; j++) { if (first_match[j] != module->commands[i].cmd_name[j]) { break; } } common_chars = j; printk("%s\n", module->commands[i].cmd_name); } /* no match, do nothing */ if (!first_match) { return 0; } if (common_chars >= 0) { /* multiple match, restore prompt */ printk("%s", get_prompt()); printk("%s", line); } else { common_chars = strlen(first_match); space = 1; } /* complete common part */ for (i = command_len; i < common_chars; i++) { printk("%c", first_match[i]); line[len++] = first_match[i]; } /* for convenience add space after command */ if (space) { printk(" "); line[len] = ' '; } return common_chars - command_len + space; } void shell_init(const char *str) { k_fifo_init(&cmds_queue); k_fifo_init(&avail_queue); line_queue_init(); prompt = str ? str : ""; k_thread_create(&shell_thread, stack, STACKSIZE, shell, NULL, NULL, NULL, K_PRIO_COOP(7), 0, K_NO_WAIT); /* Register serial console handler */ #ifdef CONFIG_UART_CONSOLE uart_register_input(&avail_queue, &cmds_queue, completion); #endif #ifdef CONFIG_TELNET_CONSOLE telnet_register_input(&avail_queue, &cmds_queue, completion); #endif } /** @brief Optionally register an app default cmd handler. * * @param handler To be called if no cmd found in cmds registered with * shell_init. */ void shell_register_app_cmd_handler(shell_cmd_function_t handler) { app_cmd_handler = handler; } void shell_register_prompt_handler(shell_prompt_function_t handler) { app_prompt_handler = handler; } void shell_register_default_module(const char *name) { int result = set_default_module(name); if (result != -1) { printk("\n%s", default_module_prompt); } } |