SwiApiGsmStk.h

Go to the documentation of this file.

#ifndef __SWIAPI_GSM_STK
#define __SWIAPI_GSM_STK

/* include files */
#include "SwiDataTypes.h"
#include "SwiRcodes.h"
#include "SwiApiGsmBasic.h"

/* CNS Objects packet lengths */
#define OBJ_CNS_STK_CMD_STRING_LENGTH       236
#define OBJ_CNS_STK_RESP_USER_ACK_LENGTH    5
#define OBJ_CNS_STK_RESP_GET_INPUT_LENGTH   245
#define OBJ_CNS_STK_RESP_GET_INPUT_STRING_LENGTH   238
#define OBJ_CNS_STK_RESP_USER_CNF_LENGTH    5
#define OBJ_CNS_STK_RESP_SELECT_ITEM_LENGTH 5

/*
 *
 * SIM Toolkit (STK)
 *
 */

enum SWI_TYPE_STK_TextType
{
    SWI_STKTEXTTTYPE_HelpData           = 0x01,
    SWI_STKTEXTTTYPE_DisplayText        = 0x02,
    SWI_STKTEXTTTYPE_DefaultDisplayText = 0x04,
    SWI_STKTEXTTTYPE_MenuTitle          = 0x08,
    SWI_STKTEXTTTYPE_MenuSelection      = 0x10
};

enum SWI_TYPE_STK_STKCommand
{
    SWI_STKCOMMANDTYPE_None,
    SWI_STKCOMMANDTYPE_MainMenu,
    SWI_STKCOMMANDTYPE_DisplayText,
    SWI_STKCOMMANDTYPE_GetInput,
    SWI_STKCOMMANDTYPE_GetInkey,
    SWI_STKCOMMANDTYPE_CallSetup,
    SWI_STKCOMMANDTYPE_SelectMenu
};

enum SWI_TYPE_STK_Operation
{
    SWI_STKOPERATIONTYPE_MainMenu,
    SWI_STKOPERATIONTYPE_Timeout,
    SWI_STKOPERATIONTYPE_UserAcknowledgement,
    SWI_STKOPERATIONTYPE_GetInput,
    SWI_STKOPERATIONTYPE_GetUserConfirmation,
    SWI_STKOPERATIONTYPE_MenuSelection
};

enum SWI_TYPE_STK_UserResponse
{
    SWI_STKUSERRESPONSE_No,
    SWI_STKUSERRESPONSE_Yes
};

enum SWI_TYPE_STK_Key
{
    SWI_STYKEY_Digit,
    SWI_STYKEY_GSMAlphabet,
    SWI_STYKEY_Unicode
};

enum SWI_TYPE_STKPriority
{
    SWI_STKPRIORITY_Normal,
    SWI_STKPRIORITY_High
};

enum SWI_TYPE_STKReturn
{
    SWI_STKRETURN_UserAck,
    SWI_STKRETURN_Back,
    SWI_STKRETURN_Abort,
    SWI_STKRETURN_MMIBusy
};

struct SWI_STRUCT_STK_Command
{
    swi_uint32                      sizeStruct;
    swi_uint32                      nSTK_Handle;
    enum SWI_TYPE_STK_TextType      eTextType;
    
    swi_uint32                      nMenuSelectionNumber;
    
    swi_bool                        bMore;
    
    swi_uint32                      cntWCHAR;
    
    swi_char                        wText [LENGTH_STKCommand_utf8];
};

struct SWI_STRUCT_STK_Notif_Command
{
    swi_uint32                      sizeStruct;
    
    swi_uint32                      nSTK_Handle;
    swi_uint32                      nTimeout;
    enum SWI_TYPE_STK_STKCommand    eSTKCommand;
    enum SWI_TYPE_STK_Operation     eOperation;
    enum SWI_TYPE_STK_TextType      eTextType;
    swi_uint32                      nMinLengthOfInputExpected;
    swi_uint32                      nMaxLengthOfInputExpected;
    swi_bool                        bEcho;
    enum SWI_TYPE_STK_Key           eKeyType;
    swi_uint32                      cntItemsInMenu;
    enum SWI_TYPE_STKPriority       ePriority;
};

struct SWI_STRUCT_STK_RsepUserAck
{
    swi_uint32              sizeStruct;
    swi_uint32              nSTK_Handle;
    enum SWI_TYPE_STKReturn eSTKReturn;
};
/* This to fix a typo in Windows' Version */ 
typedef struct SWI_STRUCT_STK_RsepUserAck SWI_STRUCT_STK_RespUserAck;

struct SWI_STRUCT_STK_RsepGetInput
{
    swi_uint32  sizeStruct;
    swi_uint32  nSTK_Handle;
    
    swi_bool    bMoreData;
    
    swi_uint32  cntWCHAR;    

    swi_char    wText[LENGTH_STKRespInput];
};
/* This to fix a typo in Windows' Version */ 
typedef struct SWI_STRUCT_STK_RsepGetInput SWI_STRUCT_STK_RespGetInput;

struct SWI_STRUCT_STK_RsepUserConfirm
{
    swi_uint32                          sizeStruct;
    
    swi_uint32                          nSTK_Handle;
    
    enum SWI_TYPE_STK_UserResponse      eUserResponse;
};

struct SWI_STRUCT_STK_RsepSelectItem
{
    swi_uint32 sizeStruct;
    swi_uint32 nSTK_Handle;

    swi_uint32 nMenuItem;
};

/* STK (SIM Toolkit) */

/* Return STK command */
extern SWI_API SWI_RCODE SwiGetSIMToolKitCommand (
    struct SWI_STRUCT_STK_Command *STKCommandp, 
    swi_uint32 timeout);

/* Set user ACK */
extern SWI_API SWI_RCODE SwiSetSTKUserAcknowledge (
    const struct SWI_STRUCT_STK_RsepUserAck *RespUserAckp, 
    swi_uint32 timeout);

/* Set input */
extern SWI_API SWI_RCODE SwiSetSTKSetInput (
    const struct SWI_STRUCT_STK_RsepGetInput *RespGetInputp, 
    swi_uint32 timeout);

/* Set user confirmation response */
extern SWI_API SWI_RCODE SwiSetSTKUserConfirmationResponse (
    const struct SWI_STRUCT_STK_RsepUserConfirm *RespUserConfirmp, 
    swi_uint32 timeout);

/* Set user selected menu item */
extern SWI_API SWI_RCODE SwiSetSTKUserSelectedMenuItem (
    const struct SWI_STRUCT_STK_RsepSelectItem *RespSelectItemp, 
    swi_bool *Resultp, 
    swi_uint32 timeout);

#endif /* __SWIAPI_GSM_STK */
/*
 * $Log: SwiApiGsmStk.h,v $
 */