ser_open(): Document a bit more.

[bertos.git] / drv / ser.c

diff --git a/drv/ser.c b/drv/ser.c
index dbde1aa0f63eafbe7d48d0a8329ef5d73734845d..02e3e2d1519006252875ed28fb9891f7a64e77a3 100755 (executable)
--- a/drv/ser.c
+++ b/drv/ser.c
@@ -3,7 +3,7 @@
  * <!--
  * Copyright 2003, 2004 Develer S.r.l. (http://www.develer.com/)
  * Copyright 2000 Bernardo Innocenti <bernie@codewiz.org>
- * This file is part of DevLib - See devlib/README for information.
+ * This file is part of DevLib - See README.devlib for information.
  * -->
  *
  * \brief Buffered serial I/O driver
@@ -28,6 +28,21 @@
 
 /*#*
  *#* $Log$
+ *#* Revision 1.29  2006/05/18 00:39:30  bernie
+ *#* ser_open(): Document a bit more.
+ *#*
+ *#* Revision 1.28  2006/02/17 22:23:06  bernie
+ *#* Update POSIX serial emulator.
+ *#*
+ *#* Revision 1.27  2005/11/27 23:33:40  bernie
+ *#* Use appconfig.h instead of cfg/config.h.
+ *#*
+ *#* Revision 1.26  2005/11/04 16:20:02  bernie
+ *#* Fix reference to README.devlib in header.
+ *#*
+ *#* Revision 1.25  2005/04/11 19:10:27  bernie
+ *#* Include top-level headers from cfg/ subdir.
+ *#*
  *#* Revision 1.24  2005/01/21 20:13:15  aleph
  *#* Fix drain at ser_close()
  *#*
@@ -102,9 +117,9 @@
 #include "ser.h"
 #include "ser_p.h"
 #include <mware/formatwr.h>
-#include <debug.h>
-#include <hw.h>
-#include <config.h>
+#include <cfg/debug.h>
+//#include <hw.h>
+#include <appconfig.h>
 
 /*
  * Sanity check for config parameters required by this module.
@@ -461,7 +476,9 @@ void ser_drain(struct Serial *ser)
 
 
 /*!
- * Initialize serial
+ * Initialize a serial port.
+ *
+ * \param unit  Serial unit to open. Possible values are architecture dependant.
  */
 struct Serial *ser_open(unsigned int unit)
 {