Maxim-integrated 73M1866B/73M1966B FXOAPI Manual de usuario Pagina 1

Simplifying System IntegrationTM 73M1866B/73M1966B FXOAPI User Guide November 2, 2009 Rev. 2.1 UG_1x66

73M1866B/73M1966B FXOAPI User Guide UG_1x66B_046 10 Rev. 2.1 IOCTL Name Description M1x66_GetFileDrescriptor Interval Event Table Management APIs

UG_1x66B_046 73M1866B/73M1966B FXOAPI User Guide Rev. 2.1 11 2.2 FXO API Initialization and Termination 2.2.1 M1x66_FxoApiInit Description This

73M1866B/73M1966B FXOAPI User Guide UG_1x66B_046 12 Rev. 2.1 2.3 Device/Channel Open, Close and Initialization APIs 2.3.1 M1x66_OpenDevice Descri

UG_1x66B_046 73M1866B/73M1966B FXOAPI User Guide Rev. 2.1 13 Return Values Data Type Description M1x66_HANDLE Non-ZERO value if the device is op

73M1866B/73M1966B FXOAPI User Guide UG_1x66B_046 14 Rev. 2.1 2.3.3 M1x66_OpenChannel Description This API performs the low level opening of the ch

UG_1x66B_046 73M1866B/73M1966B FXOAPI User Guide Rev. 2.1 15 2.3.5 M1x66_InitChannel Description This API performs the channel initialization an

73M1866B/73M1966B FXOAPI User Guide UG_1x66B_046 16 Rev. 2.1 2.4 PCM Management and Control APIs 2.4.1 M1x66_PcmIfConfig Description This API is

UG_1x66B_046 73M1866B/73M1966B FXOAPI User Guide Rev. 2.1 17 2.4.3 M1x66_PcmActivation Description This API activates the PCM timeslot configure

73M1866B/73M1966B FXOAPI User Guide UG_1x66B_046 18 Rev. 2.1 2.5 Hook Switch and Pulse Dial Related APIs 2.5.1 M1x66_HookSwitch Description Perfo

UG_1x66B_046 73M1866B/73M1966B FXOAPI User Guide Rev. 2.1 19 2.5.3 M1x66_PulseDialCancel Description

73M1866B/73M1966B FXOAPI User Guide UG_1x66B_046 2 Rev. 2.1 © 2009 Teridian Semiconductor Corporation. Al

73M1866B/73M1966B FXOAPI User Guide UG_1x66B_046 20 Rev. 2.1 2.6 This API terminates any active pulse dial session previously initiated by the Hoo

UG_1x66B_046 73M1866B/73M1966B FXOAPI User Guide Rev. 2.1 21 M1x66_RET M1x66_SetPulseDialParam (M1x66_HANDLE chanHandle,

73M1866B/73M1966B FXOAPI User Guide UG_1x66B_046 22 Rev. 2.1 2.7 GPIO Management APIs 2.7.1 M1x66_GetGpioConfig Description This is an API for re

UG_1x66B_046 73M1866B/73M1966B FXOAPI User Guide Rev. 2.1 23 Return Values Data Type Description M1x66_RET M1x66_SUCCESS – Successful. M1x66_FAI

73M1866B/73M1966B FXOAPI User Guide UG_1x66B_046 24 Rev. 2.1 2.7.5 M1x66_GpioEnable Description This is an API for enable the GPIO. After a GPIO

UG_1x66B_046 73M1866B/73M1966B FXOAPI User Guide Rev. 2.1 25 2.8 Loopback Control APIs 2.8.1 M1x66_LoopbackGet Description This API reads the c

73M1866B/73M1966B FXOAPI User Guide UG_1x66B_046 26 Rev. 2.1 2.8.3 M1x66_LoopbackClear Description This API disables the loopback. Prototype M1x6

UG_1x66B_046 73M1866B/73M1966B FXOAPI User Guide Rev. 2.1 27 2.9 Country Default Parameter and Override APIs 2.9.1 M1x66_GetCountryParam Descri

73M1866B/73M1966B FXOAPI User Guide UG_1x66B_046 28 Rev. 2.1 2.9.3 M1x66_ThresholdOverride Description Various FXO channel parameters are convenie

UG_1x66B_046 73M1866B/73M1966B FXOAPI User Guide Rev. 2.1 29 2.10 Billing Tone Filter Control APIs 2.10.1 M1x66_BillingToneFilterEnable Descript

UG_1x66B_046 73M1866B/73M1966B FXOAPI User Guide Rev. 2.1 3 Table of Contents 1 Introduction ...

73M1866B/73M1966B FXOAPI User Guide UG_1x66B_046 30 Rev. 2.1 2.11 1x66 H/W Register Access and Debugging aid APIs 2.11.1 M1x66_HWRegisterRead Desc

UG_1x66B_046 73M1866B/73M1966B FXOAPI User Guide Rev. 2.1 31 M1x66_FAILED – Failure. 2.11.3 M1x66_HWRegisterWrite Description Perform H/W regist

73M1866B/73M1966B FXOAPI User Guide UG_1x66B_046 32 Rev. 2.1 2.11.5 M1x66_GetFileDrescriptor Description To provide full flexibility to the drive

UG_1x66B_046 73M1866B/73M1966B FXOAPI User Guide Rev. 2.1 33 2.12 Interval Event Table Management APIs 2.12.1 M1x66_GetCurrentIET Description Re

73M1866B/73M1966B FXOAPI User Guide UG_1x66B_046 34 Rev. 2.1 2.12.3 M1x66_ClearCurrentIET Description Delete the line current IET table entry. Pr

UG_1x66B_046 73M1866B/73M1966B FXOAPI User Guide Rev. 2.1 35 2.12.5 M1x66_UpdateVoltageIET Description Perform the line voltage IET table update

73M1866B/73M1966B FXOAPI User Guide UG_1x66B_046 36 Rev. 2.1 2.13 Current/Voltage Measurement APIs 2.13.1 M1x66_StartMeasureCurrent Description St

UG_1x66B_046 73M1866B/73M1966B FXOAPI User Guide Rev. 2.1 37 2.13.3 M1x66_StopMeasureCurrent Description Stop the line current measurement. Pro

73M1866B/73M1966B FXOAPI User Guide UG_1x66B_046 38 Rev. 2.1 2.14 Miscellaneous Channel Setting APIs 2.14.1 M1x66_SetRingCadence Description Set

UG_1x66B_046 73M1866B/73M1966B FXOAPI User Guide Rev. 2.1 39 2.14.2 M1x66_SetPhoneVolume Description Set the speaker phone and microphone volume

73M1866B/73M1966B FXOAPI User Guide UG_1x66B_046 4 Rev. 2.1 2.10.5 M1x66_UpdateVoltageIET ...

73M1866B/73M1966B FXOAPI User Guide UG_1x66B_046 40 Rev. 2.1 2.14.4 M1x66_SelectSampleRate Description Select PCM sample rate. The 73M1x66B devic

UG_1x66B_046 73M1866B/73M1966B FXOAPI User Guide Rev. 2.1 41 3 Structure Reference This section contains the detail description of the data stru

73M1866B/73M1966B FXOAPI User Guide UG_1x66B_046 42 Rev. 2.1 3.1 M1x66_HANDLE_t Description The device or channel handle is a pointer to a device

UG_1x66B_046 73M1866B/73M1966B FXOAPI User Guide Rev. 2.1 43 3.2 M1x66_CHAN_INIT_t Description Channel initialization structure. This structure

73M1866B/73M1966B FXOAPI User Guide UG_1x66B_046 44 Rev. 2.1 3.3 M1x66_PCM_IF_CFG_t Description PCM interface config structure. This structure co

UG_1x66B_046 73M1866B/73M1966B FXOAPI User Guide Rev. 2.1 45 3.4 M1x66_PCM_CFG_t Description PCM config structure. This structure contains the

73M1866B/73M1966B FXOAPI User Guide UG_1x66B_046 46 Rev. 2.1 3.5 M1966_CNTRY_STRUCT_t Description This structure defines the country default param

UG_1x66B_046 73M1866B/73M1966B FXOAPI User Guide Rev. 2.1 47 4 Enumerator Reference This section contains the detail description of the enumerat

73M1866B/73M1966B FXOAPI User Guide UG_1x66B_046 48 Rev. 2.1 4.1 M1x66_RET Description API function return code. All APIs, expect the open device

UG_1x66B_046 73M1866B/73M1966B FXOAPI User Guide Rev. 2.1 49 4.2 M1x66_EVENT_ID Description List of FXO event identification supported by the AP

UG_1x66B_046 73M1866B/73M1966B FXOAPI User Guide Rev. 2.1 5 1 Introduction This document describes the application programming interface (API) o

73M1866B/73M1966B FXOAPI User Guide UG_1x66B_046 50 Rev. 2.1 M1x66_EVENT_LINE_STATE 0x00000100 Line state event – current/voltage. M1x66_EVENT_QUAL

UG_1x66B_046 73M1866B/73M1966B FXOAPI User Guide Rev. 2.1 51 4.3 M1x66_COUNTRY_CODE Description List of country codes supported by the API subsy

73M1866B/73M1966B FXOAPI User Guide UG_1x66B_046 52 Rev. 2.1 M1x66_CNTRY_CODE_NG = 47, /* "Nigeria" */ M1x66_C

UG_1x66B_046 73M1866B/73M1966B FXOAPI User Guide Rev. 2.1 53 4.4 M1x66_DCL_FREQUENCY Description Valid DCL Frequency used in M1x66_InitChannel A

73M1866B/73M1966B FXOAPI User Guide UG_1x66B_046 54 Rev. 2.1 4.5 M1x66_HOOK_SWITCH Description Hook switch command for on-hook and off-hook. Prot

UG_1x66B_046 73M1866B/73M1966B FXOAPI User Guide Rev. 2.1 55 4.6 M1x66_REG_TYPE Description List of 1x66 device register type. Note: Register 0

73M1866B/73M1966B FXOAPI User Guide UG_1x66B_046 56 Rev. 2.1 Parameters Name Value Description M1x66_REG_0x00 Ox00 Register 0x00 M1x66_REG_0x01

UG_1x66B_046 73M1866B/73M1966B FXOAPI User Guide Rev. 2.1 57 4.7 M1x66_REG_ACCESS_TYPE Description Defines 73M1x66B register access types. Prot

73M1866B/73M1966B FXOAPI User Guide UG_1x66B_046 58 Rev. 2.1 4.9 M1966_GPIO_CONFIG_COMMAND Description This is the GPIO configuration command. T

UG_1x66B_046 73M1866B/73M1966B FXOAPI User Guide Rev. 2.1 59 4.11 M1966_GPIO_DATA_COMMAND Description GPIO data access command. If the M1966_GPI

73M1866B/73M1966B FXOAPI User Guide UG_1x66B_046 6 Rev. 2.1 1.1 Overview The FXOAPI is a user-friendly programming conduit used to access and mana

73M1866B/73M1966B FXOAPI User Guide UG_1x66B_046 60 Rev. 2.1 4.13 M1966_GPIO_SIGNAL_DIRECTION Description GPIO pin signal direction. This control b

UG_1x66B_046 73M1866B/73M1966B FXOAPI User Guide Rev. 2.1 61 4.15 M1x66_DEBUG_TRACE_MASK Description Defines all debug trace masks. Prototype /*

73M1866B/73M1966B FXOAPI User Guide UG_1x66B_046 62 Rev. 2.1 5 Sample Application This section illustrates how an FXO application can be implemen

UG_1x66B_046 73M1866B/73M1966B FXOAPI User Guide Rev. 2.1 63 /* Initialize the channel for operation in US */ if (M1x66_InitChannel (channel

73M1866B/73M1966B FXOAPI User Guide UG_1x66B_046 64 Rev. 2.1 switch (event_id) { case M1x66_EVENT_RING_START: printf("\nRING(%d)"

UG_1x66B_046 73M1866B/73M1966B FXOAPI User Guide Rev. 2.1 65 case M1x66_EVENT_DIAL_COMPLETE: printf("\n\r DIAL_COMP

73M1866B/73M1966B FXOAPI User Guide UG_1x66B_046 66 Rev. 2.1 Revision History Revision Date Description 1.0 6/12/2009 First publication. 2.0 1

UG_1x66B_046 73M1866B/73M1966B FXOAPI User Guide Rev. 2.1 7 1.2 Conventions Used in this Guide This document uses the following conventions: •

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

UG_1x66B_046 73M1866B/73M1966B FXOAPI User Guide Rev. 2.1 9 IOCTL Name Description M1x66_FAILED – Failure. M1x66_PulseDial M1x66_PulseDialCance