LXR linux/drivers/net/wireless/intel/iwlwifi/iwl-io.h

   1/******************************************************************************
   2 *
   3 * This file is provided under a dual BSD/GPLv2 license.  When using or
   4 * redistributing this file, you may do so under either license.
   5 *
   6 * GPL LICENSE SUMMARY
   7 *
   8 * Copyright (C) 2018 - 2019 Intel Corporation
   9 *
  10 * This program is free software; you can redistribute it and/or modify it
  11 * under the terms of version 2 of the GNU General Public License as
  12 * published by the Free Software Foundation.
  13 *
  14 * This program is distributed in the hope that it will be useful, but WITHOUT
  15 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  16 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
  17 * more details.
  18 *
  19 * The full GNU General Public License is included in this distribution in the
  20 * file called COPYING.
  21 *
  22 * Contact Information:
  23 *  Intel Linux Wireless <linuxwifi@intel.com>
  24 * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
  25 *
  26 * BSD LICENSE
  27 *
  28 * Copyright (C) 2018 - 2019 Intel Corporation
  29 * All rights reserved.
  30 *
  31 * Redistribution and use in source and binary forms, with or without
  32 * modification, are permitted provided that the following conditions
  33 * are met:
  34 *
  35 *  * Redistributions of source code must retain the above copyright
  36 *    notice, this list of conditions and the following disclaimer.
  37 *  * Redistributions in binary form must reproduce the above copyright
  38 *    notice, this list of conditions and the following disclaimer in
  39 *    the documentation and/or other materials provided with the
  40 *    distribution.
  41 *  * Neither the name Intel Corporation nor the names of its
  42 *    contributors may be used to endorse or promote products derived
  43 *    from this software without specific prior written permission.
  44 *
  45 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  46 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  47 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  48 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  49 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  50 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  51 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  52 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  53 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  54 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  55 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  56 *
  57 *****************************************************************************/
  58#ifndef __iwl_io_h__
  59#define __iwl_io_h__
  60
  61#include "iwl-devtrace.h"
  62#include "iwl-trans.h"
  63
  64void iwl_write8(struct iwl_trans *trans, u32 ofs, u8 val);
  65void iwl_write32(struct iwl_trans *trans, u32 ofs, u32 val);
  66void iwl_write64(struct iwl_trans *trans, u64 ofs, u64 val);
  67u32 iwl_read32(struct iwl_trans *trans, u32 ofs);
  68
  69static inline void iwl_set_bit(struct iwl_trans *trans, u32 reg, u32 mask)
  70{
  71        iwl_trans_set_bits_mask(trans, reg, mask, mask);
  72}
  73
  74static inline void iwl_clear_bit(struct iwl_trans *trans, u32 reg, u32 mask)
  75{
  76        iwl_trans_set_bits_mask(trans, reg, mask, 0);
  77}
  78
  79int iwl_poll_bit(struct iwl_trans *trans, u32 addr,
  80                 u32 bits, u32 mask, int timeout);
  81int iwl_poll_direct_bit(struct iwl_trans *trans, u32 addr, u32 mask,
  82                        int timeout);
  83
  84u32 iwl_read_direct32(struct iwl_trans *trans, u32 reg);
  85void iwl_write_direct32(struct iwl_trans *trans, u32 reg, u32 value);
  86void iwl_write_direct64(struct iwl_trans *trans, u64 reg, u64 value);
  87
  88
  89u32 iwl_read_prph_no_grab(struct iwl_trans *trans, u32 ofs);
  90u32 iwl_read_prph(struct iwl_trans *trans, u32 ofs);
  91void iwl_write_prph_no_grab(struct iwl_trans *trans, u32 ofs, u32 val);
  92void iwl_write_prph64_no_grab(struct iwl_trans *trans, u64 ofs, u64 val);
  93void iwl_write_prph(struct iwl_trans *trans, u32 ofs, u32 val);
  94int iwl_poll_prph_bit(struct iwl_trans *trans, u32 addr,
  95                      u32 bits, u32 mask, int timeout);
  96void iwl_set_bits_prph(struct iwl_trans *trans, u32 ofs, u32 mask);
  97void iwl_set_bits_mask_prph(struct iwl_trans *trans, u32 ofs,
  98                            u32 bits, u32 mask);
  99void iwl_clear_bits_prph(struct iwl_trans *trans, u32 ofs, u32 mask);
 100void iwl_force_nmi(struct iwl_trans *trans);
 101
 102int iwl_finish_nic_init(struct iwl_trans *trans,
 103                        const struct iwl_cfg_trans_params *cfg_trans);
 104
 105/* Error handling */
 106int iwl_dump_fh(struct iwl_trans *trans, char **buf);
 107
 108/*
 109 * UMAC periphery address space changed from 0xA00000 to 0xD00000 starting from
 110 * device family AX200. So peripheries used in families above and below AX200
 111 * should go through iwl_..._umac_..._prph.
 112 */
 113static inline u32 iwl_umac_prph(struct iwl_trans *trans, u32 ofs)
 114{
 115        return ofs + trans->trans_cfg->umac_prph_offset;
 116}
 117
 118static inline u32 iwl_read_umac_prph_no_grab(struct iwl_trans *trans, u32 ofs)
 119{
 120        return iwl_read_prph_no_grab(trans, ofs +
 121                                     trans->trans_cfg->umac_prph_offset);
 122}
 123
 124static inline u32 iwl_read_umac_prph(struct iwl_trans *trans, u32 ofs)
 125{
 126        return iwl_read_prph(trans, ofs + trans->trans_cfg->umac_prph_offset);
 127}
 128
 129static inline void iwl_write_umac_prph_no_grab(struct iwl_trans *trans, u32 ofs,
 130                                               u32 val)
 131{
 132        iwl_write_prph_no_grab(trans,  ofs + trans->trans_cfg->umac_prph_offset,
 133                               val);
 134}
 135
 136static inline void iwl_write_umac_prph(struct iwl_trans *trans, u32 ofs,
 137                                       u32 val)
 138{
 139        iwl_write_prph(trans,  ofs + trans->trans_cfg->umac_prph_offset, val);
 140}
 141
 142static inline int iwl_poll_umac_prph_bit(struct iwl_trans *trans, u32 addr,
 143                                         u32 bits, u32 mask, int timeout)
 144{
 145        return iwl_poll_prph_bit(trans, addr +
 146                                 trans->trans_cfg->umac_prph_offset,
 147                                 bits, mask, timeout);
 148}
 149
 150#endif
 151