From e6af207cc17423fd9efade3c1d8fc1510506127c Mon Sep 17 00:00:00 2001 From: hartkopp Date: Sun, 26 Jun 2011 12:47:21 +0000 Subject: [PATCH] minor doc changes ... tbc git-svn-id: svn://svn.berlios.de//socketcan/trunk@1261 030b6a49-0b11-0410-94ab-b0dab22257f2 --- kernel/2.6/Documentation/networking/can/can-bcm.txt | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/kernel/2.6/Documentation/networking/can/can-bcm.txt b/kernel/2.6/Documentation/networking/can/can-bcm.txt index 56f6d19..2d7a0a4 100644 --- a/kernel/2.6/Documentation/networking/can/can-bcm.txt +++ b/kernel/2.6/Documentation/networking/can/can-bcm.txt @@ -48,8 +48,10 @@ B. Broadcast Manager protocol sockets (SOCK_DGRAM) B.1 Opening BCM sockets - To use Broadcast-Manager include the file "bcm.h". - A socket for Broadcast-Manager is created with: + To use the referenced definitions for CAN_BCM sockets, include + . + + A socket for the Broadcast-Manager is created with: s = socket(PF_CAN, SOCK_DGRAM, CAN_BCM); @@ -62,7 +64,7 @@ B. Broadcast Manager protocol sockets (SOCK_DGRAM) connect(s, (struct sockaddr *)&addr, sizeof(addr)); - If a process must operate on multiple CAN buses, it must open several + If a process must operate on multiple CAN buses, it can open several sockets. It is also possible for a process to open multiple sockets on a single CAN-bus, if it makes sense for the application programmer to structure different data flows. @@ -82,7 +84,7 @@ B. Broadcast Manager protocol sockets (SOCK_DGRAM) int count; /* run 'count' times ival1 then ival2 */ struct timeval ival1, ival2; /* intervals */ canid_t can_id; /* 32 Bit SFF/EFF. MSB set at EFF */ - int nframes; /* number of can_frame's in the next field */ + int nframes; /* num of can_frame's in the next field */ struct can_frame frames[0]; }; @@ -135,7 +137,8 @@ B. Broadcast Manager protocol sockets (SOCK_DGRAM) SETTIMER: set the value of ival1, ival2 and count STARTTIMER: start the timer with the actual value of ival1, ival2 and count. - Starting the timer leads simultaneously to the transmission of a can_frame + Starting the timer leads simultaneously to the transmission of a + can_frame TX_COUNTEVT: create the message TX_EXPIRED when count is reached TX_ANNOUNCE: a change of data by the process is emitted with a new frame, regardless of the timer status -- 2.39.2