From 4fc5b696fad6b10620dcd49149bf64b829e38f77 Mon Sep 17 00:00:00 2001 From: gdisirio Date: Sun, 7 Jun 2009 10:27:48 +0000 Subject: git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@1019 35acf78f-673a-0410-8e92-d51de3d6d3f4 --- docs/src/main.dox | 35 +++++++++++++++++------------------ 1 file changed, 17 insertions(+), 18 deletions(-) (limited to 'docs/src') diff --git a/docs/src/main.dox b/docs/src/main.dox index c92192fff..24d7acda1 100644 --- a/docs/src/main.dox +++ b/docs/src/main.dox @@ -355,26 +355,25 @@ */ /** - * @defgroup IOPorts Abstract I/O Ports - * @brief Abstract digital I/O ports. + * @defgroup PAL I/O Ports Abstraction Layer (PAL) + * @brief I/O Ports Abstraction Layer * @details This module defines an abstract interface for digital I/O ports. * 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.
- * 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.
+ * have default software implementations that can be redefined in a + * @ref PAL_LLD if the target hardware supports special features like, as + * example, atomic bit set/reset/masking. Please refer to the ports specific + * documentation for details.
+ * The @ref PAL has the advantage to make the access to the I/O ports platform + * independent and still be optimized for the specific architectures.
* 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.
- * Note that the @ref IOPortsLLD may also offer non standard macro and - * functions in order to support specific features but, of course, the use of - * such interfaces would not be portable. + * Note that the @ref PAL_LLD may also offer non standard macro and functions + * in order to support specific features but, of course, the use of such + * interfaces would not be portable. * *

Implementation Rules

- * In implementing an @ref IOPortsLLD there are some rules/behaviors that + * In implementing an @ref PAL_LLD there are some rules/behaviors that * should be respected. * *

Writing on input pads

@@ -406,7 +405,7 @@ * The behavior is not specified. * *

Usage

- * The use of I/O ports requires the inclusion of the header file @p ioports.h, + * The use of I/O ports requires the inclusion of the header file @p pal.h, * this file is not automatically included @p ch.h like the other header * files. * @@ -414,12 +413,12 @@ */ /** - * @defgroup IOPortsLLD I/O Ports Low Level Driver - * @brief Digital I/O ports low level driver template. + * @defgroup PAL_LLD PAL Low Level Driver + * @brief @ref PAL low level driver template. * @details This file is a template for an I/O port low level driver. This - * file implements the prysical layer of an I/O port driver. + * file implements the physical layer of an I/O port driver. * - * @ingroup IOPorts + * @ingroup PAL */ /** -- cgit v1.2.3