Skip to content

[board] Rename board.h/c to wolfHAL_board.h/c - #56

Open
AlexLanzano wants to merge 1 commit into
wolfSSL:mainfrom
AlexLanzano:board-rename
Open

[board] Rename board.h/c to wolfHAL_board.h/c#56
AlexLanzano wants to merge 1 commit into
wolfSSL:mainfrom
AlexLanzano:board-rename

Conversation

@AlexLanzano

@AlexLanzano AlexLanzano commented Aug 31, 2026

Copy link
Copy Markdown
Member

Right now wolfHAL requires the user to create and include a file named board.h to specify board specific configuration. However this name is very most likely going to cause file collision when used in other embedded projects.

This PR renames all this board.h file to wolfHAL_board.h as well as the board.c files as well to remove the odds of a collision

Below are the projects downstream affected by this change with a link to the PR addressing the change:
wolfBoot - wolfSSL/wolfBoot#881
wolfTPM - wolfSSL/wolfTPM#587
wolfip - wolfSSL/wolfip#166

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This pull request standardizes board and peripheral integration file naming by renaming board.h/cwolfHAL_board.h/c (and peripheral.h/cwolfHAL_peripheral.h/c) and updates call sites, build files, and documentation to match across wolfHAL, boards, tests, and examples.

Changes:

  • Update all in-repo includes from "board.h" to "wolfHAL_board.h" and from "peripheral.h" to "wolfHAL_peripheral.h" where applicable.
  • Rename board and peripheral implementation/header files and adjust board board.mk source lists accordingly.
  • Refresh documentation and internal scaffolding skills to reference the new filenames.

Reviewed changes

Copilot reviewed 130 out of 130 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
tests/watchdog/test_watchdog.c Update board header include to wolfHAL_board.h.
tests/uart/test_uart.c Update board header include to wolfHAL_board.h.
tests/timer/test_timer.c Update board header include to wolfHAL_board.h.
tests/spi/test_spi_loopback.c Update board header include to wolfHAL_board.h.
tests/sensor/imu/test_bmi270_sensor.c Update board/peripheral header includes to wolfHAL_* names.
tests/rng/test_rng.c Update board header include to wolfHAL_board.h.
tests/main.c Update board header include to wolfHAL_board.h.
tests/ipc/test_ipc.c Update board header include to wolfHAL_board.h.
tests/i2c/test_i2c.c Update board header include to wolfHAL_board.h.
tests/gpio/test_stm32wb_gpio.c Update board header include to wolfHAL_board.h.
tests/gpio/test_pic32cz_gpio.c Update board header include to wolfHAL_board.h.
tests/gpio/test_gpio.c Update board header include to wolfHAL_board.h.
tests/flash/test_stm32wb_flash.c Update board header include to wolfHAL_board.h.
tests/flash/test_flash.c Update board/peripheral header includes to wolfHAL_* names.
tests/eth/test_stm32n6_eth.c Update board header include to wolfHAL_board.h.
tests/eth/test_stm32h5_eth.c Update board header include to wolfHAL_board.h.
tests/eth/test_eth.c Update board header include to wolfHAL_board.h.
tests/crypto/test_sha256.c Update board header include to wolfHAL_board.h.
tests/crypto/test_sha224.c Update board header include to wolfHAL_board.h.
tests/crypto/test_sha1.c Update board header include to wolfHAL_board.h.
tests/crypto/test_pka.c Update board header include to wolfHAL_board.h.
tests/crypto/test_hmac_sha256.c Update board header include to wolfHAL_board.h.
tests/crypto/test_hmac_sha224.c Update board header include to wolfHAL_board.h.
tests/crypto/test_hmac_sha1.c Update board header include to wolfHAL_board.h.
tests/crypto/test_aes_gmac.c Update board header include to wolfHAL_board.h.
tests/crypto/test_aes_gcm.c Update board header include to wolfHAL_board.h.
tests/crypto/test_aes_ecb.c Update board header include to wolfHAL_board.h.
tests/crypto/test_aes_ctr.c Update board header include to wolfHAL_board.h.
tests/crypto/test_aes_ccm.c Update board header include to wolfHAL_board.h.
tests/crypto/test_aes_cbc.c Update board header include to wolfHAL_board.h.
tests/clock/test_stm32wb_clock.c Update board header include to wolfHAL_board.h.
tests/clock/test_pic32cz_clock.c Update board header include to wolfHAL_board.h.
tests/block/test_block.c Update board/peripheral header includes to wolfHAL_* names.
src/watchdog/stm32wb_wwdg.c Update board header include to wolfHAL_board.h.
src/watchdog/stm32wb_iwdg.c Update board header include to wolfHAL_board.h.
src/watchdog/stm32f0_wwdg.c Update board header include to wolfHAL_board.h.
src/uart/stm32wba_uart_dma.c Update conditional board header include to wolfHAL_board.h.
src/uart/stm32wb_uart.c Update conditional board header include to wolfHAL_board.h.
src/uart/stm32wb_uart_dma.c Update conditional board header include to wolfHAL_board.h.
src/uart/stm32f4_uart.c Update conditional board header include to wolfHAL_board.h.
src/uart/stm32f0_uart.c Update conditional board header include to wolfHAL_board.h.
src/uart/pic32cz_uart.c Update conditional board header include to wolfHAL_board.h.
src/timer/systick.c Update board header include to wolfHAL_board.h.
src/spi/stm32wb_spi.c Update conditional board header include to wolfHAL_board.h.
src/spi/stm32h5_spi.c Update conditional board header include to wolfHAL_board.h.
src/spi/stm32f4_spi.c Update conditional board header include to wolfHAL_board.h.
src/sensor/imu/bmi270_sensor.c Update conditional board header include to wolfHAL_board.h.
src/rng/stm32wba_rng.c Update board header include to wolfHAL_board.h.
src/rng/stm32wb0_rng.c Update board header include to wolfHAL_board.h.
src/rng/stm32wb_rng.c Update board header include to wolfHAL_board.h.
src/rng/stm32h5_rng.c Update board header include to wolfHAL_board.h.
src/irq/cortex_m4_nvic.c Update board header include to wolfHAL_board.h.
src/i2c/stm32wb_i2c.c Update conditional board header include to wolfHAL_board.h.
src/i2c/stm32l1_i2c.c Update conditional board header include to wolfHAL_board.h.
src/gpio/stm32wb0_gpio.c Update board header include to wolfHAL_board.h.
src/gpio/stm32wb_gpio.c Update board header include to wolfHAL_board.h.
src/gpio/pic32cz_gpio.c Update board header include to wolfHAL_board.h.
src/flash/stm32wba_flash.c Update board header include to wolfHAL_board.h.
src/flash/stm32wb0_flash.c Update board header include to wolfHAL_board.h.
src/flash/stm32wb_flash.c Update board header include to wolfHAL_board.h.
src/flash/stm32u5_flash.c Update board header include to wolfHAL_board.h.
src/flash/stm32l1_flash.c Update board header include to wolfHAL_board.h.
src/flash/stm32h5_flash.c Update board header include to wolfHAL_board.h.
src/flash/stm32f4_flash.c Update board header include to wolfHAL_board.h.
src/flash/stm32f0_flash.c Update board header include to wolfHAL_board.h.
src/flash/stm32c0_flash.c Update board header include to wolfHAL_board.h.
src/flash/spi_nor_flash.c Update conditional board header include to wolfHAL_board.h.
src/flash/pic32cz_flash.c Update board header include to wolfHAL_board.h.
src/eth/stm32n6_eth.c Update board header include to wolfHAL_board.h.
src/eth/stm32h5_eth.c Update board header include to wolfHAL_board.h and adjust adjacent comment text.
src/eth_phy/lan8742a_eth_phy.c Update board header include to wolfHAL_board.h.
src/dma/stm32wba_gpdma.c Update conditional board header include to wolfHAL_board.h.
src/dma/stm32wb_dma.c Update conditional board header include to wolfHAL_board.h.
src/crypto/stm32wba_hash.c Update board header include to wolfHAL_board.h.
src/crypto/stm32wb_pka.c Update board header include to wolfHAL_board.h.
src/crypto/stm32wb_aes.c Update board header include to wolfHAL_board.h.
src/crypto/stm32n6_cryp.c Update board header include to wolfHAL_board.h.
src/block/sdhc_spi_block.c Update conditional board header include to wolfHAL_board.h.
examples/blinky/main.c Update board header include to wolfHAL_board.h.
docs/writing_a_driver.md Update documentation references/examples to wolfHAL_board.h/c and wolfHAL_peripheral.h/c.
docs/getting_started.md Update project layout and code snippets to wolfHAL_board.h/c.
docs/adding_an_example.md Update example guidance to include wolfHAL_board.h.
docs/adding_a_test.md Update test guidance to include wolfHAL_board.h and rename references in narrative.
docs/adding_a_peripheral.md Update peripheral documentation to wolfHAL_peripheral.h/c and wolfHAL_board.h/c.
docs/adding_a_board.md Update board authoring documentation to wolfHAL_board.h/c and wolfHAL_peripheral.h.
boards/stm32wba55cg_nucleo/wolfHAL_board.h Rename header banner/guards to wolfHAL_board.h + WOLFHAL_BOARD_H.
boards/stm32wba55cg_nucleo/wolfHAL_board.c Update includes/comments to wolfHAL_board.h / wolfHAL_peripheral.h.
boards/stm32wba55cg_nucleo/board.mk Update board source list to compile wolfHAL_board.c.
boards/stm32wb55xx_nucleo/wolfHAL_board.h Rename header banner/guards to wolfHAL_board.h + WOLFHAL_BOARD_H.
boards/stm32wb55xx_nucleo/wolfHAL_board.c Update includes to wolfHAL_board.h / wolfHAL_peripheral.h.
boards/stm32wb55xx_nucleo/board.mk Update board source list to compile wolfHAL_board.c.
boards/stm32wb05kz_nucleo/wolfHAL_board.h Rename header banner/guards to wolfHAL_board.h + WOLFHAL_BOARD_H and adjust internal comments.
boards/stm32wb05kz_nucleo/wolfHAL_board.c Update includes to wolfHAL_board.h.
boards/stm32wb05kz_nucleo/board.mk Update board source list to compile wolfHAL_board.c.
boards/stm32u5a5zj_nucleo/wolfHAL_board.h Rename header banner/guards to wolfHAL_board.h + WOLFHAL_BOARD_H.
boards/stm32u5a5zj_nucleo/wolfHAL_board.c Update includes/comments to wolfHAL_board.h / wolfHAL_peripheral.h.
boards/stm32u5a5zj_nucleo/board.mk Update board source list to compile wolfHAL_board.c.
boards/stm32n657a0_nucleo/wolfHAL_board.h Rename header banner/guards to wolfHAL_board.h + WOLFHAL_BOARD_H and adjust internal comments.
boards/stm32n657a0_nucleo/wolfHAL_board.c Update includes/comments to wolfHAL_board.h / wolfHAL_peripheral.h.
boards/stm32n657a0_nucleo/board.mk Update board source list to compile wolfHAL_board.c.
boards/stm32l152re_nucleo/wolfHAL_board.h Rename header banner/guards to wolfHAL_board.h + WOLFHAL_BOARD_H.
boards/stm32l152re_nucleo/wolfHAL_board.c Update includes/comments to wolfHAL_board.h / wolfHAL_peripheral.h.
boards/stm32l152re_nucleo/board.mk Update board source list to compile wolfHAL_board.c.
boards/stm32h563zi_nucleo/wolfHAL_board.h Rename header banner/guards to wolfHAL_board.h + WOLFHAL_BOARD_H and adjust internal comments.
boards/stm32h563zi_nucleo/wolfHAL_board.c Update includes/comments to wolfHAL_board.h / wolfHAL_peripheral.h.
boards/stm32h563zi_nucleo/board.mk Update board source list to compile wolfHAL_board.c.
boards/stm32f411_blackpill/wolfHAL_board.h Rename header banner/guards to wolfHAL_board.h + WOLFHAL_BOARD_H and adjust internal comments.
boards/stm32f411_blackpill/wolfHAL_board.c Update includes/comments to wolfHAL_board.h / wolfHAL_peripheral.h.
boards/stm32f411_blackpill/board.mk Update board source list to compile wolfHAL_board.c.
boards/stm32f302r8_nucleo/wolfHAL_board.h Rename header banner/guards to wolfHAL_board.h + WOLFHAL_BOARD_H.
boards/stm32f302r8_nucleo/wolfHAL_board.c Update includes/comments to wolfHAL_board.h / wolfHAL_peripheral.h.
boards/stm32f302r8_nucleo/board.mk Update board source list to compile wolfHAL_board.c.
boards/stm32f091rc_nucleo/wolfHAL_board.h Rename header banner/guards to wolfHAL_board.h + WOLFHAL_BOARD_H.
boards/stm32f091rc_nucleo/wolfHAL_board.c Update includes/comments to wolfHAL_board.h / wolfHAL_peripheral.h.
boards/stm32f091rc_nucleo/board.mk Update board source list to compile wolfHAL_board.c.
boards/stm32c031_nucleo/wolfHAL_board.h Rename header banner/guards to wolfHAL_board.h + WOLFHAL_BOARD_H.
boards/stm32c031_nucleo/wolfHAL_board.c Update includes/comments to wolfHAL_board.h / wolfHAL_peripheral.h.
boards/stm32c031_nucleo/board.mk Update board source list to compile wolfHAL_board.c.
boards/README.md Update board directory documentation to wolfHAL_board.h/c.
boards/pic32cz_curiosity_ultra/wolfHAL_board.h Rename header banner/guards to wolfHAL_board.h + WOLFHAL_BOARD_H.
boards/pic32cz_curiosity_ultra/wolfHAL_board.c Update includes/comments to wolfHAL_board.h / wolfHAL_peripheral.h.
boards/pic32cz_curiosity_ultra/board.mk Update board source list to compile wolfHAL_board.c.
boards/peripheral/wolfHAL_peripheral.h Rename peripheral registry header banner/guards to wolfHAL_peripheral.h + WOLFHAL_PERIPHERAL_H.
boards/peripheral/wolfHAL_peripheral.c Update peripheral registry implementation to include wolfHAL_peripheral.h.
boards/peripheral/sensor/imu/bmi270.c Update board header include and narrative references to wolfHAL_board.h.
boards/peripheral/flash/spi_nor_w25q64.c Update board header include to wolfHAL_board.h.
boards/peripheral/board.mk Update peripheral build rules to compile wolfHAL_peripheral.c.
boards/peripheral/block/sdhc_spi_sdcard32gb.c Update board header include to wolfHAL_board.h.
.claude/skills/port-stm32-platform/SKILL.md Update skill documentation to reference wolfHAL_board.h/c and wolfHAL_peripheral.h/c.
.claude/skills/generate-driver-template/SKILL.md Update skill documentation to reference wolfHAL_board.h/c.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread docs/getting_started.md
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants