PM8621-BI PMC-Sierra, Inc., PM8621-BI Datasheet - Page 134

• Manufacturer Part Number: PM8621-BI
• Description: Driver, NSE/SBS Narrowband Chipset Driver
• Manufacturer: PMC-Sierra, Inc.

Proprietary and Confidential to PMC-Sierra, Inc., and for its Customers’ Internal Use
Document ID: PMC-2021248, Issue 1
Inputs
Outputs
Returns
Valid States
Side Effects
Prototype
Getting the number of received messages: nbcsIlcGetRxNumMsg
This function queries the total number of messages currently stored in the Rx FIFO for the
specified link. For NSE devices, user can either specify the handle(s) of the transmitting SBS
device via pT
is indicated by
linkDesc
physically attached to this NSE device or an error message will be returned.
User can also retrieve the received message level for a specified port by supplying a NULL
pTxhandle
linkDesc
ports for NSE-8/20G will be returned. The same applies to SBS devices. If NBCS_ALL_LINKS
is provided in
User will have to ensure that
returned values in those cases when number of ports is greater than one.
will be used to indicate the total number of ports to retrieve. The SBS device has to be
equals to NBCS_ALL_LINKS. Number of messages in Rx FIFO from port 1 to 12/32
and a valid
xHandle
linkDesc
linkDesc
*pRxBufDesc, UINT1 numDesc, UINT1 pyldSz)
rxHandle
txHandle
pRxBufDesc
pyldSz
numDesc
pRxBufDesc
Success =
Failure =
NBCS_ACTIVE, NBCS_INACTIVE
None
INT4 nbcsIlcGetRxNumMsg (sNBCS_HNDL rxHandle,
sNBCS_HNDL* pTxHandle, UINT1 linkDesc, UINT1
*pNumRxMsg)
which is a pointer to an array of SBS devices (the number of SBS devices
linkDesc
, RxFIFO level for both the working and protect link will be returned.
NBCS_ERR_INVALID_DEVICE_STATE
NBCS_ERR_INVALID_ARG
NBCS_ERR_ILC_INVALID_OP
NBCS_ERR_POLL_TIMEOUT
NBCS_ERR_DEV_ABSENT
NBCS_ERR_INVALID_DEV
NBCS_SUCCESS
) or the port number via
pTxHandle
(0-11/31 for NSE8/20G), or all ports in an NSE device if
: device handle (from
: (pointer to) array of device handle(s)
: (pointer to) buffer descriptors (this
: payload size (from 1 to 32 bytes)
: number of descriptors
: pointer to buffer descriptor structures
must point to
which include the received messages
and their corresponding CRC status
device receiving messages
(from
transmitting messages to the NSE
is NULL and the buffer is large enough to hold the
nbcsAdd
linkDesc
numDesc
Narrowband Chipset Device Driver Manual
) of the SBS device(s)
. If
nbcsAdd
descriptors)
txHandle
Application Programming Interface
) of the
is non-NULL,
134