From e8358ce21b771fb2558d1329ef15957a98e62839 Mon Sep 17 00:00:00 2001 From: claudio Date: Thu, 11 Nov 2021 09:45:27 +0000 Subject: [PATCH] Unhook switch.4 and update bridge.4 since some switch(4) specific ioctls will be removed soon. OK sthen@ kn@ patrick@ --- share/man/man4/Makefile | 4 +- share/man/man4/bridge.4 | 9 +- share/man/man4/switch.4 | 194 ---------------------------------------- 3 files changed, 5 insertions(+), 202 deletions(-) delete mode 100644 share/man/man4/switch.4 diff --git a/share/man/man4/Makefile b/share/man/man4/Makefile index c385599922a..ce89c7fc2a6 100644 --- a/share/man/man4/Makefile +++ b/share/man/man4/Makefile @@ -1,4 +1,4 @@ -# $OpenBSD: Makefile,v 1.811 2021/11/09 16:16:11 kn Exp $ +# $OpenBSD: Makefile,v 1.812 2021/11/11 09:45:27 claudio Exp $ MAN= aac.4 abcrtc.4 abl.4 ac97.4 acphy.4 acrtc.4 \ acpi.4 acpiac.4 acpials.4 acpiasus.4 acpibat.4 \ @@ -78,7 +78,7 @@ MAN= aac.4 abcrtc.4 abl.4 ac97.4 acphy.4 acrtc.4 \ sdmmc.4 sdhc.4 se.4 ses.4 sf.4 sili.4 \ simpleamp.4 simpleaudio.4 simplefb.4 simplepanel.4 siop.4 sis.4 sk.4 \ sm.4 smsc.4 softraid.4 spdmem.4 sdtemp.4 speaker.4 sppp.4 sqphy.4 \ - ssdfb.4 st.4 ste.4 stge.4 sti.4 stp.4 sv.4 switch.4 sxiccmu.4 \ + ssdfb.4 st.4 ste.4 stge.4 sti.4 stp.4 sv.4 sxiccmu.4 \ sxidog.4 sximmc.4 sxipio.4 sxipwm.4 sxirsb.4 sxirtc.4 sxisid.4 \ sxisyscon.4 sxitemp.4 sxitwi.4 sym.4 sypwr.4 syscon.4 \ tcic.4 tcp.4 tcpci.4 termios.4 tht.4 ti.4 tipmic.4 titmp.4 tl.4 \ diff --git a/share/man/man4/bridge.4 b/share/man/man4/bridge.4 index 089589269c0..c29609f7e2c 100644 --- a/share/man/man4/bridge.4 +++ b/share/man/man4/bridge.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: bridge.4,v 1.80 2020/08/27 21:06:34 kn Exp $ +.\" $OpenBSD: bridge.4,v 1.81 2021/11/11 09:45:27 claudio Exp $ .\" .\" Copyright (c) 1999-2001 Jason L. Wright (jason@thought.net) .\" All rights reserved. @@ -24,7 +24,7 @@ .\" ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE .\" POSSIBILITY OF SUCH DAMAGE. .\" -.Dd $Mdocdate: August 27 2020 $ +.Dd $Mdocdate: November 11 2021 $ .Dt BRIDGE 4 .Os .Sh NAME @@ -147,7 +147,7 @@ They are defined in Some .Xr ioctl 2 calls are used by -.Xr switch 4 +.Xr veb 4 and .Xr tpmr 4 as well. @@ -370,9 +370,6 @@ struct ifbrparam { #define ifbrp_hellotime ifbrp_ifbrpu.ifbrpu_hellotime #define ifbrp_fwddelay ifbrp_ifbrpu.ifbrpu_fwddelay #define ifbrp_maxage ifbrp_ifbrpu.ifbrpu_maxage -#define ifbrp_datapath ifbrp_ifbrpu.ifbrpu_datapath -#define ifbrp_maxflow ifbrp_ifbrpu.ifbrpu_csize -#define ifbrp_maxgroup ifbrp_ifbrpu.ifbrpu_maxgroup .Ed .Pp Note that the diff --git a/share/man/man4/switch.4 b/share/man/man4/switch.4 deleted file mode 100644 index 859ef52409f..00000000000 --- a/share/man/man4/switch.4 +++ /dev/null @@ -1,194 +0,0 @@ -.\" $OpenBSD: switch.4,v 1.9 2019/05/10 18:27:50 akoshibe Exp $ -.\" -.\" Copyright (c) 2016 YASUOKA Masahiko -.\" -.\" Permission to use, copy, modify, and distribute this software for any -.\" purpose with or without fee is hereby granted, provided that the above -.\" copyright notice and this permission notice appear in all copies. -.\" -.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES -.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF -.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR -.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES -.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN -.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF -.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. -.\" -.Dd $Mdocdate: May 10 2019 $ -.Dt SWITCH 4 -.Os -.Sh NAME -.Nm switch -.Nd network switch pseudo device -.Sh SYNOPSIS -.Cd "pseudo-device switch" -.Pp -.In sys/types.h -.In net/if.h -.In netinet/in.h -.In netinet/if_ether.h -.In net/if_bridge.h -.Sh DESCRIPTION -The -.Nm -driver provides a network interface pseudo-device. -The interface is the forwarding part of a network switch -and it works along with a controller, usually -.Xr switchd 8 -or -.Xr switchctl 8 , -through the device -.Pa /dev/switchN . -The -.Nm -device and the controller communicate using the OpenFlow -1.3 protocol. -.Pp -A -.Nm -interface is created using -.Ic ifconfig switch Ns Ar N Ic create -or by opening the character device -.Pa /dev/switchN . -.Pp -.Pa /dev/switchN -is the OpenFlow channel of the interface -.Pa switchN . -It is used for exchanging OpenFlow messages. -The device behaves like a stream, which means that a -.Xr read 2 -may return one or more OpenFlow messages depending on the number of -bytes requested. -It may also read the message partially (e.g.\& -.Xr read 2 -the OpenFlow message header and then the complete message). -The same applies to -.Xr write 2 -calls, so it may send one or more OpenFlow messages with a single write -or use more than one -.Xr write 2 -calls to send a single message. -.Sh IOCTLS -A -.Nm -interface responds to all of the -.Xr ioctl 2 -calls specific to other interfaces listed in -.Xr netintro 4 . -.Pp -The following -.Xr ioctl 2 -calls and their structures are commonly used by -.Nm -and -.Xr bridge 4 : -.Pp -.Bl -bullet -offset indent -compact -.It -.Dv SIOCBRDGIFS -.It -.Dv SIOCBRDGADD -.It -.Dv SIOCBRDGDEL -.It -.Dv SIOCBRDGGIFFLGS -.It -.Dv SIOCBRDGSIFPROT -.El -.Pp -The following -.Xr ioctl 2 -calls are used only by the -.Nm -interface, -as defined in -.In sys/sockio.h : -.Bl -tag -width Ds -.It Dv SIOCBRDGADDL Fa "struct ifbreq *" -Add the interface named in -.Va ifbr_ifsname -to the switch named in -.Va ifbr_name -as a local port which connects the local system's network stacks. -Only one -.Xr vether 4 -interface can be added as a local port. -.It Dv SIOCSWGDPID -Retrieve the datapath_id in the OpenFlow protocol of the switch named in -.Va ifbrp_name -into the -.Va ifbrpu_datapath -field. -.It Dv SIOCSWSDPID Fa "struct ifbrparam" -Set the datapath_id in the OpenFlow protocol of the switch named in -.Va ifbrp_name -to the value in the -.Va ifbrpu_datapath -field. -.It Dv SIOCSWGMAXFLOW Fa "struct ifbrparam" -Retrieve the maximum number of flows in the OpenFlow protocol -of the switch named in -.Va ifbrp_name -into the -.Va ifbrp_maxflow -field. -.It Dv SIOCSWGMAXGROUP Fa "struct ifbrparam" -Retrieve the maximum number of groups in the OpenFlow protocol -of the switch named -in -.Va ifbrp_name -into the -.Va ifbrpu_maxgroup -field. -.It Dv SIOCSWSPORTNO Fa "struct ifbreq" -Set the port_no in the OpenFlow protocol of the port named in -.Va ifbr_ifsname -of the switch named in -.Va ifbr_name -to the -.Va ifbr_portno -field. -.El -.Sh FILES -.Bl -tag -width /dev/switch* -compact -.It Pa /dev/switch* -.El -.Sh ERRORS -If open fails, -.Xr errno 2 -may be set to one of: -.Bl -tag -width Er -.It Bq Er ENXIO -Could not create the interface. -.It Bq Er EBUSY -The device was already opened. -.It Bq Er ENOBUF -Out of memory. -.El -.Sh SEE ALSO -.Xr bridge 4 , -.Xr inet 4 , -.Xr inet6 4 , -.Xr vether 4 , -.Xr hostname.if 5 , -.Xr ifconfig 8 , -.Xr netstart 8 , -.Xr switchctl 8 , -.Xr switchd 8 -.Sh STANDARDS -.Rs -.%A Open Networking Foundation (ONF) -.%D March 26, 2015 -.%R Version 1.3.5 (Protocol version 0x04) -.%T OpenFlow Switch Specification -.Re -.Sh HISTORY -The -.Nm -driver first appeared in -.Ox 6.1 . -.Sh AUTHORS -The -.Nm -driver was written by -.An Kazuya Goda Aq Mt goda@openbsd.org . -- 2.20.1