2 * Copyright (c) 2016 QLogic Corporation.
6 * See LICENSE.qede_pmd for copyright and licensing details.
10 #define __ECORE_HW_H__
13 #include "ecore_dev_api.h"
15 /* Forward decleration */
20 RESERVED_PTT_USER_SPACE,
26 /* @@@TMP - in earlier versions of the emulation, the HW lock started from 1
27 * instead of 0, this should be fixed in later HW versions.
29 #ifndef MISC_REG_DRIVER_CONTROL_0
30 #define MISC_REG_DRIVER_CONTROL_0 MISC_REG_DRIVER_CONTROL_1
32 #ifndef MISC_REG_DRIVER_CONTROL_0_SIZE
33 #define MISC_REG_DRIVER_CONTROL_0_SIZE MISC_REG_DRIVER_CONTROL_1_SIZE
36 enum _dmae_cmd_dst_mask {
37 DMAE_CMD_DST_MASK_NONE = 0,
38 DMAE_CMD_DST_MASK_PCIE = 1,
39 DMAE_CMD_DST_MASK_GRC = 2
42 enum _dmae_cmd_src_mask {
43 DMAE_CMD_SRC_MASK_PCIE = 0,
44 DMAE_CMD_SRC_MASK_GRC = 1
47 enum _dmae_cmd_crc_mask {
48 DMAE_CMD_COMP_CRC_EN_MASK_NONE = 0,
49 DMAE_CMD_COMP_CRC_EN_MASK_SET = 1
52 /* definitions for DMA constants */
53 #define DMAE_GO_VALUE 0x1
56 #define DMAE_COMPLETION_VAL 0xAED10000
57 #define DMAE_CMD_ENDIANITY 0x3
59 #define DMAE_COMPLETION_VAL 0xD1AE
60 #define DMAE_CMD_ENDIANITY 0x2
63 #define DMAE_CMD_SIZE 14
64 /* size of DMAE command structure to fill.. DMAE_CMD_SIZE-5 */
65 #define DMAE_CMD_SIZE_TO_FILL (DMAE_CMD_SIZE - 5)
66 /* Minimum wait for dmae opertaion to complete 2 milliseconds */
67 #define DMAE_MIN_WAIT_TIME 0x2
68 #define DMAE_MAX_CLIENTS 32
71 * @brief ecore_gtt_init - Initialize GTT windows
75 void ecore_gtt_init(struct ecore_hwfn *p_hwfn);
78 * @brief ecore_ptt_invalidate - Forces all ptt entries to be re-configured
82 void ecore_ptt_invalidate(struct ecore_hwfn *p_hwfn);
85 * @brief ecore_ptt_pool_alloc - Allocate and initialize PTT pool
89 * @return _ecore_status_t - success (0), negative - error.
91 enum _ecore_status_t ecore_ptt_pool_alloc(struct ecore_hwfn *p_hwfn);
94 * @brief ecore_ptt_pool_free -
98 void ecore_ptt_pool_free(struct ecore_hwfn *p_hwfn);
101 * @brief ecore_ptt_get_hw_addr - Get PTT's GRC/HW address
108 u32 ecore_ptt_get_hw_addr(struct ecore_hwfn *p_hwfn, struct ecore_ptt *p_ptt);
111 * @brief ecore_ptt_get_bar_addr - Get PPT's external BAR address
118 u32 ecore_ptt_get_bar_addr(struct ecore_ptt *p_ptt);
121 * @brief ecore_ptt_set_win - Set PTT Window's GRC BAR address
127 void ecore_ptt_set_win(struct ecore_hwfn *p_hwfn,
128 struct ecore_ptt *p_ptt, u32 new_hw_addr);
131 * @brief ecore_get_reserved_ptt - Get a specific reserved PTT
136 * @return struct ecore_ptt *
138 struct ecore_ptt *ecore_get_reserved_ptt(struct ecore_hwfn *p_hwfn,
139 enum reserved_ptts ptt_idx);
142 * @brief ecore_wr - Write value to BAR using the given ptt
149 void ecore_wr(struct ecore_hwfn *p_hwfn,
150 struct ecore_ptt *p_ptt, u32 hw_addr, u32 val);
153 * @brief ecore_rd - Read value from BAR using the given ptt
160 u32 ecore_rd(struct ecore_hwfn *p_hwfn, struct ecore_ptt *p_ptt, u32 hw_addr);
163 * @brief ecore_memcpy_from - copy n bytes from BAR using the given
172 void ecore_memcpy_from(struct ecore_hwfn *p_hwfn,
173 struct ecore_ptt *p_ptt,
174 void *dest, u32 hw_addr, osal_size_t n);
177 * @brief ecore_memcpy_to - copy n bytes to BAR using the given
186 void ecore_memcpy_to(struct ecore_hwfn *p_hwfn,
187 struct ecore_ptt *p_ptt,
188 u32 hw_addr, void *src, osal_size_t n);
190 * @brief ecore_fid_pretend - pretend to another function when
191 * accessing the ptt window. There is no way to unpretend
192 * a function. The only way to cancel a pretend is to
193 * pretend back to the original function.
197 * @param fid - fid field of pxp_pretend structure. Can contain
198 * either pf / vf, port/path fields are don't care.
200 void ecore_fid_pretend(struct ecore_hwfn *p_hwfn,
201 struct ecore_ptt *p_ptt, u16 fid);
204 * @brief ecore_port_pretend - pretend to another port when
205 * accessing the ptt window
209 * @param port_id - the port to pretend to
211 void ecore_port_pretend(struct ecore_hwfn *p_hwfn,
212 struct ecore_ptt *p_ptt, u8 port_id);
215 * @brief ecore_port_unpretend - cancel any previously set port
221 void ecore_port_unpretend(struct ecore_hwfn *p_hwfn, struct ecore_ptt *p_ptt);
224 * @brief ecore_vfid_to_concrete - build a concrete FID for a
231 u32 ecore_vfid_to_concrete(struct ecore_hwfn *p_hwfn, u8 vfid);
234 * @brief ecore_dmae_info_alloc - Init the dmae_info structure
235 * which is part of p_hwfn.
238 enum _ecore_status_t ecore_dmae_info_alloc(struct ecore_hwfn *p_hwfn);
241 * @brief ecore_dmae_info_free - Free the dmae_info structure
242 * which is part of p_hwfn
246 void ecore_dmae_info_free(struct ecore_hwfn *p_hwfn);
248 union ecore_qm_pq_params {
260 u16 ecore_get_qm_pq(struct ecore_hwfn *p_hwfn,
261 enum protocol_type proto, union ecore_qm_pq_params *params);
263 enum _ecore_status_t ecore_init_fw_data(struct ecore_dev *p_dev,
266 void ecore_hw_err_notify(struct ecore_hwfn *p_hwfn,
267 enum ecore_hw_err_type err_type);
269 #endif /* __ECORE_HW_H__ */