1/*******************************************************************************
2*
3* Copyright (c) 2015-2016 Intel Corporation.  All rights reserved.
4*
5* This software is available to you under a choice of one of two
6* licenses.  You may choose to be licensed under the terms of the GNU
7* General Public License (GPL) Version 2, available from the file
8* COPYING in the main directory of this source tree, or the
9* OpenFabrics.org BSD license below:
10*
11*   Redistribution and use in source and binary forms, with or
12*   without modification, are permitted provided that the following
13*   conditions are met:
14*
15*    - Redistributions of source code must retain the above
16*	copyright notice, this list of conditions and the following
17*	disclaimer.
18*
19*    - Redistributions in binary form must reproduce the above
20*	copyright notice, this list of conditions and the following
21*	disclaimer in the documentation and/or other materials
22*	provided with the distribution.
23*
24* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
25* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
26* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
27* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
28* BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
29* ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
30* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
31* SOFTWARE.
32*
33*******************************************************************************/
34
35#ifndef I40IW_OSDEP_H
36#define I40IW_OSDEP_H
37
38#include <linux/kernel.h>
39#include <linux/string.h>
40#include <linux/bitops.h>
41#include <net/tcp.h>
42#include <crypto/hash.h>
43/* get readq/writeq support for 32 bit kernels, use the low-first version */
44#include <linux/io-64-nonatomic-lo-hi.h>
45
46#define STATS_TIMER_DELAY 1000
47
48static inline void set_64bit_val(u64 *wqe_words, u32 byte_index, u64 value)
49{
50	wqe_words[byte_index >> 3] = value;
51}
52
53/**
54 * set_32bit_val - set 32 value to hw wqe
55 * @wqe_words: wqe addr to write
56 * @byte_index: index in wqe
57 * @value: value to write
58 **/
59static inline void set_32bit_val(u32 *wqe_words, u32 byte_index, u32 value)
60{
61	wqe_words[byte_index >> 2] = value;
62}
63
64/**
65 * get_64bit_val - read 64 bit value from wqe
66 * @wqe_words: wqe addr
67 * @byte_index: index to read from
68 * @value: read value
69 **/
70static inline void get_64bit_val(u64 *wqe_words, u32 byte_index, u64 *value)
71{
72	*value = wqe_words[byte_index >> 3];
73}
74
75/**
76 * get_32bit_val - read 32 bit value from wqe
77 * @wqe_words: wqe addr
78 * @byte_index: index to reaad from
79 * @value: return 32 bit value
80 **/
81static inline void get_32bit_val(u32 *wqe_words, u32 byte_index, u32 *value)
82{
83	*value = wqe_words[byte_index >> 2];
84}
85
86struct i40iw_dma_mem {
87	void *va;
88	dma_addr_t pa;
89	u32 size;
90} __packed;
91
92struct i40iw_virt_mem {
93	void *va;
94	u32 size;
95} __packed;
96
97#define i40iw_debug(h, m, s, ...)                               \
98do {                                                            \
99	if (((m) & (h)->debug_mask))                            \
100		pr_info("i40iw " s, ##__VA_ARGS__);             \
101} while (0)
102
103#define i40iw_flush(a)          readl((a)->hw_addr + I40E_GLGEN_STAT)
104
105#define I40E_GLHMC_VFSDCMD(_i)  (0x000C8000 + ((_i) * 4)) \
106				/* _i=0...31 */
107#define I40E_GLHMC_VFSDCMD_MAX_INDEX    31
108#define I40E_GLHMC_VFSDCMD_PMSDIDX_SHIFT  0
109#define I40E_GLHMC_VFSDCMD_PMSDIDX_MASK  (0xFFF \
110					  << I40E_GLHMC_VFSDCMD_PMSDIDX_SHIFT)
111#define I40E_GLHMC_VFSDCMD_PF_SHIFT       16
112#define I40E_GLHMC_VFSDCMD_PF_MASK        (0xF << I40E_GLHMC_VFSDCMD_PF_SHIFT)
113#define I40E_GLHMC_VFSDCMD_VF_SHIFT       20
114#define I40E_GLHMC_VFSDCMD_VF_MASK        (0x1FF << I40E_GLHMC_VFSDCMD_VF_SHIFT)
115#define I40E_GLHMC_VFSDCMD_PMF_TYPE_SHIFT 29
116#define I40E_GLHMC_VFSDCMD_PMF_TYPE_MASK  (0x3 \
117					   << I40E_GLHMC_VFSDCMD_PMF_TYPE_SHIFT)
118#define I40E_GLHMC_VFSDCMD_PMSDWR_SHIFT   31
119#define I40E_GLHMC_VFSDCMD_PMSDWR_MASK  (0x1 << I40E_GLHMC_VFSDCMD_PMSDWR_SHIFT)
120
121#define I40E_GLHMC_VFSDDATAHIGH(_i)     (0x000C8200 + ((_i) * 4)) \
122				/* _i=0...31 */
123#define I40E_GLHMC_VFSDDATAHIGH_MAX_INDEX       31
124#define I40E_GLHMC_VFSDDATAHIGH_PMSDDATAHIGH_SHIFT 0
125#define I40E_GLHMC_VFSDDATAHIGH_PMSDDATAHIGH_MASK  (0xFFFFFFFF \
126			<< I40E_GLHMC_VFSDDATAHIGH_PMSDDATAHIGH_SHIFT)
127
128#define I40E_GLHMC_VFSDDATALOW(_i)      (0x000C8100 + ((_i) * 4)) \
129				/* _i=0...31 */
130#define I40E_GLHMC_VFSDDATALOW_MAX_INDEX        31
131#define I40E_GLHMC_VFSDDATALOW_PMSDVALID_SHIFT   0
132#define I40E_GLHMC_VFSDDATALOW_PMSDVALID_MASK  (0x1 \
133			<< I40E_GLHMC_VFSDDATALOW_PMSDVALID_SHIFT)
134#define I40E_GLHMC_VFSDDATALOW_PMSDTYPE_SHIFT    1
135#define I40E_GLHMC_VFSDDATALOW_PMSDTYPE_MASK  (0x1 \
136			<< I40E_GLHMC_VFSDDATALOW_PMSDTYPE_SHIFT)
137#define I40E_GLHMC_VFSDDATALOW_PMSDBPCOUNT_SHIFT 2
138#define I40E_GLHMC_VFSDDATALOW_PMSDBPCOUNT_MASK  (0x3FF \
139			<< I40E_GLHMC_VFSDDATALOW_PMSDBPCOUNT_SHIFT)
140#define I40E_GLHMC_VFSDDATALOW_PMSDDATALOW_SHIFT 12
141#define I40E_GLHMC_VFSDDATALOW_PMSDDATALOW_MASK  (0xFFFFF \
142			<< I40E_GLHMC_VFSDDATALOW_PMSDDATALOW_SHIFT)
143
144#define I40E_GLPE_FWLDSTATUS                     0x0000D200
145#define I40E_GLPE_FWLDSTATUS_LOAD_REQUESTED_SHIFT 0
146#define I40E_GLPE_FWLDSTATUS_LOAD_REQUESTED_MASK  (0x1 \
147			<< I40E_GLPE_FWLDSTATUS_LOAD_REQUESTED_SHIFT)
148#define I40E_GLPE_FWLDSTATUS_DONE_SHIFT           1
149#define I40E_GLPE_FWLDSTATUS_DONE_MASK  (0x1 << I40E_GLPE_FWLDSTATUS_DONE_SHIFT)
150#define I40E_GLPE_FWLDSTATUS_CQP_FAIL_SHIFT       2
151#define I40E_GLPE_FWLDSTATUS_CQP_FAIL_MASK  (0x1 \
152			 << I40E_GLPE_FWLDSTATUS_CQP_FAIL_SHIFT)
153#define I40E_GLPE_FWLDSTATUS_TEP_FAIL_SHIFT       3
154#define I40E_GLPE_FWLDSTATUS_TEP_FAIL_MASK  (0x1 \
155			 << I40E_GLPE_FWLDSTATUS_TEP_FAIL_SHIFT)
156#define I40E_GLPE_FWLDSTATUS_OOP_FAIL_SHIFT       4
157#define I40E_GLPE_FWLDSTATUS_OOP_FAIL_MASK  (0x1 \
158			 << I40E_GLPE_FWLDSTATUS_OOP_FAIL_SHIFT)
159
160struct i40iw_sc_dev;
161struct i40iw_sc_qp;
162struct i40iw_puda_buf;
163struct i40iw_puda_completion_info;
164struct i40iw_update_sds_info;
165struct i40iw_hmc_fcn_info;
166struct i40iw_virtchnl_work_info;
167struct i40iw_manage_vf_pble_info;
168struct i40iw_device;
169struct i40iw_hmc_info;
170struct i40iw_hw;
171
172u8 __iomem *i40iw_get_hw_addr(void *dev);
173void i40iw_ieq_mpa_crc_ae(struct i40iw_sc_dev *dev, struct i40iw_sc_qp *qp);
174enum i40iw_status_code i40iw_vf_wait_vchnl_resp(struct i40iw_sc_dev *dev);
175bool i40iw_vf_clear_to_send(struct i40iw_sc_dev *dev);
176enum i40iw_status_code i40iw_ieq_check_mpacrc(struct shash_desc *desc, void *addr,
177					      u32 length, u32 value);
178struct i40iw_sc_qp *i40iw_ieq_get_qp(struct i40iw_sc_dev *dev, struct i40iw_puda_buf *buf);
179void i40iw_ieq_update_tcpip_info(struct i40iw_puda_buf *buf, u16 length, u32 seqnum);
180void i40iw_free_hash_desc(struct shash_desc *);
181enum i40iw_status_code i40iw_init_hash_desc(struct shash_desc **);
182enum i40iw_status_code i40iw_puda_get_tcpip_info(struct i40iw_puda_completion_info *info,
183						 struct i40iw_puda_buf *buf);
184enum i40iw_status_code i40iw_cqp_sds_cmd(struct i40iw_sc_dev *dev,
185					 struct i40iw_update_sds_info *info);
186enum i40iw_status_code i40iw_cqp_manage_hmc_fcn_cmd(struct i40iw_sc_dev *dev,
187						    struct i40iw_hmc_fcn_info *hmcfcninfo);
188enum i40iw_status_code i40iw_cqp_query_fpm_values_cmd(struct i40iw_sc_dev *dev,
189						      struct i40iw_dma_mem *values_mem,
190						      u8 hmc_fn_id);
191enum i40iw_status_code i40iw_cqp_commit_fpm_values_cmd(struct i40iw_sc_dev *dev,
192						       struct i40iw_dma_mem *values_mem,
193						       u8 hmc_fn_id);
194enum i40iw_status_code i40iw_alloc_query_fpm_buf(struct i40iw_sc_dev *dev,
195						 struct i40iw_dma_mem *mem);
196enum i40iw_status_code i40iw_cqp_manage_vf_pble_bp(struct i40iw_sc_dev *dev,
197						   struct i40iw_manage_vf_pble_info *info);
198void i40iw_cqp_spawn_worker(struct i40iw_sc_dev *dev,
199			    struct i40iw_virtchnl_work_info *work_info, u32 iw_vf_idx);
200void *i40iw_remove_head(struct list_head *list);
201void i40iw_qp_suspend_resume(struct i40iw_sc_dev *dev, struct i40iw_sc_qp *qp, bool suspend);
202
203void i40iw_term_modify_qp(struct i40iw_sc_qp *qp, u8 next_state, u8 term, u8 term_len);
204void i40iw_terminate_done(struct i40iw_sc_qp *qp, int timeout_occurred);
205void i40iw_terminate_start_timer(struct i40iw_sc_qp *qp);
206void i40iw_terminate_del_timer(struct i40iw_sc_qp *qp);
207
208enum i40iw_status_code i40iw_hw_manage_vf_pble_bp(struct i40iw_device *iwdev,
209						  struct i40iw_manage_vf_pble_info *info,
210						  bool wait);
211struct i40iw_sc_vsi;
212void i40iw_hw_stats_start_timer(struct i40iw_sc_vsi *vsi);
213void i40iw_hw_stats_stop_timer(struct i40iw_sc_vsi *vsi);
214#define i40iw_mmiowb() do { } while (0)
215void i40iw_wr32(struct i40iw_hw *hw, u32 reg, u32 value);
216u32  i40iw_rd32(struct i40iw_hw *hw, u32 reg);
217#endif				/* _I40IW_OSDEP_H_ */
218