2 * Copyright 2015 Freescale Semiconductor, Inc.
4 * SPDX-License-Identifier: GPL-2.0+
6 * Ethernet Switch commands
12 #include <env_flags.h>
15 static const char *ethsw_name;
17 #define ETHSW_PORT_STATS_HELP "ethsw [port <port_no>] statistics " \
18 "{ [help] | [clear] } - show an l2 switch port's statistics"
20 static int ethsw_port_stats_help_key_func(struct ethsw_command_def *parsed_cmd)
22 printf(ETHSW_PORT_STATS_HELP"\n");
24 return CMD_RET_SUCCESS;
27 #define ETHSW_LEARN_HELP "ethsw [port <port_no>] learning " \
28 "{ [help] | show | auto | disable } " \
29 "- enable/disable/show learning configuration on a port"
31 static int ethsw_learn_help_key_func(struct ethsw_command_def *parsed_cmd)
33 printf(ETHSW_LEARN_HELP"\n");
35 return CMD_RET_SUCCESS;
38 #define ETHSW_FDB_HELP "ethsw [port <port_no>] [vlan <vid>] fdb " \
39 "{ [help] | show | flush | { add | del } <mac> } " \
40 "- Add/delete a mac entry in FDB; use show to see FDB entries; " \
41 "if vlan <vid> is missing, VID 1 will be used"
43 static int ethsw_fdb_help_key_func(struct ethsw_command_def *parsed_cmd)
45 printf(ETHSW_FDB_HELP"\n");
47 return CMD_RET_SUCCESS;
50 #define ETHSW_PVID_HELP "ethsw [port <port_no>] " \
51 "pvid { [help] | show | <pvid> } " \
52 "- set/show PVID (ingress and egress VLAN tagging) for a port"
54 static int ethsw_pvid_help_key_func(struct ethsw_command_def *parsed_cmd)
56 printf(ETHSW_PVID_HELP"\n");
58 return CMD_RET_SUCCESS;
61 #define ETHSW_VLAN_HELP "ethsw [port <port_no>] vlan " \
62 "{ [help] | show | add <vid> | del <vid> } " \
63 "- add a VLAN to a port (VLAN members)"
65 static int ethsw_vlan_help_key_func(struct ethsw_command_def *parsed_cmd)
67 printf(ETHSW_VLAN_HELP"\n");
69 return CMD_RET_SUCCESS;
72 #define ETHSW_PORT_UNTAG_HELP "ethsw [port <port_no>] untagged " \
73 "{ [help] | show | all | none | pvid } " \
74 " - set egress tagging mod for a port"
76 static int ethsw_port_untag_help_key_func(struct ethsw_command_def *parsed_cmd)
78 printf(ETHSW_PORT_UNTAG_HELP"\n");
80 return CMD_RET_SUCCESS;
83 #define ETHSW_EGR_VLAN_TAG_HELP "ethsw [port <port_no>] egress tag " \
84 "{ [help] | show | pvid | classified } " \
85 "- Configure VID source for egress tag. " \
86 "Tag's VID could be the frame's classified VID or the PVID of the port"
88 static int ethsw_egr_tag_help_key_func(struct ethsw_command_def *parsed_cmd)
90 printf(ETHSW_EGR_VLAN_TAG_HELP"\n");
92 return CMD_RET_SUCCESS;
95 static struct keywords_to_function {
96 enum ethsw_keyword_id cmd_keyword[ETHSW_MAX_CMD_PARAMS];
98 int (*keyword_function)(struct ethsw_command_def *parsed_cmd);
105 .cmd_func_offset = offsetof(struct ethsw_command_func,
107 .keyword_function = NULL,
113 .cmd_func_offset = offsetof(struct ethsw_command_func,
115 .keyword_function = NULL,
121 .cmd_func_offset = offsetof(struct ethsw_command_func,
123 .keyword_function = NULL,
130 .cmd_func_offset = -1,
131 .keyword_function = ðsw_port_stats_help_key_func,
137 .cmd_func_offset = offsetof(struct ethsw_command_func,
139 .keyword_function = NULL,
146 .cmd_func_offset = offsetof(struct ethsw_command_func,
148 .keyword_function = NULL,
154 .cmd_func_offset = -1,
155 .keyword_function = ðsw_learn_help_key_func,
162 .cmd_func_offset = -1,
163 .keyword_function = ðsw_learn_help_key_func,
170 .cmd_func_offset = offsetof(struct ethsw_command_func,
172 .keyword_function = NULL,
179 .cmd_func_offset = offsetof(struct ethsw_command_func,
181 .keyword_function = NULL,
188 .cmd_func_offset = offsetof(struct ethsw_command_func,
190 .keyword_function = NULL,
196 .cmd_func_offset = -1,
197 .keyword_function = ðsw_fdb_help_key_func,
204 .cmd_func_offset = -1,
205 .keyword_function = ðsw_fdb_help_key_func,
212 .cmd_func_offset = offsetof(struct ethsw_command_func,
214 .keyword_function = NULL,
221 .cmd_func_offset = offsetof(struct ethsw_command_func,
223 .keyword_function = NULL,
228 ethsw_id_add_del_mac,
231 .cmd_func_offset = offsetof(struct ethsw_command_func,
233 .keyword_function = NULL,
238 ethsw_id_add_del_mac,
241 .cmd_func_offset = offsetof(struct ethsw_command_func,
243 .keyword_function = NULL,
249 .cmd_func_offset = -1,
250 .keyword_function = ðsw_pvid_help_key_func,
257 .cmd_func_offset = -1,
258 .keyword_function = ðsw_pvid_help_key_func,
265 .cmd_func_offset = offsetof(struct ethsw_command_func,
267 .keyword_function = NULL,
274 .cmd_func_offset = offsetof(struct ethsw_command_func,
276 .keyword_function = NULL,
282 .cmd_func_offset = -1,
283 .keyword_function = ðsw_vlan_help_key_func,
290 .cmd_func_offset = -1,
291 .keyword_function = ðsw_vlan_help_key_func,
298 .cmd_func_offset = offsetof(struct ethsw_command_func,
300 .keyword_function = NULL,
308 .cmd_func_offset = offsetof(struct ethsw_command_func,
310 .keyword_function = NULL,
318 .cmd_func_offset = offsetof(struct ethsw_command_func,
320 .keyword_function = NULL,
326 .cmd_func_offset = -1,
327 .keyword_function = ðsw_port_untag_help_key_func,
334 .cmd_func_offset = -1,
335 .keyword_function = ðsw_port_untag_help_key_func,
342 .cmd_func_offset = offsetof(struct ethsw_command_func,
344 .keyword_function = NULL,
351 .cmd_func_offset = offsetof(struct ethsw_command_func,
353 .keyword_function = NULL,
360 .cmd_func_offset = offsetof(struct ethsw_command_func,
362 .keyword_function = NULL,
369 .cmd_func_offset = offsetof(struct ethsw_command_func,
371 .keyword_function = NULL,
378 .cmd_func_offset = -1,
379 .keyword_function = ðsw_egr_tag_help_key_func,
387 .cmd_func_offset = -1,
388 .keyword_function = ðsw_egr_tag_help_key_func,
396 .cmd_func_offset = offsetof(struct ethsw_command_func,
398 .keyword_function = NULL,
406 .cmd_func_offset = offsetof(struct ethsw_command_func,
408 .keyword_function = NULL,
416 .cmd_func_offset = offsetof(struct ethsw_command_func,
418 .keyword_function = NULL,
422 struct keywords_optional {
423 int cmd_keyword[ETHSW_MAX_CMD_PARAMS];
448 static int keyword_match_gen(enum ethsw_keyword_id key_id, int argc, char
449 *const argv[], int *argc_nr,
450 struct ethsw_command_def *parsed_cmd);
451 static int keyword_match_port(enum ethsw_keyword_id key_id, int argc,
452 char *const argv[], int *argc_nr,
453 struct ethsw_command_def *parsed_cmd);
454 static int keyword_match_vlan(enum ethsw_keyword_id key_id, int argc,
455 char *const argv[], int *argc_nr,
456 struct ethsw_command_def *parsed_cmd);
457 static int keyword_match_pvid(enum ethsw_keyword_id key_id, int argc,
458 char *const argv[], int *argc_nr,
459 struct ethsw_command_def *parsed_cmd);
460 static int keyword_match_mac_addr(enum ethsw_keyword_id key_id, int argc,
461 char *const argv[], int *argc_nr,
462 struct ethsw_command_def *parsed_cmd);
465 * Define properties for each keyword;
466 * keep the order synced with enum ethsw_keyword_id
469 const char *keyword_name;
470 int (*match)(enum ethsw_keyword_id key_id, int argc, char *const argv[],
471 int *argc_nr, struct ethsw_command_def *parsed_cmd);
474 .keyword_name = "help",
475 .match = &keyword_match_gen,
477 .keyword_name = "show",
478 .match = &keyword_match_gen,
480 .keyword_name = "port",
481 .match = &keyword_match_port
483 .keyword_name = "enable",
484 .match = &keyword_match_gen,
486 .keyword_name = "disable",
487 .match = &keyword_match_gen,
489 .keyword_name = "statistics",
490 .match = &keyword_match_gen,
492 .keyword_name = "clear",
493 .match = &keyword_match_gen,
495 .keyword_name = "learning",
496 .match = &keyword_match_gen,
498 .keyword_name = "auto",
499 .match = &keyword_match_gen,
501 .keyword_name = "vlan",
502 .match = &keyword_match_vlan,
504 .keyword_name = "fdb",
505 .match = &keyword_match_gen,
507 .keyword_name = "add",
508 .match = &keyword_match_mac_addr,
510 .keyword_name = "del",
511 .match = &keyword_match_mac_addr,
513 .keyword_name = "flush",
514 .match = &keyword_match_gen,
516 .keyword_name = "pvid",
517 .match = &keyword_match_pvid,
519 .keyword_name = "untagged",
520 .match = &keyword_match_gen,
522 .keyword_name = "all",
523 .match = &keyword_match_gen,
525 .keyword_name = "none",
526 .match = &keyword_match_gen,
528 .keyword_name = "egress",
529 .match = &keyword_match_gen,
531 .keyword_name = "tag",
532 .match = &keyword_match_gen,
534 .keyword_name = "classified",
535 .match = &keyword_match_gen,
540 * Function used by an Ethernet Switch driver to set the functions
541 * that must be called by the parser when an ethsw command is given
543 int ethsw_define_functions(const struct ethsw_command_func *cmd_func)
547 int (*cmd_func_aux)(struct ethsw_command_def *);
549 if (!cmd_func->ethsw_name)
552 ethsw_name = cmd_func->ethsw_name;
554 for (i = 0; i < ARRAY_SIZE(ethsw_cmd_def); i++) {
556 * get the pointer to the function send by the Ethernet Switch
557 * driver that corresponds to the proper ethsw command
559 if (ethsw_cmd_def[i].keyword_function)
562 aux_p = (void *)cmd_func + ethsw_cmd_def[i].cmd_func_offset;
564 cmd_func_aux = (int (*)(struct ethsw_command_def *)) *aux_p;
565 ethsw_cmd_def[i].keyword_function = cmd_func_aux;
571 /* Generic function used to match a keyword only by a string */
572 static int keyword_match_gen(enum ethsw_keyword_id key_id, int argc,
573 char *const argv[], int *argc_nr,
574 struct ethsw_command_def *parsed_cmd)
576 if (strcmp(argv[*argc_nr], keyword[key_id].keyword_name) == 0) {
577 parsed_cmd->cmd_to_keywords[*argc_nr] = key_id;
584 /* Function used to match the command's port */
585 static int keyword_match_port(enum ethsw_keyword_id key_id, int argc,
586 char *const argv[], int *argc_nr,
587 struct ethsw_command_def *parsed_cmd)
591 if (!keyword_match_gen(key_id, argc, argv, argc_nr, parsed_cmd))
594 if (*argc_nr + 1 >= argc)
597 if (strict_strtoul(argv[*argc_nr + 1], 10, &val) != -EINVAL) {
598 parsed_cmd->port = val;
600 parsed_cmd->cmd_to_keywords[*argc_nr] = ethsw_id_port_no;
607 /* Function used to match the command's vlan */
608 static int keyword_match_vlan(enum ethsw_keyword_id key_id, int argc,
609 char *const argv[], int *argc_nr,
610 struct ethsw_command_def *parsed_cmd)
615 if (!keyword_match_gen(key_id, argc, argv, argc_nr, parsed_cmd))
618 if (*argc_nr + 1 >= argc)
621 if (strict_strtoul(argv[*argc_nr + 1], 10, &val) != -EINVAL) {
622 parsed_cmd->vid = val;
624 parsed_cmd->cmd_to_keywords[*argc_nr] = ethsw_id_vlan_no;
630 if (keyword_match_gen(ethsw_id_add, argc, argv, &aux, parsed_cmd))
631 parsed_cmd->cmd_to_keywords[*argc_nr + 1] = ethsw_id_add;
632 else if (keyword_match_gen(ethsw_id_del, argc, argv, &aux, parsed_cmd))
633 parsed_cmd->cmd_to_keywords[*argc_nr + 1] = ethsw_id_del;
637 if (*argc_nr + 2 >= argc)
640 if (strict_strtoul(argv[*argc_nr + 2], 10, &val) != -EINVAL) {
641 parsed_cmd->vid = val;
643 parsed_cmd->cmd_to_keywords[*argc_nr] = ethsw_id_add_del_no;
650 /* Function used to match the command's pvid */
651 static int keyword_match_pvid(enum ethsw_keyword_id key_id, int argc,
652 char *const argv[], int *argc_nr,
653 struct ethsw_command_def *parsed_cmd)
657 if (!keyword_match_gen(key_id, argc, argv, argc_nr, parsed_cmd))
660 if (*argc_nr + 1 >= argc)
663 if (strict_strtoul(argv[*argc_nr + 1], 10, &val) != -EINVAL) {
664 parsed_cmd->vid = val;
666 parsed_cmd->cmd_to_keywords[*argc_nr] = ethsw_id_pvid_no;
672 /* Function used to match the command's MAC address */
673 static int keyword_match_mac_addr(enum ethsw_keyword_id key_id, int argc,
674 char *const argv[], int *argc_nr,
675 struct ethsw_command_def *parsed_cmd)
677 if (!keyword_match_gen(key_id, argc, argv, argc_nr, parsed_cmd))
680 if ((*argc_nr + 1 >= argc) ||
681 !is_broadcast_ethaddr(parsed_cmd->ethaddr))
684 if (eth_validate_ethaddr_str(argv[*argc_nr + 1])) {
685 printf("Invalid MAC address: %s\n", argv[*argc_nr + 1]);
689 eth_parse_enetaddr(argv[*argc_nr + 1], parsed_cmd->ethaddr);
691 if (is_broadcast_ethaddr(parsed_cmd->ethaddr)) {
692 memset(parsed_cmd->ethaddr, 0xFF, sizeof(parsed_cmd->ethaddr));
696 parsed_cmd->cmd_to_keywords[*argc_nr + 1] = ethsw_id_add_del_mac;
701 /* Finds optional keywords and modifies *argc_va to skip them */
702 static void cmd_keywords_opt_check(const struct ethsw_command_def *parsed_cmd,
706 int keyw_opt_matched;
708 int const *cmd_keyw_p;
709 int const *cmd_keyw_opt_p;
711 /* remember the best match */
712 argc_val_max = *argc_val;
715 * check if our command's optional keywords match the optional
716 * keywords of an available command
718 for (i = 0; i < ARRAY_SIZE(ethsw_cmd_def); i++) {
719 keyw_opt_matched = 0;
720 cmd_keyw_p = &parsed_cmd->cmd_to_keywords[keyw_opt_matched];
721 cmd_keyw_opt_p = &cmd_opt_def[i].cmd_keyword[keyw_opt_matched];
724 * increase the number of keywords that
725 * matched with a command
727 while (keyw_opt_matched + *argc_val <
728 parsed_cmd->cmd_keywords_nr &&
729 *cmd_keyw_opt_p != ethsw_id_key_end &&
730 *(cmd_keyw_p + *argc_val) == *cmd_keyw_opt_p) {
737 * if all our optional command's keywords perfectly match an
738 * optional pattern, then we can move to the next defined
739 * keywords in our command; remember the one that matched the
740 * greatest number of keywords
742 if (keyw_opt_matched + *argc_val <=
743 parsed_cmd->cmd_keywords_nr &&
744 *cmd_keyw_opt_p == ethsw_id_key_end &&
745 *argc_val + keyw_opt_matched > argc_val_max)
746 argc_val_max = *argc_val + keyw_opt_matched;
749 *argc_val = argc_val_max;
753 * Finds the function to call based on keywords and
754 * modifies *argc_va to skip them
756 static void cmd_keywords_check(struct ethsw_command_def *parsed_cmd,
765 * check if our command's keywords match the
766 * keywords of an available command
768 for (i = 0; i < ARRAY_SIZE(ethsw_cmd_def); i++) {
770 cmd_keyw_p = &parsed_cmd->cmd_to_keywords[keyw_matched];
771 cmd_keyw_def_p = ðsw_cmd_def[i].cmd_keyword[keyw_matched];
774 * increase the number of keywords that
775 * matched with a command
777 while (keyw_matched + *argc_val < parsed_cmd->cmd_keywords_nr &&
778 *cmd_keyw_def_p != ethsw_id_key_end &&
779 *(cmd_keyw_p + *argc_val) == *cmd_keyw_def_p) {
786 * if all our command's keywords perfectly match an
787 * available command, then we get the function we need to call
788 * to configure the Ethernet Switch
790 if (keyw_matched && keyw_matched + *argc_val ==
791 parsed_cmd->cmd_keywords_nr &&
792 *cmd_keyw_def_p == ethsw_id_key_end) {
793 *argc_val += keyw_matched;
794 parsed_cmd->cmd_function =
795 ethsw_cmd_def[i].keyword_function;
801 /* find all the keywords in the command */
802 static int keywords_find(int argc, char * const argv[],
803 struct ethsw_command_def *parsed_cmd)
808 int rc = CMD_RET_SUCCESS;
810 for (i = 1; i < argc; i++) {
811 for (j = 0; j < ethsw_id_count; j++) {
812 if (keyword[j].match(j, argc, argv, &i, parsed_cmd))
817 /* if there is no keyword match for a word, the command is invalid */
818 for (i = 1; i < argc; i++)
819 if (parsed_cmd->cmd_to_keywords[i] == ethsw_id_key_end)
822 parsed_cmd->cmd_keywords_nr = argc;
825 /* get optional parameters first */
826 cmd_keywords_opt_check(parsed_cmd, &argc_val);
828 if (argc_val == parsed_cmd->cmd_keywords_nr)
829 return CMD_RET_USAGE;
832 * check the keywords and if a match is found,
833 * get the function to call
835 cmd_keywords_check(parsed_cmd, &argc_val);
837 /* error if not all commands' parameters were matched */
838 if (argc_val == parsed_cmd->cmd_keywords_nr) {
839 if (!parsed_cmd->cmd_function) {
840 printf("Command not available for: %s\n", ethsw_name);
841 rc = CMD_RET_FAILURE;
850 static void command_def_init(struct ethsw_command_def *parsed_cmd)
854 for (i = 0; i < ETHSW_MAX_CMD_PARAMS; i++)
855 parsed_cmd->cmd_to_keywords[i] = ethsw_id_key_end;
857 parsed_cmd->port = ETHSW_CMD_PORT_ALL;
858 parsed_cmd->vid = ETHSW_CMD_VLAN_ALL;
859 parsed_cmd->cmd_function = NULL;
861 /* We initialize the MAC address with the Broadcast address */
862 memset(parsed_cmd->ethaddr, 0xff, sizeof(parsed_cmd->ethaddr));
865 /* function to interpret commands starting with "ethsw " */
866 static int do_ethsw(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
868 struct ethsw_command_def parsed_cmd;
869 int rc = CMD_RET_SUCCESS;
871 if (argc == 1 || argc >= ETHSW_MAX_CMD_PARAMS)
872 return CMD_RET_USAGE;
874 command_def_init(&parsed_cmd);
876 rc = keywords_find(argc, argv, &parsed_cmd);
878 if (rc == CMD_RET_SUCCESS)
879 rc = parsed_cmd.cmd_function(&parsed_cmd);
884 #define ETHSW_PORT_CONF_HELP "[port <port_no>] { enable | disable | show } " \
885 "- enable/disable a port; show shows a port's configuration"
887 U_BOOT_CMD(ethsw, ETHSW_MAX_CMD_PARAMS, 0, do_ethsw,
888 "Ethernet l2 switch commands",
889 ETHSW_PORT_CONF_HELP"\n"
890 ETHSW_PORT_STATS_HELP"\n"
895 ETHSW_PORT_UNTAG_HELP"\n"
896 ETHSW_EGR_VLAN_TAG_HELP"\n"