PMC-Sierra PM5358 S/UNI 4x622 Power Screwdriver User Manual


 
PM5358 S/UNI-4x622 Driver Manual
Proprietary and Confidential to PMC-Sierra, Inc. 5
Document ID: PMC-2010419, Issue 1
3.2 Structures Passed by the Application .........................................................................26
Module Initialization Vector: MIV .............................................................................26
Device Initialization Vector: DIV...............................................................................27
ISR Enable/Disable Mask........................................................................................28
3.3 Structures in the Driver’s Allocated Memory...............................................................33
Module Data Block: MDB.........................................................................................33
Device Data Block: DDB..........................................................................................34
3.4 Structures Passed through RTOS Buffers ..................................................................50
Interrupt-Service Vector: ISV ...................................................................................50
Deferred-Processing Vector: DPV...........................................................................50
3.5 Global Variable............................................................................................................51
4 Application Programming Interface.............................................................................52
4.1 Module Management ..................................................................................................52
Opening the Driver Module: suni4x622ModuleOpen ..............................................52
Closing the Driver Module: suni4x622ModuleClose................................................52
Starting the Driver Module: suni4x622ModuleStart .................................................53
Stopping the Driver Module: suni4x622ModuleStop................................................53
4.2 Profile Management....................................................................................................54
Adding an Initialization Profile: suni4x622AddInitProfile .........................................54
Getting an Initialization Profile: suni4x622GetInitProfile..........................................54
Deleting an Initialization Profile: suni4x622DeleteInitProfile ...................................55
4.3 Device Management...................................................................................................55
Adding a Device: suni4x622Add..............................................................................55
Deleting a Device: suni4x622Delete........................................................................56
Initializing a Device: suni4x622Init...........................................................................56
Updating the Configuration of a Device: suni4x622Update.....................................57
Resetting a Device: suni4x622Reset.......................................................................57
Activating a Device: suni4x622Activate...................................................................58
De-Activating a Device: suni4x622DeActivate ........................................................58
4.4 Device Read and Write ...............................................................................................59
Reading from Device Registers: suni4x622Read....................................................59
Writing to Device Registers: suni4x622Write ..........................................................59
Reading from a block of Device Registers: suni4x622ReadBlock ..........................60
Writing to a Block of Device Registers: suni4x622WriteBlock.................................60
4.5 Section Overhead (SOH)............................................................................................61
Writing the J0 Byte: suni4x622SOHWriteJ0............................................................61
Reading and Setting the Section Trace Message :
suni4x622SOHTraceMsg ..................................................................................62
Forcing A1 Error : suni4x622SOHForceA1..............................................................62
Forcing B1 Error: suni4x622SOHForceB1 ..............................................................63
Forcing OOF: suni4x622SOHForceOOF.................................................................63
Forcing LOS: suni4x622SOHForceLOS..................................................................64
4.6 Line Overhead (LOH)..................................................................................................64
Configuring SF Error Monitor: suni4x622LOHSFCfg ..............................................64
Configuring SD Error Monitor: suni4x622LOHSDCfg..............................................65