aboutsummaryrefslogtreecommitdiff
path: root/embassy-mcxa/SW-Content-Register.txt
diff options
context:
space:
mode:
authorJames Munns <[email protected]>2025-12-04 18:46:39 +0100
committerJames Munns <[email protected]>2025-12-04 18:47:31 +0100
commitc3bc8fe8c0db112e5f2f66580104fc49b02890d2 (patch)
treeeea7adc15021697ea980289edd6235daaa12d6ee /embassy-mcxa/SW-Content-Register.txt
parent5182b2ed54f991b40b45fd2de75f597358ff9c3e (diff)
parent277ab0d2e8714edf37a0ee84cda1059d9944ecef (diff)
Import embassy-mcxa repo
Merge remote-tracking branch 'james-e-mcxa/james/upstream' into james/upstream-mcxa
Diffstat (limited to 'embassy-mcxa/SW-Content-Register.txt')
-rw-r--r--embassy-mcxa/SW-Content-Register.txt78
1 files changed, 78 insertions, 0 deletions
diff --git a/embassy-mcxa/SW-Content-Register.txt b/embassy-mcxa/SW-Content-Register.txt
new file mode 100644
index 000000000..09f879c2f
--- /dev/null
+++ b/embassy-mcxa/SW-Content-Register.txt
@@ -0,0 +1,78 @@
1Release Name: Embassy MCXA276 HAL
2Release Version: 0.1.0
3Package License: MIT (see ./License.txt)
4Note: The crate is dual-licensed “MIT OR Apache-2.0” per Cargo.toml; choosing MIT satisfies the dual-license terms.
5
6Scope of this Register
7This file documents software content that is part of this repository and, for transparency, lists major non-vendored Rust dependencies that are resolved from crates.io during builds. Components that are not present in the repository (e.g., external crates) are listed under “Non‑vendored Rust dependencies”.
8
9Repository Components (included in this release)
10
11embassy_mcxa276_hal Name: Embassy MCXA276 HAL (library + examples)
12 Version: 0.1.0
13 Outgoing License: MIT
14 License File: ./License.txt
15 Format: Rust source code, examples, scripts, linker scripts
16 Description: Hardware Abstraction Layer for NXP MCXA276 using the Embassy async framework. Implements drivers and helpers for:
17 - LPUART2 (UART), OSTIMER0, RTC0, ADC1, GPIO
18 - Embassy integration (executors, time)
19 Location: ./src, ./examples, ./build.rs, ./memory.x, ./ram.ld, ./defmt.x, ./.cargo/config.toml, ./run.sh, ./tools/
20 Origin: OEMWCSE (MIT)
21 URL: https://bitbucket.sw.nxp.com/scm/oemwcse/mcxa_rust.git
22
23mcxa276_pac Name: MCXA276 Peripheral Access Crate (PAC)
24 Version: 0.1.0
25 Outgoing License: MIT OR Apache-2.0
26 License File: (see crate metadata)
27 Format: Rust source code (auto-generated PAC)
28 Description: Auto-generated register mappings for MCXA276 peripherals (svd2rust). Includes device.x and interrupt vectors.
29 Location: External (git): https://github.com/bogdan-petru/mcxa-pac (pinned rev a9dd3301)
30 Origin: Generated by svdtools + svd2rust from NXP SVD 25.06.00
31 URL: N/A (generated from NXP SVD)
32
33examples Name: Example applications
34 Version: N/A
35 Outgoing License: MIT
36 License File: ./License.txt
37 Format: Rust source code (examples)
38 Description: Demonstrations for HAL peripherals and features:
39 - hello, blink
40 - lpuart_polling, lpuart_buffered, uart_interrupt
41 - rtc_alarm
42 - adc_polling, adc_interrupt
43 - ostimer_alarm, ostimer_async, ostimer_counter, ostimer_race_test
44 Location: ./examples
45 Origin: OEMWCSE (MIT)
46
47Non‑vendored Rust dependencies (resolved from crates.io at build time)
48The following crates are not vendored in this repository. They are fetched during builds via Cargo. See Cargo.lock for exact versions. License summaries below are for convenience; consult each crate for authoritative terms.
49
50cortex-m License: MIT OR Apache-2.0 Purpose: Cortex-M core support
51cortex-m-rt License: MIT OR Apache-2.0 Purpose: Cortex-M runtime (vectors, reset)
52embassy-executor License: MIT OR Apache-2.0 Purpose: Async executor for Cortex-M
53embassy-time (+ driver) License: MIT OR Apache-2.0 Purpose: Time abstraction and drivers
54embassy-sync License: MIT OR Apache-2.0 Purpose: No-std synchronization primitives
55embassy-embedded-hal License: MIT OR Apache-2.0 Purpose: Traits/adapters for embedded-hal
56embassy-hal-internal License: MIT OR Apache-2.0 Purpose: HAL building blocks (peripherals!)
57embedded-hal (1.0) License: MIT OR Apache-2.0 Purpose: Core embedded hardware traits
58embedded-hal (0.2.6) License: MIT OR Apache-2.0 Purpose: Legacy HAL traits ("unproven")
59embedded-hal-async License: MIT OR Apache-2.0 Purpose: Async HAL traits
60embedded-hal-nb License: MIT OR Apache-2.0 Purpose: Non-blocking HAL traits
61embedded-io / embedded-io-async License: MIT OR Apache-2.0 Purpose: IO traits
62critical-section License: MIT OR Apache-2.0 Purpose: Critical-section abstraction
63heapless License: MIT OR Apache-2.0 Purpose: Fixed-capacity data structures
64paste License: MIT OR Apache-2.0 Purpose: Macro hygiene utility
65nb License: MIT OR Apache-2.0 Purpose: Non-blocking result type
66vcell License: MIT OR Apache-2.0 Purpose: Volatile cell (PAC dependency)
67
68defmt, defmt-rtt, rtt-target, panic-probe License: MIT OR Apache-2.0 Purpose: Optional (feature-gated) logging/panic crates
69
70Attribution notes
71- MCXA276 PAC is sourced as an external dependency (see Cargo.toml). SVD 25.06.00 already includes OS_EVENT and WAKETIMER0 interrupts (no local fixes).
72- Examples run from RAM using custom linker setup; see README.txt for platform-specific instructions.
73
74Compliance
75- This repository’s distributed source is covered by MIT (see License.txt). Where crates are pulled from crates.io, those crates retain their own licenses; the dual-license compatibility (MIT OR Apache-2.0) is standard in the Rust embedded ecosystem and is compatible with this project’s selected MIT distribution.
76
77
78