You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+38-2Lines changed: 38 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,41 @@
1
1
# NXP MCU Driver
2
2
3
-
This repository contains a copy of MCU peripheral library, original sources are obtained from `https://www.nxp.com`
3
+
This repository contains a trimmed-down version of NXP's MCUXpresso SDK peripheral drivers for use with MicroPython.
4
+
5
+
## Overview
6
+
7
+
This repository follows the structure of the official [NXP MCUX SDK](https://github.com/nxp-mcuxpresso/mcux-sdk) but includes only the driver files needed for supported target chips, reducing the size from approximately 1.6GB to under 100MB.
8
+
9
+
The repository is designed to be included as a Git submodule in projects like [MicroPython](https://github.com/micropython/micropython) that target i.MX RT and other NXP MCU families.
10
+
11
+
## Updating to Newer SDK Versions
12
+
13
+
The `update_sdk.py` script automates updating driver files from the official NXP MCUX SDK releases:
14
+
15
+
```bash
16
+
# Update to the latest SDK release
17
+
./update_sdk.py
18
+
19
+
# Update to a specific release tag
20
+
./update_sdk.py --release MCUX_2.16.0
21
+
```
22
+
23
+
The script downloads the specified SDK release, updates existing target chip drivers, and commits the changes to a new branch.
24
+
25
+
## Adding Support for New Chips
26
+
27
+
To add a new target chip:
28
+
29
+
1. Create an empty folder with the chip name in `sdk/devices/`
30
+
2. Run `./update_sdk.py` to populate it with drivers from the latest SDK
31
+
32
+
The automation tool will detect the new target and include it in future updates.
33
+
34
+
## Current SDK Version
35
+
36
+
The current SDK version is stored in `sdk/version.txt`.
37
+
38
+
## History
39
+
40
+
This repository was originally maintained at [hathach/nxp_driver](https://github.com/hathach/nxp_driver) as part of the TinyUSB project. When TinyUSB migrated to using the official NXP SDK directly, this trimmed version was forked to the MicroPython organization to continue serving projects requiring a smaller dependency footprint.
4
41
5
-
This repository is meant to be included as submodule and conveniently run [Tinyusb](https://github.com/hathach/tinyusb) examples.
0 commit comments