andreika-git
/
ChibiOS
mirror of https://github.com/andreika-git/ChibiOS.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@1087 35acf78f-673a-0410-8e92-d51de3d6d3f4

This commit is contained in:
gdisirio 2009-08-20 11:15:24 +00:00
parent f7117a6201
commit 8ce831d013
49 changed files with 117 additions and 90 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
docs/Doxyfile
View File

@ -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

50
docs/src/main.dox
View File

@ -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,21 +479,27 @@
*/
/**
* @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.

12
os/io/serial.c
View File

@ -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) {

2
os/io/templates/serial_lld.c
View File

@ -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) {

2
os/ports/GCC/ARM7/AT91SAM7X/sam7x_emac.c
View File

@ -18,7 +18,7 @@
*/
/**
* @file ports/ARM7-AT91SAM7X/sam7x_emac.c
* @file AT91SAM7X/sam7x_emac.c
* @brief AT91SAM7X EMAC driver code.
* @addtogroup AT91SAM7X_EMAC
* @{

2
os/ports/GCC/ARM7/AT91SAM7X/sam7x_emac.h
View File

@ -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
* @{

2
os/ports/GCC/ARM7/AT91SAM7X/sam7x_serial.c
View File

@ -18,7 +18,7 @@
*/
/**
* @file ports/ARM7-AT91SAM7X/sam7x_serial.c
* @file AT91SAM7X/sam7x_serial.c
* @brief AT91SAM7X Serial driver code.
* @addtogroup AT91SAM7X_SERIAL
* @{

2
os/ports/GCC/ARM7/AT91SAM7X/sam7x_serial.h
View File

@ -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
* @{

2
os/ports/GCC/ARM7/LPC214x/lpc214x_serial.c
View File

@ -18,7 +18,7 @@
*/
/**
* @file ports/ARM7-LPC214x/lpc214x_serial.c
* @file LPC214x/lpc214x_serial.c
* @brief LPC214x Serial driver code.
* @addtogroup LPC214x_SERIAL
* @{

2
os/ports/GCC/ARM7/LPC214x/lpc214x_serial.h
View File

@ -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
* @{

2
os/ports/GCC/ARM7/LPC214x/lpc214x_ssp.c
View File

@ -18,7 +18,7 @@
*/
/**
* @file ports/ARM7-LPC214x/lpc214x_ssp.c
* @file LPC214x/lpc214x_ssp.c
* @brief LPC214x SSP driver code.
* @addtogroup LPC214x_SSP
* @{

2
os/ports/GCC/ARM7/LPC214x/lpc214x_ssp.h
View File

@ -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
* @{

2
os/ports/GCC/ARM7/LPC214x/pal_lld.c
View File

@ -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
* @{

2
os/ports/GCC/ARM7/LPC214x/pal_lld.h
View File

@ -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
* @{

2
os/ports/GCC/ARM7/LPC214x/vic.c
View File

@ -18,7 +18,7 @@
*/
/**
* @file ports/ARM7-LPC214x/vic.c
* @file LPC214x/vic.c
* @brief LPC214x VIC peripheral support code.
* @addtogroup LPC214x_VIC
* @{

2
os/ports/GCC/ARM7/LPC214x/vic.h
View File

@ -18,7 +18,7 @@
*/
/**
* @file ports/ARM7-LPC214x/vic.h
* @file LPC214x/vic.h
* @brief LPC214x VIC peripheral support code.
* @addtogroup LPC214x_VIC
* @{

2
os/ports/GCC/ARM7/chcore.c
View File

@ -18,7 +18,7 @@
*/
/**
* @file ports/ARM7/chcore.c
* @file ARM7/chcore.c
* @brief ARM7 architecture port code.
* @addtogroup ARM7_CORE
* @{

2
os/ports/GCC/ARM7/chcore.h
View File

@ -18,7 +18,7 @@
*/
/**
* @file ports/ARM7/chcore.h
* @file ARM7/chcore.h
* @brief ARM7 architecture port macros and structures.
* @addtogroup ARM7_CORE
* @{

2
os/ports/GCC/ARM7/chcoreasm.s
View File

@ -18,7 +18,7 @@
*/
/**
* @file ports/ARM7/chcoreasm.s
* @file ARM7/chcoreasm.s
* @brief ARM7 architecture port low level code.
* @addtogroup ARM7_CORE
* @{

2
os/ports/GCC/ARM7/chtypes.h
View File

@ -18,7 +18,7 @@
*/
/**
* @file ports/ARM7/chtypes.h
* @file ARM7/chtypes.h
* @brief ARM7 architecture port system types.
* @addtogroup ARM7_CORE
* @{

2
os/ports/GCC/ARM7/crt0.s
View File

@ -18,7 +18,7 @@
*/
/**
* @file ports/ARM7/crt0.s
* @file ARM7/crt0.s
* @brief Generic ARM7 startup file for ChibiOS/RT.
* @addtogroup ARM7_CORE
* @{

8
os/ports/GCC/ARM7/port.dox
View File

@ -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.
*/

2
os/ports/GCC/ARMCM3/STM32F103/pal_lld.c
View File

@ -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
* @{

2
os/ports/GCC/ARMCM3/STM32F103/pal_lld.h
View File

@ -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
* @{

8
os/ports/GCC/ARMCM3/STM32F103/serial_lld.c
View File

@ -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) {

6
os/ports/GCC/ARMCM3/STM32F103/serial_lld.h
View File

@ -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
* @{
*/

2
os/ports/GCC/ARMCM3/STM32F103/stm32_can.c
View File

@ -18,7 +18,7 @@
*/
/**
* @file ports/ARMCM3-STM32F103/stm32_can.c
* @file STM32F103/stm32_can.c
* @brief STM32 CAN driver code
* @addtogroup STM32F103_CAN
* @{

2
os/ports/GCC/ARMCM3/STM32F103/stm32_can.h
View File

@ -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
* @{

2
os/ports/GCC/ARMCM3/chcore.c
View File

@ -18,7 +18,7 @@
*/
/**
* @file ports/ARMCM3/chcore.c
* @file ARMCM3/chcore.c
* @brief ARM Cortex-M3 architecture port code.
* @addtogroup ARMCM3_CORE
* @{

2
os/ports/GCC/ARMCM3/chcore.h
View File

@ -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
* @{

2
os/ports/GCC/ARMCM3/chtypes.h
View File

@ -18,7 +18,7 @@
*/
/**
* @file ports/ARMCM3/chtypes.h
* @file ARMCM3/chtypes.h
* @brief ARM Cortex-M3 architecture port system types.
* @addtogroup ARMCM3_CORE
* @{

2
os/ports/GCC/ARMCM3/crt0.s
View File

@ -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
* @{

2
os/ports/GCC/ARMCM3/nvic.c
View File

@ -18,7 +18,7 @@
*/
/**
* @file ports/ARMCM3/nvic.c
* @file ARMCM3/nvic.c
* @brief Cortex-M3 NVIC support code.
* @addtogroup ARMCM3_NVIC
* @{

2
os/ports/GCC/ARMCM3/nvic.h
View File

@ -18,7 +18,7 @@
*/
/**
* @file ports/ARMCM3/nvic.h
* @file ARMCM3/nvic.h
* @brief Cortex-M3 NVIC support macros and structures.
* @addtogroup ARMCM3_NVIC
* @{

2
os/ports/GCC/ARMCM3/port.dox
View File

@ -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.
*/
/**

2
os/ports/GCC/AVR/avr_serial.c
View File

@ -18,7 +18,7 @@
*/
/**
* @file ports/AVR/avr_serial.c
* @file AVR/avr_serial.c
* @brief AVR Serial driver code.
* @addtogroup AVR_SERIAL
* @{

2
os/ports/GCC/AVR/avr_serial.h
View File

@ -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
* @{

2
os/ports/GCC/AVR/chcore.c
View File

@ -18,7 +18,7 @@
*/
/**
* @file ports/AVR/chcore.c
* @file AVR/chcore.c
* @brief AVR architecture port code.
* @addtogroup AVR_CORE
* @{

2
os/ports/GCC/AVR/chcore.h
View File

@ -18,7 +18,7 @@
*/
/**
* @file ports/AVR/chcore.h
* @file AVR/chcore.h
* @brief AVR architecture port macros and structures.
* @addtogroup AVR_CORE
* @{

2
os/ports/GCC/AVR/chtypes.h
View File

@ -18,7 +18,7 @@
*/
/**
* @file ports/AVR/chtypes.h
* @file AVR/chtypes.h
* @brief AVR architecture port system types.
* @addtogroup AVR_CORE
* @{

6
os/ports/GCC/AVR/port.dox
View File

@ -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.
*/
/**

2
os/ports/GCC/MSP430/chcore.c
View File

@ -18,7 +18,7 @@
*/
/**
* @file ports/MSP430/chcore.c
* @file MSP430/chcore.c
* @brief MSP430 architecture port code.
* @addtogroup MSP430_CORE
* @{

2
os/ports/GCC/MSP430/chcore.h
View File

@ -18,7 +18,7 @@
*/
/**
* @file ports/MSP430/chcore.h
* @file MSP430/chcore.h
* @brief MSP430 architecture port macros and structures.
* @addtogroup MSP430_CORE
* @{

2
os/ports/GCC/MSP430/chtypes.h
View File

@ -18,7 +18,7 @@
*/
/**
* @file ports/MSP430/chtypes.h
* @file MSP430/chtypes.h
* @brief MSP430 architecture port system types.
* @addtogroup MSP430_CORE
* @{

2
os/ports/GCC/MSP430/msp430_serial.c
View File

@ -18,7 +18,7 @@
*/
/**
* @file ports/MSP430/msp430_serial.c
* @file MSP430/msp430_serial.c
* @brief MSP430 Serial driver code.
* @addtogroup MSP430_SERIAL
* @{

2
os/ports/GCC/MSP430/msp430_serial.h
View File

@ -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
* @{

2
os/ports/GCC/MSP430/pal_lld.c
View File

@ -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
* @{

2
os/ports/GCC/MSP430/pal_lld.h
View File

@ -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
* @{

3
os/ports/GCC/MSP430/port.dox
View File

@ -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.
*/
/**