00001 00002 // // 00003 // $Revision: 1 $ // 00004 // // 00005 // Name : SwiMPApiCm.h // 00006 // // 00007 // Purpose : SWI MP API // 00008 // // 00009 // Note : The contents of this header file are specific to the // 00010 // MP 7XX API and do not concern the AirCard 7XX API // 00011 // // 00012 // Copyright (c) 2003 Sierra Wireless, Inc. All rights reserved // 00013 // // 00015 #ifndef _SWI_MP_API_ 00016 #define _SWI_MP_API_ 00017 00018 #ifdef __cplusplus 00019 extern "C" { 00020 #endif 00021 00022 #include "SwiRcodes.h" 00023 #include "SwiStructsMp.h" 00024 #include "SwiApiCm.h" 00025 00027 // 00028 // Name: SwiStopAllMpNotif - to stop the modem from sending MP notifications 00029 // 00030 // Purpose: This function is used to stop the modem from sending all MP notifications. 00031 // 00032 // A request is sent to the modem. The modem's response indicates that 00033 // the request is being processed. 00034 // 00035 // The caller must specify the amount of time to wait for the modem 00036 // to respond to the request. 00037 // 00038 // Parameters: 00039 // 00040 // timeout[IN]: response timeout value in milliseconds 00041 // 00042 // Return: SWI_RCODE_OK - the request has been received by the modem 00043 // SWI_RCODE_REQUEST_TIMEOUT - the request has timed out 00044 // See SWI_RCODE for other error return codes 00045 // 00046 // Notes: None 00047 // 00049 SWI_API SWI_RCODE SwiStopAllMpNotif(U32 timeout); 00050 00052 // 00053 // Name: SwiSwitchMode - switch between data link modes 00054 // 00055 // Purpose: This function is used to switch the method in which the API 00056 // communicates with the modem. 00057 // 00058 // A request is sent to the modem. The modem's response indicates a 00059 // success or failure. 00060 // 00061 // Parameters: 00062 // 00063 // eMode[IN]: stores the data link mode to switch to 00064 // 00065 // Return: SWI_RCODE_OK - the request was successful 00066 // SWI_RCODE_REQUEST_TIMEOUT - the request has timed out 00067 // See SWI_RCODE for other error return codes 00068 // 00069 // Notes: None 00070 // 00072 SWI_API SWI_RCODE SwiSwitchMode(SWI_TYPE_SwitchMode eMode); 00073 00075 // 00076 // Name: SwiGetSwitchMode - get the current data link mode 00077 // 00078 // Purpose: This function is used to get the current method that the API 00079 // uses to communicate with the modem. 00080 // 00081 // A request is sent to the modem. The modem's response sucess or 00082 // failure. 00083 // 00084 // Parameters: 00085 // 00086 // eMode[OUT]: stores the current data link mode 00087 // 00088 // Return: SWI_RCODE_OK - the request is successful 00089 // SWI_RCODE_REQUEST_TIMEOUT - the request has timed out 00090 // See SWI_RCODE for other error return codes 00091 // 00092 // Notes: None 00093 // 00095 SWI_API SWI_RCODE SwiGetSwitchMode(SWI_TYPE_SwitchMode *eMode); 00096 00098 // 00099 // Name: SwiGetExternalDigitalIOConfig - Get external digital input/output configuration 00100 // 00101 // Purpose: The host software uses function to retrieve the current 00102 // configuration of the specified external digital I/O. A notification 00103 // (SWI_STRUCT_EXT_DIO_Notif) returns the current logic level of all the I/O's. 00104 // 00105 // A request is sent to the modem. The modem's response indicates that 00106 // the request is being processed. 00107 // 00108 // The caller must specify the amount of time to wait for the modem 00109 // to respond to the request. 00110 // 00111 // Parameters: 00112 // 00113 // psDio[OUT]: structure stores external digital I/O information retrieved 00114 // 00115 // timeout[IN]: response timeout value in milliseconds 00116 // 00117 // Return: SWI_RCODE_OK - the request has been received by the modem 00118 // SWI_RCODE_REQUEST_TIMEOUT - the request has timed out 00119 // See SWI_RCODE for other error return codes 00120 // 00121 // Notes: None 00122 // 00124 SWI_API SWI_RCODE SwiGetExternalDigitalIOConfig(SWI_STRUCT_ExtDioCfg *psDio, U32 timeout); 00125 00127 // 00128 // Name: SwiSetExternalDigitalIOConfig - Set external digital input/output configuration 00129 // 00130 // Purpose: The host software uses function to configure an external 00131 // digital I/O using the set request. The set request configures only 00132 // the specified I/O line. 00133 // 00134 // A request is sent to the modem. The modem's response indicates that 00135 // the request is being processed. 00136 // 00137 // The caller must specify the amount of time to wait for the modem 00138 // to respond to the request. 00139 // 00140 // Parameters: 00141 // 00142 // psDio[IN]: structure stores external digital I/O information to set 00143 // 00144 // timeout[IN]: response timeout value in milliseconds 00145 // 00146 // Return: SWI_RCODE_OK - the request has been received by the modem 00147 // SWI_RCODE_REQUEST_TIMEOUT - the request has timed out 00148 // See SWI_RCODE for other error return codes 00149 // 00150 // Notes: None 00151 // 00153 SWI_API SWI_RCODE SwiSetExternalDigitalIOConfig(SWI_STRUCT_ExtDioCfg *psDio, U32 timeout); 00154 00156 // 00157 // Name: SwiGetExternalAnalogIOConfig - get external analog input configuration 00158 // 00159 // Purpose: The host software uses this function to retrieve the current 00160 // configuration of the specified external analog input. The notification 00161 // returns the current logic level of all the Input's. 00162 // 00163 // A request is sent to the modem. The modem's response indicates that 00164 // the request is being processed. 00165 // 00166 // The caller must specify the amount of time to wait for the modem 00167 // to respond to the request. 00168 // 00169 // Parameters: 00170 // 00171 // psAi[OUT]: stores external analog input information retrieved 00172 // 00173 // timeout[IN]: response timeout value in milliseconds 00174 // 00175 // Return: SWI_RCODE_OK - the request has been received by the modem 00176 // SWI_RCODE_REQUEST_TIMEOUT - the request has timed out 00177 // See SWI_RCODE for other error return codes 00178 // 00179 // Notes: None 00180 // 00182 SWI_API SWI_RCODE SwiGetExternalAnalogIOConfig(SWI_STRUCT_ExtAiCfg *psAi, U32 timeout); 00183 00185 // 00186 // Name: SwiSetExternalAnalogIOConfig - set external analog input configuration 00187 // 00188 // Purpose: The host software uses this to set the logic level of 00189 // an external digital output using the set request. The set request 00190 // configures only the specified I/O line. 00191 // 00192 // A request is sent to the modem. The modem's response indicates that 00193 // the request is being processed. 00194 // 00195 // The caller must specify the amount of time to wait for the modem 00196 // to respond to the request. 00197 // 00198 // Parameters: 00199 // 00200 // psAi[IN]: stores external analog input information to set 00201 // 00202 // timeout[IN]: response timeout value in milliseconds 00203 // 00204 // Return: SWI_RCODE_OK - the request has been received by the modem 00205 // SWI_RCODE_REQUEST_TIMEOUT - the request has timed out 00206 // See SWI_RCODE for other error return codes 00207 // 00208 // Notes: None 00209 // 00211 SWI_API SWI_RCODE SwiSetExternalAnalogIOConfig(SWI_STRUCT_ExtAiCfg *psAi, U32 timeout); 00212 00214 // 00215 // Name: SwiSetGPSCommand - send a GPS command to the GPS module 00216 // 00217 // Purpose: This function is used to send GPS commands to the GPS module 00218 // 00219 // A request is sent to the modem. The modem's response indicates that 00220 // the request is being processed. 00221 // 00222 // The caller must specify the amount of time to wait for the modem 00223 // to respond to the request. 00224 // 00225 // Parameters: 00226 // 00227 // sGpsCommand[IN]: stores the GPS command to be sent to the GPS module 00228 // 00229 // timeout[IN]: response timeout value in milliseconds 00230 // 00231 // Return: SWI_RCODE_OK - the request has been received by the modem 00232 // SWI_RCODE_REQUEST_TIMEOUT - the request has timed out 00233 // See SWI_RCODE for other error return codes 00234 // 00235 // Notes: None 00236 // 00238 SWI_API SWI_RCODE SwiSetGPSCommand (SWI_STRUCT_GpsCommand sGpsCommand, U32 timeout); 00239 00241 // 00242 // Name: SwiSetGpsReset - Reset the GPS module 00243 // 00244 // Purpose: This function is used to send a GPS reset command to the GPS module 00245 // 00246 // A request is sent to the modem. The modem's response indicates that 00247 // the request is being processed. 00248 // 00249 // The caller must specify the amount of time to wait for the modem 00250 // to respond to the request. 00251 // 00252 // Parameters: 00253 // 00254 // timeout[IN]: response timeout value in milliseconds 00255 // 00256 // Return: SWI_RCODE_OK - the request has been received by the modem 00257 // SWI_RCODE_REQUEST_TIMEOUT - the request has timed out 00258 // See SWI_RCODE for other error return codes 00259 // 00260 // Notes: None 00261 // 00263 SWI_API SWI_RCODE SwiSetGpsReset (U32 timeout); 00264 00266 // 00267 // Name: SwiGetMpProductRevision - Get the Product Revision 00268 // 00269 // Purpose: This function is used to get the product revision information from the modem 00270 // 00271 // A request is sent to the modem. The modem's response indicates that 00272 // the request is being processed. 00273 // 00274 // The caller must specify the amount of time to wait for the modem 00275 // to respond to the request. 00276 // 00277 // Parameters: 00278 // 00279 // psMpRevision[OUT]: stores product revision information 00280 // 00281 // timeout[IN]: response timeout value in milliseconds 00282 // 00283 // Return: SWI_RCODE_OK - the request has been received by the modem 00284 // SWI_RCODE_REQUEST_TIMEOUT - the request has timed out 00285 // See SWI_RCODE for other error return codes 00286 // 00287 // Notes: None 00288 // 00290 SWI_API SWI_RCODE SwiGetMpProductRevision (SWI_STRUCT_MpRevision *psMPRevision, U32 timeout); 00291 00293 // 00294 // Name: SwiGetMPDataCount - Get the Data Counter 00295 // 00296 // Purpose: This function is used to get data counter information. Proper 00297 // information must be set in 'pMPDataCount' before passing the 00298 // structure into the function for data retrieval. Refer to comments 00299 // for SWI_STRUCT_MpDataCount for more information. 00300 // 00301 // A request is sent to the modem. The modem's response indicates that 00302 // the request is being processed. 00303 // 00304 // The caller must specify the amount of time to wait for the modem 00305 // to respond to the request. 00306 // 00307 // Parameters: 00308 // 00309 // psMPDataCount[OUT]: stores data counter information retrieved 00310 // 00311 // timeout[IN]: response timeout value in milliseconds 00312 // 00313 // Return: SWI_RCODE_OK - the request has been received by the modem 00314 // SWI_RCODE_REQUEST_TIMEOUT - the request has timed out 00315 // See SWI_RCODE for other error return codes 00316 // 00317 // Notes: None 00318 // 00320 SWI_API SWI_RCODE SwiGetMpDataCount (SWI_STRUCT_MpDataCount *pMPDataCount, U32 timeout); 00321 00323 // 00324 // Name: SwiClearMPByteCount - Reset the Byte Counter 00325 // 00326 // Purpose: This function is used to clear the total byte counter statistics. User 00327 // must set the appropriate values for nYear, nMonth, nDay, nHour, 00328 // nMinute, and nSecond in sMpDataCount before passing it into this 00329 // function. 00330 // 00331 // A request is sent to the modem. The modem's response indicates that 00332 // the request is being processed. 00333 // 00334 // The caller must specify the amount of time to wait for the modem 00335 // to respond to the request. 00336 // 00337 // Parameters: 00338 // 00339 // sMpDataCount[IN]: stores reset information 00340 // 00341 // timeout[IN]: response timeout value in milliseconds 00342 // 00343 // Return: SWI_RCODE_OK - the request has been received by the modem 00344 // SWI_RCODE_REQUEST_TIMEOUT - the request has timed out 00345 // See SWI_RCODE for other error return codes 00346 // 00347 // Notes: None 00348 // 00350 SWI_API SWI_RCODE SwiClearMpByteCount (SWI_STRUCT_MpDataCount sMpDataCount, U32 timeout); 00351 00353 // 00354 // Name: SwiResetMpTrafficStatistics - Reset the session byte counter 00355 // 00356 // Purpose: This function is used to reset session byte counter. 00357 // 00358 // A request is sent to the modem. The modem's response indicates that 00359 // the request is being processed. 00360 // 00361 // The caller must specify the amount of time to wait for the modem 00362 // to respond to the request. 00363 // 00364 // Parameters: 00365 // 00366 // timeout[IN]: response timeout value in milliseconds 00367 // 00368 // Return: SWI_RCODE_OK - the request has been received by the modem 00369 // SWI_RCODE_REQUEST_TIMEOUT - the request has timed out 00370 // See SWI_RCODE for other error return codes 00371 // 00372 // Notes: None 00373 // 00375 SWI_API SWI_RCODE SwiResetMpTrafficStatistics (U32 timeout); 00376 00378 // 00379 // Name: SwiGetMpIgnitionSense - get the delay time between loss of ignition sense 00380 // and powering off the modem 00381 // 00382 // Purpose: Used by host software to retrieve the 'time delay' value, ie. the 00383 // 'time delay' between lost of ignition sense and modem power-off. 00384 // 00385 // A request is sent to the modem. The modem's response indicates that 00386 // the request is being processed. 00387 // 00388 // The caller must specify the amount of time to wait for the modem 00389 // to respond to the request. 00390 // 00391 // Parameters: 00392 // 00393 // nDelay[OUT]: stores the time delay value 00394 // 00395 // timeout[IN]: response timeout value in milliseconds 00396 // 00397 // Return: SWI_RCODE_OK - the request has been received by the modem 00398 // SWI_RCODE_REQUEST_TIMEOUT - the request has timed out 00399 // See SWI_RCODE for other error return codes 00400 // 00401 // Notes: None 00402 // 00404 SWI_API SWI_RCODE SwiGetMpIgnitionSense(U32* nDelay, U32 timeout); 00405 00406 00408 // 00409 // Name: SwiSetMpIgnitionSense - set a delay time between loss of ignition sense 00410 // and powering off the modem 00411 // 00412 // Purpose: The host software uses this function to specify a delay time 00413 // (in minutes) between loss of ignition sense and powering-off the modem. 00414 // This allows the modem to continue operation for a limited period after 00415 // the vehicle ignition is switched off. This setting is stored in 00416 // non-volatile memory. 00417 // 00418 // The notification (SWI_NOTIFY_MPIgnSense) first informs the host software when the 00419 // ignition is turned off. When the shutdown time approaches, other notifications are 00420 // sent to the host software indicating that the MP750 will soon be shutdown. 00421 // 00422 // If the ignition sense (accessory power) is turned on again before the 00423 // power down time has expired, the timer is stopped and MP750 will not shutdown. 00424 // In addition, if a set request is sent after the delay timer has started, 00425 // but not yet expired, the MP750 continues with the current timer value. 00426 // The new timer value is used when the ignition is turned back on. 00427 // 00428 // A request is sent to the modem. The modem's response indicates that 00429 // the request is being processed. 00430 // 00431 // The caller must specify the amount of time to wait for the modem 00432 // to respond to the request. 00433 // 00434 // Parameters: 00435 // 00436 // nDelay[IN]: delay time in minutes between loss of ignition sense and 00437 // powering-off the modem 00438 // 00439 // timeout[IN]: response timeout value in milliseconds 00440 // 00441 // Return: SWI_RCODE_OK - the request has been received by the modem 00442 // SWI_RCODE_REQUEST_TIMEOUT - the request has timed out 00443 // See SWI_RCODE for other error return codes 00444 // 00445 // Notes: None 00446 // 00448 SWI_API SWI_RCODE SwiSetMpIgnitionSense (U32 nDelay, U32 timeout); 00449 00451 // 00452 // Name: SwiGetMpNetworkConf - Get network configuration 00453 // 00454 // Purpose: The host software uses this function to retrieve the network configuration 00455 // stored on the MP750. 00456 // 00457 // A request is sent to the modem. The modem's response indicates that 00458 // the request is being processed. 00459 // 00460 // The caller must specify the amount of time to wait for the modem 00461 // to respond to the request. 00462 // 00463 // Parameters: 00464 // 00465 // sNetworkConf[OUT]: stores network configuration information retrieved 00466 // 00467 // timeout[IN]: response timeout value in milliseconds 00468 // 00469 // Return: SWI_RCODE_OK - the request has been received by the modem 00470 // SWI_RCODE_REQUEST_TIMEOUT - the request has timed out 00471 // See SWI_RCODE for other error return codes 00472 // 00473 // Notes: None 00474 // 00476 SWI_API SWI_RCODE SwiGetMpNetworkConf(SWI_STRUCT_MpNetworkConf *sNetworkConf, U32 timeout); 00477 00479 // 00480 // Name: SwiSetMpNetworkConf - Set network configuration 00481 // 00482 // Purpose: The host software uses this function to set the network configuration 00483 // stored on the MP750. 00484 // 00485 // 00486 // A request is sent to the modem. The modem's response indicates that 00487 // the request is being processed. 00488 // 00489 // The caller must specify the amount of time to wait for the modem 00490 // to respond to the request. 00491 // 00492 // Parameters: 00493 // 00494 // sNetworkConf[IN]: stores the network configuration information to set 00495 // 00496 // timeout[IN]: response timeout value in milliseconds 00497 // 00498 // Return: SWI_RCODE_OK - the request has been received by the modem 00499 // SWI_RCODE_REQUEST_TIMEOUT - the request has timed out 00500 // See SWI_RCODE for other error return codes 00501 // 00502 // Notes: None 00503 // 00505 SWI_API SWI_RCODE SwiSetMpNetworkConf(SWI_STRUCT_MpNetworkConf sNetworkConf, U32 timeout); 00506 00508 // 00509 // Name: SwiGetMpFwVersion - retrieves the MP firmware version 00510 // 00511 // Purpose: This function is used to retrieve the firmware version of your MP750. 00512 // 00513 // A request is sent to the modem. The modem's response indicates that 00514 // the request is being processed. 00515 // 00516 // The caller must specify the amount of time to wait for the modem 00517 // to respond to the request. 00518 // 00519 // Parameters: 00520 // 00521 // sVersion[OUT]: structure which stores the firmware version 00522 // 00523 // timeout[IN]: response timeout value in milliseconds 00524 // 00525 // Return: SWI_RCODE_OK - the request has been received by the modem 00526 // SWI_RCODE_REQUEST_TIMEOUT - the request has timed out 00527 // See SWI_RCODE for other error return codes 00528 // 00529 // Notes: None 00530 // 00532 SWI_API SWI_RCODE SwiGetMpFwVersion(SWI_STRUCT_MpFwVersion* sVersion, U32 timeout); 00533 00535 // 00536 // Name: SwiGetMpFwBuildDate - retrieves the MP firmware build date 00537 // 00538 // Purpose: This function is used to retrieve the MP firmware build date. 00539 // 00540 // A request is sent to the modem. The modem's response indicates that 00541 // the request is being processed. 00542 // 00543 // The caller must specify the amount of time to wait for the modem 00544 // to respond to the request. 00545 // 00546 // Parameters: 00547 // 00548 // sBuildDate[OUT]: structure which stores the firmware build date 00549 // 00550 // timeout[IN]: response timeout value in milliseconds 00551 // 00552 // Return: SWI_RCODE_OK - the request has been received by the modem 00553 // SWI_RCODE_REQUEST_TIMEOUT - the request has timed out 00554 // See SWI_RCODE for other error return codes 00555 // 00556 // Notes: None 00557 // 00559 SWI_API SWI_RCODE SwiGetMpFwBuildDate(SWI_STRUCT_MpFwBuildDate* sBuildDate, U32 timeout); 00560 00562 // 00563 // Name: SwiGetMpBootLoaderVersion - retrieves the MP boot loader version 00564 // 00565 // Purpose: This function is used to retrieve the MP boot loader version 00566 // 00567 // A request is sent to the modem. The modem's response indicates that 00568 // the request is being processed. 00569 // 00570 // The caller must specify the amount of time to wait for the modem 00571 // to respond to the request. 00572 // 00573 // Parameters: 00574 // 00575 // sVersion[OUT]: structure which stores the boot loader version 00576 // 00577 // timeout[IN]: response timeout value in milliseconds 00578 // 00579 // Return: SWI_RCODE_OK - the request has been received by the modem 00580 // SWI_RCODE_REQUEST_TIMEOUT - the request has timed out 00581 // See SWI_RCODE for other error return codes 00582 // 00583 // Notes: None 00584 // 00586 SWI_API SWI_RCODE SwiGetMpBootLoaderVersion(SWI_STRUCT_MpBootLoaderVersion* sVersion, U32 timeout); 00587 00589 // 00590 // Name: SwiGetMpHwVersion - retrieves the MP hardware version 00591 // 00592 // Purpose: This function is used to retrieve the MP hardware version. 00593 // 00594 // A request is sent to the modem. The modem's response indicates that 00595 // the request is being processed. 00596 // 00597 // The caller must specify the amount of time to wait for the modem 00598 // to respond to the request. 00599 // 00600 // Parameters: 00601 // 00602 // sVersion[OUT]: structure which stores the hardware version 00603 // 00604 // timeout[IN]: response timeout value in milliseconds 00605 // 00606 // Return: SWI_RCODE_OK - the request has been received by the modem 00607 // SWI_RCODE_REQUEST_TIMEOUT - the request has timed out 00608 // See SWI_RCODE for other error return codes 00609 // 00610 // Notes: None 00611 // 00613 SWI_API SWI_RCODE SwiGetMpHwVersion(SWI_STRUCT_MpHwVersion* sVersion, U32 timeout); 00614 00616 // 00617 // Name: SwiGetMpHwBuildDate - retrieves the MP hardware build date 00618 // 00619 // Purpose: This function is used to retrieve the MP hardware build date. 00620 // 00621 // A request is sent to the modem. The modem's response indicates that 00622 // the request is being processed. 00623 // 00624 // The caller must specify the amount of time to wait for the modem 00625 // to respond to the request. 00626 // 00627 // Parameters: 00628 // 00629 // sVersion[OUT]: structure which stores the hardware build date 00630 // 00631 // timeout[IN]: response timeout value in milliseconds 00632 // 00633 // Return: SWI_RCODE_OK - the request has been received by the modem 00634 // SWI_RCODE_REQUEST_TIMEOUT - the request has timed out 00635 // See SWI_RCODE for other error return codes 00636 // 00637 // Notes: None 00638 // 00640 SWI_API SWI_RCODE SwiGetMpHwBuildDate(SWI_STRUCT_MpHwBuildDate* sVersion, U32 timeout); 00641 00643 // 00644 // Name: SwiGetMpBatchNumber - retrieves the MP batch number 00645 // 00646 // Purpose: This function is used to retrieve the MP batch number. 00647 // 00648 // A request is sent to the modem. The modem's response indicates that 00649 // the request is being processed. 00650 // 00651 // The caller must specify the amount of time to wait for the modem 00652 // to respond to the request. 00653 // 00654 // Parameters: 00655 // 00656 // sNumber[OUT]: structure which stores the batch number 00657 // 00658 // timeout[IN]: response timeout value in milliseconds 00659 // 00660 // Return: SWI_RCODE_OK - the request has been received by the modem 00661 // SWI_RCODE_REQUEST_TIMEOUT - the request has timed out 00662 // See SWI_RCODE for other error return codes 00663 // 00664 // Notes: None 00665 // 00667 SWI_API SWI_RCODE SwiGetMpBatchNumber(SWI_STRUCT_MpBatchNumber* sNumber, U32 timeout); 00668 00670 // 00671 // Name: SwiGetMpFsn - retrieves the MP Fsn number 00672 // 00673 // Purpose: This function is used to retrieve the MP Fsn number. 00674 // 00675 // A request is sent to the modem. The modem's response indicates that 00676 // the request is being processed. 00677 // 00678 // The caller must specify the amount of time to wait for the modem 00679 // to respond to the request. 00680 // 00681 // Parameters: 00682 // 00683 // sFsn[OUT]: structure which stores the Fsn number 00684 // 00685 // timeout[IN]: response timeout value in milliseconds 00686 // 00687 // Return: SWI_RCODE_OK - the request has been received by the modem 00688 // SWI_RCODE_REQUEST_TIMEOUT - the request has timed out 00689 // See SWI_RCODE for other error return codes 00690 // 00691 // Notes: None 00692 // 00694 SWI_API SWI_RCODE SwiGetMpFsn(SWI_STRUCT_MpFsn* sFsn, U32 timeout); 00695 00697 // 00698 // Name: SwiGetMpDeviceName - retrieves the MP device name 00699 // 00700 // Purpose: This function is used to retrieve the MP device name. 00701 // 00702 // A request is sent to the modem. The modem's response indicates that 00703 // the request is being processed. 00704 // 00705 // The caller must specify the amount of time to wait for the modem 00706 // to respond to the request. 00707 // 00708 // Parameters: 00709 // 00710 // sDeviceName[OUT]: structure which stores the device name 00711 // 00712 // timeout[IN]: response timeout value in milliseconds 00713 // 00714 // Return: SWI_RCODE_OK - the request has been received by the modem 00715 // SWI_RCODE_REQUEST_TIMEOUT - the request has timed out 00716 // See SWI_RCODE for other error return codes 00717 // 00718 // Notes: None 00719 // 00721 SWI_API SWI_RCODE SwiGetMpDeviceName(SWI_STRUCT_MpName* sDeviceName, U32 timeout); 00722 00724 // 00725 // Name: SwiSetMpDeviceName - sets the MP device name 00726 // 00727 // Purpose: This function is used to set the MP device name. 00728 // It takes in a properly populated SWI_STRUCT_MP_Name structure and 00729 // sets the MP name to the modem with it. 00730 // 00731 // A request is sent to the modem. The modem's response indicates that 00732 // the request is being processed. 00733 // 00734 // The caller must specify the amount of time to wait for the modem 00735 // to respond to the request. 00736 // 00737 // Parameters: 00738 // 00739 // sDeviceName[OUT]: structure which stores the device name 00740 // 00741 // timeout[IN]: response timeout value in milliseconds 00742 // 00743 // Return: SWI_RCODE_OK - the request has been received by the modem 00744 // SWI_RCODE_REQUEST_TIMEOUT - the request has timed out 00745 // See SWI_RCODE for other error return codes 00746 // 00747 // Notes: None 00748 // 00750 SWI_API SWI_RCODE SwiSetMpDeviceName(SWI_STRUCT_MpName sDeviceName, U32 timeout); 00751 00753 // 00754 // Name: SwiGetMpCnxSetup - retrieve MP profile data 00755 // 00756 // Purpose: This function is used to retrieve MP profile information. 00757 // 00758 // A request is sent to the modem. The modem's response indicates that 00759 // the request is being processed. 00760 // 00761 // The caller must specify the amount of time to wait for the modem 00762 // to respond to the request. 00763 // 00764 // Parameters: 00765 // 00766 // sProfile[OUT]: stores the requested profile information 00767 // 00768 // timeout[IN]: response timeout value in milliseconds 00769 // 00770 // Return: SWI_RCODE_OK - the request has been received by the modem 00771 // SWI_RCODE_REQUEST_TIMEOUT - the request has timed out 00772 // See SWI_RCODE for other error return codes 00773 // 00774 // Notes: None 00775 // 00777 SWI_API SWI_RCODE SwiGetMpCnxSetup(SWI_STRUCT_MpConnectionSetup* sProfile, U32 timeout); 00778 00780 // 00781 // Name: SwiSetMpCnxSetup - set MP profile data 00782 // 00783 // Purpose: This function is used to set MP profile information. 00784 // 00785 // A request is sent to the modem. The modem's response indicates that 00786 // the request is being processed. 00787 // 00788 // The caller must specify the amount of time to wait for the modem 00789 // to respond to the request. 00790 // 00791 // Parameters: 00792 // 00793 // sProfile[OUT]: stores the profile information to be set 00794 // 00795 // timeout[IN]: response timeout value in milliseconds 00796 // 00797 // Return: SWI_RCODE_OK - the request has been received by the modem 00798 // SWI_RCODE_REQUEST_TIMEOUT - the request has timed out 00799 // See SWI_RCODE for other error return codes 00800 // 00801 // Notes: None 00802 // 00804 SWI_API SWI_RCODE SwiSetMpCnxSetup(SWI_STRUCT_MpConnectionSetup sProfile, U32 timeout); 00805 00806 00807 SWI_API SWI_RCODE SwiGetMp555CnxSetup(SWI_STRUCT_Mp555ConnectionSetup* sProfile, U32 timeout); 00808 00809 SWI_API SWI_RCODE SwiSetMp555CnxSetup(SWI_STRUCT_Mp555ConnectionSetup sProfile, U32 timeout); 00810 00811 00813 // 00814 // Name: SwiMpConnect 00815 // 00816 // Purpose: There are two cases involved with this function: 00817 // 1) USB case: If using USB then this function creates an actual 00818 // data connection. 00819 // 00820 // 2) Serial case:If using serial then this function will test the 00821 // connection to see if it is valid. The user must invoke 00822 // dial-up networking to create the actual data connection. 00823 // 00824 // A request is sent to the modem. The modem's response indicates that 00825 // the request is being processed. 00826 // 00827 // The caller must specify the amount of time to wait for the modem 00828 // to respond to the request. 00829 // 00830 // Parameters: 00831 // 00832 // sConnect[IN]: stores connection information needed to create a data 00833 // connection 00834 // 00835 // timeout[IN]: response timeout value in milliseconds 00836 // 00837 // Return: SWI_RCODE_OK - the request has been received by the modem 00838 // SWI_RCODE_REQUEST_TIMEOUT - the request has timed out 00839 // See SWI_RCODE for other error return codes 00840 // 00841 // Notes: None 00842 // 00844 SWI_API SWI_RCODE SwiMpConnect(SWI_STRUCT_MpConnect sConnect, U32 timeout); 00845 00847 // 00848 // Name: SwiMpDisconnect 00849 // 00850 // Purpose: Disconnect from an active data connection. 00851 // 00852 // Note: USB only function 00853 // 00854 // A request is sent to the modem. The modem's response indicates that 00855 // the request is being processed. 00856 // 00857 // The caller must specify the amount of time to wait for the modem 00858 // to respond to the request. 00859 // 00860 // Parameters: 00861 // 00862 // timeout[IN]: response timeout value in milliseconds 00863 // 00864 // Return: SWI_RCODE_OK - the request has been received by the modem 00865 // SWI_RCODE_REQUEST_TIMEOUT - the request has timed out 00866 // See SWI_RCODE for other error return codes 00867 // 00868 // Notes: None 00869 // 00871 SWI_API SWI_RCODE SwiMpDisconnect(U32 timeout); 00872 00874 // 00875 // Name: SwiGetMpStartupCfg - Get MP startup configuration 00876 // 00877 // Purpose: Used to get UDP port information used by the MP modem. 00878 // 00879 // A request is sent to the modem. The modem's response indicates that 00880 // the request is being processed. 00881 // 00882 // The caller must specify the amount of time to wait for the modem 00883 // to respond to the request. 00884 // 00885 // Parameters: 00886 // 00887 // sConfig[OUT]: stores UDP port information retrieved 00888 // 00889 // timeout[IN]: response timeout value in milliseconds 00890 // 00891 // Return: SWI_RCODE_OK - the request has been received by the modem 00892 // SWI_RCODE_REQUEST_TIMEOUT - the request has timed out 00893 // See SWI_RCODE for other error return codes 00894 // 00895 // Notes: None 00896 // 00898 SWI_API SWI_RCODE SwiGetMpStartupCfg(SWI_STRUCT_MpStartupConfig* sConfig, U32 timeout); 00899 00901 // 00902 // Name: SwiSetMpStartupCfg - Set MP startup configuration 00903 // 00904 // Purpose: Used to configure what UDP port to use on the MP modem. The UDP settings 00905 // are used to send control and status messages to the MP when a data (dial-up) 00906 // connection is active. 00907 // 00908 // The caller must specify the amount of time to wait for the modem 00909 // to respond to the request. 00910 // 00911 // Parameters: 00912 // 00913 // sConfig[IN]: stores UDP port information to set 00914 // 00915 // timeout[IN]: response timeout value in milliseconds 00916 // 00917 // Return: SWI_RCODE_OK - the request has been received by the modem 00918 // SWI_RCODE_REQUEST_TIMEOUT - the request has timed out 00919 // See SWI_RCODE for other error return codes 00920 // 00921 // Notes: None 00922 // 00924 SWI_API SWI_RCODE SwiSetMpStartupCfg(SWI_STRUCT_MpStartupConfig sConfig, U32 timeout); 00925 00927 // 00928 // Name: SwiGetMpActiveSetup - Get MP active setup 00929 // 00930 // Purpose: Used to retrieve the index of the setup currently used to connect 00931 // with the network. 00932 // 00933 // A request is sent to the modem. The modem's response indicates that 00934 // the request is being processed. 00935 // 00936 // The caller must specify the amount of time to wait for the modem 00937 // to respond to the request. 00938 // 00939 // Parameters: 00940 // 00941 // sActive[OUT]: stores the active setup (if any) 00942 // 00943 // timeout[IN]: response timeout value in milliseconds 00944 // 00945 // Return: SWI_RCODE_OK - the request was successful 00946 // SWI_RCODE_REQUEST_TIMEOUT - the request has timed out 00947 // See SWI_RCODE for other error return codes 00948 // 00949 // Notes: The result signals the connection status between the MP and the network. 00950 // This API call should only be made after SWI_NOTIFY_MP_Connect is 00951 // received. Otherwise the value returned is unreliable. 00952 // 00954 SWI_API SWI_RCODE SwiGetMpActiveSetup(SWI_STRUCT_MpActiveSetup* sActive, U32 timeout); 00955 00957 // 00958 // Name: SwiGetMpManagerCfg 00959 // 00960 // Purpose: Used to retrieve MP manager configuration information 00961 // 00962 // A request is sent to the modem. The modem's response contains the 00963 // configuration settings. 00964 // 00965 // The caller must specify the amount of time to wait for the modem 00966 // to respond to the request. 00967 // 00968 // Parameters: 00969 // 00970 // sMpCfg[OUT]: stores the MP Manager configuration 00971 // 00972 // timeout[IN]: response timeout value in milliseconds 00973 // 00974 // Return: SWI_RCODE_OK - the request has been received by the modem 00975 // SWI_RCODE_REQUEST_TIMEOUT - the request has timed out 00976 // See SWI_RCODE for other error return codes 00977 // 00978 // Notes: 00979 // 00981 SWI_API SWI_RCODE SwiGetMpManagerCfg(SWI_STRUCT_MpManagerCfg &sMpCfg, U32 timeout); 00982 00984 // 00985 // Name: SwiSetMpManagerCfg 00986 // 00987 // Purpose: Used to Set MP manager configuration information 00988 // 00989 // The caller must specify the amount of time to wait for the modem 00990 // to respond to the request. 00991 // 00992 // Parameters: 00993 // 00994 // sMpCfg[IN]: contains the MP Manager configuration 00995 // 00996 // timeout[IN]: response timeout value in milliseconds 00997 // 00998 // Return: SWI_RCODE_OK - the request was successful 00999 // SWI_RCODE_REQUEST_TIMEOUT - the request has timed out 01000 // See SWI_RCODE for other error return codes 01001 // 01002 // Notes: 01003 // 01005 SWI_API SWI_RCODE SwiSetMpManagerCfg(SWI_STRUCT_MpManagerCfg sMpCfg, U32 timeout); 01006 01008 // 01009 // Name: SwiStartMpRouter 01010 // 01011 // Purpose: Used to start MP manager router 01012 // 01013 // A request is sent to begin routing MP manager data. 01014 // 01015 // Parameters: 01016 // 01017 // sMpCfg[IN]: contains the MP Manager routing configuration 01018 // 01019 // Return: SWI_RCODE_OK - the request has been received by the modem 01020 // See SWI_RCODE for other error return codes 01021 // 01022 // Notes: 01023 // 01025 SWI_API SWI_RCODE SwiStartMpRouter(SWI_STRUCT_MpManagerCfg sMpCfg); 01026 01028 // 01029 // Name: SwiStopMpRouter 01030 // 01031 // Purpose: Used to stop MP manager router 01032 // 01033 // A request is sent to stop routing MP manager data. 01034 // 01035 // Parameters: 01036 // 01037 // none 01038 // 01039 // Return: SWI_RCODE_OK - the request has been received by the modem 01040 // See SWI_RCODE for other error return codes 01041 // 01042 // Notes: 01043 // 01045 SWI_API SWI_RCODE SwiStopMpRouter(); 01046 01048 // 01049 // Name: SwiGetMpMtCfg 01050 // 01051 // Purpose: Used to retrieve MP Monitor and Tracking configuration 01052 // 01053 // A request is sent to the modem. The modem's response contains the 01054 // configuration settings. 01055 // 01056 // The caller must specify the amount of time to wait for the modem 01057 // to respond to the request. 01058 // 01059 // Parameters: 01060 // 01061 // sMpCfg[OUT]: stores the MP MT configuration 01062 // 01063 // timeout[IN]: response timeout value in milliseconds 01064 // 01065 // Return: SWI_RCODE_OK - the request has been received by the modem 01066 // SWI_RCODE_REQUEST_TIMEOUT - the request has timed out 01067 // See SWI_RCODE for other error return codes 01068 // 01069 // Notes: 01070 // 01072 SWI_API SWI_RCODE SwiGetMpMtCfg(SWI_STRUCT_MpMtCfg &sMpCfg, U32 timeout); 01073 01075 // 01076 // Name: SwiSetMpMtCfg 01077 // 01078 // Purpose: Used to set MP Monitor and Tracking configuration 01079 // 01080 // The caller must specify the amount of time to wait for the modem 01081 // to respond to the request. 01082 // 01083 // Parameters: 01084 // 01085 // sMpCfg[IN]: contains the MP MT configuration 01086 // 01087 // timeout[IN]: response timeout value in milliseconds 01088 // 01089 // Return: SWI_RCODE_OK - the request was successful 01090 // SWI_RCODE_REQUEST_TIMEOUT - the request has timed out 01091 // See SWI_RCODE for other error return codes 01092 // 01093 // Notes: 01094 // 01096 SWI_API SWI_RCODE SwiSetMpMtCfg(SWI_STRUCT_MpMtCfg sMpCfg, U32 timeout); 01097 01099 // 01100 // Name: SwiGetMpCwCfg 01101 // 01102 // Purpose: Used to retrieve MP Watchdog configuration 01103 // 01104 // A request is sent to the modem. The modem's response contains the 01105 // configuration settings. 01106 // 01107 // The caller must specify the amount of time to wait for the modem 01108 // to respond to the request. 01109 // 01110 // Parameters: 01111 // 01112 // sMpCfg[OUT]: stores the MP Watchdog configuration 01113 // 01114 // timeout[IN]: response timeout value in milliseconds 01115 // 01116 // Return: SWI_RCODE_OK - the request has been received by the modem 01117 // SWI_RCODE_REQUEST_TIMEOUT - the request has timed out 01118 // See SWI_RCODE for other error return codes 01119 // 01120 // Notes: 01121 // 01123 SWI_API SWI_RCODE SwiGetMpCwCfg(SWI_STRUCT_MpCwCfg &sMpCfg, U32 timeout); 01124 01126 // 01127 // Name: SwiSetMpMtCfg 01128 // 01129 // Purpose: Used to set MP Watchdog configuration 01130 // 01131 // The caller must specify the amount of time to wait for the modem 01132 // to respond to the request. 01133 // 01134 // Parameters: 01135 // 01136 // sMpCfg[IN]: contains the MP Watchdog configuration 01137 // 01138 // timeout[IN]: response timeout value in milliseconds 01139 // 01140 // Return: SWI_RCODE_OK - the request was successful 01141 // SWI_RCODE_REQUEST_TIMEOUT - the request has timed out 01142 // See SWI_RCODE for other error return codes 01143 // 01144 // Notes: 01145 // 01147 SWI_API SWI_RCODE SwiSetMpCwCfg(SWI_STRUCT_MpCwCfg sMpCfg, U32 timeout); 01148 01150 // 01151 // Name: SwiGetMpGpsInitCfg 01152 // 01153 // Purpose: Used to retrieve MP GPS initialization string 01154 // 01155 // A request is sent to the modem. The modem's response contains the 01156 // configuration settings. 01157 // 01158 // The caller must specify the amount of time to wait for the modem 01159 // to respond to the request. 01160 // 01161 // Parameters: 01162 // 01163 // sMpGpsInitCfg[OUT]: stores the MP GPS initialization string 01164 // 01165 // timeout[IN]: response timeout value in milliseconds 01166 // 01167 // Return: SWI_RCODE_OK - the request has been received by the modem 01168 // SWI_RCODE_REQUEST_TIMEOUT - the request has timed out 01169 // See SWI_RCODE for other error return codes 01170 // 01171 // Notes: 01172 // 01174 SWI_API SWI_RCODE SwiGetMpGpsInitCfg(SWI_STRUCT_MpGpsInitCfg &sMpGpsInitStr, U32 timeout); 01175 01177 // 01178 // Name: SWI_STRUCT_MpGpsInitCfg 01179 // 01180 // Purpose: Used to set MP GPS initialization string 01181 // 01182 // The caller must specify the amount of time to wait for the modem 01183 // to respond to the request. 01184 // 01185 // Parameters: 01186 // 01187 // sMpGpsInitCfg[IN]: contains the MP GPS initialization string 01188 // 01189 // timeout[IN]: response timeout value in milliseconds 01190 // 01191 // Return: SWI_RCODE_OK - the request was successful 01192 // SWI_RCODE_REQUEST_TIMEOUT - the request has timed out 01193 // See SWI_RCODE for other error return codes 01194 // 01195 // Notes: 01196 // 01198 SWI_API SWI_RCODE SwiSetMpGpsInitCfg(SWI_STRUCT_MpGpsInitCfg sMpGpsInitStr, U32 timeout); 01199 01201 // 01202 // Name: SwiEnableMpNotif - to enable notifications 01203 // 01204 // Purpose: This function is used to enable MP notifications in the list. The list 01205 // consists of CWE or product specific objects to enable. 01206 // 01207 // A request is sent to the modem. The modem's response indicates that 01208 // the request is being processed. 01209 // 01210 // The caller must specify the amount of time to wait for the modem 01211 // to respond to the request. 01212 // 01213 // Parameters: 01214 // 01215 // psList[IN]: list MP of notifications to enable 01216 // 01217 // timeout[IN]: response timeout value in milliseconds 01218 // 01219 // Return: SWI_RCODE_OK - the request has been received by the modem 01220 // SWI_RCODE_REQUEST_TIMEOUT - the request has timed out 01221 // See SWI_RCODE for other error return codes 01222 // 01223 // Notes: None 01224 // 01226 SWI_API SWI_RCODE SwiEnableMpNotif(SWI_STRUCT_NotifList *psList, U32 timeout); 01227 01229 // 01230 // Name: SwiGetMpWifiCfg 01231 // 01232 // Purpose: This function is used to retrieve WIFI Access Point (WAP) 01233 // configuration 01234 // 01235 // Parameters: 01236 // 01237 // sMpWifiCfg[OUT]: WAP configuration 01238 // 01239 // timeout[IN]: response timeout value in milliseconds 01240 // 01241 // Return: See SWI_RCODE for error return codes 01242 // 01243 // Notes: None 01244 // 01246 SWI_API SWI_RCODE SwiGetMpWifiCfg(SWI_STRUCT_MpWifiCfg &sMpWifiCfg, U32 timeout); 01247 01249 // 01250 // Name: SwiSetMpWifiCfg 01251 // 01252 // Purpose: This function is used to set WIFI Access Point (WAP) 01253 // configuration 01254 // 01255 // Parameters: 01256 // 01257 // sMpWifiCfg[OUT]: WAP configuration 01258 // 01259 // timeout[IN]: response timeout value in milliseconds 01260 // 01261 // Return: SWI_RCODE_OK indicates the modem has received the request 01262 // successfully. However, eResult must be evaluate to determine 01263 // if the operation actually succeeded. 01264 // 01265 // See SWI_RCODE for additional error return codes 01266 // 01267 // Notes: MP has to be unlocked at configuration level in order to modify 01268 // WAP configuration (see SwiSetMpUnlock). MP has to be reset for the 01269 // changes to take effect. 01270 // 01272 SWI_API SWI_RCODE SwiSetMpWifiCfg(SWI_STRUCT_MpWifiCfg &sMpWifiCfg, U32 timeout); 01273 01275 // 01276 // Name: SwiSetMpUnlock 01277 // 01278 // Purpose: This function is used to unlock the MP to access various 01279 // functionality 01280 // 01281 // Parameters: 01282 // 01283 // sMpUnlock[OUT]: unlock information 01284 // 01285 // timeout[IN]: response timeout value in milliseconds 01286 // 01287 // Return: SWI_RCODE_OK indicates the modem has received the request 01288 // successfully. However, eResult must be evaluate to determine 01289 // if the operation actually succeeded. 01290 // 01291 // See SWI_RCODE for additional error return codes 01292 // 01293 // Notes: See SWI_TYPE_MpUnlockLevel for list of lock levels 01294 // 01296 SWI_API SWI_RCODE SwiSetMpUnlock(SWI_STRUCT_MpUnlock &sMpUnlock, U32 timeout); 01297 01299 // 01300 // Name: SwiSetMpUnlockCfg 01301 // 01302 // Purpose: This function is used to set MP unlock configuration 01303 // 01304 // Parameters: 01305 // 01306 // sMpUnlock[OUT]: unlock configuration 01307 // 01308 // timeout[IN]: response timeout value in milliseconds 01309 // 01310 // Return: SWI_RCODE_OK indicates the modem has received the request 01311 // successfully. However, eResult must be evaluate to determine 01312 // if the operation actually succeeded. 01313 // 01314 // See SWI_RCODE for additional error return codes 01315 // 01316 // Notes: The MP has to be unlocked before configuration can be modified. 01317 // A same or higher order level unlock is required to modify a 01318 // specified level of unlock code. 01319 // 01321 SWI_API SWI_RCODE SwiSetMpUnlockCfg(SWI_STRUCT_MpUnlock &sMpUnlock, U32 timeout); 01322 01324 // 01325 // Name: SwiGetMpFeatures 01326 // 01327 // Purpose: This function is used to determine available features of the MP 01328 // 01329 // Parameters: 01330 // 01331 // sMpFeatures[OUT]: available MP features 01332 // 01333 // timeout[IN]: response timeout value in milliseconds 01334 // 01335 // Return: See SWI_RCODE for error return codes 01336 // 01337 // Notes: See description of SWI_STRUCT_MpFeatures for list of available 01338 // features. 01339 // 01341 SWI_API SWI_RCODE SwiGetMpFeatures(SWI_STRUCT_MpFeatures &sMpFeatures, U32 timeout); 01342 01344 // 01345 // Name: SwiGetMpFeatureCfg 01346 // 01347 // Purpose: This function is used retrieve current programmable MP feature settings 01348 // 01349 // Parameters: 01350 // 01351 // sMpFeatureCfg[OUT]: MP feature configuration 01352 // 01353 // timeout[IN]: response timeout value in milliseconds 01354 // 01355 // Return: See SWI_RCODE for error return codes 01356 // 01357 // Notes: See description of SWI_STRUCT_MpFeatureCfg for list of 01358 // configurable features. 01359 // 01361 SWI_API SWI_RCODE SwiGetMpFeatureCfg(SWI_STRUCT_MpFeatureCfg &sMpFeatureCfg, U32 timeout); 01362 01364 // 01365 // Name: SwiSetMpFeatureCfg 01366 // 01367 // Purpose: This function is used configure programmable MP features 01368 // 01369 // Parameters: 01370 // 01371 // sMpFeatureCfg[IN/OUT]: MP feature configuration/result 01372 // 01373 // timeout[IN]: response timeout value in milliseconds 01374 // 01375 // Return: SWI_RCODE_OK indicates the modem has received the request 01376 // successfully. However, eResult must be evaluate to determine 01377 // if the operation actually succeeded. 01378 // 01379 // See SWI_RCODE for additional error return codes 01380 // 01381 // Notes: See description of SWI_STRUCT_MpFeatureCfg for list of 01382 // configurable features. 01383 // 01385 SWI_API SWI_RCODE SwiSetMpFeatureCfg(SWI_STRUCT_MpFeatureCfg &sMpFeatureCfg, U32 timeout); 01386 01387 #ifdef __cplusplus 01388 } //extern "C" { 01389 #endif 01390 01391 #endif //_SWI_MP_API_