diff options
| -rw-r--r-- | docs/Doxyfile | 3 | ||||
| -rw-r--r-- | os/hal/platforms/LPC111x/platform.dox | 76 |
2 files changed, 78 insertions, 1 deletions
diff --git a/docs/Doxyfile b/docs/Doxyfile index 603b19910..b15befac2 100644 --- a/docs/Doxyfile +++ b/docs/Doxyfile @@ -679,7 +679,8 @@ RECURSIVE = NO # subdirectory from a directory tree whose root is specified with the INPUT tag. EXCLUDE = ../os/hal/platforms/STM32/stm32f10x.h \ - ../os/hal/platforms/LPC111x + ../os/hal/platforms/LPC111x/LPC11xx.h \ + ../os/hal/platforms/LPC111x/system_LPC11xx.h # The EXCLUDE_SYMLINKS tag can be used select whether or not files or # directories that are symbolic links (a Unix filesystem feature) are excluded diff --git a/os/hal/platforms/LPC111x/platform.dox b/os/hal/platforms/LPC111x/platform.dox new file mode 100644 index 000000000..11df786db --- /dev/null +++ b/os/hal/platforms/LPC111x/platform.dox @@ -0,0 +1,76 @@ +/*
+ ChibiOS/RT - Copyright (C) 2006,2007,2008,2009,2010 Giovanni Di Sirio.
+
+ This file is part of ChibiOS/RT.
+
+ ChibiOS/RT is free software; you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation; either version 3 of the License, or
+ (at your option) any later version.
+
+ ChibiOS/RT is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with this program. If not, see <http://www.gnu.org/licenses/>.
+*/
+
+/**
+ * @defgroup LPC111x LPC111x Support
+ * @brief LPC111x specific support.
+ * @details The LPC111x support includes:
+ * - I/O ports driver.
+ * - Buffered, interrupt driven, serial driver.
+ * - A demo supporting the kernel test suite.
+ * .
+ * @ingroup ARMCMx
+ */
+
+/**
+ * @defgroup LPC111x_HAL LPC111x HAL Support
+ * @brief HAL support.
+ *
+ * @ingroup LPC111x
+ */
+
+/**
+ * @defgroup LPC111x_PAL LPC111x I/O Ports Support
+ * @brief I/O Ports peripherals support.
+ * @details This module supports the LPC111x GPIO controller. The controller
+ * supports the following features (see @ref PAL):
+ * - 12 bits wide ports.
+ * - Atomic set/reset functions.
+ * - Atomic set+reset function (atomic bus operations).
+ * - Output latched regardless of the pad setting.
+ * - Direct read of input pads regardless of the pad setting.
+ * .
+ * <h2>Supported Setup Modes</h2>
+ * - @p PAL_MODE_RESET.
+ * - @p PAL_MODE_UNCONNECTED.
+ * - @p PAL_MODE_INPUT.
+ * - @p PAL_MODE_INPUT_ANALOG.
+ * - @p PAL_MODE_OUTPUT_PUSHPULL.
+ * .
+ * Any attempt to setup an invalid mode is ignored.
+ *
+ * <h2>Suboptimal Behavior</h2>
+ * Some GPIO features are less than optimal:
+ * - Pad/port toggling operations are not atomic.
+ * - Pull-up and Pull-down resistors cannot be programmed through the PAL
+ * driver and must be programmed separately.
+ * - Reading of the output latch for pads programmed as input is not possible,
+ * the input pin value is returned instead.
+ * .
+ * @ingroup LPC111x
+ */
+
+/**
+ * @defgroup LPC111x_SERIAL LPC111x UART Support
+ * @brief UART peripherals support.
+ * @details The serial driver supports the LPC111x UART taking advantage of
+ * its deep hardware buffers.
+ *
+ * @ingroup LPC111x
+ */
|