sdk.dox 3.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224
  1. /*!
  2. @mainpage
  3. The Platform SDK is a comprehensive set of reference drivers for the modules and
  4. peripherals present on the i.MX6 Series SoCs.
  5. */
  6. // Define doxygen modules.
  7. /*!
  8. @defgroup diag_util Utilities
  9. @brief SDK utilities
  10. @defgroup diag_timer Timer Services
  11. @brief System timer services
  12. @ingroup timers
  13. @defgroup diag_epit EPIT
  14. @brief EPIT timer driver
  15. @ingroup timers
  16. @defgroup diag_gpt GPT
  17. @brief GPT timer driver
  18. @ingroup timers
  19. @defgroup diag_keypad Keypad Port
  20. @brief Keypad driver
  21. @defgroup diag_init Base SDK
  22. @brief Definitions common to SDK
  23. @defgroup diag_ipu IPU
  24. @brief IPU driver
  25. @ingroup graphics
  26. @defgroup diag_hdmi HDMI
  27. @brief HDMI transmitter driver
  28. @ingroup graphics
  29. @defgroup diag_uart UART
  30. @brief UART driver
  31. @ingroup serial
  32. @defgroup diag_ioexpander IO Expander
  33. @brief IO expander chip driver
  34. @defgroup diag_nand NAND
  35. @brief GPMI NAND driver
  36. @ingroup storage
  37. @defgroup bch BCH40 ECC
  38. @brief BCH ECC driver
  39. @ingroup diag_nand
  40. @defgroup diag_usb USB
  41. @brief USB driver
  42. @defgroup diag_audio Audio
  43. @brief Audio driver
  44. @defgroup VPU VPU
  45. @brief VPU driver
  46. @ingroup graphics
  47. @defgroup diag_camera Camera Interface
  48. @brief Camera driver
  49. @ingroup graphics
  50. @defgroup diag_mipi MIPI DSI/CSI
  51. @brief MIPI display and camera driver
  52. @ingroup graphics
  53. @defgroup diag_ocotp OTP
  54. @brief One-time programmable memory driver
  55. @defgroup diag_i2c I2C
  56. @brief I2C driver
  57. @ingroup serial
  58. @defgroup diag_ldb LDB
  59. @brief LVDS Display Bridge driver
  60. @ingroup graphics
  61. @defgroup diag_enet Ethernet
  62. @brief Internal Ethernet MAC driver
  63. @defgroup diag_gpio GPIO
  64. @brief GPIO driver
  65. @defgroup tempmon Temperature Monitor
  66. @brief Internal temperature monitor driver
  67. @defgroup diag_pmu PMU
  68. @brief Internal power manager driver
  69. @defgroup gic GIC
  70. @brief Generic Interrupt Controller driver
  71. @defgroup sdk_common SDK Common Definitions
  72. @brief Definitions used throughout the SDK.
  73. @defgroup diag_eim EIM
  74. @brief External Interface Module driver
  75. @defgroup diag_pwm PWM
  76. @brief Pulse Width Modulator driver
  77. @defgroup diag_rtc RTC
  78. @brief Real Time Clock driver
  79. @ingroup timers
  80. @defgroup diag_srtc SRTC
  81. @brief Secure Real Time Clock driver
  82. @ingroup timers
  83. @defgroup diag_snvs SNVS
  84. @brief Secure Non-volatile Storage driver
  85. @defgroup diag_spi SPI
  86. @brief SPI driver
  87. @ingroup serial
  88. @defgroup diag_usdhc USDHC
  89. @brief uSDHC SD/MMC driver
  90. @ingroup storage
  91. @defgroup diag_vdoa VDOA
  92. @brief Video Data Order Adapter driver
  93. @ingroup graphics
  94. @defgroup diag_pcie PCIe
  95. @brief PCIe driver
  96. @defgroup atomics Atomic Operations
  97. @brief Atomic operation routines
  98. @ingroup lowlevel
  99. @defgroup menu Menu
  100. @brief Menu Framework API
  101. @defgroup spinlock Spinlock
  102. @brief Simple spinlock API
  103. @defgroup diag_clocks Clocks
  104. @brief Clock management driver
  105. @ingroup lowlevel
  106. @defgroup cortexa9 Cortex-A9
  107. @brief CPU related functions
  108. @ingroup lowlevel
  109. @defgroup diag_interrupt Interrupts
  110. @brief Interrupt manager
  111. @ingroup lowlevel
  112. @defgroup diag_mmu MMU
  113. @brief MMU related routines
  114. @ingroup lowlevel
  115. @defgroup cpu_utility CPU Utility
  116. @brief Miscellaneous CPU utility routines
  117. @ingroup lowlevel
  118. @defgroup diag_adv7180 ADV7180
  119. @brief ADV7180 video decoder driver
  120. @ingroup graphics
  121. @defgroup lowlevel Low-level Services
  122. @brief
  123. @defgroup timers Timers
  124. @brief Timer drivers and services
  125. @defgroup graphics Display and Graphics Drivers
  126. @brief
  127. @defgroup serial Serial Protocols
  128. @brief
  129. @defgroup storage Storage Media Drivers
  130. @brief
  131. @defgroup os_fat FAT32
  132. @brief FAT32 filesystem
  133. @defgroup os_fat_io FAT32 I/O Layer
  134. @brief Low-level I/O layer for FAT32 filesystem.
  135. @defgroup os_fat_errors Filesystem Errors
  136. @brief Errors for FAT32 filesystem.
  137. @defgroup diag_accel Accelerometer
  138. @brief Accelerometer drivers
  139. @defgroup diag_epdc EPDC
  140. @brief E-ink EPD display controller driver
  141. @ingroup graphics
  142. @defgroup diag_lcdif LCDIF
  143. @brief LCDIF driver
  144. @ingroup graphics
  145. @defgroup diag_spdc SPDC
  146. @brief Sipix EPD display controller driver
  147. @ingroup graphics
  148. @defgroup diag_vpu VPU
  149. @brief VPU driver
  150. @ingroup graphics
  151. */