feat: Add Zephyr module configuration and README
This commit introduces the necessary files to make the vnd7050aj driver a proper Zephyr RTOS 4.x module. - Adds to define the module's build configuration and DTS bindings. - Creates a comprehensive file with instructions on how to integrate and use the module in a Zephyr project. Signed-off-by: Eduard Iten <eduard@iten.pro>
This commit is contained in:
parent
601f90ef6e
commit
575c54a506
|
|
@ -0,0 +1,47 @@
|
|||
# Zephyr VND7050AJ Driver Module
|
||||
|
||||
This repository contains a Zephyr RTOS module for the STMicroelectronics VND7050AJ high-side driver.
|
||||
|
||||
## Module Structure
|
||||
|
||||
* `drivers/misc/vnd7050aj/`: Contains the C source code for the VND7050AJ driver.
|
||||
* `dts/bindings/misc/`: Contains the Devicetree binding for the VND7050AJ.
|
||||
* `include/zephyr/drivers/misc/vnd7050aj/`: Contains the public header file for the driver.
|
||||
* `zephyr/module.yml`: Defines this directory as a Zephyr module, specifying its build configuration and DTS bindings.
|
||||
|
||||
## How to Use This Module
|
||||
|
||||
To integrate this module into your Zephyr application, follow one of these methods:
|
||||
|
||||
### 1. Using West (Recommended for larger projects)
|
||||
|
||||
If your project uses West, add the following to your `west.yml` file:
|
||||
|
||||
```yaml
|
||||
# west.yml
|
||||
projects:
|
||||
- name: vnd7050aj_driver
|
||||
path: modules/vnd7050aj_driver # Or your preferred path
|
||||
url: <URL_TO_THIS_REPOSITORY> # Replace with the actual URL
|
||||
# For local development, you can use:
|
||||
# url: file:///path/to/your/local/vnd7050aj_driver
|
||||
```
|
||||
|
||||
After modifying `west.yml`, run `west update` in your project directory.
|
||||
|
||||
### 2. Placing the Module Directly in Your Project
|
||||
|
||||
Copy the entire `zephyr_vnd7050aj_driver` directory into the `modules` directory of your Zephyr application. For example, if your application is `my_app`, the path would be `my_app/modules/zephyr_vnd7050aj_driver`.
|
||||
|
||||
### Kconfig Configuration
|
||||
|
||||
After adding the module, ensure you enable the necessary Kconfig options in your project's `prj.conf` file:
|
||||
|
||||
```kconfig
|
||||
# prj.conf
|
||||
CONFIG_VND7050AJ=y
|
||||
```
|
||||
|
||||
## Contributing
|
||||
|
||||
Contributions are welcome! Please refer to the Zephyr Project's contribution guidelines for more information.
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
name: vnd7050aj_driver
|
||||
build:
|
||||
cmake: .
|
||||
kconfig: Kconfig
|
||||
settings:
|
||||
dts_root: .
|
||||
Loading…
Reference in New Issue