main.dox 2.7 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273
  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 EX EX
  15. * @brief EXternal peripherals.
  16. * @details Under ChibiOS the set of the complex device driver interfaces
  17. * dedicated to external peripherals is called the EX subsystem. The EX resides
  18. * on top of HAL and is actually a set of libraries for external devices like
  19. * MEMS, Displays, Flash memories and so on. These libraries are the
  20. * implementation of one or more Abstract Interfaces brought by HAL subsystem.
  21. * EX also relies on HAL normal drivers to interface the peripherals.
  22. *
  23. * @section ex_complex_drivers_architecture EX Complex Drivers Architecture
  24. * Each EX driver can be considered as a standalone Complex Device Driver. For
  25. * ease of use these drivers are grouped by vendor:
  26. * - Bosch Devices
  27. * - Micron Technology Devices
  28. * - STMicroelectronics Devices
  29. * .
  30. *
  31. * @section bosch_devices Bosch Devices
  32. * This section contains all the drivers of devices produced by Bosch.
  33. * Devices currently supported are MEMS and are:
  34. * - @b BMP085: Digital pressure sensor;
  35. * .
  36. *
  37. * @section micron_devices Micron Technology Devices
  38. * This section contains all the drivers of devices produced by
  39. * Micron Technology. Devices currently supported are FLASH and are:
  40. * - @b M25Q: Serial NOR flash;
  41. * .
  42. *
  43. * @section stmicroelectronics_devices STMicroelectronics Devices
  44. * This section contains all the drivers of devices produced by
  45. * STMicroelectronics. Devices currently supported are MEMS and are:
  46. * - @b HTS221: Capacitive digital humidity sensor;
  47. * - @b L3GD20: 3-axis digital gyroscope;
  48. * - @b LIS3DSH: 3-axis digital motion sensor;
  49. * - @b LIS3MDL: Ultra low power, high performances 3-axis magnetometer;
  50. * - @b LIS302DL: 3-axis motion sensor;
  51. * - @b LPS25H: Piezoresistive 260-1260 hPa pressure sensor;
  52. * - @b LSM6DS0: 6-axis iNEMO inertial module;
  53. * - @b LSM303DLHC: Ultra compact high performance e-compass;
  54. * .
  55. */
  56. /**
  57. * @defgroup EX_BOSCH Bosch Devices
  58. * @brief Bosch Devices.
  59. *
  60. * @ingroup EX
  61. */
  62. /**
  63. * @defgroup EX_ST STMicroelectronics Devices
  64. * @brief STMicroelectronics Devices.
  65. *
  66. * @ingroup EX
  67. */