Maxim Integrated 73M1866B/73M1966B FXOAPI User Manual

Page 3

Advertising
background image

UG_1x66B_046

73M1866B/73M1966B FXOAPI User Guide

Rev. 2.1

3

Table of Contents

1

Introduction ......................................................................................................................................... 5

1.1

Overview ....................................................................................................................................... 6

1.2

Conventions Used in this Guide ................................................................................................... 7

1.3

Acronyms ...................................................................................................................................... 7

2

API Descriptions ................................................................................................................................. 8

2.1

FXO API Initialization and Termination ....................................................................................... 11

2.1.1

M1x66_FxoApiInit .......................................................................................................... 11

2.1.2

M1x66_FxoApiRelease .................................................................................................. 11

2.2

Device/Channel Open, Close and Initialization APIs .................................................................. 12

2.2.1

M1x66_OpenDevice ...................................................................................................... 12

2.2.2

M1x66_CloseDevice ...................................................................................................... 13

2.2.3

M1x66_OpenChannel .................................................................................................... 14

2.2.4

M1x66_CloseChannel ................................................................................................... 14

2.2.5

M1x66_InitChannel ........................................................................................................ 15

2.3

PCM Management and Control APIs.......................................................................................... 16

2.3.1

M1x66_PcmIfConfig ...................................................................................................... 16

2.3.2

M1x66_PcmConfig ........................................................................................................ 16

2.3.3

M1x66_PcmActivation ................................................................................................... 17

2.3.4

M1x66_PcmDeActivation ............................................................................................... 17

2.4

Hook Switch and Pulse Dial Related APIs ................................................................................. 18

2.4.1

M1x66_HookSwitch ....................................................................................................... 18

2.4.2

M1x66_PulseDial ........................................................................................................... 18

2.4.3

M1x66_PulseDialCancel ................................................................................................ 19

2.4.4

M1x66_SetPulseDialParam ........................................................................................... 20

2.4.5

M1x66_GetPulseDialParam .......................................................................................... 21

2.5

GPIO Management APIs ............................................................................................................ 22

2.5.1

M1x66_GetGpioConfig .................................................................................................. 22

2.5.2

M1x66_SetGpioConfig ................................................................................................... 22

2.5.3

M1x66_SetGpioData ..................................................................................................... 23

2.5.4

M1x66_GetGpioData ..................................................................................................... 23

2.5.5

M1x66_GpioEnable ....................................................................................................... 24

2.5.6

M1x66_GpioDisable ...................................................................................................... 24

2.6

Loopback Control APIs ............................................................................................................... 25

2.6.1

M1x66_LoopbackGet ..................................................................................................... 25

2.6.2

M1x66_LoopbackSet ..................................................................................................... 25

2.6.3

M1x66_LoopbackClear .................................................................................................. 26

2.7

Country Default Parameter and Override APIs .......................................................................... 27

2.7.1

M1x66_GetCountryParam ............................................................................................. 27

2.7.2

M1x66_SetCountryParam ............................................................................................. 27

2.7.3

M1x66_ThresholdOverride ............................................................................................ 28

2.8

Billing Tone Filter Control APIs ................................................................................................... 29

2.8.1

M1x66_BillingToneFilterEnable ..................................................................................... 29

2.8.2

M1x66_BillingToneFilterDisable .................................................................................... 29

2.9

1x66 H/W Register Access and Debugging aid APIs ................................................................. 30

2.9.1

M1x66_HWRegisterRead .............................................................................................. 30

2.9.2

M1x66_HWRegisterReadAll .......................................................................................... 30

2.9.3

M1x66_HWRegisterWrite .............................................................................................. 31

2.9.4

M1x66_SetDebugTrace ................................................................................................. 31

2.9.5

M1x66_GetFileDrescriptor ............................................................................................. 32

2.9.6

M1x66_GetHWRevision ................................................................................................ 32

2.10

Interval Event Table Management APIs ..................................................................................... 33

2.10.1

M1x66_GetCurrentIET ................................................................................................... 33

2.10.2

M1x66_UpdateCurrentIET ............................................................................................. 33

2.10.3

M1x66_ClearCurrentIET ................................................................................................ 34

2.10.4

M1x66_GetVoltageIET .................................................................................................. 34

Advertising