le_lpt_common.h - Legato Docs

Go to the documentation of this file.
    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_lpt_common.h
   12  *
   13  * Type definitions for le_lpt.
   14  *
   15  */
   16 #ifndef LE_LPT_COMMON_H_INCLUDE_GUARD
   17 #define LE_LPT_COMMON_H_INCLUDE_GUARD
   18 
   19 
   20 #include "legato.h"
   21 
   22 #define IFGEN_LE_LPT_PROTOCOL_ID "ddfabab9b938cdcb7564dbd7632f76bc"
   23 #define IFGEN_LE_LPT_MSG_SIZE 18
   24 /** @addtogroup le_lpt
   25  *  @{ **/
   26 
   27 
   28 //--------------------------------------------------------------------------------------------------
   29 /**
   30  * eDRX Radio Access Technology enum
   31  */
   32 //--------------------------------------------------------------------------------------------------
   33 typedef enum
   34 {
   35     LE_LPT_EDRX_RAT_UNKNOWN = 0,
   36         ///< Unknown
   37     LE_LPT_EDRX_RAT_EC_GSM_IOT = 1,
   38         ///< EC-GSM-IoT (A/Gb mode)
   39     LE_LPT_EDRX_RAT_GSM = 2,
   40         ///< GSM (A/Gb mode)
   41     LE_LPT_EDRX_RAT_UTRAN = 3,
   42         ///< UTRAN (Iu mode)
   43     LE_LPT_EDRX_RAT_LTE_M1 = 4,
   44         ///< E-UTRAN (WB-S1 mode)
   45     LE_LPT_EDRX_RAT_LTE_NB1 = 5,
   46         ///< E-UTRAN (NB-S1 mode)
   47     LE_LPT_EDRX_RAT_MAX = 6
   48         ///< Invalid
   49 }
   50 le_lpt_EDrxRat_t;
   51 
   52 
   53 //--------------------------------------------------------------------------------------------------
   54 /**
   55  * Reference type used by Add/Remove functions for EVENT 'le_lpt_EDrxParamsChange'
   56  */
   57 //--------------------------------------------------------------------------------------------------
   58 typedef struct le_lpt_EDrxParamsChangeHandler* le_lpt_EDrxParamsChangeHandlerRef_t;
   59 
   60 
   61 //--------------------------------------------------------------------------------------------------
   62 /**
   63  * Handler to report a change in the network-provided eDRX parameters.
   64  */
   65 //--------------------------------------------------------------------------------------------------
   66 typedef void (*le_lpt_EDrxParamsChangeHandlerFunc_t)
   67 (
   68         le_lpt_EDrxRat_t rat,
   69         ///< Radio Access Technology.
   70         le_onoff_t activation,
   71         ///< eDRX activation state.
   72         uint8_t eDrxValue,
   73         ///< eDRX cycle value, defined in 3GPP
   74         ///< TS 24.008 Rel-13 section 10.5.5.32.
   75         uint8_t pagingTimeWindow,
   76         ///< Paging Time Window, defined in 3GPP
   77         ///< TS 24.008 Rel-13 section 10.5.5.32.
   78         void* contextPtr
   79         ///<
   80 );
   81 
   82 
   83 //--------------------------------------------------------------------------------------------------
   84 /**
   85  * Get if this client bound locally.
   86  */
   87 //--------------------------------------------------------------------------------------------------
   88 LE_SHARED bool ifgen_le_lpt_HasLocalBinding
   89 (
   90     void
   91 );
   92 
   93 
   94 //--------------------------------------------------------------------------------------------------
   95 /**
   96  * Init data that is common across all threads
   97  */
   98 //--------------------------------------------------------------------------------------------------
   99 LE_SHARED void ifgen_le_lpt_InitCommonData
  100 (
  101     void
  102 );
  103 
  104 
  105 //--------------------------------------------------------------------------------------------------
  106 /**
  107  * Perform common initialization and open a session
  108  */
  109 //--------------------------------------------------------------------------------------------------
  110 LE_SHARED le_result_t ifgen_le_lpt_OpenSession
  111 (
  112     le_msg_SessionRef_t _ifgen_sessionRef,
  113     bool isBlocking
  114 );
  115 
  116 //--------------------------------------------------------------------------------------------------
  117 /**
  118  * Set the eDRX activation state for the given Radio Access Technology.
  119  *
  120  * @return
  121  *  - LE_OK             The function succeeded.
  122  *  - LE_BAD_PARAMETER  A parameter is invalid.
  123  *  - LE_UNSUPPORTED    eDRX is not supported by the platform.
  124  *  - LE_FAULT          The function failed.
  125  */
  126 //--------------------------------------------------------------------------------------------------
  127 LE_SHARED le_result_t ifgen_le_lpt_SetEDrxState
  128 (
  129     le_msg_SessionRef_t _ifgen_sessionRef,
  130         le_lpt_EDrxRat_t rat,
  131         ///< [IN] Radio Access Technology.
  132         le_onoff_t activation
  133         ///< [IN] eDRX activation state.
  134 );
  135 
  136 //--------------------------------------------------------------------------------------------------
  137 /**
  138  * Set the requested eDRX cycle value for the given Radio Access Technology.
  139  * The eDRX cycle value is defined in 3GPP TS 24.008 Release 13 section 10.5.5.32.
  140  *
  141  * @return
  142  *  - LE_OK             The function succeeded.
  143  *  - LE_BAD_PARAMETER  A parameter is invalid.
  144  *  - LE_UNSUPPORTED    eDRX is not supported by the platform.
  145  *  - LE_FAULT          The function failed.
  146  */
  147 //--------------------------------------------------------------------------------------------------
  148 LE_SHARED le_result_t ifgen_le_lpt_SetRequestedEDrxValue
  149 (
  150     le_msg_SessionRef_t _ifgen_sessionRef,
  151         le_lpt_EDrxRat_t rat,
  152         ///< [IN] Radio Access Technology.
  153         uint8_t eDrxValue
  154         ///< [IN] Requested eDRX cycle value, defined in 3GPP
  155         ///< TS 24.008 Rel-13 section 10.5.5.32.
  156 );
  157 
  158 //--------------------------------------------------------------------------------------------------
  159 /**
  160  * Get the requested eDRX cycle value for the given Radio Access Technology.
  161  * The eDRX cycle value is defined in 3GPP TS 24.008 Release 13 section 10.5.5.32.
  162  *
  163  * @return
  164  *  - LE_OK             The function succeeded.
  165  *  - LE_BAD_PARAMETER  A parameter is invalid.
  166  *  - LE_UNSUPPORTED    eDRX is not supported by the platform.
  167  *  - LE_UNAVAILABLE    No requested eDRX cycle value.
  168  *  - LE_FAULT          The function failed.
  169  */
  170 //--------------------------------------------------------------------------------------------------
  171 LE_SHARED le_result_t ifgen_le_lpt_GetRequestedEDrxValue
  172 (
  173     le_msg_SessionRef_t _ifgen_sessionRef,
  174         le_lpt_EDrxRat_t rat,
  175         ///< [IN] Radio Access Technology.
  176         uint8_t* eDrxValuePtr
  177         ///< [OUT] Requested eDRX cycle value, defined in 3GPP
  178         ///< TS 24.008 Rel-13 section 10.5.5.32.
  179 );
  180 
  181 //--------------------------------------------------------------------------------------------------
  182 /**
  183  * Get the network-provided eDRX cycle value for the given Radio Access Technology.
  184  * The eDRX cycle value is defined in 3GPP TS 24.008 Release 13 section 10.5.5.32.
  185  *
  186  * @return
  187  *  - LE_OK             The function succeeded.
  188  *  - LE_BAD_PARAMETER  A parameter is invalid.
  189  *  - LE_UNSUPPORTED    eDRX is not supported by the platform.
  190  *  - LE_UNAVAILABLE    No network-provided eDRX cycle value.
  191  *  - LE_FAULT          The function failed.
  192  */
  193 //--------------------------------------------------------------------------------------------------
  194 LE_SHARED le_result_t ifgen_le_lpt_GetNetworkProvidedEDrxValue
  195 (
  196     le_msg_SessionRef_t _ifgen_sessionRef,
  197         le_lpt_EDrxRat_t rat,
  198         ///< [IN] Radio Access Technology.
  199         uint8_t* eDrxValuePtr
  200         ///< [OUT] Network-provided eDRX cycle value, defined in
  201         ///< 3GPP TS 24.008 Rel-13 section 10.5.5.32.
  202 );
  203 
  204 //--------------------------------------------------------------------------------------------------
  205 /**
  206  * Get the network-provided Paging Time Window for the given Radio Access Technology.
  207  * The Paging Time Window is defined in 3GPP TS 24.008 Release 13 section 10.5.5.32.
  208  *
  209  * @return
  210  *  - LE_OK             The function succeeded.
  211  *  - LE_BAD_PARAMETER  A parameter is invalid.
  212  *  - LE_UNSUPPORTED    eDRX is not supported by the platform.
  213  *  - LE_UNAVAILABLE    No defined Paging Time Window.
  214  *  - LE_FAULT          The function failed.
  215  */
  216 //--------------------------------------------------------------------------------------------------
  217 LE_SHARED le_result_t ifgen_le_lpt_GetNetworkProvidedPagingTimeWindow
  218 (
  219     le_msg_SessionRef_t _ifgen_sessionRef,
  220         le_lpt_EDrxRat_t rat,
  221         ///< [IN] Radio Access Technology.
  222         uint8_t* pagingTimeWindowPtr
  223         ///< [OUT] Network-provided Paging Time Window, defined
  224         ///< in 3GPP TS 24.008 Rel-13 section 10.5.5.32.
  225 );
  226 
  227 //--------------------------------------------------------------------------------------------------
  228 /**
  229  * Add handler function for EVENT 'le_lpt_EDrxParamsChange'
  230  *
  231  * Event to report a change in the network-provided eDRX parameters.
  232  */
  233 //--------------------------------------------------------------------------------------------------
  234 LE_SHARED le_lpt_EDrxParamsChangeHandlerRef_t ifgen_le_lpt_AddEDrxParamsChangeHandler
  235 (
  236     le_msg_SessionRef_t _ifgen_sessionRef,
  237         le_lpt_EDrxParamsChangeHandlerFunc_t handlerPtr,
  238         ///< [IN]
  239         void* contextPtr
  240         ///< [IN]
  241 );
  242 
  243 //--------------------------------------------------------------------------------------------------
  244 /**
  245  * Remove handler function for EVENT 'le_lpt_EDrxParamsChange'
  246  */
  247 //--------------------------------------------------------------------------------------------------
  248 LE_SHARED void ifgen_le_lpt_RemoveEDrxParamsChangeHandler
  249 (
  250     le_msg_SessionRef_t _ifgen_sessionRef,
  251         le_lpt_EDrxParamsChangeHandlerRef_t handlerRef
  252         ///< [IN]
  253 );
  254 /** @} **/
  255 #endif // LE_LPT_COMMON_H_INCLUDE_GUARD
LE_SHARED
#define LE_SHARED
Definition: le_basics.h:300
LE_LPT_EDRX_RAT_EC_GSM_IOT
EC-GSM-IoT (A/Gb mode) 
Definition: le_lpt_common.h:37
le_result_t
le_result_t
Definition: le_basics.h:46
le_lpt_EDrxParamsChangeHandlerRef_t
struct le_lpt_EDrxParamsChangeHandler * le_lpt_EDrxParamsChangeHandlerRef_t
Definition: le_lpt_common.h:58
LE_LPT_EDRX_RAT_GSM
GSM (A/Gb mode) 
Definition: le_lpt_common.h:39
le_lpt_EDrxRat_t
le_lpt_EDrxRat_t
Definition: le_lpt_common.h:33
LE_LPT_EDRX_RAT_LTE_M1
E-UTRAN (WB-S1 mode) 
Definition: le_lpt_common.h:43
LE_LPT_EDRX_RAT_LTE_NB1
E-UTRAN (NB-S1 mode) 
Definition: le_lpt_common.h:45
le_lpt_EDrxParamsChangeHandlerFunc_t
void(* le_lpt_EDrxParamsChangeHandlerFunc_t)(le_lpt_EDrxRat_t rat, le_onoff_t activation, uint8_t eDrxValue, uint8_t pagingTimeWindow, void *contextPtr)
Definition: le_lpt_common.h:67
le_msg_SessionRef_t
struct le_msg_Session * le_msg_SessionRef_t
Definition: le_messaging.h:860
legato.h
LE_LPT_EDRX_RAT_UTRAN
UTRAN (Iu mode) 
Definition: le_lpt_common.h:41
LE_LPT_EDRX_RAT_UNKNOWN
Unknown. 
Definition: le_lpt_common.h:35
LE_LPT_EDRX_RAT_MAX
Invalid. 
Definition: le_lpt_common.h:47
le_onoff_t
le_onoff_t
Definition: le_basics.h:98