Part Number Hot Search : 
MP8716 R1001 RTAC520 ICS9541 ISL5627 2SD1005 MUR12 MC44030P
Product Description
Full Text Search
 

To Download 2001854 Datasheet File
  If you can't view the Datasheet, Please click here to try to view without PDF Reader .  
　
 

  Datasheet File OCR Text:
 RELEASED EVALUATOR BOARD PMC-2001854 ISSUE 2
PM4354 COMET-QUAD
COMET-QUAD EVALUATOR BOARD SOFTWARE
PM4354
COMET-QUAD
COMET-QUAD EVALUATOR BOARD SOFTWARE
PRELIMINARY ISSUE 2: AUGUST 2001
PROPRIETARY AND CONFIDENTIAL TO PMC-SIERRA, INC., AND FOR ITS CUSTOMERS' INTERNAL USE
RELEASED EVALUATOR BOARD PMC-2001854 ISSUE 2
PM4354 COMET-QUAD
COMET-QUAD EVALUATOR BOARD SOFTWARE
REVISION HISTORY Issue No. 1 2 Issue Date May 2000 August 2001 Details of Change Document Created. Updated document to reflect software changes related to release of new comet-quad software driver 1.0
PROPRIETARY AND CONFIDENTIAL TO PMC-SIERRA, INC., AND FOR ITS CUSTOMERS' INTERNAL USE
RELEASED EVALUATOR BOARD PMC-2001854 ISSUE 2
PM4354 COMET-QUAD
COMET-QUAD EVALUATOR BOARD SOFTWARE
CONTENTS 1 INTRODUCTION ......................................................................................1 1.1 1.2 2 PURPOSE .....................................................................................1 SCOPE ..........................................................................................1
INSTALLATION.........................................................................................2 2.1 2.2 2.3 SYSTEM REQUIREMENTS ..........................................................2 INSTALLATION STEPS .................................................................2 UN-INSTALLATION STEPS...........................................................2
3
SOFTWARE FILES LIST..........................................................................3 3.1 3.2 OS DEPENDENT FILES................................................................3 OS INDEPENDENT FILES ............................................................3
4
GRAPHIC USER INTERFACE .................................................................5 4.1 4.2 MAIN WINDOW .............................................................................6 COMET-QUAD BOARD STATUS ..................................................8 4.2.1 PCI CONFIGURATION HEADER AND PLX LOCAL REGISTERS DISPLAY........................................................8 4.2.2 INTB BUTTON ....................................................................9 4.2.3 RESET BUTTON.................................................................9 4.3 4.4 CHANNEL SELECT .....................................................................10 COMET-QUAD REGISTER ACCESS .......................................... 11 4.4.1 ADD TO SCRIPT CHECK BOX.........................................12 4.5 4.6 4.7 COMET-QUAD STATUS ..............................................................12 COMET-QUAD INTERRUPT SOURCES.....................................16 COMET-QUAD INTERRUPT STATUS HISTORY........................17
PROPRIETARY AND CONFIDENTIAL TO PMC-SIERRA, INC., AND FOR ITS CUSTOMERS' INTERNAL USE
i
RELEASED EVALUATOR BOARD PMC-2001854 ISSUE 2
PM4354 COMET-QUAD
COMET-QUAD EVALUATOR BOARD SOFTWARE
4.8 5
HDLC WINDOW ..........................................................................18
TCL COMMANDS...................................................................................19 5.1 DEVICE MANAGEMENT .............................................................19 5.1.1 COMETQINIT....................................................................20 5.1.2 COMETQRESET...............................................................21 5.1.3 COMETQACTIVATE .........................................................21 5.1.4 COMETQDEACTIVATE ....................................................21 5.2 DEVICE READ AND WRITE........................................................21 5.2.1 COMETQREAD ............................................21 5.2.2 COMETQWRITE .........................22 5.2.3 COMETQREADBLOCK .......22 5.2.4 COMETQWRITEBLOCK ...........................................................22 5.2.5 COMETQREADFR ..................23 5.2.6 COMETQWRITEFR 23 5.2.7 COMETQREADFRIND
......................................................................23 5.2.8 COMETQWRITEFRIND
......................................................23 5.2.9 COMETQREADRLPS .............24 5.2.10 COMETQWRITERLPS 24 5.3 LINE SIDE INTERFACE...............................................................24 5.3.1 COMETQLINETXENCODECFG ..........................................................................................24 5.3.2 COMETQLINERXENCODECFG ......................................25
PROPRIETARY AND CONFIDENTIAL TO PMC-SIERRA, INC., AND FOR ITS CUSTOMERS' INTERNAL USE
ii
RELEASED EVALUATOR BOARD PMC-2001854 ISSUE 2
PM4354 COMET-QUAD
COMET-QUAD EVALUATOR BOARD SOFTWARE
5.3.3 COMETQLINETXANALOGCFG < SCMQ_CFG_TX_ANALOG > ...........................................25 5.3.4 COMETQLINERXANALOGCFG < SCMQ_CFG_RX_ANALOG > ..........................................27 5.3.5 COMETQLINETXJATCFG < SCMQ_CFG_TX_JAT > ........................................................................................28 5.3.6 COMETQLINERXJATCFG < SCMQ_CFG_RX_JAT > ....................................................29 5.3.7 COMETQLINECLKSVCCFG < ECMQ_CSU_SVC_CLK >29 5.3.8 COMETQLINERXCLKCFG < SCMQ_CFG_RX_CLK > ...................................................29 5.4 SYSTEM SIDE INTERFACE........................................................30 5.4.1 COMETQBTIFACCESSCFG < SCMQ_BACKPLANE_ACCESS_CFG >...........................30 5.4.2 COMETQBTIFFRMCFG < SCMQ_CFG_BTIF_FRM > ...............................................31 5.4.3 COMETQBRIFACCESSCFG < SCMQ_BACKPLANE_ACCESS_CFG >...........................31 5.4.4 COMETQBRIFFRMCFG < SCMQ_CFG_BRIF_FRM > ...............................................32 5.4.5 COMETQHMVIPCFG < RXHMVIPMODE > < TXHMVIPMODE > ...................................32 5.4.6 COMETQTXELSTSTCFG < ELSTENABLE > ...33 5.4.7 COMETQRXELSTSTCFG < SCMQ_CFG_RX_ELST > .................................................33 5.5 T1 /E1 FRAMERS ........................................................................34 5.5.1 COMETQSETOPERATINGMODE ..........34 5.5.2 COMETQT1TXFRAMERCFG < SCMQ_CFG_T1TX_FRM > ..............................................34
PROPRIETARY AND CONFIDENTIAL TO PMC-SIERRA, INC., AND FOR ITS CUSTOMERS' INTERNAL USE
iii
RELEASED EVALUATOR BOARD PMC-2001854 ISSUE 2
PM4354 COMET-QUAD
COMET-QUAD EVALUATOR BOARD SOFTWARE
5.5.3 COMETQT1RXFRAMERCFG < SCMQ_CFG_T1RX_FRM > ..............................................35 5.5.4 COMETQE1TXFRAMERCFG < SCMQ_CFG_E1TX_FRM > ..............................................35 5.5.5 COMETQE1RXFRAMERCFG < SCMQ_CFG_T1RX_FRM > ..............................................36 5.5.6 COMETQE1TXSETEXTRABITS < EXTRABITS >37 5.5.7 COMETQE1TXSETINTBITS < INTBITS >........37 5.5.8 COMETQE1TXSETNATBITS < CODESELECT > ............................................37 5.5.9 COMETQE1RXGETEXTRABITS ......................38 5.5.10 COMETQE1RXGETINTBITS ............................38 5.5.11 COMETQE1RXGETNATBITSNFAS .................39 5.5.12 COMETQE1RXGETNATBITSSMFRM ..............................................................39 5.6 SIGNAL INSERTION / EXTRACTION .........................................40 5.6.1 COMETQSIGEXTRACTCOSS ..........................40 5.6.2 COMETQSIGEXTRACT .............40 5.6.3 COMETQSIGTSLOTTRNKDATACFG [] ..............41 5.7 ALARM CONTROL AND INBAND COMMUNICATIONS .............42 5.7.1 COMETQAUTOALARMCFG < AUTOYELLOWEN > < AUTOREDEN > < OOF_RPSCEN > < AUTOAISEN >.............................................................42 5.7.2 COMETQINSERTALARM ........................................................................42 5.7.3 COMETQHDLCENABLE .............43 5.7.4 COMETQHDLCRXCFG < SCMQ_CFG_HDLC_RX > ................................................43
PROPRIETARY AND CONFIDENTIAL TO PMC-SIERRA, INC., AND FOR ITS CUSTOMERS' INTERNAL USE iv
RELEASED EVALUATOR BOARD PMC-2001854 ISSUE 2
PM4354 COMET-QUAD
COMET-QUAD EVALUATOR BOARD SOFTWARE
5.7.5 COMETQHDLCTXCFG < SCMQ_CFG_HDLC_TX >.................................................43 5.7.6 COMETQTDPRDATA < IDHDLC > ...................44 5.7.7 COMETQTDPRCTL < IDHDLC > .........44 5.7.8 COMETQTDPRFIFOTHRESHCFG < IDHDLC > ......................44 5.7.9 COMETQRDLCTERM < IDHDLC > ..................................45 5.7.10 COMETQRDLCADDRMATCH < IDHDLC > < ADDRPRI > < ADDRSEC >......................................................................45 5.7.11 COMETQRDLCFIFOTHRESHCFG < IDHDLC > < FIFOTHRESH> .................................................................45 5.7.12 COMETQIBCDACTLPBKCFG < CHAN > < PATLEN > ................................................................................46 5.7.13 COMETQIBCDDEACTLPBKCFG < CHAN > < PATLEN > ................................................................................46 5.7.14 COMETQIBCDTXCFG < CHAN > < PATLEN > ........................................................................46 5.7.15 COMETQBOCTXCFG < CHAN > < BOC > ..........................................................................................47 5.7.16 COMETQBOCRXCFG < CHAN > .47 5.7.17 COMETQBOCRXGET < CHAN > .....................................48 5.8 SERIAL CONTROLLER...............................................................48 5.8.1 COMETQTPSCENABLE < CHAN > ..............48 5.8.2 COMETQTPSCPCMCTL < CHAN > [ ]........................48 5.8.3 COMETQRPSCENABLE < CHAN > ..............50 5.8.4 COMETQRPSCPCMCTL < CHAN > [ ]........................50 5.8.5 COMETQTXTRNKCFG < CHAN > ................51
PROPRIETARY AND CONFIDENTIAL TO PMC-SIERRA, INC., AND FOR ITS CUSTOMERS' INTERNAL USE v
RELEASED EVALUATOR BOARD PMC-2001854 ISSUE 2
PM4354 COMET-QUAD
COMET-QUAD EVALUATOR BOARD SOFTWARE
5.8.6 COMETQRXTRNKCFG < CHAN > ................51 5.8.7 COMETQPRGDCTLCFG< CHAN > < GENLEN > ............................................................52 5.8.8 COMETQPRGDPATCFG < CHAN > < QUASIRAND > ................................................................................52 5.8.9 COMETQPRGDERRINSCFG ....................53 5.9 INTERRUPT SERVICE FUNCTIONS ..........................................54 5.9.1 COMETQPOLL .................................................................54 5.10 STATUS AND STATISTICS FUNCTIONS....................................54 5.10.1 COMETQFORCESTATSUPDATE.....................................54 5.10.2 COMETQGETSTATS ........................................................55 5.10.3 COMETQGETSTATUS .....................................................55 5.10.4 COMETQLINECLKSTATGET ............................55 5.10.5 COMETQPRGDCNTGET < CHAN > ................................56 5.10.6 COMETQPRGDGETBITCNT............................................56 5.10.7 COMETQPMONSET ......................56 5.10.8 COMETQPMONREPORTGET ..........................56 5.11 DEVICE DIAGNOSTICS ..............................................................57 5.11.1 COMETQTESTREG..........................................................57 5.11.2 COMETQLOOPFRAMER......................57 5.11.3 COMETQLOOPTSLOTS ..........................................................................................58 5.11.4 COMETQTXANALOGBYP ...............58 5.11.5 COMETQRXANALOGBYP ...............58 6 REFERENCES .......................................................................................59
PROPRIETARY AND CONFIDENTIAL TO PMC-SIERRA, INC., AND FOR ITS CUSTOMERS' INTERNAL USE
vi
RELEASED EVALUATOR BOARD PMC-2001854 ISSUE 2
PM4354 COMET-QUAD
COMET-QUAD EVALUATOR BOARD SOFTWARE
LIST OF FIGURES FIGURE 1 - MAIN WINDOW DISPLAY..............................................................6 FIGURE 2 - COMET-QUAD BLOCK DIAGRAM ................................................7 FIGURE 3 - BOARD CONTROL AND STATUS .................................................8 FIGURE 4 - CHANNEL SELECT......................................................................10 FIGURE 5 - REGISTER ACCESS.................................................................... 11 FIGURE 6 - T1 STATUS...................................................................................12 FIGURE 7 - E1 STATUS ..................................................................................13 FIGURE 8 - INTERRUPT SOURCE HISTORY ................................................16 FIGURE 9 - INTERRUPT STATUS HISTORY DISPLAY..................................17 FIGURE 10 - HDLC DISPLAY............................................................................18
PROPRIETARY AND CONFIDENTIAL TO PMC-SIERRA, INC., AND FOR ITS CUSTOMERS' INTERNAL USE
vii
RELEASED EVALUATOR BOARD PMC-2001854 ISSUE 2
PM4354 COMET-QUAD
COMET-QUAD EVALUATOR BOARD SOFTWARE
LIST OF TABLES TABLE 1 TABLE 2 TABLE 3 TABLE 4 TABLE 5 - WINDOWS 95/98 FILES ................................................................3 - WINDOWS NT/2000 FILES ...........................................................3 - MISCELLANEOUS FILES ..............................................................3 - T1 STATUS WINDOW DESCRIPTION ........................................14 - E1 STATUS WINDOW DESCRIPTION ........................................14
PROPRIETARY AND CONFIDENTIAL TO PMC-SIERRA, INC., AND FOR ITS CUSTOMERS' INTERNAL USE
viii
RELEASED EVALUATOR BOARD PMC-2001854 ISSUE 2
PM4354 COMET-QUAD
COMET-QUAD EVALUATOR BOARD SOFTWARE
1
INTRODUCTION The COMET-QUAD Evaluator Software is part of the COMET-QUAD Evaluator Kit and allows for the evaluation and demonstration of PMC-Sierra's PM4354 COMET-QUAD device. The kit also provides an environment for the development and integration of software using the software driver. The evaluation software consists of two parts. The Graphic Display provides a way for the user to access the COMET-QUAD device registers and the Tcl console provides an interface to exercise COMET-QUAD driver APIs.
1.1
Purpose The COMET-QUAD Evaluator software is designed to assist software developers in designing or integrating the COMET-QUAD device driver into their system. It helps to reduce development time when using PMC-Sierra's COMET-QUAD device and driver. The purpose of this document is to provide a detailed description of the COMET-QUAD Evaluator Software design.
1.2
Scope This document describes proper use of the software and demonstrates the functionality of the COMET-QUAD device on the evaluation board. The document gives a thorough description of each window display and use of each Tcl command. The document is prepared for COMET-QUAD Evaluation Kit Software users. The evaluation software is designed and built on top of the COMET-QUAD Device Driver. The user should refer to the documents listed in the reference section for a more in-depth understanding of COMET-QUAD device operation and driver design.
PROPRIETARY AND CONFIDENTIAL TO PMC-SIERRA, INC., AND FOR ITS CUSTOMERS' INTERNAL USE
1
RELEASED EVALUATOR BOARD PMC-2001854 ISSUE 2
PM4354 COMET-QUAD
COMET-QUAD EVALUATOR BOARD SOFTWARE
2 2.1
INSTALLATION System Requirements This program requires a Windows 95, 98, NT or 2000 PC with a Pentium and a PCI bus. For best performance, a clock speed of 200MHz and RAM size of 32Mbytes or greater is recommended. A lower performance PC can be used but the window displays may appear slow. The graphical user interface is best viewed with a monitor of size 17" or larger. The display resolution is best viewed with 1024X768.
2.2
Installation Steps 1. Insert the installation CD and run the executable file "setup.exe".
2. For best results, adjust the display monitor resolution via the control panel or the task bar. This program is best viewed with a resolution of 1024x768 and 256 or more colors. 3. Run the program from the start menu under PROGRAMS | PMC_SIERRA | COMETQUAD GUI or by double clicking on the file "cometgui.exe" within the Windows Explorer. 4. The program will notify the user if it does not detect the PCI Evaluator Kit board on the PCI bus. The user should follow the hardware installation notes to install the hardware. 2.3 Un-Installation Steps 1. 2. Open the control panel and select the add/remove software icon. Select "COMETQUAD" from the list and press the remove button.
PROPRIETARY AND CONFIDENTIAL TO PMC-SIERRA, INC., AND FOR ITS CUSTOMERS' INTERNAL USE
2
RELEASED EVALUATOR BOARD PMC-2001854 ISSUE 2
PM4354 COMET-QUAD
COMET-QUAD EVALUATOR BOARD SOFTWARE
3 3.1
SOFTWARE FILES LIST OS Dependent Files Table 1 File Name comettcl.exe cometquad.exe comet.vxd - Windows 95/98 Files Description This is the Tcl console executable file for Win95 that has all the COMET-QUAD driver API commands built in. This is the GUI file for Win95 that executes the main window. This is the Windows 95/98 driver. This driver is used by the GUI and Tcl Console to provide access to the COMETQUAD Evaluation Board.
Table 2 File Name
- Windows NT/2000 Files Description This is the Tcl console executable file for WinNT that has all the COMET-QUAD driver API commands built in. This is the GUI file for WinNT that executes the main window. This is the Windows NT/2000 driver. This driver is used by the GUI and Tcl Console to provide access to the COMETQUAD Evaluation Board.
comettcl.exe cometquad.exe comet.sys
3.2
OS Independent Files Table 3 File Name cometquad.hlp cometquad.EMF - Miscellaneous Files Description This is the Windows help file that is built based on the COMET-QUAD Data sheet. The COMET-QUAD block diagram.
PROPRIETARY AND CONFIDENTIAL TO PMC-SIERRA, INC., AND FOR ITS CUSTOMERS' INTERNAL USE
3
RELEASED EVALUATOR BOARD PMC-2001854 ISSUE 2
PM4354 COMET-QUAD
COMET-QUAD EVALUATOR BOARD SOFTWARE
File Name cometquad_t1_esf_sh.tcl
Description This script sets up the COMET-QUAD for Short Haul (0-110ft) T1 ESF external payload loop back (for all channels) using the driver API's. This script sets up the COMET-QUAD for E1 CRC-Multi-Frame external payload loop back (for all channels) using the driver API's. This script sets up the COMET-QUAD for Short Haul (0-110ft) T1 ESF external payload loop back (for all channels) using register writes only. This script sets up the COMET-QUAD for E1 CRC-Multi-Frame external payload loop back (for all channels) using register writes only.
cometquad_e1_crcmf.tcl
cometquad_reg_t1_esf_sh.tcl
cometquad_reg_e1_crcmf.tcl
PROPRIETARY AND CONFIDENTIAL TO PMC-SIERRA, INC., AND FOR ITS CUSTOMERS' INTERNAL USE
4
RELEASED EVALUATOR BOARD PMC-2001854 ISSUE 2
PM4354 COMET-QUAD
COMET-QUAD EVALUATOR BOARD SOFTWARE
4
GRAPHIC USER INTERFACE The graphic windows provide users easy access to the COMET-QUAD device. Additionally, the program provides interactive access to the COMET-QUAD datasheet via various window displays. This information is in the form of Windows Help. Help is obtained by a mouse left-click on a window control when the help cursor appears, or by accessing help from the main menu. The cursor changes from an arrow icon to a hand icon to indicate that the mouse can be left-clicked at the current position. The hand icon indicates that an action will occur when the mouse is left-clicked. The action will depend on where the mouse cursor is positioned. Some windows allow the user to select from a pop-up menu when the mouse is right-clicked. The operation of each window is discussed in the following sections.
PROPRIETARY AND CONFIDENTIAL TO PMC-SIERRA, INC., AND FOR ITS CUSTOMERS' INTERNAL USE
5
RELEASED EVALUATOR BOARD PMC-2001854 ISSUE 2
PM4354 COMET-QUAD
COMET-QUAD EVALUATOR BOARD SOFTWARE
4.1
Main Window Figure 1 - Main Window Display
The main window display (Figure 1) is shown when the program starts. The display contains a main menu and a bitmap photo of the PCI add-in card. A popup menu can be launched with a right-click anywhere in the main window display. This menu contains the same items as the "COMET-QUAD" main menu item. The main menu allows the user to display detailed information concerning one of three areas: 1. "Configuration" menu item provides selections to display board status and to exit the program
PROPRIETARY AND CONFIDENTIAL TO PMC-SIERRA, INC., AND FOR ITS CUSTOMERS' INTERNAL USE
6
RELEASED EVALUATOR BOARD PMC-2001854 ISSUE 2
PM4354 COMET-QUAD
COMET-QUAD EVALUATOR BOARD SOFTWARE
2. 3.
"TCL Command" menu item provides selections to launch the Tcl console, run Tcl scripts, and view Tcl log files. "COMET-QUAD" menu item provides selections to launch detailed displays associated with the COMET-QUAD device: channel selection window, registers read/write window, alarm status window, interrupt status window, and HDLC statistic displays. "Help" menu item provides selections to launch documentation concerning the COMET-QUAD, this program or the board.
4.
Figure 2
- COMET-QUAD Block Diagram
If the mouse is placed above the COMET-QUAD in the bitmap, the cursor will appear as a hand. A left-click on the COMET-QUAD will replace the bitmap with a COMET-QUAD block diagram (Figure 2). The same change can be performed by selecting "COMET-QUAD | Show Block Diagram" in the main menu, or on the right-click popup menu item.
PROPRIETARY AND CONFIDENTIAL TO PMC-SIERRA, INC., AND FOR ITS CUSTOMERS' INTERNAL USE
7
RELEASED EVALUATOR BOARD PMC-2001854 ISSUE 2
PM4354 COMET-QUAD
COMET-QUAD EVALUATOR BOARD SOFTWARE
When the block diagram is shown in the main window the user can move the mouse across the block diagram and left-click on a block, or pin name. When the hand cursor is left-clicked a popup menu allows the user to access a register associated with the block, or to display help information describing the block. The user can directly access help information describing a pin when the help cursor is left-clicked above the pin name. 4.2 COMET-QUAD Board Status Figure 3 - Board Control and Status
This display is launched from the main menu item "Configuration | Board Control ". It provides access to the PLX 9050 chip that bridges the PCI bus to the COMET-QUAD device. 4.2.1 PCI Configuration Header and PLX Local Registers Display The PCI Configuration Header and PLX local register values are shown in the display window. The information is only retrieved once when the program starts. The following provides some brief and useful information about these values. * * VendorID and DeviceId are used by the GUI to recognize the PCI card. BaseAddress[0] is the physical address of the PLX registers.
PROPRIETARY AND CONFIDENTIAL TO PMC-SIERRA, INC., AND FOR ITS CUSTOMERS' INTERNAL USE
8
RELEASED EVALUATOR BOARD PMC-2001854 ISSUE 2
PM4354 COMET-QUAD
COMET-QUAD EVALUATOR BOARD SOFTWARE
* * *
BaseAddress[2] is the physical address of the COMET-QUAD registers InterruptLine is the IRQ number assigned by the OS. InterruptPin is the pin that is routed to the COMET-QUAD INTB pin.
Please refer to PLX9050 datasheet and PCI specification for more detailed information on these register values. 4.2.2 INTB button When the program is started, a periodic one-second timer is activated. On timeout, the PLX9050 interrupt status register (INTCSR) is read to determine the state of the COMET-QUAD INTB pin. The local interrupt status bit (bit2) of the PLX9050 interrupt status register is read and displayed. When it is set, INTB pin is active and the INTB panel is displayed red in color. When the COMET-QUAD interrupt is cleared, INTB pin is inactive and the INTB panel is displayed green in color. When this button is clicked, the COMET-QUAD INTB pin is routed to the PCI interrupt pin by asserting the PCI Interrupt Enable bit of the register INTCSR. The Interrupt Service Routine of the program is then associated with the COMET-QUAD INTB signal. In this GUI design, three windows are added with interrupt capabilities along with original timer polling routines. Upon receiving an interrupt event, the ISR manually calls the timer timeout event of the following windows: Status window, Interrupt windows, and HDLC window. Enabling the PCI interrupt enhances the performance of the GUI to reflect almost real-time status of the COMET-QUAD registers. The Title bar displays the mode of operation (Polling or Interrupt driven). A counter near the INTB button displays the number of interrupt serving attempts. NOTE: if the INTB can't be cleared, the counter accumulates really fast and endless running of the interrupt routine can decrease computer performance dramatically. 4.2.3 Reset button The "Reset" button instructs the PLX 9050 chip to toggle the COMET-QUAD RSTB pin. This is a hardware reset of the COMET-QUAD. Pressing the reset button on the board also causes register values to be reset to their default values.
PROPRIETARY AND CONFIDENTIAL TO PMC-SIERRA, INC., AND FOR ITS CUSTOMERS' INTERNAL USE
9
RELEASED EVALUATOR BOARD PMC-2001854 ISSUE 2
PM4354 COMET-QUAD
COMET-QUAD EVALUATOR BOARD SOFTWARE
4.3
Channel Select Figure 4 - Channel Select
This window is launched from the main menu under COMET-Quad or by rightclicking the "COMETQUAD Channel Select" menu item. This window provides a means for windows to display different COMET-QUAD channels. The change in channels affects three windows: Status window, Interrupt windows, and Register Access window. The title bar in these windows indicates the current channel of operation.
PROPRIETARY AND CONFIDENTIAL TO PMC-SIERRA, INC., AND FOR ITS CUSTOMERS' INTERNAL USE
10
RELEASED EVALUATOR BOARD PMC-2001854 ISSUE 2
PM4354 COMET-QUAD
COMET-QUAD EVALUATOR BOARD SOFTWARE
4.4
COMET-QUAD Register Access Figure 5 - Register Access
The COMET-QUAD registers can be directly accessed via the register access window. This window is launched from the main menu under COMET-Quad or by right-clicking the "COMET-QUAD | Register Access" menu item. This display has a "Read" and a "Write" button that provides read or write access to the COMET-QUAD device. A register is selected by left-clicking one of the register spaces of the COMET-QUAD - either normal, RPSC, TPSC or SIGX. Then the register is selected by name in the pull down list, or by directly typing in the register offset box.
PROPRIETARY AND CONFIDENTIAL TO PMC-SIERRA, INC., AND FOR ITS CUSTOMERS' INTERNAL USE
11
RELEASED EVALUATOR BOARD PMC-2001854 ISSUE 2
PM4354 COMET-QUAD
COMET-QUAD EVALUATOR BOARD SOFTWARE
The register value can be viewed after the "Read" button is left-clicked, or alternatively the user can specify a register value to write. Within the control titled "Value of bit fields", clicking on one of the bit panels in the Value column toggles that value bit. Clicking on the Value panel clears all value bits. Clicking on the Default panel sets the value to the register default. Alternatively the user can specify the value directly in the control titled "Register value". Once the value is specified, the user can issue a write access to the COMET-QUAD by left-clicking the "Write" button. The name of each bit field for the register offset is shown in this window. If the user moves the mouse over any of the bit names, the cursor changes to a help icon. Left-clicking at this time launches context sensitive help for the register display. 4.4.1 Add to Script Check Box This check box provides users a way to record direct or indirect read/write accesses from the GUI. When the check box is clicked, the script, "tmpScript.tcl" is opened. Read and Write accesses from clicking window buttons are automatically appended to the script. NOTE that the command "INITIALIZE" must be added to the fist line of the script so that COMET-QUAD driver api can be run. In addition, "UPDATELOGFILE" must be added to the end of the script to update the output log file. 4.5 COMET-QUAD Status Figure 6 - T1 Status
PROPRIETARY AND CONFIDENTIAL TO PMC-SIERRA, INC., AND FOR ITS CUSTOMERS' INTERNAL USE
12
RELEASED EVALUATOR BOARD PMC-2001854 ISSUE 2
PM4354 COMET-QUAD
COMET-QUAD EVALUATOR BOARD SOFTWARE
Figure 7
- E1 Status
The COMET-QUAD status window is launched from the main menu item "COMET-QUAD | Status". This window appears differently for T1 configurations than for E1 configurations. In both cases, it shows the status of some alarms and the accumulated count of the performance monitor error counters. The status window determines whether the configuration is an E1 or T1 application by reading the E1/T1Bit from the register value database. The alarm status is shown as a red color when the associated status bit value is set. It is shown as a green color when the associated status bit value is clear. Status bit values are taken from the register value database instead of the COMET-QUAD registers. Alarm panels that correspond with database values that have not been updated (invalid values) are shown as grey. Each alarm status has a current and a history panel. A right-click of the mouse enables the user to select a menu item from a popup menu. Selecting "Clear History" turns all history panels to grey. The next timeout updates the register value database (during a register access) and that causes the alarm and history panels to change to either red or green. The "Enable/Disable Register Access" menu item of the popup menu can be selected to enable, or disable, register access. Register reads are performed periodically (1 seconds) to update the register value database for alarms and history when the window is visible. Choosing "Disable Register Access" stops the periodic register read accesses. When register access is disabled the alarm text heading includes the text "Disabled Register Access", and the PMON counters show the text "disabled". PMON counters are not accumulated when register access is disabled but they are accumulated when the window is not visible.
PROPRIETARY AND CONFIDENTIAL TO PMC-SIERRA, INC., AND FOR ITS CUSTOMERS' INTERNAL USE
13
RELEASED EVALUATOR BOARD PMC-2001854 ISSUE 2
PM4354 COMET-QUAD
COMET-QUAD EVALUATOR BOARD SOFTWARE
The following tables show the registers and bits that are read for status display
Table 4 Status
- T1 Status Window Description "LOSV" "ALTLOS" "ALOSV" "OOF (~INFR)" "AIS" "RED" "YEL"
Register Bit(s)
0xQ12 bit0
0xQ13 bit0
0xQF8 bit6
0xQ4A bit0
0xQ62 bit0 bit1 bit2
Table 5 Status
- E1 Status Window Description "LOSV" "ALTLOS" "ALOSV" "OOFV" "OOSMFV" "RAIV" "RED"
"OOCMFV" "AIS" "OOOFV" Register Bit(s) 0xQ12 bit0 0xQ13 bit0 0xQF8 bit6 0xQ96 bit6 bit5 bit4 bit3 0xQ97 bit7 bit3 bit2
The performance monitor counters shown in this display are an accumulation of the PMON counters within the COMET-QUAD device. The polling of counters can be enabled/disabled by a right-click to launch the popup menu and a leftclick on the "specify counter polling interval" menu item. A non-zero polling value causes the PMON counter registers to be read periodically. A zero value disables polling of the PMON counters. At each poll interval register 0xQ59 is
PROPRIETARY AND CONFIDENTIAL TO PMC-SIERRA, INC., AND FOR ITS CUSTOMERS' INTERNAL USE
14
RELEASED EVALUATOR BOARD PMC-2001854 ISSUE 2
PM4354 COMET-QUAD
COMET-QUAD EVALUATOR BOARD SOFTWARE
written to transfer the internal counts to the visible registers. Then each register is read and added to the displayed value. PMON counter accumulations are also disabled if the user chooses to disable register access. When the accumulations are disabled the counter value is not displayed. Instead the text "disabled" is displayed. The accumulated counts shown in the window can be cleared by selecting "Clear Counters" from the popup menu.
For T1 applications the following PMON counters are shown in this window: * * * * Framing Bit Error Count OOF Error Count if the CCOFA bit of the receive options register is clear. Otherwise it's the COFA Error Count. Bit Error Count LCV Error Count
For E1 applications the following PMON counters are shown in this window: * * * * Framing Bit Error Count Far End Block Error Count CRC Error Count LCV Error Count
PROPRIETARY AND CONFIDENTIAL TO PMC-SIERRA, INC., AND FOR ITS CUSTOMERS' INTERNAL USE
15
RELEASED EVALUATOR BOARD PMC-2001854 ISSUE 2
PM4354 COMET-QUAD
COMET-QUAD EVALUATOR BOARD SOFTWARE
4.6
COMET-QUAD Interrupt Sources Figure 8 - Interrupt Source History
The COMET-QUAD Interrupt Sources window is launched by selecting the main menu item "COMET-QUAD | Interrupts". The window shows the status of all interrupt sources. Panels representing bits of the three registers that are the source of all interrupts can be colored red, green or grey. A grey panel indicates that the interrupt source bit has not been read and updated in the register value database. A red color indicates an active interrupt the last time this source bit was read. A green color indicates the interrupt source was not active the last time this source bit was read. The cursor appears as a help icon when it is moved around the boundary line of a group box on this display. A left-click with the help icon launches register specific help. The cursor appears as a hand icon when it is moved across bit panels in this window. If the user left-clicks with the hand icon then an Interrupt Status History window for the selected source bit panel is displayed.
PROPRIETARY AND CONFIDENTIAL TO PMC-SIERRA, INC., AND FOR ITS CUSTOMERS' INTERNAL USE
16
RELEASED EVALUATOR BOARD PMC-2001854 ISSUE 2
PM4354 COMET-QUAD
COMET-QUAD EVALUATOR BOARD SOFTWARE
4.7
COMET-QUAD Interrupt Status History Figure 9 - Interrupt Status History Display
The COMET-QUAD Interrupt Status History window is launched with a left-click on a source bit of the COMET-QUAD Interrupt Sources window. Each source bit represents a COMET-QUAD block. The window shows the status history of each interrupt status bit associated with the selected COMET-QUAD block. Status bits are green if all previous accesses to the register had an inactive (clear) bit. Status bits are red if one or more previous accesses to the register had an active (set) bit. The most current status for the bits within a register is obtained by a right-click on the status bit to launch a pop-up menu. If the menu item "Read register and clear status" is selected then the COMET-QUAD register is read, status bits are cleared, and the register value database is updated with the new register status/history. Interrupt status history is cleared from the display by a right-click on the display to launch a popup menu, and choosing the "Clear Register History" menu item. Status bits are grey if the register has not yet been read from the COMET-QUAD. A clearing count is provided beside the name of each register. The clearing count increments by one when the register is read, and one or more of the interrupt status bits are active. A depressed panel indicates the status bit is enabled - that it may activate the INTB pin if the status bit is active (red). A panel which appears to stick out of the window, indicates the status bit is disabled - that it could not activate the INTB pin when the status bit is active (red). A hand cursor appears over a status bit and allows the user to enable/disable the individual interrupts associated with the status bits. When the cursor is moved across the window it may appear as a help icon and can be left-clicked to launch help on the register underneath the cursor.
PROPRIETARY AND CONFIDENTIAL TO PMC-SIERRA, INC., AND FOR ITS CUSTOMERS' INTERNAL USE
17
RELEASED EVALUATOR BOARD PMC-2001854 ISSUE 2
PM4354 COMET-QUAD
COMET-QUAD EVALUATOR BOARD SOFTWARE
4.8
HDLC Window Figure 10 - HDLC Display
The COMET-QUAD HDLC window is launched by selecting the main menu item "COMET-QUAD | HDLC ". This GUI demonstrates the RDLC receiver Block of the COMET-QUAD. Each quadrant of COMET-QUAD has an HDLC controller. The user can select any of the four controllers to monitor from the Pull-down list. When the start button is clicked, a thread that runs continuously in a loop starts to poll the INTR bit of the RDLC Status registers (0xQC2). If INTR bit (bit0) is asserted, the program reads the status registers and RDLC Data FIFO. The data collected is then organized and stored in the database. The GUI display uses a 0.1s timer to poll the database and display the statistics. When the Stop button is clicked, the thread is blocked and stopped to collect statistics. When the Reset button is clicked, the database is reset to 0 for all statistics.
PROPRIETARY AND CONFIDENTIAL TO PMC-SIERRA, INC., AND FOR ITS CUSTOMERS' INTERNAL USE
18
RELEASED EVALUATOR BOARD PMC-2001854 ISSUE 2
PM4354 COMET-QUAD
COMET-QUAD EVALUATOR BOARD SOFTWARE
5
TCL COMMANDS The Tcl commands are derived based on the COMET-QUAD device driver APIs. This section describes the Tcl commands and input parameters that can be used to exercise to the driver APIs. It is advised that the user refers to the COMETQUAD Device Driver Design Specification and COMET-QUAD Device Driver User's Guide when using the Tcl script commands. The Tcl interface to the driver API is built to familiarize the user with the driver architecture. Therefore, each Tcl command is almost built for one-to-one mapping to the actual API calls. There are only a few exceptions. 1. The input deviceHandle is omitted in the command 2. The output pointers of the input command are omitted. 3. Some Tcl commands (APIs) can only be used in certain device states. Please refer to COMET-QUAD Device Driver User's Guide for each Tcl command(API)'s valid states. 4. The device state can be manipulated using Device Management commands: "cometqInit", "cometqActivate", "cometqReset", "cometqDeActivate" 5. The output of the API is echoed on the Tcl console. It is also written to the file "outfile.txt"
* *
<> brackets around a field imply that the textual representation of a number or character strings must be entered in the field. [ ] brackets around a field, or fields, imply that the field(s) is optional.
Note that in Tcl script language, { } bracket is used to group a list of inputs into one field. Therefore, when an input field, such as a pointer to a block, requires multiple entries, { } is used to group the block.
5.1
Device Management The following APIs are executed INITIALIZATION
PROPRIETARY AND CONFIDENTIAL TO PMC-SIERRA, INC., AND FOR ITS CUSTOMERS' INTERNAL USE
19
RELEASED EVALUATOR BOARD PMC-2001854 ISSUE 2
PM4354 COMET-QUAD
COMET-QUAD EVALUATOR BOARD SOFTWARE
*Note: INITIALIZATION sets the device to T1 mode by default. To change the operating mode to E1, user needs to reset (cometqReset) and reinitialize (cometqInit) and then call "cometqSetOperatingMode", followed by reactivation (cometqActivate). cometqModuleOpen cometqModuleStart cometqAdd cometqInit cometqActivate CLOSE cometqDeActivate cometqDelete cometqModuleStop cometqModuleClose UPDATELOGFILE This command closes the filestream and writes the the up-to-date Tcl outputs to the "outfile.txt"
5.1.1 cometqInit
Description Map to API Input field(s) Output Example Initialize comet-Quad device to default setting. ( with input field pdiv = NULL, profileNum = 0 ) Change device state from "Present" to "Inactive". INT4 cometqInit(sCMQ_HNDL deviceHandle, sCMQ_DIV *pdiv, UINT2 profileNum); none none if success cometqInit
PROPRIETARY AND CONFIDENTIAL TO PMC-SIERRA, INC., AND FOR ITS CUSTOMERS' INTERNAL USE
20
RELEASED EVALUATOR BOARD PMC-2001854 ISSUE 2
PM4354 COMET-QUAD
COMET-QUAD EVALUATOR BOARD SOFTWARE
5.1.2 cometqReset
Description Applies a software reset to the COMET or COMET-Quad device. Also resets all the DDB contents. Change device state from "Inactive" or "Active" to "Present". INT4 cometqReset(sCMQ_HNDL deviceHandle); none none if success cometqReset
Map to API Input field(s) Output Example
5.1.3 cometqActivate
Description Map to API Input field(s) Output Example The cometqActivate API activates the device by enabling the interrupt if the device is in ISR mode. Change device state from "Inactive" to "Active" INT4 cometqActivate(sCMQ_HNDL deviceHandle); none none if success cometqActivate
5.1.4 cometqDeActivate
Description The cometqDeActivate API Deactivates the device by disabling interrupts if the device is in ISR mode and retaining interrupt mask within the DDB. Change device state from "Active" to "Inactive" INT4 cometqDeActivate(sCMQ_HNDL deviceHandle); none none if success cometqDeActivate
Map to API Input field(s) Output Example
5.2
Device Read and Write
5.2.1 cometqRead
Description Map to API Reading from the Device Registers. UINT1 cometqRead(sCMQ_HNDL deviceHandle, UINT2 regNum)
PROPRIETARY AND CONFIDENTIAL TO PMC-SIERRA, INC., AND FOR ITS CUSTOMERS' INTERNAL USE
21
RELEASED EVALUATOR BOARD PMC-2001854 ISSUE 2
PM4354 COMET-QUAD
COMET-QUAD EVALUATOR BOARD SOFTWARE
Input field(s) Output Example
any number from 0x0 to 0x3ff print the Register value if success cometqRead 0x100
5.2.2 cometqWrite
Description Map to API Input field(s) Output Example Writing to Device Registers. UINT1 cometqWrite(sCMQ_HNDL deviceHandle, UINT2 regNum, UINT1 value) any number from 0x0 to 0x3ff any number from 0x0 to 0xff none if success cometqWrite 0x100 0x1
5.2.3 cometqReadBlock
Description Map to API Input field(s) Output Example Reading from a block of Device Registers UINT1 cometqReadBlock(sCMQ_HNDL deviceHandle, UINT2 startRegNum, UINT2 size, UINT1 *pblock) any number from 0x0 to 0x3ff any number from 0x0 to 0x3ff print the Block of Register values if success cometqReadBlock 0 5
5.2.4 cometqWriteBlock
Description Map to API Input field(s)
Writing to a Block of Device Registers UINT1 cometqWriteBlock(sCMQ_HNDL deviceHandle, UINT2 startRegNum, UINT2 size, UINT1 *pblock, UINT1 *pmask) any number from 0x0 to 0x3ff any number from 0x0 to 0x3ff a set of numbers from 0x0 to 0xff a set of numbers from 0x0 to 0xff none if success cometqWriteBlock 0 5 {1 2 3 4 5} {0xff 0 0xff 0xff 0}
Output Example
PROPRIETARY AND CONFIDENTIAL TO PMC-SIERRA, INC., AND FOR ITS CUSTOMERS' INTERNAL USE
22
RELEASED EVALUATOR BOARD PMC-2001854 ISSUE 2
PM4354 COMET-QUAD
COMET-QUAD EVALUATOR BOARD SOFTWARE
5.2.5 cometqReadFr
Description Map to API Input field(s) Output Example Reading from Framer Device Registers: UINT1 cometqReadFr(sCMQ_HNDL deviceHandle, UINT1 frmNum, UINT2 regNum) any number from 0 to 3 any number from 0x0 to 0xff print the Register value if success cometqReadFr 0 0x1
5.2.6 cometqWriteFr
Description Map to API Input field(s) Output Example Writing to Framer Device Registers UINT1 cometqWriteFr(sCMQ_HNDL deviceHandle, UINT1 frmNum, UINT2 regNum, UINT1 value) any number from 0 to 3 any number from 0x0 to 0xff any number from 0x0 to 0xff none if success cometqWriteFr 0 0x1 0xff
5.2.7 cometqReadFrInd

Description Map to API Input field(s) Reading from Device Indirect Registers UINT1 cometqReadFrInd(sCMQ_HNDL deviceHandle, UINT1 frmNum, eCMQ_SECTION section, UINT2 regNum) any number from 0 to 3
CMQ_SIGX_SECT or 0, CMQ_TPSC_SECT or 1, CMQ_RPSC_SECT or 2, CMQ_XLPG_SECT or 3 any number in the valid address range print the Register value if success cometqReadFrInd 0 CMQ_SIGX_SECT 0x20
Output Example
5.2.8 cometqWriteFrInd

Description Map to API Writing to Device Indirect Registers UINT1 cometqWriteFrInd(sCMQ_HNDL deviceHandle, UINT1 frmNum eCMQ SECTION section, UINT2 regNum, UINT1
PROPRIETARY AND CONFIDENTIAL TO PMC-SIERRA, INC., AND FOR ITS CUSTOMERS' INTERNAL USE
23
RELEASED EVALUATOR BOARD PMC-2001854 ISSUE 2
PM4354 COMET-QUAD
COMET-QUAD EVALUATOR BOARD SOFTWARE
value) Input field(s) any number from 0 to 3
CMQ_SIGX_SECT or 0, CMQ_TPSC_SECT or 1, CMQ_RPSC_SECT or 2, CMQ_XLPG_SECT or 3 any number in the valid address range any number from 0x0 to 0xff none if success cometqWriteFrInd 0 CMQ_SIGX_SECT 0x20 0x1
Output Example
5.2.9 cometqReadRLPS
Description Map to API Input field(s) Output Example Reading from Device RLPS Indirect Registers UINT1 cometqReadRLPS(sCMQ_HNDL deviceHandle, UINT2 frmNum,UINT1 regNum) any number from 0 to 3 any number from 0x0 to 0xff print the Register value if success cometqReadRLPS 0 0x1
5.2.10 cometqWriteRLPS
Description Map to API Input field(s) Output Example Writing to Device RLPS Indirect Registers UINT4 cometqWriteRLPS(sCMQ_HNDL deviceHandle, UINT2 frmNum, UINT1 regNum, UINT4 value) any number from 0 to 3 any number from 0x0 to 0xff any number from 0x0 to 0xff none if success cometqWriteRLPS 0 0x1 0xff
5.3
Line Side Interface
5.3.1 cometqLineTxEncodeCfg
Description Configure transmit line encoding
PROPRIETARY AND CONFIDENTIAL TO PMC-SIERRA, INC., AND FOR ITS CUSTOMERS' INTERNAL USE
24
RELEASED EVALUATOR BOARD PMC-2001854 ISSUE 2
PM4354 COMET-QUAD
COMET-QUAD EVALUATOR BOARD SOFTWARE
Map to API Input field(s)
Output Example
INT4 cometqLineTxEncodeCfg(sCMQ_HNDL deviceHandle, UINT2 chan, eCMQ_LINE_CODE encScheme); any number from 0 to 3 CMQ_LINE_CODE_AMI or 0, CMQ_LINE_CODE_HDB3_E1 or 1, CMQ_LINE_CODE_B8ZS_T1 or 2 none if success cometqLineTxEncodeCfg 1 1
5.3.2 cometqLineRxEncodeCfg
Description Map to API Input field(s) Configure receive line encoding INT4 cometqLineRxEncodeCfg(sCMQ_HNDL deviceHandle, UINT2 chan, eCMQ_LINE_CODE encScheme, UINT1 incXSZeros, UINT1 E1_O162En); any number from 0 to 3 CMQ_LINE_CODE_AMI or 0, CMQ_LINE_CODE_HDB3_E1 or 1, CMQ_LINE_CODE_B8ZS_T1 or 2 < incXSZeros> 0 or 1 < E1_O162En > 0 or 1 none if success cometqLineRxEncodeCfg 0 1 0 1
Output Example
5.3.3 cometqLineTxAnalogCfg < sCMQ_CFG_TX_ANALOG >
Description Map to API Input field(s) Configure analog transmit line INT4 cometqLineTxAnalogCfg(sCMQ_HNDL deviceHandle, UINT2 chan, sCMQ_CFG_TX_ANALOG* ptxAnalogCfg); any number from 0 to 3 < sCMQ_CFG_TX_ANALOG > = { { } } : 0 or 1 : CMQ_TX_LBO_T1_LONG_HAUL_0DB or 0, CMQ_TX_LBO_T1_LONG_HAUL_7_5DB or 1, CMQ_TX_LBO_T1_LONG_HAUL_15DB or 2, CMQ_TX_LBO_T1_LONG_HAUL_22_5DB or 3, CMQ_TX_LBO_T1_LONG_HAUL_TR62411_0DB or 4, CMQ_TX_LBO_T1_SHORT_HAUL_110FT or 5, CMQ_TX_LBO_T1_SHORT_HAUL_220FT or 6,
PROPRIETARY AND CONFIDENTIAL TO PMC-SIERRA, INC., AND FOR ITS CUSTOMERS' INTERNAL USE
25
RELEASED EVALUATOR BOARD PMC-2001854 ISSUE 2
PM4354 COMET-QUAD
COMET-QUAD EVALUATOR BOARD SOFTWARE
Output Example 1
CMQ_TX_LBO_T1_SHORT_HAUL_330FT or 7, CMQ_TX_LBO_T1_SHORT_HAUL_440FT or 8, CMQ_TX_LBO_T1_SHORT_HAUL_550FT or 9, CMQ_TX_LBO_T1_SHORT_HAUL_660FT or 10, CMQ_TX_LBO_T1_SHORT_HAUL_TR62411_110FT or 11, CMQ_TX_LBO_T1_SHORT_HAUL_TR62411_220FT or 12, CMQ_TX_LBO_T1_SHORT_HAUL_TR62411_330FT or 13, CMQ_TX_LBO_T1_SHORT_HAUL_TR62411_440FT or 14, CMQ_TX_LBO_T1_SHORT_HAUL_TR62411_550FT or 15, CMQ_TX_LBO_T1_SHORT_HAUL_TR62411_660FT or 16, CMQ_TX_LBO_E1_75OHM or 17, CMQ_TX_LBO_E1_120OHM or 18, CMQ_TX_LBO_USER_DEFINED or 19, CMQ_TX_LBO_RETAIN_CURRENT or 20 : Scale factor : a [24][5] array Note: This array entry is only needed when wvFormType = CMQ_TX_LBO_USER_DEFINED : CMQ_TX_FUSE_DATA_TST_CTL or 0 CMQ_TX_FUSE_DATA_ENABLE or 1 CMQ_TX_FUSE_DATA_MAX or 2 none if success cometqLineTxAnalogCfg 0 \ { 1 CMQ_TX_LBO_USER_DEFINED 0xC \ {{0 0x1f 0x16 0x6 0x1} \ {0 0x20 0x15 0x5 0x2} \ {0 0x20 0x15 0x5 0x3} \ {0 0x20 0x15 0x5 0x4} \ {0 0x20 0x15 0x5 0x5} \ {0 0x20 0x15 0x5 0x6} \ {0 0x20 0x15 0x5 0x7} \ {0 0x20 0x15 0x5 0x8} \ {0 0x20 0x15 0x5 0x9} \ {0 0x20 0x15 0x5 0xa} \ {0 0x20 0x15 0x5 0xb} \ {0 0x20 0x15 0x5 0xc} \ {0 0x1f 0x16 0x6 0xd} \ {0 0x20 0x15 0x5 0xe} \ {0 0x20 0x15 0x5 0xf} \ {0 0x20 0x15 0x5 0x10} \ {0 0x20 0x15 0x5 0x11} \ {0 0x20 0x15 0x5 0x12} \ {0 0x20 0x15 0x5 0x13} \ {0 0x20 0x15 0x5 0x14} \ {0 0x20 0x15 0x5 0x15} \ {0 0x20 0x15 0x5 0x16} \
PROPRIETARY AND CONFIDENTIAL TO PMC-SIERRA, INC., AND FOR ITS CUSTOMERS' INTERNAL USE
26
RELEASED EVALUATOR BOARD PMC-2001854 ISSUE 2
PM4354 COMET-QUAD
COMET-QUAD EVALUATOR BOARD SOFTWARE
Example 2
{0 0x20 0x15 0x5 0x17} \ {0 0x20 0x15 0x5 0x18}} \ 1 1 1} cometqLineTxAnalogCfg 0 { 1 0 0xC 1 1 1 }
5.3.4 cometqLineRxAnalogCfg < sCMQ_CFG_RX_ANALOG >
Description Map to API Input field(s) Configure analog receive line INT4 cometqLineRxAnalogCfg(sCMQ_HNDL deviceHandle, UINT2 chan, sCMQ_CFG_RX_ANALOG *prxAnalogCfg); any number from 0 to 3 < sCMQ_CFG_RX_ANALOG > = { < aLosThreshold > < eqFreq> < eqFdBckPer> { } } < aLosThreshold >: CMQ_RX_ALOS_9DB_THRESH or 0, CMQ_RX_ALOS_14_5DB_THRESH or 1, CMQ_RX_ALOS_20DB_THRESH or 2, CMQ_RX_ALOS_22DB_THRESH or 3, CMQ_RX_ALOS_25DB_THRESH or 4, CMQ_RX_ALOS_30DB_THRESH or 5, CMQ_RX_ALOS_31DB_THRESH or 6, CMQ_RX_ALOS_35DB_THRESH or 7 : CMQ_RX_EQ_FREQ_T1_24_125KHZ or 0, CMQ_RX_EQ_FREQ_T1_12_063KHZ or 1, CMQ_RX_EQ_FREQ_T1_8_0417KHZ or 2, CMQ_RX_EQ_FREQ_T1_6_0313KHZ or 3, CMQ_RX_EQ_FREQ_T1_4_8250KHZ or 4, CMQ_RX_EQ_FREQ_T1_4_0208KHZ or 5, CMQ_RX_EQ_FREQ_T1_3_4464KHZ or 6, CMQ_RX_EQ_FREQ_T1_3_0156KHZ or 7, CMQ_RX_EQ_FREQ_E1_32_000KHZ or 8, CMQ_RX_EQ_FREQ_E1_16_000KHZ or 9, CMQ_RX_EQ_FREQ_E1_10_667KHZ or 10, CMQ_RX_EQ_FREQ_E1_8_000KHZ or 11, CMQ_RX_EQ_FREQ_E1_6_40KHZ or 12, CMQ_RX_EQ_FREQ_E1_5_333KHZ or 13, CMQ_RX_EQ_FREQ_E1_4_5714KHZ or 14, CMQ_RX_EQ_FREQ_E1_4_0KHZ or 15 : CMQ_RX_EQ_VALID_PERIOD_32 or 0, CMQ_RX_EQ_VALID_PERIOD_64 or 1,
PROPRIETARY AND CONFIDENTIAL TO PMC-SIERRA, INC., AND FOR ITS CUSTOMERS' INTERNAL USE
27
RELEASED EVALUATOR BOARD PMC-2001854 ISSUE 2
PM4354 COMET-QUAD
COMET-QUAD EVALUATOR BOARD SOFTWARE
CMQ_RX_EQ_VALID_PERIOD_128 or 2, CMQ_RX_EQ_VALID_PERIOD_256 or 3 : CMQ_RX_LINE_EQ_RAM_T1 or 0, CMQ_RX_LINE_EQ_RAM_E1 or 1, CMQ_RX_LINE_EQ_USER_DEFINED or 2, CMQ_RX_LINE_EQ_RETAIN_CURRENT or 3 : a [256] array Note: This array entry is only needed when ramType = CMQ_RX_LINE_EQ_USER_DEFINED. : 0 or 1 Output Example 1 none if success cometqLineRxAnalogCfg 0 \ {1 3 3 0 0\ CMQ_RX_LINE_EQ_USER_DEFINED \ { 0x0 0x0 0x0 0x0 0x0 0x0 0x0 0x0 0x0 0x0\ 0x0 0x0 0x0 0x0 0x0 0x0 0x0 0x0 0x0 0x0\ ... ... . . . (256 entries) }\ 1} cometqLineRxAnalogCfg 0 {1330001}
Example 2
5.3.5 cometqLineTxJatCfg < sCMQ_CFG_TX_JAT >
Description Map to API Input field(s) Configure transmit line jitter attenuation INT4 cometqLineTxJatCfg(sCMQ_HNDL deviceHandle, UINT2 chan, sCMQ_CFG_TX_JAT *ptxJatCfg); any number from 0 to 3 < sCMQ_CFG_TX_JAT > = { < enable > < refDiv > < outputDiv > < preventOvfUndf > < outputClock > } < enable >: 0 or 1 < refDiv >: a ratio (refer to data sheet) < outputDiv >: a ratio (refer to data sheet) < FIFOselfCenter >: 0 or 1 < preventOvfUndf >: 0 or 1 < outputClock >: CMQ_TJAT_OUTPUT_CLK_INTERN_JAT or 0, CMQ_TJAT_OUTPUT_CLK_CTCLK or 1, CMQ_TJAT_OUTPUT_CLK_FIFO_INPUT or 2 < pllRefClock >: CMQ_TJAT_PLL_REF_CLK_FIFO_INPUT or 0,
PROPRIETARY AND CONFIDENTIAL TO PMC-SIERRA, INC., AND FOR ITS CUSTOMERS' INTERNAL USE
28
RELEASED EVALUATOR BOARD PMC-2001854 ISSUE 2
PM4354 COMET-QUAD
COMET-QUAD EVALUATOR BOARD SOFTWARE
CMQ_TJAT_PLL_REF_CLK_BACKPLANE or 1, CMQ_TJAT_PLL_REF_CLK_RECOVERED or 2, CMQ_TJAT_PLL_REF_CLK_CTCLK or 3 Output Example none if success cometqLineTxJatCfg 0 { 1 1 1 1 1 0 0 }
5.3.6 cometqLineRxJatCfg < sCMQ_CFG_RX_JAT >
Description Map to API Input field(s) Configure receive line jitter attenuation INT4 cometqLineRxJatCfg(sCMQ_HNDL deviceHandle, UINT2 chan, sCMQ_CFG_RX_JAT *prxJatCfg); any number from 0 to 3 < sCMQ_CFG_RX_JAT > = { < enable > < refDiv > < outputDiv > < FIFOselfCenter > < preventOvfUndf > } < enable >: 0 or 1 < refDiv >: a ratio (refer to data sheet) < outputDiv >: a ratio (refer to data sheet) < FIFOselfCenter >: 0 or 1 < preventOvfUndf >: 0 or 1 none if success cometqLineRxJatCfg 0 { 1 1 1 0 0 }
Output Example
5.3.7 cometqLineClkSvcCfg < eCMQ_CSU_SVC_CLK >
Description Map to API Input field(s) Output Example 1 Example 2 Configure clock service unit INT4 cometqLineClkSvcCfg(sCMQ_HNDL deviceHandle, eCMQ_CSU_SVC_CLK synthTxFreq); < eCMQ_CSU_SVC_CLK > = CMQ_XCLK_2048_TXCLK_2048 or 0, CMQ_XCLK_1544_TXCLK_1544 or 1, CMQ_XCLK_2048_TXCLK_1544 or 2 none if success cometqLineClkSvcCfg {CMQ_XCLK_2048_TXCLK_2048} cometqLineClkSvcCfg 1
5.3.8 cometqLineRxClkCfg < sCMQ_CFG_RX_CLK >
Description Configure receive line clock
PROPRIETARY AND CONFIDENTIAL TO PMC-SIERRA, INC., AND FOR ITS CUSTOMERS' INTERNAL USE
29
RELEASED EVALUATOR BOARD PMC-2001854 ISSUE 2
PM4354 COMET-QUAD
COMET-QUAD EVALUATOR BOARD SOFTWARE
Map to API Input field(s)
INT4 cometqLineRxClkCfg(sCMQ_HNDL deviceHandle, UINT2 chan, sCMQ_CFG_RX_CLK *prxClkCfg); any number from 0 to 3 < sCMQ_CFG_RX_CLK > = { < recoverClkSel > < LOSThresh >} : CMQ_RECOVER_CLK_LOW_FREQ_JAT or 0, CMQ_RECOVER_CLK_HIGH_FREQ_JAT or 1 : CMQ_LOS_THRESH_PCM_10_HDB3 or 0, CMQ_LOS_THRESH_PCM_15_B8ZS or 1, CMQ_LOS_THRESH_PCM_15_AMI or 2, CMQ_LOS_THRESH_PCM_31 or 3, CMQ_LOS_THRESH_PCM_63 or 4, CMQ_LOS_THRESH_PCM_175 or 5 none if success cometqLineRxClkCfg 0 { 1 3 }
Output Example
5.4
System Side Interface
5.4.1 cometqBTIFAccessCfg < sCMQ_BACKPLANE_ACCESS_CFG >
Description Map to API Input field(s) Configure backplane transmit interface INT4 cometqBTIFAccessCfg(sCMQ_HNDL deviceHandle, UINT2 chan, sCMQ_BACKPLANE_ACCESS_CFG* pBTIFCfgData); any number from 0 to 3 < sCMQ_BACKPLANE_ACCESS_CFG > = { < masterMode > < dataMode > < clkTimes2 > < dataRate >} < masterMode >: 0 or 1 < dataMode >: CMQ_BACKPLANE_FULL_FRAME_MODE or 0, CMQ_BACKPLANE_NX56K_MODE or 1, CMQ_BACKPLANE_NX64K_MODE or 2, CMQ_BACKPLANE_NX64K_E1_MODE or 3 < clkTimes2 >: 0 or 1 < dataRate >: CMQ_BACKPLANE_CLK_RATE_1544 or 0, CMQ_BACKPLANE_CLK_RATE_2048 or 1, CMQ_BACKPLANE_CLK_RATE_8192 or 2 none if success cometqBTIFAccessCfg 1 { 1 0 1 0 }
Output Example
PROPRIETARY AND CONFIDENTIAL TO PMC-SIERRA, INC., AND FOR ITS CUSTOMERS' INTERNAL USE
30
RELEASED EVALUATOR BOARD PMC-2001854 ISSUE 2
PM4354 COMET-QUAD
COMET-QUAD EVALUATOR BOARD SOFTWARE
5.4.2 cometqBTIFFrmCfg < sCMQ_CFG_BTIF_FRM >
Description Map to API Input field(s) Configure backplane transmit interface INT4 cometqBTIFFrmCfg(sCMQ_HNDL deviceHandle, UINT2 chan, sCMQ_CFG_BTIF_FRM *pfrmCfg); any number from 0 to 3 < sCMQ_CFG_BTIF_FRM > = {< fpMaster > < fpInvEn > < oddPar > < extParEn > < fpFrmOffset > < T1ESFAlign > < fpBitOffsetEn > < fpBitOffset > < tslotMapFormat > } < fpMaster >: 0 or 1 < fpInvEn >: 0 or 1 < oddPar >: 0 or 1 < extParEn > 0 or 1 < fpFrmOffset > Offset in bytes < T1ESFAlign > 0 or 1 (T1 Mode Only) < fpBitOffsetEn > 0 or 1 < fpBitOffset > Offset in bits < tslotMapFormat > CMQ_BACKPLANE_TIMESLOT_MAP_3_OF_4 or 0, CMQ_BACKPLANE_TIMESLOT_MAP_24_OF_32 or 1 none if success cometqBTIFFrmCfg 1 {0 1 0 1 1 1 1 1 0}
Output Example
5.4.3 cometqBRIFAccessCfg < sCMQ_BACKPLANE_ACCESS_CFG >
Description Map to API Input field(s) Configure backplane transmit interface INT4 cometqBRIFAccessCfg(sCMQ_HNDL deviceHandle, UINT2 chan, sCMQ_BACKPLANE_ACCESS_CFG* pBRIFCfgData); any number from 0 to 3 < sCMQ_BACKPLANE_ACCESS_CFG > = { < masterMode > < dataMode > < clkTimes2 > < dataRate >} < masterMode >: 0 or 1 < dataMode >: CMQ_BACKPLANE_FULL_FRAME_MODE or 0, CMQ_BACKPLANE_NX56K_MODE or 1, CMQ_BACKPLANE_NX64K_MODE or 2, CMQ_BACKPLANE_NX64K_E1_MODE or 3 < clkTimes2 >: 0 or 1 < dataRate >: CMQ_BACKPLANE_CLK_RATE_1544 or 0, CMQ_BACKPLANE_CLK_RATE_2048 or 1, CMQ_BACKPLANE_CLK_RATE_8192 or 2 none if success cometqBRIFAccessCfg 1 { 0 1 1 0 }
Output Example
PROPRIETARY AND CONFIDENTIAL TO PMC-SIERRA, INC., AND FOR ITS CUSTOMERS' INTERNAL USE
31
RELEASED EVALUATOR BOARD PMC-2001854 ISSUE 2
PM4354 COMET-QUAD
COMET-QUAD EVALUATOR BOARD SOFTWARE
5.4.4 cometqBRIFFrmCfg < sCMQ_CFG_BRIF_FRM >
Description Map to API Input field(s) Configure backplane receive interface INT4 cometqBRIFFrmCfg(sCMQ_HNDL deviceHandle, UINT2 chan, sCMQ_CFG_BRIF_FRM *pfrmCfg); any number from 0 to 3 < sCMQ_CFG_BRIF_FRM > = {< fpMaster > < fpmMode > < fpInvEn > < parInsEn > < oddPar > < extParEn > < fBitFix > < fBitPol > < fpFrmOffset > < fpBitOffsetEn > < fpBitOffset > < altFDLEn > < tslotMapFormat >} < fpMaster >: 0 or 1 < fpmMode >: CMQ_BACKPLANE_RX_FP_T1_HIGH_ON_SF_ESF or 0, CMQ_BACKPLANE_RX_FP_T1E1_HIGH_EVERY_FRAME or 1, CMQ_BACKPLANE_RX_FP_E1_HIGH_ON_CRC_MFRM or 2, CMQ_BACKPLANE_RX_FP_E1_HIGH_ON_SIG_MFRM or 3, CMQ_BACKPLANE_RX_FP_E1_COMP_MFRM or 4, CMQ_BACKPLANE_RX_FP_E1_HIGH_ON_OVERHEAD or 5 < fpInvEn >: 0 or 1 < parInsEn >: 0 or 1 < oddPar >: 0 or 1 < extParEn > : 0 or 1 < fBitFix >: 0 or 1 < fBitPol >: 0 or 1 < fpFrmOffset > Offset in bytes < fpBitOffsetEn >: 0 or 1 < fpBitOffset > Offset in bits < altFDLEn >: 0 or 1 < tslotMapFormat > CMQ_BACKPLANE_TIMESLOT_MAP_3_OF_4 or 0, CMQ_BACKPLANE_TIMESLOT_MAP_24_OF_32 or 1 none if success cometqBRIFFrmCfg 1 {0 1 0 1 0 1 0 1 0 1 0 1 0}
Output Example
5.4.5 cometqHMVIPCfg < rxHMVIPMode > < txHMVIPMode >
Description Map to API Configure the H-MVIP receive and transmit interface INT4 cometqHMVIPCfg (sCMQ_HNDL deviceHandle, sCMQ_CFG_HMVIP *pHMVIPCfg)
PROPRIETARY AND CONFIDENTIAL TO PMC-SIERRA, INC., AND FOR ITS CUSTOMERS' INTERNAL USE
32
RELEASED EVALUATOR BOARD PMC-2001854 ISSUE 2
PM4354 COMET-QUAD
COMET-QUAD EVALUATOR BOARD SOFTWARE
Input field(s)
Output Example
CMQ_BACKPLANE_HMVIP_MODE or 0, CMQ_BACKPLANE_HMVIP_CCS or 1 CMQ_BACKPLANE_HMVIP_DISABLE or 2 < txHMVIPMode >: CMQ_BACKPLANE_HMVIP_MODE or 0, CMQ_BACKPLANE_HMVIP_CCS or 1, CMQ_BACKPLANE_HMVIP_DISABLE or 2 : ( insert at ) { timeslot 15 timeslot 16 timeslot 31 } none if success cometqHMVIPCfg 1 1 {1 0 0} {0 0 0} {1 1 1} {1 0 1}
< rxHMVIPMode >:
5.4.6 cometqTxElstStCfg < elstEnable >
Description Map to API Input field(s) Output Example Configure the elastic store in receive data path INT4 cometqTxElstStCfg(sCMQ_HNDL deviceHandle, UINT2 chan, UINT1 elstEnable); any number from 0 to 3 < elstEnable > 0 or 1 none if success cometqTxElstStCfg 0 1
5.4.7 cometqRxElstStCfg < sCMQ_CFG_RX_ELST >
Description Map to API Input field(s) Configure the elastic store in receive data path INT4 cometqRxElstStCfg(sCMQ_HNDL deviceHandle, UINT2 chan, sCMQ_CFG_RX_ELST* pElstCfg); any number from 0 to 3 < sCMQ_CFG_RX_ELST > = { < elstEnable > < idleCode > < CCSidleCode > } < elstEnable >: 0 or 1 < idleCode >: idle code < CCSidleCode >: ccs idle code none if success cometqRxElstStCfg 0 { 1 1 1 }
Output Example
PROPRIETARY AND CONFIDENTIAL TO PMC-SIERRA, INC., AND FOR ITS CUSTOMERS' INTERNAL USE
33
RELEASED EVALUATOR BOARD PMC-2001854 ISSUE 2
PM4354 COMET-QUAD
COMET-QUAD EVALUATOR BOARD SOFTWARE
5.5
T1 /E1 Framers
5.5.1 cometqSetOperatingMode
Description Map to API Input field(s) Output Example This function specifies whether the device will operate in T1 or E1 mode. INT4 cometqSetOperatingMode(sCMQ_HNDL deviceHandle, eCMQ_OPER_MODE operMode); : CMQ_MODE_E1 or 0, CMQ_MODE_T1 or 1 none if success cometqSetOperatingMode CMQ_MODE_E1
5.5.2 cometqT1TxFramerCfg < sCMQ_CFG_T1TX_FRM >
Description Map to API Input field(s) T1 transmit framer configuration INT4 cometqT1TxFramerCfg (sCMQ_HNDL deviceHandle, UINT2 chan, sCMQ_CFG_T1TX_FRM *pfrmCfg) any number from 0 to 3 < sCMQ_CFG_T1TX_FRM > = {< frmMode > < zSupFormat > < SFSigAlignerEn >} < frmMode >: CMQ_FRM_MODE_E1 or 0, CMQ_FRM_MODE_T1_SF or 3, CMQ_FRM_MODE_T1_DM or 4, CMQ_FRM_MODE_T1_SLC96 or 5, CMQ_FRM_MODE_T1_DM_FDL or 6, CMQ_FRM_MODE_T1_ESF or 7, CMQ_FRM_MODE_T1_SF_JPN_ALARM or 8, CMQ_FRM_MODE_T1_DM_JPN_ALARM or 9, CMQ_FRM_MODE_T1_SLC96_JPN_ALARM or 10, CMQ_FRM_MODE_T1_DM_FDL_JPN_ALARM or 11, CMQ_FRM_MODE_T1_JT_G704 or 12, CMQ_FRM_MODE_T1_UNFRAMED or 13 < zSupFormat >: CMQ_T1_ZSUP_NONE or 0, CMQ_T1_ZSUP_GTE or 1, CMQ_T1_ZSUP_DDS or 2, CMQ_T1_ZSUP_BELL or 3 < SFSigAlignerEn >: 0 or 1 none if success cometqT1TxFramerCfg 2{120}
Output Example
PROPRIETARY AND CONFIDENTIAL TO PMC-SIERRA, INC., AND FOR ITS CUSTOMERS' INTERNAL USE
34
RELEASED EVALUATOR BOARD PMC-2001854 ISSUE 2
PM4354 COMET-QUAD
COMET-QUAD EVALUATOR BOARD SOFTWARE
5.5.3 cometqT1RxFramerCfg < sCMQ_CFG_T1RX_FRM >
Description Map to API Input field(s) T1 receive framer configuration INT4 cometqT1RxFramerCfg (sCMQ_HNDL deviceHandle, UINT2 chan, sCMQ_CFG_T1RX_FRM *pfrmCfg) any number from 0 to 3 < sCMQ_CFG_T1RX_FRM > = {< frmMode > < outOfFrameCriteria> < frmESFAlgo> < COFACntEn >} < frmMode >: CMQ_FRM_MODE_T1_SF or 3, CMQ_FRM_MODE_T1_DM or 4, CMQ_FRM_MODE_T1_SLC96 or 5, CMQ_FRM_MODE_T1_DM_FDL or 6, CMQ_FRM_MODE_T1_ESF or 7, CMQ_FRM_MODE_T1_SF_JPN_ALARM or 8, CMQ_FRM_MODE_T1_DM_JPN_ALARM or 9, CMQ_FRM_MODE_T1_SLC96_JPN_ALARM or 10, CMQ_FRM_MODE_T1_DM_FDL_JPN_ALARM or 11, CMQ_FRM_MODE_T1_JT_G704 or 12, CMQ_FRM_MODE_T1_UNFRAMED or 13 < outOfFrameCriteria >: CMQ_T1_OOF_2OF4 or 0, CMQ_T1_OOF_2OF5 or 1, CMQ_T1_OOF_2OF6 or 2 < frmESFAlgo >: CMQ_T1_ESF_FRAME_ALGO_ONE_CANDIDATE or 0, CMQ_T1_ESF_FRAME_ALGO_CRC_6 or 1 < COFACntEn >: 0 or 1; none if success cometqT1RxFramerCfg 1{3111}
Output Example
5.5.4 cometqE1TxFramerCfg < sCMQ_CFG_E1TX_FRM >
Description Map to API Input field(s) E1 transmit framer configuration INT4 cometqE1TxFramerCfg (sCMQ_HNDL deviceHandle, UINT2 chan, sCMQ_CFG_E1TX_FRM *pfrmCfg) any number from 0 to 3 < sCMQ_CFG_E1TX_FRM > = {< frmMode > < ts16Signaling > < insNatIntBitEn > < insXtraBitsEn > < insFEBEEn >} < frmMode >: CMQ_FRM_MODE_E1 or 0, CMQ_FRM_MODE_E1_CRC_MFRM or 1,
PROPRIETARY AND CONFIDENTIAL TO PMC-SIERRA, INC., AND FOR ITS CUSTOMERS' INTERNAL USE
35
RELEASED EVALUATOR BOARD PMC-2001854 ISSUE 2
PM4354 COMET-QUAD
COMET-QUAD EVALUATOR BOARD SOFTWARE
< < < < Output Example
CMQ_FRM_MODE_E1_UNFRAMED or 2, ts16Signaling >: CMQ_E1_SIG_INS_NONE or 0, CMQ_E1_SIG_INS_HDLC_CCS or 1, CMQ_E1_SIG_INS_CAS or 2 insNatIntBitEn >: 0 or 1 insXtraBitsEn >: 0 or 1 insFEBEEn >: 0 or 1
none if success cometqE1TxFramerCfg 1{00111}
5.5.5 cometqE1RxFramerCfg < sCMQ_CFG_T1RX_FRM >
Description Map to API Input field(s) E1 receive framer configuration INT4 cometqE1RxFramerCfg (sCMQ_HNDL deviceHandle, UINT2 chan, sCMQ_CFG_E1RX_FRM *pfrmCfg) any number from 0 to 3 < sCMQ_CFG_E1RX_FRM > = {< frmMode > < CASAlignmentEn > < CRC2NCRCEn > < noReframeOnErrEn > < reframeOnXSCrcErrEn > < lofBit2CritEn > < NFASErrEn > < multFASEOneFEEn > < mfrmLossAlignCrit > < AISCriteria > < RAICriteria >} < frmMode >: CMQ_FRM_MODE_E1 or 0, CMQ_FRM_MODE_E1_CRC_MFRM or 1, CMQ_FRM_MODE_E1_UNFRAMED or 2, < CASAlignmentEn >: 0 or 1 < CRC2NCRCEn >: 0 or 1 < noReframeOnErrEn >: 0 or 1 < reframeOnXSCrcErrEn >: 0 or 1 < lofBit2CritEn >:0 or 1 < NFASErrEn >:0 or 1 < multFASEOneFEEn >:0 or 1 < mfrmLossAlignCrit >: CMQ_E1_LOSS_MFRM_ALIGN_TS16_CRIT_NONE or 0, CMQ_E1_LOSS_MFRM_ALIGN_TS16_CRIT_ZERO_1_MFRM or 1, CMQ_E1_LOSS_MFRM_ALIGN_TS16_CRIT_ZERO_2_MFRM or 2 < AISCriteria >: CMQ_E1_AIS_CRIT_3Z_IN_512BITS or 0, CMQ_E1_AIS_CRIT_2_PERIODS_3Z_IN_512BITS or 1 < RAICriteria >: CMQ_E1_RAI_CRIT_ALL_A_1 or 0, CMQ_E1_RAI_CRIT_4_CONSEC_A_1 or 1 none if success
Output
PROPRIETARY AND CONFIDENTIAL TO PMC-SIERRA, INC., AND FOR ITS CUSTOMERS' INTERNAL USE
36
RELEASED EVALUATOR BOARD PMC-2001854 ISSUE 2
PM4354 COMET-QUAD
COMET-QUAD EVALUATOR BOARD SOFTWARE
Example
cometqE1RxFramerCfg
1 {1 0 1 0 1 0 1 0 1 0 1}
5.5.6 cometqE1TxSetExtraBits < extraBits >
Description Map to API Input field(s) Allows user to set extra bit values that will be inserted into bits 5, 7 and 8 of timeslot 16 if enabled in the E1 transmit framer configuration. INT4 cometqE1TxSetExtraBits(sCMQ_HNDL deviceHandle, UINT2 chan, UINT1 extraBits); any number from 0 to 3 < extraBits > bitmap ( bit 0: X1 - timeslot 16, bit 5 )
( bit 1: X3 - timeslot 16, bit 7 ) ( bit 2: X4 - timeslot 16, bit 8 ) ( bit 3-7: unused )
Output Example
none if success cometqE1TxSetExtraBits 1 0x03
5.5.7 cometqE1TxSetIntBits < intBits >
Description Map to API Input field(s) Set value of the international bits to insert into the E1 stream. Must be enabled first in the configuration. INT4 cometqE1TxSetIntBits(sCMQ_HNDL deviceHandle, UINT2 chan, UINT1 intBits); any number from 0 to 3 < intBits > bitmap containing international bits
bit 0: Si[0]: inserted into NFAS frames bit 1: Si[1]: inserted into FAS frames bit 2-7: unused
Output Example
none if success cometqE1TxSetIntBits 1 0xFF
5.5.8 cometqE1TxSetNatBits < codeSelect >
Description Map to API Input field(s) Set National bits. Must be enabled first in the framer configuration. INT4 cometqE1TxSetNatBits(sCMQ_HNDL deviceHandle, UINT2 chan, eCMQ_E1_NAT_BIT codeSelect, UINT1 natBits, UINT1 natBitsEn) any number from 0 to 3 : CMQ_E1_NAT_BIT_SA4 or 0, CMQ_E1_NAT_BIT_SA5 or 1, CMQ_E1_NAT_BIT_SA6 or 2, CMQ_E1_NAT_BIT_SA7 or 3,
PROPRIETARY AND CONFIDENTIAL TO PMC-SIERRA, INC., AND FOR ITS CUSTOMERS' INTERNAL USE
37
RELEASED EVALUATOR BOARD PMC-2001854 ISSUE 2
PM4354 COMET-QUAD
COMET-QUAD EVALUATOR BOARD SOFTWARE
Output Example
CMQ_E1_NAT_BIT_SA8 or 4 : bitmap containing national bit values (over one sub-multiframe) bit 0 : first Sai position in SMF bit 1 : second Sai position in SMF bit 2 : third Sai position in SMF bit 3 : fourth Sai position in SMF bits 4-7 : unused : enables/disables each bit position in natBits: bit 0 : enable first Sai bit bit 1 : enable second Sai bit bit 2 : enable third Sai bit bit 3 : enable fourth Sai bit bits 4-7 : unused none if success cometqE1TxSetNatBits 3 2 0xff 0xff
5.5.9 cometqE1RxGetExtraBits
Description Map to API Input field(s) Output Get extra bits and the y bit from ts16 frame 0 of the last received signaling multiframe INT4 cometqE1RxGetExtraBits(sCMQ_HNDL deviceHandle, UINT2 chan, UINT1* pExtraBits); any number from 0 to 3 pExtraBits : bitmap containing extra bits & y bit bit 0 : X1 (from timeslot 16, bit 5) bit 1 : Y bit (from timeslot 16, bit 6) bit 2 : X3 (from timeslot 16, bit 7) bit 3 : X4 (from timeslot 16, bit 8) bits 4-7 : unused cometqE1RxGetExtraBits 2
Example
5.5.10 cometqE1RxGetIntBits
Description This function returns the international bits from the incoming E1 stream for the last frame. Si[0] is updated every NFAS frame while Si[1] is updated every FAS frame. INT4 cometqE1RxGetIntBits(sCMQ_HNDL deviceHandle, UINT2 chan, UINT1* pIntBits); any number from 0 to 3 pIntBits : bitmap containing international bits
bit 0 : Si[0]: inserted into NFAS frames
Map to API Input field(s) Output
PROPRIETARY AND CONFIDENTIAL TO PMC-SIERRA, INC., AND FOR ITS CUSTOMERS' INTERNAL USE
38
RELEASED EVALUATOR BOARD PMC-2001854 ISSUE 2
PM4354 COMET-QUAD
COMET-QUAD EVALUATOR BOARD SOFTWARE
bit 1 : Si[1]: inserted into FAS frames bit 2-7: unused
Example
cometqE1RxGetIntBits 2
5.5.11 cometqE1RxGetNatBitsNFAS
Description This function returns the value of the national bits from the incoming E1 stream from the last NFAS frame. This API allows the user to process the national bits on a frame by frame basis, without waiting for the complete submultiframe. INT4 cometqE1RxGetNatBitsNFAS(sCMQ_HNDL deviceHandle, UINT2 chan, UINT1* pNatBits); any number from 0 to 3 pNatBits : bitmap containing national bit values bit 0 : Sa 4 bit 1 : Sa 5 bit 2 : Sa 6 bit 3 : Sa 7 bit 4 : Sa 8 bits 5-7 : unused cometqE1RxGetNatBitsNFAS 2
Map to API Input field(s) Output
Example
5.5.12 cometqE1RxGetNatBitsSMFRM
Description Map to API Input field(s) This function returns a complete national bit codeword for a specified national bit in the incoming E1 stream for the last submultiframe. INT4 cometqE1RxGetNatBitsSMFRM(sCMQ_HNDL deviceHandle, UINT2 chan, eCMQ_E1_NAT_BIT codeSelect, UINT1* pNatBits); any number from 0 to 3 : CMQ_E1_NAT_BIT_SA4 or 0, CMQ_E1_NAT_BIT_SA5 or 1, CMQ_E1_NAT_BIT_SA6 or 2, CMQ_E1_NAT_BIT_SA7 or 3, CMQ_E1_NAT_BIT_SA8 or 4 pNatBits : bitmap containing national bit values (over one sub-multiframe)
bit 0 : first Sai position in SMF bit 1 : second Sai position in SMF bit 2 : third Sai position in SMF
Output
PROPRIETARY AND CONFIDENTIAL TO PMC-SIERRA, INC., AND FOR ITS CUSTOMERS' INTERNAL USE
39
RELEASED EVALUATOR BOARD PMC-2001854 ISSUE 2
PM4354 COMET-QUAD
COMET-QUAD EVALUATOR BOARD SOFTWARE
bit 3 : fourth Sai position in SMF
Example
bits 4-7 : unused cometqE1RxGetNatBitsSMFRM 1 1
5.6
Signal Insertion / Extraction
5.6.1 cometqSigExtractCOSS
Description This function provides a bitmap corresponding to change of signaling state (COSS) information for a T1 or E1 stream. After determining on which E1 timeslot or T1 channel the signaling state has changed through the use of this function, the user should call cometqSigExtract for the new signaling state. INT4 cometqExtractCOSS(sCMQ_HNDL deviceHandle, UINT2 chan, UINT4 *psigState) any number from 0 to 3 pSigState: Signal state bit map. E1: Bit 0 corresponds to timeslot 1 and bit 30 corresponds to timeslot 31. Timeslot 0 and 16 do not have COSS info. Bit 15 (timeslot 16) is always set to 0. Bit 31 is unused and set to zero. T1: Bits 0 to 23 correspond to timeslots 1 to 24 respectively. Bits 24 to 31 are not used and set to 0. cometqSigExtractCOSS 0
Map to API Input field(s) Output
Example
5.6.2 cometqSigExtract
Description Map to API Input field(s) Output Signaling state INT4 cometqSigExtract(sCMQ_HNDL deviceHandle, UINT2 chan, UINT1 timeslot, UINT1 *pSigState) any number from 0 to 3 timeslot for which to retrieve signaling pSigState : contains the signaling state information for the timeslot. bit 0: D bit bit 1: C bit
PROPRIETARY AND CONFIDENTIAL TO PMC-SIERRA, INC., AND FOR ITS CUSTOMERS' INTERNAL USE
40
RELEASED EVALUATOR BOARD PMC-2001854 ISSUE 2
PM4354 COMET-QUAD
COMET-QUAD EVALUATOR BOARD SOFTWARE
Example
bit 2: B bit bit 3: A bit bits 4-7: unused cometqSigExtract 1 12
5.6.3 cometqSigTslotTrnkDataCfg []
Description This API allows the user to enable change of signal state debouncing by only allowing a COSS event to be generated when the new signaling data is received twice consecutively. Also, DS0 manipulation of the PCM data stream can be performed here. DS0 PCM data manipulation performed by the signal extraction block occurs before PCM data manipulation performed by the RPSC block (via cometqRPSCPCMCtrl). INT4 cometqSigTslotTrnkDataCfg(sCMQ_HNDL deviceHandle, UINT2 chan, UINT2 readWrite, UINT1 timeslot, UINT1 *pSigConfig); any number from 0 to 3 0 for read, 1 for write timeslot to operate on config data pSigConfig : pointer to config data bit map for T1 mode: bit bit bit bit bit 0: enable COSS debouncing 1: logic level when bit fixing enabled 2: enable bit fixing 3: invert all PCM data bits 4-7: unused
Map to API Input field(s)
Output
bit map for E1 mode: bit 0: bit 1: bit 2,3: enable COSS debouncing unused 0,0 - no inversion 0,1 - invert odd PCM bits 1,0 - invert even PCM bits 1,1 - invert all bits
bit 4-7: unused Example 1 (Read) cometqSigTslotTrnkDataCfg 1 0 13
PROPRIETARY AND CONFIDENTIAL TO PMC-SIERRA, INC., AND FOR ITS CUSTOMERS' INTERNAL USE
41
RELEASED EVALUATOR BOARD PMC-2001854 ISSUE 2
PM4354 COMET-QUAD
COMET-QUAD EVALUATOR BOARD SOFTWARE
Example 2 (Write)
cometqSigTslotTrnkDataCfg 1 1 12 0xff
5.7
Alarm Control and InBand Communications
5.7.1 cometqAutoAlarmCfg < autoYellowEn > < autoRedEn > < OOF_RPSCEn > < autoAISEn >
Description Map to API Input field(s) Enable or disable the possible automatic alarm responses INT4 cometqAutoAlarmCfg(sCMQ_HNDL deviceHandle, UINT2 chan, UINT1 autoYellowEn, UINT1 autoRedEn, UINT1 OOF_RPSCEn, UINT1 OOF_RxELSTEn, UINT1 autoAISEn); any number from 0 to 3 < autoYellowEn >: 0 or 1 < autoRedEn >: 0 or 1 < OOF_RPSCEn >: 0 or 1 < OOF_RxELSTEn >: 0 or 1 < autoAISEn >: 0 or 1 none if success cometqAutoAlarmCfg 0 1 0 1 0 1
Output Example
5.7.2 cometqInsertAlarm
Description Map to API Input field(s) Insert or disable insertion of alarm INT4 cometqInsertAlarm(sCMQ_HNDL deviceHandle, UINT2 chan, eCMQ_ALARM_INS alarmType, UINT1 enable); any number from 0 to 3 : CMQ_ALARM_INS_RX_AIS or 0, CMQ_ALARM_INS_TX_YELLOW or 1, CMQ_ALARM_INS_TX_AIS or 2, CMQ_ALARM_INS_TX_E1_Y_BIT or 3, CMQ_ALARM_INS_TX_E1_CHAN16 or 4 : 0 or 1 none if success cometqInsertAlarm 1 0 1
Output Example
PROPRIETARY AND CONFIDENTIAL TO PMC-SIERRA, INC., AND FOR ITS CUSTOMERS' INTERNAL USE
42
RELEASED EVALUATOR BOARD PMC-2001854 ISSUE 2
PM4354 COMET-QUAD
COMET-QUAD EVALUATOR BOARD SOFTWARE
5.7.3 cometqHDLCEnable
Description Map to API Input field(s) Output Example Enable HDLC inband communications INT4 cometqHDLCEnable(sCMQ_HNDL deviceHandle, UINT2 idHDLC, UINT2 enable) HDLC controller 0, 1, 2, 3, 0 or 1 none if success cometqHDLCEnable 1 1
5.7.4 cometqHDLCRxCfg < sCMQ_CFG_HDLC_RX >
Description Map to API Input field(s) HDLC configuration INT4 cometqHDLCRxCfg(sCMQ_HNDL deviceHandle, UINT2 idHDLC, sCMQ_CFG_HDLC_RX* pData); : HDLC controller 0, 1, 2, 3 < sCMQ_CFG_HDLC_RX >= { { linkLocation } < addrMatchEn >< addrMaskEn > } { linkLocation } = { < useT1DataLink >< evenFrames >< oddFrames >< timeslot >< dataLinkBitMask > } < useT1DataLink >:0 or 1 < evenFrames >:0 or 1 (ignored when using T1 Data Link) < oddFrames >:0 or 1 (ignored when using T1 Data Link) < timeslot >: timeslot < dataLinkBitMask >: bit mask < addrMatchEn >: 0 or 1 < addrMaskEn >: 0 or1 none if success cometqHDLCRxCfg 0 {{ 1 0 1 0 1} 0 1}
Output Example
5.7.5 cometqHDLCTxCfg < sCMQ_CFG_HDLC_TX >
Description Map to API Input field(s) HDLC configuration INT4 cometqHDLCTxCfg(sCMQ_HNDL deviceHandle, UINT2 idHDLC, sCMQ_CFG_HDLC_TX* pData); : HDLC controller 0, 1, 2, 3 < sCMQ_CFG_HDLC_TX > ={{ linkLocation } < flagShareEn > } { linkLocation } = { < useT1DataLink >< evenFrames >< oddFrames >< timeslot >< dataLinkBitMask > } < useT1DataLink >:0 or 1
PROPRIETARY AND CONFIDENTIAL TO PMC-SIERRA, INC., AND FOR ITS CUSTOMERS' INTERNAL USE
43
RELEASED EVALUATOR BOARD PMC-2001854 ISSUE 2
PM4354 COMET-QUAD
COMET-QUAD EVALUATOR BOARD SOFTWARE
Output Example
< evenFrames >:0 or 1 (ignored when using T1 Data Link) < oddFrames >:0 or 1 (ignored when using T1 Data Link) < timeslot >: timeslot < dataLinkBitMask >: bit mask < flagShareEn >:0 or 1 < crcFCSEn >:0 or 1 < pmRepEn >:0 or 1 none if success cometqHDLCTxCfg 1 {{1 0 1 0 1} 0 0 0 }
5.7.6 cometqTDPRData < idHDLC >
Description Map to API Input field(s) Output Example This function transmits a data byte on the specified HDLC link. NT4 cometqTDPRData(sCMQ_HNDL deviceHandle, UINT2 idHDLC, UINT1 value); < idHDLC > : HDLC controller 0, 1, 2, 3 : any number from 0 to 0xff none if success cometqTDPRData 1 0xf
5.7.7 cometqTDPRCtl < idHDLC >
Description Map to API Input field(s) With this function the user can transmit a control byte on an HDLC link or force a FIFO clear. INT4 cometqTDPRCtl(sCMQ_HNDL deviceHandle, UINT2 idHDLC, eCMQ_TDPR_ACTION hdlcAction) < idHDLC > : HDLC controller 0, 1, 2, 3 < hdlcAction >: CMQ_TDPR_ACTION_ABORT or 0, CMQ_TDPR_ACTION_END_ABORT or 1, CMQ_TDPR_ACTION_EOM or 2, CMQ_TDPR_ACTION_FIFOCLR or 3 none if success cometqTDPRCtl 1 CMQ_TDPR_ACTION_ABORT
Output Example
5.7.8 cometqTDPRFIFOThreshCfg < idHDLC >
Description Map to API Configures the upper and lower limits of the HDLC transmitter FIFO for one of the transmit HDLC Controllers. INT4 cometqTDPRFIFOThreshCfg (sCMQ_HNDL deviceHandle, UINT2 idHDLC, UINT1 upFifoThresh, UINT1 lowFifoThresh)
PROPRIETARY AND CONFIDENTIAL TO PMC-SIERRA, INC., AND FOR ITS CUSTOMERS' INTERNAL USE
44
RELEASED EVALUATOR BOARD PMC-2001854 ISSUE 2
PM4354 COMET-QUAD
COMET-QUAD EVALUATOR BOARD SOFTWARE
Input field(s)
< idHDLC > : HDLC controller 0, 1, 2, 3 FIFO Watermark for auto transmit valid values are 0 thru 127 FIFO Watermark for internal interrupt valid values are 0 thru 127 * low threshold must be less than up threshold unless both are set to 0 none if success cometqTDPRFIFOThreshCfg 1 3 2
Output Example
5.7.9 cometqRDLCTerm < idHDLC >
Description Forces the RDLC to immediately terminate the reception of the current data frame. This function causes the current data frame to terminate and the FIFO buffer to empty. INT4 cometqRDLCTerm (sCMQ_HNDL deviceHandle, UINT2 idHDLC) < idHDLC > : HDLC controller 0,1, 2, 3 none if success cometqRDLCTerm 1
Map to API Input field(s) Output Example
5.7.10 cometqRDLCAddrMatch < idHDLC > < addrPri > < addrSec >
Description This function configures the primary and secondary addresses used with address matching on an HDLC receiver. When address masking is enabled, the lower two bits of each of the primary and secondary addresses are masked during comparison. INT4 cometqRDLCAddrMatch(sCMQ_HNDL deviceHandle, UINT2 idHDLC, UINT1 addrPri, UINT1 addrSec) < idHDLC > : HDLC controller 0, 1, 2, 3 < addrPri > primary address < addrSec > secondary address none if success cometqRDLCAddrMatch 1 2 3
Map to API Input field(s) Output Example
5.7.11 cometqRDLCFIFOThreshCfg < idHDLC > < fifoThresh>
Description Configures the fill level threshold for an RDLC FIFO. The fill level threshold is the number of bytes that
PROPRIETARY AND CONFIDENTIAL TO PMC-SIERRA, INC., AND FOR ITS CUSTOMERS' INTERNAL USE
45
RELEASED EVALUATOR BOARD PMC-2001854 ISSUE 2
PM4354 COMET-QUAD
COMET-QUAD EVALUATOR BOARD SOFTWARE
Map to API Input field(s) Output Example
must be present in the FIFO before an interrupt is generated. INT4 cometqRDLCFIFOThreshCfg(sCMQ_HNDL deviceHandle, UINT2 idHDLC, UINT1 fifoThresh) < idHDLC > : HDLC controller 0, 1, 2, 3 FIFO fill level threshold (7 bit value) none if success cometqRDLCFIFOThreshCfg 1 2
5.7.12 cometqIBCDActLpBkCfg < chan > < patLen >
Description Map to API Input field(s) Output Example Configures the detection of inband activate loopback code length and pattern. INT4 cometqIBCDActLpBkCfg(sCMQ_HNDL deviceHandle, UINT2 chan, UINT2 patLen, UINT2 pat) < chan > : channel from 0 to 3 5,6,7,8 : loop code pattern none if success cometqIBCDActLpBkCfg 1 5 1
5.7.13 cometqIBCDDeActLpBkCfg < chan > < patLen >
Description Map to API Input field(s) Output Example Configures the detection of inband de-activate loopback code length and pattern. INT4 cometqIBCDDeActLpBkCfg(sCMQ_HNDL deviceHandle, UINT2 chan, UINT1 patLen, UINT2 pat) < chan > : channel from 0 to 3 5,6,7,8 : loop code pattern none if success cometqIBCDDeActLpBkCfg 1 6 1
5.7.14 cometqIBCDTxCfg < chan > < patLen >
Description Enables/disables transmission of the inband transmit loopback code and allows configuration of the code length and pattern when activating. When disabling transmission of the loopback code, the parameters pat and patLen are not used. INT4 cometqIBCDTxCfg (sCMQ_HNDL deviceHandle, UINT2 chan, UINT2 patLen, UINT1 pat, UINT2 enable)
Map to API
PROPRIETARY AND CONFIDENTIAL TO PMC-SIERRA, INC., AND FOR ITS CUSTOMERS' INTERNAL USE
46
RELEASED EVALUATOR BOARD PMC-2001854 ISSUE 2
PM4354 COMET-QUAD
COMET-QUAD EVALUATOR BOARD SOFTWARE
Input field(s)
Output Example
< chan > : channel from 0 to 3 5,6,7,8 : loop code pattern 0 or 1 none if success cometqIBCDTxCfg 1 7 1 0
5.7.15 cometqBOCTxCfg < chan > < boc >
Description Configures the bit oriented code for transmission. On COMET-Quad devices, the associated repeat count can also be configured. The value of parameter boc is transmitted with the least significant bit leading. To terminate BOC transmission, boc should be set to all 1's. Valid only in T1 mode. INT4 cometqBOCTxCfg(sCMQ_HNDL deviceHandle, UINT2 chan, UINT1 boc, UINT1 repCount) < chan > : channel from 0 to 3 < boc > 6 bit BOC code pattern. Setting this value to all 1's disables BOC transmission number of consecutive BOC codes to transmit. Valid numbers from 0 to 15 none if success cometqBOCTxCfg 1 2 3
Map to API Input field(s)
Output Example
5.7.16 cometqBOCRxCfg < chan >
Description Configures bit oriented code detection criteria by allowing the user to select the threshold that determines whether or not a valid BOC code has been detected. Valid BOC detection criteria are 8 out of 10 matching values (or alternately 4 out of 5 matching values). Valid only in T1 mode. INT4 cometqBOCRxCfg(sCMQ_HNDL deviceHandle, UINT2 chan, eCMQ_RBOC_CRITERIA detectCriteria) < chan > : channel from 0 to 3 : CMQ_RX_BOC_VALID_4OF5 or 0, CMQ_RX_BOC_VALID_8OF10 or 1 none if success cometqBOCRxCfg 1 CMQ_RX_BOC_VALID_4OF5
Map to API Input field(s) Output Example
PROPRIETARY AND CONFIDENTIAL TO PMC-SIERRA, INC., AND FOR ITS CUSTOMERS' INTERNAL USE
47
RELEASED EVALUATOR BOARD PMC-2001854 ISSUE 2
PM4354 COMET-QUAD
COMET-QUAD EVALUATOR BOARD SOFTWARE
5.7.17 cometqBOCRxGet < chan >
Description Map to API Input field(s) Output Example This function retrieves the current bit oriented code from the holding registers. Valid only in T1 mode. INT4 cometqBOCRxGet(sCMQ_HNDL deviceHandle, UINT2 chan, UINT1 *prxBOC) < chan > : channel from 0 to 3 rxBOC = Last BOC received (6 bit value) cometqBOCRxGet 2
5.8
Serial Controller
5.8.1 cometqTPSCEnable < chan >
Description Map to API Input field(s) Output Example Transmit per-channel serial controller INT4 cometqTPSCEnable(sCMQ_HNDL deviceHandle, UINT2 chan, UINT2 enable) < chan > : channel from 0 to 3 0 or 1 none if success cometqTPSCEnable 2 1
5.8.2 cometqTPSCPCMCtl < chan > [ ]
Description Map to API Input field(s) Transmit per-channel serial controller INT4 cometqTPSCPCMCtl(sCMQ_HNDL deviceHandle, UINT2 chan, UINT1 tSlot ,UINT2 rWFlag, , UINT1 *pctlByte, UINT1 *ptrnkData, UINT1 *psigData) < chan > : channel from 0 to 3 E1 from 0 to 31, T1 from 0 to 23 0 for Read 1 for Write when read control byte(when rWFlag=0) bit 7,4: pcm data unchanged = 0,0 invert pcm data = 1,0 invert pcm data MSB = 0,1 invert pcm data except MSB = 1,1 bit 5:
PROPRIETARY AND CONFIDENTIAL TO PMC-SIERRA, INC., AND FOR ITS CUSTOMERS' INTERNAL USE
48
RELEASED EVALUATOR BOARD PMC-2001854 ISSUE 2
PM4354 COMET-QUAD
COMET-QUAD EVALUATOR BOARD SOFTWARE
replace pcm data with idle pat = 1 bit 4: replace pcm data with miliwatt pat = 1 bit 3: replace pcm data with DPGR = 1 bit 2: loopback Tx timeslot data with Rx data = 1 bit 1,0 : zero code suppression format no zero suppression =0 jammed bit 8 =1 GTE zero suppression = 2 Bell zero suppression = 3 : trunk conditioning data byte(when rWFlag=0) : signaling data byte (when rWFlag=0) bit map for E1 mode: bit 7,6,5: sub timeslot bits with trunk data = 0 invert odd timeslot bits = 1 invert even timeslot bits = 2 invert all timeslot bits = 3 sub timeslot bits with A-Law pattern = 4 sub timeslot bits with U-Law pattern = 5 sub timeslot bits with trunk data = 6 sub timeslot bits with trunk data = 7 bit 4: This bit is only valid when CAS is selected in the T1-Tran configuration register. Signal trunken sourced from BTSIG via the format specified E1-Tran configuration reg = 0 signal trunken sourced from bit 3 thru 0 = 1 bit 3,2,1,0: signal trunken bits bit map for T1 mode: bit 7: signal trunken sourced from BTSIG = 0 signal trunken sourced from bit 3 thru 0 bit 6: disable signal insertion = 0 enable signal insertion = 1 bit 5,4: unused bit 3,2,1,0: signal trunken bits when Read (Wflag =1) print if success
=1
Output
PROPRIETARY AND CONFIDENTIAL TO PMC-SIERRA, INC., AND FOR ITS CUSTOMERS' INTERNAL USE
49
RELEASED EVALUATOR BOARD PMC-2001854 ISSUE 2
PM4354 COMET-QUAD
COMET-QUAD EVALUATOR BOARD SOFTWARE
Example
ctlByte : control byte trnkData : trunk conditioning data sigData: signaling data byte cometqTPSCPCMCtl 1 2 0
5.8.3 cometqRPSCEnable < chan >
Description Map to API Input field(s) Output Example Receive per-channel serial controller INT4 cometqRPSCEnable(sCMQ_HNDL deviceHandle, UINT2 chan, UINT2 enable) < chan > : channel from 0 to 3 0 or 1 none if success cometqRPSCEnable 2 1
5.8.4 cometqRPSCPCMCtl < chan > [ ]
Description Map to API Input field(s) Transmit per-channel serial controller INT4 cometqTPSCPCMCtl(sCMQ_HNDL deviceHandle, UINT2 chan, , UINT1 tSlot,UINT2 rWFlag, UINT1 *pctlByte, UINT1 *ptrnkData, UINT1 *psigData) < chan > : channel from 0 to 3 E1 from 0 to 31, T1 from 0 to 23 0 for Read 1 for Write :control byte(when rWFlag=1) bit 7: leave pcm data unchanged = 0 replace pcm data with DPGR = 1 bit 6: leave pcm data unchanged = 0 replace pcm data with trunken condition code byte = 1 bit 5: leave signaling data unchanged = 0 replace pcm data with signal trunken condition code byte = 1 bit 4: leave pcm data unchanged = 0 replace pcm data with miliwat pat = 1 bit 3: leave pcm data unchanged = 0
PROPRIETARY AND CONFIDENTIAL TO PMC-SIERRA, INC., AND FOR ITS CUSTOMERS' INTERNAL USE
50
RELEASED EVALUATOR BOARD PMC-2001854 ISSUE 2
PM4354 COMET-QUAD
COMET-QUAD EVALUATOR BOARD SOFTWARE
trnkData sigData
replace pcm data with U LAW pat = 1 bit 2: leave pcm data unchanged = 0 invert most significant bit of pcm data = 1 bit 1,0: unused : trunk conditioning data byte : signaling data byte bit 7,6,5,4: unused bit 3,2,1,0: A,B,C,D bits
Output
Example
when Read (Wflag =1) print if success ctlByte : control byte trnkData : tronk conditioning data sigData: signaling data byte bit 7,6,5,4 unused, bit 3,2,1,0 signal trunken bits cometqRPSCPCMCtl 1 2 1 0xff 0x11 0x22 cometqRPSCPCMCtl 1 2 0
5.8.5 cometqTxTrnkCfg < chan >
Description Map to API Input field(s) Output Example Transmit Trunk Conditioning INT4 cometqTxTrnkCfg (sCMQ_HNDL deviceHandle, UINT2 chan, UINT2 enable) < chan > : channel from 0 to 3 0 or 1 none if success cometqTxTrnkCfg 3 1
5.8.6 cometqRxTrnkCfg < chan >
Description Map to API Input field(s) Output Example Receive Trunk Conditioning INT4 cometqRxTrnkCfg (sCMQ_HNDL deviceHandle, UINT2 chan, UINT2 enable) < chan > : channel from 0 to 3 0 or 1 none if success cometqRxTrnkCfg 3 0
PROPRIETARY AND CONFIDENTIAL TO PMC-SIERRA, INC., AND FOR ITS CUSTOMERS' INTERNAL USE
51
RELEASED EVALUATOR BOARD PMC-2001854 ISSUE 2
PM4354 COMET-QUAD
COMET-QUAD EVALUATOR BOARD SOFTWARE
5.8.7 cometqPRGDCtlCfg< chan > < genLen >
Description Map to API Receive Trunk Conditioning INT4 cometqPRGDCtlCfg(sCMQ_HNDL deviceHandle, UINT2 chan, eCMQ_PRGD_PAT_LEN genLen, eCMQ_PRGD_PAT_LEN detLen, UINT2 unFrmGen, UINT2 unFrmDet, UINT2 rxPatGenLoc); < chan > : channel from 0 to 3 < genLen > : select 7 or 8 bit pattern insertion: CMQ_PRGD_PAT_8_BIT, CMQ_PRGD_PAT_7_BIT < detLen > :select 7 or 8 bit pattern detection: CMQ_PRGD_PAT_8_BIT, CMQ_PRGD_PAT_7_BIT 0 or 1 0 or 1 : location of the PRBS generator / detector. If set the pattern detector is inserted into the transmit path and the detector is inserted into the receive path if clear the generator is inserted in the transmit path and the detector is inserted in the receive path. none if success cometqPRGDCtlCfg 101010
Input field(s)
Output Example
5.8.8 cometqPRGDPatCfg < chan > < quasiRand >
Description
This API provides configuration of the pattern type that the pseudo-random generator/detector uses. The user can specify the pattern type and select between a pseudo-random or a quasi-random sequence. INT4 cometqPRGDPatCfg(sCMQ_HNDL deviceHandle, UINT2 chan, UINT1 quasiRand, eCMQ_PSEUDO_RANDOM_PATTERN pat); < chan > : channel from 0 to 3 < quasiRand >: 0 or 1 : * = Comet-Quad Device CMQ_PSEUDO_RANDOM_PAT_2_TO_3RD_MINUS1 or 0, CMQ_PSEUDO_RANDOM_PAT_2_TO_4th_MINUS1 or 1, CMQ_PSEUDO_RANDOM_PAT_2_TO_5th_MINUS1 or 2, CMQ_PSEUDO_RANDOM_PAT_2_TO_6th_MINUS1 or 3, CMQ_PSEUDO_RANDOM_PAT_2_TO_7th_MINUS1 or 4, CMQ_PSEUDO_RANDOM_PAT_FRAC_T1_ACTIVATE or 5, CMQ_PSEUDO_RANDOM_PAT_FRAC_T1_DEACTIVATE or 6, CMQ_PSEUDO_RANDOM_PAT_2_TO_9th_MINUS1_O_153 or 7,
Map to API Input field(s)
PROPRIETARY AND CONFIDENTIAL TO PMC-SIERRA, INC., AND FOR ITS CUSTOMERS' INTERNAL USE
52
RELEASED EVALUATOR BOARD PMC-2001854 ISSUE 2
PM4354 COMET-QUAD
COMET-QUAD EVALUATOR BOARD SOFTWARE
Output Example
CMQ_PSEUDO_RANDOM_PAT_2_TO_10th_MINUS1 or 8, * CMQ_PSEUDO_RANDOM_PAT_2_TO_11th_MINUS1 or 9, CMQ_PSEUDO_RANDOM_PAT_2_TO_11th_MINUS1_O_152 or 10, * CMQ_PSEUDO_RANDOM_PAT_2_TO_15th_MINUS1 or 11, CMQ_PSEUDO_RANDOM_PAT_2_TO_15th_MINUS1_O_151 or 12, CMQ_PSEUDO_RANDOM_PAT_2_TO_17th_MINUS1 or 13, CMQ_PSEUDO_RANDOM_PAT_2_TO_18th_MINUS1 or 14, * CMQ_PSEUDO_RANDOM_PAT_2_TO_20th_MINUS1 or 15, CMQ_PSEUDO_RANDOM_PAT_2_TO_20th_MINUS1_O_153 or 16, CMQ_PSEUDO_RANDOM_PAT_2_TO_20th_MINUS1_O_151 or 17, CMQ_PSEUDO_RANDOM_PAT_2_TO_21th_MINUS1 or 18, CMQ_PSEUDO_RANDOM_PAT_2_TO_22th_MINUS1 or 19, CMQ_PSEUDO_RANDOM_PAT_2_TO_23th_MINUS1_O_151 or 20, CMQ_PSEUDO_RANDOM_PAT_2_TO_25th_MINUS1 or 21, CMQ_PSEUDO_RANDOM_PAT_2_TO_28th_MINUS1 or 22, CMQ_PSEUDO_RANDOM_PAT_2_TO_29th_MINUS1 or 23, CMQ_PSEUDO_RANDOM_PAT_2_TO_31ST_MINUS1 or 24, CMQ_PSEUDO_RANDOM_PAT_ALL_ONES or 25, CMQ_PSEUDO_RANDOM_PAT_ALL_ZEROS or 26, CMQ_PSEUDO_RANDOM_PAT_ALT_ONES_AND_ZEROS or 27, CMQ_PSEUDO_RANDOM_PAT_DOUBLE_ALT_ONES_AND_ZEROS or 28, CMQ_PSEUDO_RANDOM_PAT_3_IN_24 or 29, CMQ_PSEUDO_RANDOM_PAT_1_IN_16 or 30, CMQ_PSEUDO_RANDOM_PAT_1_IN_8 or 31, CMQ_PSEUDO_RANDOM_PAT_1_IN_4 or 32, CMQ_PSEUDO_RANDOM_PAT_INBAND_LOOPBACK_ACTIVATE or 33, CMQ_PSEUDO_RANDOM_PAT_INBAND_LOOPBACK_DEACTIVATE or 34 none if success cometqPRGDPatCfg 1 2 3
5.8.9 cometqPRGDErrInsCfg
Description Map to API Input field(s) configure the data generator and detector error insertion rate. For COMET only INT4 cometqPRGDErrInsCfg(sCMQ_HNDL deviceHandle, eCMQ_ERROR_RATE errRate); : CMQ_ERROR_RATE_OFF or 0, CMQ_ERROR_RATE_SINGLE or 1, CMQ_ERROR_RATE_10_TO_MINUS1 or 2, CMQ_ERROR_RATE_10_TO_MINUS2 or 3, CMQ_ERROR_RATE_10_TO_MINUS3 or 4, CMQ_ERROR_RATE_10_TO_MINUS4 or 5, CMQ_ERROR_RATE_10_TO_MINUS5 or 6, CMQ_ERROR_RATE_10_TO_MINUS6 or 7, CMQ_ERROR_RATE_10_TO_MINUS7 or 8
PROPRIETARY AND CONFIDENTIAL TO PMC-SIERRA, INC., AND FOR ITS CUSTOMERS' INTERNAL USE
53
RELEASED EVALUATOR BOARD PMC-2001854 ISSUE 2
PM4354 COMET-QUAD
COMET-QUAD EVALUATOR BOARD SOFTWARE
Output Example
none if success cometqPRGDErrInsCfg 8
5.9
Interrupt Service Functions
NOTE: * The Tcl console only supports Polling mode. Polling can be done by calling "cometqPoll". * ISR and ISR Mask related APIs functions are omitted. * For the purpose of demonstrating interrupt events, only CDRC interrupts are enabled. * Callback functions used in this Tcl console are those provided in the Beta Driver cmq_app.c file. 5.9.1 cometqPoll
Description Map to API Input field(s) Output Example Commands the driver to poll the interrupt registers in the device. INT4 cometqPoll(sCMQ_HNDL deviceHandle); none Invoke callbacks cometqPoll
5.10
Status and Statistics Functions
5.10.1 cometqForceStatsUpdate
Description This function forces the performance monitor counters obtained by calling cometqGetStats to be updated from the internal holding registers. This function must be called before cometqGetStats is invoked. INT4 cometqForceStatsUpdate(sCMQ_HNDL deviceHandle); none none if success cometqForceStatsUpdate
Map to API Input field(s) Output Example
PROPRIETARY AND CONFIDENTIAL TO PMC-SIERRA, INC., AND FOR ITS CUSTOMERS' INTERNAL USE
54
RELEASED EVALUATOR BOARD PMC-2001854 ISSUE 2
PM4354 COMET-QUAD
COMET-QUAD EVALUATOR BOARD SOFTWARE
5.10.2 cometqGetStats
Description This function retrieves framing statistics from the hardware T1/E1 performance monitoring registers. When calling this function, it is assumed that the user forced the registers to update by calling cometqForceStatsUpdate. INT4 cometqGetStats(sCMQ_HNDL deviceHandle, sCMQ_FRM_CNTS *pData); none framing stats cometqGetStats
Map to API Input field(s) Output Example
5.10.3 cometqGetStatus
Description This function retrieves status and alarms information for either the T1 or E1 framers as appropriate based on the current operating mode. Loss of signal, loss of frame, AIS and yellow alarm status information is available for T1 and E1. For E1, loss of CRC-4 multiframe, loss of signaling multiframe, and timeslot 16 RAI indication is also available. INT4 cometqGetStatus(sCMQ_HNDL deviceHandle, sCMQ_FRM_STATUS *pData); none framer and alarm information cometqGetStatus
Map to API Input field(s) Output Example
5.10.4 cometqLineClkStatGet
Description Map to API Input field(s) Output Example This function provides the clock inputs status as well as the synchronization status of the clock service unit. INT4 cometqLineClkStatGet(sCMQ_HNDL deviceHandle, UINT2 chan, sCMQ_CLK_STATUS *pclkStat); any number from 0 to 3 clock input status and synchronization status cometqLineClkStatGet 0
PROPRIETARY AND CONFIDENTIAL TO PMC-SIERRA, INC., AND FOR ITS CUSTOMERS' INTERNAL USE
55
RELEASED EVALUATOR BOARD PMC-2001854 ISSUE 2
PM4354 COMET-QUAD
COMET-QUAD EVALUATOR BOARD SOFTWARE
5.10.5 cometqPRGDCntGet < chan >
Description Map to API Input field(s) Output Example This function retrieves the bit error count that is maintained in the pseudo-random generator/detector within the device. INT4 cometqPRGDCntGet(sCMQ_HNDL deviceHandle, UINT2 chan, UINT4 *pcount) < chan > : channel from 0 to 3 print count if success total bit count or bit error count cometqPRGDCntGet 1
5.10.6 cometqPRGDGetBitCnt
Description Map to API Input field(s) Output Example This function provides the user with the bit count maintained in the PRBS within a COMET device. This function is supported by the COMET only. INT4 cometqPRGDGetBitCnt(sCMQ_HNDL deviceHandle, UINT4 *pcount); none print count if success cometqPRGDGetBitCnt
5.10.7 cometqPmonSet
Description Map to API Input field(s) Enable/Disable one second update of Auto Performance Report Monitoring (APRM). This function is valid only in T1 ESF framing mode. INT4 cometqPmonSet(sCMQ_HNDL deviceHandle, UINT2 chan, eCMQ_APRM_ACTION action); any number from 0 to 3 : CMQ_AUTO_PMON_UPDATE_DISABLE or 0, CMQ_AUTO_PMON_UPDATE_ENABLE or 1, CMQ_AUTO_PMON_UPDATE_MAN or 2 none if success cometqPmonSet 01
Output Example
5.10.8 cometqPmonReportGet
Description This API returns the current one second performance report. This function is valid only in T1 ESF framing mode.
PROPRIETARY AND CONFIDENTIAL TO PMC-SIERRA, INC., AND FOR ITS CUSTOMERS' INTERNAL USE
56
RELEASED EVALUATOR BOARD PMC-2001854 ISSUE 2
PM4354 COMET-QUAD
COMET-QUAD EVALUATOR BOARD SOFTWARE
Map to API Input field(s) Output Example
INT4 cometqPmonReportGet(sCMQ_HNDL deviceHandle, UINT2 chan, sCMQ_STAT_APRM *pPmonReport); any number from 0 to 3 print pMonReport if success performance report buffer cometqPmonReportGet 3
5.11
Device Diagnostics
5.11.1 cometqTestReg
Description Map to API Input field(s) Output Example This function verifies hardware register integrity by writing and reading back values. INT4 cometqTestReg(sCMQ_HNDL deviceHandle); none none if success cometqTestReg
5.11.2 cometqLoopFramer
Description Clears / Sets a loopback of type line, payload, or digital within the E1/T1 framer section of the device. Note that when performing a line loopback, the transmit jitter attenuators reference and output clock divisors are set to 0x2F, the transmit timing options register is modified to jitter attenuated loop timing, and the transmit elastic store is enabled. INT4 cometqLoopFramer(sCMQ_HNDL deviceHandle, UINT2 framer, eCMQ_LOOPBACK_TYPE type); any number from 0 to 3 : CMQ_LOOPBACK_NONE or 0, CMQ_LOOPBACK_DIGITAL or 1, CMQ_LOOPBACK_LINE or 2, CMQ_LOOPBACK_PAYLOAD or 3 none if success cometqLoopFramer 0 1
Map to API Input field(s)
Output Example
PROPRIETARY AND CONFIDENTIAL TO PMC-SIERRA, INC., AND FOR ITS CUSTOMERS' INTERNAL USE
57
RELEASED EVALUATOR BOARD PMC-2001854 ISSUE 2
PM4354 COMET-QUAD
COMET-QUAD EVALUATOR BOARD SOFTWARE
5.11.3 cometqLoopTslots
Description This function enables or disables DS0 loopback on specified DS0s. To facilitate DS0 loopback, the receive elastic store must be bypassed. As such, the current receive backplane configuration must be clock master otherwise DS0 loopback is not possible. INT4 cometqLoopTslots(sCMQ_HNDL deviceHandle, UINT2 framer, UINT4 timeSlot, UINT2 enable); any number from 0 to 3 timeslot 0 or 1 none if success cometqLoopTslots 0 1 1
Map to API Input field(s) Output Example
5.11.4 cometqTxAnalogByp
Description Map to API Input field(s) Output Example This function enables or disables bypass of the TXRING and TXTIP outputs to use the digital TDAT and TCLKO lines. INT4 cometqTxAnalogByp(sCMQ_HNDL deviceHandle, UINT2 chan, UINT1 enable); any number from 0 to 3 0 or 1 none if success cometqTxAnalogByp 01
5.11.5 cometqRxAnalogByp
Description Map to API Input field(s) Output Example This function enables or disables bypass of the RXRING and RXTIP outputs to use the digital RDAT and RCLK lines. INT4 cometqRxAnalogByp(sCMQ_HNDL deviceHandle, UINT2 chan, UINT1 enable); any number from 0 to 3 0 or 1 none if success cometqRxAnalogByp 11
PROPRIETARY AND CONFIDENTIAL TO PMC-SIERRA, INC., AND FOR ITS CUSTOMERS' INTERNAL USE
58
RELEASED EVALUATOR BOARD PMC-2001854 ISSUE 2
PM4354 COMET-QUAD
COMET-QUAD EVALUATOR BOARD SOFTWARE
6
REFERENCES 1. PMC-Sierra, Inc., PMC-1991237, "COMET-QUAD Evaluator Board", December 2000, Issue 2. 2. PMC-Sierra, Inc., PMC-2000151, "COMET-QUAD Programming Guide", August 2001, Issue 2. 3. PMC-Sierra, Inc., PMC-1990315, "COMET-QUAD Data Sheet", May 2001, Issue 6. 4. PMC-Sierra, Inc., PMC-2001401, "COMET and COMET-QUAD Driver Manual", June 2001, Issue 2.
PROPRIETARY AND CONFIDENTIAL TO PMC-SIERRA, INC., AND FOR ITS CUSTOMERS' INTERNAL USE
59
RELEASED EVALUATOR BOARD PMC-2001854 ISSUE 2
PM4354 COMET-QUAD
COMET-QUAD EVALUATOR BOARD SOFTWARE
CONTACTING PMC-SIERRA, INC. PMC-Sierra, Inc. 8555 Baxter Place Burnaby, BC Canada V5A 4V7 Tel: Fax: (604) 415-6000 (604) 415-6200
http://www.pmc-sierra.com/techSupport/requestSupport.html
Technical Support: Document Ordering: Corporate Information: Web Site:
apps@pmc-sierra.com (604) 415-4533 document@pmc-sierra.com info@pmc-sierra.com http://www.pmc-sierra.com
None of the information contained in this document constitutes an express or implied warranty by PMC-Sierra, Inc. as to the sufficiency, fitness or suitability for a particular purpose of any such information or the fitness, or suitability for a particular purpose, merchantability, performance, compatibility with other parts or systems, of any of the products of PMC-Sierra, Inc., or any portion thereof, referred to in this document. PMC-Sierra, Inc. expressly disclaims all representations and warranties of any kind regarding the contents or use of the information, including, but not limited to, express and implied warranties of accuracy, completeness, merchantability, fitness for a particular use, or non-infringement. In no event will PMC-Sierra, Inc. be liable for any direct, indirect, special, incidental or consequential damages, including, but not limited to, lost profits, lost business or lost data resulting from any use of or reliance upon the information, whether or not PMC-Sierra, Inc. has been advised of the possibility of such damage. (c) 2000 PMC-Sierra, Inc. PMC-2001854 (R2) Issue date: August 2001
PROPRIETARY AND CONFIDENTIAL TO PMC-SIERRA, INC., AND FOR ITS CUSTOMERS' INTERNAL USE


▲Up To Search▲   

 
Price & Availability of 2001854

All Rights Reserved © IC-ON-LINE 2003 - 2022  
[Add Bookmark] [Contact Us] [Link exchange] [Privacy policy]
Mirror Sites :  [www.datasheet.hk]   [www.maxim4u.com]  [www.ic-on-line.cn] [www.ic-on-line.com] [www.ic-on-line.net] [www.alldatasheet.com.cn] [www.gdcy.com]  [www.gdcy.net]
 . . . . .
  We use cookies to deliver the best possible web experience and assist with our advertising efforts. By continuing to use this site, you consent to the use of cookies. For more information on cookies, please take a look at our Privacy Policy. X