FunctionalInterrupt/ScheduledFunctions should be in a library, not in esp32-hal-gpio #2734

dok-net · 2019-05-02T11:27:13Z

After mulling over the situation with the pending PR esp8266/Arduino#6003, I have rewritten the support for std::functional and scheduled interrupts to be less intrusive.
First, the support is revoked. Second, the refactored code is brought back as an example in libraries/ESP32/examples/GPIO/FunctionalInterrupt.
I have unified the code with the ESP8266 version: esp8266/Arduino#6038

dok-net · 2019-05-02T17:24:01Z

I don't know if this is redundant, but if integrating the Schedule.h functionality that brings loop-synchronized scheduling, is desired, here's what it takes:

copy Schedule.(h|cpp) from libraries/ESP32/examples/GPIO/FunctionalInterrupt to cores/esp32.
add cores/esp32/Schedule.cpp to CMakeLists.txt right before cores/esp32/Stream.cpp.
add #include "Schedule.h" as last include in Arduino.h.
add run_scheduled_functions(); right under loop(); in void loopTask(void *pvParameters) which is in cores/esp32/main.cpp.

me-no-dev · 2019-05-11T08:14:22Z

here are a few thoughts :)

Do not rename header filenames.
Do not include ESP8266 Arduino code in examples.
ESP32 Arduino runs on top of FreeRTOS :) we have threads and other tools to create scheduled commands
ESP32 Arduino doesn't necessarily have to have 1:1 what ESP8266 Arduino have. Chips are not the same, runtime is not the same... many differences.
Such PR Should be split in two, where we can in one discuss that Schedule library and another to discuss Functional Interrupt

dok-net · 2019-05-11T16:12:37Z

@me-no-dev :

Do not rename header filenames.

Checked - though they were deleted and resurrected as pure example code, not renamed ;-)

Do not include ESP8266 Arduino code in examples.

Functional* was previously included from ESP8266. I am working with the WEMOS D1 mini like boards, and I think Arduino is all about portability, please don't restrict this.

ESP32 Arduino runs on top of FreeRTOS :) we have threads and other tools to create scheduled commands

Again, Functional* did in fact get accepted earlier from a different source, I am removing them due to problems :-)

ESP32 Arduino doesn't necessarily have to have 1:1 what ESP8266 Arduino have. Chips are not the same, runtime is not the same... many differences.

Naturally, but helping migrate code is not an evil thing, anyway.

Such PR Should be split in two, where we can in one discuss that Schedule library and another to discuss Functional Interrupt

Dropping Schedule in the example is just due to my perception of the original author's intent of adding FunctionalInterrupt in the first place.

OK - I hope you can review this PR for it's own merits. The core issue I am addressing is that non-IRAM code will be surreptitiously called from ISRs if FunctionalInterrupt.h gets used.

…oop Scheduler

…opment branch.

…each completed loop.

(cherry picked from commit d39be67)

Move Schedule to libraries

…h ESP8266

(cherry picked from commit d39be67)

Same yield behavior as on ESP8266 - scheduler has policies for loop and yield initiated runs.

Move Schedule to libraries

…each completed loop.

(cherry picked from commit d39be67) squash! Add Schedule.(h|cpp) from ESP8266 to run off loopTask. squash! Add Schedule.(h|cpp) from ESP8266 to run off loopTask.

squash! Ticker and Schedule updated from ESP8266 Arduino

…ndling: - VIP treatment in general attach/detach/handling looks untidy: extern symbols without matching header include but copy&paste special under-the-hood c++ delete support, where everyone else has to do their own resource tracking as usual. - FunctionalInterrupt is not used by anything inside core ESP32 Arduino for 8 months now, it can be a library, which reduces precious core size for everyone else. This reverts commit ea61563.

…th functional interrupts.

…as example code. It should be decided whether to reinstate these in the core, or make them an optional library.

…comment)

…n attachInterruptArg(). This is sufficient for resource management - the function has static duration anyway.

…late the ISR in ICACHE_RAM rule (ESP8266 core catches this).

squash! Return Ticker to libraries only for modularity.

dok-net mentioned this pull request May 2, 2019

FunctionalInterrupt/ScheduledFunctions should be in a library, not in core_esp8266_wiring_digital esp8266/Arduino#6038

Closed

dok-net force-pushed the functional-shouldbe-lib branch 3 times, most recently from ce898df to d2ec37c Compare May 6, 2019 01:08

This was referenced May 6, 2019

Safely schedule functional ISRs: follow-up to Schedule and FunctionalInterrupt fix #2747

Closed

Prevent hidden use of non-IRAM interrupt service routines via FunctionalInterrupt API #2748

Closed

dok-net force-pushed the functional-shouldbe-lib branch from d2ec37c to 53aa967 Compare May 11, 2019 15:49

dok-net force-pushed the functional-shouldbe-lib branch 4 times, most recently from f01691b to 97aba98 Compare June 3, 2019 13:51

dok-net added 10 commits June 7, 2019 20:22

Update Ticker API to compatibility with ESP8266, prepares for co-op l…

f938f81

…oop Scheduler

Fixing Build server complaints

2030ba0

Fix omitted casts in template member function

108f87f

Changes after review

01dced2

Expose µs resolution of OS API in Ticker class

aa5d1c0

Return Ticker to libraries only for modularity.

e069d83

Unify Ticker examples.

cc9aa7d

Default for LED_BUILTIN

b6b5afd

In Ticker, the *scheduled functions become available in another devel…

2f2b66c

…opment branch.

Astyle from ESP8266

28f71f3

dok-net force-pushed the functional-shouldbe-lib branch from 3950637 to db42f37 Compare June 7, 2019 18:57

dok-net added 5 commits June 7, 2019 23:22

Add hooks for sketches/libraries to perform work on each yield() and …

af944b4

…each completed loop.

Add Schedule.(h|cpp) from ESP8266 to run off loopTask.

e7d5411

(cherry picked from commit d39be67)

Updated with latest sources and ESP8266/ESP32 portability.

37cebc1

Misordering resulting from merge fixed.

bfe8739

Yield in scheduling loop to prevent wdt elapsing.

b5b6dc9

dok-net added 26 commits June 7, 2019 23:26

Make entry points into sequential cont scheduler weak functions

1355467

Move Schedule to libraries

Move PolledTimeout to own libraries for source code compatibility wit…

c7fc06c

…h ESP8266

Add Schedule.(h|cpp) from ESP8266 to run off loopTask.

fda9f1e

(cherry picked from commit d39be67)

Port Schedule to ESP32.

562fbcb

Same yield behavior as on ESP8266 - scheduler has policies for loop and yield initiated runs.

Make entry points into sequential cont scheduler weak functions

487a7b0

Move Schedule to libraries

Add hooks for sketches/libraries to perform work on each yield() and …

f307262

…each completed loop.

Add Schedule.(h|cpp) from ESP8266 to run off loopTask.

adcc380

(cherry picked from commit d39be67) squash! Add Schedule.(h|cpp) from ESP8266 to run off loopTask. squash! Add Schedule.(h|cpp) from ESP8266 to run off loopTask.

Ticker and Schedule updated from ESP8266 Arduino

5972c52

squash! Ticker and Schedule updated from ESP8266 Arduino

Add supporting function for interrupt arg memory management, linke wi…

f1416fd

…th functional interrupts.

Bring back FunctionalInterrupt, and ScheduledFunctions from ESP8266, …

549f2ab

…as example code. It should be decided whether to reinstate these in the core, or make them an optional library.

Ridiculous port number mistake.

d192d3c

Apply astyle to example INO.

ad3a24a

Remove ScheduledFunctions.(h|cpp), per comment esp8266/Arduino#6038 (…

e530b68

…comment)

Invented void* detachInterruptArg() that returns the argument given i…

2768906

…n attachInterruptArg(). This is sufficient for resource management - the function has static duration anyway.

Modified example to showcase how general FunctionalInterrupt uses vio…

4960474

…late the ISR in ICACHE_RAM rule (ESP8266 core catches this).

Direct call or scheduled is either-or.

a55364c

While Schedule.cpp is not part of ESP32 core...

16cd6ff

Always apply astyle to examples.

cc0183d

Fix renaming for better PR readability.

896ec6b

Properly turn FunctionalInterrupt into integral library

c9d8753

remove leftover files

260aaaf

Update to latest ESP8266/ESP32 compatible version

f770056

Proper detach for scheduled ISR example

41265dd

Return Ticker to libraries only for modularity.

386b6e6

squash! Return Ticker to libraries only for modularity.

Fill in empty fields

ef061bc

dok-net force-pushed the functional-shouldbe-lib branch from db42f37 to ef061bc Compare June 7, 2019 22:16

Bring back FunctionalInterrupt's attachInterrupt()

5c46e6d

dok-net closed this Jun 28, 2019

dok-net deleted the functional-shouldbe-lib branch June 28, 2019 21:20

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FunctionalInterrupt/ScheduledFunctions should be in a library, not in esp32-hal-gpio #2734

FunctionalInterrupt/ScheduledFunctions should be in a library, not in esp32-hal-gpio #2734

dok-net commented May 2, 2019 •

edited

Loading

dok-net commented May 2, 2019 •

edited

Loading

me-no-dev commented May 11, 2019

dok-net commented May 11, 2019 •

edited

Loading

FunctionalInterrupt/ScheduledFunctions should be in a library, not in esp32-hal-gpio #2734

FunctionalInterrupt/ScheduledFunctions should be in a library, not in esp32-hal-gpio #2734

Conversation

dok-net commented May 2, 2019 • edited Loading

dok-net commented May 2, 2019 • edited Loading

me-no-dev commented May 11, 2019

dok-net commented May 11, 2019 • edited Loading

dok-net commented May 2, 2019 •

edited

Loading

dok-net commented May 2, 2019 •

edited

Loading

dok-net commented May 11, 2019 •

edited

Loading