Yegor Yefremov
b8ff48cce4
periph/uart: improve documentation
...
Change description to reflect the configurability of the serial
interface.
Also, fix the uart_mode parameter description as the UART will be
configured and not initialized.
Signed-off-by: Yegor Yefremov <yegorslists@googlemail.com>
2019-02-11 09:35:23 +01:00
Yegor Yefremov
ddf19783d7
periph/uart: add support for enhanced serial settings
...
As suggested in PR#5899 add a routine uart_mode() that will
setup data bits, stop bits and parity at runtime.
uart.h provides a set of enums defining these settings and each
platform will override them to specify values corresponding to
its configuration registers.
The idea behind the enums is to specify default settings i.e. 8N1
through the 0 value item. Invoking uart_mode(uart, 0, 0, 0) will
setup 8N1 mode.
Signed-off-by: Yegor Yefremov <yegorslists@googlemail.com>
2019-01-31 14:15:11 +01:00
Hauke Petersen
39f0e4d5d3
periph/uart: fix line length in doc header
2018-12-06 10:08:56 +01:00
94c753c07a
drivers: doxygen cleanup
2017-09-01 15:12:20 +02:00
smlng
ab6cb269ed
doc: fix UART doxygen docu
...
- move detailed description to be visible on respective module page
- see and compare other periph interfaces, i.e., GPIO, PWM ...
2017-06-06 16:05:52 +02:00
79b2fd89bb
Merge pull request #6568 from haukepetersen/opt_periph_uarttxonly
...
periph/uart: enable to run UART in TX only mode
2017-02-24 13:01:38 +01:00
Hauke Petersen
021471e691
periph/uart: removed UART_NUMOF check
2017-02-15 09:45:06 +01:00
Hauke Petersen
18fe26a5c8
periph/uart: documented TX only mode
2017-02-09 10:42:52 +01:00
Hauke Petersen
314549059c
periph/uart: added names for return values
2016-10-28 10:31:59 +02:00
Laurent Navet
96ebff9174
drivers/uart: fix typos
2016-06-14 22:54:25 +02:00
Hauke Petersen
9a4df61005
drivers/periph: fixed UNDEF values to UINT_MAX
2016-04-01 10:57:26 +02:00
Hauke Petersen
2d2126e909
drivers/uart: use uint8_t for data in cb signature
2016-03-15 10:57:44 +01:00
Joakim Nohlgård
9af084ec18
drivers/periph/uart: Add missing #include <stddef.h>
...
Required for size_t
2016-01-19 14:11:35 +01:00
PeterKietzmann
4c41f7a994
periph/uart: extend uart API doc
2015-12-22 16:11:21 +01:00
Hauke Petersen
77b790375f
drivers/periph: some doxygen fixes
...
- added todos to periph module description
- repaired group names (e.g. s/driver_xx/drivers_xx/)
2015-11-19 15:57:36 +01:00
Hauke Petersen
634ae1541b
drivers/periph: remodeled UART driver interface
2015-10-27 14:59:37 +01:00
Alexandru Caciulescu
451bf78549
drivers/include/periph: Repair header file include guards
2015-03-24 17:55:42 +02:00
Ludwig Ortmann
5523ec67f3
doc: make peripheral interfaces modules
...
also remove `@file` parameters
2014-10-25 15:37:04 +02:00
BytesGalore
f94623ae0f
drivers: add extern "C" to header files
2014-10-21 15:30:03 +02:00
Ludwig Ortmann
2439bd839c
doc: fix more license headers
...
Remove some cruft, set correct lgpl versions, update to lgpl where
this had been overlooked in the past, fix odd comment style...
2014-08-27 19:20:49 +02:00
Hauke Petersen
8a80b2add8
drivers: improvements to UART driver interface
...
- removed UNDEFINED value from device enum
- added argument for callbacks
- add power[on|off] functions
- removed tx_end() function in favor of cb return value
2014-08-08 17:39:34 +02:00
Martin Lenders
1528857feb
Make filenames in periph documentation unique
...
This makes the filenames in the documentation of low-lever peripheral
drivers unique, so doxygen stops complaining about duplicates.
2014-07-18 14:59:46 +02:00
Martin Lenders
2362623490
Fix trailing whitespaces
...
Fixes #1138
2014-05-26 14:54:23 +02:00
Hauke Petersen
bfad408ce7
drivers: Initial import of low-level UART driver interface
...
Fixed spelling
drivers: remodeled low-level uart driver interface
- added blocking mode of operation
- added UNDEFINED device for compatibility
- changed baudrate type to uint32_t
drivers: added [in|out] to param documentation
2014-04-10 15:06:52 +02:00
