rt.dox 2.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152
  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. * @defgroup kernel RT Kernel
  17. * @details The kernel is the portable part of ChibiOS/RT, this section
  18. * documents the various kernel subsystems.
  19. */
  20. /**
  21. * @defgroup kernel_info Version Numbers and Identification
  22. * @ingroup kernel
  23. */
  24. /**
  25. * @defgroup config_category Configuration
  26. * @ingroup kernel
  27. */
  28. /**
  29. * @defgroup config Options
  30. * @ingroup config_category
  31. */
  32. /**
  33. * @defgroup conf_checks Checks
  34. * @ingroup config_category
  35. */
  36. /**
  37. * @defgroup rt_restrictions Restrictions
  38. * @ingroup config_category
  39. */
  40. /**
  41. * @defgroup base Base Kernel Services
  42. * @details Base kernel services, the base subsystems are always included in
  43. * the OS builds.
  44. * @ingroup kernel
  45. */
  46. /**
  47. * @defgroup mem Memory Alignment
  48. * @ingroup base
  49. */
  50. /**
  51. * @defgroup system System Management
  52. * @ingroup base
  53. */
  54. /**
  55. * @defgroup scheduler Scheduler
  56. * @ingroup base
  57. */
  58. /**
  59. * @defgroup time_intervals Time and Intervals
  60. * @ingroup base
  61. */
  62. /**
  63. * @defgroup time Virtual Timers
  64. * @ingroup base
  65. */
  66. /**
  67. * @defgroup threads Threads
  68. * @ingroup base
  69. */
  70. /**
  71. * @defgroup time_measurement Time Measurement
  72. * @ingroup base
  73. */
  74. /**
  75. * @defgroup synchronization Synchronization
  76. * @details Synchronization services.
  77. * @ingroup kernel
  78. */
  79. /**
  80. * @defgroup semaphores Counting Semaphores
  81. * @ingroup synchronization
  82. */
  83. /**
  84. * @defgroup mutexes Mutexes
  85. * @ingroup synchronization
  86. */
  87. /**
  88. * @defgroup condvars Condition Variables
  89. * @ingroup synchronization
  90. */
  91. /**
  92. * @defgroup events Event Flags
  93. * @ingroup synchronization
  94. */
  95. /**
  96. * @defgroup messages Synchronous Messages
  97. * @ingroup synchronization
  98. */
  99. /**
  100. * @defgroup dynamic_threads Dynamic Threads
  101. * @ingroup kernel
  102. */
  103. /**
  104. * @defgroup registry Registry
  105. * @ingroup kernel
  106. */
  107. /**
  108. * @defgroup debug Debug
  109. * @ingroup kernel
  110. */
  111. /**
  112. * @defgroup checks_assertions Checks and Assertions
  113. * @ingroup debug
  114. */
  115. /**
  116. * @defgroup trace Tracing
  117. * @ingroup debug
  118. */
  119. /**
  120. * @defgroup statistics Statistics
  121. * @ingroup debug
  122. */