picolibrary-microchip-megaavr

Usage

Table of Contents

1. Dependency
   1. Configuration Options
   2. avr-libcpp Configuration Requirements
   3. picolibrary Configuration Requirements
2. Development

Dependency

To use picolibrary-microchip-megaavr as a dependency, simply add the subdirectory containing the repository to a CMake build, and link with the picolibrary-microchip-megaavr static library.

add_subdirectory( picolibrary-microchip-megaavr )

target_link_libraries(
    foo
    picolibrary-microchip-megaavr
)

The picolibrary-microchip-megaavr static library does not include ::picolibrary::Microchip::megaAVR::version(). To use ::picolibrary::Microchip::megaAVR::version(), link with the picolibrary-microchip-megaavr-version static library.

target_link_libraries(
    foo
    picolibrary-microchip-megaavr
    picolibrary-microchip-megaavr-version
)

Configuration Options

picolibrary-microchip-megaavr supports the following project configuration options:

• PICOLIBRARY_MICROCHIP_MEGAAVR_ENABLE_INTERACTIVE_TESTING (defaults to OFF): enable interactive testing
  • The following project configuration options are available if PICOLIBRARY_MICROCHIP_MEGAAVR_ENABLE_INTERACTIVE_TESTING is ON:
    • PICOLIBRARY_MICROCHIP_MEGAAVR_TESTING_INTERACTIVE_LOG_USART (optional): ::picolibrary::Testing::Interactive::Microchip::megaAVR::Log USART (see include/picolibrary/testing/interactive/microchip/megaavr/log.h for more information)
    • PICOLIBRARY_MICROCHIP_MEGAAVR_TESTING_INTERACTIVE_LOG_USART_CLOCK_GENERATOR_OPERATING_SPEED (optional): ::picolibrary::Testing::Interactive::Microchip::megaAVR::Log USART clock generator operating speed (see include/picolibrary/testing/interactive/microchip/megaavr/log.h for more information)
    • PICOLIBRARY_MICROCHIP_MEGAAVR_TESTING_INTERACTIVE_LOG_USART_CLOCK_GENERATOR_SCALING_FACTOR (optional): ::picolibrary::Testing::Interactive::Microchip::megaAVR::Log USART clock generator scaling factor (see include/picolibrary/testing/interactive/microchip/megaavr/log.h for more information)
• PICOLIBRARY_MICROCHIP_MEGAAVR_USE_PARENT_PROJECT_AVRLIBCPP (defaults to ON): use parent project’s avr-libcpp
• PICOLIBRARY_MICROCHIP_MEGAAVR_USE_PARENT_PROJECT_PICOLIBRARY (defaults to ON): use parent project’s picolibrary

avr-libcpp Configuration Requirements

If PICOLIBRARY_MICROCHIP_MEGAAVR_USE_PARENT_PROJECT_AVRLIBCPP is ON, avr-libcpp must be configured as follows:

• AVRLIBCPP_SUPPRESS_SFR_MACROS must be ON

picolibrary Configuration Requirements

If PICOLIBRARY_MICROCHIP_MEGAAVR_USE_PARENT_PROJECT_PICOLIBRARY is ON, picolibrary must be configured as follows:

• PICOLIBRARY_HIL_INCLUDE_DIR must be set to the path to picolibrary-microchip-megaavr’s include/ directory
• PICOLIBRARY_ENABLE_AUTOMATED_TESTING must be OFF
• PICOLIBRARY_ENABLE_INTERACTIVE_TESTING must be ON if PICOLIBRARY_MICROCHIP_MEGAAVR_ENABLE_INTERACTIVE_TESTING is ON
• PICOLIBRARY_SUPPRESS_ASSERTION_FAILURE_LOCATION_INFORMATION must be ON

Development

The repository’s Git pre-commit hook script is the simplest way to configure, and build picolibrary-microchip-megaavr during development. See the pre-commit script’s help text for usage details.

./git/hooks/pre-commit --help

Additional checks, such as static analysis, are performed by the repository’s GitHub Actions CI workflow.

This site is open source. Improve this page.