drivers/net/wireless/rt2x00/rt2x00reg.h

   1 /*
   2         Copyright (C) 2004 - 2008 rt2x00 SourceForge Project
   3         <http://rt2x00.serialmonkey.com>
   4
   5         This program is free software; you can redistribute it and/or modify
   6         it under the terms of the GNU General Public License as published by
   7         the Free Software Foundation; either version 2 of the License, or
   8         (at your option) any later version.
   9
  10         This program is distributed in the hope that it will be useful,
  11         but WITHOUT ANY WARRANTY; without even the implied warranty of
  12         MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13         GNU General Public License for more details.
  14
  15         You should have received a copy of the GNU General Public License
  16         along with this program; if not, write to the
  17         Free Software Foundation, Inc.,
  18         59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  19  */
  20
  21 /*
  22         Module: rt2x00
  23         Abstract: rt2x00 generic register information.
  24  */
  25
  26 #ifndef RT2X00REG_H
  27 #define RT2X00REG_H
  28
  29 /*
  30  * Antenna values
  31  */
  32 enum antenna {
  33         ANTENNA_SW_DIVERSITY = 0,
  34         ANTENNA_A = 1,
  35         ANTENNA_B = 2,
  36         ANTENNA_HW_DIVERSITY = 3,
  37 };
  38
  39 /*
  40  * Led mode values.
  41  */
  42 enum led_mode {
  43         LED_MODE_DEFAULT = 0,
  44         LED_MODE_TXRX_ACTIVITY = 1,
  45         LED_MODE_SIGNAL_STRENGTH = 2,
  46         LED_MODE_ASUS = 3,
  47         LED_MODE_ALPHA = 4,
  48 };
  49
  50 /*
  51  * TSF sync values
  52  */
  53 enum tsf_sync {
  54         TSF_SYNC_NONE = 0,
  55         TSF_SYNC_INFRA = 1,
  56         TSF_SYNC_BEACON = 2,
  57 };
  58
  59 /*
  60  * Device states
  61  */
  62 enum dev_state {
  63         STATE_DEEP_SLEEP = 0,
  64         STATE_SLEEP = 1,
  65         STATE_STANDBY = 2,
  66         STATE_AWAKE = 3,
  67
  68 /*
  69  * Additional device states, these values are
  70  * not strict since they are not directly passed
  71  * into the device.
  72  */
  73         STATE_RADIO_ON,
  74         STATE_RADIO_OFF,
  75         STATE_RADIO_RX_ON,
  76         STATE_RADIO_RX_OFF,
  77         STATE_RADIO_RX_ON_LINK,
  78         STATE_RADIO_RX_OFF_LINK,
  79         STATE_RADIO_IRQ_ON,
  80         STATE_RADIO_IRQ_OFF,
  81 };
  82
  83 /*
  84  * IFS backoff values
  85  */
  86 enum ifs {
  87         IFS_BACKOFF = 0,
  88         IFS_SIFS = 1,
  89         IFS_NEW_BACKOFF = 2,
  90         IFS_NONE = 3,
  91 };
  92
  93 /*
  94  * Cipher types for hardware encryption
  95  */
  96 enum cipher {
  97         CIPHER_NONE = 0,
  98         CIPHER_WEP64 = 1,
  99         CIPHER_WEP128 = 2,
 100         CIPHER_TKIP = 3,
 101         CIPHER_AES = 4,
 102 /*
 103  * The following fields were added by rt61pci and rt73usb.
 104  */
 105         CIPHER_CKIP64 = 5,
 106         CIPHER_CKIP128 = 6,
 107         CIPHER_TKIP_NO_MIC = 7,
 108 };
 109
 110 /*
 111  * Register handlers.
 112  * We store the position of a register field inside a field structure,
 113  * This will simplify the process of setting and reading a certain field
 114  * inside the register while making sure the process remains byte order safe.
 115  */
 116 struct rt2x00_field8 {
 117         u8 bit_offset;
 118         u8 bit_mask;
 119 };
 120
 121 struct rt2x00_field16 {
 122         u16 bit_offset;
 123         u16 bit_mask;
 124 };
 125
 126 struct rt2x00_field32 {
 127         u32 bit_offset;
 128         u32 bit_mask;
 129 };
 130
 131 /*
 132  * Power of two check, this will check
 133  * if the mask that has been given contains and contiguous set of bits.
 134  * Note that we cannot use the is_power_of_2() function since this
 135  * check must be done at compile-time.
 136  */
 137 #define is_power_of_two(x)      ( !((x) & ((x)-1)) )
 138 #define low_bit_mask(x)         ( ((x)-1) & ~(x) )
 139 #define is_valid_mask(x)        is_power_of_two(1 + (x) + low_bit_mask(x))
 140
 141 /*
 142  * Macro's to find first set bit in a variable.
 143  * These macro's behaves the same as the __ffs() function with
 144  * the most important difference that this is done during
 145  * compile-time rather then run-time.
 146  */
 147 #define compile_ffs2(__x) \
 148         __builtin_choose_expr(((__x) & 0x1), 0, 1)
 149
 150 #define compile_ffs4(__x) \
 151         __builtin_choose_expr(((__x) & 0x3), \
 152                               (compile_ffs2((__x))), \
 153                               (compile_ffs2((__x) >> 2) + 2))
 154
 155 #define compile_ffs8(__x) \
 156         __builtin_choose_expr(((__x) & 0xf), \
 157                               (compile_ffs4((__x))), \
 158                               (compile_ffs4((__x) >> 4) + 4))
 159
 160 #define compile_ffs16(__x) \
 161         __builtin_choose_expr(((__x) & 0xff), \
 162                               (compile_ffs8((__x))), \
 163                               (compile_ffs8((__x) >> 8) + 8))
 164
 165 #define compile_ffs32(__x) \
 166         __builtin_choose_expr(((__x) & 0xffff), \
 167                               (compile_ffs16((__x))), \
 168                               (compile_ffs16((__x) >> 16) + 16))
 169
 170 /*
 171  * This macro will check the requirements for the FIELD{8,16,32} macros
 172  * The mask should be a constant non-zero contiguous set of bits which
 173  * does not exceed the given typelimit.
 174  */
 175 #define FIELD_CHECK(__mask, __type)                     \
 176         BUILD_BUG_ON(!__builtin_constant_p(__mask) ||   \
 177                      !(__mask) ||                       \
 178                      !is_valid_mask(__mask) ||          \
 179                      (__mask) != (__type)(__mask))      \
 180
 181 #define FIELD8(__mask)                          \
 182 ({                                              \
 183         FIELD_CHECK(__mask, u8);                \
 184         (struct rt2x00_field8) {                \
 185                 compile_ffs8(__mask), (__mask)  \
 186         };                                      \
 187 })
 188
 189 #define FIELD16(__mask)                         \
 190 ({                                              \
 191         FIELD_CHECK(__mask, u16);               \
 192         (struct rt2x00_field16) {               \
 193                 compile_ffs16(__mask), (__mask) \
 194         };                                      \
 195 })
 196
 197 #define FIELD32(__mask)                         \
 198 ({                                              \
 199         FIELD_CHECK(__mask, u32);               \
 200         (struct rt2x00_field32) {               \
 201                 compile_ffs32(__mask), (__mask) \
 202         };                                      \
 203 })
 204
 205 #define SET_FIELD(__reg, __type, __field, __value)\
 206 ({                                              \
 207         typecheck(__type, __field);             \
 208         *(__reg) &= ~((__field).bit_mask);      \
 209         *(__reg) |= ((__value) <<               \
 210             ((__field).bit_offset)) &           \
 211             ((__field).bit_mask);               \
 212 })
 213
 214 #define GET_FIELD(__reg, __type, __field)       \
 215 ({                                              \
 216         typecheck(__type, __field);             \
 217         ((__reg) & ((__field).bit_mask)) >>     \
 218             ((__field).bit_offset);             \
 219 })
 220
 221 #define rt2x00_set_field32(__reg, __field, __value) \
 222         SET_FIELD(__reg, struct rt2x00_field32, __field, __value)
 223 #define rt2x00_get_field32(__reg, __field) \
 224         GET_FIELD(__reg, struct rt2x00_field32, __field)
 225
 226 #define rt2x00_set_field16(__reg, __field, __value) \
 227         SET_FIELD(__reg, struct rt2x00_field16, __field, __value)
 228 #define rt2x00_get_field16(__reg, __field) \
 229         GET_FIELD(__reg, struct rt2x00_field16, __field)
 230
 231 #define rt2x00_set_field8(__reg, __field, __value) \
 232         SET_FIELD(__reg, struct rt2x00_field8, __field, __value)
 233 #define rt2x00_get_field8(__reg, __field) \
 234         GET_FIELD(__reg, struct rt2x00_field8, __field)
 235
 236 #endif /* RT2X00REG_H */