* [PATCH] Broadcast manager documentation
@ 2013-10-08 0:56 Brian Thorne
2013-10-08 8:24 ` Oliver Hartkopp
` (2 more replies)
0 siblings, 3 replies; 8+ messages in thread
From: Brian Thorne @ 2013-10-08 0:56 UTC (permalink / raw)
To: linux-can
[-- Attachment #1: Type: text/plain, Size: 248 bytes --]
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
[-- Attachment #2: 0001-net-Update-the-CAN-broadcast-manager-documentation.patch --]
[-- Type: application/octet-stream, Size: 5890 bytes --]
From 282b4d202b580d57c384dc84aeb7bbb08dff556f Mon Sep 17 00:00:00 2001
From: Brian Thorne <hardbyte@gmail.com>
Date: Tue, 8 Oct 2013 12:10:43 +1300
Subject: [PATCH] net: Update the CAN broadcast manager documentation
Add content to empty section in controller area network
documentation.
Signed-off-by: Brian Thorne <hardbyte@gmail.com>
---
Documentation/networking/can.txt | 132 +++++++++++++++++++++++++++++++++++++++
1 file changed, 132 insertions(+)
diff --git a/Documentation/networking/can.txt b/Documentation/networking/can.txt
index 820f553..38b1d7e 100644
--- a/Documentation/networking/can.txt
+++ b/Documentation/networking/can.txt
@@ -593,6 +593,138 @@ 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 an interface to filter and send
+ cyclic CAN packets in kernel space.
+
+ Periodic transmissions can be modified at runtime; both the message content
+ and the interval can be altered. Periodic transmissions can use multiple
+ intervals, sending N messages at a interval, then continuing to send at
+ another given interval.
+
+ 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.
+
+ A BCM socket is not used for sending individual can frames, instead a new
+ special message is defined. The basic BCM frame structure used to
+ communicate with the broadcast manager and the available operations are
+ defined in include/linux/can/bcm.h. The basic BCM frame consists of a
+ message header with an opcode command followed by zero or more can frames.
+ The broadcast manager sends responses to user space in the same form:
+
+ struct bcm_msg_head {
+ __u32 opcode; /* command */
+ __u32 flags; /* special flags */
+ __u32 count; /* run 'count' times with ival1 */
+ struct timeval ival1, ival2; /* count and subsequent interval */
+ canid_t can_id; /* unique can_id for task */
+ __u32 nframes; /* number of can_frames following */
+ struct can_frame frames[0];
+ };
+
+ The frames payload uses the same basic CAN frame structure defined at the
+ beginning of section 4. All messages to the broadcast manager from user
+ space have this structure.
+
+ Note a CAN_BCM socket must be connected instead of bound after socket
+ creation (example without error checking):
+
+ int s;
+ struct sockaddr_can addr;
+ struct ifreq ifr;
+
+ s = socket(PF_CAN, SOCK_DGRAM, CAN_BCM);
+
+ strcpy(ifr.ifr_name, "can0");
+ ioctl(s, SIOCGIFINDEX, &ifr);
+
+ addr.can_family = AF_CAN;
+ addr.can_ifindex = ifr.ifr_ifindex;
+
+ connect(s, (struct sockaddr *)&addr, sizeof(addr))
+
+ (..)
+
+ The broadcast manager socket is able to handle any number of in flight
+ transmissions or receive filters concurrently. However additional sockets
+ are required to communicate on multiple CAN buses.
+
+ 4.2.1 Broadcast Manager Operations
+
+ The opcode defines the operation for the broadcast manager to carry out, or
+ details the broadcast managers response to several events, including user
+ requests.
+
+ Transmit Operations
+
+ The following transmit operations may be sent from user space to the
+ broadcast manager:
+
+ TX_SETUP: create (cyclic) transmission task
+
+ TX_DELETE: remove (cyclic) transmission task, requires only can_id.
+
+ TX_READ: read properties of (cyclic) transmission task
+
+ TX_SEND: send one CAN frame
+
+ Transmit Responses
+
+ TX_STATUS: reply to TX_READ request
+
+ TX_EXPIRED: notification when counter finishes sending at initial interval
+ Requires the TX_COUNTEVT flag to be set.
+
+ Receive Operations
+
+ RX_SETUP: create RX content filter subscription
+
+ RX_DELETE: remove RX content filter subscription
+
+ RX_READ: read properties of RX content filter subscription
+
+ Receive Responses
+
+ RX_STATUS: reply to RX_READ request
+
+ RX_TIMEOUT: Cyclic message is absent. Sent when time controlled
+ message reception failed.
+
+ RX_CHANGED: updated CAN frame (detected content change). Sent on first
+ message received, or on a receipt of a revised CAN messages.
+
+ 4.2.2 Broadcast Manager message flags
+
+ When sending a message to the broadcast manager the msg->flags may contain
+ the following flags which influence the behaviour:
+
+ 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 emit a can_frame.
+
+ TX_COUNTEVT: create the message TX_EXPIRED when count expires
+
+ TX_ANNOUNCE: A change of data by the process is emitted immediately.
+
+ TX_CP_CAN_ID: Copies the can_id from the message header attached to
+ each frame in frames. This is intended only as usage simplification.
+
+ RX_FILTER_ID: Filter by can_id alone, no frames required (nframes=0)
+
+ RX_CHECK_DLC: A change of the DLC leads to an RX_CHANGED.
+
+ RX_NO_AUTOTIMER: Prevent automatically starting the timeout monitor.
+
+ RX_ANNOUNCE_RESUME: If passed to RX_SETUP, when a receive timeout occurs,
+ an RX_CHANGED will be generated when the (cyclic) receive restarts.
+
+ TX_RESET_MULTI_IDX: Start multiple frame transmission with index 0.
+
+ RX_RTR_FRAME: send reply for RTR-request (placed in op->frames[0])
+
+
4.3 connected transport protocols (SOCK_SEQPACKET)
4.4 unconnected transport protocols (SOCK_DGRAM)
--
1.8.1.2
^ permalink raw reply related [flat|nested] 8+ messages in thread
* Re: [PATCH] Broadcast manager documentation
2013-10-08 0:56 [PATCH] Broadcast manager documentation Brian Thorne
@ 2013-10-08 8:24 ` Oliver Hartkopp
2013-10-08 14:03 ` Marc Kleine-Budde
2013-10-14 19:41 ` [PATCH can-next] Add broadcast " Oliver Hartkopp
2 siblings, 0 replies; 8+ messages in thread
From: Oliver Hartkopp @ 2013-10-08 8:24 UTC (permalink / raw)
To: Brian Thorne, linux-can
Brian Thorne <hardbyte@gmail.com> schrieb:
>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.
>
Hello Brian,
thanks for the patch.
I think it's almost >90% correct.
I would be able to give you a more detailed feedback when I'm back from vacation this weekend.
>I haven't tried submitting any patches before so please point out any
>mistakes.
>
See linux source tree "SubmittingPatches" file.
>Cheers,
>Brian
Tnx,
Oliver
--
Diese Nachricht wurde von meinem Android-Mobiltelefon mit K-9 Mail gesendet.
^ permalink raw reply [flat|nested] 8+ messages in thread
* Re: [PATCH] Broadcast manager documentation
2013-10-08 0:56 [PATCH] Broadcast manager documentation Brian Thorne
2013-10-08 8:24 ` Oliver Hartkopp
@ 2013-10-08 14:03 ` Marc Kleine-Budde
2013-10-14 19:41 ` [PATCH can-next] Add broadcast " Oliver Hartkopp
2 siblings, 0 replies; 8+ messages in thread
From: Marc Kleine-Budde @ 2013-10-08 14:03 UTC (permalink / raw)
To: Brian Thorne; +Cc: linux-can
[-- Attachment #1: Type: text/plain, Size: 3490 bytes --]
On 10/08/2013 02:56 AM, 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.
YEAY! documentation!
> I haven't tried submitting any patches before so please point out any mistakes.
From the howto submit patches point of view, it's preferred to send
matches inline, "git send-email" is your friend.
I cannot say anything to the contents, as I've never used the bcm so
far. However a nitpick inline:
> 0001-net-Update-the-CAN-broadcast-manager-documentation.patch
>
>
> From 282b4d202b580d57c384dc84aeb7bbb08dff556f Mon Sep 17 00:00:00 2001
> From: Brian Thorne <hardbyte@gmail.com>
> Date: Tue, 8 Oct 2013 12:10:43 +1300
> Subject: [PATCH] net: Update the CAN broadcast manager documentation
>
> Add content to empty section in controller area network
> documentation.
>
> Signed-off-by: Brian Thorne <hardbyte@gmail.com>
> ---
> Documentation/networking/can.txt | 132 +++++++++++++++++++++++++++++++++++++++
> 1 file changed, 132 insertions(+)
>
> diff --git a/Documentation/networking/can.txt b/Documentation/networking/can.txt
> index 820f553..38b1d7e 100644
> --- a/Documentation/networking/can.txt
> +++ b/Documentation/networking/can.txt
> @@ -593,6 +593,138 @@ 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 an interface to filter and send
> + cyclic CAN packets in kernel space.
> +
> + Periodic transmissions can be modified at runtime; both the message content
> + and the interval can be altered. Periodic transmissions can use multiple
> + intervals, sending N messages at a interval, then continuing to send at
> + another given interval.
> +
> + 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.
> +
> + A BCM socket is not used for sending individual can frames, instead a new
> + special message is defined. The basic BCM frame structure used to
> + communicate with the broadcast manager and the available operations are
> + defined in include/linux/can/bcm.h. The basic BCM frame consists of a
It's "include/uapi/linux/can/bcm.h" in recent kernel trees.
> + message header with an opcode command followed by zero or more can frames.
> + The broadcast manager sends responses to user space in the same form:
> +
> + struct bcm_msg_head {
> + __u32 opcode; /* command */
> + __u32 flags; /* special flags */
> + __u32 count; /* run 'count' times with ival1 */
> + struct timeval ival1, ival2; /* count and subsequent interval */
> + canid_t can_id; /* unique can_id for task */
> + __u32 nframes; /* number of can_frames following */
> + struct can_frame frames[0];
> + };
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 --]
^ permalink raw reply [flat|nested] 8+ messages in thread
* [PATCH can-next] Add broadcast manager documentation
2013-10-08 0:56 [PATCH] Broadcast manager documentation Brian Thorne
2013-10-08 8:24 ` Oliver Hartkopp
2013-10-08 14:03 ` Marc Kleine-Budde
@ 2013-10-14 19:41 ` Oliver Hartkopp
2013-10-14 20:02 ` Marc Kleine-Budde
2 siblings, 1 reply; 8+ messages in thread
From: Oliver Hartkopp @ 2013-10-14 19:41 UTC (permalink / raw)
To: Brian Thorne; +Cc: linux-can
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
+ message header with an 'opcode' command followed by zero or more CAN frames.
+ The broadcast manager sends responses to user space in the same form:
+
+ struct bcm_msg_head {
+ __u32 opcode; /* command */
+ __u32 flags; /* special flags */
+ __u32 count; /* run 'count' times with ival1 */
+ struct timeval ival1, ival2; /* count and subsequent interval */
+ canid_t can_id; /* unique can_id for task */
+ __u32 nframes; /* number of can_frames following */
+ struct can_frame frames[0];
+ };
+
+ The frames payload uses the same basic CAN frame structure defined at the
+ beginning of section 4. All messages to the broadcast manager from user
+ space have this structure.
+
+ Note a CAN_BCM socket must be connected instead of bound after socket
+ creation (example without error checking):
+
+ int s;
+ struct sockaddr_can addr;
+ struct ifreq ifr;
+
+ s = socket(PF_CAN, SOCK_DGRAM, CAN_BCM);
+
+ strcpy(ifr.ifr_name, "can0");
+ ioctl(s, SIOCGIFINDEX, &ifr);
+
+ addr.can_family = AF_CAN;
+ addr.can_ifindex = ifr.ifr_ifindex;
+
+ connect(s, (struct sockaddr *)&addr, sizeof(addr))
+
+ (..)
+
+ The broadcast manager socket is able to handle any number of in flight
+ transmissions or receive filters concurrently. The different RX/TX jobs are
+ distinguished by the unique can_id in each BCM message. However additional
+ CAN_BCM sockets are recommended to communicate on multiple CAN interfaces.
+ When the broadcast manager socket is bound to 'any' CAN interface (=> the
+ interface index is set to zero) the configured receive filters apply to any
+ CAN interface unless the sendto() syscall is used to overrule the zero CAN
+ interface index. When using recvfrom() instead of read() to retrieve BCM
+ socket messages the originating CAN interface is provided in can_ifindex.
+
+ 4.2.1 Broadcast Manager Operations
+
+ The opcode defines the operation for the broadcast manager to carry out, or
+ details the broadcast managers response to several events, including user
+ requests.
+
+ Transmit Operations (user space to broadcast manager):
+
+ TX_SETUP: create (cyclic) transmission task
+
+ TX_DELETE: remove (cyclic) transmission task, requires only can_id.
+
+ TX_READ: read properties of (cyclic) transmission task
+
+ TX_SEND: send one CAN frame
+
+ Transmit Responses (broadcast manager to user space):
+
+ TX_STATUS: reply to TX_READ request
+
+ TX_EXPIRED: notification when counter finishes sending at initial interval
+ Requires the TX_COUNTEVT flag to be set.
+
+ Receive Operations (user space to broadcast manager):
+
+ RX_SETUP: create RX content filter subscription
+
+ RX_DELETE: remove RX content filter subscription, requires only can_id.
+
+ RX_READ: read properties of RX content filter subscription
+
+ Receive Responses (broadcast manager to user space):
+
+ RX_STATUS: reply to RX_READ request
+
+ RX_TIMEOUT: Cyclic message is detected to be absent
+
+ RX_CHANGED: updated CAN frame (detected content change). Sent on first
+ message received or on a receipt of a revised CAN messages.
+
+ 4.2.2 Broadcast Manager message flags
+
+ When sending a message to the broadcast manager the msg->flags may contain
+ the following flags which influence the behaviour:
+
+ 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 emit a can_frame.
+
+ TX_COUNTEVT: create the message TX_EXPIRED when count expires
+
+ TX_ANNOUNCE: A change of data by the process is emitted immediately.
+
+ TX_CP_CAN_ID: Copies the can_id from the message header to each
+ subsequent frame in frames. This is intended as usage simplification. For
+ TX tasks the unique can_id from the message header may differ from the
+ can_id(s) stored for transmission in the subsequent struct can_frame(s).
+
+ RX_FILTER_ID: Filter by can_id alone, no frames required (nframes=0)
+
+ RX_CHECK_DLC: A change of the DLC leads to an RX_CHANGED.
+
+ RX_NO_AUTOTIMER: Prevent automatically starting the timeout monitor.
+
+ RX_ANNOUNCE_RESUME: If passed to RX_SETUP, when a receive timeout occurs,
+ an RX_CHANGED will be generated when the (cyclic) receive restarts.
+
+ TX_RESET_MULTI_IDX: Start multiple frame transmission with index 0.
+
+ RX_RTR_FRAME: send reply for RTR-request (placed in op->frames[0])
+
+ 4.2.3 Broadcast Manager message sequence transmission
+
+ Up to 256 CAN frames can be transmitted in a sequence in the case of a cyclic
+ TX task. The number of CAN frames is provided in the 'nframes' element of the
+ BCM message head. The defined number of CAN frames are added as array to the
+ TX_SETUP BCM configuration message. With every transmission the index in the
+ array of CAN frames is increased and set to zero at index overflow.
+
+ 4.2.4 Broadcast Manager multiplex message receive filter
+
+ To filter for content changes in multiplex message sequences an array of more
+ than one CAN frames can be passed in a RX_SETUP configuration message. The
+ data bytes of the first CAN frame contain the mask of relevant bits that
+ have to match in the subsequent CAN frames with the received CAN frame.
+ If one of the subsequent CAN frames is matching the bits in that frame data
+ mark the relevant content to be compared with the previous received content.
+ Up to 257 CAN frames (multiplex filter bit mask CAN frame plus 256 CAN
+ filters) can be added as array to the TX_SETUP BCM configuration message.
+
4.3 connected transport protocols (SOCK_SEQPACKET)
4.4 unconnected transport protocols (SOCK_DGRAM)
^ permalink raw reply related [flat|nested] 8+ messages in thread
* Re: [PATCH can-next] Add broadcast manager documentation
2013-10-14 19:41 ` [PATCH can-next] Add broadcast " Oliver Hartkopp
@ 2013-10-14 20:02 ` Marc Kleine-Budde
[not found] ` <CAENe87q9PCCJjgzDp-D7GfhJkGeBJU6kog+YuMHKkNbacg1bTA@mail.gmail.com>
2013-10-15 4:57 ` Oliver Hartkopp
0 siblings, 2 replies; 8+ messages in thread
From: Marc Kleine-Budde @ 2013-10-14 20:02 UTC (permalink / raw)
To: Oliver Hartkopp; +Cc: Brian Thorne, linux-can
[-- 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 --]
^ permalink raw reply [flat|nested] 8+ messages in thread
* Re: [PATCH can-next] Add broadcast manager documentation
[not found] ` <CAENe87q9PCCJjgzDp-D7GfhJkGeBJU6kog+YuMHKkNbacg1bTA@mail.gmail.com>
@ 2013-10-14 21:00 ` Brian Thorne
0 siblings, 0 replies; 8+ messages in thread
From: Brian Thorne @ 2013-10-14 21:00 UTC (permalink / raw)
To: linux-can@vger.kernel.org
Hi Oliver,
Your changes all look good to me.
Thanks,
Brian
(Reposting in text mode for mailing list)
>> > Hi Brian,
>> >
>> > I updated and enhanced your documentation patch for the broadcast manager.
>> >
>> > Please review and make your annotations inline.
>> >
>> > Tnx,
>> > Oliver
^ permalink raw reply [flat|nested] 8+ messages in thread
* Re: [PATCH can-next] Add broadcast manager documentation
2013-10-14 20:02 ` Marc Kleine-Budde
[not found] ` <CAENe87q9PCCJjgzDp-D7GfhJkGeBJU6kog+YuMHKkNbacg1bTA@mail.gmail.com>
@ 2013-10-15 4:57 ` Oliver Hartkopp
2013-10-15 7:20 ` Marc Kleine-Budde
1 sibling, 1 reply; 8+ messages in thread
From: Oliver Hartkopp @ 2013-10-15 4:57 UTC (permalink / raw)
To: Marc Kleine-Budde; +Cc: Brian Thorne, linux-can
On 14.10.2013 22:02, Marc Kleine-Budde wrote:
> On 10/14/2013 09:41 PM, Oliver Hartkopp wrote:
>> + 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.
>
AFAIK the uapi directory is the place where the 'user API' relevant header
files are /generated/ at build time. Finally these header files are copied to
/usr/include/linux/...
in the different Linux distributions to be accessed by application developers.
So in the application C code it's still:
#include <linux/can.h>
#include <linux/can/raw.h>
#include <linux/can/bcm.h>
Right?
Regards,
Oliver
^ permalink raw reply [flat|nested] 8+ messages in thread
* Re: [PATCH can-next] Add broadcast manager documentation
2013-10-15 4:57 ` Oliver Hartkopp
@ 2013-10-15 7:20 ` Marc Kleine-Budde
0 siblings, 0 replies; 8+ messages in thread
From: Marc Kleine-Budde @ 2013-10-15 7:20 UTC (permalink / raw)
To: Oliver Hartkopp; +Cc: Brian Thorne, linux-can
[-- Attachment #1: Type: text/plain, Size: 1259 bytes --]
On 10/15/2013 06:57 AM, Oliver Hartkopp wrote:
> On 14.10.2013 22:02, Marc Kleine-Budde wrote:
>> On 10/14/2013 09:41 PM, Oliver Hartkopp wrote:
>
>>> + 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.
>>
>
> AFAIK the uapi directory is the place where the 'user API' relevant header
> files are /generated/ at build time. Finally these header files are copied to
>
> /usr/include/linux/...
>
> in the different Linux distributions to be accessed by application developers.
>
> So in the application C code it's still:
>
> #include <linux/can.h>
> #include <linux/can/raw.h>
> #include <linux/can/bcm.h>
>
> Right?
Correct, from that point of view (which makes more sense).
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 --]
^ permalink raw reply [flat|nested] 8+ messages in thread
end of thread, other threads:[~2013-10-15 7:20 UTC | newest]
Thread overview: 8+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2013-10-08 0:56 [PATCH] Broadcast manager documentation Brian Thorne
2013-10-08 8:24 ` Oliver Hartkopp
2013-10-08 14:03 ` Marc Kleine-Budde
2013-10-14 19:41 ` [PATCH can-next] Add broadcast " Oliver Hartkopp
2013-10-14 20:02 ` Marc Kleine-Budde
[not found] ` <CAENe87q9PCCJjgzDp-D7GfhJkGeBJU6kog+YuMHKkNbacg1bTA@mail.gmail.com>
2013-10-14 21:00 ` Brian Thorne
2013-10-15 4:57 ` Oliver Hartkopp
2013-10-15 7:20 ` Marc Kleine-Budde
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).