Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove coroutines #590

Merged
merged 4 commits into from
Nov 23, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 0 additions & 26 deletions .github/lexicon.txt
Original file line number Diff line number Diff line change
Expand Up @@ -317,7 +317,6 @@ coproc
coprocessor
coprocessors
coreid
coroutinehandle
covfs
cp
cpacr
Expand All @@ -344,16 +343,10 @@ cpu
cr
crc
crcb
crcoroutine
crdelay
creadonlyarray
creadwritearray
createevent
crend
crgint
croutine
crqueue
crstart
crt
crtv
crxedchar
Expand Down Expand Up @@ -1517,14 +1510,11 @@ prvaddcurrenttasktodelayedlist
prvcheckinterfaces
prvchecktaskswaitingtermination
prvcopydatatoqueue
prvcoroutineflashtask
prvcoroutineflashworktask
prvdeletetcb
prvexitfunction
prvgettimens
prvheapinit
prvidletask
prvinitialisecoroutinelists
prvinitialisemutex
prvinitialisenewstreambuffer
prvinitialisenewtimer
Expand Down Expand Up @@ -1638,15 +1628,11 @@ pxblocktoinsert
pxcallbackfunction
pxcode
pxcontainer
pxcoroutinecode
pxcoroutinewoken
pxcrcb
pxcreatedtask
pxcurrentcoroutine
pxcurrenttcb
pxcurrenttcbconst
pxcurrenttimerlist
pxdelayedcoroutinelist
pxdelayedtasklist
pxend
pxendofstack
Expand Down Expand Up @@ -1681,7 +1667,6 @@ pxnextfreeblock
pxnexttcb
pxoriginalsp
pxoriginaltos
pxoverflowdelayedcoroutinelist
pxoverflowdelayedtasklist
pxowner
pxportinitialisestack
Expand All @@ -1691,7 +1676,6 @@ pxqueue
pxqueuebuffer
pxqueuesetcontainer
pxramstack
pxreadycoroutinelists
pxreadytaskslists
pxreceivecompletedcallback
pxregions
Expand Down Expand Up @@ -2463,7 +2447,6 @@ uxtopreadypriority
uxtopusedpriority
uxvariabletoincrement
uxwantedbytes
vacoroutine
vadifferenttask
vafunction
val
Expand Down Expand Up @@ -2492,7 +2475,6 @@ vbr
vbufferisr
vcallbackfunction
vclearinterruptmask
vcoroutineschedule
vddcore
vec
vectactive
Expand All @@ -2502,7 +2484,6 @@ ver
veventgroupclearbitscallback
veventgroupdelete
veventgroupsetbitscallback
vflashcoroutine
vfp
vfunction
vic
Expand Down Expand Up @@ -2565,14 +2546,12 @@ vqueuedelete
vqueueunregisterqueue
vr
vraiseprivilege
vreceivingcoroutine
vreg
vresetprivilege
vrestorecontextoffirsttask
vrpm
vsemaphorecreatebinary
vsemaphoredelete
vsendingcoroutine
vsetbacklightstate
vsoftwareinterruptentry
vstartfirsttask
Expand Down Expand Up @@ -2706,9 +2685,6 @@ xcommandtime
xcommsrxqueue
xconsttickcount
xcopyposition
xcoroutinecreate
xcoroutinepreviouslywoken
xcoroutinequeue
xcount
xcreatedeventgroup
xcrwokenbypost
Expand All @@ -2718,7 +2694,6 @@ xdd
xdddd
xdeadbeef
xdelay
xdelayedcoroutinelist
xdelayedtasklist
xdelaytime
xe
Expand Down Expand Up @@ -2865,7 +2840,6 @@ xpar
xparameters
xpendedcounts
xpendedticks
xpendingreadycoroutinelist
xpendingreadylist
xperiod
xportgetcoreid
Expand Down
1 change: 0 additions & 1 deletion CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -225,7 +225,6 @@ endif()
add_subdirectory(portable)

add_library(freertos_kernel STATIC
croutine.c
event_groups.c
list.c
queue.c
Expand Down
15 changes: 7 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
## Getting started
This repository contains FreeRTOS kernel source/header files and kernel ports only. This repository is referenced as a submodule in [FreeRTOS/FreeRTOS](https://github.com/FreeRTOS/FreeRTOS) repository, which contains pre-configured demo application projects under ```FreeRTOS/Demo``` directory.
This repository contains FreeRTOS kernel source/header files and kernel ports only. This repository is referenced as a submodule in [FreeRTOS/FreeRTOS](https://github.com/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](https://www.FreeRTOS.org/FreeRTOS-quick-start-guide.html) for detailed instructions and other useful links.

Expand Down Expand Up @@ -66,19 +66,18 @@ git clone [email protected]: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 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.

- The ```./portable``` directory contains the files that are specific to a particular microcontroller and/or compiler.
- 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](https://github.com/FreeRTOS/FreeRTOS/blob/main/tools/uncrustify.cfg).
FreeRTOS files are formatted using the "uncrustify" tool. The configuration file used by uncrustify can be found in the [FreeRTOS/FreeRTOS repository](https://github.com/FreeRTOS/FreeRTOS/blob/main/tools/uncrustify.cfg).

### 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*.
*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.
Loading