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

Improved ChibiOS\EX documentation (Still uncomplete) 

git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@10274 35acf78f-673a-0410-8e92-d51de3d6d3f4
This commit is contained in:
roccomarco 2017-07-01 18:45:25 +00:00
parent 3edd2f7ccb
commit 3588ac33a3
21 changed files with 174 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
os/ex/Micron/m25q.c
View File

@ -21,7 +21,8 @@
* @file m25q.c
* @brief Micron serial flash driver code.
*
* @addtogroup m25q
* @addtogroup M25Q
* @ingroup EX_MICRON
* @{
*/

3
os/ex/Micron/m25q.h
View File

@ -21,7 +21,8 @@
* @file m25q.h
* @brief Micron serial flash driver header.
*
* @addtogroup m25q
* @addtogroup M25Q
* @ingroup EX_MICRON
* @{
*/

3
os/ex/ST/hts221.c
View File

@ -22,7 +22,8 @@
* @file hts221.c
* @brief HTS221 MEMS interface module code.
*
* @addtogroup hts221
* @addtogroup HTS221
* @ingroup EX_ST
* @{
*/

3
os/ex/ST/hts221.h
View File

@ -22,6 +22,9 @@
* @file hts221.h
* @brief HTS221 MEMS interface module header.
*
*
* @addtogroup HTS221
* @ingroup EX_ST
* @{
*/
#ifndef _HTS221_H_

3
os/ex/ST/l3gd20.c
View File

@ -22,7 +22,8 @@
* @file l3gd20.c
* @brief L3GD20 MEMS interface module code.
*
* @addtogroup l3gd20
* @addtogroup L3GD20
* @ingroup EX_ST
* @{
*/

2
os/ex/ST/l3gd20.h
View File

@ -22,6 +22,8 @@
* @file l3gd20.h
* @brief L3GD20 MEMS interface module header.
*
* @addtogroup L3GD20
* @ingroup EX_ST
* @{
*/
#ifndef _L3GD20_H_

3
os/ex/ST/lis302dl.c
View File

@ -22,7 +22,8 @@
* @file lis302dl.c
* @brief LIS302DL MEMS interface module code.
*
* @addtogroup lis302dl
* @addtogroup LIS302DL
* @ingroup EX_ST
* @{
*/

2
os/ex/ST/lis302dl.h
View File

@ -22,6 +22,8 @@
* @file lis302dl.h
* @brief LIS302DL MEMS interface module header.
*
* @addtogroup LIS302DL
* @ingroup EX_ST
* @{
*/

3
os/ex/ST/lis3dsh.c
View File

@ -22,7 +22,8 @@
* @file lis3dsh.c
* @brief LIS3DSH MEMS interface module code.
*
* @addtogroup lis3dsh
* @addtogroup LIS3DSH
* @ingroup EX_ST
* @{
*/

2
os/ex/ST/lis3dsh.h
View File

@ -22,6 +22,8 @@
* @file lis3dsh.h
* @brief LIS3DSH MEMS interface module header.
*
* @addtogroup LIS3DSH
* @ingroup EX_ST
* @{
*/

3
os/ex/ST/lis3mdl.c
View File

@ -22,7 +22,8 @@
* @file lis3mdl.c
* @brief LIS3MDL MEMS interface module code.
*
* @addtogroup lis3mdl
* @addtogroup LIS3MDL
* @ingroup EX_ST
* @{
*/

2
os/ex/ST/lis3mdl.h
View File

@ -22,6 +22,8 @@
* @file lis3mdl.h
* @brief LIS3MDL MEMS interface module header.
*
* @addtogroup LIS3MDL
* @ingroup EX_ST
* @{
*/
#ifndef _LIS3MDL_H_

3
os/ex/ST/lps25h.c
View File

@ -22,7 +22,8 @@
* @file lps25h.c
* @brief LPS25H MEMS interface module code.
*
* @addtogroup lps25h
* @addtogroup LPS25H
* @ingroup EX_ST
* @{
*/

2
os/ex/ST/lps25h.h
View File

@ -22,6 +22,8 @@
* @file lps25h.h
* @brief LPS25H MEMS interface module header.
*
* @addtogroup LPS25H
* @ingroup EX_ST
* @{
*/
#ifndef _LPS25H_H_

3
os/ex/ST/lsm303dlhc.c
View File

@ -22,7 +22,8 @@
* @file lsm303dlhc.c
* @brief LSM303DLHC MEMS interface module code.
*
* @addtogroup lsm303dlhc
* @addtogroup LSM303DLHC
* @ingroup EX_ST
* @{
*/

2
os/ex/ST/lsm303dlhc.h
View File

@ -22,6 +22,8 @@
* @file lsm303dlhc.h
* @brief LSM303DLHC MEMS interface module header.
*
* @addtogroup LSM303DLHC
* @ingroup EX_ST
* @{
*/
#ifndef _LSM303DLHC_H_

3
os/ex/ST/lsm6ds0.c
View File

@ -22,7 +22,8 @@
* @file lsm6ds0.c
* @brief LSM6DS0 MEMS interface module code.
*
* @addtogroup lsm6ds0
* @addtogroup LSM6DS0
* @ingroup EX_ST
* @{
*/

2
os/ex/ST/lsm6ds0.h
View File

@ -22,6 +22,8 @@
* @file lsm6ds0.h
* @brief LSM6DS0 MEMS interface module header.
*
* @addtogroup LSM6DS0
* @ingroup EX_ST
* @{
*/
#ifndef _LSM6DS0_H_

38
os/ex/dox/gyro.dox Normal file
View File

@ -0,0 +1,38 @@
/*
ChibiOS - Copyright (C) 2006..2016 Giovanni Di Sirio
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
/**
* @defgroup HAL HAL
* @brief Hardware Abstraction Layer.
* @details Under ChibiOS the set of the various device driver interfaces
* is called the HAL subsystem: Hardware Abstraction Layer. The HAL is the
* abstract interface between ChibiOS applications and hardware.
*
* @section hal_interfaces HAL Interfaces
* An interface is a binary structure allowing the access to a service
* using virtual functions. This allows to create drivers that can be
* accessed using a common interface.
* The concept of interface is commonly found in object-oriented languages
* like Java or C++, their meaning in ChibiOS/HAL is exactly the same.
*
*/
/**
* @defgroup HAL_GYROSCOPE Generic Gyroscope Interfaces
* @brief HAL Generic Gyroscope Interfaces.
*
* @ingroup HAL_PERIPHERAL_INTERFACES
*/

34
os/ex/dox/hal.dox Normal file
View File

@ -0,0 +1,34 @@
/*
ChibiOS - Copyright (C) 2006..2016 Giovanni Di Sirio
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
/**
* @defgroup HAL HAL
* @brief Hardware Abstraction Layer.
* @details Under ChibiOS the set of the various device driver interfaces
* is called the HAL subsystem: Hardware Abstraction Layer. The HAL is the
* abstract interface between ChibiOS applications and hardware.
*
* @section hal_peripheral interfaces HAL Peripheral Interfaces
* These are a particular case of HAL Interfaces since they are an abstraction
* of a hardware.
*/
/**
* @defgroup HAL_PERIPHERAL_INTERFACES Peripheral Interfaces
* @brief HAL Peripheral Interfaces.
*
* @ingroup HAL
*/

65
os/ex/dox/main.dox Normal file
View File

@ -0,0 +1,65 @@
/*
ChibiOS - Copyright (C) 2006..2016 Giovanni Di Sirio
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
/**
* @defgroup EX EX
* @brief EXternal periferals.
* @details Under ChibiOS the set of the complex device driver interfaces
* dedicated to external peripherals is called the EX subsystem. The EX resides
* on top of HAL and is actually a set of libraries for external devices like
* MEMS, Displays, Flash memories and so on. These libraries are the
* implementation of one or more Abstract Interfaces brought by HAL subsystem.
* EX also relies on HAL normal drivers to interface the peripherals.
*
* @section ex_complex_drivers_architecture EX Complex Drivers Architecture
* Each EX driver can be considered as a standalone Complex Device Driver. For
* ease of use these drivers are grouped by vendor:
* - Micron Technology Peripherals
* - STMicroelectronics Peripherals
* .
* @section micron_devices Micron Technology Devices
* This section contains all the drivers of devices produced by
* Micron Technology. Devices currently supported are FLASH and are:
* - @b M25Q: Serial NOR flash;
* .
*
* @section stmicroelectronics_devices STMicroelectronics Devices
* This section contains all the drivers of devices produced by
* STMicroelectronics. Devices currently supported are MEMS and are:
* - @b HTS221: Capacitive digital humidity sensor;
* - @b L3GD20: 3-axis digital gyroscope;
* - @b LIS3DSH: 3-axis digital motion sensor;
* - @b LIS3MDL: Ultra low power, high performances 3-axis magnetometer;
* - @b LIS302DL: 3-axis motion sensor;
* - @b LPS25H: Piezoresistive 260-1260 hPa pressure sensor;
* - @b LSM6DS0: 6-axis iNEMO inertial module;
* - @b LSM303DLHC: Ultra compact high performance e-compass;
* .
*/
/**
* @defgroup EX_MICRON Micron Technology Devices
* @brief Micron Technology Devices.
*
* @ingroup EX
*/
/**
* @defgroup EX_ST STMicroelectronics Devices
* @brief STMicroelectronics Devices.
*
* @ingroup EX
*/