le_mcc_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_mcc_common.h
   12  *
   13  * Type definitions for le_mcc.
   14  *
   15  */
   16 #ifndef LE_MCC_COMMON_H_INCLUDE_GUARD
   17 #define LE_MCC_COMMON_H_INCLUDE_GUARD
   18 
   19 
   20 #include "legato.h"
   21 
   22 // Interface specific includes
   23 #include "le_mdmDefs_common.h"
   24 
   25 #define IFGEN_LE_MCC_PROTOCOL_ID "bf43202a0369b12bb827e1bc4724bb41"
   26 #define IFGEN_LE_MCC_MSG_SIZE 33
   27 /** @addtogroup le_mcc
   28  *  @{ **/
   29 
   30 
   31 //--------------------------------------------------------------------------------------------------
   32 /**
   33  *  Enumeration of the possible events that may be reported to a call event handler.
   34  */
   35 //--------------------------------------------------------------------------------------------------
   36 typedef enum
   37 {
   38     LE_MCC_EVENT_SETUP = 0,
   39         ///< Call is being set up.
   40     LE_MCC_EVENT_INCOMING = 1,
   41         ///< Incoming call attempt (new call).
   42     LE_MCC_EVENT_ORIGINATING = 2,
   43         ///< Outgoing call attempt.
   44     LE_MCC_EVENT_ALERTING = 3,
   45         ///< Far end is now alerting its user (outgoing call).
   46     LE_MCC_EVENT_CONNECTED = 4,
   47         ///< Call has been established, and is media is active.
   48     LE_MCC_EVENT_TERMINATED = 5,
   49         ///< Call has terminated.
   50     LE_MCC_EVENT_WAITING = 6,
   51         ///< Call is waiting
   52     LE_MCC_EVENT_ON_HOLD = 7,
   53         ///< Remote party has put the call on hold.
   54     LE_MCC_EVENT_MAX = 8
   55         ///< Enumerate max value.
   56 }
   57 le_mcc_Event_t;
   58 
   59 
   60 //--------------------------------------------------------------------------------------------------
   61 /**
   62  *  Enumeration of the possible reasons for call termination.
   63  */
   64 //--------------------------------------------------------------------------------------------------
   65 typedef enum
   66 {
   67     LE_MCC_TERM_LOCAL_ENDED = 0,
   68         ///< Local party ended the call (Normal Call Clearing).
   69     LE_MCC_TERM_REMOTE_ENDED = 1,
   70         ///< Remote party ended the call (Normal Call Clearing).
   71     LE_MCC_TERM_NETWORK_FAIL = 2,
   72         ///< Network could not complete the call.
   73     LE_MCC_TERM_UNASSIGNED_NUMBER = 3,
   74         ///< cf. 3GPP 24.008 Annex H
   75     LE_MCC_TERM_NO_ROUTE_TO_DESTINATION = 4,
   76         ///< cf. 3GPP 24.008 Annex H
   77     LE_MCC_TERM_CHANNEL_UNACCEPTABLE = 5,
   78         ///< cf. 3GPP 24.008 Annex H
   79     LE_MCC_TERM_OPERATOR_DETERMINED_BARRING = 6,
   80         ///< cf. 3GPP 24.008 Annex H
   81     LE_MCC_TERM_USER_BUSY = 7,
   82         ///< cf. 3GPP 24.008 Annex H
   83     LE_MCC_TERM_NO_USER_RESPONDING = 8,
   84         ///< cf. 3GPP 24.008 Annex H
   85     LE_MCC_TERM_USER_ALERTING_NO_ANSWER = 9,
   86         ///< cf. 3GPP 24.008 Annex H
   87     LE_MCC_TERM_CALL_REJECTED = 10,
   88         ///< cf. 3GPP 24.008 Annex H
   89     LE_MCC_TERM_NUMBER_CHANGED = 11,
   90         ///< cf. 3GPP 24.008 Annex H
   91     LE_MCC_TERM_PREEMPTION = 12,
   92         ///< cf. 3GPP 24.008 Annex H
   93     LE_MCC_TERM_DESTINATION_OUT_OF_ORDER = 13,
   94         ///< cf. 3GPP 24.008 Annex H
   95     LE_MCC_TERM_INVALID_NUMBER_FORMAT = 14,
   96         ///< cf. 3GPP 24.008 Annex H
   97     LE_MCC_TERM_FACILITY_REJECTED = 15,
   98         ///< cf. 3GPP 24.008 Annex H
   99     LE_MCC_TERM_RESP_TO_STATUS_ENQUIRY = 16,
  100         ///< cf. 3GPP 24.008 Annex H
  101     LE_MCC_TERM_NORMAL_UNSPECIFIED = 17,
  102         ///< cf. 3GPP 24.008 Annex H
  103     LE_MCC_TERM_NO_CIRCUIT_OR_CHANNEL_AVAILABLE = 18,
  104         ///< cf. 3GPP 24.008 Annex H
  105     LE_MCC_TERM_NETWORK_OUT_OF_ORDER = 19,
  106         ///< cf. 3GPP 24.008 Annex H
  107     LE_MCC_TERM_TEMPORARY_FAILURE = 20,
  108         ///< cf. 3GPP 24.008 Annex H
  109     LE_MCC_TERM_SWITCHING_EQUIPMENT_CONGESTION = 21,
  110         ///< cf. 3GPP 24.008 Annex H
  111     LE_MCC_TERM_ACCESS_INFORMATION_DISCARDED = 22,
  112         ///< cf. 3GPP 24.008 Annex H
  113     LE_MCC_TERM_REQUESTED_CIRCUIT_OR_CHANNEL_NOT_AVAILABLE = 23,
  114         ///< cf. 3GPP 24.008 Annex H
  115     LE_MCC_TERM_RESOURCES_UNAVAILABLE_OR_UNSPECIFIED = 24,
  116         ///< cf. 3GPP 24.008 Annex H
  117     LE_MCC_TERM_QOS_UNAVAILABLE = 25,
  118         ///< cf. 3GPP 24.008 Annex H
  119     LE_MCC_TERM_REQUESTED_FACILITY_NOT_SUBSCRIBED = 26,
  120         ///< cf. 3GPP 24.008 Annex H
  121     LE_MCC_TERM_INCOMING_CALLS_BARRED_WITHIN_CUG = 27,
  122         ///< cf. 3GPP 24.008 Annex H
  123     LE_MCC_TERM_BEARER_CAPABILITY_NOT_AUTH = 28,
  124         ///< cf. 3GPP 24.008 Annex H
  125     LE_MCC_TERM_BEARER_CAPABILITY_UNAVAILABLE = 29,
  126         ///< cf. 3GPP 24.008 Annex H
  127     LE_MCC_TERM_SERVICE_OPTION_NOT_AVAILABLE = 30,
  128         ///< cf. 3GPP 24.008 Annex H
  129     LE_MCC_TERM_ACM_LIMIT_EXCEEDED = 31,
  130         ///< cf. 3GPP 24.008 Annex H
  131     LE_MCC_TERM_BEARER_SERVICE_NOT_IMPLEMENTED = 32,
  132         ///< cf. 3GPP 24.008 Annex H
  133     LE_MCC_TERM_REQUESTED_FACILITY_NOT_IMPLEMENTED = 33,
  134         ///< cf. 3GPP 24.008 Annex H
  135     LE_MCC_TERM_ONLY_DIGITAL_INFORMATION_BEARER_AVAILABLE = 34,
  136         ///< cf. 3GPP 24.008 Annex H
  137     LE_MCC_TERM_SERVICE_OR_OPTION_NOT_IMPLEMENTED = 35,
  138         ///< cf. 3GPP 24.008 Annex H
  139     LE_MCC_TERM_INVALID_TRANSACTION_IDENTIFIER = 36,
  140         ///< cf. 3GPP 24.008 Annex H
  141     LE_MCC_TERM_USER_NOT_MEMBER_OF_CUG = 37,
  142         ///< cf. 3GPP 24.008 Annex H
  143     LE_MCC_TERM_INCOMPATIBLE_DESTINATION = 38,
  144         ///< cf. 3GPP 24.008 Annex H
  145     LE_MCC_TERM_INVALID_TRANSIT_NW_SELECTION = 39,
  146         ///< cf. 3GPP 24.008 Annex H
  147     LE_MCC_TERM_SEMANTICALLY_INCORRECT_MESSAGE = 40,
  148         ///< cf. 3GPP 24.008 Annex H
  149     LE_MCC_TERM_INVALID_MANDATORY_INFORMATION = 41,
  150         ///< cf. 3GPP 24.008 Annex H
  151     LE_MCC_TERM_MESSAGE_TYPE_NON_IMPLEMENTED = 42,
  152         ///< cf. 3GPP 24.008 Annex H
  153     LE_MCC_TERM_MESSAGE_TYPE_NOT_COMPATIBLE_WITH_PROTOCOL_STATE = 43,
  154         ///< cf. 3GPP 24.008 Annex H
  155     LE_MCC_TERM_INFORMATION_ELEMENT_NON_EXISTENT = 44,
  156         ///< cf. 3GPP 24.008 Annex H
  157     LE_MCC_TERM_CONDITONAL_IE_ERROR = 45,
  158         ///< cf. 3GPP 24.008 Annex H
  159     LE_MCC_TERM_MESSAGE_NOT_COMPATIBLE_WITH_PROTOCOL_STATE = 46,
  160         ///< cf. 3GPP 24.008 Annex H
  161     LE_MCC_TERM_RECOVERY_ON_TIMER_EXPIRY = 47,
  162         ///< cf. 3GPP 24.008 Annex H
  163     LE_MCC_TERM_PROTOCOL_ERROR_UNSPECIFIED = 48,
  164         ///< cf. 3GPP 24.008 Annex H
  165     LE_MCC_TERM_INTERWORKING_UNSPECIFIED = 49,
  166         ///< cf. 3GPP 24.008 Annex H
  167     LE_MCC_TERM_SERVICE_TEMPORARILY_OUT_OF_ORDER = 50,
  168         ///< cf. 3GPP 24.008 10.5.3.6
  169     LE_MCC_TERM_NOT_ALLOWED = 51,
  170         ///< Call operations not allowed
  171         ///<  (i.e. Radio off).
  172     LE_MCC_TERM_FDN_ACTIVE = 52,
  173         ///< FDN is active and number is not
  174         ///< in the FDN.
  175     LE_MCC_TERM_NO_SERVICE = 53,
  176         ///< No service or bad signal quality
  177     LE_MCC_TERM_PLATFORM_SPECIFIC = 54,
  178         ///< Platform specific code.
  179     LE_MCC_TERM_UNDEFINED = 55
  180         ///< Undefined reason.
  181 }
  182 le_mcc_TerminationReason_t;
  183 
  184 
  185 //--------------------------------------------------------------------------------------------------
  186 /**
  187  *  Reference type for managing active calls.
  188  */
  189 //--------------------------------------------------------------------------------------------------
  190 typedef struct le_mcc_Call* le_mcc_CallRef_t;
  191 
  192 
  193 //--------------------------------------------------------------------------------------------------
  194 /**
  195  * Reference type used by Add/Remove functions for EVENT 'le_mcc_CallEvent'
  196  */
  197 //--------------------------------------------------------------------------------------------------
  198 typedef struct le_mcc_CallEventHandler* le_mcc_CallEventHandlerRef_t;
  199 
  200 
  201 //--------------------------------------------------------------------------------------------------
  202 /**
  203  * Handler for call state changes.
  204  *
  205  * @note The callRef has to be deleted using le_mcc_Delete() when LE_MCC_TERMINATED event
  206  * is received, except if is has to be used for a future usage (with le_mcc_profile handler for
  207  * instance, or dialing again the same number).
  208  *
  209  */
  210 //--------------------------------------------------------------------------------------------------
  211 typedef void (*le_mcc_CallEventHandlerFunc_t)
  212 (
  213         le_mcc_CallRef_t callRef,
  214         ///< The call reference.
  215         le_mcc_Event_t event,
  216         ///< Call event.
  217         void* contextPtr
  218         ///<
  219 );
  220 
  221 
  222 //--------------------------------------------------------------------------------------------------
  223 /**
  224  * Get if this client bound locally.
  225  */
  226 //--------------------------------------------------------------------------------------------------
  227 LE_SHARED bool ifgen_le_mcc_HasLocalBinding
  228 (
  229     void
  230 );
  231 
  232 
  233 //--------------------------------------------------------------------------------------------------
  234 /**
  235  * Init data that is common across all threads
  236  */
  237 //--------------------------------------------------------------------------------------------------
  238 LE_SHARED void ifgen_le_mcc_InitCommonData
  239 (
  240     void
  241 );
  242 
  243 
  244 //--------------------------------------------------------------------------------------------------
  245 /**
  246  * Perform common initialization and open a session
  247  */
  248 //--------------------------------------------------------------------------------------------------
  249 LE_SHARED le_result_t ifgen_le_mcc_OpenSession
  250 (
  251     le_msg_SessionRef_t _ifgen_sessionRef,
  252     bool isBlocking
  253 );
  254 
  255 //--------------------------------------------------------------------------------------------------
  256 /**
  257  * Create a call reference.
  258  *
  259  * @note Return NULL if call reference can't be created
  260  *
  261  * @note If destination number is too long (max LE_MDMDEFS_PHONE_NUM_MAX_LEN digits),
  262  * it is a fatal error, the function will not return.
  263  *
  264  */
  265 //--------------------------------------------------------------------------------------------------
  266 LE_SHARED le_mcc_CallRef_t ifgen_le_mcc_Create
  267 (
  268     le_msg_SessionRef_t _ifgen_sessionRef,
  269         const char* LE_NONNULL phoneNumPtr
  270         ///< [IN] The target number we are going to
  271         ///< call.
  272 );
  273 
  274 //--------------------------------------------------------------------------------------------------
  275 /**
  276  * Call to free up a call reference.
  277  *
  278  * @return
  279  *     - LE_OK        The function succeed.
  280  *     - LE_NOT_FOUND The call reference was not found.
  281  *     - LE_FAULT      The function failed.
  282  *
  283  *
  284  */
  285 //--------------------------------------------------------------------------------------------------
  286 LE_SHARED le_result_t ifgen_le_mcc_Delete
  287 (
  288     le_msg_SessionRef_t _ifgen_sessionRef,
  289         le_mcc_CallRef_t callRef
  290         ///< [IN] The call object to free.
  291 );
  292 
  293 //--------------------------------------------------------------------------------------------------
  294 /**
  295  * Start a call attempt.
  296  *
  297  * Asynchronous due to possible time to connect.
  298  *
  299  * As the call attempt proceeds, the profile's registered call event handler receives events.
  300  *
  301  * @return
  302  *      - LE_OK            Function succeed.
  303  *      - LE_BUSY          The call is already in progress
  304  *
  305  * * @note As this is an asynchronous call, a successful only confirms a call has been
  306  *       started. Don't assume a call has been successful yet.
  307  *
  308  * @note If the caller is passing a bad pointer into this function, it is a fatal error, the
  309  *       function will not return.
  310  */
  311 //--------------------------------------------------------------------------------------------------
  312 LE_SHARED le_result_t ifgen_le_mcc_Start
  313 (
  314     le_msg_SessionRef_t _ifgen_sessionRef,
  315         le_mcc_CallRef_t callRef
  316         ///< [IN] Reference to the call object.
  317 );
  318 
  319 //--------------------------------------------------------------------------------------------------
  320 /**
  321  * Allow the caller to know if the given call is actually connected or not.
  322  *
  323  * @return TRUE if the call is connected, FALSE otherwise.
  324  *
  325  * @note If the caller is passing a bad pointer into this function, it is a fatal error, the
  326  *       function will not return.
  327  */
  328 //--------------------------------------------------------------------------------------------------
  329 LE_SHARED bool ifgen_le_mcc_IsConnected
  330 (
  331     le_msg_SessionRef_t _ifgen_sessionRef,
  332         le_mcc_CallRef_t callRef
  333         ///< [IN] The call reference to read.
  334 );
  335 
  336 //--------------------------------------------------------------------------------------------------
  337 /**
  338  * Read out the remote party telephone number associated with the call.
  339  *
  340  * Output parameter is updated with the telephone number. If the Telephone number string length exceeds
  341  * the value of 'len' parameter, the LE_OVERFLOW error code is returned and 'telPtr' is used until
  342  * 'len-1' characters and a null-character is implicitly appended at the end of 'telPtr'.
  343  * Note that 'len' sould be at least equal to LE_MDMDEFS_PHONE_NUM_MAX_BYTES, otherwise LE_OVERFLOW
  344  * error code will be common.
  345  *
  346  * @return LE_OVERFLOW      The Telephone number length exceed the maximum length.
  347  * @return LE_OK            The function succeeded.
  348  *
  349  * @note If the caller is passing a bad pointer into this function, it is a fatal error, the
  350  *       function will not return.
  351  */
  352 //--------------------------------------------------------------------------------------------------
  353 LE_SHARED le_result_t ifgen_le_mcc_GetRemoteTel
  354 (
  355     le_msg_SessionRef_t _ifgen_sessionRef,
  356         le_mcc_CallRef_t callRef,
  357         ///< [IN]  The call reference to read from.
  358         char* telPtr,
  359         ///< [OUT] The telephone number string.
  360         size_t telPtrSize
  361         ///< [IN]
  362 );
  363 
  364 //--------------------------------------------------------------------------------------------------
  365 /**
  366  * Called to get the termination reason.
  367  *
  368  * @return The termination reason.
  369  *
  370  * @note If the caller is passing a bad pointer into this function, it is a fatal error, the
  371  *       function will not return.
  372  */
  373 //--------------------------------------------------------------------------------------------------
  374 LE_SHARED le_mcc_TerminationReason_t ifgen_le_mcc_GetTerminationReason
  375 (
  376     le_msg_SessionRef_t _ifgen_sessionRef,
  377         le_mcc_CallRef_t callRef
  378         ///< [IN] The call reference to read from.
  379 );
  380 
  381 //--------------------------------------------------------------------------------------------------
  382 /**
  383  * Called to get the platform specific termination code.
  384  *
  385  * Refer to @ref platformConstraintsSpecificErrorCodes for platform specific
  386  * termination code description.
  387  *
  388  * @return The platform specific termination code.
  389  *
  390  * @note If the caller is passing a bad pointer into this function, it is a fatal error, the
  391  *       function will not return.
  392  */
  393 //--------------------------------------------------------------------------------------------------
  394 LE_SHARED int32_t ifgen_le_mcc_GetPlatformSpecificTerminationCode
  395 (
  396     le_msg_SessionRef_t _ifgen_sessionRef,
  397         le_mcc_CallRef_t callRef
  398         ///< [IN] The call reference to read from.
  399 );
  400 
  401 //--------------------------------------------------------------------------------------------------
  402 /**
  403  *  Answers incoming call.
  404  *
  405  * @return LE_TIMEOUT       No response was received from the Modem.
  406  * @return LE_OK            The function succeeded.
  407  *
  408  * @note If the caller is passing a bad pointer into this function, it is a fatal error, the
  409  *       function will not return.
  410  * @note A call waiting call must be answered using SetCallActive() API. This API doesn't manage
  411  * call waiting supplementary service.
  412  */
  413 //--------------------------------------------------------------------------------------------------
  414 LE_SHARED le_result_t ifgen_le_mcc_Answer
  415 (
  416     le_msg_SessionRef_t _ifgen_sessionRef,
  417         le_mcc_CallRef_t callRef
  418         ///< [IN] The call reference.
  419 );
  420 
  421 //--------------------------------------------------------------------------------------------------
  422 /**
  423  * Disconnect, or hang up, the specifed call. Any active call handlers
  424  * will be notified.
  425  *
  426  * @return LE_FAULT         The function failed.
  427  * @return LE_TIMEOUT       No response was received from the Modem.
  428  * @return LE_OK            Function succeeded.
  429  *
  430  * @note If the caller is passing a bad pointer into this function, it is a fatal error, the
  431  *       function will not return.
  432  * @note this API can also be used to disconnect a waiting or on hold call.
  433  */
  434 //--------------------------------------------------------------------------------------------------
  435 LE_SHARED le_result_t ifgen_le_mcc_HangUp
  436 (
  437     le_msg_SessionRef_t _ifgen_sessionRef,
  438         le_mcc_CallRef_t callRef
  439         ///< [IN] The call to end.
  440 );
  441 
  442 //--------------------------------------------------------------------------------------------------
  443 /**
  444  * This function will disconnect, or hang up all the ongoing calls. Any active call handlers will
  445  * be notified.
  446  *
  447  * @return LE_FAULT         The function failed.
  448  * @return LE_TIMEOUT       No response was received from the Modem.
  449  * @return LE_OK            The function succeeded.
  450  */
  451 //--------------------------------------------------------------------------------------------------
  452 LE_SHARED le_result_t ifgen_le_mcc_HangUpAll
  453 (
  454     le_msg_SessionRef_t _ifgen_sessionRef
  455 );
  456 
  457 //--------------------------------------------------------------------------------------------------
  458 /**
  459  * This function return the Calling Line Identification Restriction (CLIR) status on the specific
  460  *  call.
  461  *
  462  * The output parameter is updated with the CLIR status.
  463  *    - LE_ON  Disable presentation of own phone number to remote.
  464  *    - LE_OFF Enable presentation of own phone number to remote.
  465  *
  466  * @return
  467  *    - LE_OK          The function succeed.
  468  *    - LE_NOT_FOUND   The call reference was not found.
  469  *    - LE_UNAVAILABLE CLIR status was not set.
  470  */
  471 //--------------------------------------------------------------------------------------------------
  472 LE_SHARED le_result_t ifgen_le_mcc_GetCallerIdRestrict
  473 (
  474     le_msg_SessionRef_t _ifgen_sessionRef,
  475         le_mcc_CallRef_t callRef,
  476         ///< [IN] The call reference.
  477         le_onoff_t* clirStatusPtrPtr
  478         ///< [OUT] the Calling Line Identification Restriction (CLIR) status
  479 );
  480 
  481 //--------------------------------------------------------------------------------------------------
  482 /**
  483  * This function set the Calling Line Identification Restriction (CLIR) status on the specific call.
  484  * By default the CLIR status is not set.
  485  *
  486  * @return
  487  *     - LE_OK        The function succeed.
  488  *     - LE_NOT_FOUND The call reference was not found.
  489  *
  490  */
  491 //--------------------------------------------------------------------------------------------------
  492 LE_SHARED le_result_t ifgen_le_mcc_SetCallerIdRestrict
  493 (
  494     le_msg_SessionRef_t _ifgen_sessionRef,
  495         le_mcc_CallRef_t callRef,
  496         ///< [IN] The call reference.
  497         le_onoff_t clirStatus
  498         ///< [IN] The Calling Line Identification Restriction (CLIR) status.
  499 );
  500 
  501 //--------------------------------------------------------------------------------------------------
  502 /**
  503  * Add handler function for EVENT 'le_mcc_CallEvent'
  504  *
  505  * Register an event handler that will be notified when an call's event occurs.
  506  *
  507  * @return A reference to the new event handler object.
  508  *
  509  * @note It is a fatal error if this function does succeed.  If this function fails, it will not
  510  *       return.
  511  *
  512  */
  513 //--------------------------------------------------------------------------------------------------
  514 LE_SHARED le_mcc_CallEventHandlerRef_t ifgen_le_mcc_AddCallEventHandler
  515 (
  516     le_msg_SessionRef_t _ifgen_sessionRef,
  517         le_mcc_CallEventHandlerFunc_t handlerPtr,
  518         ///< [IN]
  519         void* contextPtr
  520         ///< [IN]
  521 );
  522 
  523 //--------------------------------------------------------------------------------------------------
  524 /**
  525  * Remove handler function for EVENT 'le_mcc_CallEvent'
  526  */
  527 //--------------------------------------------------------------------------------------------------
  528 LE_SHARED void ifgen_le_mcc_RemoveCallEventHandler
  529 (
  530     le_msg_SessionRef_t _ifgen_sessionRef,
  531         le_mcc_CallEventHandlerRef_t handlerRef
  532         ///< [IN]
  533 );
  534 
  535 //--------------------------------------------------------------------------------------------------
  536 /**
  537  * This function activates or deactivates the call waiting service.
  538  *
  539  * @return
  540  *     - LE_OK        The function succeed.
  541  *     - LE_FAULT     The function failed.
  542  *
  543  */
  544 //--------------------------------------------------------------------------------------------------
  545 LE_SHARED le_result_t ifgen_le_mcc_SetCallWaitingService
  546 (
  547     le_msg_SessionRef_t _ifgen_sessionRef,
  548         bool active
  549         ///< [IN] The call waiting activation.
  550 );
  551 
  552 //--------------------------------------------------------------------------------------------------
  553 /**
  554  * This function gets the call waiting service status.
  555  *
  556  * @return
  557  *     - LE_OK        The function succeed.
  558  *     - LE_FAULT     The function failed.
  559  *
  560  */
  561 //--------------------------------------------------------------------------------------------------
  562 LE_SHARED le_result_t ifgen_le_mcc_GetCallWaitingService
  563 (
  564     le_msg_SessionRef_t _ifgen_sessionRef,
  565         bool* activePtr
  566         ///< [OUT] The call waiting activation.
  567 );
  568 
  569 //--------------------------------------------------------------------------------------------------
  570 /**
  571  * This function activates the specified call. Other calls are placed on hold.
  572  *
  573  * @return
  574  *     - LE_OK        The function succeed.
  575  *     - LE_FAULT     The function failed.
  576  *
  577  */
  578 //--------------------------------------------------------------------------------------------------
  579 LE_SHARED le_result_t ifgen_le_mcc_ActivateCall
  580 (
  581     le_msg_SessionRef_t _ifgen_sessionRef,
  582         le_mcc_CallRef_t callRef
  583         ///< [IN] The call reference.
  584 );
  585 
  586 //--------------------------------------------------------------------------------------------------
  587 /**
  588  * This function enables/disables the audio AMR Wideband capability.
  589  *
  590  * @return
  591  *     -  LE_OK             The function succeeded.
  592  *     -  LE_UNAVAILABLE    The service is not available.
  593  *     -  LE_FAULT          On any other failure.
  594  *
  595  * @note The capability setting takes effect immediately and is not persistent to reset.
  596  */
  597 //--------------------------------------------------------------------------------------------------
  598 LE_SHARED le_result_t ifgen_le_mcc_SetAmrWbCapability
  599 (
  600     le_msg_SessionRef_t _ifgen_sessionRef,
  601         bool enable
  602         ///< [IN] True enables the AMR Wideband capability, false disables it.
  603 );
  604 
  605 //--------------------------------------------------------------------------------------------------
  606 /**
  607  * This function gets the audio AMR Wideband capability.
  608  *
  609  * @return
  610  *     - LE_OK            The function succeeded.
  611  *     - LE_UNAVAILABLE   The service is not available.
  612  *     - LE_FAULT         On any other failure.
  613  */
  614 //--------------------------------------------------------------------------------------------------
  615 LE_SHARED le_result_t ifgen_le_mcc_GetAmrWbCapability
  616 (
  617     le_msg_SessionRef_t _ifgen_sessionRef,
  618         bool* enabledPtr
  619         ///< [OUT] True if AMR Wideband capability is enabled, false otherwise.
  620 );
  621 /** @} **/
  622 #endif // LE_MCC_COMMON_H_INCLUDE_GUARD
LE_MCC_TERM_INVALID_NUMBER_FORMAT
cf. 3GPP 24.008 Annex H 
Definition: le_mcc_common.h:95
LE_MCC_TERM_BEARER_SERVICE_NOT_IMPLEMENTED
cf. 3GPP 24.008 Annex H 
Definition: le_mcc_common.h:131
LE_MCC_TERM_INTERWORKING_UNSPECIFIED
cf. 3GPP 24.008 Annex H 
Definition: le_mcc_common.h:165
LE_MCC_TERM_INFORMATION_ELEMENT_NON_EXISTENT
cf. 3GPP 24.008 Annex H 
Definition: le_mcc_common.h:155
LE_MCC_TERM_USER_NOT_MEMBER_OF_CUG
cf. 3GPP 24.008 Annex H 
Definition: le_mcc_common.h:141
LE_SHARED
#define LE_SHARED
Definition: le_basics.h:300
LE_MCC_TERM_NO_SERVICE
No service or bad signal quality. 
Definition: le_mcc_common.h:175
LE_MCC_TERM_NO_USER_RESPONDING
cf. 3GPP 24.008 Annex H 
Definition: le_mcc_common.h:83
le_result_t
le_result_t
Definition: le_basics.h:46
LE_MCC_TERM_SERVICE_OPTION_NOT_AVAILABLE
cf. 3GPP 24.008 Annex H 
Definition: le_mcc_common.h:127
LE_MCC_TERM_NETWORK_FAIL
Network could not complete the call. 
Definition: le_mcc_common.h:71
LE_MCC_TERM_REQUESTED_FACILITY_NOT_IMPLEMENTED
cf. 3GPP 24.008 Annex H 
Definition: le_mcc_common.h:133
LE_MCC_TERM_FDN_ACTIVE
Definition: le_mcc_common.h:172
LE_MCC_EVENT_INCOMING
Incoming call attempt (new call). 
Definition: le_mcc_common.h:40
LE_MCC_TERM_SEMANTICALLY_INCORRECT_MESSAGE
cf. 3GPP 24.008 Annex H 
Definition: le_mcc_common.h:147
LE_MCC_TERM_PREEMPTION
cf. 3GPP 24.008 Annex H 
Definition: le_mcc_common.h:91
LE_MCC_TERM_NO_CIRCUIT_OR_CHANNEL_AVAILABLE
cf. 3GPP 24.008 Annex H 
Definition: le_mcc_common.h:103
LE_MCC_TERM_ONLY_DIGITAL_INFORMATION_BEARER_AVAILABLE
cf. 3GPP 24.008 Annex H 
Definition: le_mcc_common.h:135
LE_MCC_EVENT_WAITING
Call is waiting. 
Definition: le_mcc_common.h:50
LE_MCC_TERM_MESSAGE_TYPE_NOT_COMPATIBLE_WITH_PROTOCOL_STATE
cf. 3GPP 24.008 Annex H 
Definition: le_mcc_common.h:153
LE_MCC_TERM_INCOMING_CALLS_BARRED_WITHIN_CUG
cf. 3GPP 24.008 Annex H 
Definition: le_mcc_common.h:121
LE_MCC_TERM_NETWORK_OUT_OF_ORDER
cf. 3GPP 24.008 Annex H 
Definition: le_mcc_common.h:105
LE_MCC_EVENT_ORIGINATING
Outgoing call attempt. 
Definition: le_mcc_common.h:42
LE_MCC_TERM_SERVICE_TEMPORARILY_OUT_OF_ORDER
cf. 3GPP 24.008 10.5.3.6 
Definition: le_mcc_common.h:167
LE_MCC_TERM_QOS_UNAVAILABLE
cf. 3GPP 24.008 Annex H 
Definition: le_mcc_common.h:117
LE_MCC_TERM_RESOURCES_UNAVAILABLE_OR_UNSPECIFIED
cf. 3GPP 24.008 Annex H 
Definition: le_mcc_common.h:115
le_mcc_Event_t
le_mcc_Event_t
Definition: le_mcc_common.h:36
LE_MCC_TERM_SERVICE_OR_OPTION_NOT_IMPLEMENTED
cf. 3GPP 24.008 Annex H 
Definition: le_mcc_common.h:137
le_mdmDefs_common.h
LE_MCC_TERM_ACCESS_INFORMATION_DISCARDED
cf. 3GPP 24.008 Annex H 
Definition: le_mcc_common.h:111
LE_MCC_TERM_USER_BUSY
cf. 3GPP 24.008 Annex H 
Definition: le_mcc_common.h:81
LE_MCC_TERM_NORMAL_UNSPECIFIED
cf. 3GPP 24.008 Annex H 
Definition: le_mcc_common.h:101
LE_MCC_EVENT_CONNECTED
Call has been established, and is media is active. 
Definition: le_mcc_common.h:46
LE_MCC_TERM_RECOVERY_ON_TIMER_EXPIRY
cf. 3GPP 24.008 Annex H 
Definition: le_mcc_common.h:161
LE_MCC_TERM_REMOTE_ENDED
Remote party ended the call (Normal Call Clearing). 
Definition: le_mcc_common.h:69
le_mcc_CallEventHandlerFunc_t
void(* le_mcc_CallEventHandlerFunc_t)(le_mcc_CallRef_t callRef, le_mcc_Event_t event, void *contextPtr)
Definition: le_mcc_common.h:212
LE_MCC_TERM_CALL_REJECTED
cf. 3GPP 24.008 Annex H 
Definition: le_mcc_common.h:87
LE_MCC_TERM_UNDEFINED
Undefined reason. 
Definition: le_mcc_common.h:179
LE_MCC_TERM_CHANNEL_UNACCEPTABLE
cf. 3GPP 24.008 Annex H 
Definition: le_mcc_common.h:77
LE_MCC_TERM_TEMPORARY_FAILURE
cf. 3GPP 24.008 Annex H 
Definition: le_mcc_common.h:107
LE_MCC_TERM_ACM_LIMIT_EXCEEDED
cf. 3GPP 24.008 Annex H 
Definition: le_mcc_common.h:129
LE_MCC_TERM_LOCAL_ENDED
Local party ended the call (Normal Call Clearing). 
Definition: le_mcc_common.h:67
le_mcc_CallEventHandlerRef_t
struct le_mcc_CallEventHandler * le_mcc_CallEventHandlerRef_t
Definition: le_mcc_common.h:198
le_msg_SessionRef_t
struct le_msg_Session * le_msg_SessionRef_t
Definition: le_messaging.h:860
LE_MCC_EVENT_ON_HOLD
Remote party has put the call on hold. 
Definition: le_mcc_common.h:52
LE_MCC_TERM_INVALID_TRANSIT_NW_SELECTION
cf. 3GPP 24.008 Annex H 
Definition: le_mcc_common.h:145
le_mcc_TerminationReason_t
le_mcc_TerminationReason_t
Definition: le_mcc_common.h:65
LE_MCC_TERM_INVALID_MANDATORY_INFORMATION
cf. 3GPP 24.008 Annex H 
Definition: le_mcc_common.h:149
LE_MCC_TERM_NUMBER_CHANGED
cf. 3GPP 24.008 Annex H 
Definition: le_mcc_common.h:89
legato.h
LE_MCC_TERM_MESSAGE_NOT_COMPATIBLE_WITH_PROTOCOL_STATE
cf. 3GPP 24.008 Annex H 
Definition: le_mcc_common.h:159
LE_MCC_TERM_USER_ALERTING_NO_ANSWER
cf. 3GPP 24.008 Annex H 
Definition: le_mcc_common.h:85
LE_MCC_TERM_REQUESTED_CIRCUIT_OR_CHANNEL_NOT_AVAILABLE
cf. 3GPP 24.008 Annex H 
Definition: le_mcc_common.h:113
LE_MCC_TERM_REQUESTED_FACILITY_NOT_SUBSCRIBED
cf. 3GPP 24.008 Annex H 
Definition: le_mcc_common.h:119
LE_MCC_TERM_SWITCHING_EQUIPMENT_CONGESTION
cf. 3GPP 24.008 Annex H 
Definition: le_mcc_common.h:109
LE_MCC_TERM_INCOMPATIBLE_DESTINATION
cf. 3GPP 24.008 Annex H 
Definition: le_mcc_common.h:143
LE_MCC_TERM_RESP_TO_STATUS_ENQUIRY
cf. 3GPP 24.008 Annex H 
Definition: le_mcc_common.h:99
LE_MCC_TERM_BEARER_CAPABILITY_NOT_AUTH
cf. 3GPP 24.008 Annex H 
Definition: le_mcc_common.h:123
LE_MCC_TERM_NO_ROUTE_TO_DESTINATION
cf. 3GPP 24.008 Annex H 
Definition: le_mcc_common.h:75
le_mcc_CallRef_t
struct le_mcc_Call * le_mcc_CallRef_t
Definition: le_mcc_common.h:190
LE_MCC_EVENT_TERMINATED
Call has terminated. 
Definition: le_mcc_common.h:48
LE_MCC_TERM_FACILITY_REJECTED
cf. 3GPP 24.008 Annex H 
Definition: le_mcc_common.h:97
LE_MCC_TERM_UNASSIGNED_NUMBER
cf. 3GPP 24.008 Annex H 
Definition: le_mcc_common.h:73
LE_MCC_TERM_MESSAGE_TYPE_NON_IMPLEMENTED
cf. 3GPP 24.008 Annex H 
Definition: le_mcc_common.h:151
LE_MCC_TERM_BEARER_CAPABILITY_UNAVAILABLE
cf. 3GPP 24.008 Annex H 
Definition: le_mcc_common.h:125
LE_MCC_TERM_PLATFORM_SPECIFIC
Platform specific code. 
Definition: le_mcc_common.h:177
LE_MCC_TERM_PROTOCOL_ERROR_UNSPECIFIED
cf. 3GPP 24.008 Annex H 
Definition: le_mcc_common.h:163
LE_MCC_EVENT_ALERTING
Far end is now alerting its user (outgoing call). 
Definition: le_mcc_common.h:44
LE_MCC_EVENT_MAX
Enumerate max value. 
Definition: le_mcc_common.h:54
LE_MCC_TERM_OPERATOR_DETERMINED_BARRING
cf. 3GPP 24.008 Annex H 
Definition: le_mcc_common.h:79
LE_MCC_TERM_CONDITONAL_IE_ERROR
cf. 3GPP 24.008 Annex H 
Definition: le_mcc_common.h:157
LE_MCC_EVENT_SETUP
Call is being set up. 
Definition: le_mcc_common.h:38
LE_MCC_TERM_DESTINATION_OUT_OF_ORDER
cf. 3GPP 24.008 Annex H 
Definition: le_mcc_common.h:93
le_onoff_t
le_onoff_t
Definition: le_basics.h:98
LE_MCC_TERM_INVALID_TRANSACTION_IDENTIFIER
cf. 3GPP 24.008 Annex H 
Definition: le_mcc_common.h:139
LE_MCC_TERM_NOT_ALLOWED
Definition: le_mcc_common.h:169