err.no Git - linux-2.6/blob - 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
 134  * and contiguous set of bits.
 135  */
 136 #define is_power_of_two(x)      ( !((x) & ((x)-1)) )
 137 #define low_bit_mask(x)         ( ((x)-1) & ~(x) )
 138 #define is_valid_mask(x)        is_power_of_two(1 + (x) + low_bit_mask(x))
 139
 140 #define FIELD8(__mask)                          \
 141 ({                                              \
 142         BUILD_BUG_ON(!(__mask) ||               \
 143                      !is_valid_mask(__mask) ||  \
 144                      (__mask) != (u8)(__mask)); \
 145         (struct rt2x00_field8) {                \
 146                 __ffs(__mask), (__mask)         \
 147         };                                      \
 148 })
 149
 150 #define FIELD16(__mask)                         \
 151 ({                                              \
 152         BUILD_BUG_ON(!(__mask) ||               \
 153                      !is_valid_mask(__mask) ||  \
 154                      (__mask) != (u16)(__mask));\
 155         (struct rt2x00_field16) {               \
 156                 __ffs(__mask), (__mask)         \
 157         };                                      \
 158 })
 159
 160 #define FIELD32(__mask)                         \
 161 ({                                              \
 162         BUILD_BUG_ON(!(__mask) ||               \
 163                      !is_valid_mask(__mask) ||  \
 164                      (__mask) != (u32)(__mask));\
 165         (struct rt2x00_field32) {               \
 166                 __ffs(__mask), (__mask)         \
 167         };                                      \
 168 })
 169
 170 static inline void rt2x00_set_field32(u32 *reg,
 171                                       const struct rt2x00_field32 field,
 172                                       const u32 value)
 173 {
 174         *reg &= ~(field.bit_mask);
 175         *reg |= (value << field.bit_offset) & field.bit_mask;
 176 }
 177
 178 static inline u32 rt2x00_get_field32(const u32 reg,
 179                                      const struct rt2x00_field32 field)
 180 {
 181         return (reg & field.bit_mask) >> field.bit_offset;
 182 }
 183
 184 static inline void rt2x00_set_field16(u16 *reg,
 185                                       const struct rt2x00_field16 field,
 186                                       const u16 value)
 187 {
 188         *reg &= ~(field.bit_mask);
 189         *reg |= (value << field.bit_offset) & field.bit_mask;
 190 }
 191
 192 static inline u16 rt2x00_get_field16(const u16 reg,
 193                                      const struct rt2x00_field16 field)
 194 {
 195         return (reg & field.bit_mask) >> field.bit_offset;
 196 }
 197
 198 static inline void rt2x00_set_field8(u8 *reg,
 199                                      const struct rt2x00_field8 field,
 200                                      const u8 value)
 201 {
 202         *reg &= ~(field.bit_mask);
 203         *reg |= (value << field.bit_offset) & field.bit_mask;
 204 }
 205
 206 static inline u8 rt2x00_get_field8(const u8 reg,
 207                                    const struct rt2x00_field8 field)
 208 {
 209         return (reg & field.bit_mask) >> field.bit_offset;
 210 }
 211
 212 #endif /* RT2X00REG_H */