alex/esp-idf
alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2024-10-05 20:47:46 -04:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity
c2e134b775
esp-idf/components/freertos/FreeRTOS-Kernel-SMP
History
Darian Leung c2e134b775 change(xtensa): Deprecate ".../xtensa_api.h" include path 
This commit deprecates the "freertos/xtensa_api.h" and "xtensa/xtensa_api.h"
include paths. Users should use "xtensa_api.h" instead.

- Replace legacy include paths
- Removed some unnecessary includes of "xtensa_api.h"
- Replaced some calls with "esp_cpu_..." equivalents
- Add warning to compatibility header
2023-12-05 18:04:52 +08:00
..
include/freertos refactor(freertos/smp): Move vTaskStartSchedulerOtherCores() to API additions to headers 2023-09-05 16:19:42 +08:00
portable change(xtensa): Deprecate ".../xtensa_api.h" include path 2023-12-05 18:04:52 +08:00
croutine.c freertos: Add FreeRTOS SMP upstream files 2022-03-08 14:58:57 +08:00
event_groups.c freertos: Add GetStaticBuffer functions 2023-04-12 11:45:06 +08:00
list.c freertos: Add FreeRTOS SMP upstream files 2022-03-08 14:58:57 +08:00
porting_notes.md freertos-smp: Updated the FreeRTOS SMP kernel source to the latest commit 2022-11-03 08:01:44 +01:00
queue.c freertos: Add GetStaticBuffer functions 2023-04-12 11:45:06 +08:00
README.md freertos: Add FreeRTOS SMP upstream files 2022-03-08 14:58:57 +08:00
stream_buffer.c freertos: Add GetStaticBuffer functions 2023-04-12 11:45:06 +08:00
tasks.c refactor(freertos/smp): Move vTaskStartSchedulerOtherCores() to API additions to headers 2023-09-05 16:19:42 +08:00
timers.c freertos: Add GetStaticBuffer functions 2023-04-12 11:45:06 +08:00

README.md

Getting started

This repository contains FreeRTOS kernel source/header files and kernel ports only. This repository is referenced as a submodule in FreeRTOS/FreeRTOS repository, which contains pre-configured demo application projects under FreeRTOS/Demo directory.

The easiest way to use FreeRTOS is to start with one of the pre-configured demo application projects. That way you will have the correct FreeRTOS source files included, and the correct include paths configured. Once a demo application is building and executing you can remove the demo application files, and start to add in your own application source files. See the FreeRTOS Kernel Quick Start Guide for detailed instructions and other useful links.

Additionally, for FreeRTOS kernel feature information refer to the Developer Documentation, and API Reference.

Getting help

If you have any questions or need assistance troubleshooting your FreeRTOS project, we have an active community that can help on the FreeRTOS Community Support Forum.

Cloning this repository

To clone using HTTPS:

git clone https://github.com/FreeRTOS/FreeRTOS-Kernel.git

Using SSH:

git clone git@github.com:FreeRTOS/FreeRTOS-Kernel.git

Repository structure

  • The root of this repository contains the three files that are common to every port - list.c, queue.c and tasks.c. The kernel is contained within these three files. croutine.c implements the optional co-routine functionality - which is normally only used on very memory limited systems.

  • The ./portable directory contains the files that are specific to a particular microcontroller and/or compiler. See the readme file in the ./portable directory for more information.

  • The ./include directory contains the real time kernel header files.

Code Formatting

FreeRTOS files are formatted using the "uncrustify" tool. The configuration file used by uncrustify can be found in the FreeRTOS/FreeRTOS repository.

Spelling

lexicon.txt contains words that are not traditionally found in an English dictionary. It is used by the spellchecker to verify the various jargon, variable names, and other odd words used in the FreeRTOS code base. If your pull request fails to pass the spelling and you believe this is a mistake, then add the word to lexicon.txt. Note that only the FreeRTOS Kernel source files are checked for proper spelling, the portable section is ignored.