tinySA/os/hal/dox/hal.dox

33 lines
1.4 KiB
Plaintext

/*
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 HAL Driver
* @brief Hardware Abstraction Layer.
* @details The HAL (Hardware Abstraction Layer) 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
* setup function that can be invoked before the C runtime
* initialization in order to accelerate the startup time.
*
* @ingroup HAL_NORMAL_DRIVERS
*/