aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation/networking
diff options
context:
space:
mode:
authorOliver Hartkopp <socketcan@hartkopp.net>2012-05-08 16:20:33 -0400
committerMarc Kleine-Budde <mkl@pengutronix.de>2012-05-23 16:55:49 -0400
commitd6e640f9766e2fb9aa3853b4ff19e4d7d5d7e373 (patch)
tree8042b08dfb17169907f71c65215bf4ec421f5ec5 /Documentation/networking
parent8b5e218d8caa7592d26e68157bd71f50426bb7ae (diff)
can: update documentation wording error frames -> error messages
As Heinz-Juergen Oertel pointed out 'CAN error frames' are a already defined term for the CAN protocol violation indication on the wire. To avoid confusion with the error messages created by CAN drivers available via CAN RAW sockets update the documentation and change the naming from 'error frames' to 'error messages' or 'error message frames'. Signed-off-by: Oliver Hartkopp <socketcan@hartkopp.net> Signed-off-by: Marc Kleine-Budde <mkl@pengutronix.de>
Diffstat (limited to 'Documentation/networking')
-rw-r--r--Documentation/networking/can.txt32
1 files changed, 16 insertions, 16 deletions
diff --git a/Documentation/networking/can.txt b/Documentation/networking/can.txt
index 56ca3b75376..28d9b14c34e 100644
--- a/Documentation/networking/can.txt
+++ b/Documentation/networking/can.txt
@@ -232,16 +232,16 @@ solution for a couple of reasons:
232 arbitration problems and error frames caused by the different 232 arbitration problems and error frames caused by the different
233 ECUs. The occurrence of detected errors are important for diagnosis 233 ECUs. The occurrence of detected errors are important for diagnosis
234 and have to be logged together with the exact timestamp. For this 234 and have to be logged together with the exact timestamp. For this
235 reason the CAN interface driver can generate so called Error Frames 235 reason the CAN interface driver can generate so called Error Message
236 that can optionally be passed to the user application in the same 236 Frames that can optionally be passed to the user application in the
237 way as other CAN frames. Whenever an error on the physical layer 237 same way as other CAN frames. Whenever an error on the physical layer
238 or the MAC layer is detected (e.g. by the CAN controller) the driver 238 or the MAC layer is detected (e.g. by the CAN controller) the driver
239 creates an appropriate error frame. Error frames can be requested by 239 creates an appropriate error message frame. Error messages frames can
240 the user application using the common CAN filter mechanisms. Inside 240 be requested by the user application using the common CAN filter
241 this filter definition the (interested) type of errors may be 241 mechanisms. Inside this filter definition the (interested) type of
242 selected. The reception of error frames is disabled by default. 242 errors may be selected. The reception of error messages is disabled
243 The format of the CAN error frame is briefly described in the Linux 243 by default. The format of the CAN error message frame is briefly
244 header file "include/linux/can/error.h". 244 described in the Linux header file "include/linux/can/error.h".
245 245
2464. How to use Socket CAN 2464. How to use Socket CAN
247------------------------ 247------------------------
@@ -383,7 +383,7 @@ solution for a couple of reasons:
383 defaults are set at RAW socket binding time: 383 defaults are set at RAW socket binding time:
384 384
385 - The filters are set to exactly one filter receiving everything 385 - The filters are set to exactly one filter receiving everything
386 - The socket only receives valid data frames (=> no error frames) 386 - The socket only receives valid data frames (=> no error message frames)
387 - The loopback of sent CAN frames is enabled (see chapter 3.2) 387 - The loopback of sent CAN frames is enabled (see chapter 3.2)
388 - The socket does not receive its own sent frames (in loopback mode) 388 - The socket does not receive its own sent frames (in loopback mode)
389 389
@@ -434,7 +434,7 @@ solution for a couple of reasons:
434 4.1.2 RAW socket option CAN_RAW_ERR_FILTER 434 4.1.2 RAW socket option CAN_RAW_ERR_FILTER
435 435
436 As described in chapter 3.4 the CAN interface driver can generate so 436 As described in chapter 3.4 the CAN interface driver can generate so
437 called Error Frames that can optionally be passed to the user 437 called Error Message Frames that can optionally be passed to the user
438 application in the same way as other CAN frames. The possible 438 application in the same way as other CAN frames. The possible
439 errors are divided into different error classes that may be filtered 439 errors are divided into different error classes that may be filtered
440 using the appropriate error mask. To register for every possible 440 using the appropriate error mask. To register for every possible
@@ -527,7 +527,7 @@ solution for a couple of reasons:
527 527
528 rcvlist_all - list for unfiltered entries (no filter operations) 528 rcvlist_all - list for unfiltered entries (no filter operations)
529 rcvlist_eff - list for single extended frame (EFF) entries 529 rcvlist_eff - list for single extended frame (EFF) entries
530 rcvlist_err - list for error frames masks 530 rcvlist_err - list for error message frames masks
531 rcvlist_fil - list for mask/value filters 531 rcvlist_fil - list for mask/value filters
532 rcvlist_inv - list for mask/value filters (inverse semantic) 532 rcvlist_inv - list for mask/value filters (inverse semantic)
533 rcvlist_sff - list for single standard frame (SFF) entries 533 rcvlist_sff - list for single standard frame (SFF) entries
@@ -784,13 +784,13 @@ solution for a couple of reasons:
784 $ ip link set canX type can restart-ms 100 784 $ ip link set canX type can restart-ms 100
785 785
786 Alternatively, the application may realize the "bus-off" condition 786 Alternatively, the application may realize the "bus-off" condition
787 by monitoring CAN error frames and do a restart when appropriate with 787 by monitoring CAN error message frames and do a restart when
788 the command: 788 appropriate with the command:
789 789
790 $ ip link set canX type can restart 790 $ ip link set canX type can restart
791 791
792 Note that a restart will also create a CAN error frame (see also 792 Note that a restart will also create a CAN error message frame (see
793 chapter 3.4). 793 also chapter 3.4).
794 794
795 6.6 Supported CAN hardware 795 6.6 Supported CAN hardware
796 796