NPA_Add_Option

Specifies command line options and configuration information that can be parsed out and registered for this instance of the application.

Requirements: The NPAOptionStruct must be initialized before calling this function.
Thread Context:Non-Blocking

Syntax

    LONG NPA_Add_Option (
       LONG                     npaHandle,
       struct NPAOptionStruct  *option
       );
    
    

Parameters

npaHandle
(IN) The CDM's or HAM's handle for using the NPA APIs, assigned during NPA_Register_CDM_Module or NPA_Register_HAM_Module, respectively.
option
(IN) Points to the NPAOptionStruct associated with this CDM/HAM. The NPAOptionStruct contains information about hardware options associated with this CDM/HAM.

Return Values

The following table lists return values and descriptions.

0

Successful

nonzero

Unsuccessful

-2

Option unavailable (possibly already registered)

Remarks

NPA_Add_Option is used to collect all possible systems resource identifiers that might be passed as valid command line parameters to the driver. While this function can be used by CMDs for registering command line parameters, its primary purpose is to allow HAMs to collect parameters that are related to system resources for registration, such as the bus slot, interrupt, I/O ports, and memory decode options.