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

• 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
Retrieving Current Connection Map: nbcsFmgtGetMap
This function retrieves the current device setting from the OPA. The structure
both as the input and output between user and the CSD. In this structure,
field that allows the user to fill in a valid device handle (returned from
nbcsAdd
that has a different definition for SBS and NSE devices. For SBS device, this field indicates the
direction, 0 = ingress and 1 = egress; for NSE device, this denotes the port number, 0-11 or 31 for
NSE-8G and NSE-20G respectively. If the port number is ffh, settings for all ports will be
retrieved. Lastly, the field
format in the buffer varies depending on the device type.
Upon a successful retrieval, the CSD fills in the
should use to populate the settings to the device (via
indicating the total number of settings returned. For SBS device, this should be either 9720 or
1080 for byte or column mode operation. For NSE device, this should be either 9720 or 1080 for
the two modes on a per port basis. If ffh is specified, this will be one of the four possibilities:
9720/1080 x 32/12 depending on the mode and the NSE type.
The actual settings are copied to the buffer pointed to by
the order is as follows: inSlot[0],…,inSlot[M-1] where M = 9720 or 1080 for byte and column
mode respectively. For NSE device and single port, the order is as follows: inport[0],…,inport[M-
1] where M = 9720 or 1080 for byte and column mode respectively. For NSE device in all port
mode, the order is inport0[0]…inport0[M] inport1[0]…inport1[M]…inportN[0]…inportN[M]
where M = 9719 or 1079 in column or byte mode and N = total number of ports – 1, i.e., 11 or 31
for NSE-8G and NSE-20G respectively.
Table 57 summarizes the definition of all the fields in the header structure for different devices
Table 57: Narrowband Chipset Connection Map Header Definition – Entire Map
Fields
devHndl
devId
/
nbcsGroupAdd
Success =
Failure =
NBCS_INACTIVE, NBCS_ACTIVE, NBCS_PRESENT
None
I/O
input
input
NBCS_ERR_INVALID_DEVICE_STATE
NBCS_ERR_STSW_ACCESS
NBCS_FAILURE
NBCS_ERR_INVALID_DEV
NBCS_SUCCESS
pBuf
) to specify the device to retrieve from. Another input field is
is a pointer to the buffer for holding the actual settings. The data
SBS
device handle
0 = ingress, or 1 =
egress
accMode
nbcsStswMapSlot
Narrowband Chipset Device Driver Manual
pBuf
indicating what access mode user
NSE
device handle
port number: 0-11/31 for NSE-8/20G
or ffh for all ports
, as indicated by the user. For SBS,
Application Programming Interface
devHndl
), and
conMapHdr
numSetting
is an input
devId
serves
144