le_riPin_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_riPin_common.h
   12  *
   13  * Type definitions for le_riPin.
   14  *
   15  */
   16 #ifndef LE_RIPIN_COMMON_H_INCLUDE_GUARD
   17 #define LE_RIPIN_COMMON_H_INCLUDE_GUARD
   18 
   19 
   20 #include "legato.h"
   21 
   22 #define IFGEN_LE_RIPIN_PROTOCOL_ID "aafbc3c57eec1350fdae5eb6fe083e5a"
   23 #define IFGEN_LE_RIPIN_MSG_SIZE 13
   24 /** @addtogroup le_riPin
   25  *  @{ **/
   26 
   27 
   28 
   29 //--------------------------------------------------------------------------------------------------
   30 /**
   31  * Get if this client bound locally.
   32  */
   33 //--------------------------------------------------------------------------------------------------
   34 LE_SHARED bool ifgen_le_riPin_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_riPin_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_riPin_OpenSession
   57 (
   58     le_msg_SessionRef_t _ifgen_sessionRef,
   59     bool isBlocking
   60 );
   61 
   62 //--------------------------------------------------------------------------------------------------
   63 /**
   64  * Check whether the application core is the current owner of the Ring Indicator signal.
   65  *
   66  * @return
   67  *      - LE_OK              The function succeeded.
   68  *      - LE_FAULT           The function failed.
   69  *      - LE_BAD_PARAMETER   Bad input parameter.
   70  */
   71 //--------------------------------------------------------------------------------------------------
   72 LE_SHARED le_result_t ifgen_le_riPin_AmIOwnerOfRingSignal
   73 (
   74     le_msg_SessionRef_t _ifgen_sessionRef,
   75         bool* amIOwnerPtr
   76         ///< [OUT] true when application core is the owner of the Ring Indicator signal,
   77 );
   78 
   79 //--------------------------------------------------------------------------------------------------
   80 /**
   81  * Take control of the Ring Indicator signal.
   82  *
   83  * @return
   84  *      - LE_OK           The function succeeded.
   85  *      - LE_FAULT        The function failed.
   86  *      - LE_UNSUPPORTED  The platform does not support this operation.
   87  */
   88 //--------------------------------------------------------------------------------------------------
   89 LE_SHARED le_result_t ifgen_le_riPin_TakeRingSignal
   90 (
   91     le_msg_SessionRef_t _ifgen_sessionRef
   92 );
   93 
   94 //--------------------------------------------------------------------------------------------------
   95 /**
   96  * Release control of the Ring Indicator signal.
   97  *
   98  * @return
   99  *      - LE_OK           The function succeeded.
  100  *      - LE_FAULT        The function failed.
  101  *      - LE_UNSUPPORTED  The platform does not support this operation.
  102  */
  103 //--------------------------------------------------------------------------------------------------
  104 LE_SHARED le_result_t ifgen_le_riPin_ReleaseRingSignal
  105 (
  106     le_msg_SessionRef_t _ifgen_sessionRef
  107 );
  108 
  109 //--------------------------------------------------------------------------------------------------
  110 /**
  111  * Set the Ring Indicator signal to high for configurable duration of time before lowering it.
  112  *
  113  */
  114 //--------------------------------------------------------------------------------------------------
  115 LE_SHARED void ifgen_le_riPin_PulseRingSignal
  116 (
  117     le_msg_SessionRef_t _ifgen_sessionRef,
  118         uint32_t duration
  119         ///< [IN] [IN] Duration in ms
  120 );
  121 /** @} **/
  122 #endif // LE_RIPIN_COMMON_H_INCLUDE_GUARD
LE_SHARED
#define LE_SHARED
Definition: le_basics.h:287
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