drivers/net/wireless/rockchip_wlan/rtl8723bs/include/hal_com.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 #ifndef __HAL_COMMON_H__
  21 #define __HAL_COMMON_H__
  22
  23 #include "HalVerDef.h"
  24 #include "hal_pg.h"
  25 #include "hal_phy.h"
  26 #include "hal_phy_reg.h"
  27 #include "hal_com_reg.h"
  28 #include "hal_com_phycfg.h"
  29
  30 /*------------------------------ Tx Desc definition Macro ------------------------*/
  31 //#pragma mark -- Tx Desc related definition. --
  32 //----------------------------------------------------------------------------
  33 //-----------------------------------------------------------
  34 //      Rate
  35 //-----------------------------------------------------------
  36 // CCK Rates, TxHT = 0
  37 #define DESC_RATE1M                             0x00
  38 #define DESC_RATE2M                             0x01
  39 #define DESC_RATE5_5M                           0x02
  40 #define DESC_RATE11M                            0x03
  41
  42 // OFDM Rates, TxHT = 0
  43 #define DESC_RATE6M                             0x04
  44 #define DESC_RATE9M                             0x05
  45 #define DESC_RATE12M                            0x06
  46 #define DESC_RATE18M                            0x07
  47 #define DESC_RATE24M                            0x08
  48 #define DESC_RATE36M                            0x09
  49 #define DESC_RATE48M                            0x0a
  50 #define DESC_RATE54M                            0x0b
  51
  52 // MCS Rates, TxHT = 1
  53 #define DESC_RATEMCS0                           0x0c
  54 #define DESC_RATEMCS1                           0x0d
  55 #define DESC_RATEMCS2                           0x0e
  56 #define DESC_RATEMCS3                           0x0f
  57 #define DESC_RATEMCS4                           0x10
  58 #define DESC_RATEMCS5                           0x11
  59 #define DESC_RATEMCS6                           0x12
  60 #define DESC_RATEMCS7                           0x13
  61 #define DESC_RATEMCS8                           0x14
  62 #define DESC_RATEMCS9                           0x15
  63 #define DESC_RATEMCS10                          0x16
  64 #define DESC_RATEMCS11                          0x17
  65 #define DESC_RATEMCS12                          0x18
  66 #define DESC_RATEMCS13                          0x19
  67 #define DESC_RATEMCS14                          0x1a
  68 #define DESC_RATEMCS15                          0x1b
  69 #define DESC_RATEMCS16                          0x1C
  70 #define DESC_RATEMCS17                          0x1D
  71 #define DESC_RATEMCS18                          0x1E
  72 #define DESC_RATEMCS19                          0x1F
  73 #define DESC_RATEMCS20                          0x20
  74 #define DESC_RATEMCS21                          0x21
  75 #define DESC_RATEMCS22                          0x22
  76 #define DESC_RATEMCS23                          0x23
  77 #define DESC_RATEMCS24                          0x24
  78 #define DESC_RATEMCS25                          0x25
  79 #define DESC_RATEMCS26                          0x26
  80 #define DESC_RATEMCS27                          0x27
  81 #define DESC_RATEMCS28                          0x28
  82 #define DESC_RATEMCS29                          0x29
  83 #define DESC_RATEMCS30                          0x2A
  84 #define DESC_RATEMCS31                          0x2B
  85 #define DESC_RATEVHTSS1MCS0             0x2C
  86 #define DESC_RATEVHTSS1MCS1             0x2D
  87 #define DESC_RATEVHTSS1MCS2             0x2E
  88 #define DESC_RATEVHTSS1MCS3             0x2F
  89 #define DESC_RATEVHTSS1MCS4             0x30
  90 #define DESC_RATEVHTSS1MCS5             0x31
  91 #define DESC_RATEVHTSS1MCS6             0x32
  92 #define DESC_RATEVHTSS1MCS7             0x33
  93 #define DESC_RATEVHTSS1MCS8             0x34
  94 #define DESC_RATEVHTSS1MCS9             0x35
  95 #define DESC_RATEVHTSS2MCS0             0x36
  96 #define DESC_RATEVHTSS2MCS1             0x37
  97 #define DESC_RATEVHTSS2MCS2             0x38
  98 #define DESC_RATEVHTSS2MCS3             0x39
  99 #define DESC_RATEVHTSS2MCS4             0x3A
 100 #define DESC_RATEVHTSS2MCS5             0x3B
 101 #define DESC_RATEVHTSS2MCS6             0x3C
 102 #define DESC_RATEVHTSS2MCS7             0x3D
 103 #define DESC_RATEVHTSS2MCS8             0x3E
 104 #define DESC_RATEVHTSS2MCS9             0x3F
 105 #define DESC_RATEVHTSS3MCS0             0x40
 106 #define DESC_RATEVHTSS3MCS1             0x41
 107 #define DESC_RATEVHTSS3MCS2             0x42
 108 #define DESC_RATEVHTSS3MCS3             0x43
 109 #define DESC_RATEVHTSS3MCS4             0x44
 110 #define DESC_RATEVHTSS3MCS5             0x45
 111 #define DESC_RATEVHTSS3MCS6             0x46
 112 #define DESC_RATEVHTSS3MCS7             0x47
 113 #define DESC_RATEVHTSS3MCS8             0x48
 114 #define DESC_RATEVHTSS3MCS9             0x49
 115 #define DESC_RATEVHTSS4MCS0             0x4A
 116 #define DESC_RATEVHTSS4MCS1             0x4B
 117 #define DESC_RATEVHTSS4MCS2             0x4C
 118 #define DESC_RATEVHTSS4MCS3             0x4D
 119 #define DESC_RATEVHTSS4MCS4             0x4E
 120 #define DESC_RATEVHTSS4MCS5             0x4F
 121 #define DESC_RATEVHTSS4MCS6             0x50
 122 #define DESC_RATEVHTSS4MCS7             0x51
 123 #define DESC_RATEVHTSS4MCS8             0x52
 124 #define DESC_RATEVHTSS4MCS9             0x53
 125
 126 enum{
 127         UP_LINK,
 128         DOWN_LINK,
 129 };
 130 typedef enum _RT_MEDIA_STATUS {
 131         RT_MEDIA_DISCONNECT = 0,
 132         RT_MEDIA_CONNECT       = 1
 133 } RT_MEDIA_STATUS;
 134
 135 #define MAX_DLFW_PAGE_SIZE                      4096    // @ page : 4k bytes
 136 typedef enum _FIRMWARE_SOURCE {
 137         FW_SOURCE_IMG_FILE = 0,
 138         FW_SOURCE_HEADER_FILE = 1,              //from header file
 139 } FIRMWARE_SOURCE, *PFIRMWARE_SOURCE;
 140
 141
 142 // BK, BE, VI, VO, HCCA, MANAGEMENT, COMMAND, HIGH, BEACON.
 143 //#define MAX_TX_QUEUE          9
 144
 145 #define TX_SELE_HQ                      BIT(0)          // High Queue
 146 #define TX_SELE_LQ                      BIT(1)          // Low Queue
 147 #define TX_SELE_NQ                      BIT(2)          // Normal Queue
 148 #define TX_SELE_EQ                      BIT(3)          // Extern Queue
 149
 150 #define PageNum_128(_Len)               (u32)(((_Len)>>7) + ((_Len)&0x7F ? 1:0))
 151 #define PageNum_256(_Len)               (u32)(((_Len)>>8) + ((_Len)&0xFF ? 1:0))
 152 #define PageNum_512(_Len)               (u32)(((_Len)>>9) + ((_Len)&0x1FF ? 1:0))
 153 #define PageNum(_Len, _Size)            (u32)(((_Len)/(_Size)) + ((_Len)&((_Size) - 1) ? 1:0))
 154
 155
 156 void dump_chip_info(HAL_VERSION ChipVersion);
 157
 158 u8      //return the final channel plan decision
 159 hal_com_config_channel_plan(
 160         IN      PADAPTER        padapter,
 161         IN      u8                      hw_channel_plan,        //channel plan from HW (efuse/eeprom)
 162         IN      u8                      sw_channel_plan,        //channel plan from SW (registry/module param)
 163         IN      u8                      def_channel_plan,       //channel plan used when the former two is invalid
 164         IN      BOOLEAN         AutoLoadFail
 165         );
 166
 167 BOOLEAN
 168 HAL_IsLegalChannel(
 169         IN      PADAPTER        Adapter,
 170         IN      u32                     Channel
 171         );
 172
 173 u8      MRateToHwRate(u8 rate);
 174
 175 u8      HwRateToMRate(u8 rate);
 176
 177 void    HalSetBrateCfg(
 178         IN PADAPTER             Adapter,
 179         IN u8                   *mBratesOS,
 180         OUT u16                 *pBrateCfg);
 181
 182 BOOLEAN
 183 Hal_MappingOutPipe(
 184         IN      PADAPTER        pAdapter,
 185         IN      u8              NumOutPipe
 186         );
 187
 188 void hal_init_macaddr(_adapter *adapter);
 189
 190 void rtw_init_hal_com_default_value(PADAPTER Adapter);
 191
 192 void c2h_evt_clear(_adapter *adapter);
 193 s32 c2h_evt_read(_adapter *adapter, u8 *buf);
 194 s32 c2h_evt_read_88xx(_adapter *adapter, u8 *buf);
 195
 196 u8  rtw_hal_networktype_to_raid(_adapter *adapter, struct sta_info *psta);
 197 u8 rtw_get_mgntframe_raid(_adapter *adapter,unsigned char network_type);
 198 void rtw_hal_update_sta_rate_mask(PADAPTER padapter, struct sta_info *psta);
 199
 200 void hw_var_port_switch(_adapter *adapter);
 201
 202 void SetHwReg(PADAPTER padapter, u8 variable, u8 *val);
 203 void GetHwReg(PADAPTER padapter, u8 variable, u8 *val);
 204
 205 u8 SetHalDefVar(_adapter *adapter, HAL_DEF_VARIABLE variable, void *value);
 206 u8 GetHalDefVar(_adapter *adapter, HAL_DEF_VARIABLE variable, void *value);
 207
 208 BOOLEAN
 209 eqNByte(
 210         u8*     str1,
 211         u8*     str2,
 212         u32     num
 213         );
 214
 215 BOOLEAN
 216 IsHexDigit(
 217         IN      char    chTmp
 218         );
 219
 220 u32
 221 MapCharToHexDigit(
 222         IN      char    chTmp
 223 );
 224
 225 BOOLEAN
 226 GetHexValueFromString(
 227         IN              char*                   szStr,
 228         IN OUT  u32*                    pu4bVal,
 229         IN OUT  u32*                    pu4bMove
 230         );
 231
 232 BOOLEAN
 233 GetFractionValueFromString(
 234         IN              char*           szStr,
 235         IN OUT  u8*                     pInteger,
 236         IN OUT  u8*                     pFraction,
 237         IN OUT  u32*            pu4bMove
 238         );
 239
 240 BOOLEAN
 241 IsCommentString(
 242         IN              char*           szStr
 243         );
 244
 245 BOOLEAN
 246 ParseQualifiedString(
 247     IN  char* In,
 248     IN OUT  u32* Start,
 249     OUT char* Out,
 250     IN  char  LeftQualifier,
 251     IN  char  RightQualifier
 252     );
 253
 254 BOOLEAN
 255 GetU1ByteIntegerFromStringInDecimal(
 256         IN              char* Str,
 257         IN OUT  u8* pInt
 258         );
 259
 260 BOOLEAN
 261 isAllSpaceOrTab(
 262         u8*     data,
 263         u8      size
 264         );
 265
 266 #endif //__HAL_COMMON_H__
 267