aboutsummaryrefslogtreecommitdiffstats
path: root/docs/src
diff options
context:
space:
mode:
authorgdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4>2009-06-03 20:32:28 +0000
committergdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4>2009-06-03 20:32:28 +0000
commit9148fd36b23a5ffcdd2f358627370a697fb49cef (patch)
tree6ca0223c9209094fff1b36c11945425fbb95ee9c /docs/src
parent2a7941ee58016ce7641ab8010aff5fe711e0bedc (diff)
downloadChibiOS-9148fd36b23a5ffcdd2f358627370a697fb49cef.tar.gz
ChibiOS-9148fd36b23a5ffcdd2f358627370a697fb49cef.tar.bz2
ChibiOS-9148fd36b23a5ffcdd2f358627370a697fb49cef.zip
Added default implementations for I/O ports functions in ioports.h. Adjusted the documentation accordingly.
git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@1017 35acf78f-673a-0410-8e92-d51de3d6d3f4
Diffstat (limited to 'docs/src')
-rw-r--r--docs/src/main.dox12
1 files changed, 8 insertions, 4 deletions
diff --git a/docs/src/main.dox b/docs/src/main.dox
index bfe6f036c..c92192fff 100644
--- a/docs/src/main.dox
+++ b/docs/src/main.dox
@@ -358,10 +358,14 @@
* @defgroup IOPorts Abstract I/O Ports
* @brief Abstract digital I/O ports.
* @details This module defines an abstract interface for digital I/O ports.
- * Note that no code is present, I/O ports are just a set of macros that must
- * be implemented by an @ref IOPortsLLD.<br>
- * This system has the advantage to make the access to I/O ports platform
- * independent from the implementation logic.<br>
+ * Note that I/O ports functions are just a set of macros. The macros
+ * have default software implementation that can be redefined by an
+ * @ref IOPortsLLD if the target hardware supports special features like, as
+ * example, atomic bit set/reset/masking. Please refer to the documentation
+ * of the low level drivers for each port.<br>
+ * This abstraction system has the advantage to make the access to the I/O
+ * ports platform independent and still be optimized for the specific
+ * architecture.<br>
* Currently the I/O ports interface does not handle physical port programming
* like direction, pull up/down resistors etc. The interface only allows input
* and output operations but this may change in future releases.<br>