######################################
# RPP high-level library             #
######################################

This is the RPP high-level library. It is designed from the board user
perspective and exposes a simplified API to handle the board's peripheral
modules. It works on top of the DRV (RPP driver library). For advanced use,
configuration and low-level access of the board please refers to the DRV
library.

This library include functions for the following hardware modules:

    CATEGORY            NAME                                MNEMONIC
    ----------------------------------------------------------------

    Logic IO
                        Digital Input                       [DIN ]
                        Digital (Logic) Output              [LOUT]
                        Analog Input                        [AIN ]
                        Analog Output                       [AOUT]

    Power output
                        H-Bridge output                     [HBR ]
                        Power output (12V, 2A)              [MOUT]
                        High-Power output (12V, 10A)        [HOUT]

    Communication
                        CAN Bus                             [CAN ]
                        LIN (Local Interconnect Network)    [LIN ]
                        FlexRay                             [FR  ]
                        Serial Communication Interface      [SCI ]
                        Ethernet                            [ETH ]

    Logging
                        SD Card                             [SDC ]
                        SD-RAM                              [SDR ]


Library file layout:

    -> include/rpp/rpp.h

        Main library header file.

        To use this library just include this file and this file only. Also,
        before using any library function please call rpp_init() function for
        all hardware peripherals initialization.
        
        If you want only selected peripherals to be initialized, just include 
        base.h and rpp/<peripheral>.h and call rpp_<peripheral>_init()
        for each one <peripheral>, you want to initialize.


    -> include/rpp/rpp_{mnemonic}.h

        Header file for {mnemonic} module.

        This files includes function definitions, pin definitions, etc, specific
        to {mnemonic} module. This file has to be included if you want to use the
        peripheral.


    -> src/rpp/rpp_{mnemonic}.c

        Module implementation.

        Implementation of rpp_{mnemonic}.h's functions on top of the DRV
        library.


    -> src/rpp/rpp.c

        Implementation of library-wide functions.


    -> doc/doxygen.conf

        Configuration file for Doxygen code documentation generation tool.
        To generate HTML API documentation execute:

            doxygen doxygen.conf

        On Debian based systems install doxygen with:

            sudo apt-get install doxygen graphviz