main.dox 1.5 KB

1234567891011121314151617181920212223242526272829303132333435363738
  1. /*
  2. ChibiOS - Copyright (C) 2006..2018 Giovanni Di Sirio.
  3. This file is part of ChibiOS.
  4. ChibiOS is free software; you can redistribute it and/or modify
  5. it under the terms of the GNU General Public License as published by
  6. the Free Software Foundation; either version 3 of the License, or
  7. (at your option) any later version.
  8. ChibiOS is distributed in the hope that it will be useful,
  9. but WITHOUT ANY WARRANTY; without even the implied warranty of
  10. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  11. GNU General Public License for more details.
  12. You should have received a copy of the GNU General Public License
  13. along with this program. If not, see <http://www.gnu.org/licenses/>.
  14. */
  15. /**
  16. * @mainpage Introduction
  17. * @author Giovanni Di Sirio (gdisirio@users.sourceforge.net).
  18. *
  19. * <h2>Features</h2>
  20. * - Hardware Abstraction Layer (HAL) supporting numerous high level device
  21. * drivers abstracting common features in modern MCUs.
  22. * - Driver models for: ADC, CAN, DAC, EXT, GPT, I2C, I2S, ICU, MAC, MMC, PAL,
  23. * PWM, RTC, SDC, Serial, UART, USB, USB-CDC, SPI, ST, WDG.
  24. * - Abstraction of streams.
  25. * - Abstraction of block devices.
  26. * - The drivers can be ported to virtually any MCU architecture thanks to
  27. * an high level API.
  28. * - The HAL can be used with or without an RTOS.
  29. * - The HAL can be adapted to any reasonable RTOS thanks to an Operating
  30. * System Abstraction Layer (OSAL). ChibiOS/RT and ChibiOS/NIL are supported
  31. * out of the box.
  32. * .
  33. */