diff options
| author | roccomarco <roccomarco@35acf78f-673a-0410-8e92-d51de3d6d3f4> | 2017-07-02 10:24:43 +0000 |
|---|---|---|
| committer | roccomarco <roccomarco@35acf78f-673a-0410-8e92-d51de3d6d3f4> | 2017-07-02 10:24:43 +0000 |
| commit | 82580b3660c4ee1379ba6dba3e7f05bae2b4efa6 (patch) | |
| tree | 4a93e33e9e42cb093f4533afa733e23d1b9afaad /os | |
| parent | 28202cd23b4e462dda1fbf316d282c0835b52bf0 (diff) | |
| download | ChibiOS-82580b3660c4ee1379ba6dba3e7f05bae2b4efa6.tar.gz ChibiOS-82580b3660c4ee1379ba6dba3e7f05bae2b4efa6.tar.bz2 ChibiOS-82580b3660c4ee1379ba6dba3e7f05bae2b4efa6.zip | |
Added HAL Abstract Peripheral Interfaces documentation
git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@10289 35acf78f-673a-0410-8e92-d51de3d6d3f4
Diffstat (limited to 'os')
| -rw-r--r-- | os/hal/dox/accelerometer.dox | 22 | ||||
| -rw-r--r-- | os/hal/dox/barometer.dox | 22 | ||||
| -rw-r--r-- | os/hal/dox/compass.dox | 22 | ||||
| -rw-r--r-- | os/hal/dox/flash.dox | 22 | ||||
| -rw-r--r-- | os/hal/dox/gyro.dox | 22 | ||||
| -rw-r--r-- | os/hal/dox/hal_peripherals.dox | 22 | ||||
| -rw-r--r-- | os/hal/dox/hygrometer.dox | 22 | ||||
| -rw-r--r-- | os/hal/dox/jesd216flash.dox | 22 | ||||
| -rw-r--r-- | os/hal/dox/main.dox | 2 | ||||
| -rw-r--r-- | os/hal/dox/sensor.dox | 22 | ||||
| -rw-r--r-- | os/hal/dox/thermometer.dox | 22 |
11 files changed, 221 insertions, 1 deletions
diff --git a/os/hal/dox/accelerometer.dox b/os/hal/dox/accelerometer.dox new file mode 100644 index 000000000..77d98953b --- /dev/null +++ b/os/hal/dox/accelerometer.dox @@ -0,0 +1,22 @@ +/*
+ 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_ACCELEROMETER Generic Accelerometer Interface
+ * @brief HAL Generic Accelerometer Interface.
+ *
+ * @ingroup HAL_ABSTRACT_PERIPHERALS
+ */
diff --git a/os/hal/dox/barometer.dox b/os/hal/dox/barometer.dox new file mode 100644 index 000000000..173d1241a --- /dev/null +++ b/os/hal/dox/barometer.dox @@ -0,0 +1,22 @@ +/*
+ 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_BAROMETER Generic Barometer Interface
+ * @brief HAL Generic Barometer Interface.
+ *
+ * @ingroup HAL_ABSTRACT_PERIPHERALS
+ */
diff --git a/os/hal/dox/compass.dox b/os/hal/dox/compass.dox new file mode 100644 index 000000000..ed8b566e1 --- /dev/null +++ b/os/hal/dox/compass.dox @@ -0,0 +1,22 @@ +/*
+ 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_COMPASS Generic Compass Interface
+ * @brief HAL Generic Compass Interface.
+ *
+ * @ingroup HAL_ABSTRACT_PERIPHERALS
+ */
diff --git a/os/hal/dox/flash.dox b/os/hal/dox/flash.dox new file mode 100644 index 000000000..d9364587b --- /dev/null +++ b/os/hal/dox/flash.dox @@ -0,0 +1,22 @@ +/*
+ 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_FLASH Generic Flash Driver Interface
+ * @brief HAL Generic Flash Driver Interface.
+ *
+ * @ingroup HAL_ABSTRACT_PERIPHERALS
+ */
diff --git a/os/hal/dox/gyro.dox b/os/hal/dox/gyro.dox new file mode 100644 index 000000000..04c521709 --- /dev/null +++ b/os/hal/dox/gyro.dox @@ -0,0 +1,22 @@ +/*
+ 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_GYROSCOPE Generic Gyroscope Interface
+ * @brief HAL Generic Gyroscope Interface.
+ *
+ * @ingroup HAL_ABSTRACT_PERIPHERALS
+ */
diff --git a/os/hal/dox/hal_peripherals.dox b/os/hal/dox/hal_peripherals.dox new file mode 100644 index 000000000..732372689 --- /dev/null +++ b/os/hal/dox/hal_peripherals.dox @@ -0,0 +1,22 @@ +/*
+ 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_ABSTRACT_PERIPHERALS Abstract Peripheral Interfaces
+ * @brief HAL Abstract Peripheral Interfaces.
+ *
+ * @ingroup HAL_INTERFACES
+ */
diff --git a/os/hal/dox/hygrometer.dox b/os/hal/dox/hygrometer.dox new file mode 100644 index 000000000..f60031900 --- /dev/null +++ b/os/hal/dox/hygrometer.dox @@ -0,0 +1,22 @@ +/*
+ 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_HYGROMETER Generic Hygrometer Interface
+ * @brief HAL Generic Hygrometer Interface.
+ *
+ * @ingroup HAL_ABSTRACT_PERIPHERALS
+ */
diff --git a/os/hal/dox/jesd216flash.dox b/os/hal/dox/jesd216flash.dox new file mode 100644 index 000000000..e979d6f0c --- /dev/null +++ b/os/hal/dox/jesd216flash.dox @@ -0,0 +1,22 @@ +/*
+ 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_JESD216_FLASH JESD216 Compliant Flash Driver Interface
+ * @brief HAL JESD216 Compliant Flash Driver Interface.
+ *
+ * @ingroup HAL_ABSTRACT_PERIPHERALS
+ */
diff --git a/os/hal/dox/main.dox b/os/hal/dox/main.dox index f9cb5f6ac..87951b47d 100644 --- a/os/hal/dox/main.dox +++ b/os/hal/dox/main.dox @@ -119,7 +119,7 @@ *
* @ingroup IO
*/
-
+
/**
* @defgroup HAL_INNER_CODE Inner Code
* @brief HAL Inner Code.
diff --git a/os/hal/dox/sensor.dox b/os/hal/dox/sensor.dox new file mode 100644 index 000000000..ae15ab7f8 --- /dev/null +++ b/os/hal/dox/sensor.dox @@ -0,0 +1,22 @@ +/*
+ 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_SENSORS Generic Sensor Interface
+ * @brief HAL Generic Sensor Interface.
+ *
+ * @ingroup HAL_ABSTRACT_PERIPHERALS
+ */
diff --git a/os/hal/dox/thermometer.dox b/os/hal/dox/thermometer.dox new file mode 100644 index 000000000..d02063600 --- /dev/null +++ b/os/hal/dox/thermometer.dox @@ -0,0 +1,22 @@ +/*
+ 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_THERMOMETER Generic Thermometer Interface
+ * @brief HAL Generic Thermometer Interface.
+ *
+ * @ingroup HAL_ABSTRACT_PERIPHERALS
+ */
|