Re: [PATCH can-next] Add broadcast manager documentation

[Marc Kleine-Budde <mkl@pengutronix.de>]

[-- Attachment #1: Type: text/plain, Size: 3069 bytes --]

On 10/14/2013 09:41 PM, Oliver Hartkopp wrote:
> On 08.10.2013 02:56, Brian Thorne wrote:
>> Hi all,
>>
>> I wanted to use the bcm module and ended up putting together some basic findings
>> that might be a useful addition to the can.txt documentation.
>>
>> I haven't tried submitting any patches before so please point out any mistakes.
>>
>> Cheers,
>> Brian
>>
> 
> Hi Brian,
> 
> I updated and enhanced your documentation patch for the broadcast manager.
> 
> Please review and make your annotations inline.
> 
> Tnx,
> Oliver
> 
> 
> 
> 
> Signed-off-by: Brian Thorne <hardbyte@gmail.com>
> Signed-off-by: Oliver Hartkopp <socketcan@hartkopp.net>
> 
> ---
> 
> diff --git a/Documentation/networking/can.txt b/Documentation/networking/can.txt
> index 820f553..f227ba6 100644
> --- a/Documentation/networking/can.txt
> +++ b/Documentation/networking/can.txt
> @@ -25,6 +25,10 @@ This file contains
>        4.1.5 RAW socket option CAN_RAW_FD_FRAMES
>        4.1.6 RAW socket returned message flags
>      4.2 Broadcast Manager protocol sockets (SOCK_DGRAM)
> +      4.2.1 Broadcast Manager Operations
> +      4.2.2 Broadcast Manager message flags
> +      4.2.3 Broadcast Manager message sequence transmission
> +      4.2.4 Broadcast Manager multiplex message receive filter
>      4.3 connected transport protocols (SOCK_SEQPACKET)
>      4.4 unconnected transport protocols (SOCK_DGRAM)
>  
> @@ -593,6 +597,161 @@ solution for a couple of reasons:
>        In order to receive such messages, CAN_RAW_RECV_OWN_MSGS must be set.
>  
>    4.2 Broadcast Manager protocol sockets (SOCK_DGRAM)
> +
> +  The Broadcast Manager protocol provides a command based configuration
> +  interface to filter and send (e.g. cyclic) CAN messages in kernel space.
> +
> +  Receive filters can be used to down sample frequent messages; detect events
> +  such as message contents changes, packet length changes, and do time-out
> +  monitoring of received messages.
> +
> +  Periodic transmissions can be modified at runtime; both the message content
> +  and the transmit interval can be altered. Periodic transmissions can use two
> +  intervals, sending a number of messages at a interval ival1, then continuing
> +  to send at another given interval ival2.
> +
> +  A BCM socket is not intended for sending individual CAN frames using the
> +  struct can_frame as known from the CAN_RAW socket. Instead a special BCM
> +  configuration message is defined. The basic BCM configuration message used
> +  to communicate with the broadcast manager and the available operations are
> +  defined in the linux/can/bcm.h include. The BCM message consists of a

Nitpick
It's "include/uapi/linux/can/bcm.h" in recent kernel trees.

Marc

-- 
Pengutronix e.K.                  | Marc Kleine-Budde           |
Industrial Linux Solutions        | Phone: +49-231-2826-924     |
Vertretung West/Dortmund          | Fax:   +49-5121-206917-5555 |
Amtsgericht Hildesheim, HRA 2686  | http://www.pengutronix.de   |


[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 259 bytes --]