Maxim-integrated 73M1822/73M1922 Control Module Instrukcja Użytkownika

Simplifying System IntegrationTM 73M1822/73M1922 Control Module User Guide December 23, 2009 Rev. 1.0 UG

73M1822/73M1922 Control Module User Guide UG_1x22_053 10 Rev. 1.0 2.2.1 Event Generation During operation the driver constantly monitors the line

UG_1x22_053 73M1822/73M1922 Control Module User Guide Rev. 1.0 11 2.2.3.2 Measurement Procedure The driver is responsible for reading the raw va

73M1822/73M1922 Control Module User Guide UG_1x22_053 12 Rev. 1.0 2.2.5 Loopback and Testing Modes The 1x22 devices support several variations of

UG_1x22_053 73M1822/73M1922 Control Module User Guide Rev. 1.0 13 3 Driver Service Interface The Driver Service provides the link between the mo

73M1822/73M1922 Control Module User Guide UG_1x22_053 14 Rev. 1.0 4 Country Specific Settings The 73M1x22 Control Module supports global complianc

UG_1x22_053 73M1822/73M1922 Control Module User Guide Rev. 1.0 15 5 Modem Events The driver provides event service to the high level application

73M1822/73M1922 Control Module User Guide UG_1x22_053 16 Rev. 1.0 5.2 Event Identification 5.2.1 M1X22_BATTERY_DROPPED This event occurs when the

UG_1x22_053 73M1822/73M1922 Control Module User Guide Rev. 1.0 17 5.2.4 M1X22_NOPOH_DETECT This event is generated when a parallel phone goes on

73M1822/73M1922 Control Module User Guide UG_1x22_053 18 Rev. 1.0 5.2.7 M1X22_RING_DETECT_END This event is generated when the driver detects the

UG_1x22_053 73M1822/73M1922 Control Module User Guide Rev. 1.0 19 5.2.10 M1X22_OI_DETECT This event is generated on detection of an over curren

73M1822/73M1922 Control Module User Guide UG_1x22_053 2 Rev. 1.0 © 2009 Teridian Semiconductor Corporation.

73M1822/73M1922 Control Module User Guide UG_1x22_053 20 Rev. 1.0 5.2.13 M1X22_DIAL_ABORTED This event is generated when a pulse dial session is

UG_1x22_053 73M1822/73M1922 Control Module User Guide Rev. 1.0 21 6 IOCTL Commands Description Upon successful opening of a device or channel de

73M1822/73M1922 Control Module User Guide UG_1x22_053 22 Rev. 1.0 6.1.1 M1X22_CH_INIT Description Performs 73M1x22 channel initialization. This i

UG_1x22_053 73M1822/73M1922 Control Module User Guide Rev. 1.0 23 6.1.2 M1X22_CNTRY_NMBR_GET Description Converts a null terminated ASCII string

73M1822/73M1922 Control Module User Guide UG_1x22_053 24 Rev. 1.0 6.1.3 M1X22_GET_COUNTRY_CONFIG This IOCTL allows an application program to rea

UG_1x22_053 73M1822/73M1922 Control Module User Guide Rev. 1.0 25 6.1.4 M1X22_SET_COUNTRY_CONFIG This IOCTL allows application program to write

73M1822/73M1922 Control Module User Guide UG_1x22_053 26 Rev. 1.0 6.1.5 M1X22_PHONE_VOLUME_SET Description The gain of both transmit and receive p

UG_1x22_053 73M1822/73M1922 Control Module User Guide Rev. 1.0 27 6.1.6 M1X22_SET_SAMPLING_FREQ Description Select modem sample rate. The 73M1x

73M1822/73M1922 Control Module User Guide UG_1x22_053 28 Rev. 1.0 6.1.7 M1X22_GET_SAMPLING_FREQ Description Return current modem sample rate. The

UG_1x22_053 73M1822/73M1922 Control Module User Guide Rev. 1.0 29 6.2 Events and Status Service The driver can be queried for a variety of curre

UG_1x22_053 73M1822/73M1922 Control Module User Guide Rev. 1.0 3 Table of Contents 1 Introduction ...

73M1822/73M1922 Control Module User Guide UG_1x22_053 30 Rev. 1.0 6.2.2 M1X22_POL_GET Description Gets the current polarity reversal status of the

UG_1x22_053 73M1822/73M1922 Control Module User Guide Rev. 1.0 31 6.2.3 M1X22_BAT_GET Description Gets the current battery status of the modem l

73M1822/73M1922 Control Module User Guide UG_1x22_053 32 Rev. 1.0 6.2.4 M1X22_POH_GET Description Gets the current “parallel phone off-hook” statu

UG_1x22_053 73M1822/73M1922 Control Module User Guide Rev. 1.0 33 6.2.5 M1X22_EVENT_GET Description Returns an event from the FIFO queue. The d

73M1822/73M1922 Control Module User Guide UG_1x22_053 34 Rev. 1.0 6.2.6 M1X22_ERROR_CODE_GET Description This IOCTL returns the error code of the

UG_1x22_053 73M1822/73M1922 Control Module User Guide Rev. 1.0 35 6.3 Modem Hook Switch Control Services The configuration and control of the mo

73M1822/73M1922 Control Module User Guide UG_1x22_053 36 Rev. 1.0 6.3.2 M1X22_ATH1 Description Issues the off-hook signal to the modem interface.

UG_1x22_053 73M1822/73M1922 Control Module User Guide Rev. 1.0 37 6.3.3 M1X22_ATH0 Description Issues on-hook in the modem interface. #define M

73M1822/73M1922 Control Module User Guide UG_1x22_053 38 Rev. 1.0 6.3.4 M1X22_ATDP Description Performs pulse dialing on the modem channel. As a

UG_1x22_053 73M1822/73M1922 Control Module User Guide Rev. 1.0 39 6.3.5 M1X22_ATDP_CANCEL Description Aborts or cancels an active pulse session

73M1822/73M1922 Control Module User Guide UG_1x22_053 4 Rev. 1.0 6.3 Modem Hook Switch Control Services ...

73M1822/73M1922 Control Module User Guide UG_1x22_053 40 Rev. 1.0 6.3.6 M1X22_ATDP_PARAM Description This IOCTL is used to modify or read the foll

UG_1x22_053 73M1822/73M1922 Control Module User Guide Rev. 1.0 41 6.3.7 M1X22_FLSH_CFG Description This is the configuration of flash-hook timin

73M1822/73M1922 Control Module User Guide UG_1x22_053 42 Rev. 1.0 6.3.9 M1X22_SEND_WETTING_PULSE Description Performs hook flashing on the modem i

UG_1x22_053 73M1822/73M1922 Control Module User Guide Rev. 1.0 43 6.4 Caller-ID Services The following service control how the modem manages Typ

73M1822/73M1922 Control Module User Guide UG_1x22_053 44 Rev. 1.0 6.4.2 M1X22_DISABLE_CALLER_ID Description Disables the automatic Caller ID proce

UG_1x22_053 73M1822/73M1922 Control Module User Guide Rev. 1.0 45 6.4.4 M1X22_EXIT_CID_MODE Description Exits Caller ID mode. #define M1X22_EX

73M1822/73M1922 Control Module User Guide UG_1x22_053 46 Rev. 1.0 6.5 Ring Detection Services The following services control how the modem manages

UG_1x22_053 73M1822/73M1922 Control Module User Guide Rev. 1.0 47 6.5.2 M1X22_SET_RING_MIN_FREQ Description Upon detection of a ring burst the d

73M1822/73M1922 Control Module User Guide UG_1x22_053 48 Rev. 1.0 6.6 Line State Analysis Services The following services control the modem line s

UG_1x22_053 73M1822/73M1922 Control Module User Guide Rev. 1.0 49 6.6.2 M1X22_MEASURE_STOP Description Stops an on-going measurement (current or

UG_1x22_053 73M1822/73M1922 Control Module User Guide Rev. 1.0 5 7.12.5 M1X22_GPIO_DATA_TYPE ...

73M1822/73M1922 Control Module User Guide UG_1x22_053 50 Rev. 1.0 6.6.3 M1X22_MEASURE_UPDATE Description Reads an IET entry or updates an IET ent

UG_1x22_053 73M1822/73M1922 Control Module User Guide Rev. 1.0 51 The following example code illustrates a reading of a line voltage IET table en

73M1822/73M1922 Control Module User Guide UG_1x22_053 52 Rev. 1.0 6.7 GPIO Services 6.7.1 M1X22_GPIO_CONFIG Description The ioctl is used to con

UG_1x22_053 73M1822/73M1922 Control Module User Guide Rev. 1.0 53 6.7.2 M1X22_GPIO_CONTROL Description The ioctl is used to control the operati

73M1822/73M1922 Control Module User Guide UG_1x22_053 54 Rev. 1.0 6.7.3 M1X22_GPIO_DATA Description This IOCTL is used to read or write data from

UG_1x22_053 73M1822/73M1922 Control Module User Guide Rev. 1.0 55 6.8 Loopback Services 6.8.1 M1X22_LOOPBACK Description This IOCTL is used fo

73M1822/73M1922 Control Module User Guide UG_1x22_053 56 Rev. 1.0 6.9 Miscellaneous 6.9.1 M1X22_THRESHOLD_OVERRIDE Description Various modem chan

UG_1x22_053 73M1822/73M1922 Control Module User Guide Rev. 1.0 57 6.9.2 M1X22_BTONE_FILTER Description Large amplitude out-of-band tones can be

73M1822/73M1922 Control Module User Guide UG_1x22_053 58 Rev. 1.0 6.9.3 M1X22_CPROG_MONITOR Description The Call Progress Monitor monitors activit

UG_1x22_053 73M1822/73M1922 Control Module User Guide Rev. 1.0 59 6.9.4 M1X22_DEBUG_LEVEL_SET Description Sets the driver trace mask to enable o

73M1822/73M1922 Control Module User Guide UG_1x22_053 6 Rev. 1.0 FiguresFigure 1: General Driver Architecture ...

73M1822/73M1922 Control Module User Guide UG_1x22_053 60 Rev. 1.0 7 Type and Structure Definition Reference This section contains the type definit

UG_1x22_053 73M1822/73M1922 Control Module User Guide Rev. 1.0 61 #define M1X22_CNTRY_CODE_MA 44 /* "Morocco" */

73M1822/73M1922 Control Module User Guide UG_1x22_053 62 Rev. 1.0 7.2 M1X22_CNTRY_STRUCT_t Description This structure defines the country default

UG_1x22_053 73M1822/73M1922 Control Module User Guide Rev. 1.0 63 7.3 M1X22_DEBUG_TRACE_MASK Description Trace macros used by the M1X22_DEBUG_LE

73M1822/73M1922 Control Module User Guide UG_1x22_053 64 Rev. 1.0 7.5 struct txrx_gain Description This structure is used by the M1X22_PHONE_VOLUM

UG_1x22_053 73M1822/73M1922 Control Module User Guide Rev. 1.0 65 7.7 M1X22_PULSE_DIAL_PARAM_t Description This structure is used by the M1X22_A

73M1822/73M1922 Control Module User Guide UG_1x22_053 66 Rev. 1.0 7.9 M1X22_SAMPLE_RATE_SELECTION Description This is the enumerated sample rate s

UG_1x22_053 73M1822/73M1922 Control Module User Guide Rev. 1.0 67 Name Value Description M1X22_XTAL_24576KHZ_FS_14400HZ 11 Set sample rate at 2

73M1822/73M1922 Control Module User Guide UG_1x22_053 68 Rev. 1.0 7.10 Billing Tone Filter Related Data Type and Structure 7.10.1 M1X22_BTONE_FIL

UG_1x22_053 73M1822/73M1922 Control Module User Guide Rev. 1.0 69 7.10.3 M1X22_BTONE_FILTER_t Description This structure is used by the M1X22_BT

UG_1x22_053 73M1822/73M1922 Control Module User Guide Rev. 1.0 7 1 Introduction This document describes the capabilities of the 73M1822/73M1922

73M1822/73M1922 Control Module User Guide UG_1x22_053 70 Rev. 1.0 7.11 Call Progress Monitor Data Type and Structure 7.11.1 M1X22_CPROG_MON_VOLT_

UG_1x22_053 73M1822/73M1922 Control Module User Guide Rev. 1.0 71 7.11.3 M1X22_CPROG_MONITOR_t Description This structure is used by the M1X22_C

73M1822/73M1922 Control Module User Guide UG_1x22_053 72 Rev. 1.0 7.12 GPIO Related Data Type and Structures 7.12.1 M1X22_GPIO_NUMBER Description

UG_1x22_053 73M1822/73M1922 Control Module User Guide Rev. 1.0 73 7.12.3 M1X22_GPIO_CONTROL_TYPE Description GPIO control type definitios. Prot

73M1822/73M1922 Control Module User Guide UG_1x22_053 74 Rev. 1.0 7.12.5 M1X22_GPIO_DATA_TYPE Description GPIO data types – this is the GPIO data

UG_1x22_053 73M1822/73M1922 Control Module User Guide Rev. 1.0 75 7.12.7 M1X22_GPIO_INTR_POLARITY Description GPIO Interrupt signal transition e

73M1822/73M1922 Control Module User Guide UG_1x22_053 76 Rev. 1.0 7.12.9 M1X22_GPIO_DATA_t Description This structure is used by the M1X22_GPIO_DA

UG_1x22_053 73M1822/73M1922 Control Module User Guide Rev. 1.0 77 7.13 Loopback Related Data Type and Structure 7.13.1 M1X22_LOOPBACK_COMMAND D

73M1822/73M1922 Control Module User Guide UG_1x22_053 78 Rev. 1.0 7.13.3 M1X22_LOOPBACK_t Description This is the structure used for managing the

UG_1x22_053 73M1822/73M1922 Control Module User Guide Rev. 1.0 79 7.14 Line Measurement Related Data Types and Structures 7.14.1 M1X22_MEASURE_

73M1822/73M1922 Control Module User Guide UG_1x22_053 8 Rev. 1.0 2 Overview 2.1 Driver Architecture The driver provides a framework by which appl

73M1822/73M1922 Control Module User Guide UG_1x22_053 80 Rev. 1.0 7.14.3 M1X22_MEASURE_START_STOP_t Description This structure is used by the M1X2

UG_1x22_053 73M1822/73M1922 Control Module User Guide Rev. 1.0 81 7.14.4 M1X22_MEASURE_UPDATE_t Description This structure is used by the M1X22_

73M1822/73M1922 Control Module User Guide UG_1x22_053 82 Rev. 1.0 7.14.5 M1X22_IET_t Description This Interval and Event Table structure (IET) is

UG_1x22_053 73M1822/73M1922 Control Module User Guide Rev. 1.0 83 8 Driver Source and Include Files The driver software is written exclusively i

73M1822/73M1922 Control Module User Guide UG_1x22_053 84 Rev. 1.0 9 Related Documentation The following 73M1x22 documents are available from Terid

UG_1x22_053 73M1822/73M1922 Control Module User Guide Rev. 1.0 85 Appendix A – Country Codes Table 8 provides all the defined countries, their co

73M1822/73M1922 Control Module User Guide UG_1x22_053 86 Rev. 1.0 Revision History Revision Date Description 1.0 12/23/2009 First publication.

UG_1x22_053 73M1822/73M1922 Control Module User Guide Rev. 1.0 9 Teridian 73M1x22 Hardware Module73M1x22 Control ModuleUser Application SoftwareI