Initialization, Creation and Termination functions


Functions

THandle CuCmd_Create (const PS8 device_name, THandle hConsole, S32 BypassSupplicant, PS8 pSupplIfFile)
 Creates the command module.
VOID CuCmd_Destroy (THandle hCuCmd)
 Destroys the command module.
VOID CuCmd_StartDriver (THandle hCuCmd)
 Starts the driver.
VOID CuCmd_StopDriver (THandle hCuCmd)
 Stops the driver.
S32 CuCmd_GetDeviceStatus (THandle hCuCmd)
 Gets the driver status.
THandle CuCmd_GetCuCommonHandle (THandle hCuCmd)
 Gets the CU Common module pointer.
THandle CuCmd_GetCuWpaHandle (THandle hCuCmd)
 Gets the supplicant pointer.

Detailed Description


Function Documentation

THandle CuCmd_Create ( const PS8  device_name,
THandle  hConsole,
S32  BypassSupplicant,
PS8  pSupplIfFile 
)

Creates the command module.

This function performs the following:

  • Allocates memory space for the command module context
  • Creates sub-modules context, such as IPC event module, WEXT module and so on
  • Creates the supplicant context, if a supplicant was loaded
  • Initializes the scan parameters with the default ones

Parameters:
[in] device_name The driver name
[in] hConsole Pointer to the console context
[in] BypassSupplicant Indicates whether or not the supplicant is bypassed (0 - supplicant loaded, 1 - supplicant bypassed)
[in] pSupplIfFile Supplicant *.ini file
Returns:
Command context handle in a case of success; otherwise, returns a NULL pointer
See also:
CuCmd_Destroy()
Note:
Warning:

VOID CuCmd_Destroy ( THandle  hCuCmd  ) 

Destroys the command module.

This function performs the following:

  • Destroys the contexts of the command sub-modules, such as IPC event module, WEXT module, supplicant...
  • Frees the memory allocated for the command module

Parameters:
[in] hCuCmd Handle for the command module
Returns:
None
See also:
CuCmd_Create()
Note:
Warning:

THandle CuCmd_GetCuCommonHandle ( THandle  hCuCmd  ) 

Gets the CU Common module pointer.

This function gets a pointer to a CU Common module and returns it to the caller.

Parameters:
[in] hCuCmd Handle for the command module
Returns:
Pointer to the CU Common module
See also:
Note:
This function is used only when working in CCX mode. The CCX module uses the CU Common pointer in order to get /set CCX-related parameters, such as CCX network EAP, CCX configuration and so on.
Warning:

THandle CuCmd_GetCuWpaHandle ( THandle  hCuCmd  ) 

Gets the supplicant pointer.

This function gets a pointer to the supplicant and returns it to the caller.

Parameters:
[in] hCuCmd Handle for the command module
Returns:
Pointer to the supplicant
See also:
Note:
This function is used only when working in CCX mode. The CCX module uses the supplicant pointer in order to set the CCX mode for the supplicant.
Warning:

S32 CuCmd_GetDeviceStatus ( THandle  hCuCmd  ) 

Gets the driver status.

This function gets the status of the driver and prints it.

Parameters:
[in] hCuCmd Handle for the command module
Returns:
0 in a case of success and the driver is running; otherwise -10
See also:
Note:
Warning:

VOID CuCmd_StartDriver ( THandle  hCuCmd  ) 

Starts the driver.

This function starts the driver operation.

Parameters:
[in] hCuCmd Handle for the command module
Returns:
None
See also:
CuCmd_StopDriver()
Note:
Warning:

VOID CuCmd_StopDriver ( THandle  hCuCmd  ) 

Stops the driver.

This function stops the driver operation.

Parameters:
[in] hCuCmd Handle for the command module
Returns:
None
See also:
CuCmd_StartDriver()
Note:
Warning:


Generated on Sun Dec 6 12:34:02 2009 for WLAN DRIVER API REFERENCE MANUAL by  doxygen 1.5.9