SWI CDMA specific SMS related APIs. More...

#include "SwiDataTypes.h"
#include "SwiRcodes.h"

Data Structures
struct	SWI_STRUCT_CDMA_SMS_Status

struct	SWI_STRUCT_SMS_CdmaHeader

struct	SWI_STRUCT_CDMA_SMS_RetrieveSms

struct	SWI_STRUCT_CDMA_SMS_SendStatus

struct	SWI_STRUCT_CDMA_SMS_StoreSms

struct	CDMA_SMS_HEADER

struct	CNS_SMS_HEADER

Macros
#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

Typedefs
typedef enum SWI_SMS_PACKET_TYPE	SWI_SMS_PACKET_TYPE

typedef enum SMSAPIUsage	SMSAPIUsage

typedef enum SWI_TYPE_SMS_ParamMask	SWI_TYPE_SMS_ParamMask

typedef enum SWI_TYPE_SMS_MsgCategory	SWI_TYPE_SMS_MsgCategory

typedef enum SWI_TYPE_SMS_Teleservice	SWI_TYPE_SMS_Teleservice

typedef enum SWI_TYPE_SMS_MsgIdType	SWI_TYPE_SMS_MsgIdType

typedef enum SWI_TYPE_SMS_Priority	SWI_TYPE_SMS_Priority

typedef enum SWI_TYPE_SMS_Privacy	SWI_TYPE_SMS_Privacy

typedef enum SWI_TYPE_SMS_Language	SWI_TYPE_SMS_Language

typedef enum SWI_TYPE_SMS_MsgDispMode	SWI_TYPE_SMS_MsgDispMode

typedef enum SWI_TYPE_SMS_DataEncodeType	SWI_TYPE_SMS_DataEncodeType

typedef enum SWI_TYPE_SMS_ErrorClass	SWI_TYPE_SMS_ErrorClass

typedef enum SWI_TYPE_SMS_CauseCode	SWI_TYPE_SMS_CauseCode

typedef enum SWI_TYPE_PRI_SmsMask	SWI_TYPE_PRI_SmsMask

typedef struct SWI_STRUCT_CDMA_SMS_Status	SWI_STRUCT_CDMA_SMS_Status

typedef struct SWI_STRUCT_SMS_CdmaHeader	SWI_STRUCT_SMS_CdmaHeader

typedef struct SWI_STRUCT_CDMA_SMS_RetrieveSms	SWI_STRUCT_CDMA_SMS_RetrieveSms

typedef struct SWI_STRUCT_CDMA_SMS_SendStatus	SWI_STRUCT_CDMA_SMS_SendStatus

typedef struct SWI_STRUCT_CDMA_SMS_StoreSms	SWI_STRUCT_CDMA_SMS_StoreSms

typedef struct CDMA_SMS_HEADER	CDMA_SMS_HEADER

typedef struct CNS_SMS_HEADER	CNS_SMS_HEADER

Enumerations
enum	SWI_SMS_PACKET_TYPE { SMS_SEGMENT_INTERMEDIATE = 0x00, SMS_SEGMENT_FIRST, SMS_SEGMENT_LAST, SMS_NOT_SEGMENTED }

enum	SMSAPIUsage { SMS_Use_Uninitialized, SMS_Use_Legacy, SMS_Use_New }

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 }

enum	SWI_TYPE_SMS_MsgCategory { SWI_SMS_MSGCAT_POINT_TO_POINT, SWI_SMS_MSGCAT_BROADCAST_MSG, SWI_SMS_MSGCAT_ACK_MSG }

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 }

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 }

enum	SWI_TYPE_SMS_Priority { SWI_SMS_PRIORITY_NORMAL, SWI_SMS_PRIORITY_INTERACTIVE, SWI_SMS_PRIORITY_URGENT, SWI_SMS_PRIORITY_EMERGENCY }

enum	SWI_TYPE_SMS_Privacy { SWI_SMS_PRIVACY_NOT_RESTR, SWI_SMS_PRIVACY_RESTRICTED, SWI_SMS_PRIVACY_CONFIDENTIAL, SWI_SMS_PRIVACY_SECRET }

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 }

enum	SWI_TYPE_SMS_MsgDispMode { SWI_SMS_MSGDISPMODE_IMMEDIATE, SWI_SMS_MSGDISPMODE_DEFAULT, SWI_SMS_MSGDISPMODE_USER_INVOKE }

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 }

enum	SWI_TYPE_SMS_ErrorClass { SWI_SMS_ERRORCLASS_NoError, SWI_SMS_ERRORCLASS_Reserved, SWI_SMS_ERRORCLASS_Temporary, SWI_SMS_ERRORCLASS_Permanent }

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, 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 }

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 }

Functions
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)

Detailed Description

SWI CDMA specific SMS related APIs.

Macro Definition Documentation

#define CNS_MAX_PACKET_SIZE 256

Maximum CnS packet size

#define CNS_MAX_PAYLOAD_SIZE (CNS_MAX_PACKET_SIZE - CNS_PACKET_HEADER_SIZE)

Maximum CnS packet payload size

#define CNS_PACKET_HEADER_SIZE 10

Maximum CnS packet header size

#define CNS_SMS_HEADER_SIZE 6

Maximum SMS header size

#define CNS_SMS_MAX_SIZE (CNS_MAX_PAYLOAD_SIZE - CNS_SMS_HEADER_SIZE)

Maximum SMS size

#define MAX_SMSI_CALL_BACK 32

Maximum SMS callback length

#define MAX_SMSI_TL_ADDRESS 50

Maximum SMS address length

Typedef Documentation

typedef struct CDMA_SMS_HEADER CDMA_SMS_HEADER

Contains SMS header structure.

Note: While this appears redundant to SWI_STRUCT_SMS_CdmaHeader, they serve two different purposes. The below header is used to cast the payload, hence the strict definition of the member data types. SWI_STRUCT_SMS_CdmaHeader uses enum's in its members, to enforce proper setting by the developer for SDK/API use.

typedef struct CNS_SMS_HEADER CNS_SMS_HEADER

Contains general SMS header data.

typedef enum SMSAPIUsage SMSAPIUsage

An enumeration of SMS API type.

This enum will be used to indicate if the legacy SMS APIs [ SwiRetrieveSmsMessage ] are used instead of the new [ SwiRetrieveSmsMessageEx and SwiSetMessageRetrieved ] APIs. The two sets above are mutually exclusive. And the mode will be switched to whoever uses the APIs first. So, if the first call happens to a new API, the mode will be switched to that and shall remain so throughout the life of the program.

typedef enum SWI_SMS_PACKET_TYPE SWI_SMS_PACKET_TYPE

An enumeration of SMS packet type.

typedef struct SWI_STRUCT_CDMA_SMS_RetrieveSms SWI_STRUCT_CDMA_SMS_RetrieveSms

Contains CDMA SMS header.

This structure is used to provide input to, and receive output from the SwiRetrieveSMSMessage function.

typedef struct SWI_STRUCT_CDMA_SMS_SendStatus SWI_STRUCT_CDMA_SMS_SendStatus

Contains SMS Send Status notification data structure.

This data structure is used as a member of the notification SWI_NOTIFY_SmsSendStatus. Refer to the description of SWI_NOTIFY_SmsSendStatus for more detail.

typedef struct SWI_STRUCT_CDMA_SMS_Status SWI_STRUCT_CDMA_SMS_Status

Contains status of SMS messages on the modem.

This structure reports the number of SMS messages in each of the three buffers in the modem: urgent, regular, and voice.

typedef struct SWI_STRUCT_CDMA_SMS_StoreSms SWI_STRUCT_CDMA_SMS_StoreSms

Contains data used to store SMS.

This structure is used to provide input to the SwiStoreCdmaSMSMessage function.

typedef struct SWI_STRUCT_SMS_CdmaHeader SWI_STRUCT_SMS_CdmaHeader

Contains CDMA SMS header.

A portion of SWI_STRUCT_CDMA_SMS_RetrieveSms, this structure defines the header of incoming SMS messages. Most of the data items are defined in the CDMA specification and are not explained here. The enumerated types are described following this structure.

typedef enum SWI_TYPE_PRI_SmsMask SWI_TYPE_PRI_SmsMask

An enumeration of SMS support mask bit.

The enumerated mask bits identifies the SMS features supported by the modem.

typedef enum SWI_TYPE_SMS_CauseCode SWI_TYPE_SMS_CauseCode

An enumeration of SMS send cause code.

This enumeration identifies the possible Cause Code values that may be returned with the notification SWI_NOTIFY_SmsSendStatus

For detailed explanation of each of the codes, please refer to the IS-41 SMS Standard.

typedef enum SWI_TYPE_SMS_DataEncodeType SWI_TYPE_SMS_DataEncodeType

An enumeration of possible data encoding methods used on the SMS message body.

For a more complete list, see SMS standard TSB-58C.

typedef enum SWI_TYPE_SMS_ErrorClass SWI_TYPE_SMS_ErrorClass

An enumeration of SMS send error class

This enumeration identifies the possible Error Class values that may be returned with the notification SWI_NOTIFY_SmsSendStatus

typedef enum SWI_TYPE_SMS_Language SWI_TYPE_SMS_Language

An enumeration of SMS message body language.

typedef enum SWI_TYPE_SMS_MsgCategory SWI_TYPE_SMS_MsgCategory

An enumeration of SMS category.

typedef enum SWI_TYPE_SMS_MsgDispMode SWI_TYPE_SMS_MsgDispMode

An enumeration of SMS display mode.

typedef enum SWI_TYPE_SMS_MsgIdType SWI_TYPE_SMS_MsgIdType

An enumeration of SMS ID.

typedef enum SWI_TYPE_SMS_ParamMask SWI_TYPE_SMS_ParamMask

An enumeration of SMS parameter mask.

typedef enum SWI_TYPE_SMS_Priority SWI_TYPE_SMS_Priority

An enumeration of SMS priority.

typedef enum SWI_TYPE_SMS_Privacy SWI_TYPE_SMS_Privacy

An enumeration of SMS privacy.

typedef enum SWI_TYPE_SMS_Teleservice SWI_TYPE_SMS_Teleservice

An enumeration of SMS teleservice.

Refer to TIA/EIA-41-D Table 175 for further information.

Enumeration Type Documentation

enum SMSAPIUsage

An enumeration of SMS API type.

This enum will be used to indicate if the legacy SMS APIs [ SwiRetrieveSmsMessage ] are used instead of the new [ SwiRetrieveSmsMessageEx and SwiSetMessageRetrieved ] APIs. The two sets above are mutually exclusive. And the mode will be switched to whoever uses the APIs first. So, if the first call happens to a new API, the mode will be switched to that and shall remain so throughout the life of the program.

Enumerator
SMS_Use_Uninitialized	Not know yet.
SMS_Use_Legacy	Use legacy SWI SMS API
SMS_Use_New	Use new SWI SMS API

enum SWI_SMS_PACKET_TYPE

An enumeration of SMS packet type.

Enumerator
SMS_SEGMENT_INTERMEDIATE	Intermediate segment
SMS_SEGMENT_FIRST	First segment
SMS_SEGMENT_LAST	Last segment
SMS_NOT_SEGMENTED	Not a segment

enum SWI_TYPE_PRI_SmsMask

An enumeration of SMS support mask bit.

The enumerated mask bits identifies the SMS features supported by the modem.

Enumerator
SWI_PRI_SMS_MT	Mobile Terminated (Incoming) SMS supported
SWI_PRI_SMS_MO	Mobile Originated (Outgoing) SMS supported
SWI_PRI_SMS_ALL	Internal Use
SWI_PRI_SMS_MASK_ENABLED	Enabled bit (Internal use only)

enum SWI_TYPE_SMS_CauseCode

An enumeration of SMS send cause code.

This enumeration identifies the possible Cause Code values that may be returned with the notification SWI_NOTIFY_SmsSendStatus

For detailed explanation of each of the codes, please refer to the IS-41 SMS Standard.

Enumerator
SWI_SMS_CAUSECODE_AddressVacant	Below are network problems
SWI_SMS_CAUSECODE_AddressTranslationFailure
SWI_SMS_CAUSECODE_NetworkResourceShortage
SWI_SMS_CAUSECODE_NetworkFailure
SWI_SMS_CAUSECODE_InvalidTeleserviceId
SWI_SMS_CAUSECODE_OtherNetworkProblem
SWI_SMS_CAUSECODE_OtherNetworkProblemMoreFirst
SWI_SMS_CAUSECODE_OtherNetworkProblemMoreLast
SWI_SMS_CAUSECODE_NoPageResponse
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
SWI_SMS_CAUSECODE_OtherTerminalProblemMoreLast
SWI_SMS_CAUSECODE_SmsDeliveryPostponedMoreFirst
SWI_SMS_CAUSECODE_SmsDeliveryPostponedMoreLast
SWI_SMS_CAUSECODE_Radio_If_Resource_Shortage	Below are radio Interface Problems
SWI_SMS_CAUSECODE_RadioIfIncompatible
SWI_SMS_CAUSECODE_OtherRadioIfProblem
SWI_SMS_CAUSECODE_OtherRadioIfProblemMoreFirst
SWI_SMS_CAUSECODE_OtherRadioIfProblemMoreLast
SWI_SMS_CAUSECODE_UnexpectedParmSize	Below are general Problems
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
SWI_SMS_CAUSECODE_OtherGeneralProblemsMoreLast
SWI_SMS_CAUSECODE_DtcCallDisconnect	Below are internal SMS Cause Code (From the Mobile Station)
SWI_SMS_CAUSECODE_DtcCallError
SWI_SMS_CAUSECODE_Ok
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

enum SWI_TYPE_SMS_DataEncodeType

An enumeration of possible data encoding methods used on the SMS message body.

For a more complete list, see SMS standard TSB-58C.

Enumerator
SWI_SMS_DATAENCODE_8bitAscii	Octet, unspecified (i.e. Binary)
SWI_SMS_DATAENCODE_IS91EP	varies
SWI_SMS_DATAENCODE_7bitAscii	Standard ascii, 7-bit
SWI_SMS_DATAENCODE_IA5	7-bit encoding (International Alphabet No.5 same as ASCII)
SWI_SMS_DATAENCODE_Unicode	Unicode
SWI_SMS_DATAENCODE_Shift_Jis	8 or 16-bit. It's also known as SJIS or MS Kanji for Japanese support
SWI_SMS_DATAENCODE_Korean	8 or 16-bit. Korean support
SWI_SMS_DATAENCODE_LatinHebrew	8-bit. specific to the Hebrew script ISO-8859-8 and Windows-1255
SWI_SMS_DATAENCODE_Latin	HEBREW
SWI_SMS_DATAENCODE_GSM7BitDefault	7-bit. defined in ETSI GSM 03.38
SWI_SMS_DATAENCODE_MAX32	Place holder

enum SWI_TYPE_SMS_ErrorClass

An enumeration of SMS send error class

This enumeration identifies the possible Error Class values that may be returned with the notification SWI_NOTIFY_SmsSendStatus

Enumerator
SWI_SMS_ERRORCLASS_NoError	No Error
SWI_SMS_ERRORCLASS_Reserved	Reserved (Ignore)
SWI_SMS_ERRORCLASS_Temporary	Temporary. A retry is recommended
SWI_SMS_ERRORCLASS_Permanent	Permanent. A retry is not recommened

enum SWI_TYPE_SMS_Language

An enumeration of SMS message body language.

Enumerator
SWI_SMS_LANGUAGE_UNSPECIFIED	UNSPECIFIED
SWI_SMS_LANGUAGE_ENGLISH	ENGLISH
SWI_SMS_LANGUAGE_FRENCH	FRENCH
SWI_SMS_LANGUAGE_SPANISH	SPANISH
SWI_SMS_LANGUAGE_JAPANESE	JAPANESE
SWI_SMS_LANGUAGE_KOREAN	KOREAN
SWI_SMS_LANGUAGE_CHINESE	CHINESE
SWI_SMS_LANGUAGE_HEBREW	HEBREW

enum SWI_TYPE_SMS_MsgCategory

An enumeration of SMS category.

Enumerator
SWI_SMS_MSGCAT_POINT_TO_POINT	IS-637 SMS Point-to-Point Message
SWI_SMS_MSGCAT_BROADCAST_MSG	IS-637 SMS Broadcast Message
SWI_SMS_MSGCAT_ACK_MSG	IS-637 SMS Acknowledge Message

enum SWI_TYPE_SMS_MsgDispMode

An enumeration of SMS display mode.

Enumerator
SWI_SMS_MSGDISPMODE_IMMEDIATE	Immediate Display
SWI_SMS_MSGDISPMODE_DEFAULT	Radio default setting
SWI_SMS_MSGDISPMODE_USER_INVOKE	User Invoke

enum SWI_TYPE_SMS_MsgIdType

An enumeration of SMS ID.

Enumerator
SWI_SMS_MSGIDTYPE_NOTUSED	NOT USED
SWI_SMS_MSGIDTYPE_DELIVER	Deliver (Regular MT SMS)
SWI_SMS_MSGIDTYPE_SUBMIT	Submit (Regular MO SMS)
SWI_SMS_MSGIDTYPE_CANCEL	Cancel previous SMS delivery (MO Only)
SWI_SMS_MSGIDTYPE_DELIVERY_ACK	Delivery Ack. (MT Only)
SWI_SMS_MSGIDTYPE_USER_ACK	User Acknowledgement (Either Directions)

enum SWI_TYPE_SMS_ParamMask

An enumeration of SMS parameter mask.

Enumerator
SWI_SMS_PARAMASK_NO_PARAMS	No parameters set
SWI_SMS_PARAMASK_BEARER_REPLY	Bearer Reply (TL Ack.)
SWI_SMS_PARAMASK_VALID_ABS	Absolute Validity Time
SWI_SMS_PARAMASK_VALID_REL	Relative Validity Time
SWI_SMS_PARAMASK_DEFER_ABS	Absolute Delivery Deferral Time
SWI_SMS_PARAMASK_DEFER_REL	Relative Delivery Deferral Time
SWI_SMS_PARAMASK_USER_RESP	User Response
SWI_SMS_PARAMASK_ADDRESS	Address
SWI_SMS_PARAMASK_SUBADDR	Sub Address
SWI_SMS_PARAMASK_USER_DATA	Data Encoding
SWI_SMS_PARAMASK_PRIORITY	Priority
SWI_SMS_PARAMASK_PRIVACY	Privacy
SWI_SMS_PARAMASK_REPLY_OPT	Reply Option (DAK & User Ack)
SWI_SMS_PARAMASK_NUM_OF_MSG	Number of Messages
SWI_SMS_PARAMASK_ALERT	Delivery Alert
SWI_SMS_PARAMASK_LANGUAGE	Language
SWI_SMS_PARAMASK_CALL_BACK	Call Back Number
SWI_SMS_PARAMASK_MC_TIME_STAMP	Time Stamp
SWI_SMS_PARAMASK_DISP_MODE	Display Mode

enum SWI_TYPE_SMS_Priority

An enumeration of SMS priority.

Enumerator
SWI_SMS_PRIORITY_NORMAL	Normal
SWI_SMS_PRIORITY_INTERACTIVE	Interactive
SWI_SMS_PRIORITY_URGENT	Urgent
SWI_SMS_PRIORITY_EMERGENCY	Emergency

enum SWI_TYPE_SMS_Privacy

An enumeration of SMS privacy.

Enumerator
SWI_SMS_PRIVACY_NOT_RESTR	Not restricted (Level 0)
SWI_SMS_PRIVACY_RESTRICTED	Restricted (Level 1)
SWI_SMS_PRIVACY_CONFIDENTIAL	Confidential (Level 2)
SWI_SMS_PRIVACY_SECRET	Secret (Level 3)

enum SWI_TYPE_SMS_Teleservice

An enumeration of SMS teleservice.

Refer to TIA/EIA-41-D Table 175 for further information.

Enumerator
SWI_SMS_TELESRV_CELL_PAGING	SMSI_CPT_95: IS-95A Cellular Paging
SWI_SMS_TELESRV_CELL_MESSAGING	SMSI_CMT_95: IS-95A Cellular Messaging
SWI_SMS_TELESRV_VOICE_MAIL_NOT	SMSI_VMN_95: IS-95A Voice Mail Notification
SWI_SMS_TELESRV_CLI_ORDER	SMSI_CMT_91_CLI: IS-91 Extended Protocol - CLI Order
SWI_SMS_TELESRV_VOICE_IND	SMSI_CMT_91_VOICE_MAIL: IS-91 Extended Protocol - Voice Mail and Embedded Message Waiting Indicator
SWI_SMS_TELESRV_SHORT_MSG	SMSI_CMT_91_SHORT_MSG: IS-91 Extended Protocol - Short Message
SWI_SMS_TELESRV_ALERT_INFO	SMSI_AWI_95: IS-95A Alert With Info
SWI_SMS_TELESRV_WAP	SMSI_WAP: WAP Message

Function Documentation

SWI_API SWI_RCODE SwiGetCdmaSMSMessageStatus	(	SWI_STRUCT_CDMA_SMS_Status *	pSMS_Status,
		swi_uint32	timeout
	)

This function queries the outstanding SMS message status

Parameters

pSMS_Status[OUT]	Outstanding SMS message status.
timeout[IN]	Function timeout in milliseconds.

Returns: See SwiRcodes.h

SWI_API SWI_RCODE SwiPriGetMaxMosmsLen	(	swi_uint16 *	puMaxLen,
		swi_uint32	timeout
	)

This function gets maximum outgoing SMS length

Parameters

puMaxLen[OUT]	The destination in which the maximum length in bytes is returned.
timeout[IN]	Function timeout in milliseconds.

Returns: See SwiRcodes.h

SWI_API SWI_RCODE SwiPriGetSMSMask	(	swi_uint16 *	smsMask,
		swi_uint32	timeout
	)

This function reports the modem's SMS capabilities.

Parameters

smsMask[OUT]	The destination in which the the data is returned. Possible mask bit values are defined in SWI_TYPE_PRI_SmsMask.
timeout[IN]	Function timeout in milliseconds.

Returns: See SwiRcodes.h

SWI_API SWI_RCODE SwiRetrieveCdmaSMSMessage	(	SWI_STRUCT_CDMA_SMS_RetrieveSms *	pSms,
		swi_uint32	timeout
	)

This function retrieves an SMS message

Parameters

pSms[OUT]	SMS message struct.
timeout[IN]	Function timeout in milliseconds.

Returns: See SwiRcodes.h

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

This function retrieves an SMS message along with an option to delete it or not.

Parameters

pSms[OUT]	Memory to save SMS message retrieved.
bDeleteAfterRetrieve[IN]	Delete the message from modem after retrieval if TRUE; Otherwise leave it in the modem store.
timeout[IN]	Function timeout in milliseconds.

Returns: See SwiRcodes.h

SWI_API SWI_RCODE SwiSendCdmaSMS ( swi_uint32 timeout )

This function starts sending stored SMS messages.

Parameters

timeout[IN] Function timeout in milliseconds.

Returns: See SwiRcodes.h

SWI_API SWI_RCODE SwiSetMessageRetrieved	(	swi_uint16	msgID,
		swi_uint32	timeout
	)

This function sets a message as retrieved so modem can delete it

Parameters

msgID[IN]	SMS message ID to be deleted.
timeout[IN]	Function timeout in milliseconds.

Returns: See SwiRcodes.h

SWI_API SWI_RCODE SwiStoreCdmaSMSMessage	(	SWI_STRUCT_CDMA_SMS_StoreSms *	psStoreSms,
		swi_uint32	timeout
	)

This function is used to store an SMS message.

Parameters

psStoreSms[OUT]	SMS message to store.
timeout[IN]	Function timeout in milliseconds.

Returns: See SwiRcodes.h

Data Structures

Macros

Typedefs

Enumerations

Functions

Detailed Description

Macro Definition Documentation

Typedef Documentation

Enumeration Type Documentation

Function Documentation