aboutsummaryrefslogtreecommitdiffstats
path: root/os/hal/dox/hal.dox
diff options
context:
space:
mode:
Diffstat (limited to 'os/hal/dox/hal.dox')
-rw-r--r--os/hal/dox/hal.dox34
1 files changed, 34 insertions, 0 deletions
diff --git a/os/hal/dox/hal.dox b/os/hal/dox/hal.dox
new file mode 100644
index 000000000..02d09c0d8
--- /dev/null
+++ b/os/hal/dox/hal.dox
@@ -0,0 +1,34 @@
+/*
+ ChibiOS/RT - Copyright (C) 2006,2007,2008,2009,2010 Giovanni Di Sirio.
+
+ This file is part of ChibiOS/RT.
+
+ ChibiOS/RT is free software; you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation; either version 3 of the License, or
+ (at your option) any later version.
+
+ ChibiOS/RT is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with this program. If not, see <http://www.gnu.org/licenses/>.
+*/
+
+/**
+ * @defgroup HAL HAL Driver
+ * @brief Hardware Abstraction Layer.
+ * @details The HAL driver performs the system initialization and includes
+ * the platform support code shared by the other drivers. This driver does
+ * contain any API function except for a general initialization function
+ * @p halInit() that must be invoked before any HAL service can be used,
+ * usually the HAL initialization should be performed immediately before the
+ * kernel initialization.<br>
+ * Some HAL driver implementations also offer a custom early clock
+ * setum function that can be invoked before the C runtime initialization
+ * in order to accellerate the startup time.
+ *
+ * @ingroup IO
+ */