Update preset.

[bertos.git] / bertos / drv / ser.c

diff --git a/bertos/drv/ser.c b/bertos/drv/ser.c
index a684ebbaf6cdcb22767afe8ad248fb09db685235..c9c3b0f7611e13bcb97632eb3c40bdc04ac9bb7f 100644 (file)
--- a/bertos/drv/ser.c
+++ b/bertos/drv/ser.c
@@ -46,7 +46,6 @@
  *  \li \c CONFIG_SER_TXTIMEOUT - Enable software serial transmission timeouts
  *
  *
- * \version $Id$
  * \author Bernie Innocenti <bernie@codewiz.org>
  */
 
@@ -256,12 +255,18 @@ void ser_settimeouts(struct Serial *fd, mtime_t rxtimeout, mtime_t txtimeout)
 #endif /* CONFIG_SER_RXTIMEOUT || CONFIG_SER_TXTIMEOUT */
 
 
+/**
+ * Set the baudrate for the serial port
+ */
 void ser_setbaudrate(struct Serial *fd, unsigned long rate)
 {
        fd->hw->table->setBaudrate(fd->hw, rate);
 }
 
 
+/**
+ * Set the parity for the \a fd serial port
+ */
 void ser_setparity(struct Serial *fd, int parity)
 {
        fd->hw->table->setParity(fd->hw, parity);
@@ -410,6 +415,8 @@ static struct KFile *ser_reopen(struct KFile *fd)
 
 /**
  * Init serial driver for \a unit.
+ *
+ * Use values SER_UARTn as values for \a unit.
  */
 void ser_init(struct Serial *fds, unsigned int unit)
 {
@@ -476,6 +483,8 @@ static size_t spimaster_write(struct KFile *fd, const void *buf, size_t size)
 /**
  * Init SPI serial driver \a unit in master mode.
  *
+ * Use SER_SPIn for \a unit parameter.
+ *
  * This interface implements the SPI master protocol over a serial SPI
  * driver. This is needed because normal serial driver send/receive data
  * at the same time. SPI slaves like memories and other peripherals