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 #define ETHSW_VLAN_FDB_HELP "ethsw vlan fdb " \
96 "{ [help] | show | shared | private } " \
97 "- make VLAN learning shared or private"
99 static int ethsw_vlan_learn_help_key_func(struct ethsw_command_def *parsed_cmd)
101 printf(ETHSW_VLAN_FDB_HELP"\n");
103 return CMD_RET_SUCCESS;
106 static struct keywords_to_function {
107 enum ethsw_keyword_id cmd_keyword[ETHSW_MAX_CMD_PARAMS];
109 int (*keyword_function)(struct ethsw_command_def *parsed_cmd);
110 } ethsw_cmd_def[] = {
116 .cmd_func_offset = offsetof(struct ethsw_command_func,
118 .keyword_function = NULL,
124 .cmd_func_offset = offsetof(struct ethsw_command_func,
126 .keyword_function = NULL,
132 .cmd_func_offset = offsetof(struct ethsw_command_func,
134 .keyword_function = NULL,
141 .cmd_func_offset = -1,
142 .keyword_function = ðsw_port_stats_help_key_func,
148 .cmd_func_offset = offsetof(struct ethsw_command_func,
150 .keyword_function = NULL,
157 .cmd_func_offset = offsetof(struct ethsw_command_func,
159 .keyword_function = NULL,
165 .cmd_func_offset = -1,
166 .keyword_function = ðsw_learn_help_key_func,
173 .cmd_func_offset = -1,
174 .keyword_function = ðsw_learn_help_key_func,
181 .cmd_func_offset = offsetof(struct ethsw_command_func,
183 .keyword_function = NULL,
190 .cmd_func_offset = offsetof(struct ethsw_command_func,
192 .keyword_function = NULL,
199 .cmd_func_offset = offsetof(struct ethsw_command_func,
201 .keyword_function = NULL,
207 .cmd_func_offset = -1,
208 .keyword_function = ðsw_fdb_help_key_func,
215 .cmd_func_offset = -1,
216 .keyword_function = ðsw_fdb_help_key_func,
223 .cmd_func_offset = offsetof(struct ethsw_command_func,
225 .keyword_function = NULL,
232 .cmd_func_offset = offsetof(struct ethsw_command_func,
234 .keyword_function = NULL,
239 ethsw_id_add_del_mac,
242 .cmd_func_offset = offsetof(struct ethsw_command_func,
244 .keyword_function = NULL,
249 ethsw_id_add_del_mac,
252 .cmd_func_offset = offsetof(struct ethsw_command_func,
254 .keyword_function = NULL,
260 .cmd_func_offset = -1,
261 .keyword_function = ðsw_pvid_help_key_func,
268 .cmd_func_offset = -1,
269 .keyword_function = ðsw_pvid_help_key_func,
276 .cmd_func_offset = offsetof(struct ethsw_command_func,
278 .keyword_function = NULL,
285 .cmd_func_offset = offsetof(struct ethsw_command_func,
287 .keyword_function = NULL,
293 .cmd_func_offset = -1,
294 .keyword_function = ðsw_vlan_help_key_func,
301 .cmd_func_offset = -1,
302 .keyword_function = ðsw_vlan_help_key_func,
309 .cmd_func_offset = offsetof(struct ethsw_command_func,
311 .keyword_function = NULL,
319 .cmd_func_offset = offsetof(struct ethsw_command_func,
321 .keyword_function = NULL,
329 .cmd_func_offset = offsetof(struct ethsw_command_func,
331 .keyword_function = NULL,
337 .cmd_func_offset = -1,
338 .keyword_function = ðsw_port_untag_help_key_func,
345 .cmd_func_offset = -1,
346 .keyword_function = ðsw_port_untag_help_key_func,
353 .cmd_func_offset = offsetof(struct ethsw_command_func,
355 .keyword_function = NULL,
362 .cmd_func_offset = offsetof(struct ethsw_command_func,
364 .keyword_function = NULL,
371 .cmd_func_offset = offsetof(struct ethsw_command_func,
373 .keyword_function = NULL,
380 .cmd_func_offset = offsetof(struct ethsw_command_func,
382 .keyword_function = NULL,
389 .cmd_func_offset = -1,
390 .keyword_function = ðsw_egr_tag_help_key_func,
398 .cmd_func_offset = -1,
399 .keyword_function = ðsw_egr_tag_help_key_func,
407 .cmd_func_offset = offsetof(struct ethsw_command_func,
409 .keyword_function = NULL,
417 .cmd_func_offset = offsetof(struct ethsw_command_func,
419 .keyword_function = NULL,
427 .cmd_func_offset = offsetof(struct ethsw_command_func,
429 .keyword_function = NULL,
436 .cmd_func_offset = -1,
437 .keyword_function = ðsw_vlan_learn_help_key_func,
445 .cmd_func_offset = -1,
446 .keyword_function = ðsw_vlan_learn_help_key_func,
454 .cmd_func_offset = offsetof(struct ethsw_command_func,
456 .keyword_function = NULL,
464 .cmd_func_offset = offsetof(struct ethsw_command_func,
466 .keyword_function = NULL,
474 .cmd_func_offset = offsetof(struct ethsw_command_func,
476 .keyword_function = NULL,
480 struct keywords_optional {
481 int cmd_keyword[ETHSW_MAX_CMD_PARAMS];
506 static int keyword_match_gen(enum ethsw_keyword_id key_id, int argc, char
507 *const argv[], int *argc_nr,
508 struct ethsw_command_def *parsed_cmd);
509 static int keyword_match_port(enum ethsw_keyword_id key_id, int argc,
510 char *const argv[], int *argc_nr,
511 struct ethsw_command_def *parsed_cmd);
512 static int keyword_match_vlan(enum ethsw_keyword_id key_id, int argc,
513 char *const argv[], int *argc_nr,
514 struct ethsw_command_def *parsed_cmd);
515 static int keyword_match_pvid(enum ethsw_keyword_id key_id, int argc,
516 char *const argv[], int *argc_nr,
517 struct ethsw_command_def *parsed_cmd);
518 static int keyword_match_mac_addr(enum ethsw_keyword_id key_id, int argc,
519 char *const argv[], int *argc_nr,
520 struct ethsw_command_def *parsed_cmd);
523 * Define properties for each keyword;
524 * keep the order synced with enum ethsw_keyword_id
527 const char *keyword_name;
528 int (*match)(enum ethsw_keyword_id key_id, int argc, char *const argv[],
529 int *argc_nr, struct ethsw_command_def *parsed_cmd);
532 .keyword_name = "help",
533 .match = &keyword_match_gen,
535 .keyword_name = "show",
536 .match = &keyword_match_gen,
538 .keyword_name = "port",
539 .match = &keyword_match_port
541 .keyword_name = "enable",
542 .match = &keyword_match_gen,
544 .keyword_name = "disable",
545 .match = &keyword_match_gen,
547 .keyword_name = "statistics",
548 .match = &keyword_match_gen,
550 .keyword_name = "clear",
551 .match = &keyword_match_gen,
553 .keyword_name = "learning",
554 .match = &keyword_match_gen,
556 .keyword_name = "auto",
557 .match = &keyword_match_gen,
559 .keyword_name = "vlan",
560 .match = &keyword_match_vlan,
562 .keyword_name = "fdb",
563 .match = &keyword_match_gen,
565 .keyword_name = "add",
566 .match = &keyword_match_mac_addr,
568 .keyword_name = "del",
569 .match = &keyword_match_mac_addr,
571 .keyword_name = "flush",
572 .match = &keyword_match_gen,
574 .keyword_name = "pvid",
575 .match = &keyword_match_pvid,
577 .keyword_name = "untagged",
578 .match = &keyword_match_gen,
580 .keyword_name = "all",
581 .match = &keyword_match_gen,
583 .keyword_name = "none",
584 .match = &keyword_match_gen,
586 .keyword_name = "egress",
587 .match = &keyword_match_gen,
589 .keyword_name = "tag",
590 .match = &keyword_match_gen,
592 .keyword_name = "classified",
593 .match = &keyword_match_gen,
595 .keyword_name = "shared",
596 .match = &keyword_match_gen,
598 .keyword_name = "private",
599 .match = &keyword_match_gen,
604 * Function used by an Ethernet Switch driver to set the functions
605 * that must be called by the parser when an ethsw command is given
607 int ethsw_define_functions(const struct ethsw_command_func *cmd_func)
611 int (*cmd_func_aux)(struct ethsw_command_def *);
613 if (!cmd_func->ethsw_name)
616 ethsw_name = cmd_func->ethsw_name;
618 for (i = 0; i < ARRAY_SIZE(ethsw_cmd_def); i++) {
620 * get the pointer to the function send by the Ethernet Switch
621 * driver that corresponds to the proper ethsw command
623 if (ethsw_cmd_def[i].keyword_function)
626 aux_p = (void *)cmd_func + ethsw_cmd_def[i].cmd_func_offset;
628 cmd_func_aux = (int (*)(struct ethsw_command_def *)) *aux_p;
629 ethsw_cmd_def[i].keyword_function = cmd_func_aux;
635 /* Generic function used to match a keyword only by a string */
636 static int keyword_match_gen(enum ethsw_keyword_id key_id, int argc,
637 char *const argv[], int *argc_nr,
638 struct ethsw_command_def *parsed_cmd)
640 if (strcmp(argv[*argc_nr], keyword[key_id].keyword_name) == 0) {
641 parsed_cmd->cmd_to_keywords[*argc_nr] = key_id;
648 /* Function used to match the command's port */
649 static int keyword_match_port(enum ethsw_keyword_id key_id, int argc,
650 char *const argv[], int *argc_nr,
651 struct ethsw_command_def *parsed_cmd)
655 if (!keyword_match_gen(key_id, argc, argv, argc_nr, parsed_cmd))
658 if (*argc_nr + 1 >= argc)
661 if (strict_strtoul(argv[*argc_nr + 1], 10, &val) != -EINVAL) {
662 parsed_cmd->port = val;
664 parsed_cmd->cmd_to_keywords[*argc_nr] = ethsw_id_port_no;
671 /* Function used to match the command's vlan */
672 static int keyword_match_vlan(enum ethsw_keyword_id key_id, int argc,
673 char *const argv[], int *argc_nr,
674 struct ethsw_command_def *parsed_cmd)
679 if (!keyword_match_gen(key_id, argc, argv, argc_nr, parsed_cmd))
682 if (*argc_nr + 1 >= argc)
685 if (strict_strtoul(argv[*argc_nr + 1], 10, &val) != -EINVAL) {
686 parsed_cmd->vid = val;
688 parsed_cmd->cmd_to_keywords[*argc_nr] = ethsw_id_vlan_no;
694 if (keyword_match_gen(ethsw_id_add, argc, argv, &aux, parsed_cmd))
695 parsed_cmd->cmd_to_keywords[*argc_nr + 1] = ethsw_id_add;
696 else if (keyword_match_gen(ethsw_id_del, argc, argv, &aux, parsed_cmd))
697 parsed_cmd->cmd_to_keywords[*argc_nr + 1] = ethsw_id_del;
701 if (*argc_nr + 2 >= argc)
704 if (strict_strtoul(argv[*argc_nr + 2], 10, &val) != -EINVAL) {
705 parsed_cmd->vid = val;
707 parsed_cmd->cmd_to_keywords[*argc_nr] = ethsw_id_add_del_no;
714 /* Function used to match the command's pvid */
715 static int keyword_match_pvid(enum ethsw_keyword_id key_id, int argc,
716 char *const argv[], int *argc_nr,
717 struct ethsw_command_def *parsed_cmd)
721 if (!keyword_match_gen(key_id, argc, argv, argc_nr, parsed_cmd))
724 if (*argc_nr + 1 >= argc)
727 if (strict_strtoul(argv[*argc_nr + 1], 10, &val) != -EINVAL) {
728 parsed_cmd->vid = val;
730 parsed_cmd->cmd_to_keywords[*argc_nr] = ethsw_id_pvid_no;
736 /* Function used to match the command's MAC address */
737 static int keyword_match_mac_addr(enum ethsw_keyword_id key_id, int argc,
738 char *const argv[], int *argc_nr,
739 struct ethsw_command_def *parsed_cmd)
741 if (!keyword_match_gen(key_id, argc, argv, argc_nr, parsed_cmd))
744 if ((*argc_nr + 1 >= argc) ||
745 !is_broadcast_ethaddr(parsed_cmd->ethaddr))
748 if (eth_validate_ethaddr_str(argv[*argc_nr + 1])) {
749 printf("Invalid MAC address: %s\n", argv[*argc_nr + 1]);
753 eth_parse_enetaddr(argv[*argc_nr + 1], parsed_cmd->ethaddr);
755 if (is_broadcast_ethaddr(parsed_cmd->ethaddr)) {
756 memset(parsed_cmd->ethaddr, 0xFF, sizeof(parsed_cmd->ethaddr));
760 parsed_cmd->cmd_to_keywords[*argc_nr + 1] = ethsw_id_add_del_mac;
765 /* Finds optional keywords and modifies *argc_va to skip them */
766 static void cmd_keywords_opt_check(const struct ethsw_command_def *parsed_cmd,
770 int keyw_opt_matched;
772 int const *cmd_keyw_p;
773 int const *cmd_keyw_opt_p;
775 /* remember the best match */
776 argc_val_max = *argc_val;
779 * check if our command's optional keywords match the optional
780 * keywords of an available command
782 for (i = 0; i < ARRAY_SIZE(ethsw_cmd_def); i++) {
783 keyw_opt_matched = 0;
784 cmd_keyw_p = &parsed_cmd->cmd_to_keywords[keyw_opt_matched];
785 cmd_keyw_opt_p = &cmd_opt_def[i].cmd_keyword[keyw_opt_matched];
788 * increase the number of keywords that
789 * matched with a command
791 while (keyw_opt_matched + *argc_val <
792 parsed_cmd->cmd_keywords_nr &&
793 *cmd_keyw_opt_p != ethsw_id_key_end &&
794 *(cmd_keyw_p + *argc_val) == *cmd_keyw_opt_p) {
801 * if all our optional command's keywords perfectly match an
802 * optional pattern, then we can move to the next defined
803 * keywords in our command; remember the one that matched the
804 * greatest number of keywords
806 if (keyw_opt_matched + *argc_val <=
807 parsed_cmd->cmd_keywords_nr &&
808 *cmd_keyw_opt_p == ethsw_id_key_end &&
809 *argc_val + keyw_opt_matched > argc_val_max)
810 argc_val_max = *argc_val + keyw_opt_matched;
813 *argc_val = argc_val_max;
817 * Finds the function to call based on keywords and
818 * modifies *argc_va to skip them
820 static void cmd_keywords_check(struct ethsw_command_def *parsed_cmd,
829 * check if our command's keywords match the
830 * keywords of an available command
832 for (i = 0; i < ARRAY_SIZE(ethsw_cmd_def); i++) {
834 cmd_keyw_p = &parsed_cmd->cmd_to_keywords[keyw_matched];
835 cmd_keyw_def_p = ðsw_cmd_def[i].cmd_keyword[keyw_matched];
838 * increase the number of keywords that
839 * matched with a command
841 while (keyw_matched + *argc_val < parsed_cmd->cmd_keywords_nr &&
842 *cmd_keyw_def_p != ethsw_id_key_end &&
843 *(cmd_keyw_p + *argc_val) == *cmd_keyw_def_p) {
850 * if all our command's keywords perfectly match an
851 * available command, then we get the function we need to call
852 * to configure the Ethernet Switch
854 if (keyw_matched && keyw_matched + *argc_val ==
855 parsed_cmd->cmd_keywords_nr &&
856 *cmd_keyw_def_p == ethsw_id_key_end) {
857 *argc_val += keyw_matched;
858 parsed_cmd->cmd_function =
859 ethsw_cmd_def[i].keyword_function;
865 /* find all the keywords in the command */
866 static int keywords_find(int argc, char * const argv[],
867 struct ethsw_command_def *parsed_cmd)
872 int rc = CMD_RET_SUCCESS;
874 for (i = 1; i < argc; i++) {
875 for (j = 0; j < ethsw_id_count; j++) {
876 if (keyword[j].match(j, argc, argv, &i, parsed_cmd))
881 /* if there is no keyword match for a word, the command is invalid */
882 for (i = 1; i < argc; i++)
883 if (parsed_cmd->cmd_to_keywords[i] == ethsw_id_key_end)
886 parsed_cmd->cmd_keywords_nr = argc;
889 /* get optional parameters first */
890 cmd_keywords_opt_check(parsed_cmd, &argc_val);
892 if (argc_val == parsed_cmd->cmd_keywords_nr)
893 return CMD_RET_USAGE;
896 * check the keywords and if a match is found,
897 * get the function to call
899 cmd_keywords_check(parsed_cmd, &argc_val);
901 /* error if not all commands' parameters were matched */
902 if (argc_val == parsed_cmd->cmd_keywords_nr) {
903 if (!parsed_cmd->cmd_function) {
904 printf("Command not available for: %s\n", ethsw_name);
905 rc = CMD_RET_FAILURE;
914 static void command_def_init(struct ethsw_command_def *parsed_cmd)
918 for (i = 0; i < ETHSW_MAX_CMD_PARAMS; i++)
919 parsed_cmd->cmd_to_keywords[i] = ethsw_id_key_end;
921 parsed_cmd->port = ETHSW_CMD_PORT_ALL;
922 parsed_cmd->vid = ETHSW_CMD_VLAN_ALL;
923 parsed_cmd->cmd_function = NULL;
925 /* We initialize the MAC address with the Broadcast address */
926 memset(parsed_cmd->ethaddr, 0xff, sizeof(parsed_cmd->ethaddr));
929 /* function to interpret commands starting with "ethsw " */
930 static int do_ethsw(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
932 struct ethsw_command_def parsed_cmd;
933 int rc = CMD_RET_SUCCESS;
935 if (argc == 1 || argc >= ETHSW_MAX_CMD_PARAMS)
936 return CMD_RET_USAGE;
938 command_def_init(&parsed_cmd);
940 rc = keywords_find(argc, argv, &parsed_cmd);
942 if (rc == CMD_RET_SUCCESS)
943 rc = parsed_cmd.cmd_function(&parsed_cmd);
948 #define ETHSW_PORT_CONF_HELP "[port <port_no>] { enable | disable | show } " \
949 "- enable/disable a port; show shows a port's configuration"
951 U_BOOT_CMD(ethsw, ETHSW_MAX_CMD_PARAMS, 0, do_ethsw,
952 "Ethernet l2 switch commands",
953 ETHSW_PORT_CONF_HELP"\n"
954 ETHSW_PORT_STATS_HELP"\n"
959 ETHSW_PORT_UNTAG_HELP"\n"
960 ETHSW_EGR_VLAN_TAG_HELP"\n"
961 ETHSW_VLAN_FDB_HELP"\n"