HAL module request: hal_xhsc #86804
Description
Origin
Q:
Name of project hosting the original open source code:
A:
[zephyr_hc32_hal]
Q:
Provide a link to the source:
A:
https://github.com/levizh/zephyr_hc32_hal.git
Purpose
Q:
Brief description of what this software does:
A:
This software provides the Device Driver Layer (DDL) for Xiaohua Semiconductor's (XHSC) HC32F series SoCs.
Mode of integration
Q:
Describe whether you'd like to integrate this external component in the main tree or as a module, and why:
A:
As with other manufacturers' SoCs, we recommend creating a repo (hal_xhsc) that treats the DDL component as a separate module. This approach allows for better modularity and maintainability, as it isolates the hardware-specific code from the main Zephyr tree. It also makes it easier to update and maintain the HAL without affecting the core Zephyr code base.
Maintainership
Q:
List the person(s) that will be maintaining the integration of this external code for the foreseeable future:
A:
@levizh, maintainer, employee of XHSC
@Pengbiao12345, employee of XHSC
@ETRD, employee of XHSC
@greya5, employee of XHSC
@YangJP, employee of XHSC
@TrackingRobot, employee of XHSC
Pull Request
Q:
Pull request (if any) with the actual implementation of the integration:
A:
We will submit zephyr PR after our DDL repository (hal_xhsc) is created.
(Old PR using this HAL: #86693)
Description
Q:
What is its primary functionality (e.g., SQLLite is a lightweight
database)?
A:
Provides SoC modules' interfaces to directly manipulate XHSC SoCs hardware module registers.
For example, ADC_Init(), ADC_DeInit(), ...
Q:
What problem are you trying to solve? (e.g., a state store is
required to maintain ...)
A:
To provide hardware driver support for XHSC SoCs running Zephyr.
Q:
Why is this the right component to solve it (e.g., SQLite is small,
easy to use, and has a very liberal license.)
A:
This is the official driver library released to optimally match XHSC SoCs.
Dependencies
Q:
What other components does this package depend on?
A:
XHSC SoC DDL is developed independently and does not depend on other package.
Q:
Will the Zephyr project have a direct dependency on the component, or
will it be included via an abstraction layer with this component as a
replaceable implementation?
A:
The Zephyr project based on XHSC SoCs will have a direct dependency on this component. However, the DDL itself is designed to be modular, allowing for easy replacement or extension of specific hardware drivers if needed.
Revision
Q:
Version or SHA you would like to integrate initially
A:
We want to integrate the latest commit(fc37871336e48b57829a0fb529cd6885cffd6da5) from the repository(https://github.com/levizh/zephyr_hc32_hal.git).
License
Q:
Please use an SPDX identifier (https://spdx.org/licenses/), such as
BSD-3-Clause.
A:
Yes, our DDL is all open source and the source files almost always have SPDX.