1 /******************************************************************************
2  * This software may be used and distributed according to the terms of
3  * the GNU General Public License (GPL), incorporated herein by reference.
4  * Drivers based on or derived from this code fall under the GPL and must
5  * retain the authorship, copyright and license notice.  This file is not
6  * a complete program and may only be used when the entire operating
7  * system is licensed under the GPL.
8  * See the file COPYING in this distribution for more information.
9  *
10  * vxge-config.h: Driver for Exar Corp's X3100 Series 10GbE PCIe I/O
11  *                Virtualized Server Adapter.
12  * Copyright(c) 2002-2010 Exar Corp.
13  ******************************************************************************/
14 #ifndef VXGE_CONFIG_H
15 #define VXGE_CONFIG_H
16 #include <linux/list.h>
17 #include <linux/slab.h>
18 
19 #ifndef VXGE_CACHE_LINE_SIZE
20 #define VXGE_CACHE_LINE_SIZE 128
21 #endif
22 
23 #ifndef VXGE_ALIGN
24 #define VXGE_ALIGN(adrs, size) \
25 	(((size) - (((u64)adrs) & ((size)-1))) & ((size)-1))
26 #endif
27 
28 #define VXGE_HW_MIN_MTU				68
29 #define VXGE_HW_MAX_MTU				9600
30 #define VXGE_HW_DEFAULT_MTU			1500
31 
32 #define VXGE_HW_MAX_ROM_IMAGES			8
33 
34 struct eprom_image {
35 	u8 is_valid:1;
36 	u8 index;
37 	u8 type;
38 	u16 version;
39 };
40 
41 #ifdef VXGE_DEBUG_ASSERT
42 /**
43  * vxge_assert
44  * @test: C-condition to check
45  * @fmt: printf like format string
46  *
47  * This function implements traditional assert. By default assertions
48  * are enabled. It can be disabled by undefining VXGE_DEBUG_ASSERT macro in
49  * compilation
50  * time.
51  */
52 #define vxge_assert(test) BUG_ON(!(test))
53 #else
54 #define vxge_assert(test)
55 #endif /* end of VXGE_DEBUG_ASSERT */
56 
57 /**
58  * enum vxge_debug_level
59  * @VXGE_NONE: debug disabled
60  * @VXGE_ERR: all errors going to be logged out
61  * @VXGE_TRACE: all errors plus all kind of verbose tracing print outs
62  *                 going to be logged out. Very noisy.
63  *
64  * This enumeration going to be used to switch between different
65  * debug levels during runtime if DEBUG macro defined during
66  * compilation. If DEBUG macro not defined than code will be
67  * compiled out.
68  */
69 enum vxge_debug_level {
70 	VXGE_NONE   = 0,
71 	VXGE_TRACE  = 1,
72 	VXGE_ERR    = 2
73 };
74 
75 #define NULL_VPID					0xFFFFFFFF
76 #ifdef CONFIG_VXGE_DEBUG_TRACE_ALL
77 #define VXGE_DEBUG_MODULE_MASK  0xffffffff
78 #define VXGE_DEBUG_TRACE_MASK   0xffffffff
79 #define VXGE_DEBUG_ERR_MASK     0xffffffff
80 #define VXGE_DEBUG_MASK         0x000001ff
81 #else
82 #define VXGE_DEBUG_MODULE_MASK  0x20000000
83 #define VXGE_DEBUG_TRACE_MASK   0x20000000
84 #define VXGE_DEBUG_ERR_MASK     0x20000000
85 #define VXGE_DEBUG_MASK         0x00000001
86 #endif
87 
88 /*
89  * @VXGE_COMPONENT_LL: do debug for vxge link layer module
90  * @VXGE_COMPONENT_ALL: activate debug for all modules with no exceptions
91  *
92  * This enumeration going to be used to distinguish modules
93  * or libraries during compilation and runtime.  Makefile must declare
94  * VXGE_DEBUG_MODULE_MASK macro and set it to proper value.
95  */
96 #define	VXGE_COMPONENT_LL				0x20000000
97 #define	VXGE_COMPONENT_ALL				0xffffffff
98 
99 #define VXGE_HW_BASE_INF	100
100 #define VXGE_HW_BASE_ERR	200
101 #define VXGE_HW_BASE_BADCFG	300
102 
103 enum vxge_hw_status {
104 	VXGE_HW_OK				  = 0,
105 	VXGE_HW_FAIL				  = 1,
106 	VXGE_HW_PENDING				  = 2,
107 	VXGE_HW_COMPLETIONS_REMAIN		  = 3,
108 
109 	VXGE_HW_INF_NO_MORE_COMPLETED_DESCRIPTORS = VXGE_HW_BASE_INF + 1,
110 	VXGE_HW_INF_OUT_OF_DESCRIPTORS		  = VXGE_HW_BASE_INF + 2,
111 
112 	VXGE_HW_ERR_INVALID_HANDLE		  = VXGE_HW_BASE_ERR + 1,
113 	VXGE_HW_ERR_OUT_OF_MEMORY		  = VXGE_HW_BASE_ERR + 2,
114 	VXGE_HW_ERR_VPATH_NOT_AVAILABLE	  	  = VXGE_HW_BASE_ERR + 3,
115 	VXGE_HW_ERR_VPATH_NOT_OPEN		  = VXGE_HW_BASE_ERR + 4,
116 	VXGE_HW_ERR_WRONG_IRQ			  = VXGE_HW_BASE_ERR + 5,
117 	VXGE_HW_ERR_SWAPPER_CTRL		  = VXGE_HW_BASE_ERR + 6,
118 	VXGE_HW_ERR_INVALID_MTU_SIZE		  = VXGE_HW_BASE_ERR + 7,
119 	VXGE_HW_ERR_INVALID_INDEX		  = VXGE_HW_BASE_ERR + 8,
120 	VXGE_HW_ERR_INVALID_TYPE		  = VXGE_HW_BASE_ERR + 9,
121 	VXGE_HW_ERR_INVALID_OFFSET		  = VXGE_HW_BASE_ERR + 10,
122 	VXGE_HW_ERR_INVALID_DEVICE		  = VXGE_HW_BASE_ERR + 11,
123 	VXGE_HW_ERR_VERSION_CONFLICT		  = VXGE_HW_BASE_ERR + 12,
124 	VXGE_HW_ERR_INVALID_PCI_INFO		  = VXGE_HW_BASE_ERR + 13,
125 	VXGE_HW_ERR_INVALID_TCODE 		  = VXGE_HW_BASE_ERR + 14,
126 	VXGE_HW_ERR_INVALID_BLOCK_SIZE		  = VXGE_HW_BASE_ERR + 15,
127 	VXGE_HW_ERR_INVALID_STATE		  = VXGE_HW_BASE_ERR + 16,
128 	VXGE_HW_ERR_PRIVILAGED_OPEARATION	  = VXGE_HW_BASE_ERR + 17,
129 	VXGE_HW_ERR_INVALID_PORT 		  = VXGE_HW_BASE_ERR + 18,
130 	VXGE_HW_ERR_FIFO		 	  = VXGE_HW_BASE_ERR + 19,
131 	VXGE_HW_ERR_VPATH			  = VXGE_HW_BASE_ERR + 20,
132 	VXGE_HW_ERR_CRITICAL			  = VXGE_HW_BASE_ERR + 21,
133 	VXGE_HW_ERR_SLOT_FREEZE 		  = VXGE_HW_BASE_ERR + 22,
134 
135 	VXGE_HW_BADCFG_RING_INDICATE_MAX_PKTS	  = VXGE_HW_BASE_BADCFG + 1,
136 	VXGE_HW_BADCFG_FIFO_BLOCKS		  = VXGE_HW_BASE_BADCFG + 2,
137 	VXGE_HW_BADCFG_VPATH_MTU		  = VXGE_HW_BASE_BADCFG + 3,
138 	VXGE_HW_BADCFG_VPATH_RPA_STRIP_VLAN_TAG	  = VXGE_HW_BASE_BADCFG + 4,
139 	VXGE_HW_BADCFG_VPATH_MIN_BANDWIDTH	  = VXGE_HW_BASE_BADCFG + 5,
140 	VXGE_HW_BADCFG_INTR_MODE		  = VXGE_HW_BASE_BADCFG + 6,
141 	VXGE_HW_BADCFG_RTS_MAC_EN		  = VXGE_HW_BASE_BADCFG + 7,
142 
143 	VXGE_HW_EOF_TRACE_BUF			  = -1
144 };
145 
146 /**
147  * enum enum vxge_hw_device_link_state - Link state enumeration.
148  * @VXGE_HW_LINK_NONE: Invalid link state.
149  * @VXGE_HW_LINK_DOWN: Link is down.
150  * @VXGE_HW_LINK_UP: Link is up.
151  *
152  */
153 enum vxge_hw_device_link_state {
154 	VXGE_HW_LINK_NONE,
155 	VXGE_HW_LINK_DOWN,
156 	VXGE_HW_LINK_UP
157 };
158 
159 /**
160  * enum enum vxge_hw_fw_upgrade_code - FW upgrade return codes.
161  * @VXGE_HW_FW_UPGRADE_OK: All OK send next 16 bytes
162  * @VXGE_HW_FW_UPGRADE_DONE:  upload completed
163  * @VXGE_HW_FW_UPGRADE_ERR:  upload error
164  * @VXGE_FW_UPGRADE_BYTES2SKIP:  skip bytes in the stream
165  *
166  */
167 enum vxge_hw_fw_upgrade_code {
168 	VXGE_HW_FW_UPGRADE_OK		= 0,
169 	VXGE_HW_FW_UPGRADE_DONE		= 1,
170 	VXGE_HW_FW_UPGRADE_ERR		= 2,
171 	VXGE_FW_UPGRADE_BYTES2SKIP	= 3
172 };
173 
174 /**
175  * enum enum vxge_hw_fw_upgrade_err_code - FW upgrade error codes.
176  * @VXGE_HW_FW_UPGRADE_ERR_CORRUPT_DATA_1: corrupt data
177  * @VXGE_HW_FW_UPGRADE_ERR_BUFFER_OVERFLOW: buffer overflow
178  * @VXGE_HW_FW_UPGRADE_ERR_INV_NCF_FILE_3: invalid .ncf file
179  * @VXGE_HW_FW_UPGRADE_ERR_INV_NCF_FILE_4: invalid .ncf file
180  * @VXGE_HW_FW_UPGRADE_ERR_INV_NCF_FILE_5: invalid .ncf file
181  * @VXGE_HW_FW_UPGRADE_ERR_INV_NCF_FILE_6: invalid .ncf file
182  * @VXGE_HW_FW_UPGRADE_ERR_CORRUPT_DATA_7: corrupt data
183  * @VXGE_HW_FW_UPGRADE_ERR_INV_NCF_FILE_8: invalid .ncf file
184  * @VXGE_HW_FW_UPGRADE_ERR_GENERIC_ERROR_UNKNOWN: generic error unknown type
185  * @VXGE_HW_FW_UPGRADE_ERR_FAILED_TO_FLASH: failed to flash image check failed
186  */
187 enum vxge_hw_fw_upgrade_err_code {
188 	VXGE_HW_FW_UPGRADE_ERR_CORRUPT_DATA_1		= 1,
189 	VXGE_HW_FW_UPGRADE_ERR_BUFFER_OVERFLOW		= 2,
190 	VXGE_HW_FW_UPGRADE_ERR_INV_NCF_FILE_3		= 3,
191 	VXGE_HW_FW_UPGRADE_ERR_INV_NCF_FILE_4		= 4,
192 	VXGE_HW_FW_UPGRADE_ERR_INV_NCF_FILE_5		= 5,
193 	VXGE_HW_FW_UPGRADE_ERR_INV_NCF_FILE_6		= 6,
194 	VXGE_HW_FW_UPGRADE_ERR_CORRUPT_DATA_7		= 7,
195 	VXGE_HW_FW_UPGRADE_ERR_INV_NCF_FILE_8		= 8,
196 	VXGE_HW_FW_UPGRADE_ERR_GENERIC_ERROR_UNKNOWN	= 9,
197 	VXGE_HW_FW_UPGRADE_ERR_FAILED_TO_FLASH		= 10
198 };
199 
200 /**
201  * struct vxge_hw_device_date - Date Format
202  * @day: Day
203  * @month: Month
204  * @year: Year
205  * @date: Date in string format
206  *
207  * Structure for returning date
208  */
209 
210 #define VXGE_HW_FW_STRLEN	32
211 struct vxge_hw_device_date {
212 	u32     day;
213 	u32     month;
214 	u32     year;
215 	char    date[VXGE_HW_FW_STRLEN];
216 };
217 
218 struct vxge_hw_device_version {
219 	u32     major;
220 	u32     minor;
221 	u32     build;
222 	char    version[VXGE_HW_FW_STRLEN];
223 };
224 
225 /**
226  * struct vxge_hw_fifo_config - Configuration of fifo.
227  * @enable: Is this fifo to be commissioned
228  * @fifo_blocks: Numbers of TxDL (that is, lists of Tx descriptors)
229  * 		blocks per queue.
230  * @max_frags: Max number of Tx buffers per TxDL (that is, per single
231  *             transmit operation).
232  *             No more than 256 transmit buffers can be specified.
233  * @memblock_size: Fifo descriptors are allocated in blocks of @mem_block_size
234  *             bytes. Setting @memblock_size to page size ensures
235  *             by-page allocation of descriptors. 128K bytes is the
236  *             maximum supported block size.
237  * @alignment_size: per Tx fragment DMA-able memory used to align transmit data
238  *             (e.g., to align on a cache line).
239  * @intr: Boolean. Use 1 to generate interrupt for each completed TxDL.
240  *             Use 0 otherwise.
241  * @no_snoop_bits: If non-zero, specifies no-snoop PCI operation,
242  *             which generally improves latency of the host bridge operation
243  *             (see PCI specification). For valid values please refer
244  *             to struct vxge_hw_fifo_config{} in the driver sources.
245  * Configuration of all Titan fifos.
246  * Note: Valid (min, max) range for each attribute is specified in the body of
247  * the struct vxge_hw_fifo_config{} structure.
248  */
249 struct vxge_hw_fifo_config {
250 	u32				enable;
251 #define VXGE_HW_FIFO_ENABLE				1
252 #define VXGE_HW_FIFO_DISABLE				0
253 
254 	u32				fifo_blocks;
255 #define VXGE_HW_MIN_FIFO_BLOCKS				2
256 #define VXGE_HW_MAX_FIFO_BLOCKS				128
257 
258 	u32				max_frags;
259 #define VXGE_HW_MIN_FIFO_FRAGS				1
260 #define VXGE_HW_MAX_FIFO_FRAGS				256
261 
262 	u32				memblock_size;
263 #define VXGE_HW_MIN_FIFO_MEMBLOCK_SIZE			VXGE_HW_BLOCK_SIZE
264 #define VXGE_HW_MAX_FIFO_MEMBLOCK_SIZE			131072
265 #define VXGE_HW_DEF_FIFO_MEMBLOCK_SIZE			8096
266 
267 	u32		                alignment_size;
268 #define VXGE_HW_MIN_FIFO_ALIGNMENT_SIZE		0
269 #define VXGE_HW_MAX_FIFO_ALIGNMENT_SIZE		65536
270 #define VXGE_HW_DEF_FIFO_ALIGNMENT_SIZE		VXGE_CACHE_LINE_SIZE
271 
272 	u32		                intr;
273 #define VXGE_HW_FIFO_QUEUE_INTR_ENABLE			1
274 #define VXGE_HW_FIFO_QUEUE_INTR_DISABLE			0
275 #define VXGE_HW_FIFO_QUEUE_INTR_DEFAULT			0
276 
277 	u32				no_snoop_bits;
278 #define VXGE_HW_FIFO_NO_SNOOP_DISABLED			0
279 #define VXGE_HW_FIFO_NO_SNOOP_TXD			1
280 #define VXGE_HW_FIFO_NO_SNOOP_FRM			2
281 #define VXGE_HW_FIFO_NO_SNOOP_ALL			3
282 #define VXGE_HW_FIFO_NO_SNOOP_DEFAULT			0
283 
284 };
285 /**
286  * struct vxge_hw_ring_config - Ring configurations.
287  * @enable: Is this ring to be commissioned
288  * @ring_blocks: Numbers of RxD blocks in the ring
289  * @buffer_mode: Receive buffer mode (1, 2, 3, or 5); for details please refer
290  *             to Titan User Guide.
291  * @scatter_mode: Titan supports two receive scatter modes: A and B.
292  *             For details please refer to Titan User Guide.
293  * @rx_timer_val: The number of 32ns periods that would be counted between two
294  *             timer interrupts.
295  * @greedy_return: If Set it forces the device to return absolutely all RxD
296  *             that are consumed and still on board when a timer interrupt
297  *             triggers. If Clear, then if the device has already returned
298  *             RxD before current timer interrupt trigerred and after the
299  *             previous timer interrupt triggered, then the device is not
300  *             forced to returned the rest of the consumed RxD that it has
301  *             on board which account for a byte count less than the one
302  *             programmed into PRC_CFG6.RXD_CRXDT field
303  * @rx_timer_ci: TBD
304  * @backoff_interval_us: Time (in microseconds), after which Titan
305  *             tries to download RxDs posted by the host.
306  *             Note that the "backoff" does not happen if host posts receive
307  *             descriptors in the timely fashion.
308  * Ring configuration.
309  */
310 struct vxge_hw_ring_config {
311 	u32				enable;
312 #define VXGE_HW_RING_ENABLE					1
313 #define VXGE_HW_RING_DISABLE					0
314 #define VXGE_HW_RING_DEFAULT					1
315 
316 	u32				ring_blocks;
317 #define VXGE_HW_MIN_RING_BLOCKS					1
318 #define VXGE_HW_MAX_RING_BLOCKS					128
319 #define VXGE_HW_DEF_RING_BLOCKS					2
320 
321 	u32				buffer_mode;
322 #define VXGE_HW_RING_RXD_BUFFER_MODE_1				1
323 #define VXGE_HW_RING_RXD_BUFFER_MODE_3				3
324 #define VXGE_HW_RING_RXD_BUFFER_MODE_5				5
325 #define VXGE_HW_RING_RXD_BUFFER_MODE_DEFAULT			1
326 
327 	u32				scatter_mode;
328 #define VXGE_HW_RING_SCATTER_MODE_A				0
329 #define VXGE_HW_RING_SCATTER_MODE_B				1
330 #define VXGE_HW_RING_SCATTER_MODE_C				2
331 #define VXGE_HW_RING_SCATTER_MODE_USE_FLASH_DEFAULT		0xffffffff
332 
333 	u64				rxds_limit;
334 #define VXGE_HW_DEF_RING_RXDS_LIMIT				44
335 };
336 
337 /**
338  * struct vxge_hw_vp_config - Configuration of virtual path
339  * @vp_id: Virtual Path Id
340  * @min_bandwidth: Minimum Guaranteed bandwidth
341  * @ring: See struct vxge_hw_ring_config{}.
342  * @fifo: See struct vxge_hw_fifo_config{}.
343  * @tti: Configuration of interrupt associated with Transmit.
344  *             see struct vxge_hw_tim_intr_config();
345  * @rti: Configuration of interrupt associated with Receive.
346  *              see struct vxge_hw_tim_intr_config();
347  * @mtu: mtu size used on this port.
348  * @rpa_strip_vlan_tag: Strip VLAN Tag enable/disable. Instructs the device to
349  *             remove the VLAN tag from all received tagged frames that are not
350  *             replicated at the internal L2 switch.
351  *             0 - Do not strip the VLAN tag.
352  *             1 - Strip the VLAN tag. Regardless of this setting, VLAN tags are
353  *                 always placed into the RxDMA descriptor.
354  *
355  * This structure is used by the driver to pass the configuration parameters to
356  * configure Virtual Path.
357  */
358 struct vxge_hw_vp_config {
359 	u32				vp_id;
360 
361 #define	VXGE_HW_VPATH_PRIORITY_MIN			0
362 #define	VXGE_HW_VPATH_PRIORITY_MAX			16
363 #define	VXGE_HW_VPATH_PRIORITY_DEFAULT			0
364 
365 	u32				min_bandwidth;
366 #define	VXGE_HW_VPATH_BANDWIDTH_MIN			0
367 #define	VXGE_HW_VPATH_BANDWIDTH_MAX			100
368 #define	VXGE_HW_VPATH_BANDWIDTH_DEFAULT			0
369 
370 	struct vxge_hw_ring_config		ring;
371 	struct vxge_hw_fifo_config		fifo;
372 	struct vxge_hw_tim_intr_config	tti;
373 	struct vxge_hw_tim_intr_config	rti;
374 
375 	u32				mtu;
376 #define VXGE_HW_VPATH_MIN_INITIAL_MTU			VXGE_HW_MIN_MTU
377 #define VXGE_HW_VPATH_MAX_INITIAL_MTU			VXGE_HW_MAX_MTU
378 #define VXGE_HW_VPATH_USE_FLASH_DEFAULT_INITIAL_MTU	0xffffffff
379 
380 	u32				rpa_strip_vlan_tag;
381 #define VXGE_HW_VPATH_RPA_STRIP_VLAN_TAG_ENABLE			1
382 #define VXGE_HW_VPATH_RPA_STRIP_VLAN_TAG_DISABLE		0
383 #define VXGE_HW_VPATH_RPA_STRIP_VLAN_TAG_USE_FLASH_DEFAULT	0xffffffff
384 
385 };
386 /**
387  * struct vxge_hw_device_config - Device configuration.
388  * @dma_blockpool_initial: Initial size of DMA Pool
389  * @dma_blockpool_max: Maximum blocks in DMA pool
390  * @intr_mode: Line, or MSI-X interrupt.
391  *
392  * @rth_en: Enable Receive Traffic Hashing(RTH) using IT(Indirection Table).
393  * @rth_it_type: RTH IT table programming type
394  * @rts_mac_en: Enable Receive Traffic Steering using MAC destination address
395  * @vp_config: Configuration for virtual paths
396  * @device_poll_millis: Specify the interval (in mulliseconds)
397  * 			to wait for register reads
398  *
399  * Titan configuration.
400  * Contains per-device configuration parameters, including:
401  * - stats sampling interval, etc.
402  *
403  * In addition, struct vxge_hw_device_config{} includes "subordinate"
404  * configurations, including:
405  * - fifos and rings;
406  * - MAC (done at firmware level).
407  *
408  * See Titan User Guide for more details.
409  * Note: Valid (min, max) range for each attribute is specified in the body of
410  * the struct vxge_hw_device_config{} structure. Please refer to the
411  * corresponding include file.
412  * See also: struct vxge_hw_tim_intr_config{}.
413  */
414 struct vxge_hw_device_config {
415 	u32				dma_blockpool_initial;
416 	u32				dma_blockpool_max;
417 #define VXGE_HW_MIN_DMA_BLOCK_POOL_SIZE			0
418 #define VXGE_HW_INITIAL_DMA_BLOCK_POOL_SIZE		0
419 #define VXGE_HW_INCR_DMA_BLOCK_POOL_SIZE		4
420 #define VXGE_HW_MAX_DMA_BLOCK_POOL_SIZE			4096
421 
422 #define        VXGE_HW_MAX_PAYLOAD_SIZE_512		2
423 
424 	u32				intr_mode;
425 #define VXGE_HW_INTR_MODE_IRQLINE			0
426 #define VXGE_HW_INTR_MODE_MSIX				1
427 #define VXGE_HW_INTR_MODE_MSIX_ONE_SHOT			2
428 
429 #define VXGE_HW_INTR_MODE_DEF				0
430 
431 	u32				rth_en;
432 #define VXGE_HW_RTH_DISABLE				0
433 #define VXGE_HW_RTH_ENABLE				1
434 #define VXGE_HW_RTH_DEFAULT				0
435 
436 	u32				rth_it_type;
437 #define VXGE_HW_RTH_IT_TYPE_SOLO_IT			0
438 #define VXGE_HW_RTH_IT_TYPE_MULTI_IT			1
439 #define VXGE_HW_RTH_IT_TYPE_DEFAULT			0
440 
441 	u32				rts_mac_en;
442 #define VXGE_HW_RTS_MAC_DISABLE			0
443 #define VXGE_HW_RTS_MAC_ENABLE			1
444 #define VXGE_HW_RTS_MAC_DEFAULT			0
445 
446 	struct vxge_hw_vp_config	vp_config[VXGE_HW_MAX_VIRTUAL_PATHS];
447 
448 	u32				device_poll_millis;
449 #define VXGE_HW_MIN_DEVICE_POLL_MILLIS			1
450 #define VXGE_HW_MAX_DEVICE_POLL_MILLIS			100000
451 #define VXGE_HW_DEF_DEVICE_POLL_MILLIS			1000
452 
453 };
454 
455 /**
456  * function vxge_uld_link_up_f - Link-Up callback provided by driver.
457  * @devh: HW device handle.
458  * Link-up notification callback provided by the driver.
459  * This is one of the per-driver callbacks, see struct vxge_hw_uld_cbs{}.
460  *
461  * See also: struct vxge_hw_uld_cbs{}, vxge_uld_link_down_f{},
462  * vxge_hw_driver_initialize().
463  */
464 
465 /**
466  * function vxge_uld_link_down_f - Link-Down callback provided by
467  * driver.
468  * @devh: HW device handle.
469  *
470  * Link-Down notification callback provided by the driver.
471  * This is one of the per-driver callbacks, see struct vxge_hw_uld_cbs{}.
472  *
473  * See also: struct vxge_hw_uld_cbs{}, vxge_uld_link_up_f{},
474  * vxge_hw_driver_initialize().
475  */
476 
477 /**
478  * function vxge_uld_crit_err_f - Critical Error notification callback.
479  * @devh: HW device handle.
480  * (typically - at HW device iinitialization time).
481  * @type: Enumerated hw error, e.g.: double ECC.
482  * @serr_data: Titan status.
483  * @ext_data: Extended data. The contents depends on the @type.
484  *
485  * Link-Down notification callback provided by the driver.
486  * This is one of the per-driver callbacks, see struct vxge_hw_uld_cbs{}.
487  *
488  * See also: struct vxge_hw_uld_cbs{}, enum vxge_hw_event{},
489  * vxge_hw_driver_initialize().
490  */
491 
492 /**
493  * struct vxge_hw_uld_cbs - driver "slow-path" callbacks.
494  * @link_up: See vxge_uld_link_up_f{}.
495  * @link_down: See vxge_uld_link_down_f{}.
496  * @crit_err: See vxge_uld_crit_err_f{}.
497  *
498  * Driver slow-path (per-driver) callbacks.
499  * Implemented by driver and provided to HW via
500  * vxge_hw_driver_initialize().
501  * Note that these callbacks are not mandatory: HW will not invoke
502  * a callback if NULL is specified.
503  *
504  * See also: vxge_hw_driver_initialize().
505  */
506 struct vxge_hw_uld_cbs {
507 	void (*link_up)(struct __vxge_hw_device *devh);
508 	void (*link_down)(struct __vxge_hw_device *devh);
509 	void (*crit_err)(struct __vxge_hw_device *devh,
510 			enum vxge_hw_event type, u64 ext_data);
511 };
512 
513 /*
514  * struct __vxge_hw_blockpool_entry - Block private data structure
515  * @item: List header used to link.
516  * @length: Length of the block
517  * @memblock: Virtual address block
518  * @dma_addr: DMA Address of the block.
519  * @dma_handle: DMA handle of the block.
520  * @acc_handle: DMA acc handle
521  *
522  * Block is allocated with a header to put the blocks into list.
523  *
524  */
525 struct __vxge_hw_blockpool_entry {
526 	struct list_head	item;
527 	u32			length;
528 	void			*memblock;
529 	dma_addr_t		dma_addr;
530 	struct pci_dev 		*dma_handle;
531 	struct pci_dev 		*acc_handle;
532 };
533 
534 /*
535  * struct __vxge_hw_blockpool - Block Pool
536  * @hldev: HW device
537  * @block_size: size of each block.
538  * @Pool_size: Number of blocks in the pool
539  * @pool_max: Maximum number of blocks above which to free additional blocks
540  * @req_out: Number of block requests with OS out standing
541  * @free_block_list: List of free blocks
542  *
543  * Block pool contains the DMA blocks preallocated.
544  *
545  */
546 struct __vxge_hw_blockpool {
547 	struct __vxge_hw_device *hldev;
548 	u32				block_size;
549 	u32				pool_size;
550 	u32				pool_max;
551 	u32				req_out;
552 	struct list_head		free_block_list;
553 	struct list_head		free_entry_list;
554 };
555 
556 /*
557  * enum enum __vxge_hw_channel_type - Enumerated channel types.
558  * @VXGE_HW_CHANNEL_TYPE_UNKNOWN: Unknown channel.
559  * @VXGE_HW_CHANNEL_TYPE_FIFO: fifo.
560  * @VXGE_HW_CHANNEL_TYPE_RING: ring.
561  * @VXGE_HW_CHANNEL_TYPE_MAX: Maximum number of HW-supported
562  * (and recognized) channel types. Currently: 2.
563  *
564  * Enumerated channel types. Currently there are only two link-layer
565  * channels - Titan fifo and Titan ring. In the future the list will grow.
566  */
567 enum __vxge_hw_channel_type {
568 	VXGE_HW_CHANNEL_TYPE_UNKNOWN			= 0,
569 	VXGE_HW_CHANNEL_TYPE_FIFO			= 1,
570 	VXGE_HW_CHANNEL_TYPE_RING			= 2,
571 	VXGE_HW_CHANNEL_TYPE_MAX			= 3
572 };
573 
574 /*
575  * struct __vxge_hw_channel
576  * @item: List item; used to maintain a list of open channels.
577  * @type: Channel type. See enum vxge_hw_channel_type{}.
578  * @devh: Device handle. HW device object that contains _this_ channel.
579  * @vph: Virtual path handle. Virtual Path Object that contains _this_ channel.
580  * @length: Channel length. Currently allocated number of descriptors.
581  *          The channel length "grows" when more descriptors get allocated.
582  *          See _hw_mempool_grow.
583  * @reserve_arr: Reserve array. Contains descriptors that can be reserved
584  *               by driver for the subsequent send or receive operation.
585  *               See vxge_hw_fifo_txdl_reserve(),
586  *               vxge_hw_ring_rxd_reserve().
587  * @reserve_ptr: Current pointer in the resrve array
588  * @reserve_top: Reserve top gives the maximum number of dtrs available in
589  *          reserve array.
590  * @work_arr: Work array. Contains descriptors posted to the channel.
591  *            Note that at any point in time @work_arr contains 3 types of
592  *            descriptors:
593  *            1) posted but not yet consumed by Titan device;
594  *            2) consumed but not yet completed;
595  *            3) completed but not yet freed
596  *            (via vxge_hw_fifo_txdl_free() or vxge_hw_ring_rxd_free())
597  * @post_index: Post index. At any point in time points on the
598  *              position in the channel, which'll contain next to-be-posted
599  *              descriptor.
600  * @compl_index: Completion index. At any point in time points on the
601  *               position in the channel, which will contain next
602  *               to-be-completed descriptor.
603  * @free_arr: Free array. Contains completed descriptors that were freed
604  *            (i.e., handed over back to HW) by driver.
605  *            See vxge_hw_fifo_txdl_free(), vxge_hw_ring_rxd_free().
606  * @free_ptr: current pointer in free array
607  * @per_dtr_space: Per-descriptor space (in bytes) that channel user can utilize
608  *                 to store per-operation control information.
609  * @stats: Pointer to common statistics
610  * @userdata: Per-channel opaque (void*) user-defined context, which may be
611  *            driver object, ULP connection, etc.
612  *            Once channel is open, @userdata is passed back to user via
613  *            vxge_hw_channel_callback_f.
614  *
615  * HW channel object.
616  *
617  * See also: enum vxge_hw_channel_type{}, enum vxge_hw_channel_flag
618  */
619 struct __vxge_hw_channel {
620 	struct list_head		item;
621 	enum __vxge_hw_channel_type	type;
622 	struct __vxge_hw_device 	*devh;
623 	struct __vxge_hw_vpath_handle 	*vph;
624 	u32			length;
625 	u32			vp_id;
626 	void		**reserve_arr;
627 	u32			reserve_ptr;
628 	u32			reserve_top;
629 	void		**work_arr;
630 	u32			post_index ____cacheline_aligned;
631 	u32			compl_index ____cacheline_aligned;
632 	void		**free_arr;
633 	u32			free_ptr;
634 	void		**orig_arr;
635 	u32			per_dtr_space;
636 	void		*userdata;
637 	struct vxge_hw_common_reg	__iomem *common_reg;
638 	u32			first_vp_id;
639 	struct vxge_hw_vpath_stats_sw_common_info *stats;
640 
641 } ____cacheline_aligned;
642 
643 /*
644  * struct __vxge_hw_virtualpath - Virtual Path
645  *
646  * @vp_id: Virtual path id
647  * @vp_open: This flag specifies if vxge_hw_vp_open is called from LL Driver
648  * @hldev: Hal device
649  * @vp_config: Virtual Path Config
650  * @vp_reg: VPATH Register map address in BAR0
651  * @vpmgmt_reg: VPATH_MGMT register map address
652  * @max_mtu: Max mtu that can be supported
653  * @vsport_number: vsport attached to this vpath
654  * @max_kdfc_db: Maximum kernel mode doorbells
655  * @max_nofl_db: Maximum non offload doorbells
656  * @tx_intr_num: Interrupt Number associated with the TX
657 
658  * @ringh: Ring Queue
659  * @fifoh: FIFO Queue
660  * @vpath_handles: Virtual Path handles list
661  * @stats_block: Memory for DMAing stats
662  * @stats: Vpath statistics
663  *
664  * Virtual path structure to encapsulate the data related to a virtual path.
665  * Virtual paths are allocated by the HW upon getting configuration from the
666  * driver and inserted into the list of virtual paths.
667  */
668 struct __vxge_hw_virtualpath {
669 	u32				vp_id;
670 
671 	u32				vp_open;
672 #define VXGE_HW_VP_NOT_OPEN	0
673 #define	VXGE_HW_VP_OPEN		1
674 
675 	struct __vxge_hw_device		*hldev;
676 	struct vxge_hw_vp_config	*vp_config;
677 	struct vxge_hw_vpath_reg	__iomem *vp_reg;
678 	struct vxge_hw_vpmgmt_reg	__iomem *vpmgmt_reg;
679 	struct __vxge_hw_non_offload_db_wrapper	__iomem *nofl_db;
680 
681 	u32				max_mtu;
682 	u32				vsport_number;
683 	u32				max_kdfc_db;
684 	u32				max_nofl_db;
685 	u64				tim_tti_cfg1_saved;
686 	u64				tim_tti_cfg3_saved;
687 	u64				tim_rti_cfg1_saved;
688 	u64				tim_rti_cfg3_saved;
689 
690 	struct __vxge_hw_ring *____cacheline_aligned ringh;
691 	struct __vxge_hw_fifo *____cacheline_aligned fifoh;
692 	struct list_head		vpath_handles;
693 	struct __vxge_hw_blockpool_entry		*stats_block;
694 	struct vxge_hw_vpath_stats_hw_info	*hw_stats;
695 	struct vxge_hw_vpath_stats_hw_info	*hw_stats_sav;
696 	struct vxge_hw_vpath_stats_sw_info	*sw_stats;
697 	spinlock_t lock;
698 };
699 
700 /*
701  * struct __vxge_hw_vpath_handle - List item to store callback information
702  * @item: List head to keep the item in linked list
703  * @vpath: Virtual path to which this item belongs
704  *
705  * This structure is used to store the callback information.
706  */
707 struct __vxge_hw_vpath_handle {
708 	struct list_head	item;
709 	struct __vxge_hw_virtualpath	*vpath;
710 };
711 
712 /*
713  * struct __vxge_hw_device
714  *
715  * HW device object.
716  */
717 /**
718  * struct __vxge_hw_device  - Hal device object
719  * @magic: Magic Number
720  * @bar0: BAR0 virtual address.
721  * @pdev: Physical device handle
722  * @config: Confguration passed by the LL driver at initialization
723  * @link_state: Link state
724  *
725  * HW device object. Represents Titan adapter
726  */
727 struct __vxge_hw_device {
728 	u32				magic;
729 #define VXGE_HW_DEVICE_MAGIC		0x12345678
730 #define VXGE_HW_DEVICE_DEAD		0xDEADDEAD
731 	void __iomem			*bar0;
732 	struct pci_dev			*pdev;
733 	struct net_device		*ndev;
734 	struct vxge_hw_device_config	config;
735 	enum vxge_hw_device_link_state	link_state;
736 
737 	struct vxge_hw_uld_cbs		uld_callbacks;
738 
739 	u32				host_type;
740 	u32				func_id;
741 	u32				access_rights;
742 #define VXGE_HW_DEVICE_ACCESS_RIGHT_VPATH      0x1
743 #define VXGE_HW_DEVICE_ACCESS_RIGHT_SRPCIM     0x2
744 #define VXGE_HW_DEVICE_ACCESS_RIGHT_MRPCIM     0x4
745 	struct vxge_hw_legacy_reg	__iomem *legacy_reg;
746 	struct vxge_hw_toc_reg		__iomem *toc_reg;
747 	struct vxge_hw_common_reg	__iomem *common_reg;
748 	struct vxge_hw_mrpcim_reg	__iomem *mrpcim_reg;
749 	struct vxge_hw_srpcim_reg	__iomem *srpcim_reg \
750 					[VXGE_HW_TITAN_SRPCIM_REG_SPACES];
751 	struct vxge_hw_vpmgmt_reg	__iomem *vpmgmt_reg \
752 					[VXGE_HW_TITAN_VPMGMT_REG_SPACES];
753 	struct vxge_hw_vpath_reg	__iomem *vpath_reg \
754 					[VXGE_HW_TITAN_VPATH_REG_SPACES];
755 	u8				__iomem *kdfc;
756 	u8				__iomem *usdc;
757 	struct __vxge_hw_virtualpath	virtual_paths \
758 					[VXGE_HW_MAX_VIRTUAL_PATHS];
759 	u64				vpath_assignments;
760 	u64				vpaths_deployed;
761 	u32				first_vp_id;
762 	u64				tim_int_mask0[4];
763 	u32				tim_int_mask1[4];
764 
765 	struct __vxge_hw_blockpool	block_pool;
766 	struct vxge_hw_device_stats	stats;
767 	u32				debug_module_mask;
768 	u32				debug_level;
769 	u32				level_err;
770 	u32				level_trace;
771 	u16 eprom_versions[VXGE_HW_MAX_ROM_IMAGES];
772 };
773 
774 #define VXGE_HW_INFO_LEN	64
775 /**
776  * struct vxge_hw_device_hw_info - Device information
777  * @host_type: Host Type
778  * @func_id: Function Id
779  * @vpath_mask: vpath bit mask
780  * @fw_version: Firmware version
781  * @fw_date: Firmware Date
782  * @flash_version: Firmware version
783  * @flash_date: Firmware Date
784  * @mac_addrs: Mac addresses for each vpath
785  * @mac_addr_masks: Mac address masks for each vpath
786  *
787  * Returns the vpath mask that has the bits set for each vpath allocated
788  * for the driver and the first mac address for each vpath
789  */
790 struct vxge_hw_device_hw_info {
791 	u32		host_type;
792 #define VXGE_HW_NO_MR_NO_SR_NORMAL_FUNCTION			0
793 #define VXGE_HW_MR_NO_SR_VH0_BASE_FUNCTION			1
794 #define VXGE_HW_NO_MR_SR_VH0_FUNCTION0				2
795 #define VXGE_HW_NO_MR_SR_VH0_VIRTUAL_FUNCTION			3
796 #define VXGE_HW_MR_SR_VH0_INVALID_CONFIG			4
797 #define VXGE_HW_SR_VH_FUNCTION0					5
798 #define VXGE_HW_SR_VH_VIRTUAL_FUNCTION				6
799 #define VXGE_HW_VH_NORMAL_FUNCTION				7
800 	u64		function_mode;
801 #define VXGE_HW_FUNCTION_MODE_SINGLE_FUNCTION			0
802 #define VXGE_HW_FUNCTION_MODE_MULTI_FUNCTION			1
803 #define VXGE_HW_FUNCTION_MODE_SRIOV				2
804 #define VXGE_HW_FUNCTION_MODE_MRIOV				3
805 #define VXGE_HW_FUNCTION_MODE_MRIOV_8				4
806 #define VXGE_HW_FUNCTION_MODE_MULTI_FUNCTION_17			5
807 #define VXGE_HW_FUNCTION_MODE_SRIOV_8				6
808 #define VXGE_HW_FUNCTION_MODE_SRIOV_4				7
809 #define VXGE_HW_FUNCTION_MODE_MULTI_FUNCTION_2			8
810 #define VXGE_HW_FUNCTION_MODE_MULTI_FUNCTION_4			9
811 #define VXGE_HW_FUNCTION_MODE_MRIOV_4				10
812 
813 	u32		func_id;
814 	u64		vpath_mask;
815 	struct vxge_hw_device_version fw_version;
816 	struct vxge_hw_device_date    fw_date;
817 	struct vxge_hw_device_version flash_version;
818 	struct vxge_hw_device_date    flash_date;
819 	u8		serial_number[VXGE_HW_INFO_LEN];
820 	u8		part_number[VXGE_HW_INFO_LEN];
821 	u8		product_desc[VXGE_HW_INFO_LEN];
822 	u8 mac_addrs[VXGE_HW_MAX_VIRTUAL_PATHS][ETH_ALEN];
823 	u8 mac_addr_masks[VXGE_HW_MAX_VIRTUAL_PATHS][ETH_ALEN];
824 };
825 
826 /**
827  * struct vxge_hw_device_attr - Device memory spaces.
828  * @bar0: BAR0 virtual address.
829  * @pdev: PCI device object.
830  *
831  * Device memory spaces. Includes configuration, BAR0 etc. per device
832  * mapped memories. Also, includes a pointer to OS-specific PCI device object.
833  */
834 struct vxge_hw_device_attr {
835 	void __iomem		*bar0;
836 	struct pci_dev 		*pdev;
837 	struct vxge_hw_uld_cbs	uld_callbacks;
838 };
839 
840 #define VXGE_HW_DEVICE_LINK_STATE_SET(hldev, ls)	(hldev->link_state = ls)
841 
842 #define VXGE_HW_DEVICE_TIM_INT_MASK_SET(m0, m1, i) {	\
843 	if (i < 16) {				\
844 		m0[0] |= vxge_vBIT(0x8, (i*4), 4);	\
845 		m0[1] |= vxge_vBIT(0x4, (i*4), 4);	\
846 	}			       		\
847 	else {					\
848 		m1[0] = 0x80000000;		\
849 		m1[1] = 0x40000000;		\
850 	}					\
851 }
852 
853 #define VXGE_HW_DEVICE_TIM_INT_MASK_RESET(m0, m1, i) {	\
854 	if (i < 16) {					\
855 		m0[0] &= ~vxge_vBIT(0x8, (i*4), 4);		\
856 		m0[1] &= ~vxge_vBIT(0x4, (i*4), 4);		\
857 	}						\
858 	else {						\
859 		m1[0] = 0;				\
860 		m1[1] = 0;				\
861 	}						\
862 }
863 
864 #define VXGE_HW_DEVICE_STATS_PIO_READ(loc, offset) {		\
865 	status = vxge_hw_mrpcim_stats_access(hldev, \
866 				VXGE_HW_STATS_OP_READ, \
867 				loc, \
868 				offset, \
869 				&val64);			\
870 	if (status != VXGE_HW_OK)				\
871 		return status;						\
872 }
873 
874 /*
875  * struct __vxge_hw_ring - Ring channel.
876  * @channel: Channel "base" of this ring, the common part of all HW
877  *           channels.
878  * @mempool: Memory pool, the pool from which descriptors get allocated.
879  *           (See vxge_hw_mm.h).
880  * @config: Ring configuration, part of device configuration
881  *          (see struct vxge_hw_device_config{}).
882  * @ring_length: Length of the ring
883  * @buffer_mode: 1, 3, or 5. The value specifies a receive buffer mode,
884  *          as per Titan User Guide.
885  * @rxd_size: RxD sizes for 1-, 3- or 5- buffer modes. As per Titan spec,
886  *            1-buffer mode descriptor is 32 byte long, etc.
887  * @rxd_priv_size: Per RxD size reserved (by HW) for driver to keep
888  *                 per-descriptor data (e.g., DMA handle for Solaris)
889  * @per_rxd_space: Per rxd space requested by driver
890  * @rxds_per_block: Number of descriptors per hardware-defined RxD
891  *                  block. Depends on the (1-, 3-, 5-) buffer mode.
892  * @rxdblock_priv_size: Reserved at the end of each RxD block. HW internal
893  *                      usage. Not to confuse with @rxd_priv_size.
894  * @cmpl_cnt: Completion counter. Is reset to zero upon entering the ISR.
895  * @callback: Channel completion callback. HW invokes the callback when there
896  *            are new completions on that channel. In many implementations
897  *            the @callback executes in the hw interrupt context.
898  * @rxd_init: Channel's descriptor-initialize callback.
899  *            See vxge_hw_ring_rxd_init_f{}.
900  *            If not NULL, HW invokes the callback when opening
901  *            the ring.
902  * @rxd_term: Channel's descriptor-terminate callback. If not NULL,
903  *          HW invokes the callback when closing the corresponding channel.
904  *          See also vxge_hw_channel_rxd_term_f{}.
905  * @stats: Statistics for ring
906  * Ring channel.
907  *
908  * Note: The structure is cache line aligned to better utilize
909  *       CPU cache performance.
910  */
911 struct __vxge_hw_ring {
912 	struct __vxge_hw_channel		channel;
913 	struct vxge_hw_mempool			*mempool;
914 	struct vxge_hw_vpath_reg		__iomem	*vp_reg;
915 	struct vxge_hw_common_reg		__iomem	*common_reg;
916 	u32					ring_length;
917 	u32					buffer_mode;
918 	u32					rxd_size;
919 	u32					rxd_priv_size;
920 	u32					per_rxd_space;
921 	u32					rxds_per_block;
922 	u32					rxdblock_priv_size;
923 	u32					cmpl_cnt;
924 	u32					vp_id;
925 	u32					doorbell_cnt;
926 	u32					total_db_cnt;
927 	u64					rxds_limit;
928 	u32					rtimer;
929 	u64					tim_rti_cfg1_saved;
930 	u64					tim_rti_cfg3_saved;
931 
932 	enum vxge_hw_status (*callback)(
933 			struct __vxge_hw_ring *ringh,
934 			void *rxdh,
935 			u8 t_code,
936 			void *userdata);
937 
938 	enum vxge_hw_status (*rxd_init)(
939 			void *rxdh,
940 			void *userdata);
941 
942 	void (*rxd_term)(
943 			void *rxdh,
944 			enum vxge_hw_rxd_state state,
945 			void *userdata);
946 
947 	struct vxge_hw_vpath_stats_sw_ring_info *stats	____cacheline_aligned;
948 	struct vxge_hw_ring_config		*config;
949 } ____cacheline_aligned;
950 
951 /**
952  * enum enum vxge_hw_txdl_state - Descriptor (TXDL) state.
953  * @VXGE_HW_TXDL_STATE_NONE: Invalid state.
954  * @VXGE_HW_TXDL_STATE_AVAIL: Descriptor is available for reservation.
955  * @VXGE_HW_TXDL_STATE_POSTED: Descriptor is posted for processing by the
956  * device.
957  * @VXGE_HW_TXDL_STATE_FREED: Descriptor is free and can be reused for
958  * filling-in and posting later.
959  *
960  * Titan/HW descriptor states.
961  *
962  */
963 enum vxge_hw_txdl_state {
964 	VXGE_HW_TXDL_STATE_NONE	= 0,
965 	VXGE_HW_TXDL_STATE_AVAIL	= 1,
966 	VXGE_HW_TXDL_STATE_POSTED	= 2,
967 	VXGE_HW_TXDL_STATE_FREED	= 3
968 };
969 /*
970  * struct __vxge_hw_fifo - Fifo.
971  * @channel: Channel "base" of this fifo, the common part of all HW
972  *             channels.
973  * @mempool: Memory pool, from which descriptors get allocated.
974  * @config: Fifo configuration, part of device configuration
975  *             (see struct vxge_hw_device_config{}).
976  * @interrupt_type: Interrupt type to be used
977  * @no_snoop_bits: See struct vxge_hw_fifo_config{}.
978  * @txdl_per_memblock: Number of TxDLs (TxD lists) per memblock.
979  *             on TxDL please refer to Titan UG.
980  * @txdl_size: Configured TxDL size (i.e., number of TxDs in a list), plus
981  *             per-TxDL HW private space (struct __vxge_hw_fifo_txdl_priv).
982  * @priv_size: Per-Tx descriptor space reserved for driver
983  *             usage.
984  * @per_txdl_space: Per txdl private space for the driver
985  * @callback: Fifo completion callback. HW invokes the callback when there
986  *             are new completions on that fifo. In many implementations
987  *             the @callback executes in the hw interrupt context.
988  * @txdl_term: Fifo's descriptor-terminate callback. If not NULL,
989  *             HW invokes the callback when closing the corresponding fifo.
990  *             See also vxge_hw_fifo_txdl_term_f{}.
991  * @stats: Statistics of this fifo
992  *
993  * Fifo channel.
994  * Note: The structure is cache line aligned.
995  */
996 struct __vxge_hw_fifo {
997 	struct __vxge_hw_channel		channel;
998 	struct vxge_hw_mempool			*mempool;
999 	struct vxge_hw_fifo_config		*config;
1000 	struct vxge_hw_vpath_reg		__iomem *vp_reg;
1001 	struct __vxge_hw_non_offload_db_wrapper	__iomem *nofl_db;
1002 	u64					interrupt_type;
1003 	u32					no_snoop_bits;
1004 	u32					txdl_per_memblock;
1005 	u32					txdl_size;
1006 	u32					priv_size;
1007 	u32					per_txdl_space;
1008 	u32					vp_id;
1009 	u32					tx_intr_num;
1010 	u32					rtimer;
1011 	u64					tim_tti_cfg1_saved;
1012 	u64					tim_tti_cfg3_saved;
1013 
1014 	enum vxge_hw_status (*callback)(
1015 			struct __vxge_hw_fifo *fifo_handle,
1016 			void *txdlh,
1017 			enum vxge_hw_fifo_tcode t_code,
1018 			void *userdata,
1019 			struct sk_buff ***skb_ptr,
1020 			int nr_skb,
1021 			int *more);
1022 
1023 	void (*txdl_term)(
1024 			void *txdlh,
1025 			enum vxge_hw_txdl_state state,
1026 			void *userdata);
1027 
1028 	struct vxge_hw_vpath_stats_sw_fifo_info *stats ____cacheline_aligned;
1029 } ____cacheline_aligned;
1030 
1031 /*
1032  * struct __vxge_hw_fifo_txdl_priv - Transmit descriptor HW-private data.
1033  * @dma_addr: DMA (mapped) address of _this_ descriptor.
1034  * @dma_handle: DMA handle used to map the descriptor onto device.
1035  * @dma_offset: Descriptor's offset in the memory block. HW allocates
1036  *	 descriptors in memory blocks (see struct vxge_hw_fifo_config{})
1037  *             Each memblock is a contiguous block of DMA-able memory.
1038  * @frags: Total number of fragments (that is, contiguous data buffers)
1039  * carried by this TxDL.
1040  * @align_vaddr_start: Aligned virtual address start
1041  * @align_vaddr: Virtual address of the per-TxDL area in memory used for
1042  *             alignement. Used to place one or more mis-aligned fragments
1043  * @align_dma_addr: DMA address translated from the @align_vaddr.
1044  * @align_dma_handle: DMA handle that corresponds to @align_dma_addr.
1045  * @align_dma_acch: DMA access handle corresponds to @align_dma_addr.
1046  * @align_dma_offset: The current offset into the @align_vaddr area.
1047  * Grows while filling the descriptor, gets reset.
1048  * @align_used_frags: Number of fragments used.
1049  * @alloc_frags: Total number of fragments allocated.
1050  * @unused: TODO
1051  * @next_txdl_priv: (TODO).
1052  * @first_txdp: (TODO).
1053  * @linked_txdl_priv: Pointer to any linked TxDL for creating contiguous
1054  *             TxDL list.
1055  * @txdlh: Corresponding txdlh to this TxDL.
1056  * @memblock: Pointer to the TxDL memory block or memory page.
1057  *             on the next send operation.
1058  * @dma_object: DMA address and handle of the memory block that contains
1059  *             the descriptor. This member is used only in the "checked"
1060  *             version of the HW (to enforce certain assertions);
1061  *             otherwise it gets compiled out.
1062  * @allocated: True if the descriptor is reserved, 0 otherwise. Internal usage.
1063  *
1064  * Per-transmit decsriptor HW-private data. HW uses the space to keep DMA
1065  * information associated with the descriptor. Note that driver can ask HW
1066  * to allocate additional per-descriptor space for its own (driver-specific)
1067  * purposes.
1068  *
1069  * See also: struct vxge_hw_ring_rxd_priv{}.
1070  */
1071 struct __vxge_hw_fifo_txdl_priv {
1072 	dma_addr_t		dma_addr;
1073 	struct pci_dev	*dma_handle;
1074 	ptrdiff_t		dma_offset;
1075 	u32				frags;
1076 	u8				*align_vaddr_start;
1077 	u8				*align_vaddr;
1078 	dma_addr_t		align_dma_addr;
1079 	struct pci_dev 	*align_dma_handle;
1080 	struct pci_dev	*align_dma_acch;
1081 	ptrdiff_t		align_dma_offset;
1082 	u32				align_used_frags;
1083 	u32				alloc_frags;
1084 	u32				unused;
1085 	struct __vxge_hw_fifo_txdl_priv	*next_txdl_priv;
1086 	struct vxge_hw_fifo_txd		*first_txdp;
1087 	void			*memblock;
1088 };
1089 
1090 /*
1091  * struct __vxge_hw_non_offload_db_wrapper - Non-offload Doorbell Wrapper
1092  * @control_0: Bits 0 to 7 - Doorbell type.
1093  *             Bits 8 to 31 - Reserved.
1094  *             Bits 32 to 39 - The highest TxD in this TxDL.
1095  *             Bits 40 to 47 - Reserved.
1096 	*	       Bits 48 to 55 - Reserved.
1097  *             Bits 56 to 63 - No snoop flags.
1098  * @txdl_ptr:  The starting location of the TxDL in host memory.
1099  *
1100  * Created by the host and written to the adapter via PIO to a Kernel Doorbell
1101  * FIFO. All non-offload doorbell wrapper fields must be written by the host as
1102  * part of a doorbell write. Consumed by the adapter but is not written by the
1103  * adapter.
1104  */
1105 struct __vxge_hw_non_offload_db_wrapper {
1106 	u64		control_0;
1107 #define	VXGE_HW_NODBW_GET_TYPE(ctrl0)			vxge_bVALn(ctrl0, 0, 8)
1108 #define VXGE_HW_NODBW_TYPE(val) vxge_vBIT(val, 0, 8)
1109 #define	VXGE_HW_NODBW_TYPE_NODBW				0
1110 
1111 #define	VXGE_HW_NODBW_GET_LAST_TXD_NUMBER(ctrl0)	vxge_bVALn(ctrl0, 32, 8)
1112 #define VXGE_HW_NODBW_LAST_TXD_NUMBER(val) vxge_vBIT(val, 32, 8)
1113 
1114 #define	VXGE_HW_NODBW_GET_NO_SNOOP(ctrl0)		vxge_bVALn(ctrl0, 56, 8)
1115 #define VXGE_HW_NODBW_LIST_NO_SNOOP(val) vxge_vBIT(val, 56, 8)
1116 #define	VXGE_HW_NODBW_LIST_NO_SNOOP_TXD_READ_TXD0_WRITE		0x2
1117 #define	VXGE_HW_NODBW_LIST_NO_SNOOP_TX_FRAME_DATA_READ		0x1
1118 
1119 	u64		txdl_ptr;
1120 };
1121 
1122 /*
1123  * TX Descriptor
1124  */
1125 
1126 /**
1127  * struct vxge_hw_fifo_txd - Transmit Descriptor
1128  * @control_0: Bits 0 to 6 - Reserved.
1129  *             Bit 7 - List Ownership. This field should be initialized
1130  *             to '1' by the driver before the transmit list pointer is
1131  *             written to the adapter. This field will be set to '0' by the
1132  *             adapter once it has completed transmitting the frame or frames in
1133  *             the list. Note - This field is only valid in TxD0. Additionally,
1134  *             for multi-list sequences, the driver should not release any
1135  *             buffers until the ownership of the last list in the multi-list
1136  *             sequence has been returned to the host.
1137  *             Bits 8 to 11 - Reserved
1138  *             Bits 12 to 15 - Transfer_Code. This field is only valid in
1139  *             TxD0. It is used to describe the status of the transmit data
1140  *             buffer transfer. This field is always overwritten by the
1141  *             adapter, so this field may be initialized to any value.
1142  *             Bits 16 to 17 - Host steering. This field allows the host to
1143  *             override the selection of the physical transmit port.
1144  *             Attention:
1145  *             Normal sounds as if learned from the switch rather than from
1146  *             the aggregation algorythms.
1147  *             00: Normal. Use Destination/MAC Address
1148  *             lookup to determine the transmit port.
1149  *             01: Send on physical Port1.
1150  *             10: Send on physical Port0.
1151  *	       11: Send on both ports.
1152  *             Bits 18 to 21 - Reserved
1153  *             Bits 22 to 23 - Gather_Code. This field is set by the host and
1154  *             is used to describe how individual buffers comprise a frame.
1155  *             10: First descriptor of a frame.
1156  *             00: Middle of a multi-descriptor frame.
1157  *             01: Last descriptor of a frame.
1158  *             11: First and last descriptor of a frame (the entire frame
1159  *             resides in a single buffer).
1160  *             For multi-descriptor frames, the only valid gather code sequence
1161  *             is {10, [00], 01}. In other words, the descriptors must be placed
1162  *             in the list in the correct order.
1163  *             Bits 24 to 27 - Reserved
1164  *             Bits 28 to 29 - LSO_Frm_Encap. LSO Frame Encapsulation
1165  *             definition. Only valid in TxD0. This field allows the host to
1166  *             indicate the Ethernet encapsulation of an outbound LSO packet.
1167  *             00 - classic mode (best guess)
1168  *             01 - LLC
1169  *             10 - SNAP
1170  *             11 - DIX
1171  *             If "classic mode" is selected, the adapter will attempt to
1172  *             decode the frame's Ethernet encapsulation by examining the L/T
1173  *             field as follows:
1174  *             <= 0x05DC LLC/SNAP encoding; must examine DSAP/SSAP to determine
1175  *             if packet is IPv4 or IPv6.
1176  *             0x8870 Jumbo-SNAP encoding.
1177  *             0x0800 IPv4 DIX encoding
1178  *             0x86DD IPv6 DIX encoding
1179  *             others illegal encapsulation
1180  *             Bits 30 - LSO_ Flag. Large Send Offload (LSO) flag.
1181  *             Set to 1 to perform segmentation offload for TCP/UDP.
1182  *             This field is valid only in TxD0.
1183  *             Bits 31 to 33 - Reserved.
1184  *             Bits 34 to 47 - LSO_MSS. TCP/UDP LSO Maximum Segment Size
1185  *             This field is meaningful only when LSO_Control is non-zero.
1186  *             When LSO_Control is set to TCP_LSO, the single (possibly large)
1187  *             TCP segment described by this TxDL will be sent as a series of
1188  *             TCP segments each of which contains no more than LSO_MSS
1189  *             payload bytes.
1190  *             When LSO_Control is set to UDP_LSO, the single (possibly large)
1191  *             UDP datagram described by this TxDL will be sent as a series of
1192  *             UDP datagrams each of which contains no more than LSO_MSS
1193  *             payload bytes.
1194  *             All outgoing frames from this TxDL will have LSO_MSS bytes of UDP
1195  *             or TCP payload, with the exception of the last, which will have
1196  *             <= LSO_MSS bytes of payload.
1197  *             Bits 48 to 63 - Buffer_Size. Number of valid bytes in the
1198  *             buffer to be read by the adapter. This field is written by the
1199  *             host. A value of 0 is illegal.
1200  *	       Bits 32 to 63 - This value is written by the adapter upon
1201  *	       completion of a UDP or TCP LSO operation and indicates the number
1202  *             of UDP or TCP payload bytes that were transmitted. 0x0000 will be
1203  *             returned for any non-LSO operation.
1204  * @control_1: Bits 0 to 4 - Reserved.
1205  *             Bit 5 - Tx_CKO_IPv4 Set to a '1' to enable IPv4 header checksum
1206  *             offload. This field is only valid in the first TxD of a frame.
1207  *             Bit 6 - Tx_CKO_TCP Set to a '1' to enable TCP checksum offload.
1208  *             This field is only valid in the first TxD of a frame (the TxD's
1209  *             gather code must be 10 or 11). The driver should only set this
1210  *             bit if it can guarantee that TCP is present.
1211  *             Bit 7 - Tx_CKO_UDP Set to a '1' to enable UDP checksum offload.
1212  *             This field is only valid in the first TxD of a frame (the TxD's
1213  *             gather code must be 10 or 11). The driver should only set this
1214  *             bit if it can guarantee that UDP is present.
1215  *             Bits 8 to 14 - Reserved.
1216  *             Bit 15 - Tx_VLAN_Enable VLAN tag insertion flag. Set to a '1' to
1217  *             instruct the adapter to insert the VLAN tag specified by the
1218  *             Tx_VLAN_Tag field. This field is only valid in the first TxD of
1219  *             a frame.
1220  *             Bits 16 to 31 - Tx_VLAN_Tag. Variable portion of the VLAN tag
1221  *             to be inserted into the frame by the adapter (the first two bytes
1222  *             of a VLAN tag are always 0x8100). This field is only valid if the
1223  *             Tx_VLAN_Enable field is set to '1'.
1224  *             Bits 32 to 33 - Reserved.
1225  *             Bits 34 to 39 - Tx_Int_Number. Indicates which Tx interrupt
1226  *             number the frame associated with. This field is written by the
1227  *             host. It is only valid in the first TxD of a frame.
1228  *             Bits 40 to 42 - Reserved.
1229  *             Bit 43 - Set to 1 to exclude the frame from bandwidth metering
1230  *             functions. This field is valid only in the first TxD
1231  *             of a frame.
1232  *             Bits 44 to 45 - Reserved.
1233  *             Bit 46 - Tx_Int_Per_List Set to a '1' to instruct the adapter to
1234  *             generate an interrupt as soon as all of the frames in the list
1235  *             have been transmitted. In order to have per-frame interrupts,
1236  *             the driver should place a maximum of one frame per list. This
1237  *             field is only valid in the first TxD of a frame.
1238  *             Bit 47 - Tx_Int_Utilization Set to a '1' to instruct the adapter
1239  *             to count the frame toward the utilization interrupt specified in
1240  *             the Tx_Int_Number field. This field is only valid in the first
1241  *             TxD of a frame.
1242  *             Bits 48 to 63 - Reserved.
1243  * @buffer_pointer: Buffer start address.
1244  * @host_control: Host_Control.Opaque 64bit data stored by driver inside the
1245  *            Titan descriptor prior to posting the latter on the fifo
1246  *            via vxge_hw_fifo_txdl_post().The %host_control is returned as is
1247  *            to the driver with each completed descriptor.
1248  *
1249  * Transmit descriptor (TxD).Fifo descriptor contains configured number
1250  * (list) of TxDs. * For more details please refer to Titan User Guide,
1251  * Section 5.4.2 "Transmit Descriptor (TxD) Format".
1252  */
1253 struct vxge_hw_fifo_txd {
1254 	u64 control_0;
1255 #define VXGE_HW_FIFO_TXD_LIST_OWN_ADAPTER		vxge_mBIT(7)
1256 
1257 #define VXGE_HW_FIFO_TXD_T_CODE_GET(ctrl0)		vxge_bVALn(ctrl0, 12, 4)
1258 #define VXGE_HW_FIFO_TXD_T_CODE(val) 			vxge_vBIT(val, 12, 4)
1259 #define VXGE_HW_FIFO_TXD_T_CODE_UNUSED		VXGE_HW_FIFO_T_CODE_UNUSED
1260 
1261 
1262 #define VXGE_HW_FIFO_TXD_GATHER_CODE(val) 		vxge_vBIT(val, 22, 2)
1263 #define VXGE_HW_FIFO_TXD_GATHER_CODE_FIRST	VXGE_HW_FIFO_GATHER_CODE_FIRST
1264 #define VXGE_HW_FIFO_TXD_GATHER_CODE_LAST	VXGE_HW_FIFO_GATHER_CODE_LAST
1265 
1266 
1267 #define VXGE_HW_FIFO_TXD_LSO_EN				vxge_mBIT(30)
1268 
1269 #define VXGE_HW_FIFO_TXD_LSO_MSS(val) 			vxge_vBIT(val, 34, 14)
1270 
1271 #define VXGE_HW_FIFO_TXD_BUFFER_SIZE(val) 		vxge_vBIT(val, 48, 16)
1272 
1273 	u64 control_1;
1274 #define VXGE_HW_FIFO_TXD_TX_CKO_IPV4_EN			vxge_mBIT(5)
1275 #define VXGE_HW_FIFO_TXD_TX_CKO_TCP_EN			vxge_mBIT(6)
1276 #define VXGE_HW_FIFO_TXD_TX_CKO_UDP_EN			vxge_mBIT(7)
1277 #define VXGE_HW_FIFO_TXD_VLAN_ENABLE			vxge_mBIT(15)
1278 
1279 #define VXGE_HW_FIFO_TXD_VLAN_TAG(val) 			vxge_vBIT(val, 16, 16)
1280 
1281 #define VXGE_HW_FIFO_TXD_INT_NUMBER(val) 		vxge_vBIT(val, 34, 6)
1282 
1283 #define VXGE_HW_FIFO_TXD_INT_TYPE_PER_LIST		vxge_mBIT(46)
1284 #define VXGE_HW_FIFO_TXD_INT_TYPE_UTILZ			vxge_mBIT(47)
1285 
1286 	u64 buffer_pointer;
1287 
1288 	u64 host_control;
1289 };
1290 
1291 /**
1292  * struct vxge_hw_ring_rxd_1 - One buffer mode RxD for ring
1293  * @host_control: This field is exclusively for host use and is "readonly"
1294  *             from the adapter's perspective.
1295  * @control_0:Bits 0 to 6 - RTH_Bucket get
1296  *	      Bit 7 - Own Descriptor ownership bit. This bit is set to 1
1297  *            by the host, and is set to 0 by the adapter.
1298  *	      0 - Host owns RxD and buffer.
1299  *	      1 - The adapter owns RxD and buffer.
1300  *	      Bit 8 - Fast_Path_Eligible When set, indicates that the
1301  *            received frame meets all of the criteria for fast path processing.
1302  *            The required criteria are as follows:
1303  *            !SYN &
1304  *            (Transfer_Code == "Transfer OK") &
1305  *            (!Is_IP_Fragment) &
1306  *            ((Is_IPv4 & computed_L3_checksum == 0xFFFF) |
1307  *            (Is_IPv6)) &
1308  *            ((Is_TCP & computed_L4_checksum == 0xFFFF) |
1309  *            (Is_UDP & (computed_L4_checksum == 0xFFFF |
1310  *            computed _L4_checksum == 0x0000)))
1311  *            (same meaning for all RxD buffer modes)
1312  *	      Bit 9 - L3 Checksum Correct
1313  *	      Bit 10 - L4 Checksum Correct
1314  *	      Bit 11 - Reserved
1315  *	      Bit 12 to 15 - This field is written by the adapter. It is
1316  *            used to report the status of the frame transfer to the host.
1317  *	      0x0 - Transfer OK
1318  *	      0x4 - RDA Failure During Transfer
1319  *	      0x5 - Unparseable Packet, such as unknown IPv6 header.
1320  *	      0x6 - Frame integrity error (FCS or ECC).
1321  *	      0x7 - Buffer Size Error. The provided buffer(s) were not
1322  *                  appropriately sized and data loss occurred.
1323  *	      0x8 - Internal ECC Error. RxD corrupted.
1324  *	      0x9 - IPv4 Checksum error
1325  *	      0xA - TCP/UDP Checksum error
1326  *	      0xF - Unknown Error or Multiple Error. Indicates an
1327  *               unknown problem or that more than one of transfer codes is set.
1328  *	      Bit 16 - SYN The adapter sets this field to indicate that
1329  *                the incoming frame contained a TCP segment with its SYN bit
1330  *	          set and its ACK bit NOT set. (same meaning for all RxD buffer
1331  *                modes)
1332  *	      Bit 17 - Is ICMP
1333  *	      Bit 18 - RTH_SPDM_HIT Set to 1 if there was a match in the
1334  *                Socket Pair Direct Match Table and the frame was steered based
1335  *                on SPDM.
1336  *	      Bit 19 - RTH_IT_HIT Set to 1 if there was a match in the
1337  *            Indirection Table and the frame was steered based on hash
1338  *            indirection.
1339  *	      Bit 20 to 23 - RTH_HASH_TYPE Indicates the function (hash
1340  *	          type) that was used to calculate the hash.
1341  *	      Bit 19 - IS_VLAN Set to '1' if the frame was/is VLAN
1342  *	          tagged.
1343  *	      Bit 25 to 26 - ETHER_ENCAP Reflects the Ethernet encapsulation
1344  *                of the received frame.
1345  *	      0x0 - Ethernet DIX
1346  *	      0x1 - LLC
1347  *	      0x2 - SNAP (includes Jumbo-SNAP)
1348  *	      0x3 - IPX
1349  *	      Bit 27 - IS_IPV4 Set to '1' if the frame contains an IPv4	packet.
1350  *	      Bit 28 - IS_IPV6 Set to '1' if the frame contains an IPv6 packet.
1351  *	      Bit 29 - IS_IP_FRAG Set to '1' if the frame contains a fragmented
1352  *            IP packet.
1353  *	      Bit 30 - IS_TCP Set to '1' if the frame contains a TCP segment.
1354  *	      Bit 31 - IS_UDP Set to '1' if the frame contains a UDP message.
1355  *	      Bit 32 to 47 - L3_Checksum[0:15] The IPv4 checksum value 	that
1356  *            arrived with the frame. If the resulting computed IPv4 header
1357  *            checksum for the frame did not produce the expected 0xFFFF value,
1358  *            then the transfer code would be set to 0x9.
1359  *	      Bit 48 to 63 - L4_Checksum[0:15] The TCP/UDP checksum value that
1360  *            arrived with the frame. If the resulting computed TCP/UDP checksum
1361  *            for the frame did not produce the expected 0xFFFF value, then the
1362  *            transfer code would be set to 0xA.
1363  * @control_1:Bits 0 to 1 - Reserved
1364  *            Bits 2 to 15 - Buffer0_Size.This field is set by the host and
1365  *            eventually overwritten by the adapter. The host writes the
1366  *            available buffer size in bytes when it passes the descriptor to
1367  *            the adapter. When a frame is delivered the host, the adapter
1368  *            populates this field with the number of bytes written into the
1369  *            buffer. The largest supported buffer is 16, 383 bytes.
1370  *	      Bit 16 to 47 - RTH Hash Value 32-bit RTH hash value. Only valid if
1371  *	      RTH_HASH_TYPE (Control_0, bits 20:23) is nonzero.
1372  *	      Bit 48 to 63 - VLAN_Tag[0:15] The contents of the variable portion
1373  *            of the VLAN tag, if one was detected by the adapter. This field is
1374  *            populated even if VLAN-tag stripping is enabled.
1375  * @buffer0_ptr: Pointer to buffer. This field is populated by the driver.
1376  *
1377  * One buffer mode RxD for ring structure
1378  */
1379 struct vxge_hw_ring_rxd_1 {
1380 	u64 host_control;
1381 	u64 control_0;
1382 #define VXGE_HW_RING_RXD_RTH_BUCKET_GET(ctrl0)		vxge_bVALn(ctrl0, 0, 7)
1383 
1384 #define VXGE_HW_RING_RXD_LIST_OWN_ADAPTER		vxge_mBIT(7)
1385 
1386 #define VXGE_HW_RING_RXD_FAST_PATH_ELIGIBLE_GET(ctrl0)	vxge_bVALn(ctrl0, 8, 1)
1387 
1388 #define VXGE_HW_RING_RXD_L3_CKSUM_CORRECT_GET(ctrl0)	vxge_bVALn(ctrl0, 9, 1)
1389 
1390 #define VXGE_HW_RING_RXD_L4_CKSUM_CORRECT_GET(ctrl0)	vxge_bVALn(ctrl0, 10, 1)
1391 
1392 #define VXGE_HW_RING_RXD_T_CODE_GET(ctrl0)		vxge_bVALn(ctrl0, 12, 4)
1393 #define VXGE_HW_RING_RXD_T_CODE(val) 			vxge_vBIT(val, 12, 4)
1394 
1395 #define VXGE_HW_RING_RXD_T_CODE_UNUSED		VXGE_HW_RING_T_CODE_UNUSED
1396 
1397 #define VXGE_HW_RING_RXD_SYN_GET(ctrl0)		vxge_bVALn(ctrl0, 16, 1)
1398 
1399 #define VXGE_HW_RING_RXD_IS_ICMP_GET(ctrl0)		vxge_bVALn(ctrl0, 17, 1)
1400 
1401 #define VXGE_HW_RING_RXD_RTH_SPDM_HIT_GET(ctrl0)	vxge_bVALn(ctrl0, 18, 1)
1402 
1403 #define VXGE_HW_RING_RXD_RTH_IT_HIT_GET(ctrl0)		vxge_bVALn(ctrl0, 19, 1)
1404 
1405 #define VXGE_HW_RING_RXD_RTH_HASH_TYPE_GET(ctrl0)	vxge_bVALn(ctrl0, 20, 4)
1406 
1407 #define VXGE_HW_RING_RXD_IS_VLAN_GET(ctrl0)		vxge_bVALn(ctrl0, 24, 1)
1408 
1409 #define VXGE_HW_RING_RXD_ETHER_ENCAP_GET(ctrl0)		vxge_bVALn(ctrl0, 25, 2)
1410 
1411 #define VXGE_HW_RING_RXD_FRAME_PROTO_GET(ctrl0)		vxge_bVALn(ctrl0, 27, 5)
1412 
1413 #define VXGE_HW_RING_RXD_L3_CKSUM_GET(ctrl0)	vxge_bVALn(ctrl0, 32, 16)
1414 
1415 #define VXGE_HW_RING_RXD_L4_CKSUM_GET(ctrl0)	vxge_bVALn(ctrl0, 48, 16)
1416 
1417 	u64 control_1;
1418 
1419 #define VXGE_HW_RING_RXD_1_BUFFER0_SIZE_GET(ctrl1)	vxge_bVALn(ctrl1, 2, 14)
1420 #define VXGE_HW_RING_RXD_1_BUFFER0_SIZE(val) vxge_vBIT(val, 2, 14)
1421 #define VXGE_HW_RING_RXD_1_BUFFER0_SIZE_MASK		vxge_vBIT(0x3FFF, 2, 14)
1422 
1423 #define VXGE_HW_RING_RXD_1_RTH_HASH_VAL_GET(ctrl1)    vxge_bVALn(ctrl1, 16, 32)
1424 
1425 #define VXGE_HW_RING_RXD_VLAN_TAG_GET(ctrl1)	vxge_bVALn(ctrl1, 48, 16)
1426 
1427 	u64 buffer0_ptr;
1428 };
1429 
1430 enum vxge_hw_rth_algoritms {
1431 	RTH_ALG_JENKINS = 0,
1432 	RTH_ALG_MS_RSS	= 1,
1433 	RTH_ALG_CRC32C	= 2
1434 };
1435 
1436 /**
1437  * struct vxge_hw_rth_hash_types - RTH hash types.
1438  * @hash_type_tcpipv4_en: Enables RTH field type HashTypeTcpIPv4
1439  * @hash_type_ipv4_en: Enables RTH field type HashTypeIPv4
1440  * @hash_type_tcpipv6_en: Enables RTH field type HashTypeTcpIPv6
1441  * @hash_type_ipv6_en: Enables RTH field type HashTypeIPv6
1442  * @hash_type_tcpipv6ex_en: Enables RTH field type HashTypeTcpIPv6Ex
1443  * @hash_type_ipv6ex_en: Enables RTH field type HashTypeIPv6Ex
1444  *
1445  * Used to pass RTH hash types to rts_rts_set.
1446  *
1447  * See also: vxge_hw_vpath_rts_rth_set(), vxge_hw_vpath_rts_rth_get().
1448  */
1449 struct vxge_hw_rth_hash_types {
1450 	u8 hash_type_tcpipv4_en:1,
1451 	   hash_type_ipv4_en:1,
1452 	   hash_type_tcpipv6_en:1,
1453 	   hash_type_ipv6_en:1,
1454 	   hash_type_tcpipv6ex_en:1,
1455 	   hash_type_ipv6ex_en:1;
1456 };
1457 
1458 void vxge_hw_device_debug_set(
1459 	struct __vxge_hw_device *devh,
1460 	enum vxge_debug_level level,
1461 	u32 mask);
1462 
1463 u32
1464 vxge_hw_device_error_level_get(struct __vxge_hw_device *devh);
1465 
1466 u32
1467 vxge_hw_device_trace_level_get(struct __vxge_hw_device *devh);
1468 
1469 /**
1470  * vxge_hw_ring_rxd_size_get	- Get the size of ring descriptor.
1471  * @buf_mode: Buffer mode (1, 3 or 5)
1472  *
1473  * This function returns the size of RxD for given buffer mode
1474  */
vxge_hw_ring_rxd_size_get(u32 buf_mode)1475 static inline u32 vxge_hw_ring_rxd_size_get(u32 buf_mode)
1476 {
1477 	return sizeof(struct vxge_hw_ring_rxd_1);
1478 }
1479 
1480 /**
1481  * vxge_hw_ring_rxds_per_block_get - Get the number of rxds per block.
1482  * @buf_mode: Buffer mode (1 buffer mode only)
1483  *
1484  * This function returns the number of RxD for RxD block for given buffer mode
1485  */
vxge_hw_ring_rxds_per_block_get(u32 buf_mode)1486 static inline u32 vxge_hw_ring_rxds_per_block_get(u32 buf_mode)
1487 {
1488 	return (u32)((VXGE_HW_BLOCK_SIZE-16) /
1489 		sizeof(struct vxge_hw_ring_rxd_1));
1490 }
1491 
1492 /**
1493  * vxge_hw_ring_rxd_1b_set - Prepare 1-buffer-mode descriptor.
1494  * @rxdh: Descriptor handle.
1495  * @dma_pointer: DMA address of	a single receive buffer	this descriptor
1496  * should carry. Note that by the time vxge_hw_ring_rxd_1b_set is called,
1497  * the receive buffer should be already mapped to the device
1498  * @size: Size of the receive @dma_pointer buffer.
1499  *
1500  * Prepare 1-buffer-mode Rx	descriptor for posting
1501  * (via	vxge_hw_ring_rxd_post()).
1502  *
1503  * This	inline helper-function does not	return any parameters and always
1504  * succeeds.
1505  *
1506  */
1507 static inline
vxge_hw_ring_rxd_1b_set(void * rxdh,dma_addr_t dma_pointer,u32 size)1508 void vxge_hw_ring_rxd_1b_set(
1509 	void *rxdh,
1510 	dma_addr_t dma_pointer,
1511 	u32 size)
1512 {
1513 	struct vxge_hw_ring_rxd_1 *rxdp = (struct vxge_hw_ring_rxd_1 *)rxdh;
1514 	rxdp->buffer0_ptr = dma_pointer;
1515 	rxdp->control_1	&= ~VXGE_HW_RING_RXD_1_BUFFER0_SIZE_MASK;
1516 	rxdp->control_1	|= VXGE_HW_RING_RXD_1_BUFFER0_SIZE(size);
1517 }
1518 
1519 /**
1520  * vxge_hw_ring_rxd_1b_get - Get data from the completed 1-buf
1521  * descriptor.
1522  * @vpath_handle: Virtual Path handle.
1523  * @rxdh: Descriptor handle.
1524  * @dma_pointer: DMA address of	a single receive buffer	this descriptor
1525  * carries. Returned by HW.
1526  * @pkt_length:	Length (in bytes) of the data in the buffer pointed by
1527  *
1528  * Retrieve protocol data from the completed 1-buffer-mode Rx descriptor.
1529  * This	inline helper-function uses completed descriptor to populate receive
1530  * buffer pointer and other "out" parameters. The function always succeeds.
1531  *
1532  */
1533 static inline
vxge_hw_ring_rxd_1b_get(struct __vxge_hw_ring * ring_handle,void * rxdh,u32 * pkt_length)1534 void vxge_hw_ring_rxd_1b_get(
1535 	struct __vxge_hw_ring *ring_handle,
1536 	void *rxdh,
1537 	u32 *pkt_length)
1538 {
1539 	struct vxge_hw_ring_rxd_1 *rxdp = (struct vxge_hw_ring_rxd_1 *)rxdh;
1540 
1541 	*pkt_length =
1542 		(u32)VXGE_HW_RING_RXD_1_BUFFER0_SIZE_GET(rxdp->control_1);
1543 }
1544 
1545 /**
1546  * vxge_hw_ring_rxd_1b_info_get - Get extended information associated with
1547  * a completed receive descriptor for 1b mode.
1548  * @vpath_handle: Virtual Path handle.
1549  * @rxdh: Descriptor handle.
1550  * @rxd_info: Descriptor information
1551  *
1552  * Retrieve extended information associated with a completed receive descriptor.
1553  *
1554  */
1555 static inline
vxge_hw_ring_rxd_1b_info_get(struct __vxge_hw_ring * ring_handle,void * rxdh,struct vxge_hw_ring_rxd_info * rxd_info)1556 void vxge_hw_ring_rxd_1b_info_get(
1557 	struct __vxge_hw_ring *ring_handle,
1558 	void *rxdh,
1559 	struct vxge_hw_ring_rxd_info *rxd_info)
1560 {
1561 
1562 	struct vxge_hw_ring_rxd_1 *rxdp = (struct vxge_hw_ring_rxd_1 *)rxdh;
1563 	rxd_info->syn_flag =
1564 		(u32)VXGE_HW_RING_RXD_SYN_GET(rxdp->control_0);
1565 	rxd_info->is_icmp =
1566 		(u32)VXGE_HW_RING_RXD_IS_ICMP_GET(rxdp->control_0);
1567 	rxd_info->fast_path_eligible =
1568 		(u32)VXGE_HW_RING_RXD_FAST_PATH_ELIGIBLE_GET(rxdp->control_0);
1569 	rxd_info->l3_cksum_valid =
1570 		(u32)VXGE_HW_RING_RXD_L3_CKSUM_CORRECT_GET(rxdp->control_0);
1571 	rxd_info->l3_cksum =
1572 		(u32)VXGE_HW_RING_RXD_L3_CKSUM_GET(rxdp->control_0);
1573 	rxd_info->l4_cksum_valid =
1574 		(u32)VXGE_HW_RING_RXD_L4_CKSUM_CORRECT_GET(rxdp->control_0);
1575 	rxd_info->l4_cksum =
1576 		(u32)VXGE_HW_RING_RXD_L4_CKSUM_GET(rxdp->control_0);
1577 	rxd_info->frame =
1578 		(u32)VXGE_HW_RING_RXD_ETHER_ENCAP_GET(rxdp->control_0);
1579 	rxd_info->proto =
1580 		(u32)VXGE_HW_RING_RXD_FRAME_PROTO_GET(rxdp->control_0);
1581 	rxd_info->is_vlan =
1582 		(u32)VXGE_HW_RING_RXD_IS_VLAN_GET(rxdp->control_0);
1583 	rxd_info->vlan =
1584 		(u32)VXGE_HW_RING_RXD_VLAN_TAG_GET(rxdp->control_1);
1585 	rxd_info->rth_bucket =
1586 		(u32)VXGE_HW_RING_RXD_RTH_BUCKET_GET(rxdp->control_0);
1587 	rxd_info->rth_it_hit =
1588 		(u32)VXGE_HW_RING_RXD_RTH_IT_HIT_GET(rxdp->control_0);
1589 	rxd_info->rth_spdm_hit =
1590 		(u32)VXGE_HW_RING_RXD_RTH_SPDM_HIT_GET(rxdp->control_0);
1591 	rxd_info->rth_hash_type =
1592 		(u32)VXGE_HW_RING_RXD_RTH_HASH_TYPE_GET(rxdp->control_0);
1593 	rxd_info->rth_value =
1594 		(u32)VXGE_HW_RING_RXD_1_RTH_HASH_VAL_GET(rxdp->control_1);
1595 }
1596 
1597 /**
1598  * vxge_hw_ring_rxd_private_get - Get driver private per-descriptor data
1599  *                      of 1b mode 3b mode ring.
1600  * @rxdh: Descriptor handle.
1601  *
1602  * Returns: private driver	info associated	with the descriptor.
1603  * driver requests	per-descriptor space via vxge_hw_ring_attr.
1604  *
1605  */
vxge_hw_ring_rxd_private_get(void * rxdh)1606 static inline void *vxge_hw_ring_rxd_private_get(void *rxdh)
1607 {
1608 	struct vxge_hw_ring_rxd_1 *rxdp = (struct vxge_hw_ring_rxd_1 *)rxdh;
1609 	return (void *)(size_t)rxdp->host_control;
1610 }
1611 
1612 /**
1613  * vxge_hw_fifo_txdl_cksum_set_bits - Offload checksum.
1614  * @txdlh: Descriptor handle.
1615  * @cksum_bits: Specifies which checksums are to be offloaded: IPv4,
1616  *              and/or TCP and/or UDP.
1617  *
1618  * Ask Titan to calculate IPv4 & transport checksums for _this_ transmit
1619  * descriptor.
1620  * This API is part of the preparation of the transmit descriptor for posting
1621  * (via vxge_hw_fifo_txdl_post()). The related "preparation" APIs include
1622  * vxge_hw_fifo_txdl_mss_set(), vxge_hw_fifo_txdl_buffer_set_aligned(),
1623  * and vxge_hw_fifo_txdl_buffer_set().
1624  * All these APIs fill in the fields of the fifo descriptor,
1625  * in accordance with the Titan specification.
1626  *
1627  */
vxge_hw_fifo_txdl_cksum_set_bits(void * txdlh,u64 cksum_bits)1628 static inline void vxge_hw_fifo_txdl_cksum_set_bits(void *txdlh, u64 cksum_bits)
1629 {
1630 	struct vxge_hw_fifo_txd *txdp = (struct vxge_hw_fifo_txd *)txdlh;
1631 	txdp->control_1 |= cksum_bits;
1632 }
1633 
1634 /**
1635  * vxge_hw_fifo_txdl_mss_set - Set MSS.
1636  * @txdlh: Descriptor handle.
1637  * @mss: MSS size for _this_ TCP connection. Passed by TCP stack down to the
1638  *       driver, which in turn inserts the MSS into the @txdlh.
1639  *
1640  * This API is part of the preparation of the transmit descriptor for posting
1641  * (via vxge_hw_fifo_txdl_post()). The related "preparation" APIs include
1642  * vxge_hw_fifo_txdl_buffer_set(), vxge_hw_fifo_txdl_buffer_set_aligned(),
1643  * and vxge_hw_fifo_txdl_cksum_set_bits().
1644  * All these APIs fill in the fields of the fifo descriptor,
1645  * in accordance with the Titan specification.
1646  *
1647  */
vxge_hw_fifo_txdl_mss_set(void * txdlh,int mss)1648 static inline void vxge_hw_fifo_txdl_mss_set(void *txdlh, int mss)
1649 {
1650 	struct vxge_hw_fifo_txd *txdp = (struct vxge_hw_fifo_txd *)txdlh;
1651 
1652 	txdp->control_0 |= VXGE_HW_FIFO_TXD_LSO_EN;
1653 	txdp->control_0 |= VXGE_HW_FIFO_TXD_LSO_MSS(mss);
1654 }
1655 
1656 /**
1657  * vxge_hw_fifo_txdl_vlan_set - Set VLAN tag.
1658  * @txdlh: Descriptor handle.
1659  * @vlan_tag: 16bit VLAN tag.
1660  *
1661  * Insert VLAN tag into specified transmit descriptor.
1662  * The actual insertion of the tag into outgoing frame is done by the hardware.
1663  */
vxge_hw_fifo_txdl_vlan_set(void * txdlh,u16 vlan_tag)1664 static inline void vxge_hw_fifo_txdl_vlan_set(void *txdlh, u16 vlan_tag)
1665 {
1666 	struct vxge_hw_fifo_txd *txdp = (struct vxge_hw_fifo_txd *)txdlh;
1667 
1668 	txdp->control_1 |= VXGE_HW_FIFO_TXD_VLAN_ENABLE;
1669 	txdp->control_1 |= VXGE_HW_FIFO_TXD_VLAN_TAG(vlan_tag);
1670 }
1671 
1672 /**
1673  * vxge_hw_fifo_txdl_private_get - Retrieve per-descriptor private data.
1674  * @txdlh: Descriptor handle.
1675  *
1676  * Retrieve per-descriptor private data.
1677  * Note that driver requests per-descriptor space via
1678  * struct vxge_hw_fifo_attr passed to
1679  * vxge_hw_vpath_open().
1680  *
1681  * Returns: private driver data associated with the descriptor.
1682  */
vxge_hw_fifo_txdl_private_get(void * txdlh)1683 static inline void *vxge_hw_fifo_txdl_private_get(void *txdlh)
1684 {
1685 	struct vxge_hw_fifo_txd *txdp  = (struct vxge_hw_fifo_txd *)txdlh;
1686 
1687 	return (void *)(size_t)txdp->host_control;
1688 }
1689 
1690 /**
1691  * struct vxge_hw_ring_attr - Ring open "template".
1692  * @callback: Ring completion callback. HW invokes the callback when there
1693  *            are new completions on that ring. In many implementations
1694  *            the @callback executes in the hw interrupt context.
1695  * @rxd_init: Ring's descriptor-initialize callback.
1696  *            See vxge_hw_ring_rxd_init_f{}.
1697  *            If not NULL, HW invokes the callback when opening
1698  *            the ring.
1699  * @rxd_term: Ring's descriptor-terminate callback. If not NULL,
1700  *          HW invokes the callback when closing the corresponding ring.
1701  *          See also vxge_hw_ring_rxd_term_f{}.
1702  * @userdata: User-defined "context" of _that_ ring. Passed back to the
1703  *            user as one of the @callback, @rxd_init, and @rxd_term arguments.
1704  * @per_rxd_space: If specified (i.e., greater than zero): extra space
1705  *              reserved by HW per each receive descriptor.
1706  *              Can be used to store
1707  *              and retrieve on completion, information specific
1708  *              to the driver.
1709  *
1710  * Ring open "template". User fills the structure with ring
1711  * attributes and passes it to vxge_hw_vpath_open().
1712  */
1713 struct vxge_hw_ring_attr {
1714 	enum vxge_hw_status (*callback)(
1715 			struct __vxge_hw_ring *ringh,
1716 			void *rxdh,
1717 			u8 t_code,
1718 			void *userdata);
1719 
1720 	enum vxge_hw_status (*rxd_init)(
1721 			void *rxdh,
1722 			void *userdata);
1723 
1724 	void (*rxd_term)(
1725 			void *rxdh,
1726 			enum vxge_hw_rxd_state state,
1727 			void *userdata);
1728 
1729 	void		*userdata;
1730 	u32		per_rxd_space;
1731 };
1732 
1733 /**
1734  * function vxge_hw_fifo_callback_f - FIFO callback.
1735  * @vpath_handle: Virtual path whose Fifo "containing" 1 or more completed
1736  *             descriptors.
1737  * @txdlh: First completed descriptor.
1738  * @txdl_priv: Pointer to per txdl space allocated
1739  * @t_code: Transfer code, as per Titan User Guide.
1740  *          Returned by HW.
1741  * @host_control: Opaque 64bit data stored by driver inside the Titan
1742  *            descriptor prior to posting the latter on the fifo
1743  *            via vxge_hw_fifo_txdl_post(). The @host_control is returned
1744  *            as is to the driver with each completed descriptor.
1745  * @userdata: Opaque per-fifo data specified at fifo open
1746  *            time, via vxge_hw_vpath_open().
1747  *
1748  * Fifo completion callback (type declaration). A single per-fifo
1749  * callback is specified at fifo open time, via
1750  * vxge_hw_vpath_open(). Typically gets called as part of the processing
1751  * of the Interrupt Service Routine.
1752  *
1753  * Fifo callback gets called by HW if, and only if, there is at least
1754  * one new completion on a given fifo. Upon processing the first @txdlh driver
1755  * is _supposed_ to continue consuming completions using:
1756  *    - vxge_hw_fifo_txdl_next_completed()
1757  *
1758  * Note that failure to process new completions in a timely fashion
1759  * leads to VXGE_HW_INF_OUT_OF_DESCRIPTORS condition.
1760  *
1761  * Non-zero @t_code means failure to process transmit descriptor.
1762  *
1763  * In the "transmit" case the failure could happen, for instance, when the
1764  * link is down, in which case Titan completes the descriptor because it
1765  * is not able to send the data out.
1766  *
1767  * For details please refer to Titan User Guide.
1768  *
1769  * See also: vxge_hw_fifo_txdl_next_completed(), vxge_hw_fifo_txdl_term_f{}.
1770  */
1771 /**
1772  * function vxge_hw_fifo_txdl_term_f - Terminate descriptor callback.
1773  * @txdlh: First completed descriptor.
1774  * @txdl_priv: Pointer to per txdl space allocated
1775  * @state: One of the enum vxge_hw_txdl_state{} enumerated states.
1776  * @userdata: Per-fifo user data (a.k.a. context) specified at
1777  * fifo open time, via vxge_hw_vpath_open().
1778  *
1779  * Terminate descriptor callback. Unless NULL is specified in the
1780  * struct vxge_hw_fifo_attr{} structure passed to vxge_hw_vpath_open()),
1781  * HW invokes the callback as part of closing fifo, prior to
1782  * de-allocating the ring and associated data structures
1783  * (including descriptors).
1784  * driver should utilize the callback to (for instance) unmap
1785  * and free DMA data buffers associated with the posted (state =
1786  * VXGE_HW_TXDL_STATE_POSTED) descriptors,
1787  * as well as other relevant cleanup functions.
1788  *
1789  * See also: struct vxge_hw_fifo_attr{}
1790  */
1791 /**
1792  * struct vxge_hw_fifo_attr - Fifo open "template".
1793  * @callback: Fifo completion callback. HW invokes the callback when there
1794  *            are new completions on that fifo. In many implementations
1795  *            the @callback executes in the hw interrupt context.
1796  * @txdl_term: Fifo's descriptor-terminate callback. If not NULL,
1797  *          HW invokes the callback when closing the corresponding fifo.
1798  *          See also vxge_hw_fifo_txdl_term_f{}.
1799  * @userdata: User-defined "context" of _that_ fifo. Passed back to the
1800  *            user as one of the @callback, and @txdl_term arguments.
1801  * @per_txdl_space: If specified (i.e., greater than zero): extra space
1802  *              reserved by HW per each transmit descriptor. Can be used to
1803  *              store, and retrieve on completion, information specific
1804  *              to the driver.
1805  *
1806  * Fifo open "template". User fills the structure with fifo
1807  * attributes and passes it to vxge_hw_vpath_open().
1808  */
1809 struct vxge_hw_fifo_attr {
1810 
1811 	enum vxge_hw_status (*callback)(
1812 			struct __vxge_hw_fifo *fifo_handle,
1813 			void *txdlh,
1814 			enum vxge_hw_fifo_tcode t_code,
1815 			void *userdata,
1816 			struct sk_buff ***skb_ptr,
1817 			int nr_skb, int *more);
1818 
1819 	void (*txdl_term)(
1820 			void *txdlh,
1821 			enum vxge_hw_txdl_state state,
1822 			void *userdata);
1823 
1824 	void		*userdata;
1825 	u32		per_txdl_space;
1826 };
1827 
1828 /**
1829  * struct vxge_hw_vpath_attr - Attributes of virtual path
1830  * @vp_id: Identifier of Virtual Path
1831  * @ring_attr: Attributes of ring for non-offload receive
1832  * @fifo_attr: Attributes of fifo for non-offload transmit
1833  *
1834  * Attributes of virtual path.  This structure is passed as parameter
1835  * to the vxge_hw_vpath_open() routine to set the attributes of ring and fifo.
1836  */
1837 struct vxge_hw_vpath_attr {
1838 	u32				vp_id;
1839 	struct vxge_hw_ring_attr	ring_attr;
1840 	struct vxge_hw_fifo_attr	fifo_attr;
1841 };
1842 
1843 enum vxge_hw_status __devinit vxge_hw_device_hw_info_get(
1844 	void __iomem *bar0,
1845 	struct vxge_hw_device_hw_info *hw_info);
1846 
1847 enum vxge_hw_status __devinit vxge_hw_device_config_default_get(
1848 	struct vxge_hw_device_config *device_config);
1849 
1850 /**
1851  * vxge_hw_device_link_state_get - Get link state.
1852  * @devh: HW device handle.
1853  *
1854  * Get link state.
1855  * Returns: link state.
1856  */
1857 static inline
vxge_hw_device_link_state_get(struct __vxge_hw_device * devh)1858 enum vxge_hw_device_link_state vxge_hw_device_link_state_get(
1859 	struct __vxge_hw_device *devh)
1860 {
1861 	return devh->link_state;
1862 }
1863 
1864 void vxge_hw_device_terminate(struct __vxge_hw_device *devh);
1865 
1866 const u8 *
1867 vxge_hw_device_serial_number_get(struct __vxge_hw_device *devh);
1868 
1869 u16 vxge_hw_device_link_width_get(struct __vxge_hw_device *devh);
1870 
1871 const u8 *
1872 vxge_hw_device_product_name_get(struct __vxge_hw_device *devh);
1873 
1874 enum vxge_hw_status __devinit vxge_hw_device_initialize(
1875 	struct __vxge_hw_device **devh,
1876 	struct vxge_hw_device_attr *attr,
1877 	struct vxge_hw_device_config *device_config);
1878 
1879 enum vxge_hw_status vxge_hw_device_getpause_data(
1880 	 struct __vxge_hw_device *devh,
1881 	 u32 port,
1882 	 u32 *tx,
1883 	 u32 *rx);
1884 
1885 enum vxge_hw_status vxge_hw_device_setpause_data(
1886 	struct __vxge_hw_device *devh,
1887 	u32 port,
1888 	u32 tx,
1889 	u32 rx);
1890 
vxge_os_dma_malloc(struct pci_dev * pdev,unsigned long size,struct pci_dev ** p_dmah,struct pci_dev ** p_dma_acch)1891 static inline void *vxge_os_dma_malloc(struct pci_dev *pdev,
1892 			unsigned long size,
1893 			struct pci_dev **p_dmah,
1894 			struct pci_dev **p_dma_acch)
1895 {
1896 	gfp_t flags;
1897 	void *vaddr;
1898 	unsigned long misaligned = 0;
1899 	int realloc_flag = 0;
1900 	*p_dma_acch = *p_dmah = NULL;
1901 
1902 	if (in_interrupt())
1903 		flags = GFP_ATOMIC | GFP_DMA;
1904 	else
1905 		flags = GFP_KERNEL | GFP_DMA;
1906 realloc:
1907 	vaddr = kmalloc((size), flags);
1908 	if (vaddr == NULL)
1909 		return vaddr;
1910 	misaligned = (unsigned long)VXGE_ALIGN((unsigned long)vaddr,
1911 				VXGE_CACHE_LINE_SIZE);
1912 	if (realloc_flag)
1913 		goto out;
1914 
1915 	if (misaligned) {
1916 		/* misaligned, free current one and try allocating
1917 		 * size + VXGE_CACHE_LINE_SIZE memory
1918 		 */
1919 		kfree((void *) vaddr);
1920 		size += VXGE_CACHE_LINE_SIZE;
1921 		realloc_flag = 1;
1922 		goto realloc;
1923 	}
1924 out:
1925 	*(unsigned long *)p_dma_acch = misaligned;
1926 	vaddr = (void *)((u8 *)vaddr + misaligned);
1927 	return vaddr;
1928 }
1929 
vxge_os_dma_free(struct pci_dev * pdev,const void * vaddr,struct pci_dev ** p_dma_acch)1930 static inline void vxge_os_dma_free(struct pci_dev *pdev, const void *vaddr,
1931 			struct pci_dev **p_dma_acch)
1932 {
1933 	unsigned long misaligned = *(unsigned long *)p_dma_acch;
1934 	u8 *tmp = (u8 *)vaddr;
1935 	tmp -= misaligned;
1936 	kfree((void *)tmp);
1937 }
1938 
1939 /*
1940  * __vxge_hw_mempool_item_priv - will return pointer on per item private space
1941  */
1942 static inline void*
__vxge_hw_mempool_item_priv(struct vxge_hw_mempool * mempool,u32 memblock_idx,void * item,u32 * memblock_item_idx)1943 __vxge_hw_mempool_item_priv(
1944 	struct vxge_hw_mempool *mempool,
1945 	u32 memblock_idx,
1946 	void *item,
1947 	u32 *memblock_item_idx)
1948 {
1949 	ptrdiff_t offset;
1950 	void *memblock = mempool->memblocks_arr[memblock_idx];
1951 
1952 
1953 	offset = (u32)((u8 *)item - (u8 *)memblock);
1954 	vxge_assert(offset >= 0 && (u32)offset < mempool->memblock_size);
1955 
1956 	(*memblock_item_idx) = (u32) offset / mempool->item_size;
1957 	vxge_assert((*memblock_item_idx) < mempool->items_per_memblock);
1958 
1959 	return (u8 *)mempool->memblocks_priv_arr[memblock_idx] +
1960 			    (*memblock_item_idx) * mempool->items_priv_size;
1961 }
1962 
1963 /*
1964  * __vxge_hw_fifo_txdl_priv - Return the max fragments allocated
1965  * for the fifo.
1966  * @fifo: Fifo
1967  * @txdp: Poniter to a TxD
1968  */
1969 static inline struct __vxge_hw_fifo_txdl_priv *
__vxge_hw_fifo_txdl_priv(struct __vxge_hw_fifo * fifo,struct vxge_hw_fifo_txd * txdp)1970 __vxge_hw_fifo_txdl_priv(
1971 	struct __vxge_hw_fifo *fifo,
1972 	struct vxge_hw_fifo_txd *txdp)
1973 {
1974 	return (struct __vxge_hw_fifo_txdl_priv *)
1975 			(((char *)((ulong)txdp->host_control)) +
1976 				fifo->per_txdl_space);
1977 }
1978 
1979 enum vxge_hw_status vxge_hw_vpath_open(
1980 	struct __vxge_hw_device *devh,
1981 	struct vxge_hw_vpath_attr *attr,
1982 	struct __vxge_hw_vpath_handle **vpath_handle);
1983 
1984 enum vxge_hw_status vxge_hw_vpath_close(
1985 	struct __vxge_hw_vpath_handle *vpath_handle);
1986 
1987 enum vxge_hw_status
1988 vxge_hw_vpath_reset(
1989 	struct __vxge_hw_vpath_handle *vpath_handle);
1990 
1991 enum vxge_hw_status
1992 vxge_hw_vpath_recover_from_reset(
1993 	struct __vxge_hw_vpath_handle *vpath_handle);
1994 
1995 void
1996 vxge_hw_vpath_enable(struct __vxge_hw_vpath_handle *vp);
1997 
1998 enum vxge_hw_status
1999 vxge_hw_vpath_check_leak(struct __vxge_hw_ring *ringh);
2000 
2001 enum vxge_hw_status vxge_hw_vpath_mtu_set(
2002 	struct __vxge_hw_vpath_handle *vpath_handle,
2003 	u32 new_mtu);
2004 
2005 void
2006 vxge_hw_vpath_rx_doorbell_init(struct __vxge_hw_vpath_handle *vp);
2007 
2008 #ifndef readq
readq(void __iomem * addr)2009 static inline u64 readq(void __iomem *addr)
2010 {
2011 	u64 ret = 0;
2012 	ret = readl(addr + 4);
2013 	ret <<= 32;
2014 	ret |= readl(addr);
2015 
2016 	return ret;
2017 }
2018 #endif
2019 
2020 #ifndef writeq
writeq(u64 val,void __iomem * addr)2021 static inline void writeq(u64 val, void __iomem *addr)
2022 {
2023 	writel((u32) (val), addr);
2024 	writel((u32) (val >> 32), (addr + 4));
2025 }
2026 #endif
2027 
__vxge_hw_pio_mem_write32_upper(u32 val,void __iomem * addr)2028 static inline void __vxge_hw_pio_mem_write32_upper(u32 val, void __iomem *addr)
2029 {
2030 	writel(val, addr + 4);
2031 }
2032 
__vxge_hw_pio_mem_write32_lower(u32 val,void __iomem * addr)2033 static inline void __vxge_hw_pio_mem_write32_lower(u32 val, void __iomem *addr)
2034 {
2035 	writel(val, addr);
2036 }
2037 
2038 enum vxge_hw_status
2039 vxge_hw_device_flick_link_led(struct __vxge_hw_device *devh, u64 on_off);
2040 
2041 enum vxge_hw_status
2042 vxge_hw_vpath_strip_fcs_check(struct __vxge_hw_device *hldev, u64 vpath_mask);
2043 
2044 /**
2045  * vxge_debug_ll
2046  * @level: level of debug verbosity.
2047  * @mask: mask for the debug
2048  * @buf: Circular buffer for tracing
2049  * @fmt: printf like format string
2050  *
2051  * Provides logging facilities. Can be customized on per-module
2052  * basis or/and with debug levels. Input parameters, except
2053  * module and level, are the same as posix printf. This function
2054  * may be compiled out if DEBUG macro was never defined.
2055  * See also: enum vxge_debug_level{}.
2056  */
2057 #if (VXGE_COMPONENT_LL & VXGE_DEBUG_MODULE_MASK)
2058 #define vxge_debug_ll(level, mask, fmt, ...) do {			       \
2059 	if ((level >= VXGE_ERR && VXGE_COMPONENT_LL & VXGE_DEBUG_ERR_MASK) ||  \
2060 	    (level >= VXGE_TRACE && VXGE_COMPONENT_LL & VXGE_DEBUG_TRACE_MASK))\
2061 		if ((mask & VXGE_DEBUG_MASK) == mask)			       \
2062 			printk(fmt "\n", __VA_ARGS__);			       \
2063 } while (0)
2064 #else
2065 #define vxge_debug_ll(level, mask, fmt, ...)
2066 #endif
2067 
2068 enum vxge_hw_status vxge_hw_vpath_rts_rth_itable_set(
2069 			struct __vxge_hw_vpath_handle **vpath_handles,
2070 			u32 vpath_count,
2071 			u8 *mtable,
2072 			u8 *itable,
2073 			u32 itable_size);
2074 
2075 enum vxge_hw_status vxge_hw_vpath_rts_rth_set(
2076 	struct __vxge_hw_vpath_handle *vpath_handle,
2077 	enum vxge_hw_rth_algoritms algorithm,
2078 	struct vxge_hw_rth_hash_types *hash_type,
2079 	u16 bucket_size);
2080 
2081 enum vxge_hw_status
2082 __vxge_hw_device_is_privilaged(u32 host_type, u32 func_id);
2083 
2084 #define VXGE_HW_MIN_SUCCESSIVE_IDLE_COUNT 5
2085 #define VXGE_HW_MAX_POLLING_COUNT 100
2086 
2087 void
2088 vxge_hw_device_wait_receive_idle(struct __vxge_hw_device *hldev);
2089 
2090 enum vxge_hw_status
2091 vxge_hw_upgrade_read_version(struct __vxge_hw_device *hldev, u32 *major,
2092 			     u32 *minor, u32 *build);
2093 
2094 enum vxge_hw_status vxge_hw_flash_fw(struct __vxge_hw_device *hldev);
2095 
2096 enum vxge_hw_status
2097 vxge_update_fw_image(struct __vxge_hw_device *hldev, const u8 *filebuf,
2098 		     int size);
2099 
2100 enum vxge_hw_status
2101 vxge_hw_vpath_eprom_img_ver_get(struct __vxge_hw_device *hldev,
2102 				struct eprom_image *eprom_image_data);
2103 
2104 int vxge_hw_vpath_wait_receive_idle(struct __vxge_hw_device *hldev, u32 vp_id);
2105 #endif
2106