Maxim-integrated 73M1866B/73M1966B Reference Driver User Manual

Simplifying System IntegrationTM 73M1866B/73M1966B Reference Driver User Guide June 22, 2009 Rev. 2.7

73M1866B/73M1966B Reference Driver User Guide UG_1x66B_015 10 Rev. 2.7 2.2 Functional Overview Once installed, the driver is a self-contained modu

UG_1x66B_015 73M1866B/73M1966B Reference Driver User Guide Rev. 2.7 11 The application is responsible for building up the IET using the IET table

73M1866B/73M1966B Reference Driver User Guide UG_1x66B_015 12 Rev. 2.7 2.2.5 Loopback and Testing Modes The 1966B devices support six variations o

UG_1x66B_015 73M1866B/73M1966B Reference Driver User Guide Rev. 2.7 13 3 Driver Service Interface The Driver Service provides the link between t

73M1866B/73M1966B Reference Driver User Guide UG_1x66B_015 14 Rev. 2.7 4 Country Specific Settings The 73M1x66B Reference Driver supports global c

UG_1x66B_015 73M1866B/73M1966B Reference Driver User Guide Rev. 2.7 15 5 FXO Events The driver provides event service to the high level applicat

73M1866B/73M1966B Reference Driver User Guide UG_1x66B_015 16 Rev. 2.7 5.2 Event Identification 5.2.1 M1966_BATTERY_DROPPED This event occurs whe

UG_1x66B_015 73M1866B/73M1966B Reference Driver User Guide Rev. 2.7 17 5.2.4 M1966_ONH_NOPOH_DETECT This event is generated when a parallel phon

73M1866B/73M1966B Reference Driver User Guide UG_1x66B_015 18 Rev. 2.7 5.2.7 M1966_RING_DETECT_START This event is generated at the beginning of t

UG_1x66B_015 73M1866B/73M1966B Reference Driver User Guide Rev. 2.7 19 5.2.10 M1966_OV_DETECT This event is generated on detection of an over

73M1866B/73M1966B Reference Driver User Guide UG_1x66B_015 2 Rev. 2.7 © 2010 Teridian Semiconductor Corpora

73M1866B/73M1966B Reference Driver User Guide UG_1x66B_015 20 Rev. 2.7 5.2.13 M1966_LINE_STATE This event is generated when the line state analys

UG_1x66B_015 73M1866B/73M1966B Reference Driver User Guide Rev. 2.7 21 5.2.16 M1966_DEVICE_RECOVERED This event is generated after the device i

73M1866B/73M1966B Reference Driver User Guide UG_1x66B_015 22 Rev. 2.7 6 IOCTL Commands Description Upon successful opening of a device or channel

UG_1x66B_015 73M1866B/73M1966B Reference Driver User Guide Rev. 2.7 23 6.1 Initialization and Configuration IOCTLs The following IOCTLs are defi

73M1866B/73M1966B Reference Driver User Guide UG_1x66B_015 24 Rev. 2.7 6.1.1 M1966_CH_INIT Description Performs 73M1x66 channel initialization. T

UG_1x66B_015 73M1866B/73M1966B Reference Driver User Guide Rev. 2.7 25 6.1.2 M1966_PCM_IF_CSET_OPMODE_SET Description Sets the 73M1x66 to operat

73M1866B/73M1966B Reference Driver User Guide UG_1x66B_015 26 Rev. 2.7 6.1.3 M1966_PCM_IF_CSET_FREQUENCY_SET Description If the incoming PCM frequ

UG_1x66B_015 73M1866B/73M1966B Reference Driver User Guide Rev. 2.7 27 6.1.4 M1966_PCM_IF_CSET_RPOL_SET Description Sets receive edge polarity.

73M1866B/73M1966B Reference Driver User Guide UG_1x66B_015 28 Rev. 2.7 6.1.6 M1966_PCM_IF_CSET_RCS_SET Description Sets receive clock slot. #defi

UG_1x66B_015 73M1866B/73M1966B Reference Driver User Guide Rev. 2.7 29 6.1.8 M1966_PCM_CSET_TSLOT_RX_SET Description Sets receive PCM time slot.

UG_1x66B_015 73M1866B/73M1966B Reference Driver User Guide Rev. 2.7 3 Table of Contents 1 Introduction ...

73M1866B/73M1966B Reference Driver User Guide UG_1x66B_015 30 Rev. 2.7 6.1.10 M1966_PCM_CSET_COMPRESSION_SET Description Sets PCM data compression

UG_1x66B_015 73M1866B/73M1966B Reference Driver User Guide Rev. 2.7 31 6.1.12 M1966_PCM_ACTIVATION_CLEAR Description This service de-activates t

73M1866B/73M1966B Reference Driver User Guide UG_1x66B_015 32 Rev. 2.7 6.1.14 M1966_CNTRY_NMBR_GET Description Converts a null terminated ASCII st

UG_1x66B_015 73M1866B/73M1966B Reference Driver User Guide Rev. 2.7 33 6.1.15 M1966_GET_COUNTRY_CONFIG This IOCTL allows an application progra

73M1866B/73M1966B Reference Driver User Guide UG_1x66B_015 34 Rev. 2.7 6.1.16 M1966_SET_COUNTRY_CONFIG This IOCTL allows application program to w

UG_1x66B_015 73M1866B/73M1966B Reference Driver User Guide Rev. 2.7 35 6.1.17 M1966_PHONE_VOLUME_SET Description The gain of both transmit and r

73M1866B/73M1966B Reference Driver User Guide UG_1x66B_015 36 Rev. 2.7 6.1.18 M1966_PERF_RX_OFFSET_CALIB This IOCTL allows an application program

UG_1x66B_015 73M1866B/73M1966B Reference Driver User Guide Rev. 2.7 37 6.1.19 M1966_CLEAR_RX_OFFSET_REG Description Clears the receive offset me

73M1866B/73M1966B Reference Driver User Guide UG_1x66B_015 38 Rev. 2.7 6.1.20 M1966_SAMPLE_RATE Description Select PCM sample rate. The 1x66 devi

UG_1x66B_015 73M1866B/73M1966B Reference Driver User Guide Rev. 2.7 39 6.2 Events and Status Service The driver can be queried for a variety of

73M1866B/73M1966B Reference Driver User Guide UG_1x66B_015 4 Rev. 2.7 6.1.12 M1966_PCM_ACTIVATION_CLEAR ...

73M1866B/73M1966B Reference Driver User Guide UG_1x66B_015 40 Rev. 2.7 6.2.2 M1966_POL_GET Description Gets the current polarity reversal status o

UG_1x66B_015 73M1866B/73M1966B Reference Driver User Guide Rev. 2.7 41 6.2.3 M1966_BAT_GET Description Gets the current battery status of the FX

73M1866B/73M1966B Reference Driver User Guide UG_1x66B_015 42 Rev. 2.7 6.2.4 M1966_POH_GET Description Gets the current “parallel phone off-hook”

UG_1x66B_015 73M1866B/73M1966B Reference Driver User Guide Rev. 2.7 43 6.2.5 M1966_EVENT_GET Description Returns an event from the FIFO queue.

73M1866B/73M1966B Reference Driver User Guide UG_1x66B_015 44 Rev. 2.7 6.2.6 M1966_ERROR_CODE_GET Description This IOCTL returns the error code of

UG_1x66B_015 73M1866B/73M1966B Reference Driver User Guide Rev. 2.7 45 6.3 FXO Hook Switch Control Services The configuration and control of the

73M1866B/73M1966B Reference Driver User Guide UG_1x66B_015 46 Rev. 2.7 6.3.2 M1966_ATH1 Description Issues the off-hook signal to the FXO interfac

UG_1x66B_015 73M1866B/73M1966B Reference Driver User Guide Rev. 2.7 47 6.3.3 M1966_ATH0 Description Issues on-hook in the FXO interface. #defin

73M1866B/73M1966B Reference Driver User Guide UG_1x66B_015 48 Rev. 2.7 6.3.4 M1966_ATDP Description Performs pulse dialing on the FXO channel. As

UG_1x66B_015 73M1866B/73M1966B Reference Driver User Guide Rev. 2.7 49 6.3.5 M1966_ATDP_CANCEL Description Aborts or cancels an active pulse ses

UG_1x66B_015 73M1866B/73M1966B Reference Driver User Guide Rev. 2.7 5 7.6 M1966_PULSE_DIAL_t ...

73M1866B/73M1966B Reference Driver User Guide UG_1x66B_015 50 Rev. 2.7 6.3.6 M1966_ATDP_PARAM Description This IOCTL is used to modify or read the

UG_1x66B_015 73M1866B/73M1966B Reference Driver User Guide Rev. 2.7 51 6.3.7 M1966_FLSH_CFG Description This is the configuration of flash-hook

73M1866B/73M1966B Reference Driver User Guide UG_1x66B_015 52 Rev. 2.7 6.3.9 M1966_SEND_WETTING_PULSE Description Performs hook flashing on the FX

UG_1x66B_015 73M1866B/73M1966B Reference Driver User Guide Rev. 2.7 53 6.4 Caller-ID Services The following service control how the FXO manages

73M1866B/73M1966B Reference Driver User Guide UG_1x66B_015 54 Rev. 2.7 6.4.2 M1966_DISABLE_CALLER_ID Description Disables the automatic Caller ID

UG_1x66B_015 73M1866B/73M1966B Reference Driver User Guide Rev. 2.7 55 6.4.3 M1966_ENTER_CID_MODE Description Manually enters Caller ID mode reg

73M1866B/73M1966B Reference Driver User Guide UG_1x66B_015 56 Rev. 2.7 6.4.4 M1966_EXIT_CID_MODE Description Exits Caller ID mode. #define M1966

UG_1x66B_015 73M1866B/73M1966B Reference Driver User Guide Rev. 2.7 57 6.5 Ring Detection Services The following services control how the FXO ma

73M1866B/73M1966B Reference Driver User Guide UG_1x66B_015 58 Rev. 2.7 6.5.2 M1966_SET_RING_MIN_FREQ Description Upon detection of a ring burst th

UG_1x66B_015 73M1866B/73M1966B Reference Driver User Guide Rev. 2.7 59 6.5.3 M1966_SET_RING_MAX_FREQ Description Upon detection of a ring burst

73M1866B/73M1966B Reference Driver User Guide UG_1x66B_015 6 Rev. 2.7 Figures Figure 1: Driver Architecture ...

73M1866B/73M1966B Reference Driver User Guide UG_1x66B_015 60 Rev. 2.7 6.6 Line State Analysis Services The following services control the FXO lin

UG_1x66B_015 73M1866B/73M1966B Reference Driver User Guide Rev. 2.7 61 6.6.2 M1966_MEASURE_STOP Description Stops an on-going measurement (curre

73M1866B/73M1966B Reference Driver User Guide UG_1x66B_015 62 Rev. 2.7 6.6.3 M1966_MEASURE_UPDATE Description Reads an IET entry or updates an IE

UG_1x66B_015 73M1866B/73M1966B Reference Driver User Guide Rev. 2.7 63 The following example code illustrates a reading of a line voltage IET tab

73M1866B/73M1966B Reference Driver User Guide UG_1x66B_015 64 Rev. 2.7 6.7 GPIO Services 6.7.1 M1966_GPIO_CONFIG Description The ioctl is used t

UG_1x66B_015 73M1866B/73M1966B Reference Driver User Guide Rev. 2.7 65 6.7.3 M1966_GPIO_DATA Description This IOCTL is used to read or write da

73M1866B/73M1966B Reference Driver User Guide UG_1x66B_015 66 Rev. 2.7 6.8 Loopback Services 6.8.1 M1966_LOOPBACK Description This IOCTL is used

UG_1x66B_015 73M1866B/73M1966B Reference Driver User Guide Rev. 2.7 67 6.9 Miscellaneous 6.9.1 M1966_THRESHOLD_OVERRIDE Description Various FXO

73M1866B/73M1966B Reference Driver User Guide UG_1x66B_015 68 Rev. 2.7 6.9.2 M1966_BTONE_FILTER Description Large amplitude out-of-band tones can

UG_1x66B_015 73M1866B/73M1966B Reference Driver User Guide Rev. 2.7 69 6.9.3 M1966_CPROG_MONITOR Description The Call Progress Monitor monitors

UG_1x66B_015 73M1866B/73M1966B Reference Driver User Guide Rev. 2.7 7 1 Introduction This document describes the capabilities of the 73M1866B/73

73M1866B/73M1966B Reference Driver User Guide UG_1x66B_015 70 Rev. 2.7 6.9.4 M1966_DEBUG_LEVEL_SET Description Sets the driver trace mask to enabl

UG_1x66B_015 73M1866B/73M1966B Reference Driver User Guide Rev. 2.7 71 6.9.5 M1966_TEST_CODE Description The M1966_TEST_CODE ioctl command can b

73M1866B/73M1966B Reference Driver User Guide UG_1x66B_015 72 Rev. 2.7 7 Type and Structure Definition Reference This section contains the type de

UG_1x66B_015 73M1866B/73M1966B Reference Driver User Guide Rev. 2.7 73 #define M1966_CNTRY_CODE_MX 43 /* "Mexico"

73M1866B/73M1966B Reference Driver User Guide UG_1x66B_015 74 Rev. 2.7 7.2 M1966_CNTRY_STRUCT_t Description This structure defines the country def

UG_1x66B_015 73M1866B/73M1966B Reference Driver User Guide Rev. 2.7 75 7.3 M1966_DEBUG_TRACE_MASK Description Trace macros used by the M1966_DEB

73M1866B/73M1966B Reference Driver User Guide UG_1x66B_015 76 Rev. 2.7 7.5 struct txrx_gain Description This structure is used by the M1966_PHONE_

UG_1x66B_015 73M1866B/73M1966B Reference Driver User Guide Rev. 2.7 77 7.7 M1966_PULSE_DIAL_PARAM_t Description This structure is used by the M1

73M1866B/73M1966B Reference Driver User Guide UG_1x66B_015 78 Rev. 2.7 7.9 M1966_SAMPLE_RATE_SELECTION Description This is the enumerated sample r

UG_1x66B_015 73M1866B/73M1966B Reference Driver User Guide Rev. 2.7 79 7.10.2 M1966_BTONE_FREQUENCY Description This is the list of tone frequen

73M1866B/73M1966B Reference Driver User Guide UG_1x66B_015 8 Rev. 2.7 1.2 Conventions Used in this Guide This document uses the following convent

73M1866B/73M1966B Reference Driver User Guide UG_1x66B_015 80 Rev. 2.7 7.11 Call Progress Monitor Data Type and Structure 7.11.1 M1966_CPROG_MON_

UG_1x66B_015 73M1866B/73M1966B Reference Driver User Guide Rev. 2.7 81 7.11.3 M1966_CPROG_MONITOR_t Description This structure is used by the M1

73M1866B/73M1966B Reference Driver User Guide UG_1x66B_015 82 Rev. 2.7 7.12 GPIO Related Data Type and Structures 7.12.1 M1966_GPIO_NUMBER Descri

UG_1x66B_015 73M1866B/73M1966B Reference Driver User Guide Rev. 2.7 83 7.12.3 M1966_GPIO_CONTROL_TYPE Description GPIO control type definitios.

73M1866B/73M1966B Reference Driver User Guide UG_1x66B_015 84 Rev. 2.7 7.12.5 M1966_GPIO_DATA_TYPE Description GPIO data types – this is the GPIO

UG_1x66B_015 73M1866B/73M1966B Reference Driver User Guide Rev. 2.7 85 7.12.7 M1966_GPIO_INTR_POLARITY Description GPIO Interrupt signal transit

73M1866B/73M1966B Reference Driver User Guide UG_1x66B_015 86 Rev. 2.7 7.12.9 M1966_GPIO_DATA_t Description This structure is used by the M1966_GP

UG_1x66B_015 73M1866B/73M1966B Reference Driver User Guide Rev. 2.7 87 7.13 Loopback Related Data Type and Structure 7.13.1 M1966_LOOPBACK_COMM

73M1866B/73M1966B Reference Driver User Guide UG_1x66B_015 88 Rev. 2.7 7.13.3 M1966_LOOPBACK_t Description This is the structure used for managing

UG_1x66B_015 73M1866B/73M1966B Reference Driver User Guide Rev. 2.7 89 7.14.2 M1966_MEASURE_ACTION Description This is the enumerated list of po

UG_1x66B_015 73M1866B/73M1966B Reference Driver User Guide Rev. 2.7 9 2 Overview 2.1 Driver Architecture The driver provides a framework by whi

73M1866B/73M1966B Reference Driver User Guide UG_1x66B_015 90 Rev. 2.7 7.14.4 M1966_MEASURE_UPDATE_t Description This structure is used by the M19

UG_1x66B_015 73M1866B/73M1966B Reference Driver User Guide Rev. 2.7 91 7.14.5 M1966_IET_t Description This Interval and Event Table structure (I

73M1866B/73M1966B Reference Driver User Guide UG_1x66B_015 92 Rev. 2.7 8 Porting to a Specific H/W Platform As stated earlier, it is anticipated t

UG_1x66B_015 73M1866B/73M1966B Reference Driver User Guide Rev. 2.7 93 8.3 Platform Dependent Macros The following macros are used in the drive

73M1866B/73M1966B Reference Driver User Guide UG_1x66B_015 94 Rev. 2.7 SPI_WAIT_FOR_READY (status); \ SP

UG_1x66B_015 73M1866B/73M1966B Reference Driver User Guide Rev. 2.7 95 9 Related Documentation The following 73M1x66B documents are available fr

73M1866B/73M1966B Reference Driver User Guide UG_1x66B_015 96 Rev. 2.7 Appendix A – Country Codes Table 8 provides all the defined countries, their

UG_1x66B_015 73M1866B/73M1966B Reference Driver User Guide Rev. 2.7 97 Revision History Revision Date Description 2.0 8/22/2008 First publica

73M1866B/73M1966B Reference Driver User Guide UG_1x66B_015 98 Rev. 2.7 2.5.2 8/13/2009 Changed all instances of M1966_FXO_EVENT to M1966_FXO_EVEN