aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorgdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4>2009-08-20 11:15:24 +0000
committergdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4>2009-08-20 11:15:24 +0000
commit8ce831d013cd306b24c3e6eca4c1efec28469f5b (patch)
treeebbacbe6d0238794cefa78fa9935ece975872b10
parentf7117a6201769d9d10c59415bf93f7948a2703ae (diff)
downloadChibiOS-8ce831d013cd306b24c3e6eca4c1efec28469f5b.tar.gz
ChibiOS-8ce831d013cd306b24c3e6eca4c1efec28469f5b.tar.bz2
ChibiOS-8ce831d013cd306b24c3e6eca4c1efec28469f5b.zip
git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@1087 35acf78f-673a-0410-8e92-d51de3d6d3f4
-rw-r--r--docs/Doxyfile32
-rw-r--r--docs/src/main.dox50
-rw-r--r--os/io/serial.c12
-rw-r--r--os/io/templates/serial_lld.c2
-rw-r--r--os/ports/GCC/ARM7/AT91SAM7X/sam7x_emac.c2
-rw-r--r--os/ports/GCC/ARM7/AT91SAM7X/sam7x_emac.h2
-rw-r--r--os/ports/GCC/ARM7/AT91SAM7X/sam7x_serial.c2
-rw-r--r--os/ports/GCC/ARM7/AT91SAM7X/sam7x_serial.h2
-rw-r--r--os/ports/GCC/ARM7/LPC214x/lpc214x_serial.c2
-rw-r--r--os/ports/GCC/ARM7/LPC214x/lpc214x_serial.h2
-rw-r--r--os/ports/GCC/ARM7/LPC214x/lpc214x_ssp.c2
-rw-r--r--os/ports/GCC/ARM7/LPC214x/lpc214x_ssp.h2
-rw-r--r--os/ports/GCC/ARM7/LPC214x/pal_lld.c2
-rw-r--r--os/ports/GCC/ARM7/LPC214x/pal_lld.h2
-rw-r--r--os/ports/GCC/ARM7/LPC214x/vic.c2
-rw-r--r--os/ports/GCC/ARM7/LPC214x/vic.h2
-rw-r--r--os/ports/GCC/ARM7/chcore.c2
-rw-r--r--os/ports/GCC/ARM7/chcore.h2
-rw-r--r--os/ports/GCC/ARM7/chcoreasm.s2
-rw-r--r--os/ports/GCC/ARM7/chtypes.h2
-rw-r--r--os/ports/GCC/ARM7/crt0.s2
-rw-r--r--os/ports/GCC/ARM7/port.dox8
-rw-r--r--os/ports/GCC/ARMCM3/STM32F103/pal_lld.c2
-rw-r--r--os/ports/GCC/ARMCM3/STM32F103/pal_lld.h2
-rw-r--r--os/ports/GCC/ARMCM3/STM32F103/serial_lld.c8
-rw-r--r--os/ports/GCC/ARMCM3/STM32F103/serial_lld.h6
-rw-r--r--os/ports/GCC/ARMCM3/STM32F103/stm32_can.c2
-rw-r--r--os/ports/GCC/ARMCM3/STM32F103/stm32_can.h2
-rw-r--r--os/ports/GCC/ARMCM3/chcore.c2
-rw-r--r--os/ports/GCC/ARMCM3/chcore.h2
-rw-r--r--os/ports/GCC/ARMCM3/chtypes.h2
-rw-r--r--os/ports/GCC/ARMCM3/crt0.s2
-rw-r--r--os/ports/GCC/ARMCM3/nvic.c2
-rw-r--r--os/ports/GCC/ARMCM3/nvic.h2
-rw-r--r--os/ports/GCC/ARMCM3/port.dox2
-rw-r--r--os/ports/GCC/AVR/avr_serial.c2
-rw-r--r--os/ports/GCC/AVR/avr_serial.h2
-rw-r--r--os/ports/GCC/AVR/chcore.c2
-rw-r--r--os/ports/GCC/AVR/chcore.h2
-rw-r--r--os/ports/GCC/AVR/chtypes.h2
-rw-r--r--os/ports/GCC/AVR/port.dox6
-rw-r--r--os/ports/GCC/MSP430/chcore.c2
-rw-r--r--os/ports/GCC/MSP430/chcore.h2
-rw-r--r--os/ports/GCC/MSP430/chtypes.h2
-rw-r--r--os/ports/GCC/MSP430/msp430_serial.c2
-rw-r--r--os/ports/GCC/MSP430/msp430_serial.h2
-rw-r--r--os/ports/GCC/MSP430/pal_lld.c2
-rw-r--r--os/ports/GCC/MSP430/pal_lld.h2
-rw-r--r--os/ports/GCC/MSP430/port.dox3
49 files changed, 117 insertions, 90 deletions
diff --git a/docs/Doxyfile b/docs/Doxyfile
index b26a2d37d..4a9d6d266 100644
--- a/docs/Doxyfile
+++ b/docs/Doxyfile
@@ -574,21 +574,23 @@ WARN_LOGFILE =
# with spaces.
INPUT = ../docs/src \
- ../src/include \
- ../src/templates \
- ../src \
- ../test \
- ../src/lib \
- ../ports/ARM7 \
- ../ports/ARM7/crt0.s \
- ../ports/ARM7/chcoreasm.s \
- ../ports/ARM7-AT91SAM7X \
- ../ports/ARM7-LPC214x \
- ../ports/ARMCM3 \
- ../ports/ARMCM3/crt0.s \
- ../ports/ARMCM3-STM32F103 \
- ../ports/MSP430 \
- ../ports/AVR
+ ../os/kernel/include \
+ ../os/kernel/src \
+ ../os/ports/templates \
+ ../os/ports/GCC/ARM7 \
+ ../os/ports/GCC/ARM7/crt0.s \
+ ../os/ports/GCC/ARM7/chcoreasm.s \
+ ../os/ports/GCC/ARM7/AT91SAM7X \
+ ../os/ports/GCC/ARM7/LPC214x \
+ ../os/ports/GCC/ARMCM3 \
+ ../os/ports/GCC/ARMCM3/crt0.s \
+ ../os/ports/GCC/ARMCM3/STM32F103 \
+ ../os/ports/GCC/MSP430 \
+ ../os/ports/GCC/AVR \
+ ../os/io \
+ ../os/io/templates \
+ ../os/various \
+ ../test
# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
diff --git a/docs/src/main.dox b/docs/src/main.dox
index 3d6c605c5..56fcd252a 100644
--- a/docs/src/main.dox
+++ b/docs/src/main.dox
@@ -88,7 +88,6 @@
* - @subpage test_events
* - @subpage test_mbox
* - @subpage test_queues
- * - @subpage test_serial
* - @subpage test_heap
* - @subpage test_pools
* - @subpage test_benchmarks
@@ -347,11 +346,33 @@
/**
* @defgroup IO I/O Support
* @brief I/O related services.
- * @details This section contains the I/O related services. Note that no
- * specific drivers are documented here, all the listed modules are abstract
- * interfaces or kernel APIs that the device drivers should implement/use.<br>
- * The use of common I/O interfaces allow for a certain degree of portability
- * for the ChibiOS/RT application among very different MCUs.
+ * @details This section contains the I/O related services.
+ *
+ * The I/O subsystem is a collection of device driver poertable interfaces and
+ * platform dependent implementations.<br>
+ * Under ChibiOS/RT a device driver is split in two layers:
+ * - High Level Device Driver (<b>HLD</b>). This layer contains the definitions
+ * of the driver's APIs and the platform independent part of the driver.<br>
+ * An HLD is composed by two files:
+ * - @<driver@>.c, the high level implementation file. This file must be
+ * included in the Makefile in order to use the driver.
+ * - @<driver@>.h, the high level header file. This file must be included
+ * by the application code in order to access the driver's APIs.
+ * .
+ * - Low Level Device Driver (<b>LLD</b>). This layer contains the platform
+ * dependent part of the driver.<br>
+ * A LLD is composed by two files:
+ * - @<driver@>_lld.c, the low level implementation file. This file must be
+ * included in the Makefile in order to use the driver.
+ * - @<driver@>_lld.h, the high level header file. This file is implicitly
+ * included by the HLD header file.
+ * .
+ * .
+ * <h2>Available Device Drivers</h2>
+ * The I/O subsystem currently includes support for:
+ * - @ref PAL.
+ * - @ref SERIAL.
+ * .
*/
/**
@@ -413,8 +434,7 @@
/**
* @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 physical layer of an I/O port driver.
+ * @details This file is a template for an I/O port low level driver.
*
* @ingroup PAL
*/
@@ -459,22 +479,28 @@
*/
/**
- * @defgroup Serial Serial Drivers
+ * @defgroup SERIAL Serial Driver
* @brief Generic Serial Drivers.
* @details This module implements a generic full duplex serial driver. The
- * driver implements a @p FullDuplexDriver interface and uses I/O Queues for
+ * driver implements a @p SerialDriver interface and uses I/O Queues for
* communication between the upper and the lower driver. Event flags are used
* to notify the application about incoming data, outgoing data and other I/O
* events.<br>
* The module also contains functions that make the implementation of the
* interrupt service routines much easier.<br>
- * In order to use the serial full duplex driver the
- * @p CH_USE_SERIAL_FULLDUPLEX option must be specified in @p chconf.h.
*
* @ingroup IO
*/
/**
+ * @defgroup SERIAL_LLD Serial Low Level Driver
+ * @brief @ref SERIAL low level driver template.
+ * @details This file is a template for a serial low level driver.
+ *
+ * @ingroup SERIAL
+ */
+
+/**
* @defgroup utilities_library Utilities Library
* @brief Utilities Library.
* @details This is a collection of useful library code that is not part of
diff --git a/os/io/serial.c b/os/io/serial.c
index 30a17ed48..9c398f5f0 100644
--- a/os/io/serial.c
+++ b/os/io/serial.c
@@ -80,14 +80,10 @@ void sdInit(void) {
* @details The HW dependent part of the initialization has to be performed
* outside, usually in the hardware initialization code.
*
- * @param[out] sd pointer to a @p SerialDriver structure
- * @param[in] ib pointer to a memory area allocated for the Input Queue buffer
- * @param[in] isize size of the Input Queue buffer
+ * @param[out] sdp pointer to a @p SerialDriver structure
* @param[in] inotify pointer to a callback function that is invoked when
* some data is read from the Queue. The value can be
* @p NULL.
- * @param[in] ob pointer to a memory area allocated for the Output Queue buffer
- * @param[in] osize size of the Output Queue buffer
* @param[in] onotify pointer to a callback function that is invoked when
* some data is written in the Queue. The value can be
* @p NULL.
@@ -106,7 +102,7 @@ void sdObjectInit(SerialDriver *sdp, qnotify_t inotify, qnotify_t onotify) {
/**
* @brief Configures and starts the driver.
*
- * @param[in] ip pointer to a @p SerialDriver or derived class
+ * @param[in] sdp pointer to a @p SerialDriver object
* @param[in] config the architecture-dependent serial driver configuration.
* If this parameter is set to @p NULL then a default
* configuration is used.
@@ -120,10 +116,10 @@ void sdStart(SerialDriver *sdp, const SerialDriverConfig *config) {
/**
* @brief Stops the driver.
- * @Details Any thread waiting on the driver's queues will be awakened with
+ * @details Any thread waiting on the driver's queues will be awakened with
* the message @p Q_RESET.
*
- * @param[in] ip pointer to a @p SerialDriver or derived class
+ * @param[in] sdp pointer to a @p SerialDrive object
*/
void sdStop(SerialDriver *sdp) {
diff --git a/os/io/templates/serial_lld.c b/os/io/templates/serial_lld.c
index d0aabfaa0..211307f16 100644
--- a/os/io/templates/serial_lld.c
+++ b/os/io/templates/serial_lld.c
@@ -69,7 +69,7 @@ void sd_lld_start(SerialDriver *sdp, const SerialDriverConfig *config) {
* @details De-initializes the USART, stops the associated clock, resets the
* interrupt vector.
*
- * @param[in] sd pointer to a @p SerialDriver object
+ * @param[in] sdp pointer to a @p SerialDriver object
*/
void sd_lld_stop(SerialDriver *sdp) {
diff --git a/os/ports/GCC/ARM7/AT91SAM7X/sam7x_emac.c b/os/ports/GCC/ARM7/AT91SAM7X/sam7x_emac.c
index b0db11dca..82d7e8381 100644
--- a/os/ports/GCC/ARM7/AT91SAM7X/sam7x_emac.c
+++ b/os/ports/GCC/ARM7/AT91SAM7X/sam7x_emac.c
@@ -18,7 +18,7 @@
*/
/**
- * @file ports/ARM7-AT91SAM7X/sam7x_emac.c
+ * @file AT91SAM7X/sam7x_emac.c
* @brief AT91SAM7X EMAC driver code.
* @addtogroup AT91SAM7X_EMAC
* @{
diff --git a/os/ports/GCC/ARM7/AT91SAM7X/sam7x_emac.h b/os/ports/GCC/ARM7/AT91SAM7X/sam7x_emac.h
index d666ea6ef..de81fe4c6 100644
--- a/os/ports/GCC/ARM7/AT91SAM7X/sam7x_emac.h
+++ b/os/ports/GCC/ARM7/AT91SAM7X/sam7x_emac.h
@@ -18,7 +18,7 @@
*/
/**
- * @file ports/ARM7-AT91SAM7X/sam7x_emac.h
+ * @file AT91SAM7X/sam7x_emac.h
* @brief AT91SAM7X EMAC driver macros and structures.
* @addtogroup AT91SAM7X_EMAC
* @{
diff --git a/os/ports/GCC/ARM7/AT91SAM7X/sam7x_serial.c b/os/ports/GCC/ARM7/AT91SAM7X/sam7x_serial.c
index 91aaf2f0e..e0494633e 100644
--- a/os/ports/GCC/ARM7/AT91SAM7X/sam7x_serial.c
+++ b/os/ports/GCC/ARM7/AT91SAM7X/sam7x_serial.c
@@ -18,7 +18,7 @@
*/
/**
- * @file ports/ARM7-AT91SAM7X/sam7x_serial.c
+ * @file AT91SAM7X/sam7x_serial.c
* @brief AT91SAM7X Serial driver code.
* @addtogroup AT91SAM7X_SERIAL
* @{
diff --git a/os/ports/GCC/ARM7/AT91SAM7X/sam7x_serial.h b/os/ports/GCC/ARM7/AT91SAM7X/sam7x_serial.h
index 1652ab69f..67afe84be 100644
--- a/os/ports/GCC/ARM7/AT91SAM7X/sam7x_serial.h
+++ b/os/ports/GCC/ARM7/AT91SAM7X/sam7x_serial.h
@@ -18,7 +18,7 @@
*/
/**
- * @file ports/ARM7-AT91SAM7X/sam7x_serial.h
+ * @file AT91SAM7X/sam7x_serial.h
* @brief AT91SAM7X Serial driver macros and structures.
* @addtogroup AT91SAM7X_SERIAL
* @{
diff --git a/os/ports/GCC/ARM7/LPC214x/lpc214x_serial.c b/os/ports/GCC/ARM7/LPC214x/lpc214x_serial.c
index e452cec8d..f63285083 100644
--- a/os/ports/GCC/ARM7/LPC214x/lpc214x_serial.c
+++ b/os/ports/GCC/ARM7/LPC214x/lpc214x_serial.c
@@ -18,7 +18,7 @@
*/
/**
- * @file ports/ARM7-LPC214x/lpc214x_serial.c
+ * @file LPC214x/lpc214x_serial.c
* @brief LPC214x Serial driver code.
* @addtogroup LPC214x_SERIAL
* @{
diff --git a/os/ports/GCC/ARM7/LPC214x/lpc214x_serial.h b/os/ports/GCC/ARM7/LPC214x/lpc214x_serial.h
index 021dbf6a1..380b6324b 100644
--- a/os/ports/GCC/ARM7/LPC214x/lpc214x_serial.h
+++ b/os/ports/GCC/ARM7/LPC214x/lpc214x_serial.h
@@ -18,7 +18,7 @@
*/
/**
- * @file ports/ARM7-LPC214x/lpc214x_serial.h
+ * @file LPC214x/lpc214x_serial.h
* @brief LPC214x Serial driver macros and structures.
* @addtogroup LPC214x_SERIAL
* @{
diff --git a/os/ports/GCC/ARM7/LPC214x/lpc214x_ssp.c b/os/ports/GCC/ARM7/LPC214x/lpc214x_ssp.c
index 790182576..fb7b70183 100644
--- a/os/ports/GCC/ARM7/LPC214x/lpc214x_ssp.c
+++ b/os/ports/GCC/ARM7/LPC214x/lpc214x_ssp.c
@@ -18,7 +18,7 @@
*/
/**
- * @file ports/ARM7-LPC214x/lpc214x_ssp.c
+ * @file LPC214x/lpc214x_ssp.c
* @brief LPC214x SSP driver code.
* @addtogroup LPC214x_SSP
* @{
diff --git a/os/ports/GCC/ARM7/LPC214x/lpc214x_ssp.h b/os/ports/GCC/ARM7/LPC214x/lpc214x_ssp.h
index cae264a92..3ad25b37a 100644
--- a/os/ports/GCC/ARM7/LPC214x/lpc214x_ssp.h
+++ b/os/ports/GCC/ARM7/LPC214x/lpc214x_ssp.h
@@ -18,7 +18,7 @@
*/
/**
- * @file ports/ARM7-LPC214x/lpc214x_ssp.h
+ * @file LPC214x/lpc214x_ssp.h
* @brief LPC214x SSP driver macros and structures.
* @addtogroup LPC214x_SSP
* @{
diff --git a/os/ports/GCC/ARM7/LPC214x/pal_lld.c b/os/ports/GCC/ARM7/LPC214x/pal_lld.c
index ba3f55df4..666afef55 100644
--- a/os/ports/GCC/ARM7/LPC214x/pal_lld.c
+++ b/os/ports/GCC/ARM7/LPC214x/pal_lld.c
@@ -18,7 +18,7 @@
*/
/**
- * @file os/ports/GCC/ARM7/LPC214x/pal_lld.c
+ * @file LPC214x/pal_lld.c
* @brief LPC214x FIO low level driver code
* @addtogroup LPC214x_PAL
* @{
diff --git a/os/ports/GCC/ARM7/LPC214x/pal_lld.h b/os/ports/GCC/ARM7/LPC214x/pal_lld.h
index 6df77403f..50e0ff4a5 100644
--- a/os/ports/GCC/ARM7/LPC214x/pal_lld.h
+++ b/os/ports/GCC/ARM7/LPC214x/pal_lld.h
@@ -18,7 +18,7 @@
*/
/**
- * @file os/ports/GCC/ARM7/LPC214x/pal_lld.h
+ * @file LPC214x/pal_lld.h
* @brief LPC214x FIO low level driver header
* @addtogroup LPC214x_PAL
* @{
diff --git a/os/ports/GCC/ARM7/LPC214x/vic.c b/os/ports/GCC/ARM7/LPC214x/vic.c
index 88e9814bb..685830063 100644
--- a/os/ports/GCC/ARM7/LPC214x/vic.c
+++ b/os/ports/GCC/ARM7/LPC214x/vic.c
@@ -18,7 +18,7 @@
*/
/**
- * @file ports/ARM7-LPC214x/vic.c
+ * @file LPC214x/vic.c
* @brief LPC214x VIC peripheral support code.
* @addtogroup LPC214x_VIC
* @{
diff --git a/os/ports/GCC/ARM7/LPC214x/vic.h b/os/ports/GCC/ARM7/LPC214x/vic.h
index b4b88948c..486a80b56 100644
--- a/os/ports/GCC/ARM7/LPC214x/vic.h
+++ b/os/ports/GCC/ARM7/LPC214x/vic.h
@@ -18,7 +18,7 @@
*/
/**
- * @file ports/ARM7-LPC214x/vic.h
+ * @file LPC214x/vic.h
* @brief LPC214x VIC peripheral support code.
* @addtogroup LPC214x_VIC
* @{
diff --git a/os/ports/GCC/ARM7/chcore.c b/os/ports/GCC/ARM7/chcore.c
index d0e0071bf..bd1942aba 100644
--- a/os/ports/GCC/ARM7/chcore.c
+++ b/os/ports/GCC/ARM7/chcore.c
@@ -18,7 +18,7 @@
*/
/**
- * @file ports/ARM7/chcore.c
+ * @file ARM7/chcore.c
* @brief ARM7 architecture port code.
* @addtogroup ARM7_CORE
* @{
diff --git a/os/ports/GCC/ARM7/chcore.h b/os/ports/GCC/ARM7/chcore.h
index 541207eef..ff96a419c 100644
--- a/os/ports/GCC/ARM7/chcore.h
+++ b/os/ports/GCC/ARM7/chcore.h
@@ -18,7 +18,7 @@
*/
/**
- * @file ports/ARM7/chcore.h
+ * @file ARM7/chcore.h
* @brief ARM7 architecture port macros and structures.
* @addtogroup ARM7_CORE
* @{
diff --git a/os/ports/GCC/ARM7/chcoreasm.s b/os/ports/GCC/ARM7/chcoreasm.s
index 932d39c04..da942269a 100644
--- a/os/ports/GCC/ARM7/chcoreasm.s
+++ b/os/ports/GCC/ARM7/chcoreasm.s
@@ -18,7 +18,7 @@
*/
/**
- * @file ports/ARM7/chcoreasm.s
+ * @file ARM7/chcoreasm.s
* @brief ARM7 architecture port low level code.
* @addtogroup ARM7_CORE
* @{
diff --git a/os/ports/GCC/ARM7/chtypes.h b/os/ports/GCC/ARM7/chtypes.h
index 570c719da..4fa969599 100644
--- a/os/ports/GCC/ARM7/chtypes.h
+++ b/os/ports/GCC/ARM7/chtypes.h
@@ -18,7 +18,7 @@
*/
/**
- * @file ports/ARM7/chtypes.h
+ * @file ARM7/chtypes.h
* @brief ARM7 architecture port system types.
* @addtogroup ARM7_CORE
* @{
diff --git a/os/ports/GCC/ARM7/crt0.s b/os/ports/GCC/ARM7/crt0.s
index 91d07935b..ed798fc78 100644
--- a/os/ports/GCC/ARM7/crt0.s
+++ b/os/ports/GCC/ARM7/crt0.s
@@ -18,7 +18,7 @@
*/
/**
- * @file ports/ARM7/crt0.s
+ * @file ARM7/crt0.s
* @brief Generic ARM7 startup file for ChibiOS/RT.
* @addtogroup ARM7_CORE
* @{
diff --git a/os/ports/GCC/ARM7/port.dox b/os/ports/GCC/ARM7/port.dox
index 780c57083..5afc4548f 100644
--- a/os/ports/GCC/ARM7/port.dox
+++ b/os/ports/GCC/ARM7/port.dox
@@ -147,9 +147,9 @@
* @brief ARM7 specific port code, structures and macros.
*
* @ingroup ARM7
- * @file ports/ARM7/chtypes.h Port types.
- * @file ports/ARM7/chcore.h Port related structures and macros.
- * @file ports/ARM7/chcore.c Port related code.
+ * @file ARM7/chtypes.h Port types.
+ * @file ARM7/chcore.h Port related structures and macros.
+ * @file ARM7/chcore.c Port related code.
*/
/**
@@ -196,5 +196,5 @@
* - @p _bss_end BSS end location +1.
* .
* @ingroup ARM7
- * @file ports/ARM7/crt0.s Startup code.
+ * @file ARM7/crt0.s Startup code.
*/
diff --git a/os/ports/GCC/ARMCM3/STM32F103/pal_lld.c b/os/ports/GCC/ARMCM3/STM32F103/pal_lld.c
index 00db6b980..f2fad1360 100644
--- a/os/ports/GCC/ARMCM3/STM32F103/pal_lld.c
+++ b/os/ports/GCC/ARMCM3/STM32F103/pal_lld.c
@@ -18,7 +18,7 @@
*/
/**
- * @file os/ports/GCC/ARMCM3/STM32F103/pal_lld.c
+ * @file STM32F103/pal_lld.c
* @brief STM32 GPIO low level driver code
* @addtogroup STM32F103_PAL
* @{
diff --git a/os/ports/GCC/ARMCM3/STM32F103/pal_lld.h b/os/ports/GCC/ARMCM3/STM32F103/pal_lld.h
index 55cb37046..3a0811ac2 100644
--- a/os/ports/GCC/ARMCM3/STM32F103/pal_lld.h
+++ b/os/ports/GCC/ARMCM3/STM32F103/pal_lld.h
@@ -18,7 +18,7 @@
*/
/**
- * @file os/ports/GCC/ARMCM3/STM32F103/pal_lld.h
+ * @file STM32F103/pal_lld.h
* @brief STM32 GPIO low level driver header
* @addtogroup STM32F103_PAL
* @{
diff --git a/os/ports/GCC/ARMCM3/STM32F103/serial_lld.c b/os/ports/GCC/ARMCM3/STM32F103/serial_lld.c
index f58f7aad0..f671f2be6 100644
--- a/os/ports/GCC/ARMCM3/STM32F103/serial_lld.c
+++ b/os/ports/GCC/ARMCM3/STM32F103/serial_lld.c
@@ -18,9 +18,9 @@
*/
/**
- * @file os/io/templates/serial_lld.c
- * @brief Serial Driver subsystem low level driver source template
- * @addtogroup SERIAL_LLD
+ * @file STM32F103/serial_lld.c
+ * @brief STM32F103 low level serial driver code
+ * @addtogroup STM32F103_SERIAL
* @{
*/
@@ -271,7 +271,7 @@ void sd_lld_start(SerialDriver *sdp, const SerialDriverConfig *config) {
* @details De-initializes the USART, stops the associated clock, resets the
* interrupt vector.
*
- * @param[in] sd pointer to a @p SerialDriver object
+ * @param[in] sdp pointer to a @p SerialDriver object
*/
void sd_lld_stop(SerialDriver *sdp) {
diff --git a/os/ports/GCC/ARMCM3/STM32F103/serial_lld.h b/os/ports/GCC/ARMCM3/STM32F103/serial_lld.h
index 280a44b2f..daa92c547 100644
--- a/os/ports/GCC/ARMCM3/STM32F103/serial_lld.h
+++ b/os/ports/GCC/ARMCM3/STM32F103/serial_lld.h
@@ -18,9 +18,9 @@
*/
/**
- * @file os/io/templates/serial_lld.h
- * @brief Serial Driver subsystem low level driver header template
- * @addtogroup SERIAL_LLD
+ * @file STM32F103/serial_lld.h
+ * @brief STM32F103 low level serial driver header
+ * @addtogroup STM32F103_SERIAL
* @{
*/
diff --git a/os/ports/GCC/ARMCM3/STM32F103/stm32_can.c b/os/ports/GCC/ARMCM3/STM32F103/stm32_can.c
index a5f343dee..d97855a71 100644
--- a/os/ports/GCC/ARMCM3/STM32F103/stm32_can.c
+++ b/os/ports/GCC/ARMCM3/STM32F103/stm32_can.c
@@ -18,7 +18,7 @@
*/
/**
- * @file ports/ARMCM3-STM32F103/stm32_can.c
+ * @file STM32F103/stm32_can.c
* @brief STM32 CAN driver code
* @addtogroup STM32F103_CAN
* @{
diff --git a/os/ports/GCC/ARMCM3/STM32F103/stm32_can.h b/os/ports/GCC/ARMCM3/STM32F103/stm32_can.h
index 69515758d..a124f7cdd 100644
--- a/os/ports/GCC/ARMCM3/STM32F103/stm32_can.h
+++ b/os/ports/GCC/ARMCM3/STM32F103/stm32_can.h
@@ -18,7 +18,7 @@
*/
/**
- * @file ports/ARMCM3-STM32F103/stm32_can.h
+ * @file STM32F103/stm32_can.h
* @brief STM32 CAN driver header file
* @addtogroup STM32F103_CAN
* @{
diff --git a/os/ports/GCC/ARMCM3/chcore.c b/os/ports/GCC/ARMCM3/chcore.c
index 80bd13490..ad50bfc31 100644
--- a/os/ports/GCC/ARMCM3/chcore.c
+++ b/os/ports/GCC/ARMCM3/chcore.c
@@ -18,7 +18,7 @@
*/
/**
- * @file ports/ARMCM3/chcore.c
+ * @file ARMCM3/chcore.c
* @brief ARM Cortex-M3 architecture port code.
* @addtogroup ARMCM3_CORE
* @{
diff --git a/os/ports/GCC/ARMCM3/chcore.h b/os/ports/GCC/ARMCM3/chcore.h
index e54f3ca64..4b1a5355f 100644
--- a/os/ports/GCC/ARMCM3/chcore.h
+++ b/os/ports/GCC/ARMCM3/chcore.h
@@ -18,7 +18,7 @@
*/
/**
- * @file ports/ARMCM3/chcore.h
+ * @file ARMCM3/chcore.h
* @brief ARM Cortex-M3 architecture port macros and structures.
* @addtogroup ARMCM3_CORE
* @{
diff --git a/os/ports/GCC/ARMCM3/chtypes.h b/os/ports/GCC/ARMCM3/chtypes.h
index 7373b9823..4865002f3 100644
--- a/os/ports/GCC/ARMCM3/chtypes.h
+++ b/os/ports/GCC/ARMCM3/chtypes.h
@@ -18,7 +18,7 @@
*/
/**
- * @file ports/ARMCM3/chtypes.h
+ * @file ARMCM3/chtypes.h
* @brief ARM Cortex-M3 architecture port system types.
* @addtogroup ARMCM3_CORE
* @{
diff --git a/os/ports/GCC/ARMCM3/crt0.s b/os/ports/GCC/ARMCM3/crt0.s
index 0c2ab5ab6..81da94c2c 100644
--- a/os/ports/GCC/ARMCM3/crt0.s
+++ b/os/ports/GCC/ARMCM3/crt0.s
@@ -18,7 +18,7 @@
*/
/**
- * @file ports/ARMCM3/crt0.s
+ * @file ARMCM3/crt0.s
* @brief Generic ARM Cortex-M3 startup file for ChibiOS/RT.
* @addtogroup ARMCM3_CORE
* @{
diff --git a/os/ports/GCC/ARMCM3/nvic.c b/os/ports/GCC/ARMCM3/nvic.c
index e992427fd..c34aaf4ea 100644
--- a/os/ports/GCC/ARMCM3/nvic.c
+++ b/os/ports/GCC/ARMCM3/nvic.c
@@ -18,7 +18,7 @@
*/
/**
- * @file ports/ARMCM3/nvic.c
+ * @file ARMCM3/nvic.c
* @brief Cortex-M3 NVIC support code.
* @addtogroup ARMCM3_NVIC
* @{
diff --git a/os/ports/GCC/ARMCM3/nvic.h b/os/ports/GCC/ARMCM3/nvic.h
index 54437aa62..ff4bfa34f 100644
--- a/os/ports/GCC/ARMCM3/nvic.h
+++ b/os/ports/GCC/ARMCM3/nvic.h
@@ -18,7 +18,7 @@
*/
/**
- * @file ports/ARMCM3/nvic.h
+ * @file ARMCM3/nvic.h
* @brief Cortex-M3 NVIC support macros and structures.
* @addtogroup ARMCM3_NVIC
* @{
diff --git a/os/ports/GCC/ARMCM3/port.dox b/os/ports/GCC/ARMCM3/port.dox
index db44ab9c5..652af7d68 100644
--- a/os/ports/GCC/ARMCM3/port.dox
+++ b/os/ports/GCC/ARMCM3/port.dox
@@ -159,7 +159,7 @@
* - @p _bss_end BSS end location +1.
* .
* @ingroup ARMCM3
- * @file ports/ARMCM3/crt0.s Startup code.
+ * @file ARMCM3/crt0.s Startup code.
*/
/**
diff --git a/os/ports/GCC/AVR/avr_serial.c b/os/ports/GCC/AVR/avr_serial.c
index b69a43213..de45d25c0 100644
--- a/os/ports/GCC/AVR/avr_serial.c
+++ b/os/ports/GCC/AVR/avr_serial.c
@@ -18,7 +18,7 @@
*/
/**
- * @file ports/AVR/avr_serial.c
+ * @file AVR/avr_serial.c
* @brief AVR Serial driver code.
* @addtogroup AVR_SERIAL
* @{
diff --git a/os/ports/GCC/AVR/avr_serial.h b/os/ports/GCC/AVR/avr_serial.h
index f97f16e65..5a96044fa 100644
--- a/os/ports/GCC/AVR/avr_serial.h
+++ b/os/ports/GCC/AVR/avr_serial.h
@@ -18,7 +18,7 @@
*/
/**
- * @file ports/AVR/avr_serial.h
+ * @file AVR/avr_serial.h
* @brief AVR Serial driver macros and structures.
* @addtogroup AVR_SERIAL
* @{
diff --git a/os/ports/GCC/AVR/chcore.c b/os/ports/GCC/AVR/chcore.c
index 7d39d12c3..fedba0fbe 100644
--- a/os/ports/GCC/AVR/chcore.c
+++ b/os/ports/GCC/AVR/chcore.c
@@ -18,7 +18,7 @@
*/
/**
- * @file ports/AVR/chcore.c
+ * @file AVR/chcore.c
* @brief AVR architecture port code.
* @addtogroup AVR_CORE
* @{
diff --git a/os/ports/GCC/AVR/chcore.h b/os/ports/GCC/AVR/chcore.h
index c70c5307e..18439b9fe 100644
--- a/os/ports/GCC/AVR/chcore.h
+++ b/os/ports/GCC/AVR/chcore.h
@@ -18,7 +18,7 @@
*/
/**
- * @file ports/AVR/chcore.h
+ * @file AVR/chcore.h
* @brief AVR architecture port macros and structures.
* @addtogroup AVR_CORE
* @{
diff --git a/os/ports/GCC/AVR/chtypes.h b/os/ports/GCC/AVR/chtypes.h
index e5920746c..0d5d7e4c4 100644
--- a/os/ports/GCC/AVR/chtypes.h
+++ b/os/ports/GCC/AVR/chtypes.h
@@ -18,7 +18,7 @@
*/
/**
- * @file ports/AVR/chtypes.h
+ * @file AVR/chtypes.h
* @brief AVR architecture port system types.
* @addtogroup AVR_CORE
* @{
diff --git a/os/ports/GCC/AVR/port.dox b/os/ports/GCC/AVR/port.dox
index 5343037b1..90f7970b5 100644
--- a/os/ports/GCC/AVR/port.dox
+++ b/os/ports/GCC/AVR/port.dox
@@ -73,9 +73,9 @@
* @brief AVR specific port code, structures and macros.
*
* @ingroup AVR
- * @file ports/AVR/chtypes.h Port types.
- * @file ports/AVR/chcore.h Port related structures and macros.
- * @file ports/AVR/chcore.c Port related code.
+ * @file AVR/chtypes.h Port types.
+ * @file AVR/chcore.h Port related structures and macros.
+ * @file AVR/chcore.c Port related code.
*/
/**
diff --git a/os/ports/GCC/MSP430/chcore.c b/os/ports/GCC/MSP430/chcore.c
index 45d52726a..374bec9a6 100644
--- a/os/ports/GCC/MSP430/chcore.c
+++ b/os/ports/GCC/MSP430/chcore.c
@@ -18,7 +18,7 @@
*/
/**
- * @file ports/MSP430/chcore.c
+ * @file MSP430/chcore.c
* @brief MSP430 architecture port code.
* @addtogroup MSP430_CORE
* @{
diff --git a/os/ports/GCC/MSP430/chcore.h b/os/ports/GCC/MSP430/chcore.h
index 313108cde..f903a116a 100644
--- a/os/ports/GCC/MSP430/chcore.h
+++ b/os/ports/GCC/MSP430/chcore.h
@@ -18,7 +18,7 @@
*/
/**
- * @file ports/MSP430/chcore.h
+ * @file MSP430/chcore.h
* @brief MSP430 architecture port macros and structures.
* @addtogroup MSP430_CORE
* @{
diff --git a/os/ports/GCC/MSP430/chtypes.h b/os/ports/GCC/MSP430/chtypes.h
index f8d7c944a..f273d81ab 100644
--- a/os/ports/GCC/MSP430/chtypes.h
+++ b/os/ports/GCC/MSP430/chtypes.h
@@ -18,7 +18,7 @@
*/
/**
- * @file ports/MSP430/chtypes.h
+ * @file MSP430/chtypes.h
* @brief MSP430 architecture port system types.
* @addtogroup MSP430_CORE
* @{
diff --git a/os/ports/GCC/MSP430/msp430_serial.c b/os/ports/GCC/MSP430/msp430_serial.c
index 69351b19d..a7da03c60 100644
--- a/os/ports/GCC/MSP430/msp430_serial.c
+++ b/os/ports/GCC/MSP430/msp430_serial.c
@@ -18,7 +18,7 @@
*/
/**
- * @file ports/MSP430/msp430_serial.c
+ * @file MSP430/msp430_serial.c
* @brief MSP430 Serial driver code.
* @addtogroup MSP430_SERIAL
* @{
diff --git a/os/ports/GCC/MSP430/msp430_serial.h b/os/ports/GCC/MSP430/msp430_serial.h
index 2195a6869..487dc22ec 100644
--- a/os/ports/GCC/MSP430/msp430_serial.h
+++ b/os/ports/GCC/MSP430/msp430_serial.h
@@ -18,7 +18,7 @@
*/
/**
- * @file ports/MSP430/msp430_serial.h
+ * @file MSP430/msp430_serial.h
* @brief MSP430 Serial driver macros and structures.
* @addtogroup MSP430_SERIAL
* @{
diff --git a/os/ports/GCC/MSP430/pal_lld.c b/os/ports/GCC/MSP430/pal_lld.c
index ae9e3809b..885a58dbc 100644
--- a/os/ports/GCC/MSP430/pal_lld.c
+++ b/os/ports/GCC/MSP430/pal_lld.c
@@ -18,7 +18,7 @@
*/
/**
- * @file os/ports/GCC/MSP430/pal_lld.c
+ * @file MSP430/pal_lld.c
* @brief MSP430 Digital I/O low level driver code
* @addtogroup MSP430_PAL
* @{
diff --git a/os/ports/GCC/MSP430/pal_lld.h b/os/ports/GCC/MSP430/pal_lld.h
index 468809d51..94407a849 100644
--- a/os/ports/GCC/MSP430/pal_lld.h
+++ b/os/ports/GCC/MSP430/pal_lld.h
@@ -18,7 +18,7 @@
*/
/**
- * @file os/ports/GCC/MSP430/pal_lld.h
+ * @file MSP430/pal_lld.h
* @brief MSP430 Digital I/O low level driver header
* @addtogroup MSP430_PAL
* @{
diff --git a/os/ports/GCC/MSP430/port.dox b/os/ports/GCC/MSP430/port.dox
index 1d0216d3c..232053f06 100644
--- a/os/ports/GCC/MSP430/port.dox
+++ b/os/ports/GCC/MSP430/port.dox
@@ -79,6 +79,9 @@
* @brief MSP430 specific port code, structures and macros.
*
* @ingroup MSP430
+ * @file MSP430/chtypes.h Port types.
+ * @file MSP430/chcore.h Port related structures and macros.
+ * @file MSP430/chcore.c Port related code.
*/
/**