rpp/include/rpp/rpp.h

   1 /**
   2  * RPP API library header file.
   3  *
   4  * @file rpp.h
   5  *
   6  * @copyright Copyright (C) 2013, 2014 Czech Technical University in Prague
   7  *
   8  * @author Carlos Jenkins <carlos@jenkins.co.cr>
   9  */
  10
  11
  12 #ifndef __RPP_RPP_H
  13 #define __RPP_RPP_H
  14
  15 /* Base includes */
  16 #include "base.h"
  17
  18 /* Include modules */
  19 #include "rpp/adc.h"
  20 #include "rpp/can.h"
  21 #include "rpp/sci.h"
  22 #ifdef FREERTOS_POSIX
  23 #include "rpp/sci_posix.h"
  24 #endif
  25
  26 /* Library main functions */
  27
  28 /**
  29  * Library initialization function.
  30  *
  31  * This is a convenience function, that initializes all peripherals.
  32  * If the application does not use all the peripherals it is better to
  33  * call directly the rpp_<periph>_init() functions for the used
  34  * peripherals as the resulting binary will be smaller.
  35  *
  36  * @return SUCCESS if initialization successful.\n
  37  *          FAILURE is library was already initialized.
  38  */
  39 int8_t rpp_init();
  40
  41 #endif /* __RPP_RPP_H */