Simplifying System IntegrationTM 73M1866B/73M1966B FXOCTL Application User Guide November 2, 2009 Rev. 4.
73M1866B/73M1966B FXOCTL Application User Guide UG_1x66B_009 © 2009 Teridian Semiconductor Corporation. All rights reserved. Teridian Semiconductor Corporation is a registered trademark of Teridian Semiconductor Corporation. Linux is a registered trademark of Linus Torvalds. All other trademarks are the property of their respective owners.
UG_1x66B_009 73M1866B/73M1966B FXOCTL Application User Guide Table of Contents 1 2 3 4 Introduction ................................................................................................................................... 5 1.1 FXOCTL User Space Application ............................................................................................. 5 1.2 FXOCTL Command Summary .................................................................................................
73M1866B/73M1966B FXOCTL Application User Guide UG_1x66B_009 Figures Figure 1: Conceptual Diagram of the Linux FXOCTL Application .............................................................. 5 Figure 2: Help Command Logging Session .............................................................................................. 7 Figure 3: Register Read Command Logging Session ...............................................................................
UG_1x66B_009 73M1866B/73M1966B FXOCTL Application User Guide 1 Introduction This document describes the 73M1866B/73M1966B FXOCTL Application, a software tool that is used to demonstrate and evaluate the 73M1866B/73M1966B Reference Driver and the 73M1866B/73M1966B devices in a system. This user guide applies to both the 73M1966B and 73M1866B, which will be collectively referred to as the ® 73M1x66B in this document. The current FXOCTL Application version can be used on Linux 2.4 and 2.6 kernels.
73M1866B/73M1966B FXOCTL Application User Guide 1.2 UG_1x66B_009 FXOCTL Command Summary Entering fxoctl at the command line brings up the FXOCTL program. Refer to the individual command descriptions in Section 2 for syntax and usage. When running the FXOCL program displays the following prompt: FXOCTL:XX> where: XX is the current active channel. The FXOCTL program can manage all 16 FXO channels as supported in the 73M1x66B daisy chain configuration.
UG_1x66B_009 73M1866B/73M1966B FXOCTL Application User Guide 2 Command Descriptions This section provides the details of each FXOCTL command. The command syntax varies based on each command but in general it consists of the command verb follow by its parameters. Some commands are self-contained (no parameter is needed) while others may have optional or mandatory parameter(s). The command verb is auto filled by the program.
73M1866B/73M1966B FXOCTL Application User Guide 2.2 UG_1x66B_009 1x66 Hardware Register Access The FXOCTL provides access to the 1x66 hardware register via register read and write command as described below. 2.2.1 Register Read Commands The register command can be used to reads the content register(s) on the current active device (NN).
UG_1x66B_009 73M1866B/73M1966B FXOCTL Application User Guide 2.2.2 Register Write Command The register command can also be used to write a value to the register on the current active device (NN). Syntax FXOCTL:NN> register rgXX=0xYY Where: XX 00 to 25 hexadecimal represent the registers from 00 to 25 hex. YY NN Hexadecimal value from 0x00 to 0xFF. Shows the current active channel ID. Refer to the chip datasheet for registers, their usage and contents.
73M1866B/73M1966B FXOCTL Application User Guide UG_1x66B_009 2.3.2 Answer Command The answer command manually answers an incoming call by bringing the FXO channel off-hook. This command is manually issued by the user when the RING event is detected. Syntax FXOCTL:NN> answer FXOCTL:NN> answer Where: (answer call on current active channel) (answer call on channel ID XX) XX 00 to 15 decimal represent the channel ID. NN Shows the current active channel ID.
UG_1x66B_009 2.5 73M1866B/73M1966B FXOCTL Application User Guide Dial Commands The dial is the command for managing pulse dial feature. With this command the user can perform pulse dialing with a numeric digit string, abort or cancel an on-going dial process, or changing or display pulse dial timing parameter. To display the dial timing parameter omit all input after the token “param”.
73M1866B/73M1966B FXOCTL Application User Guide 2.6 UG_1x66B_009 Exit Command The exit command terminates the FXOCTL program. When issued, the user is prompted and asked to confirm with a Y(es) or N(o). A “yes” terminates the program. Syntax FXOCTL:NN> exit Where: Shows the current active channel ID. NN The following is a log of the command to exit the FXOCTL program. FXOCTL:00> exit Are you sure you want to quit? (Y or N)y Enter “Y” to confirm. Good bye! Figure 9: Exit Command Logging Session 2.
UG_1x66B_009 73M1866B/73M1966B FXOCTL Application User Guide 2.7.2 On-Hook Command The onhook command brings the FXO channel on-hook. Syntax FXOCTL:NN> onhook FXOCTL:NN> onhook Where: (Bring current channel ID off-hook) (Bring channel XX off-hook) XX Channel ID. NN Show the current active channel ID. The following is a log of commands that bring the current channel ID and channel 4 on-hook. FXOCTL:00> onhook Take current channel (0) on-hook. Channel 0 is ON-hook.
73M1866B/73M1966B FXOCTL Application User Guide UG_1x66B_009 2.8.1 IET Setting Command The iet (Interval Event Table) is a table of up to 10 entries of interval threshold parameters. The driver can be instructed to monitor the line current and/or voltage and send an appropriate event when the current or voltage falls within active interval threshold. The iet command can be used for managing this IET table.
UG_1x66B_009 73M1866B/73M1966B FXOCTL Application User Guide 2.8.2 Measure Command The measure command is used to initiate or terminate a monitoring session. A monitoring session can be for line voltage or line current. Both measuring entity (voltage and current) can be active currently. Syntax (Stop) FXOCTL:NN> measure stop Where: NN Show current active channel ID. Syntax (Start) FXOCTL:NN> measure start Where: XX Sample time interval (in ms).
73M1866B/73M1966B FXOCTL Application User Guide 2.9 UG_1x66B_009 GPIO Management The FXOCTL provides three commands for managing the GPIO: 1. Config – configures the GPIO pin for operation. 2. Control – enable/disable the GPIO pin. 3. Data – accessing GPIO data. 2.9.1 GPIO Config Command The GPIO pin must be configured properly before it can be used. Using this command the user can display the GPIO configuration (GET), or configure the GPIO pin for the desired operation (SET).
UG_1x66B_009 73M1866B/73M1966B FXOCTL Application User Guide 2.9.2 GPIO Data Command Using this data command the GPIO pin can be read (if configured as input) or written into (if configured as output) with signal level of high or low. Syntax (GET) FXOCTL:NN> gpio data get gpioX Where: gpioX gpio5, gpio6, or gpio7. NN Shows the current active channel ID. Syntax (SET) FXOCTL:NN> gpio data set gpioX [low|high] Where: gpioX gpio5, gpio6, or gpio7. NN Shows the current active channel ID.
73M1866B/73M1966B FXOCTL Application User Guide UG_1x66B_009 2.10 Loopback Management There are six different loopback mode can be set internally by the driver. Using the loopback command the user can disable the loopback, query the loopback status, or enable one of the following loopback modes: 1. 2. 3. 4. 5. 6. PCM loopback Digital loopback – 1 Internal loopback – 1 Digital loopback – 2 Internal loopback – 2 Analog loopback 2.10.1 Loopback Set Command This command enables one of the loopback modes.
UG_1x66B_009 73M1866B/73M1966B FXOCTL Application User Guide 2.11 Billing Tone Filter Commands This command enables or disables the billing tone filter. If enable the user must specify the Receive Low Pass Notch (RLPN) frequency of 12 or 16 kHz. Syntax FXOCTL:NN> billingtonefilter [enable|disable] [12khz|16khz] Where: NN Shows the current active channel ID. The following is a log of the billing tone filter commands: Enable billing tone filter with RLPN at 12 kHz.
73M1866B/73M1966B FXOCTL Application User Guide UG_1x66B_009 2.13 Sample Rate Selection Command The 73M1x66B device can operate in one of two sample rates – 8 kHz or 16 kHz sample rate. The device defaults to 8 kHz operation upon startup and can be changed to run at 16 kHz using this command. Notes: Changing of PCM sample rate will affect the followings: 1.
UG_1x66B_009 73M1866B/73M1966B FXOCTL Application User Guide 3 Related Documentation The following 73M1x66B documents are available from Teridian Semiconductor Corporation: 73M1866B/73M1966B Data Sheet 73M1866B/73M1966B Reference Driver User Guide 73M1866B/73M1966B FXOAPI User Guide 4 Contact Information For more information about Teridian Semiconductor products or to check the availability of the 73M1866B and 73M1966B, contact us at: 6440 Oak Canyon Road Suite 100 Irvine, CA 92618-5201 Telephone: (714)
73M1866B/73M1966B FXOCTL Application User Guide UG_1x66B_009 Revision History Revision Date Description 1.0 3/9/2007 First publication. 1.1 9/25/2007 Reformatted to the company style. Miscellaneous editorial changes. 1.1.1 2/4/2008 Changed the document number and changed “Manual” in the title to “Guide”. 2.0 11/18/2008 Changed the document title to 73M1866B/73M1966B FXOCTL Application User Guide from 73M1966 Linux Application User Guide.
