hal.dox 1.4 KB

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