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


 
PM5358 S/UNI-4x622 Driver Manual
Application Programming Interface
Proprietary and Confidential to PMC-Sierra, Inc. 53
Document ID: PMC-2010419, Issue 1
Inputs
None
Outputs
None
Returns
Success =
SUNI4x622_SUCCESS
Failure = SUNI4x622_ERR_INVALID_MODULE_STATE
Valid States
SUNI4x622_MOD_IDLE, SUNI4x622_MOD_READY
Side Effects
Changes the MODULE state to
SUNI4x622_MOD_START
Starting the Driver Module: suni4x622ModuleStart
This function connects the RTOS resources to the driver. This involves allocating semaphores and
timers, initializing buffers and installing the ISR handler and DPR task. Upon successful return
from this function the driver is ready to add devices.
Prototype
INT4 suni4x622ModuleStart(void)
Inputs
None
Outputs
None
Returns
Success =
SUNI4x622_SUCCESS
Failure = SUNI4x622_ERR_INVALID_MODULE_STATE
SUNI4x622_ERR_MEM_ALLOC
SUNI4x622_ERR_INT_INSTALL
Valid States
SUNI4x622_MOD_IDLE
Side Effects
Changes the MODULE state to
SUNI4x622_MOD_READY
Stopping the Driver Module: suni4x622ModuleStop
This function disconnects the RTOS resources from the driver. This involves de-allocating
semaphores and timers, freeing-up buffers and uninstalling the ISR handler and the DPR task. If
there are any registered devices,
suni4x622Delete is called for each.
Prototype
INT4 suni4x622ModuleStop(void)
Inputs
None
Outputs
None
Returns
Success =
SUNI4x622_SUCCESS
Failure = SUNI4x622_ERR_INVALID_MODULE_STATE
Valid States
SUNI4x622_MOD_READY