aboutsummaryrefslogtreecommitdiffstats
path: root/os/hal/dox
diff options
context:
space:
mode:
Diffstat (limited to 'os/hal/dox')
-rw-r--r--os/hal/dox/crypto.dox25
-rw-r--r--os/hal/dox/hal_objects.dox20
-rw-r--r--os/hal/dox/main.dox4
-rw-r--r--os/hal/dox/mfs.dox30
4 files changed, 77 insertions, 2 deletions
diff --git a/os/hal/dox/crypto.dox b/os/hal/dox/crypto.dox
new file mode 100644
index 000000000..9f2ad850c
--- /dev/null
+++ b/os/hal/dox/crypto.dox
@@ -0,0 +1,25 @@
+/*
+ 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 CRYPTO Crypto Driver
+ * @brief Generic Crypto Driver.
+ * @details This module implements a generic Cryptography driver.
+ * @pre In order to use the I2C driver the @p HAL_USE_CRY option
+ * must be enabled in @p halconf.h.
+ *
+ * @ingroup HAL_NORMAL_DRIVERS
+ */
diff --git a/os/hal/dox/hal_objects.dox b/os/hal/dox/hal_objects.dox
new file mode 100644
index 000000000..98450801c
--- /dev/null
+++ b/os/hal/dox/hal_objects.dox
@@ -0,0 +1,20 @@
+/*
+ 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_BASE_OBJECT Base Object
+ * @ingroup HAL_INTERFACES
+ */
diff --git a/os/hal/dox/main.dox b/os/hal/dox/main.dox
index 4a34791ba..991fb78e4 100644
--- a/os/hal/dox/main.dox
+++ b/os/hal/dox/main.dox
@@ -114,8 +114,8 @@
*/
/**
- * @defgroup HAL_INTERFACES Interfaces
- * @brief HAL Interfaces.
+ * @defgroup HAL_INTERFACES Interfaces and Classes
+ * @brief HAL Interfaces and Classes.
*
* @ingroup IO
*/
diff --git a/os/hal/dox/mfs.dox b/os/hal/dox/mfs.dox
new file mode 100644
index 000000000..359cb2f9e
--- /dev/null
+++ b/os/hal/dox/mfs.dox
@@ -0,0 +1,30 @@
+/*
+ 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 MFS Managed Flash Storage Driver
+ * @brief Managed Flash Storage Driver.
+ * @details This module implements a managed flash storage able to store
+ * a finite number of variable-size records. Records are retrieved
+ * by their index number.<br>
+ * The driver is automatically performs:
+ * - Wear leveling.
+ * - Auto repair after power loss.
+ * - Garbage collection in order to remove erased data.
+ * .
+ *
+ * @ingroup HAL_COMPLEX_DRIVERS
+ */