/* ipwps_ap.h - IPWPS AP header file */
/*
* Copyright (c) 2009 Wind River Systems, Inc.
*
* The right to copy, distribute, modify, or otherwise make use
* of this software may be licensed only pursuant to the terms
* of an applicable Wind River license agreement.
* 
*/

/*
modification history
--------------------
01a,12jun09,mry  Created
*/
#ifndef IPWPS_AP_H
#define IPWPS_AP_H

/*
 ****************************************************************************
 * 1                    DESCRIPTION
 ****************************************************************************
 */



/*
 ****************************************************************************
 * 2                    CONFIGURATION
 ****************************************************************************
 */


/*
 ****************************************************************************
 * 3                    INCLUDE FILES
 ****************************************************************************
 */

#include <ipcom_type.h>
#include <ipcom_cstyle.h>

#ifdef __cplusplus
extern "C" {
#endif

/*
 ****************************************************************************
 * 4                    DEFINES
 ****************************************************************************
 */

/*
 ****************************************************************************
 * 5                    TYPES
 ****************************************************************************
 */


/*
 ****************************************************************************
 * 6                    FUNCTIONS
 ****************************************************************************
 */


/*
 *===========================================================================
 *                    ipwps_ap_init
 *===========================================================================
 * Description: Initializes the ap wps application.
 *   Called by the core module in the ipwpsd context AFTER the wps protocol
 *   init function is called.
 * Parameters:
 * 	 Ipwps_ctx* ctx - A valid configured wps context.
 * Returns:
 *   IPCOM_SUCCESS upon success, otherwise a failure indication
 */
IP_GLOBAL Ip_err ipwps_ap_init
(
		struct Ipwps_ctx_st* ctx
);

/*
 *===========================================================================
 *                    ipwps_ap_shutdown
 *===========================================================================
 * Description: Shuts down the ap wps application.
 *   Called by the core module in the ipwpsd context.
 * Parameters:
 * 	 Ipwps_ctx* ctx - A valid configured wps context.
 * Returns:
 *   IPCOM_SUCCESS upon success, otherwise a failure indication
 */
IP_GLOBAL Ip_err ipwps_ap_shutdown
(
		struct Ipwps_ctx_st* ctx
);

/*
 *===========================================================================
 *                    ipwps_ap_set_selected_registrar
 *===========================================================================
 * Description: Shuts down the ap wps application.
 *   Called by the embedded registrar module when the registrar is started 
 *   or the proxy AP module when it received a SetSelectecRegistrar indication
 *   from a registrar with Selected Registrar set to True.
 * Parameters: 
 * 	 Ipwps_ctx* ctx - A valid configured wps context.
 *   Ip_bool selected - Set to IP_TRUE when the registrar is selected and 
 *     to IP_FALSE when it unselected.
 *   Ipwps_device_pwdid sel_reg_dev_pwdid - Specifies the Selected Registrar's 
 *	   Device Password Id when a selected registrar is set. 
 *	   Ignored if "selected" == IP_FALSE.
 *	 Ip_u16 sel_reg_config_methods - Specifies the Selected Registrar's Config Methods.
 *	   Ignored if "selected" == IP_FALSE.
 * Returns:
 *   IPCOM_SUCCESS upon success, otherwise a failure indication
 */
IP_GLOBAL Ip_err ipwps_ap_set_selected_registrar
(
		struct Ipwps_ctx_st* ctx,
		Ip_bool selected,
		Ipwps_device_pwdid sel_reg_dev_pwdid,
		Ip_u16 sel_reg_config_methods
);

#ifdef IPWPS_DEBUG
/*
 *===========================================================================
 *                    ipwps_ap_debug_show
 *===========================================================================
 * Description: DEBUG ONLY routine to display the internal AP info.
 * Parameters:
 * Returns:
 *
 */
IP_GLOBAL Ip_err ipwps_ap_debug_show
(
		struct Ipwps_ctx_st *ctx
); 
#endif

/*
 ****************************************************************************
 *                      END OF FILE
 ****************************************************************************
 */

#ifdef __cplusplus
}
#endif

#endif