aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorgdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4>2009-06-01 18:01:11 +0000
committergdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4>2009-06-01 18:01:11 +0000
commita765e562eae6d5ee280c8bcbff9a61e0edcf53fc (patch)
treeabfe6f25a4cbe315efad58fadb9816e01a229291
parent0da4e6e067db019f455b43a3391a1510f517d2cf (diff)
downloadChibiOS-a765e562eae6d5ee280c8bcbff9a61e0edcf53fc.tar.gz
ChibiOS-a765e562eae6d5ee280c8bcbff9a61e0edcf53fc.tar.bz2
ChibiOS-a765e562eae6d5ee280c8bcbff9a61e0edcf53fc.zip
Doxygen warning.
git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@1004 35acf78f-673a-0410-8e92-d51de3d6d3f4
-rw-r--r--readme.txt4
-rw-r--r--src/include/ioports.h4
2 files changed, 7 insertions, 1 deletions
diff --git a/readme.txt b/readme.txt
index 69836ee06..bf22eac06 100644
--- a/readme.txt
+++ b/readme.txt
@@ -66,6 +66,10 @@ GNU-Linux-GCC - ChibiOS/RT simulator for x86 Linux systems, it is
*** 1.3.1 ***
- FIX: Removed mention of an obsolete option from the documentation (bug
2799507).
+- NEW: Abstract digital I/O ports driver, this driver defines a common
+ interface for digital I/O operations, this should help to create more
+ portable applications and, in general, make easier to work with ChibiOS/RT
+ on multiple architectures.
- Documentation section reorganization and fixes.
- Changed the STM32 demo stack sizes, it was incorrectly adjusted in version
1.3.0 but it did not create problems (not a bug).
diff --git a/src/include/ioports.h b/src/include/ioports.h
index 15792aa3d..26a393730 100644
--- a/src/include/ioports.h
+++ b/src/include/ioports.h
@@ -70,7 +70,7 @@ typedef struct {
* @brief Writes a bits mask on a I/O port.
*
* @param[in] port the port identifier
- * @param[in] mask the mask to be written on the specified port
+ * @param[in] value the value to be written on the specified port
*/
#define chPortWrite(port, value) ioport_write_lld(port, value)
@@ -78,6 +78,7 @@ typedef struct {
* @brief Reads an I/O port.
*
* @param[in] port the port identifier
+ * @return the port bits
*/
#define chPortRead(port) ioport_read_lld(port)
@@ -134,6 +135,7 @@ typedef struct {
* @brief Reads a value from an I/O bus.
*
* @param[in] bus the I/O bus
+ * @return the bus bits
*
* @note The operation is not guaranteed to be atomic on all the architectures,
* for atomicity and/or portability reasons you may need to enclose port