[PATCH] documentation: networking: can: Document alloc_candev_mqs()
From: Geert Uytterhoeven <geert+renesas@glider.be>
Date: 2025-05-21 09:51:31
Also in:
linux-can, linux-doc
Subsystem:
can network layer, documentation, networking [general], the rest · Maintainers:
Oliver Hartkopp, Marc Kleine-Budde, Jonathan Corbet, "David S. Miller", Eric Dumazet, Jakub Kicinski, Paolo Abeni, Linus Torvalds
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.
Signed-off-by: Geert Uytterhoeven <geert+renesas@glider.be>
---
Dunno if this deserves
Fixes: 39549eef3587f1c1 ("can: CAN Network device driver and Netlink interface")
Documentation/networking/can.rst | 9 +++------
1 file changed, 3 insertions(+), 6 deletions(-)
diff --git a/Documentation/networking/can.rst b/Documentation/networking/can.rst
index b018ce346392652b..784dbd19b140d262 100644
--- a/Documentation/networking/can.rst
+++ b/Documentation/networking/can.rst@@ -1106,13 +1106,10 @@ 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 */ - - 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.
--
2.43.0