le_bootReason_common.h

    1 
    2 /*
    3  * ====================== WARNING ======================
    4  *
    5  * THE CONTENTS OF THIS FILE HAVE BEEN AUTO-GENERATED.
    6  * DO NOT MODIFY IN ANY WAY.
    7  *
    8  * ====================== WARNING ======================
    9  */
   10 /**
   11  * @file le_bootReason_common.h
   12  *
   13  * Type definitions for le_bootReason.
   14  *
   15  */
   16 #ifndef LE_BOOTREASON_COMMON_H_INCLUDE_GUARD
   17 #define LE_BOOTREASON_COMMON_H_INCLUDE_GUARD
   18 
   19 
   20 #include "legato.h"
   21 
   22 #define IFGEN_LE_BOOTREASON_PROTOCOL_ID "2d79668511adea4d675f5d77b9f2d3ea"
   23 #define IFGEN_LE_BOOTREASON_MSG_SIZE 12
   24 /** @addtogroup le_bootReason
   25  *  @{ **/
   26 
   27 
   28 
   29 //--------------------------------------------------------------------------------------------------
   30 /**
   31  * Get if this client bound locally.
   32  */
   33 //--------------------------------------------------------------------------------------------------
   34 LE_SHARED bool ifgen_le_bootReason_HasLocalBinding
   35 (
   36     void
   37 );
   38 
   39 
   40 //--------------------------------------------------------------------------------------------------
   41 /**
   42  * Init data that is common across all threads
   43  */
   44 //--------------------------------------------------------------------------------------------------
   45 LE_SHARED void ifgen_le_bootReason_InitCommonData
   46 (
   47     void
   48 );
   49 
   50 
   51 //--------------------------------------------------------------------------------------------------
   52 /**
   53  * Perform common initialization and open a session
   54  */
   55 //--------------------------------------------------------------------------------------------------
   56 LE_SHARED le_result_t ifgen_le_bootReason_OpenSession
   57 (
   58     le_msg_SessionRef_t _ifgen_sessionRef,
   59     bool isBlocking
   60 );
   61 
   62 //--------------------------------------------------------------------------------------------------
   63 /**
   64  * Checks whether boot-reason was timer expiry.
   65  *
   66  * @return
   67  *      - TRUE if boot-reason was timer expiry.
   68  *      - FALSE otherwise.
   69  */
   70 //--------------------------------------------------------------------------------------------------
   71 LE_SHARED bool ifgen_le_bootReason_WasTimer
   72 (
   73     le_msg_SessionRef_t _ifgen_sessionRef
   74 );
   75 
   76 //--------------------------------------------------------------------------------------------------
   77 /**
   78  * Checks whether boot-reason was specific gpio change. GPIO number is specified in parameter.
   79  *
   80  * @return
   81  *      - TRUE if boot-reason was specified gpio change.
   82  *      - FALSE otherwise.
   83  *
   84  * @note The process exits if invalid gpio number is passed.  Check corresponding device documents
   85  * for valid list of gpio.
   86  */
   87 //--------------------------------------------------------------------------------------------------
   88 LE_SHARED bool ifgen_le_bootReason_WasGpio
   89 (
   90     le_msg_SessionRef_t _ifgen_sessionRef,
   91         uint32_t gpioNum
   92         ///< [IN] GPIO number.
   93 );
   94 
   95 //--------------------------------------------------------------------------------------------------
   96 /**
   97  * Checks whether boot reason was due to the specified ADC having a reading above or below the
   98  * configured limits.
   99  *
  100  * @return
  101  *      true if boot reason was due to the given ADC or false otherwise.
  102  *
  103  * @note
  104  *      The process exits if an invalid ADC number is passed. Check corresponding device documents
  105  *      for valid list of ADC numbers.
  106  */
  107 //--------------------------------------------------------------------------------------------------
  108 LE_SHARED bool ifgen_le_bootReason_WasAdc
  109 (
  110     le_msg_SessionRef_t _ifgen_sessionRef,
  111         uint32_t adcNum
  112         ///< [IN] ADC number
  113 );
  114 /** @} **/
  115 #endif // LE_BOOTREASON_COMMON_H_INCLUDE_GUARD
LE_SHARED
#define LE_SHARED
Definition: le_basics.h:300
le_result_t
le_result_t
Definition: le_basics.h:46
le_msg_SessionRef_t
struct le_msg_Session * le_msg_SessionRef_t
Definition: le_messaging.h:860
legato.h