linux-can.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Nikita Edward Baruzdin <nebaruzdin@gmail.com>
To: linux-can@vger.kernel.org
Subject: [libsocketcan 2/2] Update can_set_ctrlmode() documentation
Date: Mon, 21 Jul 2014 13:43:20 +0400	[thread overview]
Message-ID: <1405935800-26622-5-git-send-email-nebaruzdin@gmail.com> (raw)
In-Reply-To: <1405935800-26622-1-git-send-email-nebaruzdin@gmail.com>

Signed-off-by: Nikita Edward Baruzdin <nebaruzdin@gmail.com>
---
 src/libsocketcan.c | 33 +++++++++++++++------------------
 1 file changed, 15 insertions(+), 18 deletions(-)

diff --git a/src/libsocketcan.c b/src/libsocketcan.c
index fe3a0b3..21884b6 100644
--- a/src/libsocketcan.c
+++ b/src/libsocketcan.c
@@ -774,13 +774,20 @@ int can_set_restart_ms(const char *name, __u32 restart_ms)
  *
  * @param cm pointer of a can_ctrlmode struct
  *
- * This sets the control mode of the can device. There're currently three
- * different control modes:
- * - LOOPBACK
- * - LISTEN_ONLY
- * - TRIPPLE_SAMPLING
+ * This sets the control mode of the can device. There are currently the
+ * following modes available (each mapped to its own macro):
  *
- * You have to define the control mode struct yourself. a can_ctrlmode struct
+ * @code
+ * #define CAN_CTRLMODE_LOOPBACK           0x01    /* Loopback mode */
+ * #define CAN_CTRLMODE_LISTENONLY         0x02    /* Listen-only mode */
+ * #define CAN_CTRLMODE_3_SAMPLES          0x04    /* Triple sampling mode */
+ * #define CAN_CTRLMODE_ONE_SHOT           0x08    /* One-Shot mode */
+ * #define CAN_CTRLMODE_BERR_REPORTING     0x10    /* Bus-error reporting */
+ * #define CAN_CTRLMODE_FD                 0x20    /* CAN FD mode */
+ * #define CAN_CTRLMODE_PRESUME_ACK        0x40    /* Ignore missing CAN ACKs */
+ * @endcode
+ *
+ * You have to define the control mode struct yourself. A can_ctrlmode struct
  * is declared as:
  *
  * @code
@@ -791,16 +798,8 @@ int can_set_restart_ms(const char *name, __u32 restart_ms)
  * @endcode
  *
  * You can use mask to select modes you want to control and flags to determine
- * if you want to turn the selected mode(s) on or off. Every control mode is
- * mapped to an own macro
- *
- * @code
- * #define CAN_CTRLMODE_LOOPBACK   0x1
- * #define CAN_CTRLMODE_LISTENONLY 0x2
- * #define CAN_CTRLMODE_3_SAMPLES  0x4
- * @endcode
- *
- * e.g. the following pseudocode
+ * if you want to turn the selected mode(s) on or off. E. g. the following
+ * pseudocode will turn the loopback mode on and listenonly mode off:
  *
  * @code
  * struct can_ctrlmode cm;
@@ -810,8 +809,6 @@ int can_set_restart_ms(const char *name, __u32 restart_ms)
  * can_set_ctrlmode(candev, &cm);
  * @endcode
  *
- * will turn the loopback mode on and listenonly mode off.
- *
  * @return 0 if success
  * @return -1 if failed
  */
-- 
2.0.2


  parent reply	other threads:[~2014-07-21  9:43 UTC|newest]

Thread overview: 10+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2014-07-21  9:43 CAN_CTRLMODE_PRESUME_ACK follow-up patches Nikita Edward Baruzdin
2014-07-21  9:43 ` [iproute2 1/2] Update CAN netlink header Nikita Edward Baruzdin
2014-07-21 17:51   ` Oliver Hartkopp
2014-07-22 14:09     ` Nikita Edward Baruzdin
2014-07-22 14:23       ` Marc Kleine-Budde
2014-07-21  9:43 ` [iproute2 2/2] iplink: Support for CAN presume-ack feature Nikita Edward Baruzdin
2014-07-21  9:43 ` [libsocketcan 1/2] Update CAN netlink header Nikita Edward Baruzdin
2014-07-21  9:43 ` Nikita Edward Baruzdin [this message]
2014-07-22 14:26   ` [libsocketcan 2/2] Update can_set_ctrlmode() documentation Marc Kleine-Budde
2014-07-22 14:42     ` Nikita Edward Baruzdin

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1405935800-26622-5-git-send-email-nebaruzdin@gmail.com \
    --to=nebaruzdin@gmail.com \
    --cc=linux-can@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
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).