hal-rp2xxx (0.1.0)

A C++ RP2 hardware abstraction layer.*

Documentation

Generated

• By sphinx+breathe+exhale (What’s sphinx / breathe / exhale?)

Workflow

Install vmklib such that you can mk --version (a pip install vmklib to your desired Python environment is all that’s needed).

From a fresh checkout:

git submodule update --init
mk dz-sync
mk g

This should result in fully compiled code that you can now use or add to.

Generating Interfaces

Structs and enumerations can be defined for ifgen which can then generate C++ source code into the project.

Generating configurations based on an SVD file:

mk ifgen-svd-XMC4700

Generating code from an ifgen.yaml in the root directory of the project:

mk ifgen

Interface Documentation

• Library API
  • Class Hierarchy
  • File Hierarchy
  • Full API
    • Namespaces
    • Concepts
    • Classes and Structs
    • Functions
    • Variables
    • Defines
    • Typedefs

Indices

• Index

• Module Index

• Search Page