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 misconfiguration 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) iowrite32((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) ioread32((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 #ifdef CONFIG_IWLWIFI_DEBUG
 159         if (atomic_read(&priv->restrict_refcnt))
 160                 return 0;
 161 #endif
 162         /* this bit wakes up the NIC */
 163         _iwl_set_bit(priv, CSR_GP_CNTRL, CSR_GP_CNTRL_REG_FLAG_MAC_ACCESS_REQ);
 164         ret = _iwl_poll_bit(priv, CSR_GP_CNTRL,
 165                            CSR_GP_CNTRL_REG_VAL_MAC_ACCESS_EN,
 166                            (CSR_GP_CNTRL_REG_FLAG_MAC_CLOCK_READY |
 167                             CSR_GP_CNTRL_REG_FLAG_GOING_TO_SLEEP), 50);
 168         if (ret < 0) {
 169                 IWL_ERROR("MAC is in deep sleep!\n");
 170                 return -EIO;
 171         }
 172
 173 #ifdef CONFIG_IWLWIFI_DEBUG
 174         atomic_inc(&priv->restrict_refcnt);
 175 #endif
 176         return 0;
 177 }
 178
 179 #ifdef CONFIG_IWLWIFI_DEBUG
 180 static inline int __iwl_grab_nic_access(const char *f, u32 l,
 181                                                struct iwl_priv *priv)
 182 {
 183         if (atomic_read(&priv->restrict_refcnt))
 184                 IWL_ERROR("Grabbing access while already held %s %d.\n", f, l);
 185
 186         IWL_DEBUG_IO("grabbing nic access - %s %d\n", f, l);
 187         return _iwl_grab_nic_access(priv);
 188 }
 189 #define iwl_grab_nic_access(priv) \
 190         __iwl_grab_nic_access(__FILE__, __LINE__, priv)
 191 #else
 192 #define iwl_grab_nic_access(priv) \
 193         _iwl_grab_nic_access(priv)
 194 #endif
 195
 196 static inline void _iwl_release_nic_access(struct iwl_priv *priv)
 197 {
 198 #ifdef CONFIG_IWLWIFI_DEBUG
 199         if (atomic_dec_and_test(&priv->restrict_refcnt))
 200 #endif
 201                 _iwl_clear_bit(priv, CSR_GP_CNTRL,
 202                                CSR_GP_CNTRL_REG_FLAG_MAC_ACCESS_REQ);
 203 }
 204 #ifdef CONFIG_IWLWIFI_DEBUG
 205 static inline void __iwl_release_nic_access(const char *f, u32 l,
 206                                             struct iwl_priv *priv)
 207 {
 208         if (atomic_read(&priv->restrict_refcnt) <= 0)
 209                 IWL_ERROR("Release unheld nic access at line %s %d.\n", f, l);
 210
 211         IWL_DEBUG_IO("releasing nic access - %s %d\n", f, l);
 212         _iwl_release_nic_access(priv);
 213 }
 214 #define iwl_release_nic_access(priv) \
 215         __iwl_release_nic_access(__FILE__, __LINE__, priv)
 216 #else
 217 #define iwl_release_nic_access(priv) \
 218         _iwl_release_nic_access(priv)
 219 #endif
 220
 221 static inline u32 _iwl_read_direct32(struct iwl_priv *priv, u32 reg)
 222 {
 223         return _iwl_read32(priv, reg);
 224 }
 225 #ifdef CONFIG_IWLWIFI_DEBUG
 226 static inline u32 __iwl_read_direct32(const char *f, u32 l,
 227                                         struct iwl_priv *priv, u32 reg)
 228 {
 229         u32 value = _iwl_read_direct32(priv, reg);
 230         if (!atomic_read(&priv->restrict_refcnt))
 231                 IWL_ERROR("Nic access not held from %s %d\n", f, l);
 232         IWL_DEBUG_IO("read_direct32(0x%4X) = 0x%08x - %s %d \n", reg, value,
 233                      f, l);
 234         return value;
 235 }
 236 #define iwl_read_direct32(priv, reg) \
 237         __iwl_read_direct32(__FILE__, __LINE__, priv, reg)
 238 #else
 239 #define iwl_read_direct32 _iwl_read_direct32
 240 #endif
 241
 242 static inline void _iwl_write_direct32(struct iwl_priv *priv,
 243                                          u32 reg, u32 value)
 244 {
 245         _iwl_write32(priv, reg, value);
 246 }
 247 #ifdef CONFIG_IWLWIFI_DEBUG
 248 static void __iwl_write_direct32(const char *f , u32 line,
 249                                    struct iwl_priv *priv, u32 reg, u32 value)
 250 {
 251         if (!atomic_read(&priv->restrict_refcnt))
 252                 IWL_ERROR("Nic access not held from %s line %d\n", f, line);
 253         _iwl_write_direct32(priv, reg, value);
 254 }
 255 #define iwl_write_direct32(priv, reg, value) \
 256         __iwl_write_direct32(__func__, __LINE__, priv, reg, value)
 257 #else
 258 #define iwl_write_direct32 _iwl_write_direct32
 259 #endif
 260
 261 static inline void iwl_write_reg_buf(struct iwl_priv *priv,
 262                                                u32 reg, u32 len, u32 *values)
 263 {
 264         u32 count = sizeof(u32);
 265
 266         if ((priv != NULL) && (values != NULL)) {
 267                 for (; 0 < len; len -= count, reg += count, values++)
 268                         _iwl_write_direct32(priv, reg, *values);
 269         }
 270 }
 271
 272 static inline int _iwl_poll_direct_bit(struct iwl_priv *priv,
 273                                            u32 addr, u32 mask, int timeout)
 274 {
 275         int i = 0;
 276
 277         do {
 278                 if ((_iwl_read_direct32(priv, addr) & mask) == mask)
 279                         return i;
 280                 mdelay(10);
 281                 i += 10;
 282         } while (i < timeout);
 283
 284         return -ETIMEDOUT;
 285 }
 286
 287 #ifdef CONFIG_IWLWIFI_DEBUG
 288 static inline int __iwl_poll_direct_bit(const char *f, u32 l,
 289                                             struct iwl_priv *priv,
 290                                             u32 addr, u32 mask, int timeout)
 291 {
 292         int ret  = _iwl_poll_direct_bit(priv, addr, mask, timeout);
 293
 294         if (unlikely(ret == -ETIMEDOUT))
 295                 IWL_DEBUG_IO("poll_direct_bit(0x%08X, 0x%08X) - "
 296                              "timedout - %s %d\n", addr, mask, f, l);
 297         else
 298                 IWL_DEBUG_IO("poll_direct_bit(0x%08X, 0x%08X) = 0x%08X "
 299                              "- %s %d\n", addr, mask, ret, f, l);
 300         return ret;
 301 }
 302 #define iwl_poll_direct_bit(priv, addr, mask, timeout) \
 303         __iwl_poll_direct_bit(__FILE__, __LINE__, priv, addr, mask, timeout)
 304 #else
 305 #define iwl_poll_direct_bit _iwl_poll_direct_bit
 306 #endif
 307
 308 static inline u32 _iwl_read_prph(struct iwl_priv *priv, u32 reg)
 309 {
 310         _iwl_write_direct32(priv, HBUS_TARG_PRPH_RADDR, reg | (3 << 24));
 311         return _iwl_read_direct32(priv, HBUS_TARG_PRPH_RDAT);
 312 }
 313 #ifdef CONFIG_IWLWIFI_DEBUG
 314 static inline u32 __iwl_read_prph(const char *f, u32 line,
 315                                   struct iwl_priv *priv, u32 reg)
 316 {
 317         if (!atomic_read(&priv->restrict_refcnt))
 318                 IWL_ERROR("Nic access not held from %s line %d\n", f, line);
 319         return _iwl_read_prph(priv, reg);
 320 }
 321
 322 #define iwl_read_prph(priv, reg) \
 323         __iwl_read_prph(__func__, __LINE__, priv, reg)
 324 #else
 325 #define iwl_read_prph _iwl_read_prph
 326 #endif
 327
 328 static inline void _iwl_write_prph(struct iwl_priv *priv,
 329                                              u32 addr, u32 val)
 330 {
 331         _iwl_write_direct32(priv, HBUS_TARG_PRPH_WADDR,
 332                               ((addr & 0x0000FFFF) | (3 << 24)));
 333         _iwl_write_direct32(priv, HBUS_TARG_PRPH_WDAT, val);
 334 }
 335 #ifdef CONFIG_IWLWIFI_DEBUG
 336 static inline void __iwl_write_prph(const char *f, u32 line,
 337                                     struct iwl_priv *priv, u32 addr, u32 val)
 338 {
 339         if (!atomic_read(&priv->restrict_refcnt))
 340                 IWL_ERROR("Nic access not held from %s line %d\n", f, line);
 341         _iwl_write_prph(priv, addr, val);
 342 }
 343
 344 #define iwl_write_prph(priv, addr, val) \
 345         __iwl_write_prph(__func__, __LINE__, priv, addr, val);
 346 #else
 347 #define iwl_write_prph _iwl_write_prph
 348 #endif
 349
 350 #define _iwl_set_bits_prph(priv, reg, mask) \
 351         _iwl_write_prph(priv, reg, (_iwl_read_prph(priv, reg) | mask))
 352 #ifdef CONFIG_IWLWIFI_DEBUG
 353 static inline void __iwl_set_bits_prph(const char *f, u32 line,
 354                                        struct iwl_priv *priv,
 355                                        u32 reg, u32 mask)
 356 {
 357         if (!atomic_read(&priv->restrict_refcnt))
 358                 IWL_ERROR("Nic access not held from %s line %d\n", f, line);
 359
 360         _iwl_set_bits_prph(priv, reg, mask);
 361 }
 362 #define iwl_set_bits_prph(priv, reg, mask) \
 363         __iwl_set_bits_prph(__func__, __LINE__, priv, reg, mask)
 364 #else
 365 #define iwl_set_bits_prph _iwl_set_bits_prph
 366 #endif
 367
 368 #define _iwl_set_bits_mask_prph(priv, reg, bits, mask) \
 369         _iwl_write_prph(priv, reg, ((_iwl_read_prph(priv, reg) & mask) | bits))
 370
 371 #ifdef CONFIG_IWLWIFI_DEBUG
 372 static inline void __iwl_set_bits_mask_prph(const char *f, u32 line,
 373                 struct iwl_priv *priv, u32 reg, u32 bits, 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         _iwl_set_bits_mask_prph(priv, reg, bits, mask);
 378 }
 379 #define iwl_set_bits_mask_prph(priv, reg, bits, mask) \
 380         __iwl_set_bits_mask_prph(__func__, __LINE__, priv, reg, bits, mask)
 381 #else
 382 #define iwl_set_bits_mask_prph _iwl_set_bits_mask_prph
 383 #endif
 384
 385 static inline void iwl_clear_bits_prph(struct iwl_priv
 386                                                  *priv, u32 reg, u32 mask)
 387 {
 388         u32 val = _iwl_read_prph(priv, reg);
 389         _iwl_write_prph(priv, reg, (val & ~mask));
 390 }
 391
 392 static inline u32 iwl_read_targ_mem(struct iwl_priv *priv, u32 addr)
 393 {
 394         iwl_write_direct32(priv, HBUS_TARG_MEM_RADDR, addr);
 395         return iwl_read_direct32(priv, HBUS_TARG_MEM_RDAT);
 396 }
 397
 398 static inline void iwl_write_targ_mem(struct iwl_priv *priv, u32 addr, u32 val)
 399 {
 400         iwl_write_direct32(priv, HBUS_TARG_MEM_WADDR, addr);
 401         iwl_write_direct32(priv, HBUS_TARG_MEM_WDAT, val);
 402 }
 403
 404 static inline void iwl_write_targ_mem_buf(struct iwl_priv *priv, u32 addr,
 405                                           u32 len, u32 *values)
 406 {
 407         iwl_write_direct32(priv, HBUS_TARG_MEM_WADDR, addr);
 408         for (; 0 < len; len -= sizeof(u32), values++)
 409                 iwl_write_direct32(priv, HBUS_TARG_MEM_WDAT, *values);
 410 }
 411 #endif