mirror of
https://github.com/RIOT-OS/RIOT.git
synced 2024-12-29 04:50:03 +01:00
7f8bf30b70
The documentation mentions the can module's interaction with the can tranciver driver (can_trx), but incorrectly calls it trx_can. This patch fixes the documentation.
27 lines
1.0 KiB
Plaintext
27 lines
1.0 KiB
Plaintext
/**
|
|
* @defgroup sys_can CAN (Controller Area Network)
|
|
* @ingroup net
|
|
* @brief RIOT CAN stack
|
|
*
|
|
* This module is a full CAN stack integrated to RIOT.
|
|
* It includes a low-level interface, a data link layer, an ISO-TP layer and
|
|
* a user interface.
|
|
*
|
|
* The low-level interface, candev, must be implemented by controller drivers.
|
|
* The optional transceiver support can also be activated. Transceiver drivers must
|
|
* then implement the can_trx interface.
|
|
*
|
|
* The data link layer is built around a device thread (one thread per CAN device),
|
|
* and a common part. The common part is composed of the dll interface, for low-level
|
|
* calls (from the device) and the raw interface for upper-level calls.
|
|
* Internally it also uses the pkt module to allocate frames and the router module
|
|
* to manage CAN filters.
|
|
*
|
|
* The ISO-TP layer uses the data link layer to send and receive CAN frames.
|
|
*
|
|
* Finally, the connection layer is the user interface to send and receive raw
|
|
* CAN frames or ISO-TP datagrams.
|
|
*
|
|
* @see drivers_can
|
|
*/
|