af_can.c 21 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874
  1. /*
  2. * af_can.c - Protocol family CAN core module
  3. * (used by different CAN protocol modules)
  4. *
  5. * Copyright (c) 2002-2007 Volkswagen Group Electronic Research
  6. * All rights reserved.
  7. *
  8. * Redistribution and use in source and binary forms, with or without
  9. * modification, are permitted provided that the following conditions
  10. * are met:
  11. * 1. Redistributions of source code must retain the above copyright
  12. * notice, this list of conditions and the following disclaimer.
  13. * 2. Redistributions in binary form must reproduce the above copyright
  14. * notice, this list of conditions and the following disclaimer in the
  15. * documentation and/or other materials provided with the distribution.
  16. * 3. Neither the name of Volkswagen nor the names of its contributors
  17. * may be used to endorse or promote products derived from this software
  18. * without specific prior written permission.
  19. *
  20. * Alternatively, provided that this notice is retained in full, this
  21. * software may be distributed under the terms of the GNU General
  22. * Public License ("GPL") version 2, in which case the provisions of the
  23. * GPL apply INSTEAD OF those given above.
  24. *
  25. * The provided data structures and external interfaces from this code
  26. * are not restricted to be used by modules with a GPL compatible license.
  27. *
  28. * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  29. * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  30. * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  31. * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  32. * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  33. * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  34. * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  35. * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  36. * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  37. * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  38. * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
  39. * DAMAGE.
  40. *
  41. * Send feedback to <socketcan-users@lists.berlios.de>
  42. *
  43. */
  44. #include <linux/module.h>
  45. #include <linux/init.h>
  46. #include <linux/kmod.h>
  47. #include <linux/slab.h>
  48. #include <linux/list.h>
  49. #include <linux/spinlock.h>
  50. #include <linux/rcupdate.h>
  51. #include <linux/uaccess.h>
  52. #include <linux/net.h>
  53. #include <linux/netdevice.h>
  54. #include <linux/socket.h>
  55. #include <linux/if_ether.h>
  56. #include <linux/if_arp.h>
  57. #include <linux/skbuff.h>
  58. #include <linux/can.h>
  59. #include <linux/can/core.h>
  60. #include <net/net_namespace.h>
  61. #include <net/sock.h>
  62. #include "af_can.h"
  63. static __initdata const char banner[] = KERN_INFO
  64. "can: controller area network core (" CAN_VERSION_STRING ")\n";
  65. MODULE_DESCRIPTION("Controller Area Network PF_CAN core");
  66. MODULE_LICENSE("Dual BSD/GPL");
  67. MODULE_AUTHOR("Urs Thuermann <urs.thuermann@volkswagen.de>, "
  68. "Oliver Hartkopp <oliver.hartkopp@volkswagen.de>");
  69. MODULE_ALIAS_NETPROTO(PF_CAN);
  70. static int stats_timer __read_mostly = 1;
  71. module_param(stats_timer, int, S_IRUGO);
  72. MODULE_PARM_DESC(stats_timer, "enable timer for statistics (default:on)");
  73. HLIST_HEAD(can_rx_dev_list);
  74. static struct dev_rcv_lists can_rx_alldev_list;
  75. static DEFINE_SPINLOCK(can_rcvlists_lock);
  76. static struct kmem_cache *rcv_cache __read_mostly;
  77. /* table of registered CAN protocols */
  78. static struct can_proto *proto_tab[CAN_NPROTO] __read_mostly;
  79. static DEFINE_SPINLOCK(proto_tab_lock);
  80. struct timer_list can_stattimer; /* timer for statistics update */
  81. struct s_stats can_stats; /* packet statistics */
  82. struct s_pstats can_pstats; /* receive list statistics */
  83. /*
  84. * af_can socket functions
  85. */
  86. static int can_ioctl(struct socket *sock, unsigned int cmd, unsigned long arg)
  87. {
  88. struct sock *sk = sock->sk;
  89. switch (cmd) {
  90. case SIOCGSTAMP:
  91. return sock_get_timestamp(sk, (struct timeval __user *)arg);
  92. default:
  93. return -ENOIOCTLCMD;
  94. }
  95. }
  96. static void can_sock_destruct(struct sock *sk)
  97. {
  98. skb_queue_purge(&sk->sk_receive_queue);
  99. }
  100. static int can_create(struct net *net, struct socket *sock, int protocol)
  101. {
  102. struct sock *sk;
  103. struct can_proto *cp;
  104. int err = 0;
  105. sock->state = SS_UNCONNECTED;
  106. if (protocol < 0 || protocol >= CAN_NPROTO)
  107. return -EINVAL;
  108. if (net != &init_net)
  109. return -EAFNOSUPPORT;
  110. #ifdef CONFIG_MODULES
  111. /* try to load protocol module kernel is modular */
  112. if (!proto_tab[protocol]) {
  113. err = request_module("can-proto-%d", protocol);
  114. /*
  115. * In case of error we only print a message but don't
  116. * return the error code immediately. Below we will
  117. * return -EPROTONOSUPPORT
  118. */
  119. if (err && printk_ratelimit())
  120. printk(KERN_ERR "can: request_module "
  121. "(can-proto-%d) failed.\n", protocol);
  122. }
  123. #endif
  124. spin_lock(&proto_tab_lock);
  125. cp = proto_tab[protocol];
  126. if (cp && !try_module_get(cp->prot->owner))
  127. cp = NULL;
  128. spin_unlock(&proto_tab_lock);
  129. /* check for available protocol and correct usage */
  130. if (!cp)
  131. return -EPROTONOSUPPORT;
  132. if (cp->type != sock->type) {
  133. err = -EPROTONOSUPPORT;
  134. goto errout;
  135. }
  136. if (cp->capability >= 0 && !capable(cp->capability)) {
  137. err = -EPERM;
  138. goto errout;
  139. }
  140. sock->ops = cp->ops;
  141. sk = sk_alloc(net, PF_CAN, GFP_KERNEL, cp->prot);
  142. if (!sk) {
  143. err = -ENOMEM;
  144. goto errout;
  145. }
  146. sock_init_data(sock, sk);
  147. sk->sk_destruct = can_sock_destruct;
  148. if (sk->sk_prot->init)
  149. err = sk->sk_prot->init(sk);
  150. if (err) {
  151. /* release sk on errors */
  152. sock_orphan(sk);
  153. sock_put(sk);
  154. }
  155. errout:
  156. module_put(cp->prot->owner);
  157. return err;
  158. }
  159. /*
  160. * af_can tx path
  161. */
  162. /**
  163. * can_send - transmit a CAN frame (optional with local loopback)
  164. * @skb: pointer to socket buffer with CAN frame in data section
  165. * @loop: loopback for listeners on local CAN sockets (recommended default!)
  166. *
  167. * Return:
  168. * 0 on success
  169. * -ENETDOWN when the selected interface is down
  170. * -ENOBUFS on full driver queue (see net_xmit_errno())
  171. * -ENOMEM when local loopback failed at calling skb_clone()
  172. * -EPERM when trying to send on a non-CAN interface
  173. * -EINVAL when the skb->data does not contain a valid CAN frame
  174. */
  175. int can_send(struct sk_buff *skb, int loop)
  176. {
  177. struct sk_buff *newskb = NULL;
  178. struct can_frame *cf = (struct can_frame *)skb->data;
  179. int err;
  180. if (skb->len != sizeof(struct can_frame) || cf->can_dlc > 8) {
  181. kfree_skb(skb);
  182. return -EINVAL;
  183. }
  184. if (skb->dev->type != ARPHRD_CAN) {
  185. kfree_skb(skb);
  186. return -EPERM;
  187. }
  188. if (!(skb->dev->flags & IFF_UP)) {
  189. kfree_skb(skb);
  190. return -ENETDOWN;
  191. }
  192. skb->protocol = htons(ETH_P_CAN);
  193. skb_reset_network_header(skb);
  194. skb_reset_transport_header(skb);
  195. if (loop) {
  196. /* local loopback of sent CAN frames */
  197. /* indication for the CAN driver: do loopback */
  198. skb->pkt_type = PACKET_LOOPBACK;
  199. /*
  200. * The reference to the originating sock may be required
  201. * by the receiving socket to check whether the frame is
  202. * its own. Example: can_raw sockopt CAN_RAW_RECV_OWN_MSGS
  203. * Therefore we have to ensure that skb->sk remains the
  204. * reference to the originating sock by restoring skb->sk
  205. * after each skb_clone() or skb_orphan() usage.
  206. */
  207. if (!(skb->dev->flags & IFF_ECHO)) {
  208. /*
  209. * If the interface is not capable to do loopback
  210. * itself, we do it here.
  211. */
  212. newskb = skb_clone(skb, GFP_ATOMIC);
  213. if (!newskb) {
  214. kfree_skb(skb);
  215. return -ENOMEM;
  216. }
  217. newskb->sk = skb->sk;
  218. newskb->ip_summed = CHECKSUM_UNNECESSARY;
  219. newskb->pkt_type = PACKET_BROADCAST;
  220. }
  221. } else {
  222. /* indication for the CAN driver: no loopback required */
  223. skb->pkt_type = PACKET_HOST;
  224. }
  225. /* send to netdevice */
  226. err = dev_queue_xmit(skb);
  227. if (err > 0)
  228. err = net_xmit_errno(err);
  229. if (err) {
  230. if (newskb)
  231. kfree_skb(newskb);
  232. return err;
  233. }
  234. if (newskb)
  235. netif_rx(newskb);
  236. /* update statistics */
  237. can_stats.tx_frames++;
  238. can_stats.tx_frames_delta++;
  239. return 0;
  240. }
  241. EXPORT_SYMBOL(can_send);
  242. /*
  243. * af_can rx path
  244. */
  245. static struct dev_rcv_lists *find_dev_rcv_lists(struct net_device *dev)
  246. {
  247. struct dev_rcv_lists *d = NULL;
  248. struct hlist_node *n;
  249. /*
  250. * find receive list for this device
  251. *
  252. * The hlist_for_each_entry*() macros curse through the list
  253. * using the pointer variable n and set d to the containing
  254. * struct in each list iteration. Therefore, after list
  255. * iteration, d is unmodified when the list is empty, and it
  256. * points to last list element, when the list is non-empty
  257. * but no match in the loop body is found. I.e. d is *not*
  258. * NULL when no match is found. We can, however, use the
  259. * cursor variable n to decide if a match was found.
  260. */
  261. hlist_for_each_entry_rcu(d, n, &can_rx_dev_list, list) {
  262. if (d->dev == dev)
  263. break;
  264. }
  265. return n ? d : NULL;
  266. }
  267. static struct hlist_head *find_rcv_list(canid_t *can_id, canid_t *mask,
  268. struct dev_rcv_lists *d)
  269. {
  270. canid_t inv = *can_id & CAN_INV_FILTER; /* save flag before masking */
  271. /* filter error frames */
  272. if (*mask & CAN_ERR_FLAG) {
  273. /* clear CAN_ERR_FLAG in list entry */
  274. *mask &= CAN_ERR_MASK;
  275. return &d->rx[RX_ERR];
  276. }
  277. /* ensure valid values in can_mask */
  278. if (*mask & CAN_EFF_FLAG)
  279. *mask &= (CAN_EFF_MASK | CAN_EFF_FLAG | CAN_RTR_FLAG);
  280. else
  281. *mask &= (CAN_SFF_MASK | CAN_RTR_FLAG);
  282. /* reduce condition testing at receive time */
  283. *can_id &= *mask;
  284. /* inverse can_id/can_mask filter */
  285. if (inv)
  286. return &d->rx[RX_INV];
  287. /* mask == 0 => no condition testing at receive time */
  288. if (!(*mask))
  289. return &d->rx[RX_ALL];
  290. /* use extra filterset for the subscription of exactly *ONE* can_id */
  291. if (*can_id & CAN_EFF_FLAG) {
  292. if (*mask == (CAN_EFF_MASK | CAN_EFF_FLAG)) {
  293. /* RFC: a use-case for hash-tables in the future? */
  294. return &d->rx[RX_EFF];
  295. }
  296. } else {
  297. if (*mask == CAN_SFF_MASK)
  298. return &d->rx_sff[*can_id];
  299. }
  300. /* default: filter via can_id/can_mask */
  301. return &d->rx[RX_FIL];
  302. }
  303. /**
  304. * can_rx_register - subscribe CAN frames from a specific interface
  305. * @dev: pointer to netdevice (NULL => subcribe from 'all' CAN devices list)
  306. * @can_id: CAN identifier (see description)
  307. * @mask: CAN mask (see description)
  308. * @func: callback function on filter match
  309. * @data: returned parameter for callback function
  310. * @ident: string for calling module indentification
  311. *
  312. * Description:
  313. * Invokes the callback function with the received sk_buff and the given
  314. * parameter 'data' on a matching receive filter. A filter matches, when
  315. *
  316. * <received_can_id> & mask == can_id & mask
  317. *
  318. * The filter can be inverted (CAN_INV_FILTER bit set in can_id) or it can
  319. * filter for error frames (CAN_ERR_FLAG bit set in mask).
  320. *
  321. * Return:
  322. * 0 on success
  323. * -ENOMEM on missing cache mem to create subscription entry
  324. * -ENODEV unknown device
  325. */
  326. int can_rx_register(struct net_device *dev, canid_t can_id, canid_t mask,
  327. void (*func)(struct sk_buff *, void *), void *data,
  328. char *ident)
  329. {
  330. struct receiver *r;
  331. struct hlist_head *rl;
  332. struct dev_rcv_lists *d;
  333. int err = 0;
  334. /* insert new receiver (dev,canid,mask) -> (func,data) */
  335. r = kmem_cache_alloc(rcv_cache, GFP_KERNEL);
  336. if (!r)
  337. return -ENOMEM;
  338. spin_lock(&can_rcvlists_lock);
  339. d = find_dev_rcv_lists(dev);
  340. if (d) {
  341. rl = find_rcv_list(&can_id, &mask, d);
  342. r->can_id = can_id;
  343. r->mask = mask;
  344. r->matches = 0;
  345. r->func = func;
  346. r->data = data;
  347. r->ident = ident;
  348. hlist_add_head_rcu(&r->list, rl);
  349. d->entries++;
  350. can_pstats.rcv_entries++;
  351. if (can_pstats.rcv_entries_max < can_pstats.rcv_entries)
  352. can_pstats.rcv_entries_max = can_pstats.rcv_entries;
  353. } else {
  354. kmem_cache_free(rcv_cache, r);
  355. err = -ENODEV;
  356. }
  357. spin_unlock(&can_rcvlists_lock);
  358. return err;
  359. }
  360. EXPORT_SYMBOL(can_rx_register);
  361. /*
  362. * can_rx_delete_device - rcu callback for dev_rcv_lists structure removal
  363. */
  364. static void can_rx_delete_device(struct rcu_head *rp)
  365. {
  366. struct dev_rcv_lists *d = container_of(rp, struct dev_rcv_lists, rcu);
  367. kfree(d);
  368. }
  369. /*
  370. * can_rx_delete_receiver - rcu callback for single receiver entry removal
  371. */
  372. static void can_rx_delete_receiver(struct rcu_head *rp)
  373. {
  374. struct receiver *r = container_of(rp, struct receiver, rcu);
  375. kmem_cache_free(rcv_cache, r);
  376. }
  377. /**
  378. * can_rx_unregister - unsubscribe CAN frames from a specific interface
  379. * @dev: pointer to netdevice (NULL => unsubcribe from 'all' CAN devices list)
  380. * @can_id: CAN identifier
  381. * @mask: CAN mask
  382. * @func: callback function on filter match
  383. * @data: returned parameter for callback function
  384. *
  385. * Description:
  386. * Removes subscription entry depending on given (subscription) values.
  387. */
  388. void can_rx_unregister(struct net_device *dev, canid_t can_id, canid_t mask,
  389. void (*func)(struct sk_buff *, void *), void *data)
  390. {
  391. struct receiver *r = NULL;
  392. struct hlist_head *rl;
  393. struct hlist_node *next;
  394. struct dev_rcv_lists *d;
  395. spin_lock(&can_rcvlists_lock);
  396. d = find_dev_rcv_lists(dev);
  397. if (!d) {
  398. printk(KERN_ERR "BUG: receive list not found for "
  399. "dev %s, id %03X, mask %03X\n",
  400. DNAME(dev), can_id, mask);
  401. goto out;
  402. }
  403. rl = find_rcv_list(&can_id, &mask, d);
  404. /*
  405. * Search the receiver list for the item to delete. This should
  406. * exist, since no receiver may be unregistered that hasn't
  407. * been registered before.
  408. */
  409. hlist_for_each_entry_rcu(r, next, rl, list) {
  410. if (r->can_id == can_id && r->mask == mask
  411. && r->func == func && r->data == data)
  412. break;
  413. }
  414. /*
  415. * Check for bugs in CAN protocol implementations:
  416. * If no matching list item was found, the list cursor variable next
  417. * will be NULL, while r will point to the last item of the list.
  418. */
  419. if (!next) {
  420. printk(KERN_ERR "BUG: receive list entry not found for "
  421. "dev %s, id %03X, mask %03X\n",
  422. DNAME(dev), can_id, mask);
  423. r = NULL;
  424. d = NULL;
  425. goto out;
  426. }
  427. hlist_del_rcu(&r->list);
  428. d->entries--;
  429. if (can_pstats.rcv_entries > 0)
  430. can_pstats.rcv_entries--;
  431. /* remove device structure requested by NETDEV_UNREGISTER */
  432. if (d->remove_on_zero_entries && !d->entries)
  433. hlist_del_rcu(&d->list);
  434. else
  435. d = NULL;
  436. out:
  437. spin_unlock(&can_rcvlists_lock);
  438. /* schedule the receiver item for deletion */
  439. if (r)
  440. call_rcu(&r->rcu, can_rx_delete_receiver);
  441. /* schedule the device structure for deletion */
  442. if (d)
  443. call_rcu(&d->rcu, can_rx_delete_device);
  444. }
  445. EXPORT_SYMBOL(can_rx_unregister);
  446. static inline void deliver(struct sk_buff *skb, struct receiver *r)
  447. {
  448. struct sk_buff *clone = skb_clone(skb, GFP_ATOMIC);
  449. if (clone) {
  450. clone->sk = skb->sk;
  451. r->func(clone, r->data);
  452. r->matches++;
  453. }
  454. }
  455. static int can_rcv_filter(struct dev_rcv_lists *d, struct sk_buff *skb)
  456. {
  457. struct receiver *r;
  458. struct hlist_node *n;
  459. int matches = 0;
  460. struct can_frame *cf = (struct can_frame *)skb->data;
  461. canid_t can_id = cf->can_id;
  462. if (d->entries == 0)
  463. return 0;
  464. if (can_id & CAN_ERR_FLAG) {
  465. /* check for error frame entries only */
  466. hlist_for_each_entry_rcu(r, n, &d->rx[RX_ERR], list) {
  467. if (can_id & r->mask) {
  468. deliver(skb, r);
  469. matches++;
  470. }
  471. }
  472. return matches;
  473. }
  474. /* check for unfiltered entries */
  475. hlist_for_each_entry_rcu(r, n, &d->rx[RX_ALL], list) {
  476. deliver(skb, r);
  477. matches++;
  478. }
  479. /* check for can_id/mask entries */
  480. hlist_for_each_entry_rcu(r, n, &d->rx[RX_FIL], list) {
  481. if ((can_id & r->mask) == r->can_id) {
  482. deliver(skb, r);
  483. matches++;
  484. }
  485. }
  486. /* check for inverted can_id/mask entries */
  487. hlist_for_each_entry_rcu(r, n, &d->rx[RX_INV], list) {
  488. if ((can_id & r->mask) != r->can_id) {
  489. deliver(skb, r);
  490. matches++;
  491. }
  492. }
  493. /* check CAN_ID specific entries */
  494. if (can_id & CAN_EFF_FLAG) {
  495. hlist_for_each_entry_rcu(r, n, &d->rx[RX_EFF], list) {
  496. if (r->can_id == can_id) {
  497. deliver(skb, r);
  498. matches++;
  499. }
  500. }
  501. } else {
  502. can_id &= CAN_SFF_MASK;
  503. hlist_for_each_entry_rcu(r, n, &d->rx_sff[can_id], list) {
  504. deliver(skb, r);
  505. matches++;
  506. }
  507. }
  508. return matches;
  509. }
  510. static int can_rcv(struct sk_buff *skb, struct net_device *dev,
  511. struct packet_type *pt, struct net_device *orig_dev)
  512. {
  513. struct dev_rcv_lists *d;
  514. struct can_frame *cf = (struct can_frame *)skb->data;
  515. int matches;
  516. if (dev->type != ARPHRD_CAN || !net_eq(dev_net(dev), &init_net)) {
  517. kfree_skb(skb);
  518. return 0;
  519. }
  520. BUG_ON(skb->len != sizeof(struct can_frame) || cf->can_dlc > 8);
  521. /* update statistics */
  522. can_stats.rx_frames++;
  523. can_stats.rx_frames_delta++;
  524. rcu_read_lock();
  525. /* deliver the packet to sockets listening on all devices */
  526. matches = can_rcv_filter(&can_rx_alldev_list, skb);
  527. /* find receive list for this device */
  528. d = find_dev_rcv_lists(dev);
  529. if (d)
  530. matches += can_rcv_filter(d, skb);
  531. rcu_read_unlock();
  532. /* free the skbuff allocated by the netdevice driver */
  533. kfree_skb(skb);
  534. if (matches > 0) {
  535. can_stats.matches++;
  536. can_stats.matches_delta++;
  537. }
  538. return 0;
  539. }
  540. /*
  541. * af_can protocol functions
  542. */
  543. /**
  544. * can_proto_register - register CAN transport protocol
  545. * @cp: pointer to CAN protocol structure
  546. *
  547. * Return:
  548. * 0 on success
  549. * -EINVAL invalid (out of range) protocol number
  550. * -EBUSY protocol already in use
  551. * -ENOBUF if proto_register() fails
  552. */
  553. int can_proto_register(struct can_proto *cp)
  554. {
  555. int proto = cp->protocol;
  556. int err = 0;
  557. if (proto < 0 || proto >= CAN_NPROTO) {
  558. printk(KERN_ERR "can: protocol number %d out of range\n",
  559. proto);
  560. return -EINVAL;
  561. }
  562. err = proto_register(cp->prot, 0);
  563. if (err < 0)
  564. return err;
  565. spin_lock(&proto_tab_lock);
  566. if (proto_tab[proto]) {
  567. printk(KERN_ERR "can: protocol %d already registered\n",
  568. proto);
  569. err = -EBUSY;
  570. } else {
  571. proto_tab[proto] = cp;
  572. /* use generic ioctl function if not defined by module */
  573. if (!cp->ops->ioctl)
  574. cp->ops->ioctl = can_ioctl;
  575. }
  576. spin_unlock(&proto_tab_lock);
  577. if (err < 0)
  578. proto_unregister(cp->prot);
  579. return err;
  580. }
  581. EXPORT_SYMBOL(can_proto_register);
  582. /**
  583. * can_proto_unregister - unregister CAN transport protocol
  584. * @cp: pointer to CAN protocol structure
  585. */
  586. void can_proto_unregister(struct can_proto *cp)
  587. {
  588. int proto = cp->protocol;
  589. spin_lock(&proto_tab_lock);
  590. if (!proto_tab[proto]) {
  591. printk(KERN_ERR "BUG: can: protocol %d is not registered\n",
  592. proto);
  593. }
  594. proto_tab[proto] = NULL;
  595. spin_unlock(&proto_tab_lock);
  596. proto_unregister(cp->prot);
  597. }
  598. EXPORT_SYMBOL(can_proto_unregister);
  599. /*
  600. * af_can notifier to create/remove CAN netdevice specific structs
  601. */
  602. static int can_notifier(struct notifier_block *nb, unsigned long msg,
  603. void *data)
  604. {
  605. struct net_device *dev = (struct net_device *)data;
  606. struct dev_rcv_lists *d;
  607. if (!net_eq(dev_net(dev), &init_net))
  608. return NOTIFY_DONE;
  609. if (dev->type != ARPHRD_CAN)
  610. return NOTIFY_DONE;
  611. switch (msg) {
  612. case NETDEV_REGISTER:
  613. /*
  614. * create new dev_rcv_lists for this device
  615. *
  616. * N.B. zeroing the struct is the correct initialization
  617. * for the embedded hlist_head structs.
  618. * Another list type, e.g. list_head, would require
  619. * explicit initialization.
  620. */
  621. d = kzalloc(sizeof(*d), GFP_KERNEL);
  622. if (!d) {
  623. printk(KERN_ERR
  624. "can: allocation of receive list failed\n");
  625. return NOTIFY_DONE;
  626. }
  627. d->dev = dev;
  628. spin_lock(&can_rcvlists_lock);
  629. hlist_add_head_rcu(&d->list, &can_rx_dev_list);
  630. spin_unlock(&can_rcvlists_lock);
  631. break;
  632. case NETDEV_UNREGISTER:
  633. spin_lock(&can_rcvlists_lock);
  634. d = find_dev_rcv_lists(dev);
  635. if (d) {
  636. if (d->entries) {
  637. d->remove_on_zero_entries = 1;
  638. d = NULL;
  639. } else
  640. hlist_del_rcu(&d->list);
  641. } else
  642. printk(KERN_ERR "can: notifier: receive list not "
  643. "found for dev %s\n", dev->name);
  644. spin_unlock(&can_rcvlists_lock);
  645. if (d)
  646. call_rcu(&d->rcu, can_rx_delete_device);
  647. break;
  648. }
  649. return NOTIFY_DONE;
  650. }
  651. /*
  652. * af_can module init/exit functions
  653. */
  654. static struct packet_type can_packet __read_mostly = {
  655. .type = __constant_htons(ETH_P_CAN),
  656. .dev = NULL,
  657. .func = can_rcv,
  658. };
  659. static struct net_proto_family can_family_ops __read_mostly = {
  660. .family = PF_CAN,
  661. .create = can_create,
  662. .owner = THIS_MODULE,
  663. };
  664. /* notifier block for netdevice event */
  665. static struct notifier_block can_netdev_notifier __read_mostly = {
  666. .notifier_call = can_notifier,
  667. };
  668. static __init int can_init(void)
  669. {
  670. printk(banner);
  671. rcv_cache = kmem_cache_create("can_receiver", sizeof(struct receiver),
  672. 0, 0, NULL);
  673. if (!rcv_cache)
  674. return -ENOMEM;
  675. /*
  676. * Insert can_rx_alldev_list for reception on all devices.
  677. * This struct is zero initialized which is correct for the
  678. * embedded hlist heads, the dev pointer, and the entries counter.
  679. */
  680. spin_lock(&can_rcvlists_lock);
  681. hlist_add_head_rcu(&can_rx_alldev_list.list, &can_rx_dev_list);
  682. spin_unlock(&can_rcvlists_lock);
  683. if (stats_timer) {
  684. /* the statistics are updated every second (timer triggered) */
  685. setup_timer(&can_stattimer, can_stat_update, 0);
  686. mod_timer(&can_stattimer, round_jiffies(jiffies + HZ));
  687. } else
  688. can_stattimer.function = NULL;
  689. can_init_proc();
  690. /* protocol register */
  691. sock_register(&can_family_ops);
  692. register_netdevice_notifier(&can_netdev_notifier);
  693. dev_add_pack(&can_packet);
  694. return 0;
  695. }
  696. static __exit void can_exit(void)
  697. {
  698. struct dev_rcv_lists *d;
  699. struct hlist_node *n, *next;
  700. if (stats_timer)
  701. del_timer(&can_stattimer);
  702. can_remove_proc();
  703. /* protocol unregister */
  704. dev_remove_pack(&can_packet);
  705. unregister_netdevice_notifier(&can_netdev_notifier);
  706. sock_unregister(PF_CAN);
  707. /* remove can_rx_dev_list */
  708. spin_lock(&can_rcvlists_lock);
  709. hlist_del(&can_rx_alldev_list.list);
  710. hlist_for_each_entry_safe(d, n, next, &can_rx_dev_list, list) {
  711. hlist_del(&d->list);
  712. kfree(d);
  713. }
  714. spin_unlock(&can_rcvlists_lock);
  715. kmem_cache_destroy(rcv_cache);
  716. }
  717. module_init(can_init);
  718. module_exit(can_exit);