Integrate Arduino_ThreadsafeIO #28

aentinger · 2021-10-13T04:56:42Z

This PR will integrate https://github.com/bcmi-labs/Arduino_ThreadsafeIO into Arduino_Threads, providing a fully featured solution for multi-threading applications.

…uck.

…o keep it on the stack.

…dicated instantiation required.

…bytes have been written.

…mory leak.

…ove the need for a separate class SpiIoRequest

… messages there before writing them to the actual serial interface.

Provide message to be written to prefix/suffix callbacks:

…riority over per-thread-callbacks.

…ize such global callbacks.

…ing.

…it_BusIO. * All data returned by spi.transfer() before the end of the write buffer are directly written into the write buffer. * All data returned by spi.transer() after the end of the write buffer are written into the read buffer. * After exhaustion of the write buffer only the fill_value is being sent.

Provide Adafruit_BusIO style interface for Wire/SPI

Global local callbacks

…ThreadsafeIO into integrate-io

github-actions · 2021-10-13T05:05:33Z

Memory usage change @ 5a21e7f

Board	flash	%	RAM for global variables	%
arduino:mbed_nano:nano33ble	🔺 +10784 - +10848	+1.1 - +1.1	🔺 +2104 - +2104	+0.8 - +0.8
arduino:mbed_nano:nanorp2040connect	🔺 +100 - +100	0.0 - 0.0	🔺 +1048 - +1048	+0.39 - +0.39
arduino:mbed_portenta:envie_m4	🔺 +9248 - +9312	+0.88 - +0.89	🔺 +3688 - +3688	+1.25 - +1.25
arduino:mbed_portenta:envie_m7	🔺 +9248 - +9312	+1.18 - +1.18	🔺 +3696 - +3696	+0.71 - +0.71

Click for full report table

Board	examples/Demo_Shared_Counter flash	%	examples/Demo_Shared_Counter RAM for global variables	%	examples/Demo_Source_Sink_Counter flash	%	examples/Demo_Source_Sink_Counter RAM for global variables	%	examples/Demo_Source_Sink_LED flash	%	examples/Demo_Source_Sink_LED RAM for global variables	%	examples/Threadsafe_SPI flash	%	examples/Threadsafe_SPI RAM for global variables	%	examples/Threadsafe_SPI_BusIO flash	%	examples/Threadsafe_SPI_BusIO RAM for global variables	%	examples/Threadsafe_Serial_GlobalPrefixSuffix flash	%	examples/Threadsafe_Serial_GlobalPrefixSuffix RAM for global variables	%	examples/Threadsafe_Serial_ProtocolWrapping flash	%	examples/Threadsafe_Serial_ProtocolWrapping RAM for global variables	%	examples/Threadsafe_Serial_Reader flash	%	examples/Threadsafe_Serial_Reader RAM for global variables	%	examples/Threadsafe_Serial_Writer flash	%	examples/Threadsafe_Serial_Writer RAM for global variables	%	examples/Threadsafe_Wire flash	%	examples/Threadsafe_Wire RAM for global variables	%	examples/Threadsafe_Wire_BusIO flash	%	examples/Threadsafe_Wire_BusIO RAM for global variables	%
arduino:mbed_nano:nano33ble	10848	1.1	2104	0.8	10848	1.1	2104	0.8	10784	1.1	2104	0.8	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A
arduino:mbed_nano:nanorp2040connect	100	0.0	1048	0.39	100	0.0	1048	0.39	100	0.0	1048	0.39	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A
arduino:mbed_portenta:envie_m4	9248	0.88	3688	1.25	9312	0.89	3688	1.25	9248	0.88	3688	1.25	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A
arduino:mbed_portenta:envie_m7	9312	1.18	3696	0.71	9312	1.18	3696	0.71	9248	1.18	3696	0.71	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A

Click for full report CSV

Board,examples/Demo_Shared_Counter<br>flash,%,examples/Demo_Shared_Counter<br>RAM for global variables,%,examples/Demo_Source_Sink_Counter<br>flash,%,examples/Demo_Source_Sink_Counter<br>RAM for global variables,%,examples/Demo_Source_Sink_LED<br>flash,%,examples/Demo_Source_Sink_LED<br>RAM for global variables,%,examples/Threadsafe_SPI<br>flash,%,examples/Threadsafe_SPI<br>RAM for global variables,%,examples/Threadsafe_SPI_BusIO<br>flash,%,examples/Threadsafe_SPI_BusIO<br>RAM for global variables,%,examples/Threadsafe_Serial_GlobalPrefixSuffix<br>flash,%,examples/Threadsafe_Serial_GlobalPrefixSuffix<br>RAM for global variables,%,examples/Threadsafe_Serial_ProtocolWrapping<br>flash,%,examples/Threadsafe_Serial_ProtocolWrapping<br>RAM for global variables,%,examples/Threadsafe_Serial_Reader<br>flash,%,examples/Threadsafe_Serial_Reader<br>RAM for global variables,%,examples/Threadsafe_Serial_Writer<br>flash,%,examples/Threadsafe_Serial_Writer<br>RAM for global variables,%,examples/Threadsafe_Wire<br>flash,%,examples/Threadsafe_Wire<br>RAM for global variables,%,examples/Threadsafe_Wire_BusIO<br>flash,%,examples/Threadsafe_Wire_BusIO<br>RAM for global variables,%
arduino:mbed_nano:nano33ble,10848,1.1,2104,0.8,10848,1.1,2104,0.8,10784,1.1,2104,0.8,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A
arduino:mbed_nano:nanorp2040connect,100,0.0,1048,0.39,100,0.0,1048,0.39,100,0.0,1048,0.39,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A
arduino:mbed_portenta:envie_m4,9248,0.88,3688,1.25,9312,0.89,3688,1.25,9248,0.88,3688,1.25,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A
arduino:mbed_portenta:envie_m7,9312,1.18,3696,0.71,9312,1.18,3696,0.71,9248,1.18,3696,0.71,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A

github-actions · 2021-10-13T05:18:03Z

Memory usage change @ d7e9dfe

Board	flash	%	RAM for global variables	%
arduino:mbed_nano:nano33ble	🔺 +10784 - +10848	+1.1 - +1.1	🔺 +2104 - +2104	+0.8 - +0.8
arduino:mbed_nano:nanorp2040connect	🔺 +100 - +100	0.0 - 0.0	🔺 +1048 - +1048	+0.39 - +0.39
arduino:mbed_portenta:envie_m4	🔺 +9248 - +9312	+0.88 - +0.89	🔺 +3688 - +3688	+1.25 - +1.25
arduino:mbed_portenta:envie_m7	🔺 +9248 - +9312	+1.18 - +1.18	🔺 +3696 - +3696	+0.71 - +0.71

Click for full report table

Board	examples/Demo_Shared_Counter flash	%	examples/Demo_Shared_Counter RAM for global variables	%	examples/Demo_Source_Sink_Counter flash	%	examples/Demo_Source_Sink_Counter RAM for global variables	%	examples/Demo_Source_Sink_LED flash	%	examples/Demo_Source_Sink_LED RAM for global variables	%	examples/Threadsafe_SPI flash	%	examples/Threadsafe_SPI RAM for global variables	%	examples/Threadsafe_SPI_BusIO flash	%	examples/Threadsafe_SPI_BusIO RAM for global variables	%	examples/Threadsafe_Serial_GlobalPrefixSuffix flash	%	examples/Threadsafe_Serial_GlobalPrefixSuffix RAM for global variables	%	examples/Threadsafe_Serial_ProtocolWrapping flash	%	examples/Threadsafe_Serial_ProtocolWrapping RAM for global variables	%	examples/Threadsafe_Serial_Reader flash	%	examples/Threadsafe_Serial_Reader RAM for global variables	%	examples/Threadsafe_Serial_Writer flash	%	examples/Threadsafe_Serial_Writer RAM for global variables	%	examples/Threadsafe_Wire flash	%	examples/Threadsafe_Wire RAM for global variables	%	examples/Threadsafe_Wire_BusIO flash	%	examples/Threadsafe_Wire_BusIO RAM for global variables	%
arduino:mbed_nano:nano33ble	10848	1.1	2104	0.8	10848	1.1	2104	0.8	10784	1.1	2104	0.8	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A
arduino:mbed_nano:nanorp2040connect	100	0.0	1048	0.39	100	0.0	1048	0.39	100	0.0	1048	0.39	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A
arduino:mbed_portenta:envie_m4	9248	0.88	3688	1.25	9312	0.89	3688	1.25	9248	0.88	3688	1.25	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A
arduino:mbed_portenta:envie_m7	9312	1.18	3696	0.71	9312	1.18	3696	0.71	9248	1.18	3696	0.71	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A

Click for full report CSV

Board,examples/Demo_Shared_Counter<br>flash,%,examples/Demo_Shared_Counter<br>RAM for global variables,%,examples/Demo_Source_Sink_Counter<br>flash,%,examples/Demo_Source_Sink_Counter<br>RAM for global variables,%,examples/Demo_Source_Sink_LED<br>flash,%,examples/Demo_Source_Sink_LED<br>RAM for global variables,%,examples/Threadsafe_SPI<br>flash,%,examples/Threadsafe_SPI<br>RAM for global variables,%,examples/Threadsafe_SPI_BusIO<br>flash,%,examples/Threadsafe_SPI_BusIO<br>RAM for global variables,%,examples/Threadsafe_Serial_GlobalPrefixSuffix<br>flash,%,examples/Threadsafe_Serial_GlobalPrefixSuffix<br>RAM for global variables,%,examples/Threadsafe_Serial_ProtocolWrapping<br>flash,%,examples/Threadsafe_Serial_ProtocolWrapping<br>RAM for global variables,%,examples/Threadsafe_Serial_Reader<br>flash,%,examples/Threadsafe_Serial_Reader<br>RAM for global variables,%,examples/Threadsafe_Serial_Writer<br>flash,%,examples/Threadsafe_Serial_Writer<br>RAM for global variables,%,examples/Threadsafe_Wire<br>flash,%,examples/Threadsafe_Wire<br>RAM for global variables,%,examples/Threadsafe_Wire_BusIO<br>flash,%,examples/Threadsafe_Wire_BusIO<br>RAM for global variables,%
arduino:mbed_nano:nano33ble,10848,1.1,2104,0.8,10848,1.1,2104,0.8,10784,1.1,2104,0.8,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A
arduino:mbed_nano:nanorp2040connect,100,0.0,1048,0.39,100,0.0,1048,0.39,100,0.0,1048,0.39,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A
arduino:mbed_portenta:envie_m4,9248,0.88,3688,1.25,9312,0.89,3688,1.25,9248,0.88,3688,1.25,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A
arduino:mbed_portenta:envie_m7,9312,1.18,3696,0.71,9312,1.18,3696,0.71,9248,1.18,3696,0.71,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A

aentinger added 30 commits July 12, 2021 07:30

Backup-Point #1: This SPI access works.

6b4cd90

Backup-Point #2: This async access works but god knows its hacky as f…

c0c6644

…uck.

Turn SpiDispatcher into a threadsafe singleon, eliminating the need t…

c67b924

…o keep it on the stack.

Limit public API of SpiDispatcher.

06f0961

Eliminate global variable rtos::Queues.

46deed6

Extract SPI processing code for better readability.

84d1664

Lock all public APIs of SpiDispatcher to avoid race conditions.

de5819c

Slightly expanding IoRequest API and cleaning up a bit.

813b062

Rename TxBuf to WriteBuf, RxBuf to ReadBuf

d73db48

IoRequest is now again properly hiding data behind accessor().

e588f48

First call to SpiDispatcher::instance(). ... starts everything, no de…

2517bed

…dicated instantiation required.

Extract SpiBusDeviceConfig.

3ff0d44

Extracting SpiIoRequest.

90514b2

Minor refactorings.

eb3fb60

Move everything into subfolder spi

3d67409

Extracting SpiIoRequest

2eaab0a

Async waiting step 1 ...

920ba3f

Using SharedPtr eliminates the issue of memory leaks.

ddcb183

Renaming 'request' to 'dispatch'

ab763ea

Simplifying Input and Output buffer (IoRequest/IoResponse)

3c963d3

Pass IoTransactions instead of IoRequest/IoResponses.

14ff754

Also transport information on how many bytes have been read/how many …

c0b9db6

…bytes have been written.

Encapsulate the waiting in a function.

b0d61ea

Consolating IoRequest and IoResponse within IoTransaction.

30b0542

Replacing the Queue with a Mailbox, therefore eliminating the last me…

22f55a9

…mory leak.

Extending example code to whip up 20 threads and do parallel SPI access.

5b82cc7

A bit of refactoring for better readability.

b54f584

Cleverly restructuring the way we are using IoTransactions we can rem…

042cfc3

…ove the need for a separate class SpiIoRequest

Deleting SpiIoRequest

ffadee7

Minimal keywords.txt for syntax highlighting.

a1d0feb

aentinger added 23 commits September 21, 2021 09:33

We need a bigger serial transmit ringbuffer, if we are going to store…

4b02a9d

… messages there before writing them to the actual serial interface.

Replace inline-lamda-implementation with regular function pointers.

d164c26

Rename example for better clarity about use-case.

e55cdb9

Merge pull request #26 from bcmi-labs/data-in-callback

ec08d12

Provide message to be written to prefix/suffix callbacks:

Allow registration of global prefix/suffix callbacks which take 2nd p…

1b152ac

…riority over per-thread-callbacks.

Example Threadsafe_Serial_GlobalPrefixSuffix demonstrates how to util…

206aa05

…ize such global callbacks.

Adding global_prefix/suffix as keywords for accurate syntax highlight…

b3b39d5

…ing.

Fix spelling of incorrectly spelled word 'precedence'

10348ab

Bugfix: Only perform i2c write if the write buffer is > 0 (#28)

e3e793f

Implement write_then_read style API for threadsafe Wire.

26b562b

Move implementation from WireBusDevice.h to WireBusDevice.cpp

2d1a689

Implement Adafruit_BusIO-style read/write methods for I2C.

d492b23

Move implementation from SpiBusDevice.h to SpiBusDevice.cpp

ec2eb39

Implement Adafruit_BusIO-style write_then_read method for SPI.

58b6fb9

Implement Adafruit_BusIO-style write/read method for SPI.

98bb122

Prevent out-of-bound buffer access.

414908d

Merge pull request #29 from bcmi-labs/busio-style-interface

fd2bfa1

Provide Adafruit_BusIO style interface for Wire/SPI

Merge branch 'main' into global-local-callbacks

31840d7

Merge pull request #27 from bcmi-labs/global-local-callbacks

28522d6

Global local callbacks

Release v0.6.0

0142844

Initial draft on a documentation within README. (#31)

40e2855

Merge branch 'main' of /home/alex/projects/arduino/libraries/Arduino_…

5a21e7f

…ThreadsafeIO into integrate-io

aentinger added the type: enhancement Proposed improvement label Oct 13, 2021

aentinger self-assigned this Oct 13, 2021

Delete superfluous compile-examples-private.yml.

d7e9dfe

aentinger merged commit 8469039 into master Oct 13, 2021

aentinger deleted the integrate-io branch October 13, 2021 05:35

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Integrate Arduino_ThreadsafeIO #28

Integrate Arduino_ThreadsafeIO #28

aentinger commented Oct 13, 2021

github-actions bot commented Oct 13, 2021

github-actions bot commented Oct 13, 2021

Integrate Arduino_ThreadsafeIO #28

Integrate Arduino_ThreadsafeIO #28

Conversation

aentinger commented Oct 13, 2021

github-actions bot commented Oct 13, 2021

github-actions bot commented Oct 13, 2021