Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
R
RIOT
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Container Registry
Model registry
Operate
Environments
Monitor
Incidents
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
cm-projects
RIOT
Commits
4c41f7a9
Commit
4c41f7a9
authored
9 years ago
by
Peter Kietzmann
Browse files
Options
Downloads
Patches
Plain Diff
periph/uart: extend uart API doc
parent
b7a7578e
No related branches found
No related tags found
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
drivers/include/periph/uart.h
+23
-0
23 additions, 0 deletions
drivers/include/periph/uart.h
with
23 additions
and
0 deletions
drivers/include/periph/uart.h
+
23
−
0
View file @
4c41f7a9
...
@@ -12,6 +12,29 @@
...
@@ -12,6 +12,29 @@
* @brief Low-level UART peripheral driver
* @brief Low-level UART peripheral driver
* @{
* @{
*
*
* This is a basic UART (Universal Asynchronous Receiver Transmitter) interface
* to allow platform independent access to the MCU's serial communication abilities.
* This interface is intentionally designed to be as simple as possible, to allow
* for easy implementation and maximum portability. In RIOT we only use the
* common 8-N-1 format of the serial port (8 data bist, 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
* to the UART port, which means transmitting data. The UART device and the
* corresponding pins need to be mapped in `RIOT/boards/ * /include/periph_conf.h`.
* Furthermore you need to select the baudrate for initialization which is typically
* {9600, 19200, 38400, 57600, 115200} baud. Additionally you should register a
* callback function that is executed in interrupt context when data is being received.
* The driver will then read the received data byte, call the registered callback
* function and pass the received data to it via its argument. The interface enforces
* the receiving to be impemented in an interrupt driven mode. Thus, you never now how
* many bytes are going to be received and might want to handle that in your specific
* callback function. The transmit function can be implemented in any way
*
* 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()`.
*
* @file
* @file
* @brief Low-level UART peripheral driver interface definition
* @brief Low-level UART peripheral driver interface definition
*
*
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment