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 p_tunn
  66  * @param b_hw_start
  67  * @param int_mode - interrupt mode [msix, inta, etc.] to use.
  68  * @param allow_npar_tx_switch - npar tx switching to be used
  69  *        for vports configured for tx-switching.
  70  * @param bin_fw_data - binary fw data pointer in binary fw file.
  71  *                      Pass NULL if not using binary fw file.
  72  *
  73  * @return int
  74  */
  75 int qed_hw_init(struct qed_dev *cdev,
  76                 struct qed_tunn_start_params *p_tunn,
  77                 bool b_hw_start,
  78                 enum qed_int_mode int_mode,
  79                 bool allow_npar_tx_switch,
  80                 const u8 *bin_fw_data);
  81
  82 /**
  83  * @brief qed_hw_timers_stop_all - stop the timers HW block
  84  *
  85  * @param cdev
  86  *
  87  * @return void
  88  */
  89 void qed_hw_timers_stop_all(struct qed_dev *cdev);
  90
  91 /**
  92  * @brief qed_hw_stop -
  93  *
  94  * @param cdev
  95  *
  96  * @return int
  97  */
  98 int qed_hw_stop(struct qed_dev *cdev);
  99
 100 /**
 101  * @brief qed_hw_stop_fastpath -should be called incase
 102  *              slowpath is still required for the device,
 103  *              but fastpath is not.
 104  *
 105  * @param cdev
 106  *
 107  */
 108 void qed_hw_stop_fastpath(struct qed_dev *cdev);
 109
 110 /**
 111  * @brief qed_hw_start_fastpath -restart fastpath traffic,
 112  *              only if hw_stop_fastpath was called
 113  *
 114  * @param cdev
 115  *
 116  */
 117 void qed_hw_start_fastpath(struct qed_hwfn *p_hwfn);
 118
 119 /**
 120  * @brief qed_hw_reset -
 121  *
 122  * @param cdev
 123  *
 124  * @return int
 125  */
 126 int qed_hw_reset(struct qed_dev *cdev);
 127
 128 /**
 129  * @brief qed_hw_prepare -
 130  *
 131  * @param cdev
 132  * @param personality - personality to initialize
 133  *
 134  * @return int
 135  */
 136 int qed_hw_prepare(struct qed_dev *cdev,
 137                    int personality);
 138
 139 /**
 140  * @brief qed_hw_remove -
 141  *
 142  * @param cdev
 143  */
 144 void qed_hw_remove(struct qed_dev *cdev);
 145
 146 /**
 147  * @brief qed_ptt_acquire - Allocate a PTT window
 148  *
 149  * Should be called at the entry point to the driver (at the beginning of an
 150  * exported function)
 151  *
 152  * @param p_hwfn
 153  *
 154  * @return struct qed_ptt
 155  */
 156 struct qed_ptt *qed_ptt_acquire(struct qed_hwfn *p_hwfn);
 157
 158 /**
 159  * @brief qed_ptt_release - Release PTT Window
 160  *
 161  * Should be called at the end of a flow - at the end of the function that
 162  * acquired the PTT.
 163  *
 164  *
 165  * @param p_hwfn
 166  * @param p_ptt
 167  */
 168 void qed_ptt_release(struct qed_hwfn *p_hwfn,
 169                      struct qed_ptt *p_ptt);
 170 void qed_reset_vport_stats(struct qed_dev *cdev);
 171
 172 enum qed_dmae_address_type_t {
 173         QED_DMAE_ADDRESS_HOST_VIRT,
 174         QED_DMAE_ADDRESS_HOST_PHYS,
 175         QED_DMAE_ADDRESS_GRC
 176 };
 177
 178 /* value of flags If QED_DMAE_FLAG_RW_REPL_SRC flag is set and the
 179  * source is a block of length DMAE_MAX_RW_SIZE and the
 180  * destination is larger, the source block will be duplicated as
 181  * many times as required to fill the destination block. This is
 182  * used mostly to write a zeroed buffer to destination address
 183  * using DMA
 184  */
 185 #define QED_DMAE_FLAG_RW_REPL_SRC       0x00000001
 186 #define QED_DMAE_FLAG_COMPLETION_DST    0x00000008
 187
 188 struct qed_dmae_params {
 189         u32     flags; /* consists of QED_DMAE_FLAG_* values */
 190 };
 191
 192 /**
 193  * @brief qed_dmae_host2grc - copy data from source addr to
 194  * dmae registers using the given ptt
 195  *
 196  * @param p_hwfn
 197  * @param p_ptt
 198  * @param source_addr
 199  * @param grc_addr (dmae_data_offset)
 200  * @param size_in_dwords
 201  * @param flags (one of the flags defined above)
 202  */
 203 int
 204 qed_dmae_host2grc(struct qed_hwfn *p_hwfn,
 205                   struct qed_ptt *p_ptt,
 206                   u64 source_addr,
 207                   u32 grc_addr,
 208                   u32 size_in_dwords,
 209                   u32 flags);
 210
 211 /**
 212  * @brief qed_chain_alloc - Allocate and initialize a chain
 213  *
 214  * @param p_hwfn
 215  * @param intended_use
 216  * @param mode
 217  * @param num_elems
 218  * @param elem_size
 219  * @param p_chain
 220  *
 221  * @return int
 222  */
 223 int
 224 qed_chain_alloc(struct qed_dev *cdev,
 225                 enum qed_chain_use_mode intended_use,
 226                 enum qed_chain_mode mode,
 227                 u16 num_elems,
 228                 size_t elem_size,
 229                 struct qed_chain *p_chain);
 230
 231 /**
 232  * @brief qed_chain_free - Free chain DMA memory
 233  *
 234  * @param p_hwfn
 235  * @param p_chain
 236  */
 237 void qed_chain_free(struct qed_dev *cdev,
 238                     struct qed_chain *p_chain);
 239
 240 /**
 241  * @@brief qed_fw_l2_queue - Get absolute L2 queue ID
 242  *
 243  *  @param p_hwfn
 244  *  @param src_id - relative to p_hwfn
 245  *  @param dst_id - absolute per engine
 246  *
 247  *  @return int
 248  */
 249 int qed_fw_l2_queue(struct qed_hwfn *p_hwfn,
 250                     u16 src_id,
 251                     u16 *dst_id);
 252
 253 /**
 254  * @@brief qed_fw_vport - Get absolute vport ID
 255  *
 256  *  @param p_hwfn
 257  *  @param src_id - relative to p_hwfn
 258  *  @param dst_id - absolute per engine
 259  *
 260  *  @return int
 261  */
 262 int qed_fw_vport(struct qed_hwfn *p_hwfn,
 263                  u8 src_id,
 264                  u8 *dst_id);
 265
 266 /**
 267  * @@brief qed_fw_rss_eng - Get absolute RSS engine ID
 268  *
 269  *  @param p_hwfn
 270  *  @param src_id - relative to p_hwfn
 271  *  @param dst_id - absolute per engine
 272  *
 273  *  @return int
 274  */
 275 int qed_fw_rss_eng(struct qed_hwfn *p_hwfn,
 276                    u8 src_id,
 277                    u8 *dst_id);
 278
 279 /**
 280  * *@brief Cleanup of previous driver remains prior to load
 281  *
 282  * @param p_hwfn
 283  * @param p_ptt
 284  * @param id - For PF, engine-relative. For VF, PF-relative.
 285  *
 286  * @return int
 287  */
 288 int qed_final_cleanup(struct qed_hwfn *p_hwfn,
 289                       struct qed_ptt *p_ptt,
 290                       u16 id);
 291
 292 #endif