drivers/net/wireless/iwlwifi/iwl-io.h

   1 /******************************************************************************
   2  *
   3  * Copyright(c) 2003 - 2008 Intel Corporation. All rights reserved.
   4  *
   5  * Portions of this file are derived from the ipw3945 project.
   6  *
   7  * This program is free software; you can redistribute it and/or modify it
   8  * under the terms of version 2 of the GNU General Public License as
   9  * published by the Free Software Foundation.
  10  *
  11  * This program is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
  14  * more details.
  15  *
  16  * You should have received a copy of the GNU General Public License along with
  17  * this program; if not, write to the Free Software Foundation, Inc.,
  18  * 51 Franklin Street, Fifth Floor, Boston, MA 02110, USA
  19  *
  20  * The full GNU General Public License is included in this distribution in the
  21  * file called LICENSE.
  22  *
  23  * Contact Information:
  24  * James P. Ketrenos <ipw2100-admin@linux.intel.com>
  25  * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
  26  *
  27  *****************************************************************************/
  28
  29 #ifndef __iwl_io_h__
  30 #define __iwl_io_h__
  31
  32 #include <linux/io.h>
  33
  34 #include "iwl-debug.h"
  35
  36 /*
  37  * IO, register, and NIC memory access functions
  38  *
  39  * NOTE on naming convention and macro usage for these
  40  *
  41  * A single _ prefix before a an access function means that no state
  42  * check or debug information is printed when that function is called.
  43  *
  44  * A double __ prefix before an access function means that state is checked
  45  * and the current line number and caller function name are printed in addition
  46  * to any other debug output.
  47  *
  48  * The non-prefixed name is the #define that maps the caller into a
  49  * #define that provides the caller's name and __LINE__ to the double
  50  * prefix version.
  51  *
  52  * If you wish to call the function without any debug or state checking,
  53  * you should use the single _ prefix version (as is used by dependent IO
  54  * routines, for example _iwl_read_direct32 calls the non-check version of
  55  * _iwl_read32.)
  56  *
  57  * These declarations are *extremely* useful in quickly isolating code deltas
  58  * which result in misconfiguring of the hardware I/O.  In combination with
  59  * git-bisect and the IO debug level you can quickly determine the specific
  60  * commit which breaks the IO sequence to the hardware.
  61  *
  62  */
  63
  64 #define _iwl_write32(priv, ofs, val) writel((val), (priv)->hw_base + (ofs))
  65 #ifdef CONFIG_IWLWIFI_DEBUG
  66 static inline void __iwl_write32(const char *f, u32 l, struct iwl_priv *priv,
  67                                  u32 ofs, u32 val)
  68 {
  69         IWL_DEBUG_IO("write32(0x%08X, 0x%08X) - %s %d\n", ofs, val, f, l);
  70         _iwl_write32(priv, ofs, val);
  71 }
  72 #define iwl_write32(priv, ofs, val) \
  73         __iwl_write32(__FILE__, __LINE__, priv, ofs, val)
  74 #else
  75 #define iwl_write32(priv, ofs, val) _iwl_write32(priv, ofs, val)
  76 #endif
  77
  78 #define _iwl_read32(priv, ofs) readl((priv)->hw_base + (ofs))
  79 #ifdef CONFIG_IWLWIFI_DEBUG
  80 static inline u32 __iwl_read32(char *f, u32 l, struct iwl_priv *priv, u32 ofs)
  81 {
  82         IWL_DEBUG_IO("read_direct32(0x%08X) - %s %d\n", ofs, f, l);
  83         return _iwl_read32(priv, ofs);
  84 }
  85 #define iwl_read32(priv, ofs) __iwl_read32(__FILE__, __LINE__, priv, ofs)
  86 #else
  87 #define iwl_read32(p, o) _iwl_read32(p, o)
  88 #endif
  89
  90 static inline int _iwl_poll_bit(struct iwl_priv *priv, u32 addr,
  91                                 u32 bits, u32 mask, int timeout)
  92 {
  93         int i = 0;
  94
  95         do {
  96                 if ((_iwl_read32(priv, addr) & mask) == (bits & mask))
  97                         return i;
  98                 mdelay(10);
  99                 i += 10;
 100         } while (i < timeout);
 101
 102         return -ETIMEDOUT;
 103 }
 104 #ifdef CONFIG_IWLWIFI_DEBUG
 105 static inline int __iwl_poll_bit(const char *f, u32 l,
 106                                  struct iwl_priv *priv, u32 addr,
 107                                  u32 bits, u32 mask, int timeout)
 108 {
 109         int ret = _iwl_poll_bit(priv, addr, bits, mask, timeout);
 110         IWL_DEBUG_IO("poll_bit(0x%08X, 0x%08X, 0x%08X) - %s- %s %d\n",
 111                      addr, bits, mask,
 112                      unlikely(ret  == -ETIMEDOUT)?"timeout":"", f, l);
 113         return ret;
 114 }
 115 #define iwl_poll_bit(priv, addr, bits, mask, timeout) \
 116         __iwl_poll_bit(__FILE__, __LINE__, priv, addr, bits, mask, timeout)
 117 #else
 118 #define iwl_poll_bit(p, a, b, m, t) _iwl_poll_bit(p, a, b, m, t)
 119 #endif
 120
 121 static inline void _iwl_set_bit(struct iwl_priv *priv, u32 reg, u32 mask)
 122 {
 123         _iwl_write32(priv, reg, _iwl_read32(priv, reg) | mask);
 124 }
 125 #ifdef CONFIG_IWLWIFI_DEBUG
 126 static inline void __iwl_set_bit(const char *f, u32 l,
 127                                  struct iwl_priv *priv, u32 reg, u32 mask)
 128 {
 129         u32 val = _iwl_read32(priv, reg) | mask;
 130         IWL_DEBUG_IO("set_bit(0x%08X, 0x%08X) = 0x%08X\n", reg, mask, val);
 131         _iwl_write32(priv, reg, val);
 132 }
 133 #define iwl_set_bit(p, r, m) __iwl_set_bit(__FILE__, __LINE__, p, r, m)
 134 #else
 135 #define iwl_set_bit(p, r, m) _iwl_set_bit(p, r, m)
 136 #endif
 137
 138 static inline void _iwl_clear_bit(struct iwl_priv *priv, u32 reg, u32 mask)
 139 {
 140         _iwl_write32(priv, reg, _iwl_read32(priv, reg) & ~mask);
 141 }
 142 #ifdef CONFIG_IWLWIFI_DEBUG
 143 static inline void __iwl_clear_bit(const char *f, u32 l,
 144                                    struct iwl_priv *priv, u32 reg, u32 mask)
 145 {
 146         u32 val = _iwl_read32(priv, reg) & ~mask;
 147         IWL_DEBUG_IO("clear_bit(0x%08X, 0x%08X) = 0x%08X\n", reg, mask, val);
 148         _iwl_write32(priv, reg, val);
 149 }
 150 #define iwl_clear_bit(p, r, m) __iwl_clear_bit(__FILE__, __LINE__, p, r, m)
 151 #else
 152 #define iwl_clear_bit(p, r, m) _iwl_clear_bit(p, r, m)
 153 #endif
 154
 155 static inline int _iwl_grab_nic_access(struct iwl_priv *priv)
 156 {
 157         int ret;
 158         u32 gp_ctl;
 159
 160 #ifdef CONFIG_IWLWIFI_DEBUG
 161         if (atomic_read(&priv->restrict_refcnt))
 162                 return 0;
 163 #endif
 164         if (test_bit(STATUS_RF_KILL_HW, &priv->status) ||
 165             test_bit(STATUS_RF_KILL_SW, &priv->status)) {
 166                 IWL_WARNING("WARNING: Requesting MAC access during RFKILL "
 167                         "wakes up NIC\n");
 168
 169                 /* 10 msec allows time for NIC to complete its data save */
 170                 gp_ctl = _iwl_read32(priv, CSR_GP_CNTRL);
 171                 if (gp_ctl & CSR_GP_CNTRL_REG_FLAG_MAC_CLOCK_READY) {
 172                         IWL_DEBUG_RF_KILL("Wait for complete power-down, "
 173                                 "gpctl = 0x%08x\n", gp_ctl);
 174                         mdelay(10);
 175                 } else
 176                         IWL_DEBUG_RF_KILL("power-down complete, "
 177                                           "gpctl = 0x%08x\n", gp_ctl);
 178         }
 179
 180         /* this bit wakes up the NIC */
 181         _iwl_set_bit(priv, CSR_GP_CNTRL, CSR_GP_CNTRL_REG_FLAG_MAC_ACCESS_REQ);
 182         ret = _iwl_poll_bit(priv, CSR_GP_CNTRL,
 183                            CSR_GP_CNTRL_REG_VAL_MAC_ACCESS_EN,
 184                            (CSR_GP_CNTRL_REG_FLAG_MAC_CLOCK_READY |
 185                             CSR_GP_CNTRL_REG_FLAG_GOING_TO_SLEEP), 50);
 186         if (ret < 0) {
 187                 IWL_ERROR("MAC is in deep sleep!\n");
 188                 return -EIO;
 189         }
 190
 191 #ifdef CONFIG_IWLWIFI_DEBUG
 192         atomic_inc(&priv->restrict_refcnt);
 193 #endif
 194         return 0;
 195 }
 196
 197 #ifdef CONFIG_IWLWIFI_DEBUG
 198 static inline int __iwl_grab_nic_access(const char *f, u32 l,
 199                                                struct iwl_priv *priv)
 200 {
 201         if (atomic_read(&priv->restrict_refcnt))
 202                 IWL_ERROR("Grabbing access while already held %s %d.\n", f, l);
 203
 204         IWL_DEBUG_IO("grabbing nic access - %s %d\n", f, l);
 205         return _iwl_grab_nic_access(priv);
 206 }
 207 #define iwl_grab_nic_access(priv) \
 208         __iwl_grab_nic_access(__FILE__, __LINE__, priv)
 209 #else
 210 #define iwl_grab_nic_access(priv) \
 211         _iwl_grab_nic_access(priv)
 212 #endif
 213
 214 static inline void _iwl_release_nic_access(struct iwl_priv *priv)
 215 {
 216 #ifdef CONFIG_IWLWIFI_DEBUG
 217         if (atomic_dec_and_test(&priv->restrict_refcnt))
 218 #endif
 219                 _iwl_clear_bit(priv, CSR_GP_CNTRL,
 220                                CSR_GP_CNTRL_REG_FLAG_MAC_ACCESS_REQ);
 221 }
 222 #ifdef CONFIG_IWLWIFI_DEBUG
 223 static inline void __iwl_release_nic_access(const char *f, u32 l,
 224                                             struct iwl_priv *priv)
 225 {
 226         if (atomic_read(&priv->restrict_refcnt) <= 0)
 227                 IWL_ERROR("Release unheld nic access at line %s %d.\n", f, l);
 228
 229         IWL_DEBUG_IO("releasing nic access - %s %d\n", f, l);
 230         _iwl_release_nic_access(priv);
 231 }
 232 #define iwl_release_nic_access(priv) \
 233         __iwl_release_nic_access(__FILE__, __LINE__, priv)
 234 #else
 235 #define iwl_release_nic_access(priv) \
 236         _iwl_release_nic_access(priv)
 237 #endif
 238
 239 static inline u32 _iwl_read_direct32(struct iwl_priv *priv, u32 reg)
 240 {
 241         return _iwl_read32(priv, reg);
 242 }
 243 #ifdef CONFIG_IWLWIFI_DEBUG
 244 static inline u32 __iwl_read_direct32(const char *f, u32 l,
 245                                         struct iwl_priv *priv, u32 reg)
 246 {
 247         u32 value = _iwl_read_direct32(priv, reg);
 248         if (!atomic_read(&priv->restrict_refcnt))
 249                 IWL_ERROR("Nic access not held from %s %d\n", f, l);
 250         IWL_DEBUG_IO("read_direct32(0x%4X) = 0x%08x - %s %d \n", reg, value,
 251                      f, l);
 252         return value;
 253 }
 254 #define iwl_read_direct32(priv, reg) \
 255         __iwl_read_direct32(__FILE__, __LINE__, priv, reg)
 256 #else
 257 #define iwl_read_direct32 _iwl_read_direct32
 258 #endif
 259
 260 static inline void _iwl_write_direct32(struct iwl_priv *priv,
 261                                          u32 reg, u32 value)
 262 {
 263         _iwl_write32(priv, reg, value);
 264 }
 265 #ifdef CONFIG_IWLWIFI_DEBUG
 266 static void __iwl_write_direct32(const char *f , u32 line,
 267                                    struct iwl_priv *priv, u32 reg, u32 value)
 268 {
 269         if (!atomic_read(&priv->restrict_refcnt))
 270                 IWL_ERROR("Nic access not held from %s line %d\n", f, line);
 271         _iwl_write_direct32(priv, reg, value);
 272 }
 273 #define iwl_write_direct32(priv, reg, value) \
 274         __iwl_write_direct32(__func__, __LINE__, priv, reg, value)
 275 #else
 276 #define iwl_write_direct32 _iwl_write_direct32
 277 #endif
 278
 279 static inline void iwl_write_reg_buf(struct iwl_priv *priv,
 280                                                u32 reg, u32 len, u32 *values)
 281 {
 282         u32 count = sizeof(u32);
 283
 284         if ((priv != NULL) && (values != NULL)) {
 285                 for (; 0 < len; len -= count, reg += count, values++)
 286                         _iwl_write_direct32(priv, reg, *values);
 287         }
 288 }
 289
 290 static inline int _iwl_poll_direct_bit(struct iwl_priv *priv,
 291                                            u32 addr, u32 mask, int timeout)
 292 {
 293         int i = 0;
 294
 295         do {
 296                 if ((_iwl_read_direct32(priv, addr) & mask) == mask)
 297                         return i;
 298                 mdelay(10);
 299                 i += 10;
 300         } while (i < timeout);
 301
 302         return -ETIMEDOUT;
 303 }
 304
 305 #ifdef CONFIG_IWLWIFI_DEBUG
 306 static inline int __iwl_poll_direct_bit(const char *f, u32 l,
 307                                             struct iwl_priv *priv,
 308                                             u32 addr, u32 mask, int timeout)
 309 {
 310         int ret  = _iwl_poll_direct_bit(priv, addr, mask, timeout);
 311
 312         if (unlikely(ret == -ETIMEDOUT))
 313                 IWL_DEBUG_IO("poll_direct_bit(0x%08X, 0x%08X) - "
 314                              "timedout - %s %d\n", addr, mask, f, l);
 315         else
 316                 IWL_DEBUG_IO("poll_direct_bit(0x%08X, 0x%08X) = 0x%08X "
 317                              "- %s %d\n", addr, mask, ret, f, l);
 318         return ret;
 319 }
 320 #define iwl_poll_direct_bit(priv, addr, mask, timeout) \
 321         __iwl_poll_direct_bit(__FILE__, __LINE__, priv, addr, mask, timeout)
 322 #else
 323 #define iwl_poll_direct_bit _iwl_poll_direct_bit
 324 #endif
 325
 326 static inline u32 _iwl_read_prph(struct iwl_priv *priv, u32 reg)
 327 {
 328         _iwl_write_direct32(priv, HBUS_TARG_PRPH_RADDR, reg | (3 << 24));
 329         return _iwl_read_direct32(priv, HBUS_TARG_PRPH_RDAT);
 330 }
 331 #ifdef CONFIG_IWLWIFI_DEBUG
 332 static inline u32 __iwl_read_prph(const char *f, u32 line,
 333                                   struct iwl_priv *priv, u32 reg)
 334 {
 335         if (!atomic_read(&priv->restrict_refcnt))
 336                 IWL_ERROR("Nic access not held from %s line %d\n", f, line);
 337         return _iwl_read_prph(priv, reg);
 338 }
 339
 340 #define iwl_read_prph(priv, reg) \
 341         __iwl_read_prph(__func__, __LINE__, priv, reg)
 342 #else
 343 #define iwl_read_prph _iwl_read_prph
 344 #endif
 345
 346 static inline void _iwl_write_prph(struct iwl_priv *priv,
 347                                              u32 addr, u32 val)
 348 {
 349         _iwl_write_direct32(priv, HBUS_TARG_PRPH_WADDR,
 350                               ((addr & 0x0000FFFF) | (3 << 24)));
 351         _iwl_write_direct32(priv, HBUS_TARG_PRPH_WDAT, val);
 352 }
 353 #ifdef CONFIG_IWLWIFI_DEBUG
 354 static inline void __iwl_write_prph(const char *f, u32 line,
 355                                     struct iwl_priv *priv, u32 addr, u32 val)
 356 {
 357         if (!atomic_read(&priv->restrict_refcnt))
 358                 IWL_ERROR("Nic access not held from %s line %d\n", f, line);
 359         _iwl_write_prph(priv, addr, val);
 360 }
 361
 362 #define iwl_write_prph(priv, addr, val) \
 363         __iwl_write_prph(__func__, __LINE__, priv, addr, val);
 364 #else
 365 #define iwl_write_prph _iwl_write_prph
 366 #endif
 367
 368 #define _iwl_set_bits_prph(priv, reg, mask) \
 369         _iwl_write_prph(priv, reg, (_iwl_read_prph(priv, reg) | mask))
 370 #ifdef CONFIG_IWLWIFI_DEBUG
 371 static inline void __iwl_set_bits_prph(const char *f, u32 line,
 372                                        struct iwl_priv *priv,
 373                                        u32 reg, u32 mask)
 374 {
 375         if (!atomic_read(&priv->restrict_refcnt))
 376                 IWL_ERROR("Nic access not held from %s line %d\n", f, line);
 377
 378         _iwl_set_bits_prph(priv, reg, mask);
 379 }
 380 #define iwl_set_bits_prph(priv, reg, mask) \
 381         __iwl_set_bits_prph(__func__, __LINE__, priv, reg, mask)
 382 #else
 383 #define iwl_set_bits_prph _iwl_set_bits_prph
 384 #endif
 385
 386 #define _iwl_set_bits_mask_prph(priv, reg, bits, mask) \
 387         _iwl_write_prph(priv, reg, ((_iwl_read_prph(priv, reg) & mask) | bits))
 388
 389 #ifdef CONFIG_IWLWIFI_DEBUG
 390 static inline void __iwl_set_bits_mask_prph(const char *f, u32 line,
 391                 struct iwl_priv *priv, u32 reg, u32 bits, u32 mask)
 392 {
 393         if (!atomic_read(&priv->restrict_refcnt))
 394                 IWL_ERROR("Nic access not held from %s line %d\n", f, line);
 395         _iwl_set_bits_mask_prph(priv, reg, bits, mask);
 396 }
 397 #define iwl_set_bits_mask_prph(priv, reg, bits, mask) \
 398         __iwl_set_bits_mask_prph(__func__, __LINE__, priv, reg, bits, mask)
 399 #else
 400 #define iwl_set_bits_mask_prph _iwl_set_bits_mask_prph
 401 #endif
 402
 403 static inline void iwl_clear_bits_prph(struct iwl_priv
 404                                                  *priv, u32 reg, u32 mask)
 405 {
 406         u32 val = _iwl_read_prph(priv, reg);
 407         _iwl_write_prph(priv, reg, (val & ~mask));
 408 }
 409
 410 static inline u32 iwl_read_targ_mem(struct iwl_priv *priv, u32 addr)
 411 {
 412         iwl_write_direct32(priv, HBUS_TARG_MEM_RADDR, addr);
 413         return iwl_read_direct32(priv, HBUS_TARG_MEM_RDAT);
 414 }
 415
 416 static inline void iwl_write_targ_mem(struct iwl_priv *priv, u32 addr, u32 val)
 417 {
 418         iwl_write_direct32(priv, HBUS_TARG_MEM_WADDR, addr);
 419         iwl_write_direct32(priv, HBUS_TARG_MEM_WDAT, val);
 420 }
 421
 422 static inline void iwl_write_targ_mem_buf(struct iwl_priv *priv, u32 addr,
 423                                           u32 len, u32 *values)
 424 {
 425         iwl_write_direct32(priv, HBUS_TARG_MEM_WADDR, addr);
 426         for (; 0 < len; len -= sizeof(u32), values++)
 427                 iwl_write_direct32(priv, HBUS_TARG_MEM_WDAT, *values);
 428 }
 429 #endif