1 /* QLogic qed NIC Driver
2 * Copyright (c) 2015 QLogic Corporation
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
10 #define _QED_DEV_API_H
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>
20 * @brief qed_init_dp - initialize the debug level
26 void qed_init_dp(struct qed_dev *cdev,
31 * @brief qed_init_struct - initialize the device structure to
36 void qed_init_struct(struct qed_dev *cdev);
39 * @brief qed_resc_free -
43 void qed_resc_free(struct qed_dev *cdev);
46 * @brief qed_resc_alloc -
52 int qed_resc_alloc(struct qed_dev *cdev);
55 * @brief qed_resc_setup -
59 void qed_resc_setup(struct qed_dev *cdev);
62 * @brief qed_hw_init -
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.
74 int qed_hw_init(struct qed_dev *cdev,
76 enum qed_int_mode int_mode,
77 bool allow_npar_tx_switch,
78 const u8 *bin_fw_data);
81 * @brief qed_hw_stop -
87 int qed_hw_stop(struct qed_dev *cdev);
90 * @brief qed_hw_reset -
96 int qed_hw_reset(struct qed_dev *cdev);
99 * @brief qed_hw_prepare -
102 * @param personality - personality to initialize
106 int qed_hw_prepare(struct qed_dev *cdev,
110 * @brief qed_hw_remove -
114 void qed_hw_remove(struct qed_dev *cdev);
117 * @brief qed_ptt_acquire - Allocate a PTT window
119 * Should be called at the entry point to the driver (at the beginning of an
124 * @return struct qed_ptt
126 struct qed_ptt *qed_ptt_acquire(struct qed_hwfn *p_hwfn);
129 * @brief qed_ptt_release - Release PTT Window
131 * Should be called at the end of a flow - at the end of the function that
138 void qed_ptt_release(struct qed_hwfn *p_hwfn,
139 struct qed_ptt *p_ptt);
141 enum qed_dmae_address_type_t {
142 QED_DMAE_ADDRESS_HOST_VIRT,
143 QED_DMAE_ADDRESS_HOST_PHYS,
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
154 #define QED_DMAE_FLAG_RW_REPL_SRC 0x00000001
155 #define QED_DMAE_FLAG_COMPLETION_DST 0x00000008
157 struct qed_dmae_params {
158 u32 flags; /* consists of QED_DMAE_FLAG_* values */
162 * @brief qed_dmae_host2grc - copy data from source addr to
163 * dmae registers using the given ptt
168 * @param grc_addr (dmae_data_offset)
169 * @param size_in_dwords
170 * @param flags (one of the flags defined above)
173 qed_dmae_host2grc(struct qed_hwfn *p_hwfn,
174 struct qed_ptt *p_ptt,
181 * @brief qed_chain_alloc - Allocate and initialize a chain
184 * @param intended_use
193 qed_chain_alloc(struct qed_dev *cdev,
194 enum qed_chain_use_mode intended_use,
195 enum qed_chain_mode mode,
198 struct qed_chain *p_chain);
201 * @brief qed_chain_free - Free chain DMA memory
206 void qed_chain_free(struct qed_dev *cdev,
207 struct qed_chain *p_chain);
210 * *@brief Cleanup of previous driver remains prior to load
214 * @param id - For PF, engine-relative. For VF, PF-relative.
218 int qed_final_cleanup(struct qed_hwfn *p_hwfn,
219 struct qed_ptt *p_ptt,