drivers/staging/rtl8188eu/include/odm_interface.h

   1 /******************************************************************************
   2  *
   3  * Copyright(c) 2007 - 2011 Realtek Corporation. All rights reserved.
   4  *
   5  * This program is free software; you can redistribute it and/or modify it
   6  * under the terms of version 2 of the GNU General Public License as
   7  * published by the Free Software Foundation.
   8  *
   9  * This program is distributed in the hope that it will be useful, but WITHOUT
  10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11  * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
  12  * more details.
  13  *
  14  * You should have received a copy of the GNU General Public License along with
  15  * this program; if not, write to the Free Software Foundation, Inc.,
  16  * 51 Franklin Street, Fifth Floor, Boston, MA 02110, USA
  17  *
  18  *
  19  ******************************************************************************/
  20
  21 #ifndef __ODM_INTERFACE_H__
  22 #define __ODM_INTERFACE_H__
  23
  24 /*  */
  25 /*  =========== Constant/Structure/Enum/... Define */
  26 /*  */
  27
  28 /*  */
  29 /*  =========== Macro Define */
  30 /*  */
  31
  32 #define _reg_all(_name)                 ODM_##_name
  33 #define _reg_ic(_name, _ic)             ODM_##_name##_ic
  34 #define _bit_all(_name)                 BIT_##_name
  35 #define _bit_ic(_name, _ic)             BIT_##_name##_ic
  36
  37 /*  _cat: implemented by Token-Pasting Operator. */
  38
  39 /*===================================
  40
  41 #define ODM_REG_DIG_11N         0xC50
  42 #define ODM_REG_DIG_11AC        0xDDD
  43
  44 ODM_REG(DIG,_pDM_Odm)
  45 =====================================*/
  46
  47 #define _reg_11N(_name)                 ODM_REG_##_name##_11N
  48 #define _reg_11AC(_name)                ODM_REG_##_name##_11AC
  49 #define _bit_11N(_name)                 ODM_BIT_##_name##_11N
  50 #define _bit_11AC(_name)                ODM_BIT_##_name##_11AC
  51
  52 #define _cat(_name, _ic_type, _func)                                    \
  53         (                                                               \
  54                 (_ic_type) ? _func##_11N(_name) :                       \
  55                 _func##_11AC(_name)                                     \
  56         )
  57
  58 /*  _name: name of register or bit. */
  59 /*  Example: "ODM_REG(R_A_AGC_CORE1, pDM_Odm)" */
  60 /*         gets "ODM_R_A_AGC_CORE1" or "ODM_R_A_AGC_CORE1_8192C",
  61  *         depends on SupportICType. */
  62 #define ODM_REG(_name, _pDM_Odm) _cat(_name, _pDM_Odm->SupportICType, _reg)
  63 #define ODM_BIT(_name, _pDM_Odm) _cat(_name, _pDM_Odm->SupportICType, _bit)
  64
  65 enum odm_h2c_cmd {
  66         ODM_H2C_RSSI_REPORT = 0,
  67         ODM_H2C_PSD_RESULT = 1,
  68         ODM_H2C_PathDiv = 2,
  69         ODM_MAX_H2CCMD
  70 };
  71
  72 /*  2012/02/17 MH For non-MP compile pass only. Linux does not support workitem. */
  73 /*  Suggest HW team to use thread instead of workitem. Windows also support the feature. */
  74 typedef void (*RT_WORKITEM_CALL_BACK)(void *pContext);
  75
  76 /*  =========== Extern Variable ??? It should be forbidden. */
  77
  78 /*  =========== EXtern Function Prototype */
  79
  80 /*  Memory Relative Function. */
  81
  82 /*  ODM Timer relative API. */
  83
  84 void ODM_CancelTimer(struct odm_dm_struct *pDM_Odm, struct timer_list *pTimer);
  85
  86 /*  ODM FW relative API. */
  87 u32 ODM_FillH2CCmd(u8 *pH2CBuffer, u32 H2CBufferLen, u32 CmdNum,
  88                    u32 *pElementID, u32 *pCmdLen, u8 **pCmbBuffer,
  89                    u8 *CmdStartSeq);
  90
  91 #endif  /*  __ODM_INTERFACE_H__ */