README.md
1# Introduction
2
3The **hal_bouffalolab** is a set of register definitions for Bouffalo Lab SoC's.
4The HAL is organized following the directory structure detailed below.
5
6## Directory Structure
7
8The directory is composed by eight parts:
9```
10.
11├── common
12├── drivers
13├── include
14├── pinconfigs
15├── scripts
16├── zephyr
17├── LICENSE
18└── README.md
19```
20
21 - common
22 - drivers
23 - bl602_driver
24 - bl702_driver
25 - Includes specific for these platforms
26 - devicetree bindings
27 - [pin definitions](pinconfigs/README.md)
28 - [scripts](scripts/README.md) used for code generation
29 - ZephyrRTOS module directory (`zephyr`).
30 - The LICENSE file.
31 - This README file.
32
33# How to submit code
34
35Any contribution should follow the `How to submit code` using as premisses the
36[Zephyr Contribution Guidelines](https://docs.zephyrproject.org/latest/contribute/index.html).
37For more information about External Modules see
38[Modules Section](https://docs.zephyrproject.org/latest/develop/modules.html) in special
39[Submitting Changes to Modules](https://docs.zephyrproject.org/latest/develop/modules.html#submitting-changes-to-modules)
40
41
42## Repository specific guidelines
43
44 - This repository is managed mainly on Linux. This means that changes should
45 be submitted using Linux LF format. Usually running a similar command to
46 `find * type f -print0 | xargs -0 dos2unix -k` should be enough.
47 - Make sure directory structure is respected.
48 - Directory names should be converted to lowercase.
49 - The recommendation is add **all fixups** in the `hal_bouffalolab` instead
50 on the ZephyrRTOS project.
51
52The above are general guidelines and exceptions could happen. In this case, the
53exception should be addressed at review phase.
54
55## The standard API
56
57The BouffaloLab standard API define all information to access the SoC's
58peripherals. This library does not have namespaces and prefixes which easily
59results in name collision with ZephyrRTOS core and libraries. To avoid that
60situation, macros, enum values and function names should follow two general
61rules:
62
63 - Public API functions must be prefixed with `bflb_`.
64 - Public defines and enum values must be uppercase and prefixed with `BFLB_`.
65
