Skip to content
Snippets Groups Projects
Unverified Commit 17d2e001 authored by Martine Lenders's avatar Martine Lenders Committed by GitHub
Browse files

Merge pull request #10557 from haukepetersen/opt_uart_docfixes

periph/uart: fix line length in doc header
parents 1fcef246 39f0e4d5
No related branches found
No related tags found
No related merge requests found
...@@ -12,27 +12,30 @@ ...@@ -12,27 +12,30 @@
* @brief Low-level UART peripheral driver * @brief Low-level UART peripheral driver
* *
* This is a basic UART (Universal Asynchronous Receiver Transmitter) interface * This is a basic UART (Universal Asynchronous Receiver Transmitter) interface
* to allow platform independent access to the MCU's serial communication abilities. * to allow platform independent access to the MCU's serial communication
* This interface is intentionally designed to be as simple as possible, to allow * abilities. This interface is intentionally designed to be as simple as
* for easy implementation and maximum portability. In RIOT we only use the * possible, to allow for easy implementation and maximum portability. In RIOT
* common 8-N-1 format of the serial port (8 data bits, no parity bit, one stop bit). * we only use the common 8-N-1 format of the serial port (8 data bits, no
* * parity bit, one stop bit).
* The simple interface provides capabilities to initialize the serial communication *
* module, which automatically enables for receiving data, as well as writing data * The simple interface provides capabilities to initialize the serial
* to the UART port, which means transmitting data. The UART device and the * communication module, which automatically enables for receiving data, as well
* corresponding pins need to be mapped in `RIOT/boards/ * /include/periph_conf.h`. * as writing data to the UART port, which means transmitting data. The UART
* Furthermore you need to select the baudrate for initialization which is typically * device and the corresponding pins need to be mapped in
* {9600, 19200, 38400, 57600, 115200} baud. Additionally you should register a * `RIOT/boards/ * /include/periph_conf.h`. Furthermore you need to select the
* callback function that is executed in interrupt context when data is being received. * baudrate for initialization which is typically {9600, 19200, 38400, 57600,
* The driver will then read the received data byte, call the registered callback * 115200} baud. Additionally you should register a callback function that is
* function and pass the received data to it via its argument. The interface enforces * executed in interrupt context when data is being received. The driver will
* the receiving to be implemented in an interrupt driven mode. Thus, you never know how * then read the received data byte, call the registered callback function and
* many bytes are going to be received and might want to handle that in your specific * pass the received data to it via its argument. The interface enforces the
* callback function. The transmit function can be implemented in any way. * receiving to be implemented in an interrupt driven mode. Thus, you never know
* * how many bytes are going to be received and might want to handle that in your
* By default the @p UART_DEV(0) device of each board is initialized and mapped to STDIO * specific callback function. The transmit function can be implemented in any
* in RIOT which is used for standard input/output functions like `printf()` or * way.
* `puts()`. *
* By default the @p UART_DEV(0) device of each board is initialized and mapped
* to STDIO in RIOT which is used for standard input/output functions like
* `printf()` or `puts()`.
* *
* @{ * @{
* *
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment