Expand docs: Baremetal setup, update pico integration #142
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
rauhul
reviewed
May 24, 2025
Sources/EmbeddedSwift/Documentation.docc/SDKSupport/Baremetal.md
Outdated
Show resolved
Hide resolved
rauhul
reviewed
May 24, 2025
| Example vector table structure: | ||
|
|
||
| ```c | ||
| // Vector table for ARM Cortex-M |
There was a problem hiding this comment.
Can we add a todo or gh issue to migrate these to InlineArray?
There was a problem hiding this comment.
I'm not sure it's realistic to migrate to InlineArray today -- I think the blocker is @section being able to handle a not-completely-straightforward array, because the vector table also needs the initial SP (which is not a fptr). I can certainly file a GH issue to track this.
rauhul
reviewed
May 24, 2025
| }; | ||
| ``` | ||
|
|
||
| If you want to actually handle an interrupt (e.g. a GPIO or UART interrupt) in your Swift code, you can forward declare the function in C, and define it using `@cdecl` in Swift: |
There was a problem hiding this comment.
I think using InlineArray here would ease this learning curve by not requiring forward declarations.
rauhul
reviewed
May 24, 2025
|
|
||
| However, note that Swift currently does not provide any form of synchronization or "interrupt safety" for the code that executes the interrupt. Namely, if your interrupt handler modifies global variables that are also accessed by your main program, you need to be careful about data races and ensure proper synchronization (such as using atomic operations or disabling interrupts during critical sections). Additionally, interrupt handlers should be kept short and fast to avoid blocking other important system events. | ||
|
|
||
| ## Building a minimal project |
There was a problem hiding this comment.
This is pretty great, but likely should move the to build-system support section
rauhul
reviewed
May 24, 2025
| @@ -94,7 +93,7 @@ $ export PICO_SDK_PATH=<path_to_pico_sdk> | |||
| $ export PICO_TOOLCHAIN_PATH=<path_to_arm_toolchain> | |||
| $ ls -al | |||
| -rw-r--r-- 1 kuba staff 39B Feb 2 22:08 BridgingHeader.h | |||
| -rw-r--r-- 1 kuba staff 1.3K Feb 2 22:08 CMakeLists.txt | |||
Some clean up
rauhul
approved these changes
May 29, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.