diff options
| author | Clyne Sullivan <clyne@bitgloo.com> | 2021-01-22 21:43:36 -0500 |
|---|---|---|
| committer | Clyne Sullivan <clyne@bitgloo.com> | 2021-01-22 21:43:36 -0500 |
| commit | 48026bb824fd2d9cfb00ecd040db6ef3a416bae9 (patch) | |
| tree | c14713aedfe78ee8b34f2e1252408782e2e2ff5d /ChibiOS_20.3.2/os/ex/dox | |
| parent | e080a26651f90c88176140d63a74c93c2f4041a2 (diff) | |
upload initial port
Diffstat (limited to 'ChibiOS_20.3.2/os/ex/dox')
| -rw-r--r-- | ChibiOS_20.3.2/os/ex/dox/ex_accelerometer.dox | 22 | ||||
| -rw-r--r-- | ChibiOS_20.3.2/os/ex/dox/ex_barometer.dox | 22 | ||||
| -rw-r--r-- | ChibiOS_20.3.2/os/ex/dox/ex_compass.dox | 22 | ||||
| -rw-r--r-- | ChibiOS_20.3.2/os/ex/dox/ex_displays.dox | 22 | ||||
| -rw-r--r-- | ChibiOS_20.3.2/os/ex/dox/ex_gyro.dox | 22 | ||||
| -rw-r--r-- | ChibiOS_20.3.2/os/ex/dox/ex_hygrometer.dox | 22 | ||||
| -rw-r--r-- | ChibiOS_20.3.2/os/ex/dox/ex_rangefinder.dox | 22 | ||||
| -rw-r--r-- | ChibiOS_20.3.2/os/ex/dox/ex_sensor.dox | 22 | ||||
| -rw-r--r-- | ChibiOS_20.3.2/os/ex/dox/ex_thermometer.dox | 22 | ||||
| -rw-r--r-- | ChibiOS_20.3.2/os/ex/dox/main.dox | 92 |
10 files changed, 290 insertions, 0 deletions
diff --git a/ChibiOS_20.3.2/os/ex/dox/ex_accelerometer.dox b/ChibiOS_20.3.2/os/ex/dox/ex_accelerometer.dox new file mode 100644 index 0000000..8ac9c79 --- /dev/null +++ b/ChibiOS_20.3.2/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/ChibiOS_20.3.2/os/ex/dox/ex_barometer.dox b/ChibiOS_20.3.2/os/ex/dox/ex_barometer.dox new file mode 100644 index 0000000..ed9a2ab --- /dev/null +++ b/ChibiOS_20.3.2/os/ex/dox/ex_barometer.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_BAROMETER Generic Barometer Interface
+ * @brief EX Generic Barometer Interface.
+ *
+ * @ingroup EX_ABSTRACT_PERIPHERALS
+ */
diff --git a/ChibiOS_20.3.2/os/ex/dox/ex_compass.dox b/ChibiOS_20.3.2/os/ex/dox/ex_compass.dox new file mode 100644 index 0000000..967008c --- /dev/null +++ b/ChibiOS_20.3.2/os/ex/dox/ex_compass.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_COMPASS Generic Compass Interface
+ * @brief EX Generic Compass Interface.
+ *
+ * @ingroup EX_ABSTRACT_PERIPHERALS
+ */
diff --git a/ChibiOS_20.3.2/os/ex/dox/ex_displays.dox b/ChibiOS_20.3.2/os/ex/dox/ex_displays.dox new file mode 100644 index 0000000..fdd77ee --- /dev/null +++ b/ChibiOS_20.3.2/os/ex/dox/ex_displays.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_RANGEFINDER Generic Range Finder Interface
+ * @brief EX Generic Range Finder Interface.
+ *
+ * @ingroup EX_ABSTRACT_PERIPHERALS
+ */
diff --git a/ChibiOS_20.3.2/os/ex/dox/ex_gyro.dox b/ChibiOS_20.3.2/os/ex/dox/ex_gyro.dox new file mode 100644 index 0000000..3827183 --- /dev/null +++ b/ChibiOS_20.3.2/os/ex/dox/ex_gyro.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_GYROSCOPE Generic Gyroscope Interface
+ * @brief EX Generic Gyroscope Interface.
+ *
+ * @ingroup EX_ABSTRACT_PERIPHERALS
+ */
diff --git a/ChibiOS_20.3.2/os/ex/dox/ex_hygrometer.dox b/ChibiOS_20.3.2/os/ex/dox/ex_hygrometer.dox new file mode 100644 index 0000000..9387112 --- /dev/null +++ b/ChibiOS_20.3.2/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/ChibiOS_20.3.2/os/ex/dox/ex_rangefinder.dox b/ChibiOS_20.3.2/os/ex/dox/ex_rangefinder.dox new file mode 100644 index 0000000..06786f3 --- /dev/null +++ b/ChibiOS_20.3.2/os/ex/dox/ex_rangefinder.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_DISPLAYS Generic Display Interface
+ * @brief EX Generic Display Interface.
+ *
+ * @ingroup EX_ABSTRACT_PERIPHERALS
+ */
diff --git a/ChibiOS_20.3.2/os/ex/dox/ex_sensor.dox b/ChibiOS_20.3.2/os/ex/dox/ex_sensor.dox new file mode 100644 index 0000000..8b09b6a --- /dev/null +++ b/ChibiOS_20.3.2/os/ex/dox/ex_sensor.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_SENSORS Generic Sensor Interface
+ * @brief EX Generic Sensor Interface.
+ *
+ * @ingroup EX_ABSTRACT_PERIPHERALS
+ */
diff --git a/ChibiOS_20.3.2/os/ex/dox/ex_thermometer.dox b/ChibiOS_20.3.2/os/ex/dox/ex_thermometer.dox new file mode 100644 index 0000000..77f4bda --- /dev/null +++ b/ChibiOS_20.3.2/os/ex/dox/ex_thermometer.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_THERMOMETER Generic Thermometer Interface
+ * @brief EX Generic Thermometer Interface.
+ *
+ * @ingroup EX_ABSTRACT_PERIPHERALS
+ */
diff --git a/ChibiOS_20.3.2/os/ex/dox/main.dox b/ChibiOS_20.3.2/os/ex/dox/main.dox new file mode 100644 index 0000000..a02193d --- /dev/null +++ b/ChibiOS_20.3.2/os/ex/dox/main.dox @@ -0,0 +1,92 @@ +/*
+ 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 EX
+ * @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 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 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
+ * - STMicroelectronics Devices
+ * .
+ *
+ * @section bosch_devices Bosch Devices
+ * This section contains all the drivers of devices produced by Bosch.
+ * Devices currently supported are MEMS and are:
+ * - @b BMP085: Digital pressure sensor;
+ * .
+ *
+ * @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;
+ * .
+ */
+ *
+ * @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_INFO Info
+ * @brief EX information.
+ *
+ * @ingroup EX
+ */
+
+/**
+ * @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_DEVICES
+ */
+
+/**
+ * @defgroup EX_ST STMicroelectronics Devices
+ * @brief STMicroelectronics Devices.
+ *
+ * @ingroup EX_DEVICES
+ */
|