freertos.rst 952 B

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051
  1. FreeRTOS
  2. ========
  3. Overview
  4. --------
  5. This section contains documentation of FreeRTOS types, functions, and macros. It is automatically generated from FreeRTOS header files.
  6. .. note::
  7. ESP-IDF FreeRTOS is based on the Xtensa port of FreeRTOS v10.2.0,
  8. For more information about FreeRTOS features specific to ESP-IDF, see :doc:`ESP-IDF FreeRTOS SMP Changes<../../api-guides/freertos-smp>`
  9. and :doc:`ESP-IDF FreeRTOS Additions<freertos_additions>`.
  10. Task API
  11. --------
  12. .. include-build-file:: inc/task.inc
  13. Queue API
  14. ---------
  15. .. include-build-file:: inc/queue.inc
  16. Semaphore API
  17. -------------
  18. .. include-build-file:: inc/semphr.inc
  19. Timer API
  20. ---------
  21. .. include-build-file:: inc/timers.inc
  22. Event Group API
  23. ---------------
  24. .. include-build-file:: inc/event_groups.inc
  25. Stream Buffer API
  26. -----------------
  27. .. include-build-file:: inc/stream_buffer.inc
  28. Message Buffer API
  29. ------------------
  30. .. include-build-file:: inc/message_buffer.inc