Skip to content

Latest commit

 

History

History
67 lines (54 loc) · 2.73 KB

README.md

File metadata and controls

67 lines (54 loc) · 2.73 KB
Raw

Introduction

The hal_microchip is a set of register definitions for Microchip PIC32C/PIC32M SoC's. The HAL is organized following the directory structure detailed below.

Directory Structure

The directory is composed by six parts:

.
├── pic32c
├── include
├── pinconfigs
├── README.md
├── scripts
└── zephyr
  • PIC32C SoC specific include libraries.
  • Includes specific for these platforms
    • devicetree bindings
  • Pin definitions
  • Scripts used for code generation
  • ZephyrRTOS module directory (zephyr).
  • This README file.

How to submit code

Any contribution should follow the How to submit code using as premisses the Zephyr Contribution Guidelines. For more information about External Modules see Modules Section in special Submitting Changes to Modules

Repository specific guidelines

  • When submitting an updated firmware library version, it is important to make sure that the last firmware version will be merged. The library version is used to be checked at Microchip packs download site.
  • When submitting an updated firmware library version the patchset already applied should be rebased on top of the newer version.
  • The patchset must be sent as an individual commit per SoC series to easy rebase.
  • This repository is managed mainly on Linux. This means that changes should be submitted using Linux LF format. Usually running a similar command to find * type f -print0 | xargs -0 dos2unix -k should be enough.
  • Make sure directory structure is respected.
  • The pic32c/[pic32cxsg]/include/<soc>/README file should be updated accordingly. If for some reason the file not exists it should be created.
  • Directory names should be converted to lowercase.
  • The recommendation is add all fixups in the hal_microchip instead on the ZephyrRTOS project.

The above are general guidelines and exceptions could happen. In this case, the exception should be addressed at review phase.

The standard API

The PIC32C/PIC32M standard API define all information to access Microchip SoC's peripherals. This library does not have namespaces and prefixes which easily results in name collision with ZephyrRTOS core and libraries. To avoid that situation, macros, enum values and function names should follow two general rules:

  • Public API functions must be prefixed with pic32cxsg_ or .
  • Public defines and enum values must be uppercase and prefixed with PIC32CXSG_ or .