diff options
| author | Nikita Edward Baruzdin <nebaruzdin@gmail.com> | 2014-07-21 13:43:20 +0400 |
|---|---|---|
| committer | Marc Kleine-Budde <mkl@pengutronix.de> | 2014-07-22 16:25:09 +0200 |
| commit | 4ea9ec7cf37a0c52f2c39a13887aaad11042ef5c (patch) | |
| tree | 7bc5bad630818143487f61602c5f368f82ea2c37 /src | |
| parent | 5938ac70cb46673fd8ca47d217db3e4b1ddea31a (diff) | |
| download | libsocketcan-4ea9ec7cf37a0c52f2c39a13887aaad11042ef5c.tar.gz libsocketcan-4ea9ec7cf37a0c52f2c39a13887aaad11042ef5c.tar.xz | |
Update can_set_ctrlmode() documentation
Signed-off-by: Nikita Edward Baruzdin <nebaruzdin@gmail.com>
Signed-off-by: Marc Kleine-Budde <mkl@pengutronix.de>
Diffstat (limited to 'src')
| -rw-r--r-- | src/libsocketcan.c | 33 |
1 files changed, 15 insertions, 18 deletions
diff --git a/src/libsocketcan.c b/src/libsocketcan.c index fe3a0b3..c97a28c 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 */ |