hardware/ti/wlan/wl1271/stad/src/AirLink_Managment/regulatoryDomainApi.h

   1 /*
   2  * regulatoryDomainApi.h
   3  *
   4  * Copyright(c) 1998 - 2009 Texas Instruments. All rights reserved.
   5  * All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  *
  11  *  * Redistributions of source code must retain the above copyright
  12  *    notice, this list of conditions and the following disclaimer.
  13  *  * Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in
  15  *    the documentation and/or other materials provided with the
  16  *    distribution.
  17  *  * Neither the name Texas Instruments nor the names of its
  18  *    contributors may be used to endorse or promote products derived
  19  *    from this software without specific prior written permission.
  20  *
  21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  24  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  25  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  26  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  27  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  28  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  29  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  31  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32  */
  33
  34 /** \file regulatoryDomainApi.h
  35  *  \brief regulatoryDomain module interface header file
  36  *
  37  *  \see regulatoryDomain.c & regulatoryDomain.h
  38  */
  39
  40 /***************************************************************************/
  41 /*                                                                          */
  42 /*    MODULE:   regulatoryDomainApi.h                                       */
  43 /*    PURPOSE:  regulatoryDomain module interface header file               */
  44 /*                                                                          */
  45 /***************************************************************************/
  46 #ifndef __REGULATORY_DOMAIN_API_H__
  47 #define __REGULATORY_DOMAIN_API_H__
  48
  49
  50 #include "802_11Defs.h"
  51 #include "regulatoryDomain.h"
  52 #include "DrvMainModules.h"
  53
  54 TI_HANDLE regulatoryDomain_create(TI_HANDLE hOs);
  55
  56 void      regulatoryDomain_init (TStadHandlesList *pStadHandles);
  57
  58 TI_STATUS regulatoryDomain_SetDefaults (TI_HANDLE  hRegulatoryDomain,
  59                                         regulatoryDomainInitParams_t *pRegulatoryDomainInitParams);
  60 /**
  61  * \brief       Set Regulatory Domain Parameter
  62  *
  63  * \param  hRegulatoryDomain    -       Handle to the regulatory domain object
  64  * \param  pParam                               -       Pointer to the input parameter
  65  * \return TI_OK on success, TI_NOK otherwise
  66  *
  67  * \par Description
  68  * Configure channel validity information to the regulatory domain object.
  69  * called by the following:
  70  *      - config mgr in order to set a parameter receiving to the OS abstraction layer.
  71  *      - From inside the driver
  72  *
  73  * \sa
  74  */
  75 TI_STATUS regulatoryDomain_setParam(TI_HANDLE hRegulatoryDomain, paramInfo_t *pParam);
  76 /**
  77  * \brief       Get Regulatory Domain Parameter
  78  *
  79  * \param  hRegulatoryDomain    -       Handle to the regulatory domain object
  80  * \param  pParam                               -       Pointer to the output parameter
  81  * \return TI_OK on success, TI_NOK otherwise
  82  *
  83  * \par Description
  84  * Retrieves channel validity information from the regulatory domain object.
  85  * Called by the following:
  86  *      - Configuration Manager in order to get a parameter from the OS abstraction layer.
  87  *      - From inside the driver
  88  *
  89  * \sa
  90  */
  91 TI_STATUS regulatoryDomain_getParam(TI_HANDLE hRegulatoryDomain, paramInfo_t *pParam);
  92
  93 TI_STATUS regulatoryDomain_destroy(TI_HANDLE hRegulatoryDomain);
  94
  95 #endif /* __REGULATORY_DOMAIN_API_H__*/
  96
  97