Module Name: src
Committed By: wiz
Date: Mon May 29 08:41:57 UTC 2017
Modified Files:
src/share/man/man4: can.4
Log Message:
New sentence, new line. Remove trailing whitespace.
Fix typos. Use more markup. Sort sections. Sort SEE ALSO.
To generate a diff of this commit:
cvs rdiff -u -r1.2 -r1.3 src/share/man/man4/can.4
Please note that diffs are not public domain; they are subject to the
copyright notices on the relevant files.
Modified files:
Index: src/share/man/man4/can.4
diff -u src/share/man/man4/can.4:1.2 src/share/man/man4/can.4:1.3
--- src/share/man/man4/can.4:1.2 Sat May 27 21:02:55 2017
+++ src/share/man/man4/can.4 Mon May 29 08:41:57 2017
@@ -1,4 +1,4 @@
-.\" $NetBSD: can.4,v 1.2 2017/05/27 21:02:55 bouyer Exp $
+.\" $NetBSD: can.4,v 1.3 2017/05/29 08:41:57 wiz Exp $
.\"
.\" Copyright (c) 2017 Manuel Bouyer.
.\" Redistribution and use in source and binary forms, with or without
@@ -18,7 +18,7 @@
.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
-.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
.Dd May 18, 2017
.Dt CAN 4
@@ -33,19 +33,24 @@
.Fn socket AF_CAN SOCK_RAW CAN_RAW
.Sh DESCRIPTION
.Nm
-is the network layer protocol used on top of CAN bus networks. At this time
-only the SOCK_RAW socket type is supported.
-This protocol layer is intended to be compatible with the linux SocketCAN implementation.
+is the network layer protocol used on top of CAN bus networks.
+At this time only the
+.Dv SOCK_RAW
+socket type is supported.
+This protocol layer is intended to be compatible with the Linux SocketCAN implementation.
.Ss ADDRESSING
A CAN frame consists of a 11 bits (standard frame format) or 29 bits
(extended frame format) identifier, followed by up to 8 data bytes.
-The interpretation of the identifier is application-dependant, the CAN
+The interpretation of the identifier is application-dependent, the CAN
standard itself doesn't define an addressing.
.Pp
The
.Nm
-layer uses a 32bits identifier. The 3 upper bits are used as control flags.
-The extended frame format is selected by setting the CAN_EFF_FLAG control bit.
+layer uses a 32bits identifier.
+The 3 upper bits are used as control flags.
+The extended frame format is selected by setting the
+.Dv CAN_EFF_FLAG
+control bit.
.Pp
The socket address is defined as
.Bd -literal
@@ -74,23 +79,28 @@ struct can_frame {
uint8_t data[CAN_MAX_DLEN] __aligned(8);
};
.Ed
-The lower 11 bits (for standard frames) or 29 bits (for exended frames) are
-used as the on-wire identifier. The CAN_EFF_FLAG bit is set in can_id for
-extended frames. The CAN_RTR_FLAG bit is set in can_id for remote transmission
-request frames.
+The lower 11 bits (for standard frames) or 29 bits (for extended frames) are
+used as the on-wire identifier.
+The
+.Dv CAN_EFF_FLAG
+bit is set in can_id for extended frames.
+The
+.Dv CAN_RTR_FLAG
+bit is set in can_id for remote transmission request frames.
.Sh SEE ALSO
.Xr socket 2 ,
-.Xr netintro 4 ,
.Xr canloop 4 ,
+.Xr netintro 4 ,
.Xr canconfig 8 ,
-.Pa /usr/include/netcan/can.h
+.Pa /usr/include/netcan/can.h
.Pp
.Lk https://en.wikipedia.org/wiki/SocketCAN "SocketCAN - Wikipedia"
.Lk https://www.kernel.org/doc/Documentation/networking/can.txt "Readme file for the Controller Area Network Protocol Family"
-.Sh BUGS
-CANFD and error frames are not implemented.
.Sh HISTORY
The
.Nm
protocol appeared in
.Nx 8.0 .
+.Sh BUGS
+.Dv CANFD
+and error frames are not implemented.
