SwiApiCdmaSms.h

Go to the documentation of this file.

#ifndef __SWIAPICDMASMS_H__
#define __SWIAPICDMASMS_H__

#ifdef __cplusplus
extern "C" {
#endif

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

#define CNS_MAX_PACKET_SIZE     256     
#define CNS_PACKET_HEADER_SIZE  10      
#define CNS_MAX_PAYLOAD_SIZE    (CNS_MAX_PACKET_SIZE - CNS_PACKET_HEADER_SIZE)

#define CNS_SMS_HEADER_SIZE     6       
#define CNS_SMS_MAX_SIZE        (CNS_MAX_PAYLOAD_SIZE - CNS_SMS_HEADER_SIZE)

#define MAX_SMSI_CALL_BACK      32      
#define MAX_SMSI_TL_ADDRESS     50      
typedef enum SWI_SMS_PACKET_TYPE
{
    SMS_SEGMENT_INTERMEDIATE = 0x00,    
    SMS_SEGMENT_FIRST,                  
    SMS_SEGMENT_LAST,                   
    SMS_NOT_SEGMENTED                   
} SWI_SMS_PACKET_TYPE ;

typedef enum SMSAPIUsage
{
    SMS_Use_Uninitialized,      
    SMS_Use_Legacy,             
    SMS_Use_New                 
}SMSAPIUsage;

/*
 *
 * SMS Messaging
 *
 * CDMA2000 1X modems can send and receive
 * SMS messages. To handle SMS messages, there
 * are many data types and structures involved.
 * Most of these relate to header content. The
 * details of the parameters in the SMS header are
 * defined in the CDMA specification and are
 * beyond the scope of this manual.
 *
 * Consult the documentation for a discussion of the SMS message handling 
 * process.
 *
 */

typedef enum SWI_TYPE_SMS_ParamMask
{
    SWI_SMS_PARAMASK_NO_PARAMS      = 0x00000000,   
    SWI_SMS_PARAMASK_BEARER_REPLY   = 0x00000001,

    SWI_SMS_PARAMASK_VALID_ABS      = 0x00000002,

    SWI_SMS_PARAMASK_VALID_REL      = 0x00000004,

    SWI_SMS_PARAMASK_DEFER_ABS      = 0x00000008,

    SWI_SMS_PARAMASK_DEFER_REL      = 0x00000010,

    SWI_SMS_PARAMASK_USER_RESP      = 0x00000020,   
    SWI_SMS_PARAMASK_ADDRESS        = 0x00000040,   
    SWI_SMS_PARAMASK_SUBADDR        = 0x00000080,   
    SWI_SMS_PARAMASK_USER_DATA      = 0x00000100,   
    SWI_SMS_PARAMASK_PRIORITY       = 0x00000200,   
    SWI_SMS_PARAMASK_PRIVACY        = 0x00000400,   
    SWI_SMS_PARAMASK_REPLY_OPT      = 0x00000800,

    SWI_SMS_PARAMASK_NUM_OF_MSG     = 0x00001000,   
    SWI_SMS_PARAMASK_ALERT          = 0x00002000,   
    SWI_SMS_PARAMASK_LANGUAGE       = 0x00004000,   
    SWI_SMS_PARAMASK_CALL_BACK      = 0x00008000,   
    SWI_SMS_PARAMASK_MC_TIME_STAMP  = 0x00010000,   
    SWI_SMS_PARAMASK_DISP_MODE      = 0x00020000    
}SWI_TYPE_SMS_ParamMask;

typedef enum SWI_TYPE_SMS_MsgCategory
{
    SWI_SMS_MSGCAT_POINT_TO_POINT,  
    SWI_SMS_MSGCAT_BROADCAST_MSG,   
    SWI_SMS_MSGCAT_ACK_MSG          
}SWI_TYPE_SMS_MsgCategory;

typedef enum SWI_TYPE_SMS_Teleservice
{
    SWI_SMS_TELESRV_CELL_PAGING,    
    SWI_SMS_TELESRV_CELL_MESSAGING,
    
    SWI_SMS_TELESRV_VOICE_MAIL_NOT,
    
    SWI_SMS_TELESRV_CLI_ORDER,
    
    SWI_SMS_TELESRV_VOICE_IND,

    SWI_SMS_TELESRV_SHORT_MSG,

    SWI_SMS_TELESRV_ALERT_INFO,     
    SWI_SMS_TELESRV_WAP             
}SWI_TYPE_SMS_Teleservice;

typedef enum SWI_TYPE_SMS_MsgIdType
{
    SWI_SMS_MSGIDTYPE_NOTUSED,      
    SWI_SMS_MSGIDTYPE_DELIVER,      
    SWI_SMS_MSGIDTYPE_SUBMIT,       
    SWI_SMS_MSGIDTYPE_CANCEL,
    SWI_SMS_MSGIDTYPE_DELIVERY_ACK, 
    SWI_SMS_MSGIDTYPE_USER_ACK
}SWI_TYPE_SMS_MsgIdType;

typedef enum SWI_TYPE_SMS_Priority
{
    SWI_SMS_PRIORITY_NORMAL,        
    SWI_SMS_PRIORITY_INTERACTIVE,   
    SWI_SMS_PRIORITY_URGENT,        
    SWI_SMS_PRIORITY_EMERGENCY      
}SWI_TYPE_SMS_Priority;

typedef enum SWI_TYPE_SMS_Privacy
{
    SWI_SMS_PRIVACY_NOT_RESTR,      
    SWI_SMS_PRIVACY_RESTRICTED,     
    SWI_SMS_PRIVACY_CONFIDENTIAL,   
    SWI_SMS_PRIVACY_SECRET          
}SWI_TYPE_SMS_Privacy;

typedef enum SWI_TYPE_SMS_Language
{
    SWI_SMS_LANGUAGE_UNSPECIFIED,   
    SWI_SMS_LANGUAGE_ENGLISH,       
    SWI_SMS_LANGUAGE_FRENCH,        
    SWI_SMS_LANGUAGE_SPANISH,       
    SWI_SMS_LANGUAGE_JAPANESE,      
    SWI_SMS_LANGUAGE_KOREAN,        
    SWI_SMS_LANGUAGE_CHINESE,       
    SWI_SMS_LANGUAGE_HEBREW         
}SWI_TYPE_SMS_Language;

typedef enum SWI_TYPE_SMS_MsgDispMode
{
    SWI_SMS_MSGDISPMODE_IMMEDIATE,      
    SWI_SMS_MSGDISPMODE_DEFAULT,        
    SWI_SMS_MSGDISPMODE_USER_INVOKE     
}SWI_TYPE_SMS_MsgDispMode;

typedef enum SWI_TYPE_SMS_DataEncodeType
{
    SWI_SMS_DATAENCODE_8bitAscii = 0,

    SWI_SMS_DATAENCODE_IS91EP,              
    SWI_SMS_DATAENCODE_7bitAscii,           
    SWI_SMS_DATAENCODE_IA5,

    SWI_SMS_DATAENCODE_Unicode,             
    SWI_SMS_DATAENCODE_Shift_Jis,

    SWI_SMS_DATAENCODE_Korean,              
    SWI_SMS_DATAENCODE_LatinHebrew,

    SWI_SMS_DATAENCODE_Latin,               
    SWI_SMS_DATAENCODE_GSM7BitDefault,

    SWI_SMS_DATAENCODE_MAX32 = 0x10000000   
}SWI_TYPE_SMS_DataEncodeType;

typedef enum SWI_TYPE_SMS_ErrorClass
{
    SWI_SMS_ERRORCLASS_NoError,     
    SWI_SMS_ERRORCLASS_Reserved,    
    SWI_SMS_ERRORCLASS_Temporary,   
    SWI_SMS_ERRORCLASS_Permanent
}SWI_TYPE_SMS_ErrorClass;

typedef enum SWI_TYPE_SMS_CauseCode
{
    SWI_SMS_CAUSECODE_AddressVacant                 = 0x00,
    SWI_SMS_CAUSECODE_AddressTranslationFailure,
    SWI_SMS_CAUSECODE_NetworkResourceShortage,
    SWI_SMS_CAUSECODE_NetworkFailure,
    SWI_SMS_CAUSECODE_InvalidTeleserviceId,
    SWI_SMS_CAUSECODE_OtherNetworkProblem,
    SWI_SMS_CAUSECODE_OtherNetworkProblemMoreFirst  = 0x06,
    SWI_SMS_CAUSECODE_OtherNetworkProblemMoreLast   = 0x1F,

    /* ! Below are terminal Problems */
    SWI_SMS_CAUSECODE_NoPageResponse                = 0x20,
    SWI_SMS_CAUSECODE_DestinationBusy,
    SWI_SMS_CAUSECODE_NoAck,
    SWI_SMS_CAUSECODE_DestinationResourceShortage,
    SWI_SMS_CAUSECODE_SmsDeliveryPostponed,
    SWI_SMS_CAUSECODE_DestinationOutOfService,
    SWI_SMS_CAUSECODE_DestinationNoLongerAtThisAddress,
    SWI_SMS_CAUSECODE_OtherTerminalProblem,
    SWI_SMS_CAUSECODE_OtherTerminalProblemMoreFirst = 0x28,
    SWI_SMS_CAUSECODE_OtherTerminalProblemMoreLast  = 0x2F,
    SWI_SMS_CAUSECODE_SmsDeliveryPostponedMoreFirst = 0x30,
    SWI_SMS_CAUSECODE_SmsDeliveryPostponedMoreLast  = 0x3F,

    SWI_SMS_CAUSECODE_Radio_If_Resource_Shortage    = 0x40,
    SWI_SMS_CAUSECODE_RadioIfIncompatible,
    SWI_SMS_CAUSECODE_OtherRadioIfProblem,
    SWI_SMS_CAUSECODE_OtherRadioIfProblemMoreFirst  = 0x43,
    SWI_SMS_CAUSECODE_OtherRadioIfProblemMoreLast   = 0x5F, 

    SWI_SMS_CAUSECODE_UnexpectedParmSize            = 0x60,
    SWI_SMS_CAUSECODE_SmsOriginationDenied,
    SWI_SMS_CAUSECODE_SmsTerminationDenied,
    SWI_SMS_CAUSECODE_SupplServiceNotSupported,
    SWI_SMS_CAUSECODE_SmsNotSupported,
    SWI_SMS_CAUSECODE_Reserved101,
    SWI_SMS_CAUSECODE_MissingExpectedParm,
    SWI_SMS_CAUSECODE_MissingMandatoryParm,
    SWI_SMS_CAUSECODE_UnrecognizedParmValue,
    SWI_SMS_CAUSECODE_UnexpectedParmValue,
    SWI_SMS_CAUSECODE_UserDataSizeError,
    SWI_SMS_CAUSECODE_OtherGeneralProblems,
    SWI_SMS_CAUSECODE_OtherGeneralProblemsMoreFirst = 0x6C,
    SWI_SMS_CAUSECODE_OtherGeneralProblemsMoreLast  = 0xFF,

    SWI_SMS_CAUSECODE_DtcCallDisconnect             = 0x4000,
    SWI_SMS_CAUSECODE_DtcCallError                  = 0x4001, 
    SWI_SMS_CAUSECODE_Ok                            = 0x8000,
    SWI_SMS_CAUSECODE_WaitingForTlAck,
    SWI_SMS_CAUSECODE_OutOfResources,
    SWI_SMS_CAUSECODE_AccesTooLarge,
    SWI_SMS_CAUSECODE_DtcTooLarge,
    SWI_SMS_CAUSECODE_NetworkNotReady,
    SWI_SMS_CAUSECODE_PhoneNotReady,
    SWI_SMS_CAUSECODE_NotAllowedInAmps,
    SWI_SMS_CAUSECODE_CannotSendBroadcast,
    SWI_SMS_CAUSECODE_InvalidTransactionID,
    SWI_SMS_CAUSECODE_MsgNotSent,
    SWI_SMS_CAUSECODE_MsgBeingSent
}SWI_TYPE_SMS_CauseCode;

typedef enum SWI_TYPE_PRI_SmsMask
{
    SWI_PRI_SMS_MT              = 0x0001,
    
    SWI_PRI_SMS_MO              = 0x0002,

    SWI_PRI_SMS_ALL             = 0xFFFF,   
    SWI_PRI_SMS_MASK_ENABLED    = 0x8000
}SWI_TYPE_PRI_SmsMask;

typedef struct SWI_STRUCT_CDMA_SMS_Status
{
    swi_uint32 sizeStruct;      
    swi_uint32 cntUrgentMsg;    
    swi_uint32 cntRegularMsg;   
    swi_uint32 cntVoiceMsg;     
}SWI_STRUCT_CDMA_SMS_Status;

typedef struct SWI_STRUCT_SMS_CdmaHeader
{
    swi_uint32 sizeStruct;      
    SWI_TYPE_SMS_ParamMask eParamMask;

    SWI_TYPE_SMS_MsgCategory eMsgCategory;    
    SWI_TYPE_SMS_Teleservice eTeleservice;    
    swi_uint16 serviceCategory;

    swi_uint8 tlAckReq;

    SWI_TYPE_SMS_MsgIdType eMsgIdType;      
    swi_uint8 addrDigitMode;                
    swi_uint8 addrNumMode;                  
    swi_uint8 addrNumType;                  
    swi_uint8 addrNumPlan;

    swi_uint8 addrLen;                      
    swi_char szAddress[MAX_SMSI_TL_ADDRESS];

    swi_uint8 subType;                      
    swi_uint8 subOdd;                       
    swi_uint8 subLen;                       
    swi_char szSubAddress[MAX_SMSI_TL_ADDRESS];

    swi_uint8 callBackLen;              
    swi_char szCallBack[MAX_SMSI_CALL_BACK];

    SWI_TYPE_SMS_Priority ePriority;        
    SWI_TYPE_SMS_Privacy ePrivacy;          
    SWI_TYPE_SMS_Language eLanguage;        
    swi_uint8 user_ack_req;

    swi_uint8 dak_req;

    swi_uint8 userResp;             
    swi_char szNumMsg[2];

    swi_uint8 deliveryAlert;        
    SWI_TYPE_SMS_DataEncodeType dataEncoding;

    swi_uint8 ts_yr;
    
    swi_uint8 ts_mon;
    
    swi_uint8 ts_day;

    swi_uint8 ts_hrs;

    swi_uint8 ts_min;

    swi_uint8 ts_sec;

    swi_uint8 abVal_yr;

    swi_uint8 abVal_mon;
    
    swi_uint8 abVal_day;
    
    swi_uint8 abVal_hrs;
    
    swi_uint8 abVal_min;
    
    swi_uint8 abVal_sec;
    
    swi_uint8 relVal_time;
    
    swi_uint8 abDef_yr;
    
    swi_uint8 abDef_mon;
    
    swi_uint8 abDef_day;
    
    swi_uint8 abDef_hrs;
    
    swi_uint8 abDef_min;

    swi_uint8 abDef_sec;
    
    swi_uint8 relDef_time;

    SWI_TYPE_SMS_MsgDispMode eMsgDispMode;  
}SWI_STRUCT_SMS_CdmaHeader;

typedef struct SWI_STRUCT_CDMA_SMS_RetrieveSms
{
    swi_uint32 sizeStruct;      
    swi_bool bUnreadSMS;            
    SWI_STRUCT_SMS_CdmaHeader sHeader;

    swi_uint16 nSMSId;  
    swi_uint32 cntRemainingSMS;
    
    swi_uint8 *pMessage;
    
    swi_uint32 sizeBuffer;

    swi_uint32 retrievedStatus;
}SWI_STRUCT_CDMA_SMS_RetrieveSms;

typedef struct SWI_STRUCT_CDMA_SMS_SendStatus
{
    swi_uint32 sizeStruct;      
    swi_uint32 nMsgID;

    SWI_TYPE_SMS_ErrorClass eErrorClass;    
    SWI_TYPE_SMS_CauseCode  eCauseCode;     
}SWI_STRUCT_CDMA_SMS_SendStatus;

typedef struct SWI_STRUCT_CDMA_SMS_StoreSms
{
    swi_uint32 sizeStruct;  
    swi_uint16 nSMSId;

    SWI_STRUCT_SMS_CdmaHeader sSMSHeader;
    
    swi_uint8 *pMsgBody;
    
    swi_uint32 sizeSMSBody;

    swi_uint32 bStoreStatus;    
}SWI_STRUCT_CDMA_SMS_StoreSms;

typedef struct CDMA_SMS_HEADER
{
    swi_uint32 paramMask;


    swi_uint8 msgCategory;    

    swi_uint8 teleservice;     

    swi_uint16 serviceCategory;

    swi_uint8 tlAckReq;

    swi_uint8 msgIdType;

    swi_uint8 addrDigitMode;
    swi_uint8 addrNumMode;
    swi_uint8 addrNumType;
    swi_uint8 addrNumPlan;
    swi_uint8 addrLen;
    swi_uint8 address[MAX_SMSI_TL_ADDRESS];

    swi_uint8 subType;
    swi_uint8 subOdd;
    swi_uint8 subLen;
    swi_uint8 subAddress[MAX_SMSI_TL_ADDRESS];

    swi_uint8 callBackLen;
    swi_uint8 callBack[MAX_SMSI_CALL_BACK];

    swi_uint8 priority;    

    swi_uint8 privacy;     

    swi_uint8 language;

    swi_uint8 user_ack_req;
    swi_uint8 dak_req;

    swi_uint8 userResp;

    swi_uint8 numMsg[2];

    swi_uint8 deliveryAlert;

    swi_uint8 dataEncoding;

    swi_uint8 ts_yr;        
    swi_uint8 ts_mon;        
    swi_uint8 ts_day;        
    swi_uint8 ts_hrs;        
    swi_uint8 ts_min;
    swi_uint8 ts_sec;

    swi_uint8 abVal_yr;
    swi_uint8 abVal_mon;
    swi_uint8 abVal_day;
    swi_uint8 abVal_hrs;
    swi_uint8 abVal_min;
    swi_uint8 abVal_sec;

    swi_uint8 relVal_time;

    swi_uint8 abDef_yr;
    swi_uint8 abDef_mon;
    swi_uint8 abDef_day;
    swi_uint8 abDef_hrs;
    swi_uint8 abDef_min;
    swi_uint8 abDef_sec;

    swi_uint8 relDef_time;

    swi_uint8 msgDispMode;

}CDMA_SMS_HEADER;

typedef struct CNS_SMS_HEADER
{
    swi_uint16 messageID;   
    swi_uint8 seqNumber;    
    swi_uint8 packetType;   

    swi_uint8 remainSms;    
    swi_uint8 length;       
}CNS_SMS_HEADER;

/* Function prototypes */

SWI_API SWI_RCODE SwiPriGetSMSMask(swi_uint16* smsMask, swi_uint32 timeout);

SWI_API SWI_RCODE SwiPriGetMaxMosmsLen(swi_uint16* puMaxLen,
                                       swi_uint32 timeout);

SWI_API SWI_RCODE SwiSendCdmaSMS(swi_uint32 timeout);

SWI_API SWI_RCODE SwiGetCdmaSMSMessageStatus(
                                      SWI_STRUCT_CDMA_SMS_Status *pSMS_Status,
                                      swi_uint32 timeout);

SWI_API SWI_RCODE SwiRetrieveCdmaSMSMessage(
                                      SWI_STRUCT_CDMA_SMS_RetrieveSms *pSMS,
                                      swi_uint32 timeout);

SWI_API SWI_RCODE SwiRetrieveSMSMessageEx(
                                      SWI_STRUCT_CDMA_SMS_RetrieveSms *pSms,
                                      swi_bool bDeleteAfterRetrieve,
                                      swi_uint32 timeout);

SWI_API SWI_RCODE SwiSetMessageRetrieved(swi_uint16 msgID, swi_uint32 timeout);

SWI_API SWI_RCODE SwiStoreCdmaSMSMessage(
                                      SWI_STRUCT_CDMA_SMS_StoreSms *pStoreSMS,
                                      swi_uint32 timeout);

#ifdef __cplusplus
} /* extern "C" { */
#endif

#endif /* __SWIAPICDMASMS_H__ */

/* 
 * $Log: SwiApiCdmaSms.h,v $
 */