# Platform Library User Guide

This release note is divided into the following sections:

- Software Overview
- Documentation
- Unit Test
- Re-compilation Procedures

## Software Overview

The platform library provides a common API across all supported platforms. Each platform in turn, will have a library that implements that API with respect to the specifics of the hardware.

- The Platform Library package is present in the pdk_ ####_#_##_##_##/packages/ti/platform/evm####/platform_lib directory

- The API header files are pdk_####_#_##_##_##/packages/ti/platform/platform.h and pdk_####_#_##_##_##/packages/ti/platform/resource_mgr.h and they require stdint.h as they use basic C99 data types.
- The library to be included is pdk_####_#_##_##_##/packages/ti/platform/evm####/platform_lib/lib/debug or release/ti.platform.evm####.ae66; Application needs to include the CSL library as well. If you use a RTSC project, you can include the CSL libraries in your CFG file by using the following statement: var Csl = xdc.useModule('ti.csl.Settings'); If your do not use a RTSC project, see the pdk_####_#_#_#_#/packages/ti/csl/lib directory for the list of libraries to include. You will need the *.ae66 for little endian and *.ae66e for big endian.
- The library is re-buildable as a CCSv5 project. Just import from the platform_lib directory as an existing CCS project.
- The unit test project is available in the platform_test directory which is at the same level as platform_lib.

back to top

## Documentation

- Platform Library API and detailed documentation: Doxygen output of Platform API

back to top

## Unit Test

- Platform Library unit test: The platform library comes with a project which runs basic unit tests on the APIs. This CCSv5 project can be opened from pdk_####_#_#_#_#/packages/ti/platform/evm####/platform_test. The unit test project (or application) can be controlled from a configuration file pdk_####_#_#_#_#/packages/ti/platform/evm####/platform_test/testconfig/platform_test_input.txt. The README.txt file present in provides more information on running the unit test.

back to top

## Re-compilation Procedures

The library package is pre-compiled at the time of release for Little Endian in both Debug and Release formats. You must re-build for Big Endian. To re-build you can import the CCSv5 projects into Code Composer 5.x.

back to top