ruspiro-sdk
| Crates.io | ruspiro-sdk |
| lib.rs | ruspiro-sdk |
| version | 0.2.0 |
| source | src |
| created_at | 2019-08-10 10:41:19.241738 |
| updated_at | 2019-09-01 19:46:18.096563 |
| description | Combine the RusPiRo crates into a SDK library for convinient usage, providing feature gates for the individual parts. |
| homepage | |
| repository | https://github.com/RusPiRo/ruspiro-sdk |
| max_upload_size | |
| id | 155578 |
| size | 27,890 |
(2ndTaleStudio)
documentation
README
RusPiRo bare metal system development kit crate
This is the packaged crate combining different RusPiRo crates into one library. The library can be configured with feature gates
and allowes a more convinient usage pattern for the dependencies in your Cargo.toml file. See the details and usage patterns
below...
Usage
To use the crate just add the following dependency to your Cargo.toml file. The components of the system development kit could be configured using feature gates. The available features are listed in the table below.
[dependencies]
ruspiro-sdk = "0.2"
The always usable crates are:
ruspiro-registerruspiro-lockruspiro-singletonruspiro-gpioruspiro-mailboxruspiro-timerruspiro-cacheruspiro-interrupt
Features:
| Feature | Default | Description |
|---|---|---|
ruspiro_pi3 |
yes | Forwarded to the dependend crates to enable Raspberry Pi3 specific compilation, e.g. provide the proper base address for MMIO register. |
with_boot |
yes | Bundle the ruspiro-boot crate into the sdk package providing Raspberry Pi boot code. |
with_allocator |
yes | Bundle the ruspiro-allocator crate into the sdk package |
with_console |
no | Bundle the ruspiro-console crate into the sdk package. This requires an allocator to be present. |
with_uart |
no | Bundle the ruspiro-uart crate into the sdk package. This will always bundle ruspiro-console and does also require an allocator to be present. So either provide your own or activate the with_alocator feature as well. |
with_i2c |
no | Bundle the ruspiro-i2c crate into the sdk package. This requires an allocator to be present. |
Usage Scenarios
The following sections give some guidance how the ruspiro-sdk might be utilized. Each scenario provides an example
that could be found in the sub-folders mentioned in the respective chapter. Those examples should build just fine and could
be used as starting point for your own projects.
Scenario 1: Minimal with built-in boot
This scenario is the proposed entry point in using the RusPiRo SDK the first time. In this scenario the ruspiro-sdk
will be used with the set of default features only.
Find the whole crate structure here: Scenario-1
Scenario 1: Advanced! Minimal without built-in boot
This advanced scenario is intended for those who either already have their own boot assembly or do want to write their own one.
Additionally some other core requirements to successfully build a binary when not using the ruspiro-boot need to be fulfilled:
-
provide a panic handler and a eh_personality function.
-
provide unwind stubs:
- __aeabi_unwind_cpp_pr0
- __aeabi_unwind_cpp_pr1
- _Unwind_Resume
-
when using the
ruspiro-allocatorin this scenario the linker need to provide the two symbols:__heap_start__heap_end
indicating the physical memory address space of the heap.
Scenario 2: Using Uart/Console with built-in boot
This might be the most typical scenario to start with as it provides the functions to successfully initialize the Uart to be used as console output channel which makes "debugging" on the real hardware a bit easier. Find the whole crate structure here: Scenario-2
License
Licensed under Apache License, Version 2.0, (LICENSE or http://www.apache.org/licenses/LICENSE-2.0)