rpp/doc/rpp.txt

   1 ######################################
   2 # RPP high-level library             #
   3 ######################################
   4
   5 This is the RPP high-level library. It is designed from the board user
   6 perspective and exposes a simplified API to handle the board's peripheral
   7 modules. It works on top of the DRV (RPP driver library). For advanced use,
   8 configuration and low-level access of the board please refers to the DRV
   9 library.
  10
  11 This library include functions for the following hardware modules:
  12
  13     CATEGORY            NAME                                MNEMONIC
  14     ----------------------------------------------------------------
  15
  16     Logic IO
  17                         Digital Input                       [DIN ]
  18                         Digital (Logic) Output              [LOUT]
  19                         Analog Input                        [AIN ]
  20                         Analog Output                       [AOUT]
  21
  22     Power output
  23                         H-Bridge output                     [HBR ]
  24                         Power output (12V, 2A)              [MOUT]
  25                         High-Power output (12V, 10A)        [HOUT]
  26
  27     Communication
  28                         CAN Bus                             [CAN ]
  29                         LIN (Local Interconnect Network)    [LIN ]
  30                         FlexRay                             [FR  ]
  31                         Serial Communication Interface      [SCI ]
  32                         Ethernet                            [ETH ]
  33
  34     Logging
  35                         SD Card                             [SDC ]
  36                         SD-RAM                              [SDR ]
  37
  38
  39 Library file layout:
  40
  41     -> include/rpp/rpp.h
  42
  43         Main library header file.
  44
  45         To use this library just include this file and this file only. Also,
  46         before using any library function please call rpp_init() function for
  47         all hardware peripherals initialization.
  48
  49         If you want only selected peripherals to be initialized, just include
  50         base.h and rpp/<peripheral>.h and call rpp_<peripheral>_init()
  51         for each one <peripheral>, you want to initialize.
  52
  53
  54     -> include/rpp/rpp_{mnemonic}.h
  55
  56         Header file for {mnemonic} module.
  57
  58         This files includes function definitions, pin definitions, etc, specific
  59         to {mnemonic} module. This file has to be included if you want to use the
  60         peripheral.
  61
  62
  63     -> src/rpp/rpp_{mnemonic}.c
  64
  65         Module implementation.
  66
  67         Implementation of rpp_{mnemonic}.h's functions on top of the DRV
  68         library.
  69
  70
  71     -> src/rpp/rpp.c
  72
  73         Implementation of library-wide functions.
  74
  75
  76     -> doc/doxygen.conf
  77
  78         Configuration file for Doxygen code documentation generation tool.
  79         To generate HTML API documentation execute:
  80
  81             doxygen doxygen.conf
  82
  83         On Debian based systems install doxygen with:
  84
  85             sudo apt-get install doxygen graphviz
  86