peripheral-driver

Original：🇨🇳 Chinese

Translated

1 scripts

Used when developing BSP drivers for external devices (sensors, memory, displays, etc.). Provides open-source driver search strategies, quality assessment, code adaptation tools, and key points for common device adaptation.

3installs

Sourceleokemp223/embed-ai-tool

Added on2026-05-16

NPX Install

npx skill4agent add leokemp223/embed-ai-tool peripheral-driver

SKILL.md Content (Chinese)

View Translation Comparison →

Peripheral Driver Development (Based on Open-Source Library Adaptation)

Applicable Scenarios

Need to develop BSP drivers for external devices (AT24C02, MPU6050, SSD1306, etc.).
Want to find mature open-source driver libraries and adapt them to the project's BSP architecture.
Have existing open-source driver code that needs renaming, organizing, and HAL handle injection to comply with project specifications.
The device is relatively simple, no open-source library is needed, and BSP skeleton files need to be generated to get started quickly.

Required Inputs

Target device name (e.g.,
```
AT24C02
```
,
```
MPU6050
```
).
Communication bus type (I2C / SPI / UART / 1-Wire / GPIO).
HAL handle name (e.g.,
```
hi2c1
```
,
```
hspi2
```
), typically from code generated by CubeMX.
Optional: Device I2C address, path to the downloaded open-source driver directory.

Automatic Detection

The script's
```
--scan
```
mode automatically analyzes C/H files in the input directory to identify function signatures, HAL call patterns, naming conventions, and include dependencies.
The
```
--list-devices
```
mode lists the devices recorded in
```
device-adaptation.md
```
and recommended libraries.
If the target device is recorded in
```
device-adaptation.md
```
, directly provide the recommended library and adaptation key points.

Execution Steps

Confirm the target device and bus type. If the device is recorded in references/device-adaptation.md, directly refer to the recommended library and adaptation key points.
Read references/search-and-evaluate.md, and search for candidate open-source driver libraries on GitHub/Gitee according to the search strategy.
Score the candidate libraries according to the evaluation checklist and select the most suitable one. If no suitable library is found, skip to step 6.
Download the selected open-source library code to a local temporary directory.
Run
```
--scan
```
to analyze the open-source code and view the adaptation suggestion report:
bash
```
python3 scripts/bsp_adapter.py --scan ./downloaded_driver/
```

Perform adaptation (choose one of the two):

With open-source library: Run

--adapt

to adapt the code to BSP specifications:

bash

python3 scripts/bsp_adapter.py \
  --adapt ./downloaded_driver/ \
  --device <device_name> --handle <hal_handle> \
  --output ./Hardware/bsp_<device>/

No suitable library: Run

--scaffold

to generate BSP skeleton files:

bash

python3 scripts/bsp_adapter.py \
  --scaffold --device <device_name> --bus <bus_type> \
  --handle <hal_handle> --addr <i2c_addr> \
  --output ./Hardware/bsp_<device>/

Integrate the generated BSP files into the USER CODE area of
```
main.c
```
, referring to the integration guide output by the script.
Compile and verify, then hand over to the
```
build-*
```
skill.

For best practices in driver architecture design and implementation, refer to stm32-hal-development/references/peripheral-driver-guide.md.

Failure Diversion

When no available open-source driver libraries can be found, use
```
--scaffold
```
to generate a skeleton and prompt the user to manually implement it by referring to the specification sheet.
When the open-source library uses bare register operations or non-STM32 platform APIs, return
```
project-config-error
```
and suggest manually adapting the communication layer.
When the open-source library has a GPL license or no license, remind the user of license risks and suggest finding an alternative library or implementing it independently.
When compilation fails after adaptation, hand it over to the
```
build-*
```
skill to handle build errors.

Platform Description

The built-in script uses Python standard libraries (
```
os
```
,
```
re
```
,
```
pathlib
```
,
```
argparse
```
) with no additional dependencies.
The generated C code complies with STM32 HAL BSP specifications and is compatible with GCC, IAR, and Keil toolchains.
Path formats follow platform-compatibility.md.

Output Conventions

```
--scan
```
outputs an adaptation suggestion report: detected functions, HAL calls, naming conventions, and adaptation difficulty assessment.
```
--adapt
```
outputs the adapted BSP files and
```
main.c
```
integration guide.
```
--scaffold
```
outputs skeleton files that comply with BSP template specifications.
```
--list-devices
```
outputs the recommended libraries and adaptation difficulty for recorded devices.
Detailed usage of all modes can be found in references/usage.md.

Handover Relationships

Upstream:
```
stm32-hal-development
```
(provides methodology and BSP templates).
Downstream:
```
build-cmake
```
,
```
build-iar
```
,
```
build-keil
```
(compilation and verification).