PM5365 PMC-Sierra, Inc., PM5365 Datasheet
PM5365
Available stocks
Related parts for PM5365
PM5365 Summary of contents
Page 1
... PM8315, PM5365, PM4328 TEMUX/TEMAP/TECT3 T1/E1 F RAMER P Proprietary and Confidential to PMC-Sierra, Inc., and for its Customers’ Internal Use Document ID: PMC-1991611, Issue 2 TEMUX/TEMAP/TECT3 (PM8315, PM5365, PM4328) Driver Manual , VT/ M12/M13 M APPER D M RIVER ANUAL C ROPRIETARY AND ONFIDENTIAL R ELEASE 2001 SSUE UGUST UX ...
Page 2
... For more information about the TEMUX/TEMAP/TECT3 device, see the documents listed in the table below and any related errata documents. Proprietary and Confidential to PMC-Sierra, Inc., and for its Customers’ Internal Use Document ID: PMC-1991611, Issue 2 TEMUX/TEMAP/TECT3 (PM8315, PM5365, PM4328) Driver Manual TEMUX/TEMAP/TECT3 ANUAL AND 28 T1 VT1 ...
Page 3
... Issue 2 July 2001 Proprietary and Confidential to PMC-Sierra, Inc., and for its Customers’ Internal Use Document ID: PMC-1991611, Issue 2 TEMUX/TEMAP/TECT3 (PM8315, PM5365, PM4328) Driver Manual Document Name TEMAP High Density VT/TU Mapper and M13 Multiplexer Short Form Data Sheet High Density T1/E1 Framer with Integrated VT/TU Mapper and M13 ...
Page 4
... Tel: (604) 415-6000 Fax: (604) 415-6200 Document Information: document@pmc-sierra.com Corporate Information: info@pmc-sierra.com Technical Support: apps@pmc-sierra.com Web Site: http://www.pmc-sierra.com Proprietary and Confidential to PMC-Sierra, Inc., and for its Customers’ Internal Use Document ID: PMC-1991611, Issue 2 TEMUX/TEMAP/TECT3 (PM8315, PM5365, PM4328) Driver Manual exist. 4 ...
Page 5
... Active: TMX_ACTIVE..................................................................................................... 20 Inactive: TMX_INACTIVE............................................................................................... 20 3.3 Processing Flows ................................................................................................................. 20 Module Management ..................................................................................................... 20 Device Management ...................................................................................................... 21 3.4 Interrupt Servicing ................................................................................................................ 22 Calling temuxISR ........................................................................................................... 23 Calling temuxDPR.......................................................................................................... 23 3.5 Polling Servicing ................................................................................................................... 24 4 Data Structures ...................................................................................................................... 26 Proprietary and Confidential to PMC-Sierra, Inc., and for its Customers’ Internal Use Document ID: PMC-1991611, Issue 2 TEMUX/TEMAP/TECT3 (PM8315, PM5365, PM4328) Driver Manual 5 ...
Page 6
... Device Reading and Writing ................................................................................................. 57 Reading Registers: temuxRead ..................................................................................... 57 Writing Registers: temuxWrite........................................................................................ 57 Reading Framer Registers: temuxReadFR.................................................................... 58 Writing Framer Registers: temuxWriteFR ...................................................................... 58 Reading DS2/MX12 Multiplexer Registers: temuxReadMX .......................................... 59 Proprietary and Confidential to PMC-Sierra, Inc., and for its Customers’ Internal Use Document ID: PMC-1991611, Issue 2 TEMUX/TEMAP/TECT3 (PM8315, PM5365, PM4328) Driver Manual 6 ...
Page 7
... Invoking Interrupt Handlers: sysTemuxISRHandler ....................................................... 81 Removing Interrupt Handlers: sysTemuxISRHandlerRemove....................................... 81 Installing DPRTask: sysTemuxDPRTaskInstall .............................................................. 81 DPR Task: sysTemuxDPRTask ...................................................................................... 82 Removing DPRTask: sysTemuxDPRTaskRemove ........................................................ 82 7 RTOS Interface ...................................................................................................................... 83 Proprietary and Confidential to PMC-Sierra, Inc., and for its Customers’ Internal Use Document ID: PMC-1991611, Issue 2 TEMUX/TEMAP/TECT3 (PM8315, PM5365, PM4328) Driver Manual 7 ...
Page 8
... Constants ....................................................................................................................... 94 Structures ....................................................................................................................... 94 Functions........................................................................................................................ 94 API Functions................................................................................................................. 94 Porting Functions ........................................................................................................... 94 Other Functions.............................................................................................................. 95 Variables......................................................................................................................... 95 Appendix B: TEMUX/TECT3/TEMAP Error Codes..................................................................... 96 Acronyms 98 List of Terms .............................................................................................................................. 100 Index 101 Proprietary and Confidential to PMC-Sierra, Inc., and for its Customers’ Internal Use Document ID: PMC-1991611, Issue 2 TEMUX/TEMAP/TECT3 (PM8315, PM5365, PM4328) Driver Manual 8 ...
Page 9
... Figure 3: State Diagram .................................................................................................... 18 Figure 4: Module Management Flow Diagram.................................................................. 21 Figure 5: Device Management Flow Diagram .................................................................. 22 Figure 6: Interrupt Service Model...................................................................................... 23 Figure 7: Polling Service Model ........................................................................................ 24 Proprietary and Confidential to PMC-Sierra, Inc., and for its Customers’ Internal Use Document ID: PMC-1991611, Issue 2 TEMUX/TEMAP/TECT3 (PM8315, PM5365, PM4328) Driver Manual 9 ...
Page 10
... Table 24: Mapper Section Status Block: struct tmx_dsb_mapper (Not valid in TECT3) ................................................................................................. 42 Table 25: ISR Status Vector: sTMX_ISV .......................................................................... 43 Table 26: IO Section ISR Status Vector: struct tmx_isv_io............................................... 44 Proprietary and Confidential to PMC-Sierra, Inc., and for its Customers’ Internal Use Document ID: PMC-1991611, Issue 2 TEMUX/TEMAP/TECT3 (PM8315, PM5365, PM4328) Driver Manual 10 ...
Page 11
... Table 32: Table of Parameters: temuxReadInd ................................................................ 61 Table 33: Table of Parameters: temuxWriteInd ................................................................ 63 Table 34: Driver Source Files ........................................................................................... 87 Table 35: Variable Type Definitions .................................................................................. 92 Table 36: Naming Conventions......................................................................................... 93 Table 37: TEMUX/TECT3/TEMAP Error Codes ............................................................... 96 Proprietary and Confidential to PMC-Sierra, Inc., and for its Customers’ Internal Use Document ID: PMC-1991611, Issue 2 TEMUX/TEMAP/TECT3 (PM8315, PM5365, PM4328) Driver Manual 11 ...
Page 12
... RTOS platform (page 87). In addition, an Appendix (beginning on page 92) and Index (page 101), provide you with useful reference information. Proprietary and Confidential to PMC-Sierra, Inc., and for its Customers’ Internal Use Document ID: PMC-1991611, Issue 2 TEMUX/TEMAP/TECT3 (PM8315, PM5365, PM4328) Driver Manual Introduction 12 ...
Page 13
... Retrieving device status and statistics information. · Diagnosing the device Proprietary and Confidential to PMC-Sierra, Inc., and for its Customers’ Internal Use Document ID: PMC-1991611, Issue 2 TEMUX/TEMAP/TECT3 (PM8315, PM5365, PM4328) Driver Manual RCHITECTURE Application Callbacks Service Callbacks Service Calls Register Accesses ...
Page 14
... The driver includes five main modules: · Module and Device management · Driver API · Driver library · Interrupt processing Proprietary and Confidential to PMC-Sierra, Inc., and for its Customers’ Internal Use Document ID: PMC-1991611, Issue 2 TEMUX/TEMAP/TECT3 (PM8315, PM5365, PM4328) Driver Manual Software Architecture 14 ...
Page 15
... The DDB stores context information about the TEMUX/TEMAP/TECT3 device, such as: · Device state · Control information · Initialization vector Proprietary and Confidential to PMC-Sierra, Inc., and for its Customers’ Internal Use Document ID: PMC-1991611, Issue 2 TEMUX/TEMAP/TECT3 (PM8315, PM5365, PM4328) Driver Manual Application Function Calls Driver API Deferred Driver Library Routine ...
Page 16
... You can customize these example implementations to suit your specific needs. Proprietary and Confidential to PMC-Sierra, Inc., and for its Customers’ Internal Use Document ID: PMC-1991611, Issue 2 TEMUX/TEMAP/TECT3 (PM8315, PM5365, PM4328) Driver Manual temuxISR Software Architecture that checks if there are is ...
Page 17
... See page 22 for a detailed explanation of the DPR and interrupt-servicing model. Proprietary and Confidential to PMC-Sierra, Inc., and for its Customers’ Internal Use Document ID: PMC-1991611, Issue 2 TEMUX/TEMAP/TECT3 (PM8315, PM5365, PM4328) Driver Manual ) clears and processes interrupt conditions for the temuxDPR Software Architecture ...
Page 18
... Module States The following is a description of the TEMUX/TEMAP/TECT3 driver module states. Proprietary and Confidential to PMC-Sierra, Inc., and for its Customers’ Internal Use Document ID: PMC-1991611, Issue 2 TEMUX/TEMAP/TECT3 (PM8315, PM5365, PM4328) Driver Manual D TATE ESCRIPTION Start temuxModuleClose ...
Page 19
... There is a separate flow for each device that can be added and they all start here. Proprietary and Confidential to PMC-Sierra, Inc., and for its Customers’ Internal Use Document ID: PMC-1991611, Issue 2 TEMUX/TEMAP/TECT3 (PM8315, PM5365, PM4328) Driver Manual . In this state the driver does not hold any temuxModuleOpen . The Module Initialization Vector (MIV) has been validated, the ...
Page 20
... The following flow diagram illustrates the typical function call sequences that occur when initializing or shutting down the TEMUX/TEMAP/TECT3 driver module. Proprietary and Confidential to PMC-Sierra, Inc., and for its Customers’ Internal Use Document ID: PMC-1991611, Issue 2 TEMUX/TEMAP/TECT3 (PM8315, PM5365, PM4328) Driver Manual or deleted via temuxInit and ...
Page 21
... Proprietary and Confidential to PMC-Sierra, Inc., and for its Customers’ Internal Use Document ID: PMC-1991611, Issue 2 TEMUX/TEMAP/TECT3 (PM8315, PM5365, PM4328) Driver Manual Perform s m odule level initialization of the TEMUX driver. Validates the Module Initialization Vector (MIV). Allocates m em ory for the MDB and all its com ponents (i ...
Page 22
... TEMUX/TEMAP/TECT3 driver. Proprietary and Confidential to PMC-Sierra, Inc., and for its Customers’ Internal Use Document ID: PMC-1991611, Issue 2 TEMUX/TEMAP/TECT3 (PM8315, PM5365, PM4328) Driver Manual performs a register readback test, allocates memory for storing device context information, and applies a software reset to the device (using temuxReset) ...
Page 23
... The task waits for messages from the ISR on this message queue. When a message arrives, Proprietary and Confidential to PMC-Sierra, Inc., and for its Customers’ Internal Use Document ID: PMC-1991611, Issue 2 TEMUX/TEMAP/TECT3 (PM8315, PM5365, PM4328) Driver Manual temuxISR sysTemuxISRHandler sysTemuxDPRTask ...
Page 24
... Figure 7: Polling Service Model temuxDPR Proprietary and Confidential to PMC-Sierra, Inc., and for its Customers’ Internal Use Document ID: PMC-1991611, Issue 2 TEMUX/TEMAP/TECT3 (PM8315, PM5365, PM4328) Driver Manual calls different indication callbacks for different interrupt . Also, ensure that the indication function is non-blocking. You can and ...
Page 25
... See page 75 for a description of these callback functions. Proprietary and Confidential to PMC-Sierra, Inc., and for its Customers’ Internal Use Document ID: PMC-1991611, Issue 2 TEMUX/TEMAP/TECT3 (PM8315, PM5365, PM4328) Driver Manual ”) provided by the driver that does not change from temux and are not used ...
Page 26
... Proprietary and Confidential to PMC-Sierra, Inc., and for its Customers’ Internal Use Document ID: PMC-1991611, Issue 2 TEMUX/TEMAP/TECT3 (PM8315, PM5365, PM4328) Driver Manual temux.h >: error codes used throughout the driver code, returned by the API is returned to a function’s caller) used in the global error ...
Page 27
... UINT1 * Proprietary and Confidential to PMC-Sierra, Inc., and for its Customers’ Internal Use Document ID: PMC-1991611, Issue 2 TEMUX/TEMAP/TECT3 (PM8315, PM5365, PM4328) Driver Manual Field Description indicates to driver to start the module when opened (pointer to) pre-allocated or (if NULL) returned MDB number of devices that must be supported for this session call, this structure contains all the information needed by the driver to internally does this) ...
Page 28
... TMX_LINEOPT_SDH_E1T1 can be one of the following: sysopt Proprietary and Confidential to PMC-Sierra, Inc., and for its Customers’ Internal Use Document ID: PMC-1991611, Issue 2 TEMUX/TEMAP/TECT3 (PM8315, PM5365, PM4328) Driver Manual Field Description a user-supplied value that is returned in callback functions if non-zero, temuxInit profile number to be used for initialization. A profile ...
Page 29
... DS3 Proprietary and Confidential to PMC-Sierra, Inc., and for its Customers’ Internal Use Document ID: PMC-1991611, Issue 2 TEMUX/TEMAP/TECT3 (PM8315, PM5365, PM4328) Driver Manual : Serial Clock/Data Interface : SBI with CAS or CCS H-MVIP (not valid in TEMAP) : Serial Clock/Data with CCS H-MVIP (not valid in TEMAP) ...
Page 30
... UINT1 insbi.unde UINT1 exsbi.pare UINT1 Proprietary and Confidential to PMC-Sierra, Inc., and for its Customers’ Internal Use Document ID: PMC-1991611, Issue 2 TEMUX/TEMAP/TECT3 (PM8315, PM5365, PM4328) Driver Manual , and the temuxGetMask temuxSetMask Sets / Clears Interrupt Condition SBI collision detect (register 0) SBI collision detect (register 1) ...
Page 31
... Field Name ds2.inte.cofae Proprietary and Confidential to PMC-Sierra, Inc., and for its Customers’ Internal Use Document ID: PMC-1991611, Issue 2 TEMUX/TEMAP/TECT3 (PM8315, PM5365, PM4328) Driver Manual Field Description DS3 PMON Accumulation Transfer DS3 Receive DLC State Transition DS3 Receive BOC FEAC Removed (not valid in ...
Page 32
... Proprietary and Confidential to PMC-Sierra, Inc., and for its Customers’ Internal Use Document ID: PMC-1991611, Issue 2 TEMUX/TEMAP/TECT3 (PM8315, PM5365, PM4328) Driver Manual Field Type Field Description UINT1 DS2 Red Alarm Transition UINT1 DS2 Far End Receive Failure Transition ...
Page 33
... Proprietary and Confidential to PMC-Sierra, Inc., and for its Customers’ Internal Use Document ID: PMC-1991611, Issue 2 TEMUX/TEMAP/TECT3 (PM8315, PM5365, PM4328) Driver Manual Field Type Field Description UINT1 E1 Framer Out of Frame Transition UINT1 E1 Framer Out of Signaling Multiframe Transition ...
Page 34
... Proprietary and Confidential to PMC-Sierra, Inc., and for its Customers’ Internal Use Document ID: PMC-1991611, Issue 2 TEMUX/TEMAP/TECT3 (PM8315, PM5365, PM4328) Driver Manual Field Type Field Description UINT1 E1 Framer Input Frame Pulse Asserted UINT1 E1 Framer Input CRC Sub-Multiframe Pulse Asserted ...
Page 35
... Proprietary and Confidential to PMC-Sierra, Inc., and for its Customers’ Internal Use Document ID: PMC-1991611, Issue 2 TEMUX/TEMAP/TECT3 (PM8315, PM5365, PM4328) Driver Manual Field Type Field Description UINT1 E1/T1 Framer Receive DLC (not valid in TEMAP) ...
Page 36
... Field Name enable control ienable pattern Proprietary and Confidential to PMC-Sierra, Inc., and for its Customers’ Internal Use Document ID: PMC-1991611, Issue 2 TEMUX/TEMAP/TECT3 (PM8315, PM5365, PM4328) Driver Manual Field Type Field Description UINT1 Receive Tributary Path Overhead Processor change of path signal label UINT1 ...
Page 37
... Proprietary and Confidential to PMC-Sierra, Inc., and for its Customers’ Internal Use Document ID: PMC-1991611, Issue 2 TEMUX/TEMAP/TECT3 (PM8315, PM5365, PM4328) Driver Manual , that indicates that the top level function was not able to carry the pointer and retrieve the local error code (this eliminates the need INT4 TMX_MOD_READY ...
Page 38
... DPV when a callback function is called. The element is unused by the driver itself and may contain any value. Proprietary and Confidential to PMC-Sierra, Inc., and for its Customers’ Internal Use Document ID: PMC-1991611, Issue 2 TEMUX/TEMAP/TECT3 (PM8315, PM5365, PM4328) Driver Manual Field Description Indicates that the call sysTemuxBufferStart ...
Page 39
... BOOLEAN index UINT2 revision UINT2 Proprietary and Confidential to PMC-Sierra, Inc., and for its Customers’ Internal Use Document ID: PMC-1991611, Issue 2 TEMUX/TEMAP/TECT3 (PM8315, PM5365, PM4328) Driver Manual , or . TMX_INACTIVE and cannot be less than one UINT4 Field Description Global error indicator for device calls ...
Page 40
... Proprietary and Confidential to PMC-Sierra, Inc., and for its Customers’ Internal Use Document ID: PMC-1991611, Issue 2 TEMUX/TEMAP/TECT3 (PM8315, PM5365, PM4328) Driver Manual Field Description Indicates if device cannot be found Indicates if the current isr mask has been saved into the member savedMask Extra space for use by the application ...
Page 41
... UINT2 rdlc.stat UINT1 Proprietary and Confidential to PMC-Sierra, Inc., and for its Customers’ Internal Use Document ID: PMC-1991611, Issue 2 TEMUX/TEMAP/TECT3 (PM8315, PM5365, PM4328) Driver Manual Field Type Field Description struct tmx_dsb_framer Alarms, status and counters from the FRAMER section(s) struct tmx_dsb_mapper ...
Page 42
... Table 23: Mapper Section Status Block: struct tmx_dsb_mapper (Not valid in TECT3) Field Name telecom Proprietary and Confidential to PMC-Sierra, Inc., and for its Customers’ Internal Use Document ID: PMC-1991611, Issue 2 TEMUX/TEMAP/TECT3 (PM8315, PM5365, PM4328) Driver Manual Field Description Pattern detector error count Field Description DS2 framer status ...
Page 43
... Field Type devId sTMX_HNDL Proprietary and Confidential to PMC-Sierra, Inc., and for its Customers’ Internal Use Document ID: PMC-1991611, Issue 2 TEMUX/TEMAP/TECT3 (PM8315, PM5365, PM4328) Driver Manual ’ flag is set. value. ’ flag is set and that the array of DDBs particular order. value. ...
Page 44
... Field Type exsbi.und UINT1 Proprietary and Confidential to PMC-Sierra, Inc., and for its Customers’ Internal Use Document ID: PMC-1991611, Issue 2 TEMUX/TEMAP/TECT3 (PM8315, PM5365, PM4328) Driver Manual Field Description The user context Copy of the master ISR register SDH master interrupt source (not valid in ...
Page 45
... Field Name frInts1 Proprietary and Confidential to PMC-Sierra, Inc., and for its Customers’ Internal Use Document ID: PMC-1991611, Issue 2 TEMUX/TEMAP/TECT3 (PM8315, PM5365, PM4328) Driver Manual Field Description SBI bus egress overrun interrupt bits SBI bus parity error interrupt bits SBI bus ingress underrun interrupt bits ...
Page 46
... Proprietary and Confidential to PMC-Sierra, Inc., and for its Customers’ Internal Use Document ID: PMC-1991611, Issue 2 TEMUX/TEMAP/TECT3 (PM8315, PM5365, PM4328) Driver Manual Field Type Field Description UINT1 E1/T1 Interrupt Source #2 interrupt bits UINT1 E1/T1 receive jitter attenuator interrupt bits ...
Page 47
... TUG2 refers to a range from corresponding to TUG2 #1 to TUG2 #7 and TU refers to a range from corresponding Proprietary and Confidential to PMC-Sierra, Inc., and for its Customers’ Internal Use Document ID: PMC-1991611, Issue 2 TEMUX/TEMAP/TECT3 (PM8315, PM5365, PM4328) Driver Manual Field Type Field Description UINT1 ...
Page 48
... UINT4 Proprietary and Confidential to PMC-Sierra, Inc., and for its Customers’ Internal Use Document ID: PMC-1991611, Issue 2 TEMUX/TEMAP/TECT3 (PM8315, PM5365, PM4328) Driver Manual ) and the event that triggered the processing. For some Field Description Framer# or mx# of channel that triggered the event (if needed) ...
Page 49
... MDB de-allocated. Prototype INT4 temuxModuleClose (void) None Inputs Outputs None Proprietary and Confidential to PMC-Sierra, Inc., and for its Customers’ Internal Use Document ID: PMC-1991611, Issue 2 TEMUX/TEMAP/TECT3 (PM8315, PM5365, PM4328) Driver Manual P I ROGRAMMING NTERFACE before returning. temuxModuleStart : (pointer to) the MIV TMX_OK ...
Page 50
... ISRs and the Deferred-Processing Routine (DPR) Task. If there are any registered devices, INT4 temuxModuleStop (void) Prototype Proprietary and Confidential to PMC-Sierra, Inc., and for its Customers’ Internal Use Document ID: PMC-1991611, Issue 2 TEMUX/TEMAP/TECT3 (PM8315, PM5365, PM4328) Driver Manual TMX_OK TMX_ERR_CLOSED TMX_ERR_INVALID TMX_ERR_STOP TMX_ERR_NOTIDLE ...
Page 51
... Failure = NULL with Valid States START changes the STATE of the DEVICE to PRESENT Side Effects Proprietary and Confidential to PMC-Sierra, Inc., and for its Customers’ Internal Use Document ID: PMC-1991611, Issue 2 TEMUX/TEMAP/TECT3 (PM8315, PM5365, PM4328) Driver Manual TMX_OK TMX_ERR_CLOSED TMX_ERR_INVALID TMX_ERR_ISIDLE TMX_ERR_NOTREADY : (pointer to) the DIV temuxMdb-> ...
Page 52
... UINT2 profileNum) Inputs devId pDIV profileNum None Outputs Proprietary and Confidential to PMC-Sierra, Inc., and for its Customers’ Internal Use Document ID: PMC-1991611, Issue 2 TEMUX/TEMAP/TECT3 (PM8315, PM5365, PM4328) Driver Manual : device handle (from temuxAdd) TMX_OK TMX_ERR_CLOSED TMX_ERR_INVALID TMX_ERR_NOTREADY TMX_ERR_DEACTIVATE TMX_ERR_NOTINACTIVE TMX_ERR_RESET ...
Page 53
... INT4 temuxDeActivate (sTMX_HNDL devId) Prototype Inputs devId Proprietary and Confidential to PMC-Sierra, Inc., and for its Customers’ Internal Use Document ID: PMC-1991611, Issue 2 TEMUX/TEMAP/TECT3 (PM8315, PM5365, PM4328) Driver Manual TMX_OK TMX_ERR_HNDL TMX_ERR_ARG TMX_ERR_NOTREADY TMX_ERR_INVALID TMX_ERR_NOTPRESENT ...
Page 54
... Profiles between 8 and added. Prototype INT4 temuxAddInitProfile (sTMX_INIT_PROF *pProf, UINT2 *pprofileNum) Proprietary and Confidential to PMC-Sierra, Inc., and for its Customers’ Internal Use Document ID: PMC-1991611, Issue 2 TEMUX/TEMAP/TECT3 (PM8315, PM5365, PM4328) Driver Manual TMX_OK TMX_ERR_HNDL TMX_ERR_INVALID TMX_ERR_NOTREADY TMX_ERR_CLOSED TMX_ERR_NOTACTIVE ...
Page 55
... Prototype INT4 temuxDeleteInitProfile (UINT2 profileNum) Proprietary and Confidential to PMC-Sierra, Inc., and for its Customers’ Internal Use Document ID: PMC-1991611, Issue 2 TEMUX/TEMAP/TECT3 (PM8315, PM5365, PM4328) Driver Manual : pointer to a vector of profiles : pointer to the profile number, assigned by temuxAddInitProfile ...
Page 56
... Success = Failure = ACTIVE, INACTIVE Valid States Side Effects None Proprietary and Confidential to PMC-Sierra, Inc., and for its Customers’ Internal Use Document ID: PMC-1991611, Issue 2 TEMUX/TEMAP/TECT3 (PM8315, PM5365, PM4328) Driver Manual : the profile to delete TMX_OK TMX_ERR_ARG TMX_ERR_CLOSED TMX_ERR_INVALID TMX_ERR_RANGE MOD_START : handle from ...
Page 57
... TMX_ERR_HNDL Error Code written to DDB: Success = Failure = TMX_ERR_RANGE Proprietary and Confidential to PMC-Sierra, Inc., and for its Customers’ Internal Use Document ID: PMC-1991611, Issue 2 TEMUX/TEMAP/TECT3 (PM8315, PM5365, PM4328) Driver Manual : device handle (from : register number TMX_OK TMX_ERR_ADDR TMX_ERR_HWFAIL : device handle (from : register number ...
Page 58
... Prototype UINT1 temuxWriteFR (sTMX_HNDL devId, UINT2 frNum, UINT2 regNum, UINT1 wdata) Proprietary and Confidential to PMC-Sierra, Inc., and for its Customers’ Internal Use Document ID: PMC-1991611, Issue 2 TEMUX/TEMAP/TECT3 (PM8315, PM5365, PM4328) Driver Manual : device handle (from : framer number (1-28 T1, 1-21 E1) : register number TMX_OK ...
Page 59
... MAY affect registers that change after a read operation Side Effects Proprietary and Confidential to PMC-Sierra, Inc., and for its Customers’ Internal Use Document ID: PMC-1991611, Issue 2 TEMUX/TEMAP/TECT3 (PM8315, PM5365, PM4328) Driver Manual : device handle (from : framer number (1-28 T1, 1-21 E1) : register number : data to be written ...
Page 60
... Proprietary and Confidential to PMC-Sierra, Inc., and for its Customers’ Internal Use Document ID: PMC-1991611, Issue 2 TEMUX/TEMAP/TECT3 (PM8315, PM5365, PM4328) Driver Manual : device handle (from temuxAdd : framer number (1-7) : register number : data to be written TMX_OK TMX_ERR_ADDR TMX_ERR_HWFAIL ...
Page 61
... It then writes the contents of the data parameter to this address location using the system specific macro, . sysTemuxWriteReg Proprietary and Confidential to PMC-Sierra, Inc., and for its Customers’ Internal Use Document ID: PMC-1991611, Issue 2 TEMUX/TEMAP/TECT3 (PM8315, PM5365, PM4328) Driver Manual TMX_OK TMX_ERR_ADDR TMX_ERR_HWFAIL arg2 arg3 ...
Page 62
... Valid States Side Effects May change the configuration of the device Proprietary and Confidential to PMC-Sierra, Inc., and for its Customers’ Internal Use Document ID: PMC-1991611, Issue 2 TEMUX/TEMAP/TECT3 (PM8315, PM5365, PM4328) Driver Manual : device handle (from : section ( RPSC,TPSC,SIGX,INSBI EXSBI,RTDM,TRAP,TTOP,TTMP) : see parameter table below ...
Page 63
... Error Code written to DDB: Success = Failure = TMX_ERR_RANGE Last register value read Returns Proprietary and Confidential to PMC-Sierra, Inc., and for its Customers’ Internal Use Document ID: PMC-1991611, Issue 2 TEMUX/TEMAP/TECT3 (PM8315, PM5365, PM4328) Driver Manual arg2 arg3 Indirect Register n/u Indirect Register n/u Indirect Register ...
Page 64
... Proprietary and Confidential to PMC-Sierra, Inc., and for its Customers’ Internal Use Document ID: PMC-1991611, Issue 2 TEMUX/TEMAP/TECT3 (PM8315, PM5365, PM4328) Driver Manual : device handle (from : register number : number of register to write : (pointer to) the block of data to write TMX_OK TMX_ERR_ADDR TMX_ERR_HWFAIL ...
Page 65
... Valid States PRESENT, ACTIVE, INACTIVE Side Effects May change the configuration of the device Proprietary and Confidential to PMC-Sierra, Inc., and for its Customers’ Internal Use Document ID: PMC-1991611, Issue 2 TEMUX/TEMAP/TECT3 (PM8315, PM5365, PM4328) Driver Manual TMX_OK TMX_ERR_ADDR TMX_ERR_HWFAIL : device handle (from : register number ...
Page 66
... Outputs None Proprietary and Confidential to PMC-Sierra, Inc., and for its Customers’ Internal Use Document ID: PMC-1991611, Issue 2 TEMUX/TEMAP/TECT3 (PM8315, PM5365, PM4328) Driver Manual : device handle (from : (pointer to) HDLC data : size of HDLC data : if set, read link data TMX_OK TMX_ERR_HNDL ...
Page 67
... Returns Success = Failure = PRESENT, ACTIVE, INACTIVE Valid States Side Effects None Proprietary and Confidential to PMC-Sierra, Inc., and for its Customers’ Internal Use Document ID: PMC-1991611, Issue 2 TEMUX/TEMAP/TECT3 (PM8315, PM5365, PM4328) Driver Manual TMX_OK TMX_ERR_HNDL TMX_ERR_CLOSED TMX_ERR_INVALID TMX_ERR_NOTREADY TMX_ERR_ISSTART TMX_ERR_ISPRESENT TMX_ERR_ADDR TMX_ERR_ARG ...
Page 68
... None Outputs Returns Success = Failure = Proprietary and Confidential to PMC-Sierra, Inc., and for its Customers’ Internal Use Document ID: PMC-1991611, Issue 2 TEMUX/TEMAP/TECT3 (PM8315, PM5365, PM4328) Driver Manual : device handle (from : (pointer to) mask structure ( ) cast to void * sTMX_MASK * TMX_OK TMX_ERR_HNDL TMX_ERR_CLOSED TMX_ERR_INVALID ...
Page 69
... Inputs devId Outputs None (pointer to) an ISV or NULL on error Returns Proprietary and Confidential to PMC-Sierra, Inc., and for its Customers’ Internal Use Document ID: PMC-1991611, Issue 2 TEMUX/TEMAP/TECT3 (PM8315, PM5365, PM4328) Driver Manual : device handle (from : (pointer to) an ISV (( cast to *) void TMX_OK TMX_ERR_HNDL ...
Page 70
... Failure = Valid States PRESENT, INACTIVE, ACTIVE None Side Effects Proprietary and Confidential to PMC-Sierra, Inc., and for its Customers’ Internal Use Document ID: PMC-1991611, Issue 2 TEMUX/TEMAP/TECT3 (PM8315, PM5365, PM4328) Driver Manual . sysTemuxDPRTask : (pointer to) an ISV (( sTMX_ISV : device handle (from : ISR/polling mode: - hardware ISR mode ...
Page 71
... Prototype INT4 temuxClearStats (sTMX_HNDL devId) Inputs devId Outputs None Proprietary and Confidential to PMC-Sierra, Inc., and for its Customers’ Internal Use Document ID: PMC-1991611, Issue 2 TEMUX/TEMAP/TECT3 (PM8315, PM5365, PM4328) Driver Manual : device handle (from : (pointer to) device status block (( *) cast to sTMX_DSB TMX_OK TMX_ERR_HNDL ...
Page 72
... Failure = Valid States ACTIVE, INACTIVE May inhibit the flow of active data Side Effects Proprietary and Confidential to PMC-Sierra, Inc., and for its Customers’ Internal Use Document ID: PMC-1991611, Issue 2 TEMUX/TEMAP/TECT3 (PM8315, PM5365, PM4328) Driver Manual TMX_OK TMX_ERR_HNDL TMX_ERR_CLOSED TMX_ERR_INVALID TMX_ERR_NOTREADY TMX_ERR_ISSTART TMX_ERR_ADDR ...
Page 73
... Error Code written to the MDB on failure Outputs Proprietary and Confidential to PMC-Sierra, Inc., and for its Customers’ Internal Use Document ID: PMC-1991611, Issue 2 TEMUX/TEMAP/TECT3 (PM8315, PM5365, PM4328) Driver Manual : device handle (from : clears loop if clear, else sets loop : loop type: TMX_NOLOOP ...
Page 74
... Failure = INACTIVE, ACTIVE Valid States Side Effects Will inhibit the flow of active data Proprietary and Confidential to PMC-Sierra, Inc., and for its Customers’ Internal Use Document ID: PMC-1991611, Issue 2 TEMUX/TEMAP/TECT3 (PM8315, PM5365, PM4328) Driver Manual TMX_OK TMX_ERR_HNDL TMX_ERR_CLOSED TMX_ERR_INVALID TMX_ERR_NOTREADY TMX_ERR_ISPRESENT TMX_ERR_ADDR the user to interpret any results from temuxGetStats ...
Page 75
... Outputs None Proprietary and Confidential to PMC-Sierra, Inc., and for its Customers’ Internal Use Document ID: PMC-1991611, Issue 2 TEMUX/TEMAP/TECT3 (PM8315, PM5365, PM4328) Driver Manual : device handle (from : clears loop if clear, else sets loop : framer number (1-28 T1), (1-21 E1) : loop type: TMX_NOLOOP TMX_DLOOP ...
Page 76
... Failure = ACTIVE, INACTIVE Valid States Side Effects May inhibit the flow of active data Proprietary and Confidential to PMC-Sierra, Inc., and for its Customers’ Internal Use Document ID: PMC-1991611, Issue 2 TEMUX/TEMAP/TECT3 (PM8315, PM5365, PM4328) Driver Manual TMX_OK TMX_ERR_HNDL TMX_ERR_CLOSED TMX_ERR_INVALID TMX_ERR_NOTREADY TMX_ERR_ISPRESENT TMX_ERR_ISSTART ...
Page 77
... Returns None Proprietary and Confidential to PMC-Sierra, Inc., and for its Customers’ Internal Use Document ID: PMC-1991611, Issue 2 TEMUX/TEMAP/TECT3 (PM8315, PM5365, PM4328) Driver Manual callback function is provided by the user and is used by the DPR to : user context (passed in : event that triggered the callback : formatted event buffer ...
Page 78
... None Outputs Returns None Proprietary and Confidential to PMC-Sierra, Inc., and for its Customers’ Internal Use Document ID: PMC-1991611, Issue 2 TEMUX/TEMAP/TECT3 (PM8315, PM5365, PM4328) Driver Manual Application Programming Interface : event that triggered the callback : formatted event buffer : user context (passed in temuxAdd) : event that triggered the callback ...
Page 79
... Returns value read from the addressed register location Proprietary and Confidential to PMC-Sierra, Inc., and for its Customers’ Internal Use Document ID: PMC-1991611, Issue 2 TEMUX/TEMAP/TECT3 (PM8315, PM5365, PM4328) Driver Manual UINT1 : register location to be read : (pointer to) user’s variable : register location to be read ...
Page 80
... Inputs temuxISR None Outputs Proprietary and Confidential to PMC-Sierra, Inc., and for its Customers’ Internal Use Document ID: PMC-1991611, Issue 2 TEMUX/TEMAP/TECT3 (PM8315, PM5365, PM4328) Driver Manual : register location to be written : data to be written sysTemuxISRHandler , once for EACH device requesting service, to perform temuxISR ...
Page 81
... Success = 0x00 Failure = <any other value> Proprietary and Confidential to PMC-Sierra, Inc., and for its Customers’ Internal Use Document ID: PMC-1991611, Issue 2 TEMUX/TEMAP/TECT3 (PM8315, PM5365, PM4328) Driver Manual . Note: In most cases, the user will sysTemuxDPRTask as a task but that is not required. : (pointer to) the function ...
Page 82
... Returns None Proprietary and Confidential to PMC-Sierra, Inc., and for its Customers’ Internal Use Document ID: PMC-1991611, Issue 2 TEMUX/TEMAP/TECT3 (PM8315, PM5365, PM4328) Driver Manual call. It runs periodically and is responsible for . The user may choose to have this task perform the and functions (passing the ISV as a ...
Page 83
... Inputs address Outputs None Returns None Proprietary and Confidential to PMC-Sierra, Inc., and for its Customers’ Internal Use Document ID: PMC-1991611, Issue 2 TEMUX/TEMAP/TECT3 (PM8315, PM5365, PM4328) Driver Manual : number of bytes to be allocated . sysTemuxMemAlloc : (pointer to) first byte of the memory region being de-allocated RTOS Interface ...
Page 84
... Prototype sysTemuxDPVBufferGet (void) None Inputs Outputs None Success = (pointer to) a DPV buffer Returns Failure = NULL (pointer) Proprietary and Confidential to PMC-Sierra, Inc., and for its Customers’ Internal Use Document ID: PMC-1991611, Issue 2 TEMUX/TEMAP/TECT3 (PM8315, PM5365, PM4328) Driver Manual . RTOS Interface 84 ...
Page 85
... This function sends an ISV message to the DPR task with the device handle and interrupt statuses for that device. Proprietary and Confidential to PMC-Sierra, Inc., and for its Customers’ Internal Use Document ID: PMC-1991611, Issue 2 TEMUX/TEMAP/TECT3 (PM8315, PM5365, PM4328) Driver Manual : (pointer to) a DPV Buffer : (pointer to) a ISV Buffer RTOS Interface ...
Page 86
... Prototype Inputs None None Outputs Returns None Proprietary and Confidential to PMC-Sierra, Inc., and for its Customers’ Internal Use Document ID: PMC-1991611, Issue 2 TEMUX/TEMAP/TECT3 (PM8315, PM5365, PM4328) Driver Manual : (pointer to) a ISV Buffer RTOS Interface 86 ...
Page 87
... Proprietary and Confidential to PMC-Sierra, Inc., and for its Customers’ Internal Use Document ID: PMC-1991611, Issue 2 TEMUX/TEMAP/TECT3 (PM8315, PM5365, PM4328) Driver Manual ). The files contain the functions and the src (contains all API functions) (contains driver internal functions) ...
Page 88
... RTOS specific services. Proprietary and Confidential to PMC-Sierra, Inc., and for its Customers’ Internal Use Document ID: PMC-1991611, Issue 2 TEMUX/TEMAP/TECT3 (PM8315, PM5365, PM4328) Driver Manual (contains general defines for compiling) (contains ISR definitions and prototypes) (contains DPR definitions and prototypes) ...
Page 89
... Proprietary and Confidential to PMC-Sierra, Inc., and for its Customers’ Internal Use Document ID: PMC-1991611, Issue 2 TEMUX/TEMAP/TECT3 (PM8315, PM5365, PM4328) Driver Manual . The number after the type identifies the data-type size. temux.h defines a 4-byte (32-bit) unsigned integer. Substitute the compiler types ...
Page 90
... Define the application-specific constants for your hardware configuration in Proprietary and Confidential to PMC-Sierra, Inc., and for its Customers’ Internal Use Document ID: PMC-1991611, Issue 2 TEMUX/TEMAP/TECT3 (PM8315, PM5365, PM4328) Driver Manual tmx_hw.h Description Reads a device register given its real ...
Page 91
... Link the TEMUX/TEMAP/TECT3 API driver library to your application code. Proprietary and Confidential to PMC-Sierra, Inc., and for its Customers’ Internal Use Document ID: PMC-1991611, Issue 2 TEMUX/TEMAP/TECT3 (PM8315, PM5365, PM4328) Driver Manual Description The maximum number of TEMUX/TECT3/TEMAP devices that can be supported by this driver ...
Page 92
... INT2 INT4 signed integer – 4 bytes BOOLEAN unsigned integer – 2 bytes Proprietary and Confidential to PMC-Sierra, Inc., and for its Customers’ Internal Use Document ID: PMC-1991611, Issue 2 TEMUX/TEMAP/TECT3 (PM8315, PM5365, PM4328) Driver Manual C ODING ONVENTIONS Appendix A: Coding Conventions 92 ...
Page 93
... Macro names must be all uppercase. · Words shall be separated by an underscore. Proprietary and Confidential to PMC-Sierra, Inc., and for its Customers’ Internal Use Document ID: PMC-1991611, Issue 2 TEMUX/TEMAP/TECT3 (PM8315, PM5365, PM4328) Driver Manual Appendix A: Coding Conventions Naming convention prefix with and device “ ...
Page 94
... Example: sysTemuxReadReg() Proprietary and Confidential to PMC-Sierra, Inc., and for its Customers’ Internal Use Document ID: PMC-1991611, Issue 2 TEMUX/TEMAP/TECT3 (PM8315, PM5365, PM4328) Driver Manual is a valid name for a macro valid name for a constant valid name for a structure valid name for an API function. ...
Page 95
... Proprietary and Confidential to PMC-Sierra, Inc., and for its Customers’ Internal Use Document ID: PMC-1991611, Issue 2 TEMUX/TEMAP/TECT3 (PM8315, PM5365, PM4328) Driver Manual is a valid name for such a function prefix followed by the variable name unchanged. If “p” , the first letter of the variable name may be “ ...
Page 96
... TMX_ERR_NOTREADY TMX_ERR_NOTACTIVE TMX_ERR_NOTPRESENT TMX_ERR_NOTINACTIVE TMX_ERR_ARG Proprietary and Confidential to PMC-Sierra, Inc., and for its Customers’ Internal Use Document ID: PMC-1991611, Issue 2 TEMUX/TEMAP/TECT3 (PM8315, PM5365, PM4328) Driver Manual Appendix B: TEMUX/TECT3/TEMAP Error Codes Description Success Failure RTOS system call failure Memory allocation failure Buffer management errror ...
Page 97
... TMX_ERR_ISTEMAP TMX_ERR_MAXPROF TMX_ERR_MAXDEVICE TMX_ERR_TECT3 Proprietary and Confidential to PMC-Sierra, Inc., and for its Customers’ Internal Use Document ID: PMC-1991611, Issue 2 TEMUX/TEMAP/TECT3 (PM8315, PM5365, PM4328) Driver Manual Appendix B: TEMUX/TECT3/TEMAP Error Codes Description Device configuration error Bad address passed to function Bad handle passed to function ...
Page 98
... JAT: Jitter Attenuator (RJAT, TJAT) MDB: Module Data Block MIV: Module Initialization Vector MSB: Module Status Block MVIP: Multi-vendor integration protocol Proprietary and Confidential to PMC-Sierra, Inc., and for its Customers’ Internal Use Document ID: PMC-1991611, Issue 2 TEMUX/TEMAP/TECT3 (PM8315, PM5365, PM4328) Driver Manual ) Acronyms 98 ...
Page 99
... TOP: Tributary (path) Overhead Processor (RTOP, TTOP) TRAN: Transmitter (of a Framer, usually) TRAP: Transmit Alarm Processor VTPP: Tributary Payload Processor (I-VTPP (ingress), E-VTPP (egress)) Proprietary and Confidential to PMC-Sierra, Inc., and for its Customers’ Internal Use Document ID: PMC-1991611, Issue 2 TEMUX/TEMAP/TECT3 (PM8315, PM5365, PM4328) Driver Manual Acronyms 99 ...
Page 100
... MSB (Module Status Block): Structure that holds the alarms, status and statistics for the module · RTOS (Real-Time Operating System): The host for this driver Proprietary and Confidential to PMC-Sierra, Inc., and for its Customers’ Internal Use Document ID: PMC-1991611, Issue 2 TEMUX/TEMAP/TECT3 (PM8315, PM5365, PM4328) Driver Manual List of Terms 100 ...
Page 101
... Proprietary and Confidential to PMC-Sierra, Inc., and for its Customers’ Internal Use Document ID: PMC-1991611, Issue 2 TEMUX/TEMAP/TECT3 (PM8315, PM5365, PM4328) Driver Manual temuxSetMask, 32, 74 temuxUpdate, 61 temuxWrite, 62 temuxWriteBlock, 70 temuxWriteFR, 64 temuxWriteInd, 67, 69 temuxWriteMapper, 71 temuxWriteMX, 65 ...
Page 102
... Porting Functions sysTemuxBufferReceive, 91 sysTemuxBufferStart, 40, 47, 94, 101 Proprietary and Confidential to PMC-Sierra, Inc., and for its Customers’ Internal Use Document ID: PMC-1991611, Issue 2 TEMUX/TEMAP/TECT3 (PM8315, PM5365, PM4328) Driver Manual sysTemuxBufferStop, 97, 101 sysTemuxCBackXX, 103 sysTemuxDPRTask, 23, 24, 77, 91, 92, 102 sysTemuxDPRTaskInstall, 24, 91 sysTemuxDPRTaskRemove, 24, 92 ...
Page 103
... Proprietary and Confidential to PMC-Sierra, Inc., and for its Customers’ Internal Use Document ID: PMC-1991611, Issue 2 TEMUX/TEMAP/TECT3 (PM8315, PM5365, PM4328) Driver Manual struct tmx_dsb_io, 44 struct tmx_dsb_mapper, 44, 46 struct tmx_dsb_mux, 44, 45 struct tmx_isv_ds3, 48, 49 struct tmx_isv_framer, 48, 49 ...