drivers/net/ethernet/qlogic/qed/qed_dev_api.h

   1 /* QLogic qed NIC Driver
   2  * Copyright (c) 2015 QLogic Corporation
   3  *
   4  * This software is available under the terms of the GNU General Public License
   5  * (GPL) Version 2, available from the file COPYING in the main directory of
   6  * this source tree.
   7  */
   8
   9 #ifndef _QED_DEV_API_H
  10 #define _QED_DEV_API_H
  11
  12 #include <linux/types.h>
  13 #include <linux/kernel.h>
  14 #include <linux/slab.h>
  15 #include <linux/qed/qed_chain.h>
  16 #include <linux/qed/qed_if.h>
  17 #include "qed_int.h"
  18
  19 /**
  20  * @brief qed_init_dp - initialize the debug level
  21  *
  22  * @param cdev
  23  * @param dp_module
  24  * @param dp_level
  25  */
  26 void qed_init_dp(struct qed_dev *cdev,
  27                  u32 dp_module,
  28                  u8 dp_level);
  29
  30 /**
  31  * @brief qed_init_struct - initialize the device structure to
  32  *        its defaults
  33  *
  34  * @param cdev
  35  */
  36 void qed_init_struct(struct qed_dev *cdev);
  37
  38 /**
  39  * @brief qed_resc_free -
  40  *
  41  * @param cdev
  42  */
  43 void qed_resc_free(struct qed_dev *cdev);
  44
  45 /**
  46  * @brief qed_resc_alloc -
  47  *
  48  * @param cdev
  49  *
  50  * @return int
  51  */
  52 int qed_resc_alloc(struct qed_dev *cdev);
  53
  54 /**
  55  * @brief qed_resc_setup -
  56  *
  57  * @param cdev
  58  */
  59 void qed_resc_setup(struct qed_dev *cdev);
  60
  61 /**
  62  * @brief qed_hw_init -
  63  *
  64  * @param cdev
  65  * @param b_hw_start
  66  * @param int_mode - interrupt mode [msix, inta, etc.] to use.
  67  * @param allow_npar_tx_switch - npar tx switching to be used
  68  *        for vports configured for tx-switching.
  69  * @param bin_fw_data - binary fw data pointer in binary fw file.
  70  *                      Pass NULL if not using binary fw file.
  71  *
  72  * @return int
  73  */
  74 int qed_hw_init(struct qed_dev *cdev,
  75                 bool b_hw_start,
  76                 enum qed_int_mode int_mode,
  77                 bool allow_npar_tx_switch,
  78                 const u8 *bin_fw_data);
  79
  80 /**
  81  * @brief qed_hw_stop -
  82  *
  83  * @param cdev
  84  *
  85  * @return int
  86  */
  87 int qed_hw_stop(struct qed_dev *cdev);
  88
  89 /**
  90  * @brief qed_hw_reset -
  91  *
  92  * @param cdev
  93  *
  94  * @return int
  95  */
  96 int qed_hw_reset(struct qed_dev *cdev);
  97
  98 /**
  99  * @brief qed_hw_prepare -
 100  *
 101  * @param cdev
 102  * @param personality - personality to initialize
 103  *
 104  * @return int
 105  */
 106 int qed_hw_prepare(struct qed_dev *cdev,
 107                    int personality);
 108
 109 /**
 110  * @brief qed_hw_remove -
 111  *
 112  * @param cdev
 113  */
 114 void qed_hw_remove(struct qed_dev *cdev);
 115
 116 /**
 117  * @brief qed_ptt_acquire - Allocate a PTT window
 118  *
 119  * Should be called at the entry point to the driver (at the beginning of an
 120  * exported function)
 121  *
 122  * @param p_hwfn
 123  *
 124  * @return struct qed_ptt
 125  */
 126 struct qed_ptt *qed_ptt_acquire(struct qed_hwfn *p_hwfn);
 127
 128 /**
 129  * @brief qed_ptt_release - Release PTT Window
 130  *
 131  * Should be called at the end of a flow - at the end of the function that
 132  * acquired the PTT.
 133  *
 134  *
 135  * @param p_hwfn
 136  * @param p_ptt
 137  */
 138 void qed_ptt_release(struct qed_hwfn *p_hwfn,
 139                      struct qed_ptt *p_ptt);
 140
 141 enum qed_dmae_address_type_t {
 142         QED_DMAE_ADDRESS_HOST_VIRT,
 143         QED_DMAE_ADDRESS_HOST_PHYS,
 144         QED_DMAE_ADDRESS_GRC
 145 };
 146
 147 /* value of flags If QED_DMAE_FLAG_RW_REPL_SRC flag is set and the
 148  * source is a block of length DMAE_MAX_RW_SIZE and the
 149  * destination is larger, the source block will be duplicated as
 150  * many times as required to fill the destination block. This is
 151  * used mostly to write a zeroed buffer to destination address
 152  * using DMA
 153  */
 154 #define QED_DMAE_FLAG_RW_REPL_SRC       0x00000001
 155 #define QED_DMAE_FLAG_COMPLETION_DST    0x00000008
 156
 157 struct qed_dmae_params {
 158         u32     flags; /* consists of QED_DMAE_FLAG_* values */
 159 };
 160
 161 /**
 162  * @brief qed_dmae_host2grc - copy data from source addr to
 163  * dmae registers using the given ptt
 164  *
 165  * @param p_hwfn
 166  * @param p_ptt
 167  * @param source_addr
 168  * @param grc_addr (dmae_data_offset)
 169  * @param size_in_dwords
 170  * @param flags (one of the flags defined above)
 171  */
 172 int
 173 qed_dmae_host2grc(struct qed_hwfn *p_hwfn,
 174                   struct qed_ptt *p_ptt,
 175                   u64 source_addr,
 176                   u32 grc_addr,
 177                   u32 size_in_dwords,
 178                   u32 flags);
 179
 180 /**
 181  * @brief qed_chain_alloc - Allocate and initialize a chain
 182  *
 183  * @param p_hwfn
 184  * @param intended_use
 185  * @param mode
 186  * @param num_elems
 187  * @param elem_size
 188  * @param p_chain
 189  *
 190  * @return int
 191  */
 192 int
 193 qed_chain_alloc(struct qed_dev *cdev,
 194                 enum qed_chain_use_mode intended_use,
 195                 enum qed_chain_mode mode,
 196                 u16 num_elems,
 197                 size_t elem_size,
 198                 struct qed_chain *p_chain);
 199
 200 /**
 201  * @brief qed_chain_free - Free chain DMA memory
 202  *
 203  * @param p_hwfn
 204  * @param p_chain
 205  */
 206 void qed_chain_free(struct qed_dev *cdev,
 207                     struct qed_chain *p_chain);
 208
 209 /**
 210  * *@brief Cleanup of previous driver remains prior to load
 211  *
 212  * @param p_hwfn
 213  * @param p_ptt
 214  * @param id - For PF, engine-relative. For VF, PF-relative.
 215  *
 216  * @return int
 217  */
 218 int qed_final_cleanup(struct qed_hwfn *p_hwfn,
 219                       struct qed_ptt *p_ptt,
 220                       u16 id);
 221
 222 #endif