aboutsummaryrefslogtreecommitdiff
path: root/lib/chibios/os/hal/dox/hal.dox
diff options
context:
space:
mode:
Diffstat (limited to 'lib/chibios/os/hal/dox/hal.dox')
-rw-r--r--lib/chibios/os/hal/dox/hal.dox32
1 files changed, 32 insertions, 0 deletions
diff --git a/lib/chibios/os/hal/dox/hal.dox b/lib/chibios/os/hal/dox/hal.dox
new file mode 100644
index 000000000..1471c8e89
--- /dev/null
+++ b/lib/chibios/os/hal/dox/hal.dox
@@ -0,0 +1,32 @@
1/*
2 ChibiOS - Copyright (C) 2006..2018 Giovanni Di Sirio
3
4 Licensed under the Apache License, Version 2.0 (the "License");
5 you may not use this file except in compliance with the License.
6 You may obtain a copy of the License at
7
8 http://www.apache.org/licenses/LICENSE-2.0
9
10 Unless required by applicable law or agreed to in writing, software
11 distributed under the License is distributed on an "AS IS" BASIS,
12 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 See the License for the specific language governing permissions and
14 limitations under the License.
15*/
16
17/**
18 * @defgroup HAL HAL Driver
19 * @brief Hardware Abstraction Layer.
20 * @details The HAL (Hardware Abstraction Layer) driver performs the system
21 * initialization and includes the platform support code shared by
22 * the other drivers. This driver does contain any API function
23 * except for a general initialization function @p halInit() that
24 * must be invoked before any HAL service can be used, usually the
25 * HAL initialization should be performed immediately before the
26 * kernel initialization.<br>
27 * Some HAL driver implementations also offer a custom early clock
28 * setup function that can be invoked before the C runtime
29 * initialization in order to accelerate the startup time.
30 *
31 * @ingroup HAL_NORMAL_DRIVERS
32 */