diff --git a/doc/ex/Doxyfile_chm b/doc/ex/Doxyfile_chm index 2d5bf8dff..540068508 100644 --- a/doc/ex/Doxyfile_chm +++ b/doc/ex/Doxyfile_chm @@ -815,9 +815,9 @@ WARN_LOGFILE = INPUT = ./src \ ../../os/ex/dox \ - ../../os/ex/Bosch \ - ../../os/ex/ST \ - ../../os/hal/lib/peripherals/sensors + ../../os/ex/devices/Bosch \ + ../../os/ex/devices/ST \ + ../../os/ex/include # 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 @@ -1344,7 +1344,7 @@ GENERATE_HTMLHELP = YES # written to the html output directory. # 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 # including file name) of the HTML help compiler (hhc.exe). If non-empty, diff --git a/doc/ex/Doxyfile_html b/doc/ex/Doxyfile_html index c8ae61e20..c63393ec6 100644 --- a/doc/ex/Doxyfile_html +++ b/doc/ex/Doxyfile_html @@ -815,9 +815,9 @@ WARN_LOGFILE = INPUT = ./src \ ../../os/ex/dox \ - ../../os/ex/Bosch \ - ../../os/ex/ST \ - ../../os/hal/lib/peripherals/sensors + ../../os/ex/devices/Bosch \ + ../../os/ex/devices/ST \ + ../../os/ex/include # 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 @@ -1366,7 +1366,7 @@ GENERATE_HTMLHELP = NO # written to the html output directory. # 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 # including file name) of the HTML help compiler (hhc.exe). If non-empty, diff --git a/os/ex/dox/accelerometer.dox b/os/ex/dox/accelerometer.dox deleted file mode 100644 index e93a64c3b..000000000 --- a/os/ex/dox/accelerometer.dox +++ /dev/null @@ -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 - */ diff --git a/os/ex/dox/ex_accelerometer.dox b/os/ex/dox/ex_accelerometer.dox new file mode 100644 index 000000000..8ac9c79e7 --- /dev/null +++ b/os/ex/dox/ex_accelerometer.dox @@ -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 + */ diff --git a/os/ex/dox/barometer.dox b/os/ex/dox/ex_barometer.dox similarity index 80% rename from os/ex/dox/barometer.dox rename to os/ex/dox/ex_barometer.dox index 4a472fa11..ed9a2abc9 100644 --- a/os/ex/dox/barometer.dox +++ b/os/ex/dox/ex_barometer.dox @@ -15,8 +15,8 @@ */ /** - * @defgroup HAL_BAROMETER Generic Barometer Interface - * @brief HAL Generic Barometer Interface. + * @defgroup EX_BAROMETER Generic Barometer Interface + * @brief EX Generic Barometer Interface. * - * @ingroup HAL_ABSTRACT_PERIPHERALS + * @ingroup EX_ABSTRACT_PERIPHERALS */ diff --git a/os/ex/dox/sensor.dox b/os/ex/dox/ex_compass.dox similarity index 80% rename from os/ex/dox/sensor.dox rename to os/ex/dox/ex_compass.dox index 036f7f7ac..967008c14 100644 --- a/os/ex/dox/sensor.dox +++ b/os/ex/dox/ex_compass.dox @@ -15,8 +15,8 @@ */ /** - * @defgroup HAL_SENSORS Generic Sensor Interface - * @brief HAL Generic Sensor Interface. + * @defgroup EX_COMPASS Generic Compass Interface + * @brief EX Generic Compass Interface. * - * @ingroup HAL_ABSTRACT_PERIPHERALS + * @ingroup EX_ABSTRACT_PERIPHERALS */ diff --git a/os/ex/dox/gyro.dox b/os/ex/dox/ex_gyro.dox similarity index 80% rename from os/ex/dox/gyro.dox rename to os/ex/dox/ex_gyro.dox index 66f3c6fa8..38271835c 100644 --- a/os/ex/dox/gyro.dox +++ b/os/ex/dox/ex_gyro.dox @@ -15,8 +15,8 @@ */ /** - * @defgroup HAL_GYROSCOPE Generic Gyroscope Interface - * @brief HAL Generic Gyroscope Interface. + * @defgroup EX_GYROSCOPE Generic Gyroscope Interface + * @brief EX Generic Gyroscope Interface. * - * @ingroup HAL_ABSTRACT_PERIPHERALS + * @ingroup EX_ABSTRACT_PERIPHERALS */ diff --git a/os/ex/dox/ex_hygrometer.dox b/os/ex/dox/ex_hygrometer.dox new file mode 100644 index 000000000..9387112ae --- /dev/null +++ b/os/ex/dox/ex_hygrometer.dox @@ -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 + */ diff --git a/os/ex/dox/compass.dox b/os/ex/dox/ex_sensor.dox similarity index 80% rename from os/ex/dox/compass.dox rename to os/ex/dox/ex_sensor.dox index 4f16af784..8b09b6a22 100644 --- a/os/ex/dox/compass.dox +++ b/os/ex/dox/ex_sensor.dox @@ -15,8 +15,8 @@ */ /** - * @defgroup HAL_COMPASS Generic Compass Interface - * @brief HAL Generic Compass Interface. + * @defgroup EX_SENSORS Generic Sensor Interface + * @brief EX Generic Sensor Interface. * - * @ingroup HAL_ABSTRACT_PERIPHERALS + * @ingroup EX_ABSTRACT_PERIPHERALS */ diff --git a/os/ex/dox/hygrometer.dox b/os/ex/dox/ex_thermometer.dox similarity index 79% rename from os/ex/dox/hygrometer.dox rename to os/ex/dox/ex_thermometer.dox index b8eeb66de..77f4bda78 100644 --- a/os/ex/dox/hygrometer.dox +++ b/os/ex/dox/ex_thermometer.dox @@ -15,8 +15,8 @@ */ /** - * @defgroup HAL_HYGROMETER Generic Hygrometer Interface - * @brief HAL Generic Hygrometer Interface. + * @defgroup EX_THERMOMETER Generic Thermometer Interface + * @brief EX Generic Thermometer Interface. * - * @ingroup HAL_ABSTRACT_PERIPHERALS + * @ingroup EX_ABSTRACT_PERIPHERALS */ diff --git a/os/ex/dox/hal.dox b/os/ex/dox/hal.dox deleted file mode 100644 index 92055c554..000000000 --- a/os/ex/dox/hal.dox +++ /dev/null @@ -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 - */ diff --git a/os/ex/dox/main.dox b/os/ex/dox/main.dox index 127266c6b..1b4deccce 100644 --- a/os/ex/dox/main.dox +++ b/os/ex/dox/main.dox @@ -19,16 +19,15 @@ * @brief EXternal peripherals. * @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 + * 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 - * implementation of one or more Abstract Interfaces brought by HAL subsystem. - * EX also relies on HAL normal drivers to interface the peripherals. + * implementation of one or more Abstract Interfaces brought by EX subsystem. + * EX also relies on EX 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: * - Bosch Devices - * - Micron Technology Devices * - STMicroelectronics Devices * . * @@ -38,12 +37,6 @@ * - @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 * This section contains all the drivers of devices produced by * STMicroelectronics. Devices currently supported are MEMS and are: @@ -57,17 +50,36 @@ * - @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 * @brief Bosch Devices. * - * @ingroup EX + * @ingroup EX_DEVICES */ /** * @defgroup EX_ST STMicroelectronics Devices * @brief STMicroelectronics Devices. * - * @ingroup EX + * @ingroup EX_DEVICES */ diff --git a/os/ex/dox/thermometer.dox b/os/ex/dox/thermometer.dox deleted file mode 100644 index 70cf0bb7b..000000000 --- a/os/ex/dox/thermometer.dox +++ /dev/null @@ -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 - */