1 // SPDX-License-Identifier: (GPL-2.0 OR BSD-3-Clause)
2 /* isotp.c - ISO 15765-2 CAN transport protocol for protocol family CAN
4 * This implementation does not provide ISO-TP specific return values to the
7 * - RX path timeout of data reception leads to -ETIMEDOUT
8 * - RX path SN mismatch leads to -EILSEQ
9 * - RX path data reception with wrong padding leads to -EBADMSG
10 * - TX path flowcontrol reception timeout leads to -ECOMM
11 * - TX path flowcontrol reception overflow leads to -EMSGSIZE
12 * - TX path flowcontrol reception with wrong layout/padding leads to -EBADMSG
13 * - when a transfer (tx) is on the run the next write() blocks until it's done
14 * - use CAN_ISOTP_WAIT_TX_DONE flag to block the caller until the PDU is sent
15 * - as we have static buffers the check whether the PDU fits into the buffer
16 * is done at FF reception time (no support for sending 'wait frames')
17 * - take care of the tx-queue-len as traffic shaping is still on the TODO list
19 * Copyright (c) 2020 Volkswagen Group Electronic Research
20 * All rights reserved.
22 * Redistribution and use in source and binary forms, with or without
23 * modification, are permitted provided that the following conditions
25 * 1. Redistributions of source code must retain the above copyright
26 * notice, this list of conditions and the following disclaimer.
27 * 2. Redistributions in binary form must reproduce the above copyright
28 * notice, this list of conditions and the following disclaimer in the
29 * documentation and/or other materials provided with the distribution.
30 * 3. Neither the name of Volkswagen nor the names of its contributors
31 * may be used to endorse or promote products derived from this software
32 * without specific prior written permission.
34 * Alternatively, provided that this notice is retained in full, this
35 * software may be distributed under the terms of the GNU General
36 * Public License ("GPL") version 2, in which case the provisions of the
37 * GPL apply INSTEAD OF those given above.
39 * The provided data structures and external interfaces from this code
40 * are not restricted to be used by modules with a GPL compatible license.
42 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
43 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
44 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
45 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
46 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
47 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
48 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
49 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
50 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
51 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
52 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
56 #include <linux/module.h>
57 #include <linux/init.h>
58 #include <linux/interrupt.h>
59 #include <linux/hrtimer.h>
60 #include <linux/wait.h>
61 #include <linux/uio.h>
62 #include <linux/net.h>
63 #include <linux/netdevice.h>
64 #include <linux/socket.h>
65 #include <linux/if_arp.h>
66 #include <linux/skbuff.h>
67 #include <linux/can.h>
68 #include <linux/can/core.h>
69 #include <linux/can/skb.h>
70 #include <linux/can/isotp.h>
71 #include <linux/slab.h>
73 #include <net/net_namespace.h>
75 MODULE_DESCRIPTION("PF_CAN isotp 15765-2:2016 protocol");
76 MODULE_LICENSE("Dual BSD/GPL");
78 MODULE_ALIAS("can-proto-6");
80 #define ISOTP_MIN_NAMELEN CAN_REQUIRED_SIZE(struct sockaddr_can, can_addr.tp)
82 #define SINGLE_MASK(id) (((id) & CAN_EFF_FLAG) ? \
83 (CAN_EFF_MASK | CAN_EFF_FLAG | CAN_RTR_FLAG) : \
84 (CAN_SFF_MASK | CAN_EFF_FLAG | CAN_RTR_FLAG))
86 /* ISO 15765-2:2016 supports more than 4095 byte per ISO PDU as the FF_DL can
87 * take full 32 bit values (4 Gbyte). We would need some good concept to handle
88 * this between user space and kernel space. For now increase the static buffer
89 * to something about 8 kbyte to be able to test this new functionality.
91 #define MAX_MSG_LENGTH 8200
93 /* N_PCI type values in bits 7-4 of N_PCI bytes */
94 #define N_PCI_SF 0x00 /* single frame */
95 #define N_PCI_FF 0x10 /* first frame */
96 #define N_PCI_CF 0x20 /* consecutive frame */
97 #define N_PCI_FC 0x30 /* flow control */
99 #define N_PCI_SZ 1 /* size of the PCI byte #1 */
100 #define SF_PCI_SZ4 1 /* size of SingleFrame PCI including 4 bit SF_DL */
101 #define SF_PCI_SZ8 2 /* size of SingleFrame PCI including 8 bit SF_DL */
102 #define FF_PCI_SZ12 2 /* size of FirstFrame PCI including 12 bit FF_DL */
103 #define FF_PCI_SZ32 6 /* size of FirstFrame PCI including 32 bit FF_DL */
104 #define FC_CONTENT_SZ 3 /* flow control content size in byte (FS/BS/STmin) */
106 #define ISOTP_CHECK_PADDING (CAN_ISOTP_CHK_PAD_LEN | CAN_ISOTP_CHK_PAD_DATA)
108 /* Flow Status given in FC frame */
109 #define ISOTP_FC_CTS 0 /* clear to send */
110 #define ISOTP_FC_WT 1 /* wait */
111 #define ISOTP_FC_OVFLW 2 /* overflow */
128 u8 buf[MAX_MSG_LENGTH + 1];
138 ktime_t lastrxcf_tstamp;
139 struct hrtimer rxtimer, txtimer;
140 struct can_isotp_options opt;
141 struct can_isotp_fc_options rxfc, txfc;
142 struct can_isotp_ll_options ll;
146 struct notifier_block notifier;
147 wait_queue_head_t wait;
150 static inline struct isotp_sock *isotp_sk(const struct sock *sk)
152 return (struct isotp_sock *)sk;
155 static enum hrtimer_restart isotp_rx_timer_handler(struct hrtimer *hrtimer)
157 struct isotp_sock *so = container_of(hrtimer, struct isotp_sock,
159 struct sock *sk = &so->sk;
161 if (so->rx.state == ISOTP_WAIT_DATA) {
162 /* we did not get new data frames in time */
164 /* report 'connection timed out' */
165 sk->sk_err = ETIMEDOUT;
166 if (!sock_flag(sk, SOCK_DEAD))
167 sk->sk_error_report(sk);
170 so->rx.state = ISOTP_IDLE;
173 return HRTIMER_NORESTART;
176 static int isotp_send_fc(struct sock *sk, int ae, u8 flowstatus)
178 struct net_device *dev;
179 struct sk_buff *nskb;
180 struct canfd_frame *ncf;
181 struct isotp_sock *so = isotp_sk(sk);
184 nskb = alloc_skb(so->ll.mtu + sizeof(struct can_skb_priv), gfp_any());
188 dev = dev_get_by_index(sock_net(sk), so->ifindex);
194 can_skb_reserve(nskb);
195 can_skb_prv(nskb)->ifindex = dev->ifindex;
196 can_skb_prv(nskb)->skbcnt = 0;
199 can_skb_set_owner(nskb, sk);
200 ncf = (struct canfd_frame *)nskb->data;
201 skb_put_zero(nskb, so->ll.mtu);
203 /* create & send flow control reply */
204 ncf->can_id = so->txid;
206 if (so->opt.flags & CAN_ISOTP_TX_PADDING) {
207 memset(ncf->data, so->opt.txpad_content, CAN_MAX_DLEN);
208 ncf->len = CAN_MAX_DLEN;
210 ncf->len = ae + FC_CONTENT_SZ;
213 ncf->data[ae] = N_PCI_FC | flowstatus;
214 ncf->data[ae + 1] = so->rxfc.bs;
215 ncf->data[ae + 2] = so->rxfc.stmin;
218 ncf->data[0] = so->opt.ext_address;
220 ncf->flags = so->ll.tx_flags;
222 can_send_ret = can_send(nskb, 1);
224 pr_notice_once("can-isotp: %s: can_send_ret %d\n",
225 __func__, can_send_ret);
229 /* reset blocksize counter */
232 /* reset last CF frame rx timestamp for rx stmin enforcement */
233 so->lastrxcf_tstamp = ktime_set(0, 0);
235 /* start rx timeout watchdog */
236 hrtimer_start(&so->rxtimer, ktime_set(1, 0), HRTIMER_MODE_REL_SOFT);
240 static void isotp_rcv_skb(struct sk_buff *skb, struct sock *sk)
242 struct sockaddr_can *addr = (struct sockaddr_can *)skb->cb;
244 BUILD_BUG_ON(sizeof(skb->cb) < sizeof(struct sockaddr_can));
246 memset(addr, 0, sizeof(*addr));
247 addr->can_family = AF_CAN;
248 addr->can_ifindex = skb->dev->ifindex;
250 if (sock_queue_rcv_skb(sk, skb) < 0)
254 static u8 padlen(u8 datalen)
256 static const u8 plen[] = {
257 8, 8, 8, 8, 8, 8, 8, 8, 8, /* 0 - 8 */
258 12, 12, 12, 12, /* 9 - 12 */
259 16, 16, 16, 16, /* 13 - 16 */
260 20, 20, 20, 20, /* 17 - 20 */
261 24, 24, 24, 24, /* 21 - 24 */
262 32, 32, 32, 32, 32, 32, 32, 32, /* 25 - 32 */
263 48, 48, 48, 48, 48, 48, 48, 48, /* 33 - 40 */
264 48, 48, 48, 48, 48, 48, 48, 48 /* 41 - 48 */
270 return plen[datalen];
273 /* check for length optimization and return 1/true when the check fails */
274 static int check_optimized(struct canfd_frame *cf, int start_index)
276 /* for CAN_DL <= 8 the start_index is equal to the CAN_DL as the
277 * padding would start at this point. E.g. if the padding would
278 * start at cf.data[7] cf->len has to be 7 to be optimal.
279 * Note: The data[] index starts with zero.
281 if (cf->len <= CAN_MAX_DLEN)
282 return (cf->len != start_index);
284 /* This relation is also valid in the non-linear DLC range, where
285 * we need to take care of the minimal next possible CAN_DL.
286 * The correct check would be (padlen(cf->len) != padlen(start_index)).
287 * But as cf->len can only take discrete values from 12, .., 64 at this
288 * point the padlen(cf->len) is always equal to cf->len.
290 return (cf->len != padlen(start_index));
293 /* check padding and return 1/true when the check fails */
294 static int check_pad(struct isotp_sock *so, struct canfd_frame *cf,
295 int start_index, u8 content)
299 /* no RX_PADDING value => check length of optimized frame length */
300 if (!(so->opt.flags & CAN_ISOTP_RX_PADDING)) {
301 if (so->opt.flags & CAN_ISOTP_CHK_PAD_LEN)
302 return check_optimized(cf, start_index);
304 /* no valid test against empty value => ignore frame */
308 /* check datalength of correctly padded CAN frame */
309 if ((so->opt.flags & CAN_ISOTP_CHK_PAD_LEN) &&
310 cf->len != padlen(cf->len))
313 /* check padding content */
314 if (so->opt.flags & CAN_ISOTP_CHK_PAD_DATA) {
315 for (i = start_index; i < cf->len; i++)
316 if (cf->data[i] != content)
322 static int isotp_rcv_fc(struct isotp_sock *so, struct canfd_frame *cf, int ae)
324 struct sock *sk = &so->sk;
326 if (so->tx.state != ISOTP_WAIT_FC &&
327 so->tx.state != ISOTP_WAIT_FIRST_FC)
330 hrtimer_cancel(&so->txtimer);
332 if ((cf->len < ae + FC_CONTENT_SZ) ||
333 ((so->opt.flags & ISOTP_CHECK_PADDING) &&
334 check_pad(so, cf, ae + FC_CONTENT_SZ, so->opt.rxpad_content))) {
335 /* malformed PDU - report 'not a data message' */
336 sk->sk_err = EBADMSG;
337 if (!sock_flag(sk, SOCK_DEAD))
338 sk->sk_error_report(sk);
340 so->tx.state = ISOTP_IDLE;
341 wake_up_interruptible(&so->wait);
345 /* get communication parameters only from the first FC frame */
346 if (so->tx.state == ISOTP_WAIT_FIRST_FC) {
347 so->txfc.bs = cf->data[ae + 1];
348 so->txfc.stmin = cf->data[ae + 2];
350 /* fix wrong STmin values according spec */
351 if (so->txfc.stmin > 0x7F &&
352 (so->txfc.stmin < 0xF1 || so->txfc.stmin > 0xF9))
353 so->txfc.stmin = 0x7F;
355 so->tx_gap = ktime_set(0, 0);
356 /* add transmission time for CAN frame N_As */
357 so->tx_gap = ktime_add_ns(so->tx_gap, so->opt.frame_txtime);
358 /* add waiting time for consecutive frames N_Cs */
359 if (so->opt.flags & CAN_ISOTP_FORCE_TXSTMIN)
360 so->tx_gap = ktime_add_ns(so->tx_gap,
362 else if (so->txfc.stmin < 0x80)
363 so->tx_gap = ktime_add_ns(so->tx_gap,
364 so->txfc.stmin * 1000000);
366 so->tx_gap = ktime_add_ns(so->tx_gap,
367 (so->txfc.stmin - 0xF0)
369 so->tx.state = ISOTP_WAIT_FC;
372 switch (cf->data[ae] & 0x0F) {
375 so->tx.state = ISOTP_SENDING;
376 /* start cyclic timer for sending CF frame */
377 hrtimer_start(&so->txtimer, so->tx_gap,
378 HRTIMER_MODE_REL_SOFT);
382 /* start timer to wait for next FC frame */
383 hrtimer_start(&so->txtimer, ktime_set(1, 0),
384 HRTIMER_MODE_REL_SOFT);
388 /* overflow on receiver side - report 'message too long' */
389 sk->sk_err = EMSGSIZE;
390 if (!sock_flag(sk, SOCK_DEAD))
391 sk->sk_error_report(sk);
395 /* stop this tx job */
396 so->tx.state = ISOTP_IDLE;
397 wake_up_interruptible(&so->wait);
402 static int isotp_rcv_sf(struct sock *sk, struct canfd_frame *cf, int pcilen,
403 struct sk_buff *skb, int len)
405 struct isotp_sock *so = isotp_sk(sk);
406 struct sk_buff *nskb;
408 hrtimer_cancel(&so->rxtimer);
409 so->rx.state = ISOTP_IDLE;
411 if (!len || len > cf->len - pcilen)
414 if ((so->opt.flags & ISOTP_CHECK_PADDING) &&
415 check_pad(so, cf, pcilen + len, so->opt.rxpad_content)) {
416 /* malformed PDU - report 'not a data message' */
417 sk->sk_err = EBADMSG;
418 if (!sock_flag(sk, SOCK_DEAD))
419 sk->sk_error_report(sk);
423 nskb = alloc_skb(len, gfp_any());
427 memcpy(skb_put(nskb, len), &cf->data[pcilen], len);
429 nskb->tstamp = skb->tstamp;
430 nskb->dev = skb->dev;
431 isotp_rcv_skb(nskb, sk);
435 static int isotp_rcv_ff(struct sock *sk, struct canfd_frame *cf, int ae)
437 struct isotp_sock *so = isotp_sk(sk);
442 hrtimer_cancel(&so->rxtimer);
443 so->rx.state = ISOTP_IDLE;
445 /* get the used sender LL_DL from the (first) CAN frame data length */
446 so->rx.ll_dl = padlen(cf->len);
448 /* the first frame has to use the entire frame up to LL_DL length */
449 if (cf->len != so->rx.ll_dl)
453 so->rx.len = (cf->data[ae] & 0x0F) << 8;
454 so->rx.len += cf->data[ae + 1];
456 /* Check for FF_DL escape sequence supporting 32 bit PDU length */
458 ff_pci_sz = FF_PCI_SZ12;
460 /* FF_DL = 0 => get real length from next 4 bytes */
461 so->rx.len = cf->data[ae + 2] << 24;
462 so->rx.len += cf->data[ae + 3] << 16;
463 so->rx.len += cf->data[ae + 4] << 8;
464 so->rx.len += cf->data[ae + 5];
465 ff_pci_sz = FF_PCI_SZ32;
468 /* take care of a potential SF_DL ESC offset for TX_DL > 8 */
469 off = (so->rx.ll_dl > CAN_MAX_DLEN) ? 1 : 0;
471 if (so->rx.len + ae + off + ff_pci_sz < so->rx.ll_dl)
474 if (so->rx.len > MAX_MSG_LENGTH) {
475 /* send FC frame with overflow status */
476 isotp_send_fc(sk, ae, ISOTP_FC_OVFLW);
480 /* copy the first received data bytes */
482 for (i = ae + ff_pci_sz; i < so->rx.ll_dl; i++)
483 so->rx.buf[so->rx.idx++] = cf->data[i];
485 /* initial setup for this pdu reception */
487 so->rx.state = ISOTP_WAIT_DATA;
489 /* no creation of flow control frames */
490 if (so->opt.flags & CAN_ISOTP_LISTEN_MODE)
493 /* send our first FC frame */
494 isotp_send_fc(sk, ae, ISOTP_FC_CTS);
498 static int isotp_rcv_cf(struct sock *sk, struct canfd_frame *cf, int ae,
501 struct isotp_sock *so = isotp_sk(sk);
502 struct sk_buff *nskb;
505 if (so->rx.state != ISOTP_WAIT_DATA)
508 /* drop if timestamp gap is less than force_rx_stmin nano secs */
509 if (so->opt.flags & CAN_ISOTP_FORCE_RXSTMIN) {
510 if (ktime_to_ns(ktime_sub(skb->tstamp, so->lastrxcf_tstamp)) <
514 so->lastrxcf_tstamp = skb->tstamp;
517 hrtimer_cancel(&so->rxtimer);
519 /* CFs are never longer than the FF */
520 if (cf->len > so->rx.ll_dl)
523 /* CFs have usually the LL_DL length */
524 if (cf->len < so->rx.ll_dl) {
525 /* this is only allowed for the last CF */
526 if (so->rx.len - so->rx.idx > so->rx.ll_dl - ae - N_PCI_SZ)
530 if ((cf->data[ae] & 0x0F) != so->rx.sn) {
531 /* wrong sn detected - report 'illegal byte sequence' */
533 if (!sock_flag(sk, SOCK_DEAD))
534 sk->sk_error_report(sk);
537 so->rx.state = ISOTP_IDLE;
543 for (i = ae + N_PCI_SZ; i < cf->len; i++) {
544 so->rx.buf[so->rx.idx++] = cf->data[i];
545 if (so->rx.idx >= so->rx.len)
549 if (so->rx.idx >= so->rx.len) {
551 so->rx.state = ISOTP_IDLE;
553 if ((so->opt.flags & ISOTP_CHECK_PADDING) &&
554 check_pad(so, cf, i + 1, so->opt.rxpad_content)) {
555 /* malformed PDU - report 'not a data message' */
556 sk->sk_err = EBADMSG;
557 if (!sock_flag(sk, SOCK_DEAD))
558 sk->sk_error_report(sk);
562 nskb = alloc_skb(so->rx.len, gfp_any());
566 memcpy(skb_put(nskb, so->rx.len), so->rx.buf,
569 nskb->tstamp = skb->tstamp;
570 nskb->dev = skb->dev;
571 isotp_rcv_skb(nskb, sk);
575 /* perform blocksize handling, if enabled */
576 if (!so->rxfc.bs || ++so->rx.bs < so->rxfc.bs) {
577 /* start rx timeout watchdog */
578 hrtimer_start(&so->rxtimer, ktime_set(1, 0),
579 HRTIMER_MODE_REL_SOFT);
583 /* no creation of flow control frames */
584 if (so->opt.flags & CAN_ISOTP_LISTEN_MODE)
587 /* we reached the specified blocksize so->rxfc.bs */
588 isotp_send_fc(sk, ae, ISOTP_FC_CTS);
592 static void isotp_rcv(struct sk_buff *skb, void *data)
594 struct sock *sk = (struct sock *)data;
595 struct isotp_sock *so = isotp_sk(sk);
596 struct canfd_frame *cf;
597 int ae = (so->opt.flags & CAN_ISOTP_EXTEND_ADDR) ? 1 : 0;
598 u8 n_pci_type, sf_dl;
600 /* Strictly receive only frames with the configured MTU size
601 * => clear separation of CAN2.0 / CAN FD transport channels
603 if (skb->len != so->ll.mtu)
606 cf = (struct canfd_frame *)skb->data;
608 /* if enabled: check reception of my configured extended address */
609 if (ae && cf->data[0] != so->opt.rx_ext_address)
612 n_pci_type = cf->data[ae] & 0xF0;
614 if (so->opt.flags & CAN_ISOTP_HALF_DUPLEX) {
615 /* check rx/tx path half duplex expectations */
616 if ((so->tx.state != ISOTP_IDLE && n_pci_type != N_PCI_FC) ||
617 (so->rx.state != ISOTP_IDLE && n_pci_type == N_PCI_FC))
621 switch (n_pci_type) {
623 /* tx path: flow control frame containing the FC parameters */
624 isotp_rcv_fc(so, cf, ae);
628 /* rx path: single frame
630 * As we do not have a rx.ll_dl configuration, we can only test
631 * if the CAN frames payload length matches the LL_DL == 8
632 * requirements - no matter if it's CAN 2.0 or CAN FD
635 /* get the SF_DL from the N_PCI byte */
636 sf_dl = cf->data[ae] & 0x0F;
638 if (cf->len <= CAN_MAX_DLEN) {
639 isotp_rcv_sf(sk, cf, SF_PCI_SZ4 + ae, skb, sf_dl);
641 if (skb->len == CANFD_MTU) {
642 /* We have a CAN FD frame and CAN_DL is greater than 8:
643 * Only frames with the SF_DL == 0 ESC value are valid.
645 * If so take care of the increased SF PCI size
646 * (SF_PCI_SZ8) to point to the message content behind
647 * the extended SF PCI info and get the real SF_DL
648 * length value from the formerly first data byte.
651 isotp_rcv_sf(sk, cf, SF_PCI_SZ8 + ae, skb,
652 cf->data[SF_PCI_SZ4 + ae]);
658 /* rx path: first frame */
659 isotp_rcv_ff(sk, cf, ae);
663 /* rx path: consecutive frame */
664 isotp_rcv_cf(sk, cf, ae, skb);
669 static void isotp_fill_dataframe(struct canfd_frame *cf, struct isotp_sock *so,
672 int pcilen = N_PCI_SZ + ae + off;
673 int space = so->tx.ll_dl - pcilen;
674 int num = min_t(int, so->tx.len - so->tx.idx, space);
677 cf->can_id = so->txid;
678 cf->len = num + pcilen;
681 if (so->opt.flags & CAN_ISOTP_TX_PADDING) {
682 /* user requested padding */
683 cf->len = padlen(cf->len);
684 memset(cf->data, so->opt.txpad_content, cf->len);
685 } else if (cf->len > CAN_MAX_DLEN) {
686 /* mandatory padding for CAN FD frames */
687 cf->len = padlen(cf->len);
688 memset(cf->data, CAN_ISOTP_DEFAULT_PAD_CONTENT,
693 for (i = 0; i < num; i++)
694 cf->data[pcilen + i] = so->tx.buf[so->tx.idx++];
697 cf->data[0] = so->opt.ext_address;
700 static void isotp_create_fframe(struct canfd_frame *cf, struct isotp_sock *so,
706 cf->can_id = so->txid;
707 cf->len = so->tx.ll_dl;
709 cf->data[0] = so->opt.ext_address;
711 /* create N_PCI bytes with 12/32 bit FF_DL data length */
712 if (so->tx.len > 4095) {
713 /* use 32 bit FF_DL notation */
714 cf->data[ae] = N_PCI_FF;
715 cf->data[ae + 1] = 0;
716 cf->data[ae + 2] = (u8)(so->tx.len >> 24) & 0xFFU;
717 cf->data[ae + 3] = (u8)(so->tx.len >> 16) & 0xFFU;
718 cf->data[ae + 4] = (u8)(so->tx.len >> 8) & 0xFFU;
719 cf->data[ae + 5] = (u8)so->tx.len & 0xFFU;
720 ff_pci_sz = FF_PCI_SZ32;
722 /* use 12 bit FF_DL notation */
723 cf->data[ae] = (u8)(so->tx.len >> 8) | N_PCI_FF;
724 cf->data[ae + 1] = (u8)so->tx.len & 0xFFU;
725 ff_pci_sz = FF_PCI_SZ12;
728 /* add first data bytes depending on ae */
729 for (i = ae + ff_pci_sz; i < so->tx.ll_dl; i++)
730 cf->data[i] = so->tx.buf[so->tx.idx++];
733 so->tx.state = ISOTP_WAIT_FIRST_FC;
736 static enum hrtimer_restart isotp_tx_timer_handler(struct hrtimer *hrtimer)
738 struct isotp_sock *so = container_of(hrtimer, struct isotp_sock,
740 struct sock *sk = &so->sk;
742 struct net_device *dev;
743 struct canfd_frame *cf;
744 enum hrtimer_restart restart = HRTIMER_NORESTART;
746 int ae = (so->opt.flags & CAN_ISOTP_EXTEND_ADDR) ? 1 : 0;
748 switch (so->tx.state) {
750 case ISOTP_WAIT_FIRST_FC:
752 /* we did not get any flow control frame in time */
754 /* report 'communication error on send' */
756 if (!sock_flag(sk, SOCK_DEAD))
757 sk->sk_error_report(sk);
760 so->tx.state = ISOTP_IDLE;
761 wake_up_interruptible(&so->wait);
766 /* push out the next segmented pdu */
767 dev = dev_get_by_index(sock_net(sk), so->ifindex);
772 skb = alloc_skb(so->ll.mtu + sizeof(struct can_skb_priv),
779 can_skb_reserve(skb);
780 can_skb_prv(skb)->ifindex = dev->ifindex;
781 can_skb_prv(skb)->skbcnt = 0;
783 cf = (struct canfd_frame *)skb->data;
784 skb_put_zero(skb, so->ll.mtu);
786 /* create consecutive frame */
787 isotp_fill_dataframe(cf, so, ae, 0);
789 /* place consecutive frame N_PCI in appropriate index */
790 cf->data[ae] = N_PCI_CF | so->tx.sn++;
794 cf->flags = so->ll.tx_flags;
797 can_skb_set_owner(skb, sk);
799 can_send_ret = can_send(skb, 1);
801 pr_notice_once("can-isotp: %s: can_send_ret %d\n",
802 __func__, can_send_ret);
804 if (so->tx.idx >= so->tx.len) {
806 so->tx.state = ISOTP_IDLE;
808 wake_up_interruptible(&so->wait);
812 if (so->txfc.bs && so->tx.bs >= so->txfc.bs) {
813 /* stop and wait for FC */
814 so->tx.state = ISOTP_WAIT_FC;
816 hrtimer_set_expires(&so->txtimer,
817 ktime_add(ktime_get(),
819 restart = HRTIMER_RESTART;
823 /* no gap between data frames needed => use burst mode */
827 /* start timer to send next data frame with correct delay */
829 hrtimer_set_expires(&so->txtimer,
830 ktime_add(ktime_get(), so->tx_gap));
831 restart = HRTIMER_RESTART;
841 static int isotp_sendmsg(struct socket *sock, struct msghdr *msg, size_t size)
843 struct sock *sk = sock->sk;
844 struct isotp_sock *so = isotp_sk(sk);
846 struct net_device *dev;
847 struct canfd_frame *cf;
848 int ae = (so->opt.flags & CAN_ISOTP_EXTEND_ADDR) ? 1 : 0;
849 int wait_tx_done = (so->opt.flags & CAN_ISOTP_WAIT_TX_DONE) ? 1 : 0;
854 return -EADDRNOTAVAIL;
856 /* we do not support multiple buffers - for now */
857 if (so->tx.state != ISOTP_IDLE || wq_has_sleeper(&so->wait)) {
858 if (msg->msg_flags & MSG_DONTWAIT)
861 /* wait for complete transmission of current pdu */
862 wait_event_interruptible(so->wait, so->tx.state == ISOTP_IDLE);
865 if (!size || size > MAX_MSG_LENGTH)
868 /* take care of a potential SF_DL ESC offset for TX_DL > 8 */
869 off = (so->tx.ll_dl > CAN_MAX_DLEN) ? 1 : 0;
871 /* does the given data fit into a single frame for SF_BROADCAST? */
872 if ((so->opt.flags & CAN_ISOTP_SF_BROADCAST) &&
873 (size > so->tx.ll_dl - SF_PCI_SZ4 - ae - off))
876 err = memcpy_from_msg(so->tx.buf, msg, size);
880 dev = dev_get_by_index(sock_net(sk), so->ifindex);
884 skb = sock_alloc_send_skb(sk, so->ll.mtu + sizeof(struct can_skb_priv),
885 msg->msg_flags & MSG_DONTWAIT, &err);
891 can_skb_reserve(skb);
892 can_skb_prv(skb)->ifindex = dev->ifindex;
893 can_skb_prv(skb)->skbcnt = 0;
895 so->tx.state = ISOTP_SENDING;
899 cf = (struct canfd_frame *)skb->data;
900 skb_put_zero(skb, so->ll.mtu);
902 /* check for single frame transmission depending on TX_DL */
903 if (size <= so->tx.ll_dl - SF_PCI_SZ4 - ae - off) {
904 /* The message size generally fits into a SingleFrame - good.
906 * SF_DL ESC offset optimization:
908 * When TX_DL is greater 8 but the message would still fit
909 * into a 8 byte CAN frame, we can omit the offset.
910 * This prevents a protocol caused length extension from
911 * CAN_DL = 8 to CAN_DL = 12 due to the SF_SL ESC handling.
913 if (size <= CAN_MAX_DLEN - SF_PCI_SZ4 - ae)
916 isotp_fill_dataframe(cf, so, ae, off);
918 /* place single frame N_PCI w/o length in appropriate index */
919 cf->data[ae] = N_PCI_SF;
921 /* place SF_DL size value depending on the SF_DL ESC offset */
923 cf->data[SF_PCI_SZ4 + ae] = size;
925 cf->data[ae] |= size;
927 so->tx.state = ISOTP_IDLE;
928 wake_up_interruptible(&so->wait);
930 /* don't enable wait queue for a single frame transmission */
933 /* send first frame and wait for FC */
935 isotp_create_fframe(cf, so, ae);
937 /* start timeout for FC */
938 hrtimer_start(&so->txtimer, ktime_set(1, 0), HRTIMER_MODE_REL_SOFT);
941 /* send the first or only CAN frame */
942 cf->flags = so->ll.tx_flags;
946 err = can_send(skb, 1);
949 pr_notice_once("can-isotp: %s: can_send_ret %d\n",
955 /* wait for complete transmission of current pdu */
956 wait_event_interruptible(so->wait, so->tx.state == ISOTP_IDLE);
962 static int isotp_recvmsg(struct socket *sock, struct msghdr *msg, size_t size,
965 struct sock *sk = sock->sk;
970 noblock = flags & MSG_DONTWAIT;
971 flags &= ~MSG_DONTWAIT;
973 skb = skb_recv_datagram(sk, flags, noblock, &err);
978 msg->msg_flags |= MSG_TRUNC;
982 err = memcpy_to_msg(msg, skb->data, size);
984 skb_free_datagram(sk, skb);
988 sock_recv_timestamp(msg, sk, skb);
991 __sockaddr_check_size(ISOTP_MIN_NAMELEN);
992 msg->msg_namelen = ISOTP_MIN_NAMELEN;
993 memcpy(msg->msg_name, skb->cb, msg->msg_namelen);
996 skb_free_datagram(sk, skb);
1001 static int isotp_release(struct socket *sock)
1003 struct sock *sk = sock->sk;
1004 struct isotp_sock *so;
1013 /* wait for complete transmission of current pdu */
1014 wait_event_interruptible(so->wait, so->tx.state == ISOTP_IDLE);
1016 unregister_netdevice_notifier(&so->notifier);
1020 hrtimer_cancel(&so->txtimer);
1021 hrtimer_cancel(&so->rxtimer);
1023 /* remove current filters & unregister */
1024 if (so->bound && (!(so->opt.flags & CAN_ISOTP_SF_BROADCAST))) {
1026 struct net_device *dev;
1028 dev = dev_get_by_index(net, so->ifindex);
1030 can_rx_unregister(net, dev, so->rxid,
1031 SINGLE_MASK(so->rxid),
1050 static int isotp_bind(struct socket *sock, struct sockaddr *uaddr, int len)
1052 struct sockaddr_can *addr = (struct sockaddr_can *)uaddr;
1053 struct sock *sk = sock->sk;
1054 struct isotp_sock *so = isotp_sk(sk);
1055 struct net *net = sock_net(sk);
1057 struct net_device *dev;
1059 int notify_enetdown = 0;
1062 if (len < ISOTP_MIN_NAMELEN)
1065 /* do not register frame reception for functional addressing */
1066 if (so->opt.flags & CAN_ISOTP_SF_BROADCAST)
1069 /* do not validate rx address for functional addressing */
1071 if (addr->can_addr.tp.rx_id == addr->can_addr.tp.tx_id)
1072 return -EADDRNOTAVAIL;
1074 if (addr->can_addr.tp.rx_id & (CAN_ERR_FLAG | CAN_RTR_FLAG))
1075 return -EADDRNOTAVAIL;
1078 if (addr->can_addr.tp.tx_id & (CAN_ERR_FLAG | CAN_RTR_FLAG))
1079 return -EADDRNOTAVAIL;
1081 if (!addr->can_ifindex)
1086 if (so->bound && addr->can_ifindex == so->ifindex &&
1087 addr->can_addr.tp.rx_id == so->rxid &&
1088 addr->can_addr.tp.tx_id == so->txid)
1091 dev = dev_get_by_index(net, addr->can_ifindex);
1096 if (dev->type != ARPHRD_CAN) {
1101 if (dev->mtu < so->ll.mtu) {
1106 if (!(dev->flags & IFF_UP))
1107 notify_enetdown = 1;
1109 ifindex = dev->ifindex;
1112 can_rx_register(net, dev, addr->can_addr.tp.rx_id,
1113 SINGLE_MASK(addr->can_addr.tp.rx_id),
1114 isotp_rcv, sk, "isotp", sk);
1118 if (so->bound && do_rx_reg) {
1119 /* unregister old filter */
1121 dev = dev_get_by_index(net, so->ifindex);
1123 can_rx_unregister(net, dev, so->rxid,
1124 SINGLE_MASK(so->rxid),
1131 /* switch to new settings */
1132 so->ifindex = ifindex;
1133 so->rxid = addr->can_addr.tp.rx_id;
1134 so->txid = addr->can_addr.tp.tx_id;
1140 if (notify_enetdown) {
1141 sk->sk_err = ENETDOWN;
1142 if (!sock_flag(sk, SOCK_DEAD))
1143 sk->sk_error_report(sk);
1149 static int isotp_getname(struct socket *sock, struct sockaddr *uaddr, int peer)
1151 struct sockaddr_can *addr = (struct sockaddr_can *)uaddr;
1152 struct sock *sk = sock->sk;
1153 struct isotp_sock *so = isotp_sk(sk);
1158 memset(addr, 0, ISOTP_MIN_NAMELEN);
1159 addr->can_family = AF_CAN;
1160 addr->can_ifindex = so->ifindex;
1161 addr->can_addr.tp.rx_id = so->rxid;
1162 addr->can_addr.tp.tx_id = so->txid;
1164 return ISOTP_MIN_NAMELEN;
1167 static int isotp_setsockopt(struct socket *sock, int level, int optname,
1168 sockptr_t optval, unsigned int optlen)
1170 struct sock *sk = sock->sk;
1171 struct isotp_sock *so = isotp_sk(sk);
1174 if (level != SOL_CAN_ISOTP)
1181 case CAN_ISOTP_OPTS:
1182 if (optlen != sizeof(struct can_isotp_options))
1185 if (copy_from_sockptr(&so->opt, optval, optlen))
1188 /* no separate rx_ext_address is given => use ext_address */
1189 if (!(so->opt.flags & CAN_ISOTP_RX_EXT_ADDR))
1190 so->opt.rx_ext_address = so->opt.ext_address;
1193 case CAN_ISOTP_RECV_FC:
1194 if (optlen != sizeof(struct can_isotp_fc_options))
1197 if (copy_from_sockptr(&so->rxfc, optval, optlen))
1201 case CAN_ISOTP_TX_STMIN:
1202 if (optlen != sizeof(u32))
1205 if (copy_from_sockptr(&so->force_tx_stmin, optval, optlen))
1209 case CAN_ISOTP_RX_STMIN:
1210 if (optlen != sizeof(u32))
1213 if (copy_from_sockptr(&so->force_rx_stmin, optval, optlen))
1217 case CAN_ISOTP_LL_OPTS:
1218 if (optlen == sizeof(struct can_isotp_ll_options)) {
1219 struct can_isotp_ll_options ll;
1221 if (copy_from_sockptr(&ll, optval, optlen))
1224 /* check for correct ISO 11898-1 DLC data length */
1225 if (ll.tx_dl != padlen(ll.tx_dl))
1228 if (ll.mtu != CAN_MTU && ll.mtu != CANFD_MTU)
1231 if (ll.mtu == CAN_MTU &&
1232 (ll.tx_dl > CAN_MAX_DLEN || ll.tx_flags != 0))
1235 memcpy(&so->ll, &ll, sizeof(ll));
1237 /* set ll_dl for tx path to similar place as for rx */
1238 so->tx.ll_dl = ll.tx_dl;
1251 static int isotp_getsockopt(struct socket *sock, int level, int optname,
1252 char __user *optval, int __user *optlen)
1254 struct sock *sk = sock->sk;
1255 struct isotp_sock *so = isotp_sk(sk);
1259 if (level != SOL_CAN_ISOTP)
1261 if (get_user(len, optlen))
1267 case CAN_ISOTP_OPTS:
1268 len = min_t(int, len, sizeof(struct can_isotp_options));
1272 case CAN_ISOTP_RECV_FC:
1273 len = min_t(int, len, sizeof(struct can_isotp_fc_options));
1277 case CAN_ISOTP_TX_STMIN:
1278 len = min_t(int, len, sizeof(u32));
1279 val = &so->force_tx_stmin;
1282 case CAN_ISOTP_RX_STMIN:
1283 len = min_t(int, len, sizeof(u32));
1284 val = &so->force_rx_stmin;
1287 case CAN_ISOTP_LL_OPTS:
1288 len = min_t(int, len, sizeof(struct can_isotp_ll_options));
1293 return -ENOPROTOOPT;
1296 if (put_user(len, optlen))
1298 if (copy_to_user(optval, val, len))
1303 static int isotp_notifier(struct notifier_block *nb, unsigned long msg,
1306 struct net_device *dev = netdev_notifier_info_to_dev(ptr);
1307 struct isotp_sock *so = container_of(nb, struct isotp_sock, notifier);
1308 struct sock *sk = &so->sk;
1310 if (!net_eq(dev_net(dev), sock_net(sk)))
1313 if (dev->type != ARPHRD_CAN)
1316 if (so->ifindex != dev->ifindex)
1320 case NETDEV_UNREGISTER:
1322 /* remove current filters & unregister */
1323 if (so->bound && (!(so->opt.flags & CAN_ISOTP_SF_BROADCAST)))
1324 can_rx_unregister(dev_net(dev), dev, so->rxid,
1325 SINGLE_MASK(so->rxid),
1332 sk->sk_err = ENODEV;
1333 if (!sock_flag(sk, SOCK_DEAD))
1334 sk->sk_error_report(sk);
1338 sk->sk_err = ENETDOWN;
1339 if (!sock_flag(sk, SOCK_DEAD))
1340 sk->sk_error_report(sk);
1347 static int isotp_init(struct sock *sk)
1349 struct isotp_sock *so = isotp_sk(sk);
1354 so->opt.flags = CAN_ISOTP_DEFAULT_FLAGS;
1355 so->opt.ext_address = CAN_ISOTP_DEFAULT_EXT_ADDRESS;
1356 so->opt.rx_ext_address = CAN_ISOTP_DEFAULT_EXT_ADDRESS;
1357 so->opt.rxpad_content = CAN_ISOTP_DEFAULT_PAD_CONTENT;
1358 so->opt.txpad_content = CAN_ISOTP_DEFAULT_PAD_CONTENT;
1359 so->opt.frame_txtime = CAN_ISOTP_DEFAULT_FRAME_TXTIME;
1360 so->rxfc.bs = CAN_ISOTP_DEFAULT_RECV_BS;
1361 so->rxfc.stmin = CAN_ISOTP_DEFAULT_RECV_STMIN;
1362 so->rxfc.wftmax = CAN_ISOTP_DEFAULT_RECV_WFTMAX;
1363 so->ll.mtu = CAN_ISOTP_DEFAULT_LL_MTU;
1364 so->ll.tx_dl = CAN_ISOTP_DEFAULT_LL_TX_DL;
1365 so->ll.tx_flags = CAN_ISOTP_DEFAULT_LL_TX_FLAGS;
1367 /* set ll_dl for tx path to similar place as for rx */
1368 so->tx.ll_dl = so->ll.tx_dl;
1370 so->rx.state = ISOTP_IDLE;
1371 so->tx.state = ISOTP_IDLE;
1373 hrtimer_init(&so->rxtimer, CLOCK_MONOTONIC, HRTIMER_MODE_REL_SOFT);
1374 so->rxtimer.function = isotp_rx_timer_handler;
1375 hrtimer_init(&so->txtimer, CLOCK_MONOTONIC, HRTIMER_MODE_REL_SOFT);
1376 so->txtimer.function = isotp_tx_timer_handler;
1378 init_waitqueue_head(&so->wait);
1380 so->notifier.notifier_call = isotp_notifier;
1381 register_netdevice_notifier(&so->notifier);
1386 static int isotp_sock_no_ioctlcmd(struct socket *sock, unsigned int cmd,
1389 /* no ioctls for socket layer -> hand it down to NIC layer */
1390 return -ENOIOCTLCMD;
1393 static const struct proto_ops isotp_ops = {
1395 .release = isotp_release,
1397 .connect = sock_no_connect,
1398 .socketpair = sock_no_socketpair,
1399 .accept = sock_no_accept,
1400 .getname = isotp_getname,
1401 .poll = datagram_poll,
1402 .ioctl = isotp_sock_no_ioctlcmd,
1403 .gettstamp = sock_gettstamp,
1404 .listen = sock_no_listen,
1405 .shutdown = sock_no_shutdown,
1406 .setsockopt = isotp_setsockopt,
1407 .getsockopt = isotp_getsockopt,
1408 .sendmsg = isotp_sendmsg,
1409 .recvmsg = isotp_recvmsg,
1410 .mmap = sock_no_mmap,
1411 .sendpage = sock_no_sendpage,
1414 static struct proto isotp_proto __read_mostly = {
1415 .name = "CAN_ISOTP",
1416 .owner = THIS_MODULE,
1417 .obj_size = sizeof(struct isotp_sock),
1421 static const struct can_proto isotp_can_proto = {
1423 .protocol = CAN_ISOTP,
1425 .prot = &isotp_proto,
1428 static __init int isotp_module_init(void)
1432 pr_info("can: isotp protocol\n");
1434 err = can_proto_register(&isotp_can_proto);
1436 pr_err("can: registration of isotp protocol failed\n");
1441 static __exit void isotp_module_exit(void)
1443 can_proto_unregister(&isotp_can_proto);
1446 module_init(isotp_module_init);
1447 module_exit(isotp_module_exit);