Maxim Integrated 73M1822/73M1922 Modem API - Manual (Page 3)

UG_1x22_055 73M1822/73M1922 Modem API User Guide
Rev. 1.0 3
Table of Contents
1 Introduction ................................................................................................................................... 5
1.1 Overview ................................................................................................................................. 6
1.2 Conventions Used in this Guide ............................................................................................... 6
1.3 Acronyms................................................................................................................................. 6
2 API Descriptions ............................................................................................................................ 7
2.1 M1X22_MdmApiInit .................................................................................................................. 8
2.2 M1X22_MdmApiRelease.......................................................................................................... 8
2.3 M1X22_OpenDevice ................................................................................................................ 9
2.4 M1X22_CloseDevice.............................................................................................................. 10
2.5 M1X22_OpenChannel............................................................................................................ 10
2.6 M1X22_CloseChannel ........................................................................................................... 11
2.7 M1X22_InitChannel ............................................................................................................... 11
2.8 M1X22_HookSwitch ............................................................................................................... 12
2.9 M1X22_PulseDial .................................................................................................................. 12
2.10 M1X22_HWRegisterRead ...................................................................................................... 13
2.11 M1X22_HWRegisterReadAll .................................................................................................. 13
2.12 M1X22_HWRegisterWrite ...................................................................................................... 14
2.13 M1X22_SetDebugTrace ......................................................................................................... 14
2.14 M1X22_SetPhoneVolume ...................................................................................................... 15
2.15 M1X22_CallProgressMonitor.................................................................................................. 15
2.16 M1X22_GetFileDescriptor ...................................................................................................... 16
2.17 M1X22_GetCurrentIET .......................................................................................................... 16
2.18 M1X22_UpdateCurrentIET ..................................................................................................... 17
2.19 M1X22_ClearCurrentIET ........................................................................................................ 17
2.20 M1X22_GetVoltageIET .......................................................................................................... 18
2.21 M1X22_UpdateVoltageIET ..................................................................................................... 18
2.22 M1X22_ClearVoltageIET........................................................................................................ 19
2.23 M1X22_StartMeasureCurrent................................................................................................. 19
2.24 M1X22_StartMeasureVoltage ................................................................................................ 20
2.25 M1X22_StopMeasureCurrent ................................................................................................. 20
2.26 M1X22_StopMeasureVoltage................................................................................................. 21
2.27 M1X22_SetRingCadence ....................................................................................................... 22
3 Structure Reference..................................................................................................................... 23
3.1 M1X22_HANDLE ................................................................................................................... 23
3.2 M1X22_CHAN_INIT ............................................................................................................... 24
4 Enumerator Reference ................................................................................................................ 25
4.1 M1X22_RET .......................................................................................................................... 25
4.2 M1X22_EVENT_ID ................................................................................................................ 26
4.3 M1X22_COUNTRY_CODE .................................................................................................... 27
4.4 M1X22_HOOK_SWITCH ....................................................................................................... 29
4.5 M1X22_REG_TYPE .............................................................................................................. 30
4.6 M1X22_DEBUG_TRACE_MASK ........................................................................................... 32
5 Sample Application ..................................................................................................................... 33
6 Related Documentation ............................................................................................................... 36
7 Contact Information ..................................................................................................................... 36
Revision History .................................................................................................................................. 37