Commit 9e97db3c authored by Geert Uytterhoeven's avatar Geert Uytterhoeven Committed by Marc Kleine-Budde
Browse files

documentation: networking: can: Document alloc_candev_mqs() 



Since the introduction of alloc_candev_mqs() and friends, there is no
longer a need to allocate a generic network device and perform explicit
CAN-specific setup.  Remove the code showing this setup, and document
alloc_candev_mqs() instead.

Fixes: 39549eef ("can: CAN Network device driver and Netlink interface")
Signed-off-by: default avatarGeert Uytterhoeven <geert+renesas@glider.be>
Link: https://patch.msgid.link/c0f9a706ba31f1a49eb72e58526cd294d97a1ce9.1748865431.git.geert+renesas@glider.be


Signed-off-by: default avatarMarc Kleine-Budde <mkl@pengutronix.de>
parent 30642471

Documentation/networking/can.rst

+4 −7
Original line number Diff line number Diff line
@@ -1104,15 +1104,12 @@ for writing CAN network device driver are described below: 
General Settings

----------------



.. code-block:: C



    dev->type  = ARPHRD_CAN; /* the netdevice hardware type */

    dev->flags = IFF_NOARP;  /* CAN has no arp */

CAN network device drivers can use alloc_candev_mqs() and friends instead of

alloc_netdev_mqs(), to automatically take care of CAN-specific setup:



    dev->mtu = CAN_MTU; /* sizeof(struct can_frame) -> Classical CAN interface */

.. code-block:: C



    or alternative, when the controller supports CAN with flexible data rate:

    dev->mtu = CANFD_MTU; /* sizeof(struct canfd_frame) -> CAN FD interface */

    dev = alloc_candev_mqs(...);



The struct can_frame or struct canfd_frame is the payload of each socket

buffer (skbuff) in the protocol family PF_CAN.