Maxim Integrated 73M1822/73M1922 Control Module - Manual (Page 7)

UG_1x22_053 73M1822/73M1922 Control Module User Guide
Rev. 1.0 7
1 Introduction
This document describes the capabilities of the 73M1822/73M1922 Control Module. This driver software
is provided for use and integration by Teridian customers on their individual platforms. The intention of
this Control Module is to provide a customizable framework that is independent of processor and
operating system.
Throughout this document the 73M1x22 Reference Device Driver will be simply referred to as “driver” or
“device driver”. The 73M1822 and 73M1922 will be collectively referred to as the 73M1x22.
1.1 Purpose and Scope
The 73M1x22 Control Module provides the necessary system interfaces for the control and management
of the 73M1x22. The driver supports API calls from the application and translates these to and from the
device. The driver can be used as is, in whole or in part, or customized to accommodate a customer’s
unique environment.
The scope of this document includes discussion of driver’s architecture and design, interface to the user
application, the driver internal state machine, and the interface to the 73M1x22 hardware module.
The driver model is intended to be independent of processor and operating system. Layers above the
Control Module address software interfaces which may pre-exist for a given application and the layer
below addresses hardware related interfaces between the processor and the 73M1x22 devices.
1.2 Conventions Used in this Guide
This document uses the following conventions:
• Software code, IOCTL names, modem events, data types, and Linux ® commands are presented in
Courier font.
• A table with a blue header is a summary table. A table with a gray header is a detail table.
1.3 Acronyms
MAFE – Modem Analog Front End
DAA – Data Access Arrangement
IOCTL – I/O Control
ISR – Interrupt Service Routine
BSP – Board Support Package
GPIO – General Purpose Input/Output
POH – Phone Off Hook
NOPOH – No Phone Off Hook
APOH – Another Phone Off Hook