2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2011-2012 Stefan Bethke.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 #include <sys/cdefs.h>
32 __FBSDID("$FreeBSD$");
43 #include <sys/types.h>
44 #include <sys/ioctl.h>
46 #include <net/if_media.h>
47 #include <dev/etherswitch/etherswitch.h>
49 int get_media_subtype(int, const char *);
50 int get_media_mode(int, const char *);
51 int get_media_options(int, const char *);
52 int lookup_media_word(struct ifmedia_description *, const char *);
53 void print_media_word(int, int);
54 void print_media_word_ifconfig(int);
57 #define IEEE802DOT1Q_VID_MAX 4094
58 #define IFMEDIAREQ_NULISTENTRIES 256
73 const char *controlfile;
74 etherswitch_conf_t conf;
75 etherswitch_info_t info;
84 void (*f)(struct cfg *, char *argv[]);
86 static struct cmds cmds[];
88 /* Must match the ETHERSWITCH_PORT_LED_* enum order */
89 static const char *ledstyles[] = { "default", "on", "off", "blink", NULL };
92 * Print a value a la the %b format of the kernel's printf.
93 * Stolen from ifconfig.c.
96 printb(const char *s, unsigned v, const char *bits)
101 if (bits && *bits == 8)
102 printf("%s=%o", s, v);
104 printf("%s=%x", s, v);
108 while ((i = *bits++) != '\0') {
109 if (v & (1 << (i-1))) {
113 for (; (c = *bits) > 32; bits++)
116 for (; *bits > 32; bits++)
124 read_register(struct cfg *cfg, int r)
126 struct etherswitch_reg er;
129 if (ioctl(cfg->fd, IOETHERSWITCHGETREG, &er) != 0)
130 err(EX_OSERR, "ioctl(IOETHERSWITCHGETREG)");
135 write_register(struct cfg *cfg, int r, int v)
137 struct etherswitch_reg er;
141 if (ioctl(cfg->fd, IOETHERSWITCHSETREG, &er) != 0)
142 err(EX_OSERR, "ioctl(IOETHERSWITCHSETREG)");
146 read_phyregister(struct cfg *cfg, int phy, int reg)
148 struct etherswitch_phyreg er;
152 if (ioctl(cfg->fd, IOETHERSWITCHGETPHYREG, &er) != 0)
153 err(EX_OSERR, "ioctl(IOETHERSWITCHGETPHYREG)");
158 write_phyregister(struct cfg *cfg, int phy, int reg, int val)
160 struct etherswitch_phyreg er;
165 if (ioctl(cfg->fd, IOETHERSWITCHSETPHYREG, &er) != 0)
166 err(EX_OSERR, "ioctl(IOETHERSWITCHSETPHYREG)");
170 set_port_vid(struct cfg *cfg, char *argv[])
173 etherswitch_port_t p;
175 v = strtol(argv[1], NULL, 0);
176 if (v < 0 || v > IEEE802DOT1Q_VID_MAX)
177 errx(EX_USAGE, "pvid must be between 0 and %d",
178 IEEE802DOT1Q_VID_MAX);
179 bzero(&p, sizeof(p));
180 p.es_port = cfg->unit;
181 if (ioctl(cfg->fd, IOETHERSWITCHGETPORT, &p) != 0)
182 err(EX_OSERR, "ioctl(IOETHERSWITCHGETPORT)");
184 if (ioctl(cfg->fd, IOETHERSWITCHSETPORT, &p) != 0)
185 err(EX_OSERR, "ioctl(IOETHERSWITCHSETPORT)");
189 set_port_flag(struct cfg *cfg, char *argv[])
194 etherswitch_port_t p;
199 if (strcmp(flag, "none") != 0) {
204 if (strcasecmp(flag, "striptag") == 0)
205 f = ETHERSWITCH_PORT_STRIPTAG;
206 else if (strcasecmp(flag, "addtag") == 0)
207 f = ETHERSWITCH_PORT_ADDTAG;
208 else if (strcasecmp(flag, "firstlock") == 0)
209 f = ETHERSWITCH_PORT_FIRSTLOCK;
210 else if (strcasecmp(flag, "dropuntagged") == 0)
211 f = ETHERSWITCH_PORT_DROPUNTAGGED;
212 else if (strcasecmp(flag, "doubletag") == 0)
213 f = ETHERSWITCH_PORT_DOUBLE_TAG;
214 else if (strcasecmp(flag, "ingress") == 0)
215 f = ETHERSWITCH_PORT_INGRESS;
217 bzero(&p, sizeof(p));
218 p.es_port = cfg->unit;
219 if (ioctl(cfg->fd, IOETHERSWITCHGETPORT, &p) != 0)
220 err(EX_OSERR, "ioctl(IOETHERSWITCHGETPORT)");
225 if (ioctl(cfg->fd, IOETHERSWITCHSETPORT, &p) != 0)
226 err(EX_OSERR, "ioctl(IOETHERSWITCHSETPORT)");
230 set_port_media(struct cfg *cfg, char *argv[])
232 etherswitch_port_t p;
233 int ifm_ulist[IFMEDIAREQ_NULISTENTRIES];
236 bzero(&p, sizeof(p));
237 p.es_port = cfg->unit;
238 p.es_ifmr.ifm_ulist = ifm_ulist;
239 p.es_ifmr.ifm_count = IFMEDIAREQ_NULISTENTRIES;
240 if (ioctl(cfg->fd, IOETHERSWITCHGETPORT, &p) != 0)
241 err(EX_OSERR, "ioctl(IOETHERSWITCHGETPORT)");
242 if (p.es_ifmr.ifm_count == 0)
244 subtype = get_media_subtype(IFM_TYPE(ifm_ulist[0]), argv[1]);
245 p.es_ifr.ifr_media = (p.es_ifmr.ifm_current & IFM_IMASK) |
246 IFM_TYPE(ifm_ulist[0]) | subtype;
247 if (ioctl(cfg->fd, IOETHERSWITCHSETPORT, &p) != 0)
248 err(EX_OSERR, "ioctl(IOETHERSWITCHSETPORT)");
252 set_port_mediaopt(struct cfg *cfg, char *argv[])
254 etherswitch_port_t p;
255 int ifm_ulist[IFMEDIAREQ_NULISTENTRIES];
258 bzero(&p, sizeof(p));
259 p.es_port = cfg->unit;
260 p.es_ifmr.ifm_ulist = ifm_ulist;
261 p.es_ifmr.ifm_count = IFMEDIAREQ_NULISTENTRIES;
262 if (ioctl(cfg->fd, IOETHERSWITCHGETPORT, &p) != 0)
263 err(EX_OSERR, "ioctl(IOETHERSWITCHGETPORT)");
264 options = get_media_options(IFM_TYPE(ifm_ulist[0]), argv[1]);
266 errx(EX_USAGE, "invalid media options \"%s\"", argv[1]);
267 if (options & IFM_HDX) {
268 p.es_ifr.ifr_media &= ~IFM_FDX;
271 p.es_ifr.ifr_media |= options;
272 if (ioctl(cfg->fd, IOETHERSWITCHSETPORT, &p) != 0)
273 err(EX_OSERR, "ioctl(IOETHERSWITCHSETPORT)");
277 set_port_led(struct cfg *cfg, char *argv[])
279 etherswitch_port_t p;
283 bzero(&p, sizeof(p));
284 p.es_port = cfg->unit;
285 if (ioctl(cfg->fd, IOETHERSWITCHGETPORT, &p) != 0)
286 err(EX_OSERR, "ioctl(IOETHERSWITCHGETPORT)");
288 led = strtol(argv[1], NULL, 0);
289 if (led < 1 || led > p.es_nleds)
290 errx(EX_USAGE, "invalid led number %s; must be between 1 and %d",
291 argv[1], p.es_nleds);
295 for (i=0; ledstyles[i] != NULL; i++) {
296 if (strcmp(argv[2], ledstyles[i]) == 0) {
301 if (ledstyles[i] == NULL)
302 errx(EX_USAGE, "invalid led style \"%s\"", argv[2]);
304 if (ioctl(cfg->fd, IOETHERSWITCHSETPORT, &p) != 0)
305 err(EX_OSERR, "ioctl(IOETHERSWITCHSETPORT)");
309 set_vlangroup_vid(struct cfg *cfg, char *argv[])
312 etherswitch_vlangroup_t vg;
314 memset(&vg, 0, sizeof(vg));
315 v = strtol(argv[1], NULL, 0);
316 if (v < 0 || v > IEEE802DOT1Q_VID_MAX)
317 errx(EX_USAGE, "vlan must be between 0 and %d", IEEE802DOT1Q_VID_MAX);
318 vg.es_vlangroup = cfg->unit;
319 if (ioctl(cfg->fd, IOETHERSWITCHGETVLANGROUP, &vg) != 0)
320 err(EX_OSERR, "ioctl(IOETHERSWITCHGETVLANGROUP)");
322 if (ioctl(cfg->fd, IOETHERSWITCHSETVLANGROUP, &vg) != 0)
323 err(EX_OSERR, "ioctl(IOETHERSWITCHSETVLANGROUP)");
327 set_vlangroup_members(struct cfg *cfg, char *argv[])
329 etherswitch_vlangroup_t vg;
330 int member, untagged;
334 member = untagged = 0;
335 memset(&vg, 0, sizeof(vg));
336 if (strcmp(argv[1], "none") != 0) {
337 for (c=argv[1]; *c; c=d) {
338 v = strtol(c, &d, 0);
341 if (v < 0 || v >= cfg->info.es_nports)
342 errx(EX_USAGE, "Member port must be between 0 and %d", cfg->info.es_nports-1);
343 if (d[0] == ',' || d[0] == '\0' ||
344 ((d[0] == 't' || d[0] == 'T') && (d[1] == ',' || d[1] == '\0'))) {
345 if (d[0] == 't' || d[0] == 'T') {
346 untagged &= ~ETHERSWITCH_PORTMASK(v);
349 untagged |= ETHERSWITCH_PORTMASK(v);
350 member |= ETHERSWITCH_PORTMASK(v);
353 errx(EX_USAGE, "Invalid members specification \"%s\"", d);
356 vg.es_vlangroup = cfg->unit;
357 if (ioctl(cfg->fd, IOETHERSWITCHGETVLANGROUP, &vg) != 0)
358 err(EX_OSERR, "ioctl(IOETHERSWITCHGETVLANGROUP)");
359 vg.es_member_ports = member;
360 vg.es_untagged_ports = untagged;
361 if (ioctl(cfg->fd, IOETHERSWITCHSETVLANGROUP, &vg) != 0)
362 err(EX_OSERR, "ioctl(IOETHERSWITCHSETVLANGROUP)");
366 set_register(struct cfg *cfg, char *arg)
371 a = strtol(arg, &c, 0);
375 v = strtoul(c+1, NULL, 0);
376 write_register(cfg, a, v);
378 printf("\treg 0x%04x=0x%08x\n", a, read_register(cfg, a));
383 set_phyregister(struct cfg *cfg, char *arg)
388 phy = strtol(arg, &c, 0);
394 reg = strtol(d, &c, 0);
398 val = strtoul(c+1, NULL, 0);
399 write_phyregister(cfg, phy, reg, val);
401 printf("\treg %d.0x%02x=0x%04x\n", phy, reg, read_phyregister(cfg, phy, reg));
406 set_vlan_mode(struct cfg *cfg, char *argv[])
408 etherswitch_conf_t conf;
410 bzero(&conf, sizeof(conf));
411 conf.cmd = ETHERSWITCH_CONF_VLAN_MODE;
412 if (strcasecmp(argv[1], "isl") == 0)
413 conf.vlan_mode = ETHERSWITCH_VLAN_ISL;
414 else if (strcasecmp(argv[1], "port") == 0)
415 conf.vlan_mode = ETHERSWITCH_VLAN_PORT;
416 else if (strcasecmp(argv[1], "dot1q") == 0)
417 conf.vlan_mode = ETHERSWITCH_VLAN_DOT1Q;
418 else if (strcasecmp(argv[1], "dot1q4k") == 0)
419 conf.vlan_mode = ETHERSWITCH_VLAN_DOT1Q_4K;
420 else if (strcasecmp(argv[1], "qinq") == 0)
421 conf.vlan_mode = ETHERSWITCH_VLAN_DOUBLE_TAG;
424 if (ioctl(cfg->fd, IOETHERSWITCHSETCONF, &conf) != 0)
425 err(EX_OSERR, "ioctl(IOETHERSWITCHSETCONF)");
429 print_config(struct cfg *cfg)
433 /* Get the device name. */
434 c = strrchr(cfg->controlfile, '/');
438 c = cfg->controlfile;
440 /* Print VLAN mode. */
441 if (cfg->conf.cmd & ETHERSWITCH_CONF_VLAN_MODE) {
442 printf("%s: VLAN mode: ", c);
443 switch (cfg->conf.vlan_mode) {
444 case ETHERSWITCH_VLAN_ISL:
447 case ETHERSWITCH_VLAN_PORT:
450 case ETHERSWITCH_VLAN_DOT1Q:
453 case ETHERSWITCH_VLAN_DOT1Q_4K:
456 case ETHERSWITCH_VLAN_DOUBLE_TAG:
466 print_port(struct cfg *cfg, int port)
468 etherswitch_port_t p;
469 int ifm_ulist[IFMEDIAREQ_NULISTENTRIES];
472 bzero(&p, sizeof(p));
474 p.es_ifmr.ifm_ulist = ifm_ulist;
475 p.es_ifmr.ifm_count = IFMEDIAREQ_NULISTENTRIES;
476 if (ioctl(cfg->fd, IOETHERSWITCHGETPORT, &p) != 0)
477 err(EX_OSERR, "ioctl(IOETHERSWITCHGETPORT)");
478 printf("port%d:\n", port);
479 if (cfg->conf.vlan_mode == ETHERSWITCH_VLAN_DOT1Q)
480 printf("\tpvid: %d\n", p.es_pvid);
481 printb("\tflags", p.es_flags, ETHERSWITCH_PORT_FLAGS_BITS);
485 for (i = 0; i < p.es_nleds; i++) {
486 printf("%d:%s%s", i+1, ledstyles[p.es_led[i]], (i==p.es_nleds-1)?"":" ");
491 print_media_word(p.es_ifmr.ifm_current, 1);
492 if (p.es_ifmr.ifm_active != p.es_ifmr.ifm_current) {
495 print_media_word(p.es_ifmr.ifm_active, 0);
499 printf("\tstatus: %s\n", (p.es_ifmr.ifm_status & IFM_ACTIVE) != 0 ? "active" : "no carrier");
500 if (cfg->mediatypes) {
501 printf("\tsupported media:\n");
502 if (p.es_ifmr.ifm_count > IFMEDIAREQ_NULISTENTRIES)
503 p.es_ifmr.ifm_count = IFMEDIAREQ_NULISTENTRIES;
504 for (i=0; i<p.es_ifmr.ifm_count; i++) {
505 printf("\t\tmedia ");
506 print_media_word(ifm_ulist[i], 0);
513 print_vlangroup(struct cfg *cfg, int vlangroup)
515 etherswitch_vlangroup_t vg;
518 vg.es_vlangroup = vlangroup;
519 if (ioctl(cfg->fd, IOETHERSWITCHGETVLANGROUP, &vg) != 0)
520 err(EX_OSERR, "ioctl(IOETHERSWITCHGETVLANGROUP)");
521 if ((vg.es_vid & ETHERSWITCH_VID_VALID) == 0)
523 vg.es_vid &= ETHERSWITCH_VID_MASK;
524 printf("vlangroup%d:\n", vlangroup);
525 if (cfg->conf.vlan_mode == ETHERSWITCH_VLAN_PORT)
526 printf("\tport: %d\n", vg.es_vid);
528 printf("\tvlan: %d\n", vg.es_vid);
529 printf("\tmembers ");
531 if (vg.es_member_ports != 0)
532 for (i=0; i<cfg->info.es_nports; i++) {
533 if ((vg.es_member_ports & ETHERSWITCH_PORTMASK(i)) != 0) {
537 if ((vg.es_untagged_ports & ETHERSWITCH_PORTMASK(i)) == 0)
548 print_info(struct cfg *cfg)
553 c = strrchr(cfg->controlfile, '/');
557 c = cfg->controlfile;
559 printf("%s: %s with %d ports and %d VLAN groups\n", c,
560 cfg->info.es_name, cfg->info.es_nports,
561 cfg->info.es_nvlangroups);
563 printb("VLAN capabilities", cfg->info.es_vlan_caps,
564 ETHERSWITCH_VLAN_CAPS_BITS);
568 for (i=0; i<cfg->info.es_nports; i++) {
571 for (i=0; i<cfg->info.es_nvlangroups; i++) {
572 print_vlangroup(cfg, i);
577 usage(struct cfg *cfg __unused, char *argv[] __unused)
579 fprintf(stderr, "usage: etherswitchctl\n");
580 fprintf(stderr, "\tetherswitchcfg [-f control file] info\n");
581 fprintf(stderr, "\tetherswitchcfg [-f control file] config "
582 "command parameter\n");
583 fprintf(stderr, "\t\tconfig commands: vlan_mode\n");
584 fprintf(stderr, "\tetherswitchcfg [-f control file] phy "
585 "phy.register[=value]\n");
586 fprintf(stderr, "\tetherswitchcfg [-f control file] portX "
587 "[flags] command parameter\n");
588 fprintf(stderr, "\t\tport commands: pvid, media, mediaopt, led\n");
589 fprintf(stderr, "\tetherswitchcfg [-f control file] reg "
590 "register[=value]\n");
591 fprintf(stderr, "\tetherswitchcfg [-f control file] vlangroupX "
592 "command parameter\n");
593 fprintf(stderr, "\t\tvlangroup commands: vlan, members\n");
598 newmode(struct cfg *cfg, enum cmdmode mode)
600 if (mode == cfg->mode)
607 * Read the updated the configuration (it can be different
608 * from the last time we read it).
610 if (ioctl(cfg->fd, IOETHERSWITCHGETCONF, &cfg->conf) != 0)
611 err(EX_OSERR, "ioctl(IOETHERSWITCHGETCONF)");
615 print_port(cfg, cfg->unit);
618 print_vlangroup(cfg, cfg->unit);
628 main(int argc, char *argv[])
634 bzero(&cfg, sizeof(cfg));
635 cfg.controlfile = "/dev/etherswitch0";
636 while ((ch = getopt(argc, argv, "f:mv?")) != -1)
639 cfg.controlfile = optarg;
654 cfg.fd = open(cfg.controlfile, O_RDONLY);
656 err(EX_UNAVAILABLE, "Can't open control file: %s", cfg.controlfile);
657 if (ioctl(cfg.fd, IOETHERSWITCHGETINFO, &cfg.info) != 0)
658 err(EX_OSERR, "ioctl(IOETHERSWITCHGETINFO)");
659 if (ioctl(cfg.fd, IOETHERSWITCHGETCONF, &cfg.conf) != 0)
660 err(EX_OSERR, "ioctl(IOETHERSWITCHGETCONF)");
665 cfg.mode = MODE_NONE;
669 if (strcmp(argv[0], "info") == 0) {
671 } else if (sscanf(argv[0], "port%d", &cfg.unit) == 1) {
672 if (cfg.unit < 0 || cfg.unit >= cfg.info.es_nports)
673 errx(EX_USAGE, "port unit must be between 0 and %d", cfg.info.es_nports - 1);
674 newmode(&cfg, MODE_PORT);
675 } else if (sscanf(argv[0], "vlangroup%d", &cfg.unit) == 1) {
676 if (cfg.unit < 0 || cfg.unit >= cfg.info.es_nvlangroups)
678 "vlangroup unit must be between 0 and %d",
679 cfg.info.es_nvlangroups - 1);
680 newmode(&cfg, MODE_VLANGROUP);
681 } else if (strcmp(argv[0], "config") == 0) {
682 newmode(&cfg, MODE_CONFIG);
683 } else if (strcmp(argv[0], "phy") == 0) {
684 newmode(&cfg, MODE_PHYREG);
685 } else if (strcmp(argv[0], "reg") == 0) {
686 newmode(&cfg, MODE_REGISTER);
687 } else if (strcmp(argv[0], "help") == 0) {
690 errx(EX_USAGE, "Unknown command \"%s\"", argv[0]);
696 for(i=0; cmds[i].name != NULL; i++) {
697 if (cfg.mode == cmds[i].mode && strcmp(argv[0], cmds[i].name) == 0) {
698 if (argc < (cmds[i].args + 1)) {
699 printf("%s needs %d argument%s\n", cmds[i].name, cmds[i].args, (cmds[i].args==1)?"":",");
702 (cmds[i].f)(&cfg, argv);
703 argc -= cmds[i].args;
704 argv += cmds[i].args;
708 if (cmds[i].name == NULL) {
709 newmode(&cfg, MODE_NONE);
714 if (set_register(&cfg, argv[0]) != 0) {
715 newmode(&cfg, MODE_NONE);
720 if (set_phyregister(&cfg, argv[0]) != 0) {
721 newmode(&cfg, MODE_NONE);
729 /* switch back to command mode to print configuration for last command */
730 newmode(&cfg, MODE_NONE);
735 static struct cmds cmds[] = {
736 { MODE_PORT, "pvid", 1, set_port_vid },
737 { MODE_PORT, "media", 1, set_port_media },
738 { MODE_PORT, "mediaopt", 1, set_port_mediaopt },
739 { MODE_PORT, "led", 2, set_port_led },
740 { MODE_PORT, "addtag", 0, set_port_flag },
741 { MODE_PORT, "-addtag", 0, set_port_flag },
742 { MODE_PORT, "ingress", 0, set_port_flag },
743 { MODE_PORT, "-ingress", 0, set_port_flag },
744 { MODE_PORT, "striptag", 0, set_port_flag },
745 { MODE_PORT, "-striptag", 0, set_port_flag },
746 { MODE_PORT, "doubletag", 0, set_port_flag },
747 { MODE_PORT, "-doubletag", 0, set_port_flag },
748 { MODE_PORT, "firstlock", 0, set_port_flag },
749 { MODE_PORT, "-firstlock", 0, set_port_flag },
750 { MODE_PORT, "dropuntagged", 0, set_port_flag },
751 { MODE_PORT, "-dropuntagged", 0, set_port_flag },
752 { MODE_CONFIG, "vlan_mode", 1, set_vlan_mode },
753 { MODE_VLANGROUP, "vlan", 1, set_vlangroup_vid },
754 { MODE_VLANGROUP, "members", 1, set_vlangroup_members },