From 33121983e98cf58ea194c059576dbba0123e34f5 Mon Sep 17 00:00:00 2001 From: Henrik Brix Andersen Date: Fri, 10 Dec 2021 15:28:01 +0100 Subject: [PATCH] doc: reference: promote the canbus subsystem documentation Promote the Controller Area Network (CAN) subsystem reference documentation from being part of the networking subsystem documentation to having its own section. The networking subsystem primarily deals with IP-based networking, whereas CAN is a subsystem of its own. Signed-off-by: Henrik Brix Andersen --- CODEOWNERS | 2 +- MAINTAINERS.yml | 2 +- .../can_api.rst => canbus/controller.rst} | 8 ++++---- doc/reference/canbus/index.rst | 10 ++++++++++ .../{networking/can_isotp.rst => canbus/isotp.rst} | 2 +- .../isotp_sequence.svg} | Bin .../can_timing.svg => canbus/timing.svg} | Bin .../can_transceiver.svg => canbus/transceiver.svg} | Bin doc/reference/index.rst | 1 + doc/reference/networking/can.rst | 10 ---------- doc/reference/networking/index.rst | 1 - 11 files changed, 18 insertions(+), 18 deletions(-) rename doc/reference/{networking/can_api.rst => canbus/controller.rst} (99%) create mode 100644 doc/reference/canbus/index.rst rename doc/reference/{networking/can_isotp.rst => canbus/isotp.rst} (98%) rename doc/reference/{networking/can_isotp_sequence.svg => canbus/isotp_sequence.svg} (100%) rename doc/reference/{networking/can_timing.svg => canbus/timing.svg} (100%) rename doc/reference/{networking/can_transceiver.svg => canbus/transceiver.svg} (100%) delete mode 100644 doc/reference/networking/can.rst diff --git a/CODEOWNERS b/CODEOWNERS index 4042c83460d..8df9488ad21 100644 --- a/CODEOWNERS +++ b/CODEOWNERS @@ -183,7 +183,7 @@ /doc/guides/dts/ @galak @mbolivar-nordic /doc/reference/bluetooth/ @alwa-nordic @jhedberg @Vudentz /doc/reference/devicetree/ @galak @mbolivar-nordic -/doc/reference/networking/can* @alexanderwachter +/doc/reference/canbus/ @alexanderwachter /doc/security/ @ceolin @d3zd3z /drivers/debug/ @nashif /drivers/*/*sam4l* @nandojve diff --git a/MAINTAINERS.yml b/MAINTAINERS.yml index 12b1b8c5e7f..eb827350ba4 100644 --- a/MAINTAINERS.yml +++ b/MAINTAINERS.yml @@ -471,7 +471,7 @@ Documentation: - samples/drivers/can/ - tests/drivers/can/ - samples/subsys/canbus/ - - doc/reference/networking/can_api.rst + - doc/reference/canbus/ - modules/canopennode/ - samples/modules/canopennode/ labels: diff --git a/doc/reference/networking/can_api.rst b/doc/reference/canbus/controller.rst similarity index 99% rename from doc/reference/networking/can_api.rst rename to doc/reference/canbus/controller.rst index 90270f171b7..54e398dd47c 100644 --- a/doc/reference/networking/can_api.rst +++ b/doc/reference/canbus/controller.rst @@ -1,7 +1,7 @@ .. _can_api: -Controller Area Network (CAN) -############################# +CAN Controller API +################## .. contents:: :local: @@ -39,7 +39,7 @@ This structure is called a wired-AND. CAN RX is high, at least for a short time. This is also necessary for loopback mode. -.. image:: can_transceiver.svg +.. image:: transceiver.svg :width: 70% :align: center :alt: CAN Transceiver @@ -47,7 +47,7 @@ This structure is called a wired-AND. The bit-timing as defined in ISO 11898-1:2003 looks as following: -.. image:: can_timing.svg +.. image:: timing.svg :width: 40% :align: center :alt: CAN Timing diff --git a/doc/reference/canbus/index.rst b/doc/reference/canbus/index.rst new file mode 100644 index 00000000000..844ab945ff9 --- /dev/null +++ b/doc/reference/canbus/index.rst @@ -0,0 +1,10 @@ +.. _canbus: + +Controller Area Network (CAN) +############################# + +.. toctree:: + :maxdepth: 2 + + controller.rst + isotp.rst diff --git a/doc/reference/networking/can_isotp.rst b/doc/reference/canbus/isotp.rst similarity index 98% rename from doc/reference/networking/can_isotp.rst rename to doc/reference/canbus/isotp.rst index f8ad3f6e683..6953a04a92e 100644 --- a/doc/reference/networking/can_isotp.rst +++ b/doc/reference/canbus/isotp.rst @@ -36,7 +36,7 @@ The FC also defines the conditions of sending, namely the block-size (BS) and the minimum separation time between frames (STmin). The block size defines how many CF the sender is allowed to send, before he has to wait for another FC. -.. image:: can_isotp_sequence.svg +.. image:: isotp_sequence.svg :width: 20% :align: center :alt: ISO-TP Sequence diff --git a/doc/reference/networking/can_isotp_sequence.svg b/doc/reference/canbus/isotp_sequence.svg similarity index 100% rename from doc/reference/networking/can_isotp_sequence.svg rename to doc/reference/canbus/isotp_sequence.svg diff --git a/doc/reference/networking/can_timing.svg b/doc/reference/canbus/timing.svg similarity index 100% rename from doc/reference/networking/can_timing.svg rename to doc/reference/canbus/timing.svg diff --git a/doc/reference/networking/can_transceiver.svg b/doc/reference/canbus/transceiver.svg similarity index 100% rename from doc/reference/networking/can_transceiver.svg rename to doc/reference/canbus/transceiver.svg diff --git a/doc/reference/index.rst b/doc/reference/index.rst index 38a3f0dd1de..d21275103dd 100644 --- a/doc/reference/index.rst +++ b/doc/reference/index.rst @@ -10,6 +10,7 @@ API Reference audio/index.rst misc/notify.rst bluetooth/index.rst + canbus/index.rst crypto/index.rst devicetree/index.rst drivers/index.rst diff --git a/doc/reference/networking/can.rst b/doc/reference/networking/can.rst deleted file mode 100644 index 457b220bf8e..00000000000 --- a/doc/reference/networking/can.rst +++ /dev/null @@ -1,10 +0,0 @@ -.. _net_canbus: - -Controller Area Network -####################### - -.. toctree:: - :maxdepth: 1 - - can_api.rst - can_isotp.rst diff --git a/doc/reference/networking/index.rst b/doc/reference/networking/index.rst index 20d7593fd42..82b6e5a5b88 100644 --- a/doc/reference/networking/index.rst +++ b/doc/reference/networking/index.rst @@ -12,5 +12,4 @@ Networking protocols.rst system_mgmt.rst tsn.rst - can.rst gsm_modem.rst