Skip to contentSkip to conversation

Documentation: networking: document ISO 15765-2

PATCH Applied Francesco Valla 2 participants 3 messages May 1, 2024 – May 5, 2024

Subsystems (5)
lore
Share & tools
lore
#0 lore raw

v4 cover Documentation: networking: document ISO 15765-2

While the in-kernel ISO 15765-2 (ISO-TP) stack is fully functional and easy to use, no documentation exists for it.

This patch adds such documentation, containing the very basics of the protocol, the APIs and a basic example.

Thanks,
Francesco

---
Changes in v4:
- fix typos
- collect a Reviewed-by

Changes in v3:
- drop the :2016 version suffix, as in the mean time ISO 15765-2:2024 has been released (and is thus referenced as the referenced specification)
- add details on mixed addressing (all the paragraph about the addressing format has been reworked)
- align some descriptions to the specification
- miscellaneous fixes
- collected a Reviewed-by

Changes in v2:
- rename (and re-title) documentation to to align it with KConfig option, using ISO 15765-2:2016 instead of ISO-TP (the latter is still used for brevity inside the document)
- address review comments
- solve warnings coming from checkpatch and make htmldocs

Francesco Valla (1):
Documentation: networking: document ISO 15765-2

 Documentation/networking/index.rst      |   1 +
 Documentation/networking/iso15765-2.rst | 386 ++++++++++++++++++++++++
 MAINTAINERS                             |   1 +
 3 files changed, 388 insertions(+)
 create mode 100644 Documentation/networking/iso15765-2.rst
Signature · 1 line
2.44.0
#1 lore raw

PATCH 1/1 Documentation: networking: document ISO 15765-2

Document basic concepts, APIs and behaviour of the ISO 15675-2 (ISO-TP) CAN stack.

---
 Documentation/networking/index.rst      |   1 +
 Documentation/networking/iso15765-2.rst | 386 ++++++++++++++++++++++++
 MAINTAINERS                             |   1 +
 3 files changed, 388 insertions(+)
 create mode 100644 Documentation/networking/iso15765-2.rst
Documentation/networking/index.rst +1 -0
index 473d72c36d61..bbd9bf537793 100644
@@ -19,6 +19,7 @@ Contents:
    caif/index
    ethtool-netlink
    ieee802154
+   iso15765-2
    j1939
    kapi
    msg_zerocopy
Documentation/networking/iso15765-2.rst new file +386 -0

386 lines not on this page · raw message

MAINTAINERS +1 -0
index 62b1a16b791b..e768c4ed349d 100644
@@ -4695,6 +4695,7 @@ W:	https://github.com/linux-can
 T:	git git://git.kernel.org/pub/scm/linux/kernel/git/mkl/linux-can.git
 T:	git git://git.kernel.org/pub/scm/linux/kernel/git/mkl/linux-can-next.git
 F:	Documentation/networking/can.rst
+F:	Documentation/networking/iso15765-2.rst
 F:	include/linux/can/can-ml.h
 F:	include/linux/can/core.h
 F:	include/linux/can/skb.h
Signature · 1 line
2.44.0
maintainer Applied
#2 lore raw
In reply to Francesco Valla
Quoted 5 lines · Francesco Valla

While the in-kernel ISO 15765-2 (ISO-TP) stack is fully functional and easy to use, no documentation exists for it.

This patch adds such documentation, containing the very basics of the protocol, the APIs and a basic example.

Applied to linux-can-next.

Thanks,
Marc

Signature · 4 lines
Pengutronix e.K.                 | Marc Kleine-Budde          |
Embedded Linux                   | https://www.pengutronix.de |
Vertretung Nürnberg              | Phone: +49-5121-206917-129 |
Amtsgericht Hildesheim, HRA 2686 | Fax:   +49-5121-206917-9   |