le_riPin_interface.h

Go to the documentation of this file.
    1 /*
    2  * ====================== WARNING ======================
    3  *
    4  * THE CONTENTS OF THIS FILE HAVE BEEN AUTO-GENERATED.
    5  * DO NOT MODIFY IN ANY WAY.
    6  *
    7  * ====================== WARNING ======================
    8  */
    9 
   10 /**
   11  * @page c_riPin Ring Indicator Signal
   12  *
   13  * @ref le_riPin_interface.h "API Reference"
   14  *
   15  * <HR>
   16  *
   17  * The Ring Indicator pin is used to allow the module to wake up a host device.
   18  *
   19  * @section c_riPin_binding IPC interfaces binding
   20  *
   21  * All the functions of this API are provided by the @b modemService app.
   22  *
   23  * Here's a code sample binding to modem services:
   24  * @verbatim
   25    bindings:
   26    {
   27       clientExe.clientComponent.le_riPin -> modemService.le_riPin
   28    }
   29    @endverbatim
   30  *
   31  * @section c_riPin_usage Ring Indication signal
   32  *
   33  *
   34  * The RING pin can be configured to notify a host device with different timing of pulse signals for
   35  * different module activities.
   36  *
   37  * - le_riPin_AmIOwnerOfRingSignal() function checks whether the application core is the current
   38  *   owner of the Ring Indicator signal.
   39  * - le_riPin_TakeRingSignal() function takes control of the Ring Indicator signal.
   40  * - le_riPin_ReleaseRingSignal() function releases control of the Ring Indicator signal.
   41  *
   42  * - le_riPin_PulseRingSignal() function sets the ring signal high for configurable duration of time
   43  *   before lowering it.
   44  *
   45  * <HR>
   46  *
   47  * Copyright (C) Sierra Wireless Inc. Use of this work is subject to license.
   48  */
   49 /**
   50  * @file le_riPin_interface.h
   51  *
   52  * Legato @ref c_riPin include file.
   53  *
   54  * Copyright (C) Sierra Wireless Inc. Use of this work is subject to license.
   55  */
   56 
   57 #ifndef LE_RIPIN_INTERFACE_H_INCLUDE_GUARD
   58 #define LE_RIPIN_INTERFACE_H_INCLUDE_GUARD
   59 
   60 
   61 #include "legato.h"
   62 
   63 //--------------------------------------------------------------------------------------------------
   64 /**
   65  *
   66  * Connect the current client thread to the service providing this API. Block until the service is
   67  * available.
   68  *
   69  * For each thread that wants to use this API, either ConnectService or TryConnectService must be
   70  * called before any other functions in this API.  Normally, ConnectService is automatically called
   71  * for the main thread, but not for any other thread. For details, see @ref apiFilesC_client.
   72  *
   73  * This function is created automatically.
   74  */
   75 //--------------------------------------------------------------------------------------------------
   76 void le_riPin_ConnectService
   77 (
   78     void
   79 );
   80 
   81 //--------------------------------------------------------------------------------------------------
   82 /**
   83  *
   84  * Try to connect the current client thread to the service providing this API. Return with an error
   85  * if the service is not available.
   86  *
   87  * For each thread that wants to use this API, either ConnectService or TryConnectService must be
   88  * called before any other functions in this API.  Normally, ConnectService is automatically called
   89  * for the main thread, but not for any other thread. For details, see @ref apiFilesC_client.
   90  *
   91  * This function is created automatically.
   92  *
   93  * @return
   94  *  - LE_OK if the client connected successfully to the service.
   95  *  - LE_UNAVAILABLE if the server is not currently offering the service to which the client is bound.
   96  *  - LE_NOT_PERMITTED if the client interface is not bound to any service (doesn't have a binding).
   97  *  - LE_COMM_ERROR if the Service Directory cannot be reached.
   98  */
   99 //--------------------------------------------------------------------------------------------------
  100 le_result_t le_riPin_TryConnectService
  101 (
  102     void
  103 );
  104 
  105 //--------------------------------------------------------------------------------------------------
  106 /**
  107  *
  108  * Disconnect the current client thread from the service providing this API.
  109  *
  110  * Normally, this function doesn't need to be called. After this function is called, there's no
  111  * longer a connection to the service, and the functions in this API can't be used. For details, see
  112  * @ref apiFilesC_client.
  113  *
  114  * This function is created automatically.
  115  */
  116 //--------------------------------------------------------------------------------------------------
  117 void le_riPin_DisconnectService
  118 (
  119     void
  120 );
  121 
  122 //--------------------------------------------------------------------------------------------------
  123 /**
  124  * Check whether the application core is the current owner of the Ring Indicator signal.
  125  *
  126  * @return
  127  *      - LE_OK     The function succeeded.
  128  *      - LE_FAULT  The function failed.
  129  */
  130 //--------------------------------------------------------------------------------------------------
  131 le_result_t le_riPin_AmIOwnerOfRingSignal
  132 (
  133     bool* amIOwnerPtr
  134         ///< [OUT] true when application core is the owner of the Ring Indicator signal,
  135 );
  136 
  137 //--------------------------------------------------------------------------------------------------
  138 /**
  139  * Take control of the Ring Indicator signal.
  140  *
  141  * @return
  142  *      - LE_OK     Function succeeded.
  143  *      - LE_FAULT  Function failed.
  144  */
  145 //--------------------------------------------------------------------------------------------------
  146 le_result_t le_riPin_TakeRingSignal
  147 (
  148     void
  149 );
  150 
  151 //--------------------------------------------------------------------------------------------------
  152 /**
  153  * Release control of the Ring Indicator signal.
  154  *
  155  * @return
  156  *      - LE_OK     Function succeeded.
  157  *      - LE_FAULT  Function failed.
  158  */
  159 //--------------------------------------------------------------------------------------------------
  160 le_result_t le_riPin_ReleaseRingSignal
  161 (
  162     void
  163 );
  164 
  165 //--------------------------------------------------------------------------------------------------
  166 /**
  167  * Set the Ring Indicator signal to high for configurable duration of time before lowering it.
  168  *
  169  */
  170 //--------------------------------------------------------------------------------------------------
  171 void le_riPin_PulseRingSignal
  172 (
  173     uint32_t duration
  174         ///< [IN] [IN] Duration in ms
  175 );
  176 
  177 
  178 #endif // LE_RIPIN_INTERFACE_H_INCLUDE_GUARD
  179 
le_riPin_AmIOwnerOfRingSignal
le_result_t le_riPin_AmIOwnerOfRingSignal(bool *amIOwnerPtr)


le_result_t
le_result_t
Definition: le_basics.h:35


le_riPin_PulseRingSignal
void le_riPin_PulseRingSignal(uint32_t duration)


le_riPin_TakeRingSignal
le_result_t le_riPin_TakeRingSignal(void)


le_riPin_DisconnectService
void le_riPin_DisconnectService(void)



le_riPin_ConnectService
void le_riPin_ConnectService(void)


le_riPin_ReleaseRingSignal
le_result_t le_riPin_ReleaseRingSignal(void)


le_riPin_TryConnectService
le_result_t le_riPin_TryConnectService(void)