LinuxSDK  V1.4.0.5
SwiApiCdmaBasic.h
Go to the documentation of this file.
1 
14 #ifndef __SWIAPICDMABASIC_H__
15 #define __SWIAPICDMABASIC_H__
16 
17 #ifdef __cplusplus
18 extern "C" {
19 #endif
20 
21 /* include files */
22 #include "SwiDataTypes.h"
23 #include "SwiRcodes.h"
24 
25 #define G_SZ_FNERINAM1 "eri_nam1"
26 
28 #define CNS_MAX_DATA_BLOCK_SIZE 120
29 
30 #define LENGTH_NvNameNam 12
31 #define LENGTH_PhoneNumberMin 10
32 #define LENGTH_NVItemPayloadMax 240
33 #define LENGTH_Mdn 15
34 #define LENGTH_Min 10
35 #define LENGTH_PinPassword 4
36 #define LENGTH_SecureChallenge 8
37 #define LENGTH_SecureRebuttal 4
38 #define LENGTH_ProvisioningDate 8
40 #define LENGTH_CallNumber 32
41 #define LENGTH_CallExtendedNumber 64
43 #define SCP_PROT_SUBTYPE_MASK 0x000000F9
44 #define SCP_BCMCS_SUBTYPE_MASK 0
45 #define SCP_APP_SUBTYPE_MASK 1
53 typedef enum SWI_TYPE_Commit_ErrorMask
54 {
55  SWI_COMMIT_ERRMASK_NONE = 0x00000000,
56  SWI_COMMIT_ERRMASK_MDN = 0x00000001,
57  SWI_COMMIT_ERRMASK_IMSI = 0x00000002,
58  SWI_COMMIT_ERRMASK_USERIDPW = 0x00000004,
59  SWI_COMMIT_ERRMASK_DATE = 0x00000008,
61  /* NAM profile index out of sequence. (NAM 0 must always be provisioned
62  first) */
63  SWI_COMMIT_ERRMASK_NAMORDER = 0x00000010
64 }SWI_TYPE_Commit_ErrorMask;
65 
71 typedef struct SWI_STRUCT_Tech_Hdr_Mac_Index
72 {
73  swi_uint32 sizeStruct;
75  swi_uint8 mac_index_available;
76  swi_uint8 mac_index;
77 }SWI_STRUCT_Tech_Hdr_Mac_Index;
78 
87 typedef enum SWI_TYPE_E911Mode
88 {
89  SWI_E911_MODE_Off,
90  SWI_E911_MODE_On
91 }SWI_TYPE_E911Mode;
92 
99 typedef struct SWI_STRUCT_E911Mode
100 {
101  swi_uint32 sizeStruct;
104  SWI_TYPE_E911Mode eMode;
105 }SWI_STRUCT_E911Mode;
106 
116 typedef struct SWI_STRUCT_PowerSaveEnter
117 {
118  swi_uint32 sizeStruct;
119  /* no data */
120 }SWI_STRUCT_PowerSaveEnter;
121 
131 typedef struct SWI_STRUCT_PowerSaveExit
132 {
133  swi_uint32 sizeStruct;
134  /* no data */
135 }SWI_STRUCT_PowerSaveExit;
136 
142 typedef enum SWI_TYPE_PRI_VoiceDataMask
143 {
144  SWI_PRI_DATA_1X = 0x0001,
147  SWI_PRI_DATA_IS95 = 0x0002,
148 
150  SWI_PRI_DATA_AUTOCONNECT = 0x0004,
151 
152 #if FUTURE_USE
153  SWI_PRI_DATA_ = 0x0008,
154  SWI_PRI_DATA_ = 0x0010,
155  SWI_PRI_DATA_ = 0x0020,
156  SWI_PRI_DATA_ = 0x0040,
157 #endif
158  SWI_PRI_VOICE = 0x0080,
159  SWI_PRI_VD_ALL = 0xFFFF,
162  SWI_PRI_VD_MASK_ENABLED = 0x8000
163 }SWI_TYPE_PRI_VoiceDataMask;
164 
170 typedef enum SWI_TYPE_CarrierID
171 {
172  SWI_CARRIER_UNDEFINED = -1,
173  SWI_CARRIER_RESERVED = 0,
174  SWI_CARRIER_AC555_GENERIC,
175  SWI_CARRIER_AC550_SPRINT,
176  SWI_CARRIER_AC555_BELL,
177  SWI_CARRIER_AC555_TELUS,
178  SWI_CARRIER_AC555_VZW,
179  SWI_CARRIER_AC555_WESTERNWIRELESS,
180  SWI_CARRIER_AC555_SMARTCOM,
181  SWI_CARRIER_AC555_ALLTEL,
182  SWI_CARRIER_AC555_USCELLULAR,
183  SWI_CARRIER_SB550T_SPRINT,
184  SWI_CARRIER_SB555T_BELL,
185  SWI_CARRIER_SB555T_TELUS,
186  SWI_CARRIER_SB555T_VZW,
187  SWI_CARRIER_AC555_CHINAUNICOM,
188  SWI_CARRIER_AC555_HUTCHISONTHAILAND,
189  SWI_CARRIER_AC555_MOVILNET,
190  SWI_CARRIER_AC555_TARJETAS_IUSACELL_MEXICO,
191  SWI_CARRIER_AC555_TELECOMNEWZEALAND,
192  SWI_CARRIER_AC555_RELIANCE,
193  SWI_CARRIER_AC555_TELSTRA,
194  SWI_CARRIER_AC555_MOBILITYCANADA,
195  SWI_CARRIER_AC555_VZW_PUERTO_RICO,
196  SWI_CARRIER_AC555_PELEPHONE,
197  SWI_CARRIER_AC555_BELL_CANADA,
198  SWI_CARRIER_AC555_INDOSOL_INDONESIA,
199  SWI_CARRIER_AC555_MIDWEST_WIRELESS,
200  SWI_CARRIER_AC555_BELL_SOUTH_CHILE,
201  SWI_CARRIER_AC555_BELL_SOUTH_PANAMA,
202  SWI_CARRIER_AC555_TATA
203 }SWI_TYPE_CarrierID;
204 
210 typedef enum SWI_TYPE_DistributorID
211 {
212  SWI_DISTRIBUTOR_UNDEFINED = -1,
213  SWI_DISTRIBUTOR_NONE = 0,
214  SWI_DISTRIBUTOR_SIERRA_WIRELESS = 1,
215  SWI_DISTRIBUTOR_EASTCOM = 2,
216  SWI_DISTRIBUTOR_TONGFANG = 3,
217  SWI_DISTRIBUTOR_ZTE = 4,
218  SWI_DISTRIBUTOR_CHINA_PUTIAN = 5,
219  SWI_DISTRIBUTOR_NCL = 6,
220  SWI_DISTRIBUTOR_SHANGHAI_BELL = 7
221 }SWI_TYPE_DistributorID;
222 
228 typedef struct SWI_STRUCT_HdrNotificationStatus
229 {
230  swi_uint32 sizeStruct;
231  swi_uint16 iHdrNotificationStatus;
232 }SWI_STRUCT_HdrNotificationStatus;
233 
239 typedef enum SWI_TYPE_Digital_Mode
240 {
241  SWI_HDR_MODE_NO_SERVICE = 0x00000000,
242  SWI_HDR_MODE_AMPS = 0x00000001,
243  SWI_HDR_MODE_CDMA = 0x00000002,
244  SWI_HDR_MODE_GSM = 0x00000003,
245  SWI_HDR_MODE_HDR = 0x00000004,
246  SWI_HDR_MODE_WCDMA = 0x00000005,
247  SWI_HDR_MODE_GPS = 0x00000006
248 }SWI_TYPE_Digital_Mode;
249 
256 typedef struct SWI_STRUCT_Idle_Digital_Mode
257 {
258  swi_uint32 sizeStruct;
261  swi_uint16 iPrevIdleDigitalMode;
262 
264  swi_uint16 iCurrIdleDigitalMode;
265 }SWI_STRUCT_Idle_Digital_Mode;
266 
276 typedef struct SWI_STRUCT_Hdr_PowerSave_Enter
277 {
278  swi_uint32 sizeStruct;
279  /* no data */
280 }SWI_STRUCT_Hdr_PowerSave_Enter;
281 
291 typedef struct SWI_STRUCT_Hdr_PowerSave_Exit
292 {
293  swi_uint32 sizeStruct;
294  /* no data */
295 }SWI_STRUCT_Hdr_PowerSave_Exit;
296 
302 typedef enum SWI_TYPE_Device_CDMA_Settings
303 {
304  SWI_REV_UNKNOWN = 0x00ff,
305  SWI_REV_0 = 0x0000,
306  SWI_REV_A = 0x0001
307 }SWI_TYPE_Device_CDMA_Settings;
308 
314 typedef struct SWI_STRUCT_MeidEsn
315 {
316  swi_uint32 sizeStruct;
320  swi_uint16 nMeidEnabled;
321 
324  swi_uint16 nMeidPresent;
325 
328  swi_uint32 nMeidHigh;
329 
332  swi_uint32 nMeidLow;
333 
335  swi_uint32 nPEsn;
336 
339  swi_uint16 nTEsnPresent;
340 
342  swi_uint32 nEsn;
343 
344 }SWI_STRUCT_MeidEsn;
345 
346 /* Below are from SwiApiExt.h */
347 /*
348  * TYPE DEFINITIONS
349  */
350 
356 typedef enum SWI_TYPE_General_Features
357 {
358  SWI_GEN_FEATURE_IOTA_2_4 = 0x00000001,
359  SWI_GEN_FEATURE_ENH_GPS = 0x00000002,
360  SWI_GEN_FEATURE_ENH_LED = 0x00000004,
361  SWI_GEN_FEATURE_RESERVED3 = 0x00000008,
362  SWI_GEN_FEATURE_RESERVED4 = 0x00000010,
363  SWI_GEN_FEATURE_RESERVED5 = 0x00000020,
364  SWI_GEN_FEATURE_RESERVED6 = 0x00000040,
365  SWI_GEN_FEATURE_RESERVED7 = 0x00000080,
366  SWI_GEN_FEATURE_RESERVED8 = 0x00000100,
367  SWI_GEN_FEATURE_RESERVED9 = 0x00000200
368  /*remaining bits reserved for future feature definitions... */
369 }SWI_TYPE_General_Features;
370 
376 typedef enum SWI_TYPE_LED_TYPE
377 {
378  SWI_LED_TYPE_UNDEFINED = 0x00,
379  SWI_LED_TYPE_POWER_AMBER = 0x01,
380  SWI_LED_TYPE_SIGNAL_AMBER = 0x02,
381  SWI_LED_TYPE_POWER_BLUE = 0x03,
382  SWI_LED_TYPE_SIGNAL_BLUE = 0x04,
383  SWI_LED_TYPE_GLOWTOP = 0x05,
384  SWI_LED_TYPE_RESVD1 = 0x06,
385  SWI_LED_TYPE_RESVD2 = 0x07,
386  SWI_LED_TYPE_RESVD3 = 0x08,
387  SWI_LED_TYPE_RESVD4 = 0x09
388 }SWI_TYPE_LED_TYPE;
389 
395 typedef enum SWI_TYPE_LED_ENABLE_STATE
396 {
397  SWI_LED_DISABLED = 0,
398  SWI_LED_ENABLED = 1
399 }SWI_TYPE_LED_ENABLE_STATE;
400 
401 #define SWI_MAX_LEDS 10
408 typedef struct SWI_STRUCT_LED_CFG_ENABLE
409 {
410  swi_uint8 nType[SWI_MAX_LEDS];
411  swi_uint8 bEnable[SWI_MAX_LEDS];
412 }SWI_STRUCT_LED_CFG_ENABLE;
413 
419 typedef struct SWI_STRUCT_EFileInfo
420 {
421  swi_uint32 sizeStruct;
422  swi_uint16 nResult;
423  swi_uint32 nSize;
424  swi_uint16 nBlocks;
425 }SWI_STRUCT_EFileInfo;
426 
435 typedef struct CNS_HDRSCP_subtype_custom_config_type
436 {
438  swi_uint16 custom_config_is_active;
439 
440  swi_uint32 prot_subtype_mask;
441  swi_uint32 bcmcs_subtype_mask;
442  swi_uint32 app_subtype_mask;
443 } CNS_HDRSCP_subtype_custom_config_type;
444 
445 /* Function prototypes */
446 
447 SWI_API SWI_RCODE SwiSetEFile(const swi_charp pszEFilename,
448  swi_uint8* pBuffer,
449  swi_uint16 nBufLen,
450  swi_uint32 timeout);
451 
452 SWI_API SWI_RCODE SwiGetEFileInfo(const swi_charp pszEFilename,
453  SWI_STRUCT_EFileInfo* psEFileInfo,
454  swi_uint32 timeout);
455 
456 SWI_API SWI_RCODE SwiGetEFileBlock(const swi_charp pszEFilename,
457  swi_uint16 nSeq,
458  swi_uint8* pBuffer,
459  swi_uint16 nBufLen,
460  swi_uint32 *pnBlockSize,
461  swi_uint32 timeout);
462 
463 SWI_API SWI_RCODE SwiSetPRLSize(swi_uint16 Nam,
464  swi_uint32 nSize,
465  swi_uint32 timeout);
466 
467 SWI_API SWI_RCODE SwiIsModemReady(swi_uint32 timeout);
468 SWI_API SWI_RCODE SwiGetESN(swi_int32* lEsn, swi_uint32 timeout);
469 
470 SWI_API SWI_RCODE SwiGetMEIDESN(SWI_STRUCT_MeidEsn *pMeidEsn,
471  swi_uint32 timeout);
472 
473 SWI_API SWI_RCODE SwiGetPRLVersion(swi_uint16* pPrlVersion,
474  swi_uint32 timeout);
475 
476 SWI_API SWI_RCODE SwiGetTemperature(swi_int32 *iTemperature,
477  swi_uint32 timeout);
478 
479 SWI_API SWI_RCODE SwiGetActivationStatus(swi_uint16* pActivationStatus,
480  swi_uint32 timeout);
481 
482 SWI_API SWI_RCODE SwiGetPhoneNumber(swi_charp PhoneNumber,
483  swi_uint32 BufferSize,
484  swi_uint32 timeout);
485 
486 SWI_API SWI_RCODE SwiPriGetVoiceDataMask(swi_uint16* voiceDataMask,
487  swi_uint32 timeout);
488 
489 SWI_API SWI_RCODE SwiGetCarrierID(swi_int16* pnCarrierID, swi_uint32 timeout);
490 
491 SWI_API SWI_RCODE SwiGetDistributorID(swi_int16* pnDistributorID,
492  swi_uint32 timeout);
493 
494 SWI_API SWI_RCODE SwiGetSystemTime(swi_uint16 *year,
495  swi_uint16 *month,
496  swi_uint16 *day,
497  swi_uint16 *weekDay,
498  swi_uint16 *hour,
499  swi_uint16 *minute,
500  swi_uint16 *second,
501  swi_uint32 timeout);
502 
503 SWI_API SWI_RCODE SwiGetE911Mode(swi_uint16* e911Mode, swi_uint32 timeout);
504 SWI_API SWI_RCODE SwiSetE911Mode(swi_uint16 e911Mode, swi_uint32 timeout);
505 SWI_API SWI_RCODE SwiGetECIO(swi_uint16* pEcio, swi_uint32 timeout);
506 
507 SWI_API SWI_RCODE SwiGetNamInfo(swi_uint16 *cntNamProfile,
508  swi_uint16 *nextNamProfile,
509  swi_uint32 timeout);
510 
511 SWI_API SWI_RCODE SwiPstGetCurrentNam(swi_uint16 *CurrentNam,
512  swi_uint32 timeout);
513 
514 SWI_API SWI_RCODE SwiGetNamValidStatus(swi_uint16* pNamValidStatus,
515  swi_uint32 timeout);
516 
517 SWI_API SWI_RCODE SwiPstSetCurrentNam(swi_uint16 CurrentNam,
518  swi_uint32 timeout);
519 
520 SWI_API SWI_RCODE SwiGetProvisioningDate(swi_uint16 namIndex,
521  swi_charp pszProvisioningData,
522  swi_uint32 length,
523  swi_uint32 timeout);
524 
525 SWI_API SWI_RCODE SwiGetCdmaIMSI(swi_uint16 namIndex,
526  swi_charp pszMIN,
527  swi_uint32 length,
528  swi_uint32 timeout);
529 
530 SWI_API SWI_RCODE SwiPstUnlock(swi_uint32 SubsidyLock, swi_uint32 timeout);
531 
532 SWI_API SWI_RCODE SwiSetIMSI(swi_uint16 namIndex,
533  const swi_charp pszMIN,
534  swi_uint32 timeout);
535 
536 SWI_API SWI_RCODE SwiPstLock(swi_uint16 Type,
537  swi_uint16 Nam,
538  swi_uint16* commitResult,
539  swi_uint16* failureMask,
540  swi_uint32 timeout);
541 
542 SWI_API SWI_RCODE SwiResetModem();
543 SWI_API SWI_RCODE SwiSetModemOffline();
544 
545 SWI_API SWI_RCODE SwiGetLockStatus(swi_uint16* pLockStatus,
546  swi_uint32 timeout);
547 
548 SWI_API SWI_RCODE SwiGetAutoLock(swi_uint16* autoLock, swi_uint32 timeout);
549 SWI_API SWI_RCODE SwiSetAutoLock(swi_uint16 autoLock, swi_uint32 timeout);
550 
551 SWI_API SWI_RCODE SwiLockModem(const swi_charp Password,
552  swi_uint16* pResponse,
553  swi_uint32 timeout);
554 
555 SWI_API SWI_RCODE SwiChangeLockPIN(const swi_charp OldPassword,
556  const swi_charp NewPassword,
557  swi_uint16* pResponse,
558  swi_uint32 timeout);
559 
560 SWI_API SWI_RCODE SwiGetERIVer(const swi_charp pszERIFilename,
561  swi_uint16* pnERIVer,
562  swi_uint32 timeout);
563 
564 SWI_API SWI_RCODE SwiPowerSaveExit();
565 SWI_API SWI_RCODE SwiSetPower(swi_uint16 fwPowerState);
566 
567 SWI_API SWI_RCODE SwiNotifyEx(swi_uint16 eNotify,
568  swi_uint16 mask,
569  swi_uint32 timeout);
570 
571 SWI_API SWI_RCODE SwiPstGetAccolc(swi_uint16 Nam,
572  swi_uint16 *Accolc,
573  swi_uint32 timeout);
574 
575 SWI_API SWI_RCODE SwiPstSetAccolc(swi_uint16 Nam,
576  swi_uint16 Accolc,
577  swi_uint32 timeout);
578 
579 SWI_API SWI_RCODE SwiPstGetSci(swi_uint16 *Sci, swi_uint32 timeout);
580 
581 SWI_API SWI_RCODE SwiSetPRL(swi_uint16 NamIndex,
582  swi_uint8* pPRLBuffer,
583  swi_uint16 nPRLBufLen,
584  swi_uint32 timeout);
585 
586 SWI_API SWI_RCODE SwiSetPRLEx(swi_uint16 NamIndex,
587  swi_uint8* pPRLBuffer,
588  swi_uint16 nPRLBufLen,
589  swi_uint32 timeout);
590 
591 SWI_API SWI_RCODE SwiSetERI(swi_uint8* pERIBuffer,
592  swi_uint16 nERIBufLen,
593  swi_uint32 timeout);
594 
595 SWI_API SWI_RCODE SwiGetTotalUpTime(swi_uint32* pTotalUpTime,
596  swi_uint32 timeout);
597 
598 SWI_API SWI_RCODE SwiPstGetImsiMS1(swi_uint16 Nam,
599  swi_uint32 *IMSI,
600  swi_uint32 timeout);
601 
602 SWI_API SWI_RCODE SwiPstSetImsiMS1(swi_uint16 Nam,
603  swi_uint32 Imsi_MS1,
604  swi_uint32 timeout);
605 
606 SWI_API SWI_RCODE SwiPstGetImsiMS2(swi_uint16 Nam,
607  swi_uint16 *Imsi_MS2,
608  swi_uint32 timeout);
609 
610 SWI_API SWI_RCODE SwiPstSetImsiMS2(swi_uint16 Nam,
611  swi_uint16 Imsi_MS2,
612  swi_uint32 timeout);
613 
614 SWI_API SWI_RCODE SwiPstGetNamName(swi_uint16 Nam,
615  swi_charp pszNamName,
616  swi_uint32 length,
617  swi_uint32 timeout);
618 
619 SWI_API SWI_RCODE SwiPstSetNamName(swi_uint16 Nam,
620  const swi_charp pszNamName,
621  swi_uint32 timeout);
622 
623 SWI_API SWI_RCODE SwiPstGetImsiMcc(swi_uint16 Nam,
624  swi_uint16 *Mcc,
625  swi_uint32 timeout);
626 
627 SWI_API SWI_RCODE SwiPstSetImsiMcc(swi_uint16 Nam,
628  swi_uint16 Mcc,
629  swi_uint32 timeout);
630 
631 SWI_API SWI_RCODE SwiPstGetImsi1112(swi_uint16 Nam,
632  swi_uint16 *Digits1112,
633  swi_uint32 timeout);
634 
635 SWI_API SWI_RCODE SwiPstSetImsi1112(swi_uint16 Nam,
636  swi_uint16 Digits1112,
637  swi_uint32 timeout);
638 
639 SWI_API SWI_RCODE SwiSetAKey(swi_charp szAKey, swi_uint32 timeout);
640 SWI_API SWI_RCODE SwiRtnReset(swi_uint8 nType, swi_uint32 timeout);
641 
642 SWI_API SWI_RCODE SwiGetTechHdrMacIndex(
643  SWI_STRUCT_Tech_Hdr_Mac_Index *pTechHdrMacIndex,
644  swi_uint32 timeout);
645 
646 SWI_API SWI_RCODE SwiGetLEDEnable(swi_bool *pbEnable, swi_uint32 timeout);
647 SWI_API SWI_RCODE SwiSetLEDEnable(swi_bool bEnable, swi_uint32 timeout);
648 
649 SWI_API SWI_RCODE SwiGetLEDEnableEx(SWI_STRUCT_LED_CFG_ENABLE *pLED,
650  swi_uint32 timeout);
651 
652 SWI_API SWI_RCODE SwiSetLEDEnableEx(const SWI_STRUCT_LED_CFG_ENABLE *pLED,
653  swi_uint32 timeout);
654 
655 SWI_API SWI_RCODE SwiGetGeneralFeatureSupport(swi_uint32 *pMask,
656  swi_uint32 timeout);
657 
658 SWI_API SWI_RCODE SwiGetDeviceEVDOSetting(swi_uint16 *pwMask,
659  swi_uint32 timeout);
660 
661 SWI_API SWI_RCODE SwiSetDeviceEVDOSetting(swi_uint16 wMask,
662  swi_uint32 timeout);
663 
664 SWI_API SWI_RCODE SwiGetStationClassMark(swi_uint8 *pbSCM,
665  swi_uint32 timeout);
666 
667 SWI_API SWI_RCODE SwiGetPRIVersion(swi_uint8 *pMajor, swi_uint8 *pMinor,
668  swi_uint32 timeout);
669 
670 SWI_API SWI_RCODE SwiGetPortMapping(swi_uint8 * pnPortMapping,
671  swi_uint32 timeout);
672 
673 SWI_API SWI_RCODE SwiSetPortMapping(swi_uint8 nPortMapping,
674  swi_uint32 timeout);
675 
676 
677 #ifdef __cplusplus
678 } /* extern "C" { */
679 #endif
680 
681 #endif /* __SWIAPICDMABASIC_H__ */
682 
683 /*
684  * $Log: SwiApiCdmaBasic.h,v $
685  */
686 
Linux SDK V1.4.0.5
Copyright (c) 2011 Sierra Wireless, Inc. All rights reserved