esp-idf/components/freertos/FreeRTOS-Kernel-SMP
Darian Leung a8a3756b38 hal: Route CPU and Interrupt Controller HAL/LL to esp_cpu calls
This commit makes changes to cpu_ll.h, cpu_hal.h, and interrupt_controller_hal.h:

- Moved to esp_hw_support in order to be deprecated in the future
- HAL/LL API now route their calls to esp_cpu.h functions instead

Also updated soc_hal.h as follows:

- Removed __SOC_HAL_..._OTHER_CORES() macros as they dependend on cpu_hal.h
- Made soc_hal.h and soc_ll.h interfaces always inline, and removed soc_hal.c.

This commit also updates the XCHAL_ERRATUM_572 workaround by

- Removing it's HAL function and invoking the workaround it directly the bootloader
- Added missing workaround for the ESP32-S3
2022-06-14 14:40:03 +08:00
..
include/freertos freertos: Fix GCC 11 SMP FreeRTOS build errors 2022-06-07 16:33:22 +08:00
portable hal: Route CPU and Interrupt Controller HAL/LL to esp_cpu calls 2022-06-14 14:40:03 +08:00
croutine.c freertos: Add FreeRTOS SMP upstream files 2022-03-08 14:58:57 +08:00
event_groups.c freertos: Add FreeRTOS SMP upstream files 2022-03-08 14:58:57 +08:00
list.c freertos: Add FreeRTOS SMP upstream files 2022-03-08 14:58:57 +08:00
porting_notes.md freertos: Update task creation pinned to core functions 2022-03-21 11:37:21 +08:00
queue.c freertos: Add FreeRTOS SMP upstream files 2022-03-08 14:58:57 +08:00
README.md freertos: Add FreeRTOS SMP upstream files 2022-03-08 14:58:57 +08:00
stream_buffer.c freertos: Add FreeRTOS SMP upstream files 2022-03-08 14:58:57 +08:00
tasks.c freertos: Add newlib dynamic reentrancy support 2022-06-02 15:42:02 +08:00
timers.c freertos: Add FreeRTOS SMP upstream files 2022-03-08 14:58:57 +08:00

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.