summaryrefslogtreecommitdiff
path: root/doc/man
diff options
context:
space:
mode:
authorDimitri Staessens <[email protected]>2018-03-10 10:09:08 +0100
committerSander Vrijders <[email protected]>2018-03-10 13:16:06 +0100
commit2936dd5e4232f7d7d9c720d89bb4a696abcd1830 (patch)
treee4d755789542da32c1720636bc1065a3a6b62c74 /doc/man
parent9b6fdc1c2abe85008610063d800edf80e5011a4d (diff)
downloadouroboros-2936dd5e4232f7d7d9c720d89bb4a696abcd1830.tar.gz
ouroboros-2936dd5e4232f7d7d9c720d89bb4a696abcd1830.zip
ipcpd: Add IPCP over DIX Ethernet
This adds an IPC Process that uses DIX Ethernet with an Ethertype that is configurable at bootstrap. This allows parallel DIX layers over the same Ethernet network with different Ethertypes (and one LLC layer). It allows jumbo frames in the future, and should avoid the problems we have with some routers not handling LLC traffic very well. The destination endpoint ID is sent as a 16 bit integer, so the maximum payload is 1498 bytes in standard Ethernet, and 8998 bytes when Jumbo frames are used. The implementation is very similar to the Ethernet LLC IPCP, so it is implemented using preprocessor macros in the single source instead of duplicating code. Signed-off-by: Dimitri Staessens <[email protected]> Signed-off-by: Sander Vrijders <[email protected]>
Diffstat (limited to 'doc/man')
-rw-r--r--doc/man/ouroboros.835
1 files changed, 30 insertions, 5 deletions
diff --git a/doc/man/ouroboros.8 b/doc/man/ouroboros.8
index a661da92..063f5e8d 100644
--- a/doc/man/ouroboros.8
+++ b/doc/man/ouroboros.8
@@ -2,7 +2,7 @@
.\" Dimitri Staessens <[email protected]>
.\" Sander Vrijders <[email protected]>
-.TH OUROBOROS 8 2018-02-13 Ouroboros "Ouroboros User Manual"
+.TH OUROBOROS 8 2018-03-10 Ouroboros "Ouroboros User Manual"
.SH NAME
@@ -99,8 +99,9 @@ have to be reachable over a lower layer. IPCPs that wrap a legacy
transmission technology are all bootstrapped and thus need not enroll
as they work directly over a physical connection. Ouroboros currently
supports IPCPs over shared memory (local), L1 (raptor, experimental),
-L2 (eth-llc) and L3 (udp). The normal layer requires connections to be
-established between IPCP components for its operation.
+L2 (eth-llc and eth-dix) and L3 (udp). The normal layer requires
+connections to be established between IPCP components for its
+operation.
\fBConnecting the management components\fR using \fImanagement
flows\fR allows management information to be sent between IPCPs so
@@ -124,7 +125,9 @@ creates an IPCP process of type \fItype\fR in the system with name
.PP
\fBraptor\fR - create an IPCP that attaches to a raptor NetFPGA device.
.PP
-\fBeth-llc\fR - create an IPCP that attaches to an Ethernet adapter.
+\fBeth-llc\fR - create an IPCP that attaches to Ethernet using LLC frames.
+.PP
+\fBeth-dix\fR - create an IPCP that attaches to Ethernet using DIX frames.
.PP
\fBudp\fR - create an IPCP that attaches to a UDP socket.
.PP
@@ -152,6 +155,8 @@ Values for [\fIparam\fR] are dependent on \fItype\fR:
[hash \fIpolicy\fR] specifies the hash function used for the directory,
.br
\fIpolicy\fR: SHA3_224, SHA3_256, SHA3_384, SHA3_512.
+.br
+default: SHA3_256.
.RE
\fBraptor\fR
@@ -160,16 +165,36 @@ Values for [\fIparam\fR] are dependent on \fItype\fR:
[hash \fIpolicy\fR] specifies the hash function used for the directory,
.br
\fIpolicy\fR: SHA3_224, SHA3_256, SHA3_384, SHA3_512.
+.br
+default: SHA3_256.
.RE
.PP
\fBeth-llc\fR
.RS 4
-if_name \fIinterface\fR specifies the interface to bind the IPCP to.
+dev \fIinterface\fR specifies the interface to bind the IPCP to.
.PP
[hash \fIpolicy\fR] specifies the hash function used for the directory,
.br
\fIpolicy\fR: SHA3_224, SHA3_256, SHA3_384, SHA3_512.
+.br
+default: SHA3_256.
+.RE
+
+.PP
+\fBeth-dix\fR
+.RS 4
+dev \fIinterface\fR specifies the interface to bind the IPCP to.
+.PP
+[ethertype \fIethertype\fR] specifies the ethertype used for the layer.
+.br
+default: 0xA000.
+.PP
+[hash \fIpolicy\fR] specifies the hash function used for the directory,
+.br
+\fIpolicy\fR: SHA3_224, SHA3_256, SHA3_384, SHA3_512.
+.br
+default: SHA3_256.
.RE
.PP