kernel/drivers/net/can/dev.c

   1 /*
   2  * Copyright (C) 2005 Marc Kleine-Budde, Pengutronix
   3  * Copyright (C) 2006 Andrey Volkov, Varma Electronics
   4  * Copyright (C) 2008-2009 Wolfgang Grandegger <wg@grandegger.com>
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the version 2 of the GNU General Public License
   8  * as published by the Free Software Foundation
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program; if not, see <http://www.gnu.org/licenses/>.
  17  */
  18
  19 #include <linux/module.h>
  20 #include <linux/kernel.h>
  21 #include <linux/slab.h>
  22 #include <linux/netdevice.h>
  23 #include <linux/if_arp.h>
  24 #include <linux/can.h>
  25 #include <linux/can/dev.h>
  26 #include <linux/can/skb.h>
  27 #include <linux/can/netlink.h>
  28 #include <linux/can/led.h>
  29 #include <net/rtnetlink.h>
  30
  31 #define MOD_DESC "CAN device driver interface"
  32
  33 MODULE_DESCRIPTION(MOD_DESC);
  34 MODULE_LICENSE("GPL v2");
  35 MODULE_AUTHOR("Wolfgang Grandegger <wg@grandegger.com>");
  36
  37 /* CAN DLC to real data length conversion helpers */
  38
  39 static const u8 dlc2len[] = {0, 1, 2, 3, 4, 5, 6, 7,
  40                              8, 12, 16, 20, 24, 32, 48, 64};
  41
  42 /* get data length from can_dlc with sanitized can_dlc */
  43 u8 can_dlc2len(u8 can_dlc)
  44 {
  45         return dlc2len[can_dlc & 0x0F];
  46 }
  47 EXPORT_SYMBOL_GPL(can_dlc2len);
  48
  49 static const u8 len2dlc[] = {0, 1, 2, 3, 4, 5, 6, 7, 8,         /* 0 - 8 */
  50                              9, 9, 9, 9,                        /* 9 - 12 */
  51                              10, 10, 10, 10,                    /* 13 - 16 */
  52                              11, 11, 11, 11,                    /* 17 - 20 */
  53                              12, 12, 12, 12,                    /* 21 - 24 */
  54                              13, 13, 13, 13, 13, 13, 13, 13,    /* 25 - 32 */
  55                              14, 14, 14, 14, 14, 14, 14, 14,    /* 33 - 40 */
  56                              14, 14, 14, 14, 14, 14, 14, 14,    /* 41 - 48 */
  57                              15, 15, 15, 15, 15, 15, 15, 15,    /* 49 - 56 */
  58                              15, 15, 15, 15, 15, 15, 15, 15};   /* 57 - 64 */
  59
  60 /* map the sanitized data length to an appropriate data length code */
  61 u8 can_len2dlc(u8 len)
  62 {
  63         if (unlikely(len > 64))
  64                 return 0xF;
  65
  66         return len2dlc[len];
  67 }
  68 EXPORT_SYMBOL_GPL(can_len2dlc);
  69
  70 #ifdef CONFIG_CAN_CALC_BITTIMING
  71 #define CAN_CALC_MAX_ERROR 50 /* in one-tenth of a percent */
  72
  73 /*
  74  * Bit-timing calculation derived from:
  75  *
  76  * Code based on LinCAN sources and H8S2638 project
  77  * Copyright 2004-2006 Pavel Pisa - DCE FELK CVUT cz
  78  * Copyright 2005      Stanislav Marek
  79  * email: pisa@cmp.felk.cvut.cz
  80  *
  81  * Calculates proper bit-timing parameters for a specified bit-rate
  82  * and sample-point, which can then be used to set the bit-timing
  83  * registers of the CAN controller. You can find more information
  84  * in the header file linux/can/netlink.h.
  85  */
  86 static int can_update_spt(const struct can_bittiming_const *btc,
  87                           int sampl_pt, int tseg, int *tseg1, int *tseg2)
  88 {
  89         *tseg2 = tseg + 1 - (sampl_pt * (tseg + 1)) / 1000;
  90         if (*tseg2 < btc->tseg2_min)
  91                 *tseg2 = btc->tseg2_min;
  92         if (*tseg2 > btc->tseg2_max)
  93                 *tseg2 = btc->tseg2_max;
  94         *tseg1 = tseg - *tseg2;
  95         if (*tseg1 > btc->tseg1_max) {
  96                 *tseg1 = btc->tseg1_max;
  97                 *tseg2 = tseg - *tseg1;
  98         }
  99         return 1000 * (tseg + 1 - *tseg2) / (tseg + 1);
 100 }
 101
 102 static int can_calc_bittiming(struct net_device *dev, struct can_bittiming *bt,
 103                               const struct can_bittiming_const *btc)
 104 {
 105         struct can_priv *priv = netdev_priv(dev);
 106         long best_error = 1000000000, error = 0;
 107         int best_tseg = 0, best_brp = 0, brp = 0;
 108         int tsegall, tseg = 0, tseg1 = 0, tseg2 = 0;
 109         int spt_error = 1000, spt = 0, sampl_pt;
 110         long rate;
 111         u64 v64;
 112
 113         /* Use CiA recommended sample points */
 114         if (bt->sample_point) {
 115                 sampl_pt = bt->sample_point;
 116         } else {
 117                 if (bt->bitrate > 800000)
 118                         sampl_pt = 750;
 119                 else if (bt->bitrate > 500000)
 120                         sampl_pt = 800;
 121                 else
 122                         sampl_pt = 875;
 123         }
 124
 125         /* tseg even = round down, odd = round up */
 126         for (tseg = (btc->tseg1_max + btc->tseg2_max) * 2 + 1;
 127              tseg >= (btc->tseg1_min + btc->tseg2_min) * 2; tseg--) {
 128                 tsegall = 1 + tseg / 2;
 129                 /* Compute all possible tseg choices (tseg=tseg1+tseg2) */
 130                 brp = priv->clock.freq / (tsegall * bt->bitrate) + tseg % 2;
 131                 /* chose brp step which is possible in system */
 132                 brp = (brp / btc->brp_inc) * btc->brp_inc;
 133                 if ((brp < btc->brp_min) || (brp > btc->brp_max))
 134                         continue;
 135                 rate = priv->clock.freq / (brp * tsegall);
 136                 error = bt->bitrate - rate;
 137                 /* tseg brp biterror */
 138                 if (error < 0)
 139                         error = -error;
 140                 if (error > best_error)
 141                         continue;
 142                 best_error = error;
 143                 if (error == 0) {
 144                         spt = can_update_spt(btc, sampl_pt, tseg / 2,
 145                                              &tseg1, &tseg2);
 146                         error = sampl_pt - spt;
 147                         if (error < 0)
 148                                 error = -error;
 149                         if (error > spt_error)
 150                                 continue;
 151                         spt_error = error;
 152                 }
 153                 best_tseg = tseg / 2;
 154                 best_brp = brp;
 155                 if (error == 0)
 156                         break;
 157         }
 158
 159         if (best_error) {
 160                 /* Error in one-tenth of a percent */
 161                 error = (best_error * 1000) / bt->bitrate;
 162                 if (error > CAN_CALC_MAX_ERROR) {
 163                         netdev_err(dev,
 164                                    "bitrate error %ld.%ld%% too high\n",
 165                                    error / 10, error % 10);
 166                         return -EDOM;
 167                 } else {
 168                         netdev_warn(dev, "bitrate error %ld.%ld%%\n",
 169                                     error / 10, error % 10);
 170                 }
 171         }
 172
 173         /* real sample point */
 174         bt->sample_point = can_update_spt(btc, sampl_pt, best_tseg,
 175                                           &tseg1, &tseg2);
 176
 177         v64 = (u64)best_brp * 1000000000UL;
 178         do_div(v64, priv->clock.freq);
 179         bt->tq = (u32)v64;
 180         bt->prop_seg = tseg1 / 2;
 181         bt->phase_seg1 = tseg1 - bt->prop_seg;
 182         bt->phase_seg2 = tseg2;
 183
 184         /* check for sjw user settings */
 185         if (!bt->sjw || !btc->sjw_max)
 186                 bt->sjw = 1;
 187         else {
 188                 /* bt->sjw is at least 1 -> sanitize upper bound to sjw_max */
 189                 if (bt->sjw > btc->sjw_max)
 190                         bt->sjw = btc->sjw_max;
 191                 /* bt->sjw must not be higher than tseg2 */
 192                 if (tseg2 < bt->sjw)
 193                         bt->sjw = tseg2;
 194         }
 195
 196         bt->brp = best_brp;
 197         /* real bit-rate */
 198         bt->bitrate = priv->clock.freq / (bt->brp * (tseg1 + tseg2 + 1));
 199
 200         return 0;
 201 }
 202 #else /* !CONFIG_CAN_CALC_BITTIMING */
 203 static int can_calc_bittiming(struct net_device *dev, struct can_bittiming *bt,
 204                               const struct can_bittiming_const *btc)
 205 {
 206         netdev_err(dev, "bit-timing calculation not available\n");
 207         return -EINVAL;
 208 }
 209 #endif /* CONFIG_CAN_CALC_BITTIMING */
 210
 211 /*
 212  * Checks the validity of the specified bit-timing parameters prop_seg,
 213  * phase_seg1, phase_seg2 and sjw and tries to determine the bitrate
 214  * prescaler value brp. You can find more information in the header
 215  * file linux/can/netlink.h.
 216  */
 217 static int can_fixup_bittiming(struct net_device *dev, struct can_bittiming *bt,
 218                                const struct can_bittiming_const *btc)
 219 {
 220         struct can_priv *priv = netdev_priv(dev);
 221         int tseg1, alltseg;
 222         u64 brp64;
 223
 224         tseg1 = bt->prop_seg + bt->phase_seg1;
 225         if (!bt->sjw)
 226                 bt->sjw = 1;
 227         if (bt->sjw > btc->sjw_max ||
 228             tseg1 < btc->tseg1_min || tseg1 > btc->tseg1_max ||
 229             bt->phase_seg2 < btc->tseg2_min || bt->phase_seg2 > btc->tseg2_max)
 230                 return -ERANGE;
 231
 232         brp64 = (u64)priv->clock.freq * (u64)bt->tq;
 233         if (btc->brp_inc > 1)
 234                 do_div(brp64, btc->brp_inc);
 235         brp64 += 500000000UL - 1;
 236         do_div(brp64, 1000000000UL); /* the practicable BRP */
 237         if (btc->brp_inc > 1)
 238                 brp64 *= btc->brp_inc;
 239         bt->brp = (u32)brp64;
 240
 241         if (bt->brp < btc->brp_min || bt->brp > btc->brp_max)
 242                 return -EINVAL;
 243
 244         alltseg = bt->prop_seg + bt->phase_seg1 + bt->phase_seg2 + 1;
 245         bt->bitrate = priv->clock.freq / (bt->brp * alltseg);
 246         bt->sample_point = ((tseg1 + 1) * 1000) / alltseg;
 247
 248         return 0;
 249 }
 250
 251 static int can_get_bittiming(struct net_device *dev, struct can_bittiming *bt,
 252                              const struct can_bittiming_const *btc)
 253 {
 254         int err;
 255
 256         /* Check if the CAN device has bit-timing parameters */
 257         if (!btc)
 258                 return -EOPNOTSUPP;
 259
 260         /*
 261          * Depending on the given can_bittiming parameter structure the CAN
 262          * timing parameters are calculated based on the provided bitrate OR
 263          * alternatively the CAN timing parameters (tq, prop_seg, etc.) are
 264          * provided directly which are then checked and fixed up.
 265          */
 266         if (!bt->tq && bt->bitrate)
 267                 err = can_calc_bittiming(dev, bt, btc);
 268         else if (bt->tq && !bt->bitrate)
 269                 err = can_fixup_bittiming(dev, bt, btc);
 270         else
 271                 err = -EINVAL;
 272
 273         return err;
 274 }
 275
 276 static void can_update_state_error_stats(struct net_device *dev,
 277                                          enum can_state new_state)
 278 {
 279         struct can_priv *priv = netdev_priv(dev);
 280
 281         if (new_state <= priv->state)
 282                 return;
 283
 284         switch (new_state) {
 285         case CAN_STATE_ERROR_WARNING:
 286                 priv->can_stats.error_warning++;
 287                 break;
 288         case CAN_STATE_ERROR_PASSIVE:
 289                 priv->can_stats.error_passive++;
 290                 break;
 291         case CAN_STATE_BUS_OFF:
 292                 priv->can_stats.bus_off++;
 293                 break;
 294         default:
 295                 break;
 296         }
 297 }
 298
 299 static int can_tx_state_to_frame(struct net_device *dev, enum can_state state)
 300 {
 301         switch (state) {
 302         case CAN_STATE_ERROR_ACTIVE:
 303                 return CAN_ERR_CRTL_ACTIVE;
 304         case CAN_STATE_ERROR_WARNING:
 305                 return CAN_ERR_CRTL_TX_WARNING;
 306         case CAN_STATE_ERROR_PASSIVE:
 307                 return CAN_ERR_CRTL_TX_PASSIVE;
 308         default:
 309                 return 0;
 310         }
 311 }
 312
 313 static int can_rx_state_to_frame(struct net_device *dev, enum can_state state)
 314 {
 315         switch (state) {
 316         case CAN_STATE_ERROR_ACTIVE:
 317                 return CAN_ERR_CRTL_ACTIVE;
 318         case CAN_STATE_ERROR_WARNING:
 319                 return CAN_ERR_CRTL_RX_WARNING;
 320         case CAN_STATE_ERROR_PASSIVE:
 321                 return CAN_ERR_CRTL_RX_PASSIVE;
 322         default:
 323                 return 0;
 324         }
 325 }
 326
 327 void can_change_state(struct net_device *dev, struct can_frame *cf,
 328                       enum can_state tx_state, enum can_state rx_state)
 329 {
 330         struct can_priv *priv = netdev_priv(dev);
 331         enum can_state new_state = max(tx_state, rx_state);
 332
 333         if (unlikely(new_state == priv->state)) {
 334                 netdev_warn(dev, "%s: oops, state did not change", __func__);
 335                 return;
 336         }
 337
 338         netdev_dbg(dev, "New error state: %d\n", new_state);
 339
 340         can_update_state_error_stats(dev, new_state);
 341         priv->state = new_state;
 342
 343         if (unlikely(new_state == CAN_STATE_BUS_OFF)) {
 344                 cf->can_id |= CAN_ERR_BUSOFF;
 345                 return;
 346         }
 347
 348         cf->can_id |= CAN_ERR_CRTL;
 349         cf->data[1] |= tx_state >= rx_state ?
 350                        can_tx_state_to_frame(dev, tx_state) : 0;
 351         cf->data[1] |= tx_state <= rx_state ?
 352                        can_rx_state_to_frame(dev, rx_state) : 0;
 353 }
 354 EXPORT_SYMBOL_GPL(can_change_state);
 355
 356 /*
 357  * Local echo of CAN messages
 358  *
 359  * CAN network devices *should* support a local echo functionality
 360  * (see Documentation/networking/can.txt). To test the handling of CAN
 361  * interfaces that do not support the local echo both driver types are
 362  * implemented. In the case that the driver does not support the echo
 363  * the IFF_ECHO remains clear in dev->flags. This causes the PF_CAN core
 364  * to perform the echo as a fallback solution.
 365  */
 366 static void can_flush_echo_skb(struct net_device *dev)
 367 {
 368         struct can_priv *priv = netdev_priv(dev);
 369         struct net_device_stats *stats = &dev->stats;
 370         int i;
 371
 372         for (i = 0; i < priv->echo_skb_max; i++) {
 373                 if (priv->echo_skb[i]) {
 374                         kfree_skb(priv->echo_skb[i]);
 375                         priv->echo_skb[i] = NULL;
 376                         stats->tx_dropped++;
 377                         stats->tx_aborted_errors++;
 378                 }
 379         }
 380 }
 381
 382 /*
 383  * Put the skb on the stack to be looped backed locally lateron
 384  *
 385  * The function is typically called in the start_xmit function
 386  * of the device driver. The driver must protect access to
 387  * priv->echo_skb, if necessary.
 388  */
 389 void can_put_echo_skb(struct sk_buff *skb, struct net_device *dev,
 390                       unsigned int idx)
 391 {
 392         struct can_priv *priv = netdev_priv(dev);
 393
 394         BUG_ON(idx >= priv->echo_skb_max);
 395
 396         /* check flag whether this packet has to be looped back */
 397         if (!(dev->flags & IFF_ECHO) || skb->pkt_type != PACKET_LOOPBACK ||
 398             (skb->protocol != htons(ETH_P_CAN) &&
 399              skb->protocol != htons(ETH_P_CANFD))) {
 400                 kfree_skb(skb);
 401                 return;
 402         }
 403
 404         if (!priv->echo_skb[idx]) {
 405
 406                 skb = can_create_echo_skb(skb);
 407                 if (!skb)
 408                         return;
 409
 410                 /* make settings for echo to reduce code in irq context */
 411                 skb->pkt_type = PACKET_BROADCAST;
 412                 skb->ip_summed = CHECKSUM_UNNECESSARY;
 413                 skb->dev = dev;
 414
 415                 /* save this skb for tx interrupt echo handling */
 416                 priv->echo_skb[idx] = skb;
 417         } else {
 418                 /* locking problem with netif_stop_queue() ?? */
 419                 netdev_err(dev, "%s: BUG! echo_skb is occupied!\n", __func__);
 420                 kfree_skb(skb);
 421         }
 422 }
 423 EXPORT_SYMBOL_GPL(can_put_echo_skb);
 424
 425 /*
 426  * Get the skb from the stack and loop it back locally
 427  *
 428  * The function is typically called when the TX done interrupt
 429  * is handled in the device driver. The driver must protect
 430  * access to priv->echo_skb, if necessary.
 431  */
 432 unsigned int can_get_echo_skb(struct net_device *dev, unsigned int idx)
 433 {
 434         struct can_priv *priv = netdev_priv(dev);
 435
 436         BUG_ON(idx >= priv->echo_skb_max);
 437
 438         if (priv->echo_skb[idx]) {
 439                 struct sk_buff *skb = priv->echo_skb[idx];
 440                 struct can_frame *cf = (struct can_frame *)skb->data;
 441                 u8 dlc = cf->can_dlc;
 442
 443                 if (!(skb->tstamp.tv64))
 444                         __net_timestamp(skb);
 445
 446                 netif_rx(priv->echo_skb[idx]);
 447                 priv->echo_skb[idx] = NULL;
 448
 449                 return dlc;
 450         }
 451
 452         return 0;
 453 }
 454 EXPORT_SYMBOL_GPL(can_get_echo_skb);
 455
 456 /*
 457   * Remove the skb from the stack and free it.
 458   *
 459   * The function is typically called when TX failed.
 460   */
 461 void can_free_echo_skb(struct net_device *dev, unsigned int idx)
 462 {
 463         struct can_priv *priv = netdev_priv(dev);
 464
 465         BUG_ON(idx >= priv->echo_skb_max);
 466
 467         if (priv->echo_skb[idx]) {
 468                 dev_kfree_skb_any(priv->echo_skb[idx]);
 469                 priv->echo_skb[idx] = NULL;
 470         }
 471 }
 472 EXPORT_SYMBOL_GPL(can_free_echo_skb);
 473
 474 /*
 475  * CAN device restart for bus-off recovery
 476  */
 477 static void can_restart(unsigned long data)
 478 {
 479         struct net_device *dev = (struct net_device *)data;
 480         struct can_priv *priv = netdev_priv(dev);
 481         struct net_device_stats *stats = &dev->stats;
 482         struct sk_buff *skb;
 483         struct can_frame *cf;
 484         int err;
 485
 486         BUG_ON(netif_carrier_ok(dev));
 487
 488         /*
 489          * No synchronization needed because the device is bus-off and
 490          * no messages can come in or go out.
 491          */
 492         can_flush_echo_skb(dev);
 493
 494         /* send restart message upstream */
 495         skb = alloc_can_err_skb(dev, &cf);
 496         if (skb == NULL) {
 497                 err = -ENOMEM;
 498                 goto restart;
 499         }
 500         cf->can_id |= CAN_ERR_RESTARTED;
 501
 502         netif_rx(skb);
 503
 504         stats->rx_packets++;
 505         stats->rx_bytes += cf->can_dlc;
 506
 507 restart:
 508         netdev_dbg(dev, "restarted\n");
 509         priv->can_stats.restarts++;
 510
 511         /* Now restart the device */
 512         err = priv->do_set_mode(dev, CAN_MODE_START);
 513
 514         netif_carrier_on(dev);
 515         if (err)
 516                 netdev_err(dev, "Error %d during restart", err);
 517 }
 518
 519 int can_restart_now(struct net_device *dev)
 520 {
 521         struct can_priv *priv = netdev_priv(dev);
 522
 523         /*
 524          * A manual restart is only permitted if automatic restart is
 525          * disabled and the device is in the bus-off state
 526          */
 527         if (priv->restart_ms)
 528                 return -EINVAL;
 529         if (priv->state != CAN_STATE_BUS_OFF)
 530                 return -EBUSY;
 531
 532         /* Runs as soon as possible in the timer context */
 533         mod_timer(&priv->restart_timer, jiffies);
 534
 535         return 0;
 536 }
 537
 538 /*
 539  * CAN bus-off
 540  *
 541  * This functions should be called when the device goes bus-off to
 542  * tell the netif layer that no more packets can be sent or received.
 543  * If enabled, a timer is started to trigger bus-off recovery.
 544  */
 545 void can_bus_off(struct net_device *dev)
 546 {
 547         struct can_priv *priv = netdev_priv(dev);
 548
 549         netdev_dbg(dev, "bus-off\n");
 550
 551         netif_carrier_off(dev);
 552
 553         if (priv->restart_ms)
 554                 mod_timer(&priv->restart_timer,
 555                           jiffies + (priv->restart_ms * HZ) / 1000);
 556 }
 557 EXPORT_SYMBOL_GPL(can_bus_off);
 558
 559 static void can_setup(struct net_device *dev)
 560 {
 561         dev->type = ARPHRD_CAN;
 562         dev->mtu = CAN_MTU;
 563         dev->hard_header_len = 0;
 564         dev->addr_len = 0;
 565         dev->tx_queue_len = 10;
 566
 567         /* New-style flags. */
 568         dev->flags = IFF_NOARP;
 569         dev->features = NETIF_F_HW_CSUM;
 570 }
 571
 572 struct sk_buff *alloc_can_skb(struct net_device *dev, struct can_frame **cf)
 573 {
 574         struct sk_buff *skb;
 575
 576         skb = netdev_alloc_skb(dev, sizeof(struct can_skb_priv) +
 577                                sizeof(struct can_frame));
 578         if (unlikely(!skb))
 579                 return NULL;
 580
 581         __net_timestamp(skb);
 582         skb->protocol = htons(ETH_P_CAN);
 583         skb->pkt_type = PACKET_BROADCAST;
 584         skb->ip_summed = CHECKSUM_UNNECESSARY;
 585
 586         skb_reset_mac_header(skb);
 587         skb_reset_network_header(skb);
 588         skb_reset_transport_header(skb);
 589
 590         can_skb_reserve(skb);
 591         can_skb_prv(skb)->ifindex = dev->ifindex;
 592
 593         *cf = (struct can_frame *)skb_put(skb, sizeof(struct can_frame));
 594         memset(*cf, 0, sizeof(struct can_frame));
 595
 596         return skb;
 597 }
 598 EXPORT_SYMBOL_GPL(alloc_can_skb);
 599
 600 struct sk_buff *alloc_canfd_skb(struct net_device *dev,
 601                                 struct canfd_frame **cfd)
 602 {
 603         struct sk_buff *skb;
 604
 605         skb = netdev_alloc_skb(dev, sizeof(struct can_skb_priv) +
 606                                sizeof(struct canfd_frame));
 607         if (unlikely(!skb))
 608                 return NULL;
 609
 610         __net_timestamp(skb);
 611         skb->protocol = htons(ETH_P_CANFD);
 612         skb->pkt_type = PACKET_BROADCAST;
 613         skb->ip_summed = CHECKSUM_UNNECESSARY;
 614
 615         skb_reset_mac_header(skb);
 616         skb_reset_network_header(skb);
 617         skb_reset_transport_header(skb);
 618
 619         can_skb_reserve(skb);
 620         can_skb_prv(skb)->ifindex = dev->ifindex;
 621
 622         *cfd = (struct canfd_frame *)skb_put(skb, sizeof(struct canfd_frame));
 623         memset(*cfd, 0, sizeof(struct canfd_frame));
 624
 625         return skb;
 626 }
 627 EXPORT_SYMBOL_GPL(alloc_canfd_skb);
 628
 629 struct sk_buff *alloc_can_err_skb(struct net_device *dev, struct can_frame **cf)
 630 {
 631         struct sk_buff *skb;
 632
 633         skb = alloc_can_skb(dev, cf);
 634         if (unlikely(!skb))
 635                 return NULL;
 636
 637         (*cf)->can_id = CAN_ERR_FLAG;
 638         (*cf)->can_dlc = CAN_ERR_DLC;
 639
 640         return skb;
 641 }
 642 EXPORT_SYMBOL_GPL(alloc_can_err_skb);
 643
 644 /*
 645  * Allocate and setup space for the CAN network device
 646  */
 647 struct net_device *alloc_candev(int sizeof_priv, unsigned int echo_skb_max)
 648 {
 649         struct net_device *dev;
 650         struct can_priv *priv;
 651         int size;
 652
 653         if (echo_skb_max)
 654                 size = ALIGN(sizeof_priv, sizeof(struct sk_buff *)) +
 655                         echo_skb_max * sizeof(struct sk_buff *);
 656         else
 657                 size = sizeof_priv;
 658
 659         dev = alloc_netdev(size, "can%d", NET_NAME_UNKNOWN, can_setup);
 660         if (!dev)
 661                 return NULL;
 662
 663         priv = netdev_priv(dev);
 664
 665         if (echo_skb_max) {
 666                 priv->echo_skb_max = echo_skb_max;
 667                 priv->echo_skb = (void *)priv +
 668                         ALIGN(sizeof_priv, sizeof(struct sk_buff *));
 669         }
 670
 671         priv->state = CAN_STATE_STOPPED;
 672
 673         init_timer(&priv->restart_timer);
 674
 675         return dev;
 676 }
 677 EXPORT_SYMBOL_GPL(alloc_candev);
 678
 679 /*
 680  * Free space of the CAN network device
 681  */
 682 void free_candev(struct net_device *dev)
 683 {
 684         free_netdev(dev);
 685 }
 686 EXPORT_SYMBOL_GPL(free_candev);
 687
 688 /*
 689  * changing MTU and control mode for CAN/CANFD devices
 690  */
 691 int can_change_mtu(struct net_device *dev, int new_mtu)
 692 {
 693         struct can_priv *priv = netdev_priv(dev);
 694
 695         /* Do not allow changing the MTU while running */
 696         if (dev->flags & IFF_UP)
 697                 return -EBUSY;
 698
 699         /* allow change of MTU according to the CANFD ability of the device */
 700         switch (new_mtu) {
 701         case CAN_MTU:
 702                 priv->ctrlmode &= ~CAN_CTRLMODE_FD;
 703                 break;
 704
 705         case CANFD_MTU:
 706                 if (!(priv->ctrlmode_supported & CAN_CTRLMODE_FD))
 707                         return -EINVAL;
 708
 709                 priv->ctrlmode |= CAN_CTRLMODE_FD;
 710                 break;
 711
 712         default:
 713                 return -EINVAL;
 714         }
 715
 716         dev->mtu = new_mtu;
 717         return 0;
 718 }
 719 EXPORT_SYMBOL_GPL(can_change_mtu);
 720
 721 /*
 722  * Common open function when the device gets opened.
 723  *
 724  * This function should be called in the open function of the device
 725  * driver.
 726  */
 727 int open_candev(struct net_device *dev)
 728 {
 729         struct can_priv *priv = netdev_priv(dev);
 730
 731         if (!priv->bittiming.bitrate) {
 732                 netdev_err(dev, "bit-timing not yet defined\n");
 733                 return -EINVAL;
 734         }
 735
 736         /* For CAN FD the data bitrate has to be >= the arbitration bitrate */
 737         if ((priv->ctrlmode & CAN_CTRLMODE_FD) &&
 738             (!priv->data_bittiming.bitrate ||
 739              (priv->data_bittiming.bitrate < priv->bittiming.bitrate))) {
 740                 netdev_err(dev, "incorrect/missing data bit-timing\n");
 741                 return -EINVAL;
 742         }
 743
 744         /* Switch carrier on if device was stopped while in bus-off state */
 745         if (!netif_carrier_ok(dev))
 746                 netif_carrier_on(dev);
 747
 748         setup_timer(&priv->restart_timer, can_restart, (unsigned long)dev);
 749
 750         return 0;
 751 }
 752 EXPORT_SYMBOL_GPL(open_candev);
 753
 754 /*
 755  * Common close function for cleanup before the device gets closed.
 756  *
 757  * This function should be called in the close function of the device
 758  * driver.
 759  */
 760 void close_candev(struct net_device *dev)
 761 {
 762         struct can_priv *priv = netdev_priv(dev);
 763
 764         del_timer_sync(&priv->restart_timer);
 765         can_flush_echo_skb(dev);
 766 }
 767 EXPORT_SYMBOL_GPL(close_candev);
 768
 769 /*
 770  * CAN netlink interface
 771  */
 772 static const struct nla_policy can_policy[IFLA_CAN_MAX + 1] = {
 773         [IFLA_CAN_STATE]        = { .type = NLA_U32 },
 774         [IFLA_CAN_CTRLMODE]     = { .len = sizeof(struct can_ctrlmode) },
 775         [IFLA_CAN_RESTART_MS]   = { .type = NLA_U32 },
 776         [IFLA_CAN_RESTART]      = { .type = NLA_U32 },
 777         [IFLA_CAN_BITTIMING]    = { .len = sizeof(struct can_bittiming) },
 778         [IFLA_CAN_BITTIMING_CONST]
 779                                 = { .len = sizeof(struct can_bittiming_const) },
 780         [IFLA_CAN_CLOCK]        = { .len = sizeof(struct can_clock) },
 781         [IFLA_CAN_BERR_COUNTER] = { .len = sizeof(struct can_berr_counter) },
 782         [IFLA_CAN_DATA_BITTIMING]
 783                                 = { .len = sizeof(struct can_bittiming) },
 784         [IFLA_CAN_DATA_BITTIMING_CONST]
 785                                 = { .len = sizeof(struct can_bittiming_const) },
 786 };
 787
 788 static int can_changelink(struct net_device *dev,
 789                           struct nlattr *tb[], struct nlattr *data[])
 790 {
 791         struct can_priv *priv = netdev_priv(dev);
 792         int err;
 793
 794         /* We need synchronization with dev->stop() */
 795         ASSERT_RTNL();
 796
 797         if (data[IFLA_CAN_BITTIMING]) {
 798                 struct can_bittiming bt;
 799
 800                 /* Do not allow changing bittiming while running */
 801                 if (dev->flags & IFF_UP)
 802                         return -EBUSY;
 803                 memcpy(&bt, nla_data(data[IFLA_CAN_BITTIMING]), sizeof(bt));
 804                 err = can_get_bittiming(dev, &bt, priv->bittiming_const);
 805                 if (err)
 806                         return err;
 807                 memcpy(&priv->bittiming, &bt, sizeof(bt));
 808
 809                 if (priv->do_set_bittiming) {
 810                         /* Finally, set the bit-timing registers */
 811                         err = priv->do_set_bittiming(dev);
 812                         if (err)
 813                                 return err;
 814                 }
 815         }
 816
 817         if (data[IFLA_CAN_CTRLMODE]) {
 818                 struct can_ctrlmode *cm;
 819
 820                 /* Do not allow changing controller mode while running */
 821                 if (dev->flags & IFF_UP)
 822                         return -EBUSY;
 823                 cm = nla_data(data[IFLA_CAN_CTRLMODE]);
 824
 825                 /* check whether changed bits are allowed to be modified */
 826                 if (cm->mask & ~priv->ctrlmode_supported)
 827                         return -EOPNOTSUPP;
 828
 829                 /* clear bits to be modified and copy the flag values */
 830                 priv->ctrlmode &= ~cm->mask;
 831                 priv->ctrlmode |= (cm->flags & cm->mask);
 832
 833                 /* CAN_CTRLMODE_FD can only be set when driver supports FD */
 834                 if (priv->ctrlmode & CAN_CTRLMODE_FD)
 835                         dev->mtu = CANFD_MTU;
 836                 else
 837                         dev->mtu = CAN_MTU;
 838         }
 839
 840         if (data[IFLA_CAN_RESTART_MS]) {
 841                 /* Do not allow changing restart delay while running */
 842                 if (dev->flags & IFF_UP)
 843                         return -EBUSY;
 844                 priv->restart_ms = nla_get_u32(data[IFLA_CAN_RESTART_MS]);
 845         }
 846
 847         if (data[IFLA_CAN_RESTART]) {
 848                 /* Do not allow a restart while not running */
 849                 if (!(dev->flags & IFF_UP))
 850                         return -EINVAL;
 851                 err = can_restart_now(dev);
 852                 if (err)
 853                         return err;
 854         }
 855
 856         if (data[IFLA_CAN_DATA_BITTIMING]) {
 857                 struct can_bittiming dbt;
 858
 859                 /* Do not allow changing bittiming while running */
 860                 if (dev->flags & IFF_UP)
 861                         return -EBUSY;
 862                 memcpy(&dbt, nla_data(data[IFLA_CAN_DATA_BITTIMING]),
 863                        sizeof(dbt));
 864                 err = can_get_bittiming(dev, &dbt, priv->data_bittiming_const);
 865                 if (err)
 866                         return err;
 867                 memcpy(&priv->data_bittiming, &dbt, sizeof(dbt));
 868
 869                 if (priv->do_set_data_bittiming) {
 870                         /* Finally, set the bit-timing registers */
 871                         err = priv->do_set_data_bittiming(dev);
 872                         if (err)
 873                                 return err;
 874                 }
 875         }
 876
 877         return 0;
 878 }
 879
 880 static size_t can_get_size(const struct net_device *dev)
 881 {
 882         struct can_priv *priv = netdev_priv(dev);
 883         size_t size = 0;
 884
 885         if (priv->bittiming.bitrate)                            /* IFLA_CAN_BITTIMING */
 886                 size += nla_total_size(sizeof(struct can_bittiming));
 887         if (priv->bittiming_const)                              /* IFLA_CAN_BITTIMING_CONST */
 888                 size += nla_total_size(sizeof(struct can_bittiming_const));
 889         size += nla_total_size(sizeof(struct can_clock));       /* IFLA_CAN_CLOCK */
 890         size += nla_total_size(sizeof(u32));                    /* IFLA_CAN_STATE */
 891         size += nla_total_size(sizeof(struct can_ctrlmode));    /* IFLA_CAN_CTRLMODE */
 892         size += nla_total_size(sizeof(u32));                    /* IFLA_CAN_RESTART_MS */
 893         if (priv->do_get_berr_counter)                          /* IFLA_CAN_BERR_COUNTER */
 894                 size += nla_total_size(sizeof(struct can_berr_counter));
 895         if (priv->data_bittiming.bitrate)                       /* IFLA_CAN_DATA_BITTIMING */
 896                 size += nla_total_size(sizeof(struct can_bittiming));
 897         if (priv->data_bittiming_const)                         /* IFLA_CAN_DATA_BITTIMING_CONST */
 898                 size += nla_total_size(sizeof(struct can_bittiming_const));
 899
 900         return size;
 901 }
 902
 903 static int can_fill_info(struct sk_buff *skb, const struct net_device *dev)
 904 {
 905         struct can_priv *priv = netdev_priv(dev);
 906         struct can_ctrlmode cm = {.flags = priv->ctrlmode};
 907         struct can_berr_counter bec;
 908         enum can_state state = priv->state;
 909
 910         if (priv->do_get_state)
 911                 priv->do_get_state(dev, &state);
 912
 913         if ((priv->bittiming.bitrate &&
 914              nla_put(skb, IFLA_CAN_BITTIMING,
 915                      sizeof(priv->bittiming), &priv->bittiming)) ||
 916
 917             (priv->bittiming_const &&
 918              nla_put(skb, IFLA_CAN_BITTIMING_CONST,
 919                      sizeof(*priv->bittiming_const), priv->bittiming_const)) ||
 920
 921             nla_put(skb, IFLA_CAN_CLOCK, sizeof(cm), &priv->clock) ||
 922             nla_put_u32(skb, IFLA_CAN_STATE, state) ||
 923             nla_put(skb, IFLA_CAN_CTRLMODE, sizeof(cm), &cm) ||
 924             nla_put_u32(skb, IFLA_CAN_RESTART_MS, priv->restart_ms) ||
 925
 926             (priv->do_get_berr_counter &&
 927              !priv->do_get_berr_counter(dev, &bec) &&
 928              nla_put(skb, IFLA_CAN_BERR_COUNTER, sizeof(bec), &bec)) ||
 929
 930             (priv->data_bittiming.bitrate &&
 931              nla_put(skb, IFLA_CAN_DATA_BITTIMING,
 932                      sizeof(priv->data_bittiming), &priv->data_bittiming)) ||
 933
 934             (priv->data_bittiming_const &&
 935              nla_put(skb, IFLA_CAN_DATA_BITTIMING_CONST,
 936                      sizeof(*priv->data_bittiming_const),
 937                      priv->data_bittiming_const)))
 938                 return -EMSGSIZE;
 939
 940         return 0;
 941 }
 942
 943 static size_t can_get_xstats_size(const struct net_device *dev)
 944 {
 945         return sizeof(struct can_device_stats);
 946 }
 947
 948 static int can_fill_xstats(struct sk_buff *skb, const struct net_device *dev)
 949 {
 950         struct can_priv *priv = netdev_priv(dev);
 951
 952         if (nla_put(skb, IFLA_INFO_XSTATS,
 953                     sizeof(priv->can_stats), &priv->can_stats))
 954                 goto nla_put_failure;
 955         return 0;
 956
 957 nla_put_failure:
 958         return -EMSGSIZE;
 959 }
 960
 961 static int can_newlink(struct net *src_net, struct net_device *dev,
 962                        struct nlattr *tb[], struct nlattr *data[])
 963 {
 964         return -EOPNOTSUPP;
 965 }
 966
 967 static struct rtnl_link_ops can_link_ops __read_mostly = {
 968         .kind           = "can",
 969         .maxtype        = IFLA_CAN_MAX,
 970         .policy         = can_policy,
 971         .setup          = can_setup,
 972         .newlink        = can_newlink,
 973         .changelink     = can_changelink,
 974         .get_size       = can_get_size,
 975         .fill_info      = can_fill_info,
 976         .get_xstats_size = can_get_xstats_size,
 977         .fill_xstats    = can_fill_xstats,
 978 };
 979
 980 /*
 981  * Register the CAN network device
 982  */
 983 int register_candev(struct net_device *dev)
 984 {
 985         dev->rtnl_link_ops = &can_link_ops;
 986         return register_netdev(dev);
 987 }
 988 EXPORT_SYMBOL_GPL(register_candev);
 989
 990 /*
 991  * Unregister the CAN network device
 992  */
 993 void unregister_candev(struct net_device *dev)
 994 {
 995         unregister_netdev(dev);
 996 }
 997 EXPORT_SYMBOL_GPL(unregister_candev);
 998
 999 /*
1000  * Test if a network device is a candev based device
1001  * and return the can_priv* if so.
1002  */
1003 struct can_priv *safe_candev_priv(struct net_device *dev)
1004 {
1005         if ((dev->type != ARPHRD_CAN) || (dev->rtnl_link_ops != &can_link_ops))
1006                 return NULL;
1007
1008         return netdev_priv(dev);
1009 }
1010 EXPORT_SYMBOL_GPL(safe_candev_priv);
1011
1012 static __init int can_dev_init(void)
1013 {
1014         int err;
1015
1016         can_led_notifier_init();
1017
1018         err = rtnl_link_register(&can_link_ops);
1019         if (!err)
1020                 printk(KERN_INFO MOD_DESC "\n");
1021
1022         return err;
1023 }
1024 module_init(can_dev_init);
1025
1026 static __exit void can_dev_exit(void)
1027 {
1028         rtnl_link_unregister(&can_link_ops);
1029
1030         can_led_notifier_exit();
1031 }
1032 module_exit(can_dev_exit);
1033
1034 MODULE_ALIAS_RTNL_LINK("can");