* This driver started as a derivative of linux/drivers/net/can/slcan.c
* and my thanks go to the original authors for their inspiration, even
* after almost none of their code is left.
+ *
+ * elmcan.c Author : Max Staudt <max-linux@enpas.org>
+ * slcan.c Author : Oliver Hartkopp <socketcan@hartkopp.net>
+ * slip.c Authors : Laurence Culhane <loz@holmes.demon.co.uk>
+ * Fred N. van Kempen <waltje@uwalt.nl.mugnet.org>
*/
#define pr_fmt(fmt) "[elmcan] " fmt
#define N_DEVELOPMENT 29
#endif
+/* Compatibility for Linux < 5.11 */
+#if LINUX_VERSION_CODE < KERNEL_VERSION(5,11,0)
+#define len can_dlc
+#endif
+
#define ELM327_NAPI_WEIGHT 4
#define ELM327_SIZE_RXBUF 256
#define ELM327_CAN_CONFIG_RECV_BOTH_SFF_EFF 0x2000
#define ELM327_CAN_CONFIG_BAUDRATE_MULT_8_7 0x1000
-#define ELM327_MAGIC_CHAR 'y'
-#define ELM327_MAGIC_STRING "y"
+#define ELM327_DUMMY_CHAR 'y'
+#define ELM327_DUMMY_STRING "y"
#define ELM327_READY_CHAR '>'
/* Bits in elm->cmds_todo */
-enum ELM_TODO {
- TODO_CAN_DATA = 0,
- TODO_CANID_11BIT,
- TODO_CANID_29BIT_LOW,
- TODO_CANID_29BIT_HIGH,
- TODO_CAN_CONFIG_PART2,
- TODO_CAN_CONFIG,
- TODO_RESPONSES,
- TODO_SILENT_MONITOR,
- TODO_INIT
+enum ELM327_TX_DO_BITS {
+ ELM327_TX_DO_CAN_DATA = 0,
+ ELM327_TX_DO_CANID_11BIT,
+ ELM327_TX_DO_CANID_29BIT_LOW,
+ ELM327_TX_DO_CANID_29BIT_HIGH,
+ ELM327_TX_DO_CAN_CONFIG_PART2,
+ ELM327_TX_DO_CAN_CONFIG,
+ ELM327_TX_DO_RESPONSES,
+ ELM327_TX_DO_SILENT_MONITOR,
+ ELM327_TX_DO_INIT
};
struct elmcan {
/* State machine */
enum {
ELM_NOTINIT = 0,
- ELM_GETMAGICCHAR,
+ ELM_GETDUMMYCHAR,
ELM_GETPROMPT,
ELM_RECEIVING,
} state;
/* The CAN frame and config the ELM327 is sending/using,
* or will send/use after finishing all cmds_todo
*/
- struct can_frame can_frame;
+ struct can_frame can_frame_to_send;
unsigned short can_config;
unsigned long can_bitrate;
unsigned char can_bitrate_divisor;
}
/* Take the ELM327 out of almost any state and back into command mode.
- * We send ELM327_MAGIC_CHAR which will either abort any running
+ * We send ELM327_DUMMY_CHAR which will either abort any running
* operation, or be echoed back to us in case we're already in command
* mode.
*
*/
static void elm327_kick_into_cmd_mode(struct elmcan *elm)
{
- if (elm->state != ELM_GETMAGICCHAR && elm->state != ELM_GETPROMPT) {
- elm327_send(elm, ELM327_MAGIC_STRING, 1);
+ if (elm->state != ELM_GETDUMMYCHAR && elm->state != ELM_GETPROMPT) {
+ elm327_send(elm, ELM327_DUMMY_STRING, 1);
- elm->state = ELM_GETMAGICCHAR;
+ elm->state = ELM_GETDUMMYCHAR;
}
}
static void elm327_send_frame(struct elmcan *elm, struct can_frame *frame)
{
/* Schedule any necessary changes in ELM327's CAN configuration */
- if (elm->can_frame.can_id != frame->can_id) {
+ if (elm->can_frame_to_send.can_id != frame->can_id) {
/* Set the new CAN ID for transmission. */
if ((frame->can_id & CAN_EFF_FLAG)
- ^ (elm->can_frame.can_id & CAN_EFF_FLAG)) {
+ ^ (elm->can_frame_to_send.can_id & CAN_EFF_FLAG)) {
elm->can_config = (frame->can_id & CAN_EFF_FLAG
? 0
: ELM327_CAN_CONFIG_SEND_SFF)
| ELM327_CAN_CONFIG_RECV_BOTH_SFF_EFF
| elm->can_bitrate_divisor;
- set_bit(TODO_CAN_CONFIG, &elm->cmds_todo);
+ set_bit(ELM327_TX_DO_CAN_CONFIG, &elm->cmds_todo);
}
if (frame->can_id & CAN_EFF_FLAG) {
- clear_bit(TODO_CANID_11BIT, &elm->cmds_todo);
- set_bit(TODO_CANID_29BIT_LOW, &elm->cmds_todo);
- set_bit(TODO_CANID_29BIT_HIGH, &elm->cmds_todo);
+ clear_bit(ELM327_TX_DO_CANID_11BIT, &elm->cmds_todo);
+ set_bit(ELM327_TX_DO_CANID_29BIT_LOW, &elm->cmds_todo);
+ set_bit(ELM327_TX_DO_CANID_29BIT_HIGH, &elm->cmds_todo);
} else {
- set_bit(TODO_CANID_11BIT, &elm->cmds_todo);
- clear_bit(TODO_CANID_29BIT_LOW, &elm->cmds_todo);
- clear_bit(TODO_CANID_29BIT_HIGH, &elm->cmds_todo);
+ set_bit(ELM327_TX_DO_CANID_11BIT, &elm->cmds_todo);
+ clear_bit(ELM327_TX_DO_CANID_29BIT_LOW, &elm->cmds_todo);
+ clear_bit(ELM327_TX_DO_CANID_29BIT_HIGH, &elm->cmds_todo);
}
}
/* Schedule the CAN frame itself. */
- elm->can_frame = *frame;
- set_bit(TODO_CAN_DATA, &elm->cmds_todo);
+ elm->can_frame_to_send = *frame;
+ set_bit(ELM327_TX_DO_CAN_DATA, &elm->cmds_todo);
elm327_kick_into_cmd_mode(elm);
}
static void elm327_init(struct elmcan *elm)
{
elm->state = ELM_NOTINIT;
- elm->can_frame.can_id = 0x7df;
+ elm->can_frame_to_send.can_id = 0x7df; /* ELM327 HW default */
elm->rxfill = 0;
elm->drop_next_line = 0;
/* Configure ELM327 and then start monitoring */
elm->next_init_cmd = &elm327_init_script[0];
- set_bit(TODO_INIT, &elm->cmds_todo);
- set_bit(TODO_SILENT_MONITOR, &elm->cmds_todo);
- set_bit(TODO_RESPONSES, &elm->cmds_todo);
- set_bit(TODO_CAN_CONFIG, &elm->cmds_todo);
+ set_bit(ELM327_TX_DO_INIT, &elm->cmds_todo);
+ set_bit(ELM327_TX_DO_SILENT_MONITOR, &elm->cmds_todo);
+ set_bit(ELM327_TX_DO_RESPONSES, &elm->cmds_todo);
+ set_bit(ELM327_TX_DO_CAN_CONFIG, &elm->cmds_todo);
elm327_kick_into_cmd_mode(elm);
}
/* Assumes elm->lock taken. */
static void elm327_feed_frame_to_netdev(struct elmcan *elm,
- const struct can_frame *frame)
+ struct sk_buff *skb)
{
- struct can_frame *cf;
- struct sk_buff *skb;
-
if (!netif_running(elm->dev))
return;
- skb = alloc_can_skb(elm->dev, &cf);
-
- if (!skb)
- return;
-
- memcpy(cf, frame, sizeof(struct can_frame));
-
/* Queue for NAPI pickup.
* rx-offload will update stats and LEDs for us.
*/
*/
static inline void elm327_hw_failure(struct elmcan *elm)
{
- struct can_frame frame;
+ struct can_frame *frame;
+ struct sk_buff *skb;
- memset(&frame, 0, sizeof(frame));
- frame.can_id = CAN_ERR_FLAG;
- frame.can_dlc = CAN_ERR_DLC;
- frame.data[5] = 'R';
- frame.data[6] = 'I';
- frame.data[7] = 'P';
- elm327_feed_frame_to_netdev(elm, &frame);
+ elm->hw_failure = true;
+
+ elm->can.can_stats.bus_off++;
+ netif_stop_queue(elm->dev);
+ elm->can.state = CAN_STATE_BUS_OFF;
+ can_bus_off(elm->dev);
netdev_err(elm->dev, "ELM327 misbehaved. Blocking further communication.\n");
- elm->hw_failure = true;
- can_bus_off(elm->dev);
+ skb = alloc_can_err_skb(elm->dev, &frame);
+ if (!skb)
+ return;
+
+ frame->can_id |= CAN_ERR_BUSOFF;
+ elm327_feed_frame_to_netdev(elm, skb);
}
/* Compare a buffer to a fixed string */
-static int _memstrcmp(const u8 *mem, const char *str)
+static inline int _memstrcmp(const u8 *mem, const char *str)
{
return memcmp(mem, str, strlen(str));
}
* buffer, rather than exactly all of it.
* - It avoids byte comparisons in case the length doesn't match.
*/
-static int _len_memstrcmp(const u8 *mem, size_t mem_len, const char *str)
+static inline int _len_memstrcmp(const u8 *mem, size_t mem_len, const char *str)
{
size_t str_len = strlen(str);
/* Assumes elm->lock taken. */
static void elm327_parse_error(struct elmcan *elm, size_t len)
{
- struct can_frame frame;
+ struct can_frame *frame;
+ struct sk_buff *skb;
- memset(&frame, 0, sizeof(frame));
- frame.can_id = CAN_ERR_FLAG;
- frame.can_dlc = CAN_ERR_DLC;
+ skb = alloc_can_err_skb(elm->dev, &frame);
+ if (!skb)
+ /* It's okay to return here:
+ * The outer parsing loop will drop this UART buffer.
+ */
+ return;
/* Filter possible error messages based on length of RX'd line */
if (!_len_memstrcmp(elm->rxbuf, len, "UNABLE TO CONNECT")) {
* Otherwise, elm327_parse_frame() will heuristically
* emit this kind of error frame instead.
*/
- frame.can_id |= CAN_ERR_CRTL;
- frame.data[1] = CAN_ERR_CRTL_RX_OVERFLOW;
+ frame->can_id |= CAN_ERR_CRTL;
+ frame->data[1] = CAN_ERR_CRTL_RX_OVERFLOW;
} else if (!_len_memstrcmp(elm->rxbuf, len, "BUS ERROR")) {
- frame.can_id |= CAN_ERR_BUSERROR;
+ frame->can_id |= CAN_ERR_BUSERROR;
} else if (!_len_memstrcmp(elm->rxbuf, len, "CAN ERROR")) {
- frame.can_id |= CAN_ERR_PROT;
+ frame->can_id |= CAN_ERR_PROT;
} else if (!_len_memstrcmp(elm->rxbuf, len, "<RX ERROR")) {
- frame.can_id |= CAN_ERR_PROT;
+ frame->can_id |= CAN_ERR_PROT;
} else if (!_len_memstrcmp(elm->rxbuf, len, "BUS BUSY")) {
- frame.can_id |= CAN_ERR_PROT;
- frame.data[2] = CAN_ERR_PROT_OVERLOAD;
+ frame->can_id |= CAN_ERR_PROT;
+ frame->data[2] = CAN_ERR_PROT_OVERLOAD;
} else if (!_len_memstrcmp(elm->rxbuf, len, "FB ERROR")) {
- frame.can_id |= CAN_ERR_PROT;
- frame.data[2] = CAN_ERR_PROT_TX;
+ frame->can_id |= CAN_ERR_PROT;
+ frame->data[2] = CAN_ERR_PROT_TX;
} else if (len == 5 && !_memstrcmp(elm->rxbuf, "ERR")) {
/* ERR is followed by two digits, hence line length 5 */
netdev_err(elm->dev, "ELM327 reported an ERR%c%c. Please power it off and on again.\n",
elm->rxbuf[3], elm->rxbuf[4]);
- frame.can_id |= CAN_ERR_CRTL;
+ frame->can_id |= CAN_ERR_CRTL;
} else {
/* Something else has happened.
* Maybe garbage on the UART line.
*/
}
- elm327_feed_frame_to_netdev(elm, &frame);
+ elm327_feed_frame_to_netdev(elm, skb);
}
/* Parse CAN frames coming as ASCII from ELM327.
*/
static int elm327_parse_frame(struct elmcan *elm, size_t len)
{
- struct can_frame frame;
+ struct can_frame *frame;
+ struct sk_buff *skb;
int hexlen;
int datastart;
int i;
- memset(&frame, 0, sizeof(frame));
+ skb = alloc_can_skb(elm->dev, &frame);
+ if (!skb)
+ return -ENOMEM;
/* Find first non-hex and non-space character:
* - In the simplest case, there is none.
if (elm->rxbuf[2] == ' ' && elm->rxbuf[5] == ' ' &&
elm->rxbuf[8] == ' ' && elm->rxbuf[11] == ' ' &&
elm->rxbuf[13] == ' ') {
- frame.can_id = CAN_EFF_FLAG;
+ frame->can_id = CAN_EFF_FLAG;
datastart = 14;
} else if (elm->rxbuf[3] == ' ' && elm->rxbuf[5] == ' ') {
- frame.can_id = 0;
+ frame->can_id = 0;
datastart = 6;
} else {
/* This is not a well-formatted data line.
*/
/* Read CAN data length */
- frame.can_dlc = (hex_to_bin(elm->rxbuf[datastart - 2]) << 0);
+ frame->len = (hex_to_bin(elm->rxbuf[datastart - 2]) << 0);
/* Read CAN ID */
- if (frame.can_id & CAN_EFF_FLAG) {
- frame.can_id |= (hex_to_bin(elm->rxbuf[0]) << 28)
- | (hex_to_bin(elm->rxbuf[1]) << 24)
- | (hex_to_bin(elm->rxbuf[3]) << 20)
- | (hex_to_bin(elm->rxbuf[4]) << 16)
- | (hex_to_bin(elm->rxbuf[6]) << 12)
- | (hex_to_bin(elm->rxbuf[7]) << 8)
- | (hex_to_bin(elm->rxbuf[9]) << 4)
- | (hex_to_bin(elm->rxbuf[10]) << 0);
+ if (frame->can_id & CAN_EFF_FLAG) {
+ frame->can_id |= (hex_to_bin(elm->rxbuf[0]) << 28)
+ | (hex_to_bin(elm->rxbuf[1]) << 24)
+ | (hex_to_bin(elm->rxbuf[3]) << 20)
+ | (hex_to_bin(elm->rxbuf[4]) << 16)
+ | (hex_to_bin(elm->rxbuf[6]) << 12)
+ | (hex_to_bin(elm->rxbuf[7]) << 8)
+ | (hex_to_bin(elm->rxbuf[9]) << 4)
+ | (hex_to_bin(elm->rxbuf[10]) << 0);
} else {
- frame.can_id |= (hex_to_bin(elm->rxbuf[0]) << 8)
- | (hex_to_bin(elm->rxbuf[1]) << 4)
- | (hex_to_bin(elm->rxbuf[2]) << 0);
+ frame->can_id |= (hex_to_bin(elm->rxbuf[0]) << 8)
+ | (hex_to_bin(elm->rxbuf[1]) << 4)
+ | (hex_to_bin(elm->rxbuf[2]) << 0);
}
/* Check for RTR frame */
if (elm->rxfill >= hexlen + 3 &&
!_memstrcmp(&elm->rxbuf[hexlen], "RTR")) {
- frame.can_id |= CAN_RTR_FLAG;
+ frame->can_id |= CAN_RTR_FLAG;
}
/* Is the line long enough to hold the advertised payload?
* Note: RTR frames have a DLC, but no actual payload.
*/
- if (!(frame.can_id & CAN_RTR_FLAG) &&
- (hexlen < frame.can_dlc * 3 + datastart)) {
- /* Incomplete frame. */
-
- /* Probably the ELM327's RS232 TX buffer was full.
+ if (!(frame->can_id & CAN_RTR_FLAG) &&
+ (hexlen < frame->len * 3 + datastart)) {
+ /* Incomplete frame.
+ * Probably the ELM327's RS232 TX buffer was full.
* Emit an error frame and exit.
*/
- frame.can_id = CAN_ERR_FLAG | CAN_ERR_CRTL;
- frame.can_dlc = CAN_ERR_DLC;
- frame.data[1] = CAN_ERR_CRTL_RX_OVERFLOW;
- elm327_feed_frame_to_netdev(elm, &frame);
+ frame->can_id = CAN_ERR_FLAG | CAN_ERR_CRTL;
+ frame->len = CAN_ERR_DLC;
+ frame->data[1] = CAN_ERR_CRTL_RX_OVERFLOW;
+ elm327_feed_frame_to_netdev(elm, skb);
/* Signal failure to parse.
* The line will be re-parsed as an error line, which will fail.
}
/* Parse the data nibbles. */
- for (i = 0; i < frame.can_dlc; i++) {
- frame.data[i] = (hex_to_bin(elm->rxbuf[datastart + 3*i]) << 4)
- | (hex_to_bin(elm->rxbuf[datastart + 3*i + 1]));
+ for (i = 0; i < frame->len; i++) {
+ frame->data[i] = (hex_to_bin(elm->rxbuf[datastart + 3*i]) << 4)
+ | (hex_to_bin(elm->rxbuf[datastart + 3*i + 1]));
}
/* Feed the frame to the network layer. */
- elm327_feed_frame_to_netdev(elm, &frame);
+ elm327_feed_frame_to_netdev(elm, skb);
return 0;
}
}
/* Regular parsing */
- switch (elm->state) {
- case ELM_RECEIVING:
- if (elm327_parse_frame(elm, len)) {
- /* Parse an error line. */
- elm327_parse_error(elm, len);
+ if (elm->state == ELM_RECEIVING
+ && elm327_parse_frame(elm, len)) {
+ /* Parse an error line. */
+ elm327_parse_error(elm, len);
- /* Start afresh. */
- elm327_kick_into_cmd_mode(elm);
- }
- break;
- default:
- break;
+ /* Start afresh. */
+ elm327_kick_into_cmd_mode(elm);
}
}
/* Assumes elm->lock taken. */
static void elm327_handle_prompt(struct elmcan *elm)
{
- struct can_frame *frame = &elm->can_frame;
+ struct can_frame *frame = &elm->can_frame_to_send;
char local_txbuf[20];
if (!elm->cmds_todo) {
}
/* Reconfigure ELM327 step by step as indicated by elm->cmds_todo */
- if (test_bit(TODO_INIT, &elm->cmds_todo)) {
+ if (test_bit(ELM327_TX_DO_INIT, &elm->cmds_todo)) {
strcpy(local_txbuf, *elm->next_init_cmd);
elm->next_init_cmd++;
if (!(*elm->next_init_cmd)) {
- clear_bit(TODO_INIT, &elm->cmds_todo);
- netdev_info(elm->dev, "Initialization finished.\n");
+ clear_bit(ELM327_TX_DO_INIT, &elm->cmds_todo);
+ /* Init finished. */
}
- } else if (test_and_clear_bit(TODO_SILENT_MONITOR, &elm->cmds_todo)) {
+ } else if (test_and_clear_bit(ELM327_TX_DO_SILENT_MONITOR, &elm->cmds_todo)) {
sprintf(local_txbuf, "ATCSM%i\r",
!(!(elm->can.ctrlmode & CAN_CTRLMODE_LISTENONLY)));
- } else if (test_and_clear_bit(TODO_RESPONSES, &elm->cmds_todo)) {
+ } else if (test_and_clear_bit(ELM327_TX_DO_RESPONSES, &elm->cmds_todo)) {
sprintf(local_txbuf, "ATR%i\r",
!(elm->can.ctrlmode & CAN_CTRLMODE_LISTENONLY));
- } else if (test_and_clear_bit(TODO_CAN_CONFIG, &elm->cmds_todo)) {
+ } else if (test_and_clear_bit(ELM327_TX_DO_CAN_CONFIG, &elm->cmds_todo)) {
sprintf(local_txbuf, "ATPC\r");
- set_bit(TODO_CAN_CONFIG_PART2, &elm->cmds_todo);
+ set_bit(ELM327_TX_DO_CAN_CONFIG_PART2, &elm->cmds_todo);
- } else if (test_and_clear_bit(TODO_CAN_CONFIG_PART2, &elm->cmds_todo)) {
+ } else if (test_and_clear_bit(ELM327_TX_DO_CAN_CONFIG_PART2, &elm->cmds_todo)) {
sprintf(local_txbuf, "ATPB%04X\r",
elm->can_config);
- } else if (test_and_clear_bit(TODO_CANID_29BIT_HIGH, &elm->cmds_todo)) {
+ } else if (test_and_clear_bit(ELM327_TX_DO_CANID_29BIT_HIGH, &elm->cmds_todo)) {
sprintf(local_txbuf, "ATCP%02X\r",
(frame->can_id & CAN_EFF_MASK) >> 24);
- } else if (test_and_clear_bit(TODO_CANID_29BIT_LOW, &elm->cmds_todo)) {
+ } else if (test_and_clear_bit(ELM327_TX_DO_CANID_29BIT_LOW, &elm->cmds_todo)) {
sprintf(local_txbuf, "ATSH%06X\r",
frame->can_id & CAN_EFF_MASK & ((1 << 24) - 1));
- } else if (test_and_clear_bit(TODO_CANID_11BIT, &elm->cmds_todo)) {
+ } else if (test_and_clear_bit(ELM327_TX_DO_CANID_11BIT, &elm->cmds_todo)) {
sprintf(local_txbuf, "ATSH%03X\r",
frame->can_id & CAN_SFF_MASK);
- } else if (test_and_clear_bit(TODO_CAN_DATA, &elm->cmds_todo)) {
+ } else if (test_and_clear_bit(ELM327_TX_DO_CAN_DATA, &elm->cmds_todo)) {
if (frame->can_id & CAN_RTR_FLAG) {
/* Send an RTR frame. Their DLC is fixed.
* Some chips don't send them at all.
/* Send a regular CAN data frame */
int i;
- for (i = 0; i < frame->can_dlc; i++) {
+ for (i = 0; i < frame->len; i++) {
sprintf(&local_txbuf[2 * i], "%02X",
frame->data[i]);
}
static void elm327_parse_rxbuf(struct elmcan *elm)
{
size_t len;
+ int i;
switch (elm->state) {
case ELM_NOTINIT:
elm->rxfill = 0;
break;
- case ELM_GETMAGICCHAR:
+ case ELM_GETDUMMYCHAR:
{
/* Wait for 'y' or '>' */
- int i;
-
for (i = 0; i < elm->rxfill; i++) {
- if (elm->rxbuf[i] == ELM327_MAGIC_CHAR) {
+ if (elm->rxbuf[i] == ELM327_DUMMY_CHAR) {
elm327_send(elm, "\r", 1);
elm->state = ELM_GETPROMPT;
i++;
break;
} else if (elm327_is_ready_char(elm->rxbuf[i])) {
- elm327_send(elm, ELM327_MAGIC_STRING, 1);
+ elm327_send(elm, ELM327_DUMMY_STRING, 1);
i++;
break;
}
spin_lock_bh(&elm->lock);
if (elm->tty) {
/* Interrupt whatever we're doing right now */
- elm327_send(elm, ELM327_MAGIC_STRING, 1);
+ elm327_send(elm, ELM327_DUMMY_STRING, 1);
/* Clear the wakeup bit, as the netdev will be down and thus
* the wakeup handler won't clear it
struct elmcan *elm = netdev_priv(dev);
struct can_frame *frame = (struct can_frame *)skb->data;
- if (skb->len != sizeof(struct can_frame))
- goto out;
-
- if (!netif_running(dev)) {
- netdev_warn(elm->dev, "xmit: iface is down.\n");
- goto out;
- }
-
/* BHs are already disabled, so no spin_lock_bh().
* See Documentation/networking/netdevices.txt
*/
spin_unlock(&elm->lock);
dev->stats.tx_packets++;
- dev->stats.tx_bytes += frame->can_dlc;
+ dev->stats.tx_bytes += frame->len;
can_led_event(dev, CAN_LED_EVENT_TX);
{
return (isdigit(c) ||
isupper(c) ||
- c == ELM327_MAGIC_CHAR ||
+ c == ELM327_DUMMY_CHAR ||
c == ELM327_READY_CHAR ||
c == '<' ||
c == 'a' ||
projects / elmcan.git / blobdiff