freebsd-nq/sys/dev/vxge/vxgehal/vxgehal-ring.h
George V. Neville-Neil 548d35fd69 Exar driver for X3100 10GbE Server/Storage adapters
Features: Jumbo frames (up to 9600), LRO (Large Receive Offload),
          TSO (TCP segmentation offload), RTH (Receive Traffic Hash).

Submitted by: Sriram Rapuru at Exar
MFC after:	2 weeks
2011-04-28 14:33:15 +00:00

202 lines
7.4 KiB
C

/*-
* Copyright(c) 2002-2011 Exar Corp.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification are permitted provided the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* 3. Neither the name of the Exar Corporation nor the names of its
* contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
/*$FreeBSD$*/
#ifndef VXGE_HAL_RING_H
#define VXGE_HAL_RING_H
__EXTERN_BEGIN_DECLS
typedef u8 vxge_hal_ring_block_t[VXGE_OS_HOST_PAGE_SIZE];
#define VXGE_HAL_RING_NEXT_BLOCK_POINTER_OFFSET (VXGE_OS_HOST_PAGE_SIZE-8)
#define VXGE_HAL_RING_MEMBLOCK_IDX_OFFSET (VXGE_OS_HOST_PAGE_SIZE-16)
/*
* struct __hal_ring_rxd_priv_t - Receive descriptor HAL-private data.
* @dma_addr: DMA (mapped) address of _this_ descriptor.
* @dma_handle: DMA handle used to map the descriptor onto device.
* @dma_offset: Descriptor's offset in the memory block. HAL allocates
* descriptors in memory blocks of %VXGE_OS_HOST_PAGE_SIZE
* bytes. Each memblock is contiguous DMA-able memory. Each
* memblock contains 1 or more 4KB RxD blocks visible to the
* X3100 hardware.
* @dma_object: DMA address and handle of the memory block that contains
* the descriptor. This member is used only in the "checked"
* version of the HAL (to enforce certain assertions);
* otherwise it gets compiled out.
* @allocated: True if the descriptor is reserved, 0 otherwise. Internal usage.
* @db_bytes: Number of doorbell bytes to be posted for this Rxd. This includes
* next RxD block pointers
*
* Per-receive decsriptor HAL-private data. HAL uses the space to keep DMA
* information associated with the descriptor. Note that ULD can ask HAL
* to allocate additional per-descriptor space for its own (ULD-specific)
* purposes.
*/
typedef struct __hal_ring_rxd_priv_t {
dma_addr_t dma_addr;
pci_dma_h dma_handle;
ptrdiff_t dma_offset;
#if defined(VXGE_DEBUG_ASSERT)
vxge_hal_mempool_dma_t *dma_object;
#endif
#if defined(VXGE_OS_MEMORY_CHECK)
u32 allocated;
#endif
u32 db_bytes;
} __hal_ring_rxd_priv_t;
/*
* struct __hal_ring_t - Ring channel.
* @channel: Channel "base" of this ring, the common part of all HAL
* channels.
* @mempool: Memory pool, the pool from which descriptors get allocated.
* (See vxge_hal_mm.h).
* @config: Ring configuration, part of device configuration
* (see vxge_hal_device_config_t {}).
* @ring_length: Length of the ring
* @buffer_mode: 1, 3, or 5. The value specifies a receive buffer mode,
* as per X3100 User Guide.
* @indicate_max_pkts: Maximum number of packets processed within a single
* interrupt. Can be used to limit the time spent inside hw interrupt.
* @rxd_size: RxD sizes for 1-, 3- or 5- buffer modes. As per X3100 spec,
* 1-buffer mode descriptor is 32 byte long, etc.
* @rxd_priv_size: Per RxD size reserved (by HAL) for ULD to keep per-descriptor
* data (e.g., DMA handle for Solaris)
* @per_rxd_space: Per rxd space requested by ULD
* @rxds_per_block: Number of descriptors per hardware-defined RxD
* block. Depends on the (1-, 3-, 5-) buffer mode.
* @rxdblock_priv_size: Reserved at the end of each RxD block. HAL internal
* usage. Not to confuse with @rxd_priv_size.
* @rxd_mem_avail: Available RxD memory
* @db_byte_count: Number of doorbell bytes to be posted
* @cmpl_cnt: Completion counter. Is reset to zero upon entering the ISR.
* Used in conjunction with @indicate_max_pkts.
* @active_sw_lros: List of Software LRO sessions in progess
* @active_sw_lro_count: Number of Software LRO sessions in progess
* @free_sw_lros: List of Software LRO sessions free
* @free_sw_lro_count: Number of Software LRO sessions free
* @sw_lro_lock: LRO session lists' lock
* @callback: Channel completion callback. HAL invokes the callback when there
* are new completions on that channel. In many implementations
* the @callback executes in the hw interrupt context.
* @rxd_init: Channel's descriptor-initialize callback.
* See vxge_hal_ring_rxd_init_f {}.
* If not NULL, HAL invokes the callback when opening the ring.
* @rxd_term: Channel's descriptor-terminate callback. If not NULL,
* HAL invokes the callback when closing the corresponding channel.
* See also vxge_hal_channel_rxd_term_f {}.
* @stats: Statistics for ring
* Ring channel.
*
* Note: The structure is cache line aligned to better utilize
* CPU cache performance.
*/
typedef struct __hal_ring_t {
__hal_channel_t channel;
vxge_hal_mempool_t *mempool;
vxge_hal_ring_config_t *config;
u32 ring_length;
u32 buffer_mode;
u32 indicate_max_pkts;
u32 rxd_size;
u32 rxd_priv_size;
u32 per_rxd_space;
u32 rxds_per_block;
u32 rxdblock_priv_size;
u32 rxd_mem_avail;
u32 db_byte_count;
u32 cmpl_cnt;
vxge_hal_ring_callback_f callback;
vxge_hal_ring_rxd_init_f rxd_init;
vxge_hal_ring_rxd_term_f rxd_term;
vxge_hal_vpath_stats_sw_ring_info_t *stats;
} __vxge_os_attr_cacheline_aligned __hal_ring_t;
#define VXGE_HAL_RING_ULD_PRIV(ring, rxdh) \
ring->channel.dtr_arr[ \
((vxge_hal_ring_rxd_5_t *)(rxdh))->host_control].uld_priv
#define VXGE_HAL_RING_HAL_PRIV(ring, rxdh) \
((__hal_ring_rxd_priv_t *)(ring->channel.dtr_arr[ \
((vxge_hal_ring_rxd_5_t *)(rxdh))->host_control].hal_priv))
#define VXGE_HAL_RING_POST_DOORBELL(vph, ringh) \
{ \
if (((__hal_ring_t *)(ringh))->config->post_mode == \
VXGE_HAL_RING_POST_MODE_DOORBELL) { \
vxge_hal_ring_rxd_post_post_db(vph); \
} \
}
#define VXGE_HAL_RING_RXD_INDEX(rxdp) \
(u32)((vxge_hal_ring_rxd_5_t *)rxdp)->host_control
/* ========================== RING PRIVATE API ============================ */
u64
__hal_ring_first_block_address_get(
vxge_hal_ring_h ringh);
vxge_hal_status_e
__hal_ring_create(
vxge_hal_vpath_h vpath_handle,
vxge_hal_ring_attr_t *attr);
void
__hal_ring_abort(
vxge_hal_ring_h ringh,
vxge_hal_reopen_e reopen);
vxge_hal_status_e
__hal_ring_reset(
vxge_hal_ring_h ringh);
void
__hal_ring_delete(
vxge_hal_vpath_h vpath_handle);
vxge_hal_status_e
vxge_hal_ring_initial_replenish(
__hal_ring_t *ring,
vxge_hal_reopen_e reopen);
vxge_hal_status_e
__hal_ring_frame_length_set(
__hal_virtualpath_t *vpath,
u32 new_frmlen);
__EXTERN_END_DECLS
#endif /* VXGE_HAL_RING_H */