README.md

# Arm Corstone-3xx Platform CMSIS-Driver Based Board Support Package

## Overview 

Board support package (BSP) library for Corstone-3xx family of target platforms
implemented using the [CMSIS-Driver][cmsis-driver-documentation] software API.

Supported target platforms:
* [Corstone-300][corstone-300-documentation]

## Build System

The project uses [CMake][cmake-documentation] as its default build system.

## Selecting the target platform

You first need to select the supported target platform for which you want to use the BSP. 

This is done by setting the `ARM_CORSTONE_BSP_TARGET_PLATFORM` CMake variable to the desired value. See the table below for all supported platforms:

| Platform      | ARM_CORSTONE_BSP_TARGET_PLATFORM |
| ----------- | ----------- |
| Corstone-300      | `corstone300`       |

We recommend you pass this variable in the command line at CMake build configuration time by adding `-DARM_CORSTONE_BSP_TARGET_PLATFORM=<target_platform>` where `<target_platform>` is one of the supported values mentioned in the table above.

!!! example

    ```sh
    cmake -B __build -DARM_CORSTONE_BSP_TARGET_PLATFORM=corstone300
    ```

## Linking with other projects
As a CMake based project, we provide CMake target libraries for each supported
target platforms to integrate the BSP with any other project that also support CMake.

Follow the steps below to link the BSP with your project:
* Add the project root directory as a subdirectory to your CMake build:
    ```cmake
    add_subdirectory(arm-corstone-platform-bsp)
    ```
* Link your CMake target (executable or library) with the `target-corstone300` CMake target.

    !!! example

        ```cmake
        target_link_libraries(<your_cmake_target> PRIVATE target-corstone300)
        ```
    Where <your_cmake_target> is the name of the CMake target you want to link the BSP library with.

[cmsis-driver-documentation]: https://www.keil.com/pack/doc/CMSIS/Driver/html/index.html
[corstone-300-documentation]: https://developer.arm.com/Processors/Corstone-300
[cmake-documentation]: https://cmake.org/documentation/