eive-obsw/gomspace/libcsp/INSTALL.rst
2020-11-23 11:42:22 +01:00

31 lines
1.1 KiB
ReStructuredText

How to install LibCSP
=====================
CSP uses the `waf` build system (http://code.google.com/p/waf/). In order to
compile CSP, you first need to configure the toolchain, what operating system
to compile for, the location of required libraries and whether to enable
certain optional features.
To configure CSP to build with the AVR32 toolchain for FreeRTOS and output
the compiled libcsp.a and header files to the install directory, issue:
.. code-block:: bash
./waf configure --toolchain=avr32- --with-os=freertos --prefix=install
When compiling for FreeRTOS, the path to the FreeRTOS header files must be
specified with `--with-freertos=PATH.`
A number of optional features can be enabled by from the configure script.
Support for XTEA encryption can e.g. be enabled with `--enable-xtea`. Run
`./waf configure --help` to list the available configure options.
The CAN drivers can be enabled by appending the configure option `--with-driver-can=CHIP`,
where CHIP is one of 'socketcan', 'at91sam7a1', 'at91sam7a3' or 'at90can128'.
To build and copy the library to the location specified with --prefix, use:
.. code-block:: bash
./waf build install