Google Git
Sign in
pigweed / third_party / github / FreeRTOS / FreeRTOS-Kernel / refs/heads/smp
commit81c623212a8746c4b5ebc29891b91228591040cc[log] [tgz]
authorchinglee-iot <61685396+chinglee-iot@users.noreply.github.com>Tue Feb 20 16:50:51 2024 +0800
committerGitHub <noreply@github.com>Tue Feb 20 16:50:51 2024 +0800
tree817a259c756880222023fdc00980df8ff776f9ba
parenteb80149cd724dfd057c14d5f8ab75026ef8148fe [diff]
Update SMP branch readme for port migration (#999)
1 file changed
tree: 817a259c756880222023fdc00980df8ff776f9ba
  1. .github/
  2. design/
  3. include/
  4. portable/
  5. .gitignore
  6. CMakeLists.txt
  7. croutine.c
  8. event_groups.c
  9. GitHub-FreeRTOS-Kernel-Home.url
  10. History.txt
  11. LICENSE.md
  12. list.c
  13. queue.c
  14. Quick_Start_Guide.url
  15. README.md
  16. stream_buffer.c
  17. tasks.c
  18. timers.c
README.md

image DEPRECATED

Announcement:

FreeRTOS SMP feature has been merged into FreeRTOS-Kernel main branch. We recommend you to use the FreeRTOS-Kernel main branch to develop FreeRTOS SMP applications.

The contents of this branch will remain available for certain period but we will no longer provide updates or accept new contributions and pull requests.

Have more questions? Post them in the FreeRTOS forum.

Migrate port from SMP branch to FreeRTOS v11

The following changes should be applied to migrate a port from this branch to FreeRTOS v11:

  • Call xTaskIncrementTick in critical section in port

RP2040 example:

void xPortSysTickHandler( void )
{
    portBASE_TYPE xPreviousMask;

    /* xTaskIncrementTick now must be called in critical section. */
    xPreviousMask = taskENTER_CRITICAL_FROM_ISR();
    {
        /* Increment the RTOS tick. */
        if( xTaskIncrementTick() != pdFALSE )
        {
            /* Pend a context switch. */
            portNVIC_INT_CTRL_REG = portNVIC_PENDSVSET_BIT;
        }
    }
    taskEXIT_CRITICAL_FROM_ISR( xPreviousMask );
}

  • Rename configNUM_CORES to configNUMBER_OF_CORES

  • Define portSET/CLEAR_INTERRUPT_MASK in port

  • Define portENTER/EXIT_CRITICAL_FROM_ISR for SMP in port

    • These macros should be implemented with vTaskEnterCriticalFromISR/xTaskExitCriticalFromISR

  • Update portSET/CLEAR_INTERRUPT_MASK_FROM_ISR implementation in port

    • SMP-dev doesn’t use these macros to enter/exit critical section from ISR. Instead, portENTER/EXIT_CRITICAL_FROM_ISR are used. These functions should be implemented as the macro name suggested, set or clear interrupt mask from ISR if nested interrupt are supported.

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.