Maxim Integrated 73M1866B/73M1966B FXOAPI - Manual (Page 8)

73M1866B/73M1966B FXOAPI User Guide UG_1x66B_046
8 Rev. 2.1
2 API Descriptions
This section contains the detail description of each API. Table 1 provides a summary of the APIs.
Table 1: API Overview
IOCTL Name Description
FXO API Initialization and Termination
M1x66_FxoApiInit
API subsystem initialization.
M1x66_FxoApiRelease API subsystem release or termination.
Device/Channel Open, Close and
Initialization APIs
M1x66_OpenDevice
Open FXO device of event reporting.
M1x66_CloseDevice
Close an opened device.
M1x66_OpenChannel Open FXO channel for operation.
M1x66_CloseChannel Close an opened channel.
M1x66_InitChannel Initialize channel for specific region.
M1x66_PCMIfConfig Configure PCM interface parameter.
M1x66_PcmConfig Configure PCM timeslots and codec.
M1x66_PcmActivation Activate PCM channel.
M1x66_PcmDeActivation De-activate PCM channel.
M1x66_HookSwitch Perform hook switching – on/off-hook.
Hook Switch and Pulse Dial Related APIs
2.1.1 M1x66_HookSwitch
Description
Perform on/off-hook on the FXO channel.
Prototype
M1x66_RET M1x66_HookSwitch (
M1x66_HANDLE channel,
M1x66_HOOK_SWITCH hookSwitch );
Parameters
Data Type Name Description
M1x66_HANDLE channel Channel
handle from
FXO open
channel.
M1x66_HOOK_SWITCH hookSwitch Type of
hook switch
requested.
Return Values
Data Type Description
M1x66_RET M1x66_SUCCESS – Successfully
performed hook switch.
Pulse dialing.