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

• 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
Returns
Valid States
Side Effects
Prototype
Retrieving the received messages: nbcsIlcGetRxMsg
This function retrieves one or more ILC messages from the Rx FIFO of one or more links for a
device (SBS or NSE) in the chipset. (A maximum of 8 messages per port can be retrieved each
time this function is called.)
pRxBufDesc
message is to be retrieved. Using the field,
(
the port number from 0 to 31; and in NSE-8G, it is the port number from 0-11) from which to
read, the maximum number of messages to read (
message descriptors (
Each message descriptor contains the location in which the message is to be stored (
the status of the CRC for that message (
This function reads up to
The number of messages actually received is returned to the user in the
buffer descriptor. (Setting
Alternatively, user can supply the function an array of handles, via
SBS devices (size of the array is indicated by
NSE device. This supersedes the
transmitting SBS devices have to be physically attached to the NSE device or an error message
will return if at least one of the SBS devices is not. If a SBS device is receiving rather than a
NSE,
The parameter
payload size in a message is 32 bytes. This function only attempts to read the number of bytes
specified in
the payload is known to be fewer than 32 bytes.
This function does not operate in the context of a group.
linkDesc
pTxHandle
pyldSz
in SBS, indicates whether it is working receive, or protect receive; in NSE-20G, it is
points to an array of
pyldSz
Success =
Failure =
NBCS_ACTIVE, NBCS_INACTIVE
None
INT4 nbcsIlcGetRxMsg (sNBCS_HNDL rxHandle,
sNBCS_HNDL* pTxHandle, sNBCS_RXBUF_DESC_ILC
is ignored in this case.
. This gives the user the ability to avoid reading extra bytes in a message if
pmsgDesc
controls the number of bytes to be read in one message. The maximum
NBCS_ERR_INVALID_DEVICE_STATE
NBCS_ERR_INVALID_ARG
NBCS_ERR_ILC_INVALID_OP
NBCS_ERR_POLL_TIMEOUT
NBCS_ERR_DEV_ABSENT
numMsgs
NBCS_ERR_INVALID_DEV
NBCS_SUCCESS
numMsgs
). (If
linkDesc
numDesc
messages from each link for which a buffer descriptor exists.
to 8 will always read all available messages in the Rx FIFO.)
numMsgs
crc
linkDesc
) (returned by the driver).
field inside the array of
buffer descriptors, one for each link from which a
numDesc
is set to 0, this port will be ignored.)
numMsgs
, each buffer descriptor indicates the link
) that are transmitting to the specified
Narrowband Chipset Device Driver Manual
), and has a pointer to
pTxHandle
Application Programming Interface
pRxBufDesc
numMsgs
, of all the remote
numMsgs
field of the
. All the
pmsg
), and
133