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

Reviewed EX documentation (Still incomplete) 

git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@12731 27425a3e-05d8-49a3-a47f-9c15f0e5edd8
This commit is contained in:
Rocco Marco Guglielmi 2019-04-07 15:23:02 +00:00
parent 66aad54a16
commit 70c872d44c
13 changed files with 92 additions and 114 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/ex/Doxyfile_chm
View File

@ -815,9 +815,9 @@ WARN_LOGFILE =
INPUT = ./src \ INPUT = ./src \
../../os/ex/dox \ ../../os/ex/dox \
../../os/ex/Bosch \ ../../os/ex/devices/Bosch \
../../os/ex/ST \ ../../os/ex/devices/ST \
../../os/hal/lib/peripherals/sensors ../../os/ex/include
# This tag can be used to specify the character encoding of the source files # This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
@ -1344,7 +1344,7 @@ GENERATE_HTMLHELP = YES
# written to the html output directory. # written to the html output directory.
# This tag requires that the tag GENERATE_HTMLHELP is set to YES. # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
CHM_FILE = ../../ChibiOS_HAL.chm CHM_FILE = ../../ChibiOS_EX.chm
# The HHC_LOCATION tag can be used to specify the location (absolute path # The HHC_LOCATION tag can be used to specify the location (absolute path
# including file name) of the HTML help compiler (hhc.exe). If non-empty, # including file name) of the HTML help compiler (hhc.exe). If non-empty,

8
doc/ex/Doxyfile_html
View File

@ -815,9 +815,9 @@ WARN_LOGFILE =
INPUT = ./src \ INPUT = ./src \
../../os/ex/dox \ ../../os/ex/dox \
../../os/ex/Bosch \ ../../os/ex/devices/Bosch \
../../os/ex/ST \ ../../os/ex/devices/ST \
../../os/hal/lib/peripherals/sensors ../../os/ex/include
# This tag can be used to specify the character encoding of the source files # This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
@ -1366,7 +1366,7 @@ GENERATE_HTMLHELP = NO
# written to the html output directory. # written to the html output directory.
# This tag requires that the tag GENERATE_HTMLHELP is set to YES. # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
CHM_FILE = ../../ChibiOS_HAL.chm CHM_FILE = ../../ChibiOS_EX.chm
# The HHC_LOCATION tag can be used to specify the location (absolute path # The HHC_LOCATION tag can be used to specify the location (absolute path
# including file name) of the HTML help compiler (hhc.exe). If non-empty, # including file name) of the HTML help compiler (hhc.exe). If non-empty,

22
os/ex/dox/accelerometer.dox
View File

@ -1,22 +0,0 @@
/*
ChibiOS - Copyright (C) 2006..2018 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_ACCELEROMETER Generic Accelerometer Interface
* @brief HAL Generic Accelerometer Interface.
*
* @ingroup HAL_ABSTRACT_PERIPHERALS
*/

22
os/ex/dox/ex_accelerometer.dox Normal file
View File

@ -0,0 +1,22 @@
/*
ChibiOS - Copyright (C) 2006..2018 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_ACCELEROMETER Generic Accelerometer Interface
* @brief EX Generic Accelerometer Interface.
*
* @ingroup EX_ABSTRACT_PERIPHERALS
*/

6
os/ex/dox/barometer.dox → os/ex/dox/ex_barometer.dox
View File

@ -15,8 +15,8 @@
*/ */
/** /**
* @defgroup HAL_BAROMETER Generic Barometer Interface * @defgroup EX_BAROMETER Generic Barometer Interface
* @brief HAL Generic Barometer Interface. * @brief EX Generic Barometer Interface.
* *
* @ingroup HAL_ABSTRACT_PERIPHERALS * @ingroup EX_ABSTRACT_PERIPHERALS
*/ */

6
os/ex/dox/sensor.dox → os/ex/dox/ex_compass.dox
View File

@ -15,8 +15,8 @@
*/ */
/** /**
* @defgroup HAL_SENSORS Generic Sensor Interface * @defgroup EX_COMPASS Generic Compass Interface
* @brief HAL Generic Sensor Interface. * @brief EX Generic Compass Interface.
* *
* @ingroup HAL_ABSTRACT_PERIPHERALS * @ingroup EX_ABSTRACT_PERIPHERALS
*/ */

6
os/ex/dox/gyro.dox → os/ex/dox/ex_gyro.dox
View File

@ -15,8 +15,8 @@
*/ */
/** /**
* @defgroup HAL_GYROSCOPE Generic Gyroscope Interface * @defgroup EX_GYROSCOPE Generic Gyroscope Interface
* @brief HAL Generic Gyroscope Interface. * @brief EX Generic Gyroscope Interface.
* *
* @ingroup HAL_ABSTRACT_PERIPHERALS * @ingroup EX_ABSTRACT_PERIPHERALS
*/ */

22
os/ex/dox/ex_hygrometer.dox Normal file
View File

@ -0,0 +1,22 @@
/*
ChibiOS - Copyright (C) 2006..2018 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_HYGROMETER Generic Hygrometer Interface
* @brief EX Generic Hygrometer Interface.
*
* @ingroup EX_ABSTRACT_PERIPHERALS
*/

6
os/ex/dox/compass.dox → os/ex/dox/ex_sensor.dox
View File

@ -15,8 +15,8 @@
*/ */
/** /**
* @defgroup HAL_COMPASS Generic Compass Interface * @defgroup EX_SENSORS Generic Sensor Interface
* @brief HAL Generic Compass Interface. * @brief EX Generic Sensor Interface.
* *
* @ingroup HAL_ABSTRACT_PERIPHERALS * @ingroup EX_ABSTRACT_PERIPHERALS
*/ */

6
os/ex/dox/hygrometer.dox → os/ex/dox/ex_thermometer.dox
View File

@ -15,8 +15,8 @@
*/ */
/** /**
* @defgroup HAL_HYGROMETER Generic Hygrometer Interface * @defgroup EX_THERMOMETER Generic Thermometer Interface
* @brief HAL Generic Hygrometer Interface. * @brief EX Generic Thermometer Interface.
* *
* @ingroup HAL_ABSTRACT_PERIPHERALS * @ingroup EX_ABSTRACT_PERIPHERALS
*/ */

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

@ -1,34 +0,0 @@
/*
ChibiOS - Copyright (C) 2006..2018 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_ABSTRACT_PERIPHERALS Peripheral Interfaces
* @brief HAL Abstract Peripheral Interfaces.
*
* @ingroup HAL
*/

36
os/ex/dox/main.dox
View File

@ -19,16 +19,15 @@
* @brief EXternal peripherals. * @brief EXternal peripherals.
* @details Under ChibiOS the set of the complex device driver interfaces * @details Under ChibiOS the set of the complex device driver interfaces
* dedicated to external peripherals is called the EX subsystem. The EX resides * 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 * on top of EX and is actually a set of libraries for external devices like
* MEMS, Displays, Flash memories and so on. These libraries are the * MEMS, Displays, Flash memories and so on. These libraries are the
* implementation of one or more Abstract Interfaces brought by HAL subsystem. * implementation of one or more Abstract Interfaces brought by EX subsystem.
* EX also relies on HAL normal drivers to interface the peripherals. * EX also relies on EX normal drivers to interface the peripherals.
* *
* @section ex_complex_drivers_architecture EX Complex Drivers Architecture * @section ex_complex_drivers_architecture EX Complex Drivers Architecture
* Each EX driver can be considered as a standalone Complex Device Driver. For * Each EX driver can be considered as a standalone Complex Device Driver. For
* ease of use these drivers are grouped by vendor: * ease of use these drivers are grouped by vendor:
* - Bosch Devices * - Bosch Devices
* - Micron Technology Devices
* - STMicroelectronics Devices * - STMicroelectronics Devices
* . * .
* *
@ -38,12 +37,6 @@
* - @b BMP085: Digital pressure sensor; * - @b BMP085: Digital pressure sensor;
* . * .
* *
* @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 * @section stmicroelectronics_devices STMicroelectronics Devices
* This section contains all the drivers of devices produced by * This section contains all the drivers of devices produced by
* STMicroelectronics. Devices currently supported are MEMS and are: * STMicroelectronics. Devices currently supported are MEMS and are:
@ -57,17 +50,36 @@
* - @b LSM303DLHC: Ultra compact high performance e-compass; * - @b LSM303DLHC: Ultra compact high performance e-compass;
* . * .
*/ */
*
* @section hal_peripheral interfaces EX Peripheral Interfaces
* These are a particular case of EX Interfaces since they are an abstraction
* of a hardware.
*/
/**
* @defgroup EX_ABSTRACT_PERIPHERALS Peripheral Interfaces
* @brief EX Abstract Peripheral Interfaces.
*
* @ingroup EX
*/
/**
* @defgroup EX_DEVICES Devices
* @brief EX devices organized per vendor.
*
* @ingroup EX
*/
/** /**
* @defgroup EX_BOSCH Bosch Devices * @defgroup EX_BOSCH Bosch Devices
* @brief Bosch Devices. * @brief Bosch Devices.
* *
* @ingroup EX * @ingroup EX_DEVICES
*/ */
/** /**
* @defgroup EX_ST STMicroelectronics Devices * @defgroup EX_ST STMicroelectronics Devices
* @brief STMicroelectronics Devices. * @brief STMicroelectronics Devices.
* *
* @ingroup EX * @ingroup EX_DEVICES
*/ */

22
os/ex/dox/thermometer.dox
View File

@ -1,22 +0,0 @@
/*
ChibiOS - Copyright (C) 2006..2018 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_THERMOMETER Generic Thermometer Interface
* @brief HAL Generic Thermometer Interface.
*
* @ingroup HAL_ABSTRACT_PERIPHERALS
*/