Maxim-integrated 73M1866B/73M1966B FXOAPI Manual de usuario descargar pdf (Pagina 5)

UG_1x66B_046 73M1866B/73M1966B FXOAPI User Guide

Rev. 2.1 5

1 Introduction

This document describes the application programming interface (API) of the Teridian M1x66 Reference

Driver. The API is defined as a simplified functional interface allows an application program written in “C”

language to communicate with the driver without going through complicate and cumbersome Linux

driver

IOCTL. In addition, the API subsystem also encapsulates the FXO asynchronous event notification and

provides a much simpler mechanism to the user application via a callback function.

The API subsystem resides between the user application and the driver layer as shown in Figure 1.

Figure 1: Driver API

1 2 3 4 5 6 7 8 9 10 ... 65 66

73M1866B/73M1966B 1
FXOAPI User Guide 1
Table of Contents 3
Figures 4
1 Introduction 5
1.1 Overview 6
1.3 Acronyms 7
2 API Descriptions 8
2.2.1 M1x66_FxoApiInit 11
2.2.2 M1x66_FxoApiRelease 11
2.3.1 M1x66_OpenDevice 12
2.3.2 M1x66_CloseDevice 13
2.3.3 M1x66_OpenChannel 14
2.3.4 M1x66_CloseChannel 14
2.3.5 M1x66_InitChannel 15
2.4.1 M1x66_PcmIfConfig 16
2.4.2 M1x66_PcmConfig 16
2.4.3 M1x66_PcmActivation 17
2.4.4 M1x66_PcmDeActivation 17
2.5.1 M1x66_HookSwitch 18
2.5.2 M1x66_PulseDial 18
2.5.3 M1x66_PulseDialCancel 19
2.6.1 M1x66_HookSwitch 20
2.7 GPIO Management APIs 22
2.7.3 M1x66_SetGpioData 23
2.7.4 M1x66_GetGpioData 23
2.7.5 M1x66_GpioEnable 24
2.7.6 M1x66_GpioDisable 24
2.8 Loopback Control APIs 25
2.8.3 M1x66_LoopbackClear 26
2.9.1 M1x66_GetCountryParam 27
2.9.2 M1x66_SetCountryParam 27
2.11.1 M1x66_HWRegisterRead 30
2.11.4 M1x66_SetDebugTrace 31
2.11.6 M1x66_GetHWRevision 32
2.12.1 M1x66_GetCurrentIET 33
2.12.4 M1x66_GetVoltageIET 34
2.14.1 M1x66_SetRingCadence 38
2.14.2 M1x66_SetPhoneVolume 39
3 Structure Reference 41
3.1 M1x66_HANDLE_t 42
3.2 M1x66_CHAN_INIT_t 43
3.3 M1x66_PCM_IF_CFG_t 44
3.4 M1x66_PCM_CFG_t 45
3.5 M1966_CNTRY_STRUCT_t 46
3.6 M1966_THRESH_OVERRIDE_t 46
4 Enumerator Reference 47
4.1 M1x66_RET 48
4.2 M1x66_EVENT_ID 49
4.3 M1x66_COUNTRY_CODE 51
4.4 M1x66_DCL_FREQUENCY 53
4.5 M1x66_HOOK_SWITCH 54
4.6 M1x66_REG_TYPE 55
4.7 M1x66_REG_ACCESS_TYPE 57
4.8 M1966_GPIO_NUMBER 57
4.10 M1966_GPIO_CONTROL_TYPE 58
4.11 M1966_GPIO_DATA_COMMAND 59
4.12 M1966_GPIO_DATA_TYPE 59
4.15 M1x66_DEBUG_TRACE_MASK 61
5 Sample Application 62
6 Related Documentation 65
7 Contact Information 65
Revision History 66

Comentarios a estos manuales

Sin comentarios

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

Comentarios a estos manuales

Relacionado con productos y manuales para Hardware Maxim-integrated 73M1866B/73M1966B FXOAPI