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

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

5
5.1
Proprietary and Confidential to PMC-Sierra, Inc., and for its Customers’ Internal Use
Document ID: PMC-2021248, Issue 1
A
This section of the manual provides a detailed description of each function that is a member of
the Narrowband Chipset driver Application Programming Interface (API). API functions typically
execute in the context of an application task.
It is important to note that these functions are not re-entrant. This means that two application
tasks cannot invoke the same API at the same time. However the driver protects its data structures
from concurrent accesses by the application.
Module, Device and Group Management
Module management can be accomplished through the use of a set of API functions that are used
by the Application to open, start, stop and close the driver module. These functions take care of
initializing the driver, allocating memory and requesting all RTOS resources needed by the driver.
They are also used to change the module state. For more information on the module states see the
state diagram on page 48. For a typical module management flow diagram see page 50.
Group management consists of a set of API functions that are used by the Application to define
various groups of devices. The use of this grouping is optional; if future API calls are to be made
at the “group” level of abstraction, however, the groups must be defined using the functions in
this section. A group is considered to be in the same state as its constituent members, if all the
members are in the same state. A group is considered to be in an indeterminate state if its
constituent devices are not all in the same state.
Device management is performed by the use of a set of API functions to control the devices.
These functions take care of initializing a device in a specific configuration, and enabling the
device general activity. They are also used to change the software state for that device. For more
information on the device states see the state diagram on page 48. For a typical device
management flow diagram see page 51.
Some management function can act on either a single device or on a group. These functions
distinguish whether the operation is intended for a device or group by examining the handle given
by the user. For instance,
Note that if group management functions are used, device management functions performed on
devices within groups should be used carefully, as the use of these functions will often cause the
group state to become
For more information on the module and device states see the state diagram on page 48. For
typical module and device management flow diagrams see pages 50 and 51 respectively.
Opening the Driver Module: nbcsModuleOpen
This function performs module level initialization of the chipset device driver. This involves
allocating all of the memory needed by the driver and initializing the internal structures.
PPLICATION
NBCS_INDETERMINATE
nbcsActivate
P
ROGRAMMING
can operate on an individual device or a group.
.
I
Narrowband Chipset Device Driver Manual
NTERFACE
Application Programming Interface
104