PMC-Sierra PM5358 S/UNI 4x622 manual

PM5358 S/UNI-4x 622 Driver Manual Proprietary and Confi dential to PM C-Sierra, Inc. Document ID: PMC- 2010419, Issue 1 PM5358 S/UNI-4 X 622 D RIVER M ANUAL P ROPRIET A R Y A ND C ONFI DENTIAL P RELIMIN A R Y I SSUE 1: A PRIL , 2001[...]

PM5358 S/UNI-4x 622 Driver Manual Proprietary and Confi dential to PM C-Sierra, Inc. 2 Document ID: PMC- 2010419, Issue 1 A BOUT THIS M A NUA L A ND S/UNI-4 X 622 This m anual describes the S/UNI- 4x622 (PM5358 ) device driv er . It descr ibes the driv er ’ s function s, data st ructures, an d archite cture. This manual foc uses on the driver’ [...]

PM5358 S/UNI-4x 622 Driver Manual Proprietary and Confi dential to PM C-Sierra, Inc. 3 Document ID: PMC- 2010419, Issue 1 Legal Issues None of the inf ormatio n contained in thi s docum ent constitu tes an expre ss or im plied warran ty by PMC-Sie rra, In c. as to the suffic iency , fitness or suitabil ity fo r a partic ular purpos e of any such in[...]

PM5358 S/UNI-4x 622 Driver Manual Proprietary and Confi dential to PM C-Sierra, Inc. 4 Document ID: PMC- 2010419, Issue 1 T ABL E O F C ONTENTS About this Manual and S/UNI- 4x622 ................................................................................... 2 Audience ............................................................................[...]

PM5358 S/UNI-4x 622 Driver Manual Proprietary and Confi dential to PM C-Sierra, Inc. 5 Document ID: PMC- 2010419, Issue 1 3.2 S tructures Passed b y the Ap plication ......................................................................... 26 Module Initi ali zation V ec t or: MIV ....................................................................[...]

PM5358 S/UNI-4x 622 Driver Manual Proprietary and Confi dential to PM C-Sierra, Inc. 6 Document ID: PMC- 2010419, Issue 1 Writing the K1K2 Byte: suni4x6 22LO HW r iteK1K2 .................................................. 65 Reading the K1K2 B yte: suni4x62 2LOHRead K1K2 ................................................ 66 Writing the S1 Byte: suni4[...]

PM5358 S/UNI-4x 622 Driver Manual Proprietary and Confi dential to PM C-Sierra, Inc. 7 Document ID: PMC- 2010419, Issue 1 Clearing RPOH Interru pt Enable Mask: s uni4x622C lrMaskRPO H ......................... 86 Getting P YLD Interr upt Enabl e Mask : suni4x622Ge tMask PYLD ............................ 87 Setting P YLD Interrupt Enable Mask : suni[...]

PM5358 S/UNI-4x 622 Driver Manual Proprietary and Confi dential to PM C-Sierra, Inc. 8 Document ID: PMC- 2010419, Issue 1 5.2 System- S pecific Interrupt Serv icing .......................................................................... 109 Installing th e ISR Hand ler: sysSun i4x622I SRHandlerInstall ................................. 109 ISR Ha[...]

PM5358 S/UNI-4x 622 Driver Manual Proprietary and Confi dential to PM C-Sierra, Inc. 9 Document ID: PMC- 2010419, Issue 1 Payload Events (PYLD) ......................................................................................... 128 Line Interf ace Events (INTF_LINE) ....................................................................... 128 S[...]

PM5358 S/UNI-4x 622 Driver Manual Proprietary and Confi dential to PM C-Sierra, Inc. 10 Document ID: PMC- 2010419, Issue 1 L IST OF F IGURE S Figure 1: Driv er External Interf aces................................................................................... 14 Figure 2: Driv er Architecture ....................................................[...]

PM5358 S/UNI-4x 622 Driver Manual Proprietary and Confi dential to PM C-Sierra, Inc. 1 1 Document ID: PMC- 2010419, Issue 1 L IST OF T ABL ES Table 1: S/UNI-4x622 Module I nitiali zation Vec tor: sSUNI4x62 2_MIV ............................. 27 Table 2: S/UNI-4x 622 Device Initia li zati on Vec tor: sSUNI4x 6 22_ DIV .............................. [...]

PM5358 S/UNI-4x 622 Driver Manual Proprietary and Confi dential to PM C-Sierra, Inc. 12 Document ID: PMC- 2010419, Issue 1 Table 22: S/UNI-4x 622 Globa l Line Int erfac e Configura tion: sSUNI4x622_CFG _INTF_LINE _GLOBAL ................................................................ 44 Table 23: S/UNI-4x622 S ignal Failure Configurat ion: sSUNI4x[...]

PM5358 S/UNI-4x 622 Driver Manual Introduction Proprietary and Confi dential to PM C-Sierra, Inc. 13 Document ID: PMC- 2010419, Issue 1 1 I NTRODUCTI ON The follow ing section s of th e S/UNI- 4x622 Device Driver Des ign Specif ication descr ibe the S/UNI-4x622 dev ice driver . The code provided throughout this do cument is wri tten in ANSI-C . Thi[...]

PM5358 S/UNI-4x 622 Driver Manual Sof tware Architecture Proprietary and Confi dential to PM C-Sierra, Inc. 14 Document ID: PMC- 2010419, Issue 1 2 S OFTW ARE A RCHI TECTURE This sec tion descr ibes the so ftware arch itecture of the S/UNI -4x622 device d river . This includes a discuss ion of the d river ’ s ex ternal in terfaces and its m ain c[...]

PM5358 S/UNI-4x 622 Driver Manual Sof tware Architecture Proprietary and Confi dential to PM C-Sierra, Inc. 15 Document ID: PMC- 2010419, Issue 1 • I nitialize the device(s) • Perform diagnostic tests • V alidate con figurat ion info rmation • Retriev e statu s and coun ts inform ation The driv er API functi ons use the s ervices o f the ot[...]

PM5358 S/UNI-4x 622 Driver Manual Sof tware Architecture Proprietary and Confi dential to PM C-Sierra, Inc. 16 Document ID: PMC- 2010419, Issue 1 • Alarm, status and count s • Section Ov erhead • Line Overhe ad • Path Overhe ad • Payload Pro cessor • I nterface Conf iguration • APS Configura tion Figure 2: Drive r Architecture Module [...]

PM5358 S/UNI-4x 622 Driver Manual Sof tware Architecture Proprietary and Confi dential to PM C-Sierra, Inc. 17 Document ID: PMC- 2010419, Issue 1 • Maximu m numb er of devices • The DDB( s) The Device Da ta-Block (DDB) is conta ined in the MDB, and init ialized by the driv er module f or each S/UN I-4x622 dev ice that is reg istered. There is o[...]

PM5358 S/UNI-4x 622 Driver Manual Sof tware Architecture Proprietary and Confi dential to PM C-Sierra, Inc. 18 Document ID: PMC- 2010419, Issue 1 Section Ov erhead The Sectio n Overhead sec tion pr ovides func tions to con trol and m onitor the section ov erhead processing . Read / Wri te access is given to the sec tion trac e messag e (J0). T his [...]

PM5358 S/UNI-4x 622 Driver Manual Sof tware Architecture Proprietary and Confi dential to PM C-Sierra, Inc. 19 Document ID: PMC- 2010419, Issue 1 2.3 Sof t w are St ates Figure 3 sh ows the softw are state diagram for the S/UNI- 4x622 driver . State transiti ons occur on the success ful execut ion of the co rresponding transition functions shown. S[...]

PM5358 S/UNI-4x 622 Driver Manual Sof tware Architecture Proprietary and Confi dential to PM C-Sierra, Inc. 20 Document ID: PMC- 2010419, Issue 1 Module St ates The follow i ng is a description o f the S /UNI-4x622 m odule states. See sectio n 4.1 for a de tailed descrip tion of the API function s that ar e used to change the m odule state. S tart [...]

PM5358 S/UNI-4x 622 Driver Manual Sof tware Architecture Proprietary and Confi dential to PM C-Sierra, Inc. 21 Document ID: PMC- 2010419, Issue 1 2.4 Processing Flo w s This sec tion descr ibes the m ain processing flows of the S/ UNI-4x622 driv er component s. The flow diag rams presen ted here i llustrate the seque nce of opera tions tha t take p[...]

PM5358 S/UNI-4x 622 Driver Manual Sof tware Architecture Proprietary and Confi dential to PM C-Sierra, Inc. 22 Document ID: PMC- 2010419, Issue 1 Figure 5: Device Mana gement Flow Diagra m De-acti vates t he device and rem oves it from norm al operati on. This i nvol ves di sabling t he device int errupts. ISR rout ines for t his device are removed[...]

PM5358 S/UNI-4x 622 Driver Manual Sof tware Architecture Proprietary and Confi dential to PM C-Sierra, Inc. 23 Document ID: PMC- 2010419, Issue 1 The driv er provides sy stem -independent fun ctions, suni4x622ISR and suni4x622DPR . Y ou must fil l in the co rrespon ding system -specific fu nctions, sysSuni4x622ISRHandler and sysSuni4x622DPRTask . T[...]

PM5358 S/UNI-4x 622 Driver Manual Sof tware Architecture Proprietary and Confi dential to PM C-Sierra, Inc. 24 Document ID: PMC- 2010419, Issue 1 Calling suni4x622D PR The sysSuni4x622DPRTask funct ion is a sy stem speci fic funct ion that runs a s a separa te task within th e R T OS. Y o u should set the DPR task’ s priority hig her th an the ap[...]

PM5358 S/UNI-4x 622 Driver Manual Sof tware Architecture Proprietary and Confi dential to PM C-Sierra, Inc. 25 Document ID: PMC- 2010419, Issue 1 Figure 7: Poll ing Service M odel In polling mode, the application is res ponsible fo r calling suni4x622Poll often enough to service any pending error or alarm condi tions. When suni4x622Poll i s called,[...]

PM5358 S/UNI-4x 622 Driver Manual Dat a Structur es Proprietary and Confi dential to PM C-Sierra, Inc. 26 Document ID: PMC- 2010419, Issue 1 3 D AT A S T RUCTURES This sec tion descr ibes th e elements of the driv er that config ure or cont rol its be havior , and should therefore b e of in terest t o the appli cation prog ramm er . Included he re [...]

PM5358 S/UNI-4x 622 Driver Manual Dat a Structur es Proprietary and Confi dential to PM C-Sierra, Inc. 27 Document ID: PMC- 2010419, Issue 1 T able 1: S/UNI-4 x622 Modu le Initia lization V ector: sSUNI 4x622_MIV Field Name Field Type Field Description perrModule INT4 * (pointer t o) errModule (see description in the MDB) maxDevs UINT2 Maximum nu m[...]

PM5358 S/UNI-4x 622 Driver Manual Dat a Structur es Proprietary and Confi dential to PM C-Sierra, Inc. 28 Document ID: PMC- 2010419, Issue 1 Field Name Field Type Field Description cbackPYLD sSUNI4x622_CBACK Address for t he callback function for PYLD events cbackFIFO sSUNI4x622_CBACK Address for t he callback function for FIFO events cbackIntfLine[...]

PM5358 S/UNI-4x 622 Driver Manual Dat a Structur es Proprietary and Confi dential to PM C-Sierra, Inc. 29 Document ID: PMC- 2010419, Issue 1 T able 4: S/UNI-4 x622 ISR Mask: sSUNI4x622_MASK_ISR_CHAN Field Name Field Type Field Description maskSOH sSUNI4x622_MASK_ISR_ SOH Interrupt m ask for Section Ov erhead section maskLOH sSUNI4x622_MASK_ISR_ LOH[...]

PM5358 S/UNI-4x 622 Driver Manual Dat a Structur es Proprietary and Confi dential to PM C-Sierra, Inc. 30 Document ID: PMC- 2010419, Issue 1 Field Name Field Type Field Description psbf UINT2 APS byte failu re coaps UINT2 Change of APS bytes coz1s1 UINT2 Change of synchr onization sta tus messag e lbipe UINT2 Line BIP error lreie UINT2 Line REI err[...]

PM5358 S/UNI-4x 622 Driver Manual Dat a Structur es Proprietary and Confi dential to PM C-Sierra, Inc. 31 Document ID: PMC- 2010419, Issue 1 Field Name Field Type Field Description psl UINT2 Pat h si gna l la bel ch an ged aisc UINT2 Pointer AIS event lopc UINT2 Lost of point er concaten ation chang e newptr UINT2 New pointe r received illjreq UINT[...]

PM5358 S/UNI-4x 622 Driver Manual Dat a Structur es Proprietary and Confi dential to PM C-Sierra, Inc. 32 Document ID: PMC- 2010419, Issue 1 Field Name Field Type Field Descrip tion rxfpfovr UINT2 Rx FP FIFO overrun txfpfudr UINT2 Tx FP FIFO underrun T able 10: S/UNI-4x622 ISR Mask: sSUNI4x622_ MASK_ISR_INTF_LINE Field Name Field Type Field Descrip[...]

PM5358 S/UNI-4x 622 Driver Manual Dat a Structur es Proprietary and Confi dential to PM C-Sierra, Inc. 33 Document ID: PMC- 2010419, Issue 1 Field Name Field Type Field Description lof UINT2 Los of fr ame oof UINT2 Out of fr ame lot UINT2 Loss of tran sitio n dool UINT2 Recovered d ata out of lock rool UINT2 Recovered refere nce out of lock ese UIN[...]

PM5358 S/UNI-4x 622 Driver Manual Dat a Structur es Proprietary and Confi dential to PM C-Sierra, Inc. 34 Document ID: PMC- 2010419, Issue 1 Field Name Field Type Field Description init ialize d stateModule eSUNI4x622_MOD_STATE Module sta te; can be on e of the fo llowing IDLE or READY maxDevs UINT2 Maximum nu mber of dev i ces s upported numDevs U[...]

PM5358 S/UNI-4x 622 Driver Manual Dat a Structur es Proprietary and Confi dential to PM C-Sierra, Inc. 35 Document ID: PMC- 2010419, Issue 1 Field Name Field Type Field Description init ialize d stateDevice eSUNI4x622_DEV_STATE Device S tate; can be on e of the fo llowing PRESENT , ACTIVE or INACTIVE baseAddr void * Base addre ss of the dev ice usr[...]

PM5358 S/UNI-4x 622 Driver Manual Dat a Structur es Proprietary and Confi dential to PM C-Sierra, Inc. 36 Document ID: PMC- 2010419, Issue 1 Device-wid e Global Configura tion T able 10: S/UNI-4x622 Input/Output Configu ration: sSUNI4x622_CFG_GLOBAL Field Name Field Type Field Description sonetsel UINT1 Select SONET/SDH mode cfgIntfSys sSUNI4x622_C[...]

PM5358 S/UNI-4x 622 Driver Manual Dat a Structur es Proprietary and Confi dential to PM C-Sierra, Inc. 37 Document ID: PMC- 2010419, Issue 1 Per -Chann el Sec tion Over head (S OH ) Con figuration T able 12: S/UNI-4x622 S ection Overhe ad Configuration: sSUNI4x622_CFG_SOH Field Name Field Type Field Description algo2 UINT1 Selects fram ing pattern [...]

PM5358 S/UNI-4x 622 Driver Manual Dat a Structur es Proprietary and Confi dential to PM C-Sierra, Inc. 38 Document ID: PMC- 2010419, Issue 1 Field Name Field Type Field Description allones UINT1 Controls w heth er incom ing AI S will fo rce the dow nstream Sonet/SDH fr ame to all on es sdins UINT1 Controls wh ether SD can ca use Line AIS inse rtion[...]

PM5358 S/UNI-4x 622 Driver Manual Dat a Structur es Proprietary and Confi dential to PM C-Sierra, Inc. 39 Document ID: PMC- 2010419, Issue 1 Field Name Field Type Field Description lcdprdi UINT1 Controls wheth er loss of cell del ineation can cau se PRDI insertion alrmprdi UINT1 Controls wh ether LOS,LO F or LAI S can cause PRDI insertion paisprdi [...]

PM5358 S/UNI-4x 622 Driver Manual Dat a Structur es Proprietary and Confi dential to PM C-Sierra, Inc. 40 Document ID: PMC- 2010419, Issue 1 Field Name Field Type Field Description ptimeprdi UINT1 Controls w heth er path tr ace ident ifier m ismatch ca n cause EPRDI insertion paisconpais UINT1 Controls w hether AIS concatena tion ev ents can caus e[...]

PM5358 S/UNI-4x 622 Driver Manual Dat a Structur es Proprietary and Confi dential to PM C-Sierra, Inc. 41 Document ID: PMC- 2010419, Issue 1 Field Name Field Ty pe Fiel d Description rxfpminpl UINT1 RX minim um packet leng th rxfpmaxpl UINT2 RX maxim um pack et length txdscr UINT1 TX scram bles outgoing payload txcpidlehdr UINT1 TX idle cell h eade[...]

PM5358 S/UNI-4x 622 Driver Manual Dat a Structur es Proprietary and Confi dential to PM C-Sierra, Inc. 42 Document ID: PMC- 2010419, Issue 1 Per -Channel RALRM Confi guration T able 19: S/UNI-4x622 C lock Interface Con figuration : sSUNI4x622_CFG_RALRM Field Name Field Type Field Description losen UINT1 Controls w heth er LOS s et RALR M outp ut lo[...]

PM5358 S/UNI-4x 622 Driver Manual Dat a Structur es Proprietary and Confi dential to PM C-Sierra, Inc. 43 Document ID: PMC- 2010419, Issue 1 Field Name Field Type Field Description cfgRALRM sSUNI4x622_CFG_RALRM RALRM configurat ion block Device- wide Syste m Interface Con f igura tion T able 21: S/UNI-4x622 G l obal Sys tem Interfa ce Configuration[...]

PM5358 S/UNI-4x 622 Driver Manual Dat a Structur es Proprietary and Confi dential to PM C-Sierra, Inc. 44 Document ID: PMC- 2010419, Issue 1 Device-W ide Line Int erface Con figuration T able 22: S/UNI-4x622 G l obal Lin e Interfac e Configuration: sSUNI4x622_CFG_INTF_LINE_GLOBAL Field Name Field Type Field Description rsel UINT1 Selects which chan[...]

PM5358 S/UNI-4x 622 Driver Manual Dat a Structur es Proprietary and Confi dential to PM C-Sierra, Inc. 45 Document ID: PMC- 2010419, Issue 1 Field Name Field Type Field Description sdsap UINT4 SD Accumulatio n period sdsth UINT4 SD Saturation T hreshold sddth UINT4 SD Declaring T hres hold sdcth UINT4 SD Clearing Threshold T able 25: S/UNI-4x622 Ch[...]

PM5358 S/UNI-4x 622 Driver Manual Dat a Structur es Proprietary and Confi dential to PM C-Sierra, Inc. 46 Document ID: PMC- 2010419, Issue 1 Line Overhead (LOH) S tatus T able 27: S/UNI-4x622 L ine Overhead S tatu s: sSUNI4x622_ST A TUS_LOH Field Name Field Type Field Descrip tion k1 UINT1 Receive K1 k2 UINT1 Receive K2 s1 UINT1 Receive S1 laisdet [...]

PM5358 S/UNI-4x 622 Driver Manual Dat a Structur es Proprietary and Confi dential to PM C-Sierra, Inc. 47 Document ID: PMC- 2010419, Issue 1 Field Name Field Type Field Description prdi UINT1 Path RDI status tiu UINT1 Path trace identifi er un stable tim UINT1 Path trace identifier m ism atch uneq UINT1 Equip status of the path signal label pslu UI[...]

PM5358 S/UNI-4x 622 Driver Manual Dat a Structur es Proprietary and Confi dential to PM C-Sierra, Inc. 48 Document ID: PMC- 2010419, Issue 1 Field Name Field Ty pe Field Description tfclka UINT1 TFCL K active refclka UINT1 REFC LKA activ e Line Inter face S tatus T able 30: S/UNI-4x622 L ine Interfa ce S tatus: sSUNI4x6 22_ST A TUS_INTF_LINE Field [...]

PM5358 S/UNI-4x 622 Driver Manual Dat a Structur es Proprietary and Confi dential to PM C-Sierra, Inc. 49 Document ID: PMC- 2010419, Issue 1 Line Overhead (LOH) Counter T able 33: S/UNI-4x622 L ine Overhead (LO H) Counters: sSUNI4x622_CNTR_LOH Field Name Fi eld Ty pe Fiel d Description lbe UINT4 Line BIP error co unter lfe UINT4 Line REI error coun[...]

PM5358 S/UNI-4x 622 Driver Manual Dat a Structur es Proprietary and Confi dential to PM C-Sierra, Inc. 50 Document ID: PMC- 2010419, Issue 1 Field Name Fi eld Ty pe Field Description rxfprminlf UINT2 Rx minim um leng th error fram e count rxfprmaxlf UINT2 Rx maximum length error fram e count txfptbyte UINT4 Tx byte coun t txfptframe UINT4 Tx frame [...]

PM5358 S/UNI-4x 622 Driver Manual Dat a Structur es Proprietary and Confi dential to PM C-Sierra, Inc. 51 Document ID: PMC- 2010419, Issue 1 T able 37: S/UNI-4x622 Def erred-Pro cessing V ector: sSUNI4x622_DPV Field Name Field Ty pe Fiel d Description event SUNI4x622_DPR_EVENT Event being reported cause UINT2 Reason for the Event 3.5 Global V ariab[...]

PM5358 S/UNI-4x 622 Driver Manual Application Program ming Interface Proprietary and Confi dential to PM C-Sierra, Inc. 52 Document ID: PMC- 2010419, Issue 1 4 A PPLIC A TION P ROGRA MMING I NTER F A CE This sec tion provide s a detai led descrip tion of ea ch function tha t is a m ember of the S/UNI- 4x622 driver Applica tion Prog ramm i ng In ter[...]

PM5358 S/UNI-4x 622 Driver Manual Application Program ming Interface Proprietary and Confi dential to PM C-Sierra, Inc. 53 Document ID: PMC- 2010419, Issue 1 Inputs None Outpu ts None Retur ns Success = SUNI4x622_SUCCESS Failure = SUNI4x622_ERR_INVALID_MODULE_STATE V alid S tates SUNI4x622_MOD_IDLE , SUNI4x622_MOD_READY Side Effects C hanges the MO[...]

PM5358 S/UNI-4x 622 Driver Manual Application Program ming Interface Proprietary and Confi dential to PM C-Sierra, Inc. 54 Document ID: PMC- 2010419, Issue 1 Side Effects C hanges the MO DULE state to SUNI4x622_MOD_IDLE 4.2 Profil e Management This sec tion des cribes th e functions that add, g et and c lear an in itial ization p rofile. I nitializ[...]

PM5358 S/UNI-4x 622 Driver Manual Application Program ming Interface Proprietary and Confi dential to PM C-Sierra, Inc. 55 Document ID: PMC- 2010419, Issue 1 V alid S tates SUNI4x622_MOD_IDLE, SUNI4x622_MOD_READY Side Effects None Deleting an Init ialization Profile : suni4x62 2DeleteInitProfile This function de letes an initia lization profile giv[...]

PM5358 S/UNI-4x 622 Driver Manual Application Program ming Interface Proprietary and Confi dential to PM C-Sierra, Inc. 56 Document ID: PMC- 2010419, Issue 1 perrDevice : ( poi nte r to) errDevice (inside the DDB) Retur ns Success = Dev ice Hand le (to be us ed bas an ar gument to m ost of the S/UNI-4x622 APIs) Failure = NULL (pointer) V alid S tat[...]

PM5358 S/UNI-4x 622 Driver Manual Application Program ming Interface Proprietary and Confi dential to PM C-Sierra, Inc. 57 Document ID: PMC- 2010419, Issue 1 SUNI4x622_ERR_INVALID_DIV V alid S tates SUNI4x622_PRESENT Side Effects C hanges the DE VICE state to SUNI4x622_INACTIVE Up dating the Configuration of a Device: suni4x622Up date This func tio[...]

PM5358 S/UNI-4x 622 Driver Manual Application Program ming Interface Proprietary and Confi dential to PM C-Sierra, Inc. 58 Document ID: PMC- 2010419, Issue 1 Side Effects C hanges the DE VICE state to SUNI4x622_PRESENT A ctivating a Device: suni 4x622A ctivate This func tion re stores th e state of a device a fter a de- activate. Inter rupts m ay b[...]

PM5358 S/UNI-4x 622 Driver Manual Application Program ming Interface Proprietary and Confi dential to PM C-Sierra, Inc. 59 Document ID: PMC- 2010419, Issue 1 4.4 Device Read and W rite Reading from Dev ice Registers: suni4x62 2Read This func tion reads a reg ister of a spec ific S /UNI-4x622 dev ice by provid ing the reg ister num ber . This func t[...]

PM5358 S/UNI-4x 622 Driver Manual Application Program ming Interface Proprietary and Confi dential to PM C-Sierra, Inc. 60 Document ID: PMC- 2010419, Issue 1 Failure = 0 V alid S tates SUNI4x622_PRESENT, SUNI4x622_ACTIVE, SUNI4x622_INACTIVE Side Effects May change the config uration of the dev ice Reading from a blo ck of Dev ice Registers: suni 4x[...]

PM5358 S/UNI-4x 622 Driver Manual Application Program ming Interface Proprietary and Confi dential to PM C-Sierra, Inc. 61 Document ID: PMC- 2010419, Issue 1 Inputs deviceHandle : device handle (from suni4x622Add ) startRegNum : starting registe r number size : s ize of bl ock t o re ad pblock : (poin ter to) bl ock to wr ite pmask : ( poi nte r to[...]

PM5358 S/UNI-4x 622 Driver Manual Application Program ming Interface Proprietary and Confi dential to PM C-Sierra, Inc. 62 Document ID: PMC- 2010419, Issue 1 Reading and Sett ing the Section T race Mess age : suni4x 622SOHT raceMsg This function re triev es and sets the se ction tra ce messag e (J0) in th e Sonet/SDH S ection Trac e Buffer . Note: [...]

PM5358 S/UNI-4x 622 Driver Manual Application Program ming Interface Proprietary and Confi dential to PM C-Sierra, Inc. 63 Document ID: PMC- 2010419, Issue 1 SUNI4x622_ERR_INVALID_CHAN V alid S tates SUNI4x622_ACTIVE, SUNI4x622_INACTIVE Side Effects None Forcing B1 Error: suni4x 622SOHForceB1 This func tion in serts the B 1 BIP-8 erro rs byte to be[...]

PM5358 S/UNI-4x 622 Driver Manual Application Program ming Interface Proprietary and Confi dential to PM C-Sierra, Inc. 64 Document ID: PMC- 2010419, Issue 1 Forcing LOS: suni4x622S OHForceLOS When the enab le flag is set, t his funct ion forces a loss of s ignal co ndition in the da ta stream . When the enab le flag is not se t, this fun ction res[...]

PM5358 S/UNI-4x 622 Driver Manual Application Program ming Interface Proprietary and Confi dential to PM C-Sierra, Inc. 65 Document ID: PMC- 2010419, Issue 1 SUNI4x622_ERR_INVALID_ARG V alid S tates SUNI4x622_ACTIVE, SUNI4x622_INACTIVE Side Effects None Configuring SD Error Monito r: suni4x622LOHSDC fg This func tion con figures th e Signal Def ect[...]

PM5358 S/UNI-4x 622 Driver Manual Application Program ming Interface Proprietary and Confi dential to PM C-Sierra, Inc. 66 Document ID: PMC- 2010419, Issue 1 Side Effects None Reading the K1K 2 By te: suni4x622LOHReadK 1K2 This func tion reads the K1K2 by te from the line overhead. Pro totype INT4 suni4x622LOHReadK1K2(sSUNI4x622_HNDL deviceHandle, [...]

PM5358 S/UNI-4x 622 Driver Manual Application Program ming Interface Proprietary and Confi dential to PM C-Sierra, Inc. 67 Document ID: PMC- 2010419, Issue 1 Reading the S 1 By te: suni4x622LOHR eadS1 This func tion reads the S1 by te from the line ov erhead. Pro totype INT4 suni4x622LOHReadS1(sSUNI4x622_HNDL deviceHandle, UINT1 channel, UINT1 *pS1[...]

PM5358 S/UNI-4x 622 Driver Manual Application Program ming Interface Proprietary and Confi dential to PM C-Sierra, Inc. 68 Document ID: PMC- 2010419, Issue 1 Inputs deviceHandle : device handle (from suni4x622Add ) channel : channel num ber enable : flag to s tart/st op B2 erro r insert ion Outpu ts None Retur ns Success = SUNI4x622_SUCCESS Failure[...]

PM5358 S/UNI-4x 622 Driver Manual Application Program ming Interface Proprietary and Confi dential to PM C-Sierra, Inc. 69 Document ID: PMC- 2010419, Issue 1 Retriev ing and Setting t he Path T race Messages : suni4x62 2POHT raceMsg This func tion re trieves a nd sets the curren t path tr ace messag e in th e Sonet/SDH Path T race Buf fer . Note : [...]

PM5358 S/UNI-4x 622 Driver Manual Application Program ming Interface Proprietary and Confi dential to PM C-Sierra, Inc. 70 Document ID: PMC- 2010419, Issue 1 V alid S tates SUNI4x622_ACTIVE, SUNI4x622_INACTIVE Side Effects None Writ ing the C2 By te: suni4x622TPOH WriteC 2 This func tion write s the C2 byte into th e path overh ead. Pro totype INT4[...]

PM5358 S/UNI-4x 622 Driver Manual Application Program ming Interface Proprietary and Confi dential to PM C-Sierra, Inc. 71 Document ID: PMC- 2010419, Issue 1 Writ ing SS Bit s: suni4x622TPOH Writ eSS This func tion write s the passed SS bits (SS[1 :0]) in t he SS bit pos itions. Pro totype INT4 suni4x622TPOHWriteSS(sSUNI4x622_HNDL deviceHandle, UIN[...]

PM5358 S/UNI-4x 622 Driver Manual Application Program ming Interface Proprietary and Confi dential to PM C-Sierra, Inc. 72 Document ID: PMC- 2010419, Issue 1 Pro totype INT4 suni4x622THPPForceB3(sSUNI4x622_HNDL deviceHandle, UINT1 channel, UINT2 enable) Inputs deviceHandle : device handle (from suni4x622Add ) channel : channel num ber enable : flag[...]

PM5358 S/UNI-4x 622 Driver Manual Application Program ming Interface Proprietary and Confi dential to PM C-Sierra, Inc. 73 Document ID: PMC- 2010419, Issue 1 Inputs deviceHandle : device handle (from suni4x622Add ) channel : channel num ber enable : flag to s tart/stop pa th RDI insertion Outpu ts None Retur ns Success = SUNI4x622_SUCCESS Failure =[...]

PM5358 S/UNI-4x 622 Driver Manual Application Program ming Interface Proprietary and Confi dential to PM C-Sierra, Inc. 74 Document ID: PMC- 2010419, Issue 1 Outpu ts None Retur ns Success = SUNI4x622_SUCCESS Failure = SUNI4x622_ERR_INVALID_DEVICE_STATE SUNI4x622_ERR_INVALID_DEV SUNI4x622_ERR_INVALID_CHAN V alid S tates SUNI4x622_ACTIVE, SUNI4x622_[...]

PM5358 S/UNI-4x 622 Driver Manual Application Program ming Interface Proprietary and Confi dential to PM C-Sierra, Inc. 75 Document ID: PMC- 2010419, Issue 1 ppyldcfg : (poin ter to) pay load config uration pa rameter s Outpu ts None Retur ns Success = SUNI4x622_SUCCESS Failure = SUNI4x622_ERR_INVALID_DEVICE_STATE SUNI4x622_ERR_INVALID_DEV SUNI4x62[...]

PM5358 S/UNI-4x 622 Driver Manual Application Program ming Interface Proprietary and Confi dential to PM C-Sierra, Inc. 76 Document ID: PMC- 2010419, Issue 1 Inputs deviceHandle : device handle (from suni4x622Add ) channel : channel num ber pfifocfg : (poin ter to) FI FO configurat ion block Outpu ts None Retur ns Success = SUNI4x622_SUCCESS Failur[...]

PM5358 S/UNI-4x 622 Driver Manual Application Program ming Interface Proprietary and Confi dential to PM C-Sierra, Inc. 77 Document ID: PMC- 2010419, Issue 1 Outpu ts None Retur ns Success = SUNI4x622_SUCCESS Failure = SUNI4x622_ERR_INVALID_DEVICE_STATE SUNI4x622_ERR_INVALID_DEV SUNI4x622_ERR_INVALID_ARG V alid S tates SUNI4x622_ACTIVE, SUNI4x622_I[...]

PM5358 S/UNI-4x 622 Driver Manual Application Program ming Interface Proprietary and Confi dential to PM C-Sierra, Inc. 78 Document ID: PMC- 2010419, Issue 1 4.10 Automatic P rotection Configuration The Automati c Protect ion Configura tion section is respon sible for con figuring the S/UNI -4x622 to use the APS ports. Configuring A PS Working/Prot[...]

PM5358 S/UNI-4x 622 Driver Manual Application Program ming Interface Proprietary and Confi dential to PM C-Sierra, Inc. 79 Document ID: PMC- 2010419, Issue 1 Configuring the Source Channel for the Giv en Channel T ransmit Path: suni4x622T PCfg The function is used to co ntr ol the sou rce chann el for the transm it path. Pro totype INT4 suni4x622TP[...]

PM5358 S/UNI-4x 622 Driver Manual Application Program ming Interface Proprietary and Confi dential to PM C-Sierra, Inc. 80 Document ID: PMC- 2010419, Issue 1 deviceHandle, UINT1 link) Inputs deviceHandle : device handle (from suni4x622Add ) link : APS link num ber Outpu ts None Retur ns Success = SUNI4x622_SUCCESS Failure = SUNI4x622_ERR_INVALID_DE[...]

PM5358 S/UNI-4x 622 Driver Manual Application Program ming Interface Proprietary and Confi dential to PM C-Sierra, Inc. 81 Document ID: PMC- 2010419, Issue 1 Configuring ISR Processing: suni4x6 22ISRConfig Allows the USER to con figure how I SR processing is to be handled: po lling ( SUNI4x622_POLL_MODE ) or in terrupt d riven ( SUNI4x622_ISR_MODE [...]

PM5358 S/UNI-4x 622 Driver Manual Application Program ming Interface Proprietary and Confi dential to PM C-Sierra, Inc. 82 Document ID: PMC- 2010419, Issue 1 Pro totype INT4 suni4x622SetMask(sSUNI4x622_HNDL deviceHandle, sSUNI4x622_MASK_ISR *pmask) Inputs deviceHandle : device handle (from suni4x622Add ) pmask : (poin ter to) m ask structure Outpu [...]

PM5358 S/UNI-4x 622 Driver Manual Application Program ming Interface Proprietary and Confi dential to PM C-Sierra, Inc. 83 Document ID: PMC- 2010419, Issue 1 pmask : (poin ter to) m ask structure Outpu ts pmask : (poin ter to) upd ated m ask structure Retur ns Success = SUNI4x622_SUCCESS Failure = SUNI4x622_ERR_INVALID_DEVICE_STATE SUNI4x622_ERR_IN[...]

PM5358 S/UNI-4x 622 Driver Manual Application Program ming Interface Proprietary and Confi dential to PM C-Sierra, Inc. 84 Document ID: PMC- 2010419, Issue 1 Outpu ts None Retur ns Success = SUNI4x622_SUCCESS Failure = SUNI4x622_ERR_INVALID_DEVICE_STATE SUNI4x622_ERR_INVALID_DEV SUNI4x622_ERR_INVALID_CHAN SUNI4x622_ERR_INVALID_ARG V alid S tates SU[...]

PM5358 S/UNI-4x 622 Driver Manual Application Program ming Interface Proprietary and Confi dential to PM C-Sierra, Inc. 85 Document ID: PMC- 2010419, Issue 1 Outpu ts None Retur ns Success = SUNI4x622_SUCCESS Failure = SUNI4x622_ERR_INVALID_DEVICE_STATE SUNI4x622_ERR_INVALID_DEV SUNI4x622_ERR_INVALID_CHAN SUNI4x622_ERR_INVALID_ARG V alid S tates SU[...]

PM5358 S/UNI-4x 622 Driver Manual Application Program ming Interface Proprietary and Confi dential to PM C-Sierra, Inc. 86 Document ID: PMC- 2010419, Issue 1 Outpu ts pmask : (poin ter to) upd ated m ask structure Retur ns Success = SUNI4x622_SUCCESS Failure = SUNI4x622_ERR_INVALID_DEVICE_STATE SUNI4x622_ERR_INVALID_DEV SUNI4x622_ERR_INVALID_CHAN S[...]

PM5358 S/UNI-4x 622 Driver Manual Application Program ming Interface Proprietary and Confi dential to PM C-Sierra, Inc. 87 Document ID: PMC- 2010419, Issue 1 Outpu ts None Retur ns Success = SUNI4x622_SUCCESS Failure = SUNI4x622_ERR_INVALID_DEVICE_STATE SUNI4x622_ERR_INVALID_DEV SUNI4x622_ERR_INVALID_CHAN SUNI4x622_ERR_INVALID_ARG V alid S tates SU[...]

PM5358 S/UNI-4x 622 Driver Manual Application Program ming Interface Proprietary and Confi dential to PM C-Sierra, Inc. 88 Document ID: PMC- 2010419, Issue 1 Outpu ts None Retur ns Success = SUNI4x622_SUCCESS Failure = SUNI4x622_ERR_INVALID_DEVICE_STATE SUNI4x622_ERR_INVALID_DEV SUNI4x622_ERR_INVALID_CHAN SUNI4x622_ERR_INVALID_ARG V alid S tates SU[...]

PM5358 S/UNI-4x 622 Driver Manual Application Program ming Interface Proprietary and Confi dential to PM C-Sierra, Inc. 89 Document ID: PMC- 2010419, Issue 1 Outpu ts pmask : (poin ter to) upd ated m ask structure Retur ns Success = SUNI4x622_SUCCESS Failure = SUNI4x622_ERR_INVALID_DEVICE_STATE SUNI4x622_ERR_INVALID_DEV SUNI4x622_ERR_INVALID_CHAN S[...]

PM5358 S/UNI-4x 622 Driver Manual Application Program ming Interface Proprietary and Confi dential to PM C-Sierra, Inc. 90 Document ID: PMC- 2010419, Issue 1 Outpu ts None Retur ns Success = SUNI4x622_SUCCESS Failure = SUNI4x622_ERR_INVALID_DEVICE_STATE SUNI4x622_ERR_INVALID_DEV SUNI4x622_ERR_INVALID_CHAN SUNI4x622_ERR_INVALID_ARG V alid S tates SU[...]

PM5358 S/UNI-4x 622 Driver Manual Application Program ming Interface Proprietary and Confi dential to PM C-Sierra, Inc. 91 Document ID: PMC- 2010419, Issue 1 Outpu ts pmask : (poin ter to) upd ated m ask structure Retur ns Success = SUNI4x622_SUCCESS Failure = SUNI4x622_ERR_INVALID_DEVICE_STATE SUNI4x622_ERR_INVALID_DEV SUNI4x622_ERR_INVALID_CHAN S[...]

PM5358 S/UNI-4x 622 Driver Manual Application Program ming Interface Proprietary and Confi dential to PM C-Sierra, Inc. 92 Document ID: PMC- 2010419, Issue 1 Retur ns Success = SUNI4x622_SUCCESS Failure = SUNI4x622_ERR_INVALID_DEVICE_STATE SUNI4x622_ERR_INVALID_DEV SUNI4x622_ERR_INVALID_ARG V alid S tates SUNI4x622_ACTIVE, SUNI4x622_INACTIVE Side E[...]

PM5358 S/UNI-4x 622 Driver Manual Application Program ming Interface Proprietary and Confi dential to PM C-Sierra, Inc. 93 Document ID: PMC- 2010419, Issue 1 Side Effects May change the opera tion of the I SR / DPR Getting A P S Interrupt E n a ble Mask : suni4x62 2GetMask APS This func tion retu rns the contents of th e APS inte rrupt m ask regist[...]

PM5358 S/UNI-4x 622 Driver Manual Application Program ming Interface Proprietary and Confi dential to PM C-Sierra, Inc. 94 Document ID: PMC- 2010419, Issue 1 Clearing APS Interrupt Enable Mask: suni4x62 2ClrMaskA PS This func tion clea rs the cont ents of the APS interrupt m ask registers o f the S/UNI- 4x622 device. Pro totype INT4 suni4x622ClrMas[...]

PM5358 S/UNI-4x 622 Driver Manual Application Program ming Interface Proprietary and Confi dential to PM C-Sierra, Inc. 95 Document ID: PMC- 2010419, Issue 1 Interrupt-Serv ice Routine: suni4x6 22ISR This functio n reads the st ate of the inter rup t reg isters in the S/UNI- 4x622 and stores them in an ISV . Perform s whatever functions are need ed[...]

PM5358 S/UNI-4x 622 Driver Manual Application Program ming Interface Proprietary and Confi dential to PM C-Sierra, Inc. 96 Document ID: PMC- 2010419, Issue 1 V alid S tates SUNI4x622_ACTIVE Side Effects None Pseudocode Begin for each I SV element (se ction) get and fill ou t a DPV buf fer if callba ck (from suni4x622Init ) is not NULL in voke ( sec[...]

PM5358 S/UNI-4x 622 Driver Manual Application Program ming Interface Proprietary and Confi dential to PM C-Sierra, Inc. 97 Document ID: PMC- 2010419, Issue 1 pstatusSOH : ( poi nte r to) SOH s tat us b loc k Outpu ts pstatusSOH : ( poi nter to) upda ted S OH s tat us bl ock Retur ns Success = SUNI4x622_SUCCESS Failure = SUNI4x622_ERR_INVALID_DEVICE[...]

PM5358 S/UNI-4x 622 Driver Manual Application Program ming Interface Proprietary and Confi dential to PM C-Sierra, Inc. 98 Document ID: PMC- 2010419, Issue 1 Retur ns Success = SUNI4x622_SUCCESS Failure = SUNI4x622_ERR_INVALID_DEVICE_STATE SUNI4x622_ERR_INVALID_DEV SUNI4x622_ERR_INVALID_CHAN SUNI4x622_ERR_INVALID_ARG V alid S tates SUNI4x622_ACTIVE[...]

PM5358 S/UNI-4x 622 Driver Manual Application Program ming Interface Proprietary and Confi dential to PM C-Sierra, Inc. 99 Document ID: PMC- 2010419, Issue 1 SUNI4x622_ERR_INVALID_CHAN SUNI4x622_ERR_INVALID_ARG V alid S tates SUNI4x622_ACTIVE, SUNI4x622_INACTIVE Side Effects None Getting the Device Count s: suni4x622GetCount sChan This function re [...]

PM5358 S/UNI-4x 622 Driver Manual Application Program ming Interface Proprietary and Confi dential to PM C-Sierra, Inc. 100 Document ID: PMC- 2010419, Issue 1 V alid S tates SUNI4x622_ACTIVE, SUNI4x622_INACTIVE Side Effects None Getting the Device Count s: suni4x622GetCount sLOH This function re trieves al l the LOH counts. Pro totype INT4 suni4x62[...]

PM5358 S/UNI-4x 622 Driver Manual Application Program ming Interface Proprietary and Confi dential to PM C-Sierra, Inc. 101 Document ID: PMC- 2010419, Issue 1 Side Effects None Getting the Device Count s: suni4x622GetCount sPYLD This function re triev es all th e PYLD counts. Pro totype INT4 suni4x622GetCountsPYLD(sSUNI4x622_HNDL deviceHandle, UINT[...]

PM5358 S/UNI-4x 622 Driver Manual Application Program ming Interface Proprietary and Confi dential to PM C-Sierra, Inc. 102 Document ID: PMC- 2010419, Issue 1 Enabling Line Loopbacks: suni4 x622DiagLineLoop This func tion clea rs / sets a Line Loopb ack. I t is up to the USER to p erform any tests on the looped da ta. Pro totype INT4 suni4x622DiagL[...]

PM5358 S/UNI-4x 622 Driver Manual Application Program ming Interface Proprietary and Confi dential to PM C-Sierra, Inc. 103 Document ID: PMC- 2010419, Issue 1 Pro totype INT4 suni4x622DiagDataLoop(sSUNI4x622_HNDL deviceHandle, UINT1 channel, UINT2 enable) Inputs deviceHandle : device handle (from suni4x622Add ) channel : channel num ber enable : se[...]

PM5358 S/UNI-4x 622 Driver Manual Application Program ming Interface Proprietary and Confi dential to PM C-Sierra, Inc. 104 Document ID: PMC- 2010419, Issue 1 channel : channel num ber enable : sets loop if non- zero, else clears lo op Outpu ts None Retur ns Success = SUNI4x622_SUCCESS Failure = SUNI4x622_ERR_INVALID_DEVICE_STATE SUNI4x622_ERR_INVA[...]

PM5358 S/UNI-4x 622 Driver Manual Application Program ming Interface Proprietary and Confi dential to PM C-Sierra, Inc. 105 Document ID: PMC- 2010419, Issue 1 V alid S tates SUNI4x622_ACTIVE Side Effects None Notify ing the Application of LOH Ev ent s: cbackSuni4x622LOH This callba ck function is p rovided by the USER and is u sed by the DPR to rep[...]

PM5358 S/UNI-4x 622 Driver Manual Application Program ming Interface Proprietary and Confi dential to PM C-Sierra, Inc. 106 Document ID: PMC- 2010419, Issue 1 Side Effects None Notify ing the Application of PYLD Event s: cbackSuni4x622PY LD This callba ck function is p r ovided by the USER and is u sed by the DPR to repor t significan t PYLD sectio[...]

PM5358 S/UNI-4x 622 Driver Manual Application Program ming Interface Proprietary and Confi dential to PM C-Sierra, Inc. 107 Document ID: PMC- 2010419, Issue 1 Notify ing the Application of FIFO Ev ent s: cbackSuni4x622FIFO This callba ck function is p rovided by the USER and is u sed by the DPR to report s ignifican t FIFO section ev ents back to t[...]

PM5358 S/UNI-4x 622 Driver Manual Hardware Interfa ce Proprietary and Confi dential to PM C-Sierra, Inc. 108 Document ID: PMC- 2010419, Issue 1 5 H A RDW A R E I NTERF ACE The S/UNI -4x622 driv er interf aces direc tly with the USER’ s hardware. I n this section, a lis ting of each poin t of inte rface is shown, along with a dec laration and any [...]

PM5358 S/UNI-4x 622 Driver Manual Hardware Interfa ce Proprietary and Confi dential to PM C-Sierra, Inc. 109 Document ID: PMC- 2010419, Issue 1 Polling a Bit: sy sSuni4x622PollBit This function s imply polls a register m asked data until it is zero or tim es out. For mat #define sysSuni4x622PollBit (base, offset, mask) Pro totype INT4 sysSuni4x622P[...]

PM5358 S/UNI-4x 622 Driver Manual Hardware Interfa ce Proprietary and Confi dential to PM C-Sierra, Inc. 1 10 Document ID: PMC- 2010419, Issue 1 Failure = <a ny other v alue> Pseudocode Begin install sysSuni4x622ISRHandler in p roce ssor ’ s in terr upt vecto r ta ble End ISR Handler: sy sSuni4x622ISRHandler This routine is inv oked when on[...]

PM5358 S/UNI-4x 622 Driver Manual Hardware Interfa ce Proprietary and Confi dential to PM C-Sierra, Inc. 1 1 1 Document ID: PMC- 2010419, Issue 1 End Remov ing the ISR Handler: sy sSuni4x622ISRHandlerRemov e This func tion disab les Interr upt proce ssing for t his device. Remov es the USER-supplied In terrupt-Serv ice Routin e (ISR), sysSuni4x622I[...]

PM5358 S/UNI-4x 622 Driver Manual RTOS Interfac e Proprietary and Confi dential to PM C-Sierra, Inc. 1 12 Document ID: PMC- 2010419, Issue 1 6 RT OS I NTERF ACE The S/UNI- 4x622 driver requi res the use of som e R TOS resources. I n this sec tion, a listin g of each requ ired resou rce is shown, a long with a declara tion and any specific porting i[...]

PM5358 S/UNI-4x 622 Driver Manual RTOS Interfac e Proprietary and Confi dential to PM C-Sierra, Inc. 1 13 Document ID: PMC- 2010419, Issue 1 Pro totype void sysSuni4x622MemSet(UINT1 *pdst, UINT1 *psrc, UINT2 sz) Inputs pdst : (pointer to) th e destina tion m e mo ry psrc : ( poi nte r to) the sour ce memo ry sz : size Outpu ts None Retur ns None Fr[...]

PM5358 S/UNI-4x 622 Driver Manual RTOS Interfac e Proprietary and Confi dential to PM C-Sierra, Inc. 1 14 Document ID: PMC- 2010419, Issue 1 Failure = <a ny other v alue> Getting an ISV B uffer: sy sSuni4x622ISVBufferGet This func tion gets a buff er from the R T OS that will b e used by the I SR code to create an Interrupt- Service V ector ([...]

PM5358 S/UNI-4x 622 Driver Manual RTOS Interfac e Proprietary and Confi dential to PM C-Sierra, Inc. 1 15 Document ID: PMC- 2010419, Issue 1 Returning a DPV Buf fer: sy sSuni4x622DPVBuff erRtn This function re turns a DPV buf fer to th e R TOS when the info rmation in the block is no longer needed by the DPR. For mat #define sysSuni4x622DPVBufferRt[...]

PM5358 S/UNI-4x 622 Driver Manual RTOS Interfac e Proprietary and Confi dential to PM C-Sierra, Inc. 1 16 Document ID: PMC- 2010419, Issue 1 6.4 Preemption Disabling Preemption : sy sSuni4x622PreemptDis able This routine prev ents the calling task from being preem pted. I f the driver is in inte rrupt m ode, this routine lock s out a ll inter rupts[...]

PM5358 S/UNI-4x 622 Driver Manual Porting the S/UNI- 4x622 Driv er Proprietary and Confi dential to PM C-Sierra, Inc. 1 17 Document ID: PMC- 2010419, Issue 1 7 P ORTING THE S/UNI-4 X 622 D RIVER This section outlines h ow to port th e S/UNI- 4x622 device driver t o your hardwar e and OS platform . However , this manual can o ffe r only g uidelines [...]

PM5358 S/UNI-4x 622 Driver Manual Porting the S/UNI- 4x622 Driv er Proprietary and Confi dential to PM C-Sierra, Inc. 1 18 Document ID: PMC- 2010419, Issue 1 Procedure 1: Porting Driv er OS Extensions The OS extensions encapsula te all OS spec ific se rvices a nd data ty pes used by the d riv er . The suni4x622_rtos.h file conta ins data ty pes and[...]

PM5358 S/UNI-4x 622 Driver Manual Porting the S/UNI- 4x622 Driv er Proprietary and Confi dential to PM C-Sierra, Inc. 1 19 Document ID: PMC- 2010419, Issue 1 sysSuni4x622ISRHandlerIntInstall In stalls the in ter rup t handler for the OS sysSuni4x622ISRHandlerRemove Rem oves the interr upt handler from the OS sysSuni4x622ISRHandler In terrupt handle[...]

PM5358 S/UNI-4x 622 Driver Manual Porting the S/UNI- 4x622 Driv er Proprietary and Confi dential to PM C-Sierra, Inc. 120 Document ID: PMC- 2010419, Issue 1 SUNI4x622_DPR_TASK_STACK_SZ DPR task stack size, in by tes 8192 SUNI4x622_POLL_DELAY The con stant used in polling task m ode defines the interv al tim e in milli second between ea ch polling a[...]

PM5358 S/UNI-4x 622 Driver Manual Appendix A: Coding Conventions Proprietary and Confi dential to PM C-Sierra, Inc. 121 Document ID: PMC- 2010419, Issue 1 A PPENDIX A: C ODING C ONVENTIONS This sec tion descr ibes the cod ing conv entions used in the im plementation of al l PMC- Sierra dri ver s oftware . V ariable T ype Definiti ons T able 38: V a[...]

PM5358 S/UNI-4x 622 Driver Manual Appendix A: Coding Conventions Proprietary and Confi dential to PM C-Sierra, Inc. 122 Document ID: PMC- 2010419, Issue 1 Type Case Naming convention Examples Functions Notation Porting Functions Hungarian Notation prefix with “sys” and de vic e n ame sysSuni4x622Read() Other Functions Hungarian Notation utilSun[...]

PM5358 S/UNI-4x 622 Driver Manual Appendix A: Coding Conventions Proprietary and Confi dential to PM C-Sierra, Inc. 123 Document ID: PMC- 2010419, Issue 1 Functions API Functions • Naming of the API functions must fo llow the hung arian nota tion • The device ’ s full n ame in all l owercase sha ll be us ed as a pre fix • Example: suni4x622[...]

PM5358 S/UNI-4x 622 Driver Manual Appendix A: Coding Conventions Proprietary and Confi dential to PM C-Sierra, Inc. 124 Document ID: PMC- 2010419, Issue 1 T able 44: File Na ming Convention s API (Module and Device Managem ent) suni4x622_api.c Generic driv er API block , contains Mod ule & Device Man agem ent API such as installing /de- install[...]

PM5358 S/UNI-4x 622 Driver Manual Appendix B: Error Codes Proprietary and Confi dential to PM C-Sierra, Inc. 125 Document ID: PMC- 2010419, Issue 1 A PPENDIX B: E RROR C ODES The follow i ng desc ribes the error codes used in the S/UNI 4x622 device driv er SUNI4x622_SUCCESS Success SUNI4x622_FAILURE Failure SUNI4x622_ERR_MEM_ALLOC Memory allocation[...]

PM5358 S/UNI-4x 622 Driver Manual Appendix C: S/UNI-4x622 Event s Proprietary and Confi dential to PM C-Sierra, Inc. 126 Document ID: PMC- 2010419, Issue 1 A PPENDIX C: S/UNI-4 X 622 E VENTS Section Ov erhead Event s (SOH) Error Code Description SUNI4x622_EVENT_SOH_OOF Out Of Fram e event SUNI4x622_EVENT_SOH_LOF Loss Of Fram e event SUNI4x622_EVENT[...]

PM5358 S/UNI-4x 622 Driver Manual Appendix C: S/UNI-4x622 Event s Proprietary and Confi dential to PM C-Sierra, Inc. 127 Document ID: PMC- 2010419, Issue 1 Path Ov erhead Event s (RPOH) Error Code Description SUNI4x622_EVENT_RPOH_TIU Path T race Un stable ev ent SUNI4x622_EVENT_RPOH_TIM Path T race Mismatch event SUNI4x622_EVENT_RPOH_PSLMI Path Sig[...]

PM5358 S/UNI-4x 622 Driver Manual Appendix C: S/UNI-4x622 Event s Proprietary and Confi dential to PM C-Sierra, Inc. 128 Document ID: PMC- 2010419, Issue 1 Payload Event s (PYLD) Error Code Description SUNI4x622_EVENT_PYLD_LCD Loss of Cel l Delineat ion event SUNI4x622_EVENT_PYLD_CHCS Correcte d/Unc orrected HC S erro r event SUNI4x622_EVENT_PYLD_F[...]

PM5358 S/UNI-4x 622 Driver Manual Appendix C: S/UNI-4x622 Event s Proprietary and Confi dential to PM C-Sierra, Inc. 129 Document ID: PMC- 2010419, Issue 1 Error Code Description packet SUNI4x622_EVENT_SYS_INTF_UNPROV event th at occurs when a non- existent ch annel buffe r is detec ted during in-band addr essing SUNI4x622_EVENT_SYS_INTF_CAM data f[...]

PM5358 S/UNI-4x 622 Driver Manual Proprietary and Confi dential to PM C-Sierra, Inc. 130 Document ID: PMC- 2010419, Issue 1 L IST OF T ERMS APPLICA TION: Refers to pro tocol softw are used in a real system as well as val idation softw are written to v alidate the S/UNI- 4x622 driver on a v alidatio n platform . API (Applicat ion Prog ramm ing Inter[...]

PM5358 S/UNI-4x 622 Driver Manual Proprietary and Confi dential to PM C-Sierra, Inc. 131 Document ID: PMC- 2010419, Issue 1 A CRONYMS API: Applicat ion Prog ramming Interface APS: Automatic Protection Switch A T M: Asyn chronous Tran sfer Mode DDB: Device Data Block DIV : Dev ice Initi alizatio n V ector DPR: Deferred- Processing Routine DPV : Defe[...]

PM5358 S/UNI-4x 622 Driver Manual Proprietary and Confi dential to PM C-Sierra, Inc. 132 Document ID: PMC- 2010419, Issue 1 I NDEX A api functions suni4x622Acti vate-58 suni4x622Add-34, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84, 85, 86, 87, 88, 89, 90, 91, 92, 93, 94, 95, [...]

PM5358 S/UNI-4x 622 Driver Manual Proprietary and Confi dential to PM C-Sierra, Inc. 133 Document ID: PMC- 2010419, Issue 1 suni4x622RPCfg-78 suni4x622RPOHSDCf g-65 suni4x622RPOHSFCfg-64 suni4x622RPOHTraceMsg-69 suni4x622SetIni tProfile-27 suni4x622SetMask -28, 81, 82 suni4x622SetMask APS-93 suni4x622SetMaskF IFO-89 suni4x622SetMask Intf-92 suni4x6[...]

PM5358 S/UNI-4x 622 Driver Manual Proprietary and Confi dential to PM C-Sierra, Inc. 134 Document ID: PMC- 2010419, Issue 1 SUNI4x622_EVENT_INTF_SYS_FUNR-129 SUNI4x622_EVENT_INTF_SYS_TPRTY-129 SUNI4x622_EVENT_INTF_SYS_TSOC-129 SUNI4x622_EVENT_INTF_SYS_TXOP-128 SUNI4x622_EVENT_I NTF_SYS_UNPROV-129 SUNI4x622_EVENT_LOH_COA PS-126 SUNI4x622_EVENT_LOH_C[...]

PM5358 S/UNI-4x 622 Driver Manual Proprietary and Confi dential to PM C-Sierra, Inc. 135 Document ID: PMC- 2010419, Issue 1 suni4x622_strs. h-124 suni4x622_typs.h-124 src file suni4x622_api.c-124 suni4x622_aps.c -124 suni4x622_diag.c-124 suni4x622_hw.c-118, 124 suni4x622_intf. c-124 suni4x622_isr.c -124 suni4x622_loh.c-124 suni4x622_poh.c-124 suni4[...]

PM5358 S/UNI-4x 622 Driver Manual Proprietary and Confi dential to PM C-Sierra, Inc. 136 Document ID: PMC- 2010419, Issue 1 sSUNI4x622_CFG_RPOH-36, 38 sSUNI4x622_CFG_SD-44, 65 sSUNI4x622_CFG_SF-44, 64 sSUNI4x622_CFG_SOH-36, 37 sSUNI4x622_CFG_TPOH-36, 38 sSUNI 4x622_CNTR_CHAN-48, 99 sSUNI4x622_CNTR_LOH-48, 49, 100 sSUNI4x622_CNTR_PYLD-48, 49, 101 sS[...]