e1000g_tx.c revision 0dc2366f7b9f9f36e10909b1e95edbf2a261c2ac
/*
* This file is provided under a CDDLv1 license. When using or
* redistributing this file, you may do so under this license.
* In redistributing this file this license must be included
* and no other modification of this header file is permitted.
*
* CDDL LICENSE SUMMARY
*
* Copyright(c) 1999 - 2009 Intel Corporation. All rights reserved.
*
* The contents of this file are subject to the terms of Version
* 1.0 of the Common Development and Distribution License (the "License").
*
* You should have received a copy of the License with this software.
* You can obtain a copy of the License at
* See the License for the specific language governing permissions
* and limitations under the License.
*/
/*
* Copyright 2010 Sun Microsystems, Inc. All rights reserved.
* Use is subject to license terms.
*/
/*
* **********************************************************************
* *
* Module Name: *
* e1000g_tx.c *
* *
* Abstract: *
* This file contains some routines that take care of Transmit, *
* make the hardware to send the data pointed by the packet out *
* on to the physical medium. *
* *
* **********************************************************************
*/
#include "e1000g_sw.h"
#include "e1000g_debug.h"
static int e1000g_tx_copy(e1000g_tx_ring_t *,
static int e1000g_tx_bind(e1000g_tx_ring_t *,
p_tx_sw_packet_t, mblk_t *);
context_data_t *);
static void e1000g_fill_context_descriptor(context_data_t *,
struct e1000_context_desc *);
static int e1000g_fill_tx_desc(e1000g_tx_ring_t *,
static void e1000g_82547_timeout(void *);
static void e1000g_82547_tx_move_tail(e1000g_tx_ring_t *);
static void e1000g_82547_tx_move_tail_work(e1000g_tx_ring_t *);
#ifndef E1000G_DEBUG
#pragma inline(e1000g_tx_copy)
#pragma inline(e1000g_tx_bind)
#pragma inline(e1000g_retrieve_context)
#pragma inline(e1000g_check_context)
#pragma inline(e1000g_fill_tx_ring)
#pragma inline(e1000g_fill_context_descriptor)
#pragma inline(e1000g_fill_tx_desc)
#pragma inline(e1000g_fill_82544_desc)
#pragma inline(e1000g_tx_workaround_PCIX_82544)
#pragma inline(e1000g_tx_workaround_jumbo_82544)
#pragma inline(e1000g_free_tx_swpkt)
#endif
/*
* e1000g_free_tx_swpkt - free up the tx sw packet
*
* Unbind the previously bound DMA handle for a given
* transmit sw packet. And reset the sw packet data.
*/
void
{
switch (packet->data_transfer_type) {
case USE_BCOPY:
break;
#ifdef __sparc
case USE_DVMA:
break;
#endif
case USE_DMA:
break;
default:
break;
}
/*
* The mblk has been stripped off the sw packet
* and will be freed in a triggered soft intr.
*/
packet->num_mblk_frag = 0;
}
mblk_t *
{
}
break;
}
}
return (mp);
}
/*
* e1000g_send - send packets onto the wire
*
* Called from e1000g_m_tx with an mblk ready to send. this
* routine sets up the transmit descriptors and sends data to
* the wire. It also pushes the just transmitted packet to
* the used tx sw packet list.
*/
static boolean_t
{
int desc_count;
/* Get the total size and frags number of the message */
frag_count = 0;
msg_size = 0;
frag_count++;
}
/* retrieve and compute information for context descriptor */
return (B_TRUE);
}
/*
* Make sure the packet is less than the allowed size
*/
if (!cur_context.lso_flag &&
/*
* For the over size packet, we'll just drop it.
* So we return B_TRUE here.
*/
"Tx packet out of bound. length = %d \n", msg_size);
return (B_TRUE);
}
/*
* Check and reclaim tx descriptors.
* This low water mark check should be done all the time as
* Transmit interrupt delay can produce Transmit interrupts little
* late and that may cause few problems related to reaping Tx
* Descriptors... As you may run short of them before getting any
* transmit interrupt...
*/
(void) e1000g_recycle(tx_ring);
goto tx_no_resource;
}
}
/*
* If the message size is less than the minimum ethernet packet size,
* we'll use bcopy to send it, and padd it to 60 bytes later.
*/
}
/* Initialize variables */
desc_total = 0;
/* Process each mblk fragment and fill tx descriptors */
/*
* The software should guarantee LSO packet header(MAC+IP+TCP)
* to be within one descriptor. Here we reallocate and refill the
* the header if it's physical memory non-contiguous.
*/
if (cur_context.lso_flag) {
/* find the last fragment of the header */
}
/*
* If the header and the payload are in different mblks,
* we simply force the header to be copied into pre-allocated
* page-aligned buffer.
*/
goto adjust_threshold;
/*
* There are two cases we need to reallocate a mblk for the
* last header fragment:
* 1. the header is in multiple mblks and the last fragment
* share the same mblk with the payload
* 2. the header is in a single mblk shared with the payload
* and the header is physical memory non-contiguous
*/
< cur_context.hdr_len)) {
/*
* reallocate the mblk for the last header fragment,
* expect to bcopy into pre-allocated page-aligned
* buffer
*/
if (!new_mp)
return (B_FALSE);
/* link the new header fragment with the other parts */
if (pre_mp)
else
frag_count++;
}
/*
* adjust the bcopy threshhold to guarantee
* the header to use bcopy way
*/
}
while (nmp) {
/* Check zero length mblks */
if (len == 0) {
/*
* If there're no packet buffers have been used,
* or we just completed processing a buffer, then
* skip the empty mblk fragment.
* Otherwise, there's still a pending buffer that
* needs to be processed (tx_copy).
*/
if (desc_count > 0) {
continue;
}
}
/*
* Get a new TxSwPacket to process mblk buffers.
*/
if (desc_count > 0) {
"No Tx SwPacket available\n");
goto tx_send_failed;
}
}
/*
* If the size of the fragment is less than the tx_bcopy_thresh
* we'll use bcopy; Otherwise, we'll use DMA binding.
*/
} else {
}
if (desc_count > 0)
desc_total += desc_count;
else if (desc_count < 0)
goto tx_send_failed;
}
/* Assign the message to the last sw packet */
/* Try to recycle the tx descriptors again */
(void) e1000g_recycle(tx_ring);
}
/*
* If the number of available tx descriptors is not enough for transmit
* (one redundant descriptor and one hw checksum context descriptor are
* included), then return failure.
*/
"No Enough Tx descriptors\n");
goto tx_send_failed;
}
ASSERT(desc_count > 0);
/* Send successful */
return (B_TRUE);
/* Restore mp to original */
if (new_mp) {
if (pre_mp) {
}
}
/*
* Enable Transmit interrupts, so that the interrupt routine can
* call mac_tx_update() when transmit descriptors become available.
*/
if (!Adapter->tx_intr_enable)
/* Free pending TxSwPackets */
while (packet) {
}
/* Return pending TxSwPackets to the "Free" list */
/* Message will be scheduled for re-transmit */
return (B_FALSE);
/*
* Enable Transmit interrupts, so that the interrupt routine can
* call mac_tx_update() when transmit descriptors become available.
*/
if (!Adapter->tx_intr_enable)
/* Message will be scheduled for re-transmit */
return (B_FALSE);
}
static boolean_t
{
/* first check lso information */
/* retrieve checksum info */
/* retrieve ethernet header size */
sizeof (struct ether_vlan_header);
else
sizeof (struct ether_header);
/* free the invalid packet */
if (mss == 0 ||
return (B_FALSE);
}
/*
* Some fields are cleared for the hardware to fill
* in. We don't assume Ethernet header, IP header and
* TCP header are always in the same mblk fragment,
* while we assume each header is always within one
* mblk fragment and Ethernet header is always in the
* first mblk fragment.
*/
}
}
/* calculate the TCP packet payload length */
}
return (B_TRUE);
}
static boolean_t
{
/*
* The following code determine if the context descriptor is
* needed to be reloaded. The sequence of the conditions is
* made by their possibilities of changing.
*/
/*
* workaround for 82546EB, context descriptor must be reloaded
*/
if (Adapter->lso_premature_issue &&
Adapter->lso_enable &&
(cur_context->cksum_flags != 0)) {
} else if (cur_context->lso_flag) {
}
} else if (cur_context->cksum_flags != 0) {
}
}
return (context_reload);
}
static int
{
struct e1000_tx_desc *first_data_desc;
struct e1000_tx_desc *next_desc;
struct e1000_tx_desc *descriptor;
int desc_count;
int i;
desc_count = 0;
first_packet = NULL;
descriptor = NULL;
first_packet = NULL;
/* Context descriptor reload check */
if (context_reload) {
(struct e1000_context_desc *)descriptor);
/* Check the wrap-around case */
else
next_desc++;
desc_count++;
}
while (packet) {
/* Zero out status */
/* must set RS on every outgoing descriptor */
if (cur_context->lso_flag)
/* Check the wrap-around case */
else
next_desc++;
desc_count++;
/*
* workaround for 82546EB errata 33, hang in PCI-X
* systems due to 2k Buffer Overrun during Transmit
* Operation. The workaround applies to all the Intel
* PCI-X chips.
*/
descriptor == first_data_desc &&
/* modified the first descriptor */
/* insert a new descriptor */
/* Zero out status */
/* must set RS on every outgoing descriptor */
if (cur_context->lso_flag)
/* Check the wrap-around case */
else
next_desc++;
desc_count++;
}
}
if (buff_overrun_flag) {
}
if (first_packet != NULL) {
/*
* Count the checksum context descriptor for
* the first SwPacket.
*/
first_packet->num_desc++;
first_packet = NULL;
}
}
/*
* workaround for 82546EB errata 21, LSO Premature Descriptor Write Back
*/
/* modified the previous descriptor */
/* insert a new descriptor */
/* the lower 20 bits of lower.data is the length field */
/* Zero out status */
/* It must be part of a LSO packet */
/* Check the wrap-around case */
else
next_desc++;
desc_count++;
/* update the number of descriptors */
}
if (cur_context->cksum_flags) {
((struct e1000_data_desc *)first_data_desc)->
((struct e1000_data_desc *)first_data_desc)->
}
/*
* Last Descriptor of Packet needs End Of Packet (EOP), Report
* Status (RS) set.
*/
if (Adapter->tx_intr_delay) {
} else {
}
/* Set append Ethernet CRC (IFCS) bits */
if (cur_context->lso_flag) {
} else {
}
/*
* Sync the Tx descriptors DMA buffer
*/
0, 0, DDI_DMA_SYNC_FORDEV);
/*
* Advance the Transmit Descriptor Tail (Tdt), this tells the
* FX1000 that this frame is available to transmit.
*/
else
}
/* Put the pending SwPackets to the "Used" list */
/* update LSO related data */
if (context_reload)
return (desc_count);
}
/*
* e1000g_tx_setup - setup tx data structures
*
* This routine initializes all of the transmit related
* structures. This includes the Transmit descriptors,
* and the tx_sw_packet structures.
*/
void
{
uint32_t i;
int size;
/* init the lists */
/*
* Here we don't need to protect the lists using the
* usedlist_lock and freelist_lock, for they have
* been protected by the chip_lock.
*/
/* Go through and set up each SW_Packet */
/* Initialize this tx_sw_apcket area */
/* Add this tx_sw_packet to the free list */
}
/* Setup TX descriptor pointers */
/*
* Setup Hardware TX Registers
*/
/* Setup the Transmit Control Register (TCTL). */
/* Enable the MULR bit */
/* Setup HW Base and Length of Tx descriptor area */
/*
* Write the highest location first and work backward to the lowest.
* This is necessary for some adapter types to
* prevent write combining from occurring.
*/
/* Setup our HW Tx Head & Tail descriptor pointers */
/* Set the default values for the Tx Inter Packet Gap timer */
reg_tipg |=
reg_tipg |=
} else {
else
reg_tipg |=
reg_tipg |=
}
/* Setup Transmit Interrupt Delay Value */
}
/* Initialize stored context information */
}
/*
* e1000g_recycle - recycle the tx descriptors and tx sw packets
*/
int
{
struct e1000_tx_desc *descriptor;
int desc_count;
/*
* This function will examine each TxSwPacket in the 'used' queue
* if the e1000g is done with it then the associated resources (Tx
* Descriptors) will be "freed" and the TxSwPacket will be
* returned to the 'free' queue.
*/
delta = 0;
return (0);
}
desc_count = 0;
/* Sync the Tx descriptor DMA buffer */
0, 0, DDI_DMA_SYNC_FORKERNEL);
return (0);
}
/*
* While there are still TxSwPackets in the used queue check them
*/
while ((packet =
/*
* Get hold of the next descriptor that the e1000g will
* report status back to (this will be the last descriptor
* of a given sw packet). We only want to free the
* sw packet (and it resources) if the e1000g is done
* with ALL of the descriptors. If the e1000g is done
* with the last one then it is done with all of them.
*/
/* Check for wrap case */
/*
* If the descriptor done bit is set free TxSwPacket and
* associated resources
*/
else
descriptor + 1;
} else {
/*
* Found a sw packet that the e1000g is not done
* with then there is no reason to check the rest
* of the queue.
*/
break;
}
}
if (desc_count == 0) {
/*
* If the packet hasn't been sent out for seconds and
* the transmitter is not under paused flowctrl condition,
* the transmitter is considered to be stalled.
*/
E1000_STATUS) & E1000_STATUS_TXOFF)) {
}
return (0);
}
/* Assemble the message chain */
} else {
}
/* Disconnect the message from the sw packet */
}
/* Free the TxSwPackets */
}
/* Return the TxSwPackets back to the FreeList */
return (desc_count);
}
/*
* 82544 Coexistence issue workaround:
* There are 2 issues.
* 1. If a 32 bit split completion happens from P64H2 and another
* 82544 has a problem where in to clock all the data in, it
* looks at REQ64# signal and since it has changed so fast (i.e. 1
* idle clock turn around), it will fail to clock all the data in.
* Data coming from certain ending addresses has exposure to this issue.
*
* To detect this issue, following equation can be used...
* SIZE[3:0] + ADDR[2:0] = SUM[3:0].
* If SUM[3:0] is in between 1 to 4, we will have this issue.
*
* ROOT CAUSE:
* The erratum involves the 82544 PCIX elasticity FIFO implementations as
* 64-bit FIFO's and flushing of the final partial-bytes corresponding
* to the end of a requested read burst. Under a specific burst condition
* of ending-data alignment and 32-byte split-completions, the final
* byte(s) of split-completion data require an extra clock cycle to flush
* into 64-bit FIFO orientation. An incorrect logic dependency on the
* REQ64# signal occurring during during this clock cycle may cause the
* residual byte(s) to be lost, thereby rendering the internal DMA client
* forever awaiting the final byte(s) for an outbound data-fetch. The
* erratum is confirmed to *only* occur if certain subsequent external
* 64-bit PCIX bus transactions occur immediately (minimum possible bus
* turn- around) following the odd-aligned 32-bit split-completion
* containing the final byte(s). Intel has confirmed that this has been
* 32-bit split-completion data, and in the presence of newer PCIX bus
* agents which fully-optimize the inter-transaction turn-around (zero
* additional initiator latency when pre-granted bus ownership).
*
* This issue does not exist in PCI bus mode, when any agent is operating
* in 32 bit only mode or on chipsets that do not do 32 bit split
* completions for 64 bit read requests (Serverworks chipsets). P64H2 does
* 32 bit split completions for any read request that has bit 2 set to 1
* for the requested address and read request size is more than 8 bytes.
*
* 2. Another issue is related to 82544 driving DACs under the similar
* scenario (32 bit split completion followed by 64 bit transaction with
* only 1 cycle turnaround). This issue is still being root caused. We
* think that both of these issues can be avoided if following workaround
* is implemented. It seems DAC issues is related to ending addresses being
* 0x9, 0xA, 0xB, 0xC and hence ending up at odd boundaries in elasticity
* FIFO which does not get flushed due to REQ64# dependency. We will only
* know the full story after it has been simulated successfully by HW team.
*
* WORKAROUND:
* Make sure we do not have ending address as 1,2,3,4(Hang) or 9,a,b,c(DAC)
*/
static uint32_t
{
/*
* Since issue is sensitive to length and address.
* Let us first check the address...
*/
if (length <= 4) {
return (desc_array->elements);
}
/*
* if it does not fall between 0x1 to 0x4 and 0x9 to 0xC then
* return
*/
if (safe_terminator == 0 ||
return (desc_array->elements);
}
return (desc_array->elements);
}
static int
{
int desc_count;
desc_count = 0;
if (len > 0) {
len);
packet->num_mblk_frag++;
}
} else {
else if (tx_undersize_flag)
else
}
if (finished) {
/*
* If the packet is smaller than 64 bytes, which is the
* minimum ethernet packet size, pad the packet to make
* it at least 60 bytes. The hardware will add 4 bytes
* for CRC.
*/
if (tx_undersize_flag) {
}
#ifdef __sparc
else
#else
#endif
if (desc_count <= 0)
return (-1);
}
return (desc_count);
}
static int
{
int j;
int mystat;
int desc_count;
desc_total = 0;
/*
* ddi_dma_addr_bind_handle() allocates DMA resources for a
* memory object such that a device can perform DMA to or from
* the object. DMA resources are allocated considering the
* device's DMA attributes as expressed by ddi_dma_attr(9S)
* (see ddi_dma_alloc_handle(9F)).
*
* ddi_dma_addr_bind_handle() fills in the first DMA cookie
* pointed to by cookiep with the appropriate address, length,
* and bus type. *ccountp is set to the number of DMA cookies
* representing this DMA object. Subsequent DMA cookies must be
* retrieved by calling ddi_dma_nextcookie(9F) the number of
* times specified by *countp - 1.
*/
#ifdef __sparc
case USE_DVMA:
ncookies = 1;
break;
#endif
case USE_DMA:
if ((mystat = ddi_dma_addr_bind_handle(
DDI_DMA_DONTWAIT, 0, &dma_cookie,
&ncookies)) != DDI_DMA_MAPPED) {
"Couldn't bind mblk buffer to Tx DMA handle: "
"return: %X, Pkt: %X\n",
return (-1);
}
/*
* An implicit ddi_dma_sync() is done when the
* ddi_dma_addr_bind_handle() is called. So we
* don't need to explicitly call ddi_dma_sync()
* here any more.
*/
(ncookies > 1));
/*
* The data_transfer_type value must be set after the handle
* has been bound, for it will be used in e1000g_free_tx_swpkt()
* to decide whether we need to unbind the handle.
*/
break;
default:
break;
}
packet->num_mblk_frag++;
/*
* Each address could span thru multpile cookie..
* Each cookie will have one descriptor
*/
for (j = ncookies; j != 0; j--) {
if (desc_count <= 0)
return (-1);
desc_total += desc_count;
/*
* ddi_dma_nextcookie() retrieves subsequent DMA
* cookies for a DMA object.
* ddi_dma_nextcookie() fills in the
* ddi_dma_cookie(9S) structure pointed to by
* cookiep. The ddi_dma_cookie(9S) structure
* must be allocated prior to calling
* ddi_dma_nextcookie(). The DMA cookie count
* returned by ddi_dma_buf_bind_handle(9F),
* ddi_dma_addr_bind_handle(9F), or
* ddi_dma_getwin(9F) indicates the number of DMA
* cookies a DMA object consists of. If the
* resulting cookie count, N, is larger than 1,
* ddi_dma_nextcookie() must be called N-1 times
* to retrieve all DMA cookies.
*/
if (j > 1) {
&dma_cookie);
}
}
return (desc_total);
}
static void
struct e1000_context_desc *context_desc)
{
} else
/*
* The packet with same protocol has the following
* stuff and start offset:
* | Protocol | Stuff | Start | Checksum
* | | Offset | Offset | Enable
* | IPv4 + TCP | 0x24 | 0x14 | Yes
* | IPv4 + UDP | 0x1A | 0x14 | Yes
* | IPv6 + TCP | 0x20 | 0x10 | No
* | IPv6 + UDP | 0x14 | 0x10 | No
*/
} else
if (cur_context->lso_flag) {
/*
* workaround for 82546EB errata 23, status-writeback
* reporting (RS) should not be set on context or
* Null descriptors
*/
} else {
/*
* Zero out the options for TCP Segmentation Offload
*/
}
}
static int
{
return (e1000g_tx_workaround_PCIX_82544(packet,
if (size > JUMBO_FRAG_LENGTH)
return (e1000g_tx_workaround_jumbo_82544(packet,
}
return (1);
}
static int
{
int desc_count;
long size_left;
/*
* Coexist Workaround for cordova: RP: 07/04/03
*
* RP: ERRATA: Workaround ISSUE:
* 8kb_buffer_Lockup CONTROLLER: Cordova Breakup
* Eachbuffer in to 8kb pieces until the
* remainder is < 8kb
*/
desc_count = 0;
while (size_left > 0) {
if (size_left > MAX_TX_BUF_SIZE)
else
len, &desc_array);
/*
* Put in the buffer address
*/
desc_count++;
} /* for */
/*
* Update the buffer address and length
*/
} /* while */
return (desc_count);
}
static int
{
int desc_count;
long size_left;
/*
* Workaround for Jumbo Frames on Cordova
* PSD 06/01/2001
*/
desc_count = 0;
offset = 0;
while (size_left > 0) {
if (size_left > JUMBO_FRAG_LENGTH)
else
desc_count++;
}
return (desc_count);
}
#pragma inline(e1000g_82547_tx_move_tail_work)
static void
{
struct e1000_tx_desc *tx_desc;
hw_tdt = 0;
if (eop) {
!= E1000_SUCCESS)) {
if (tx_ring->timer_enable_82547) {
(void *)tx_ring,
drv_usectohz(10000));
}
return;
} else {
length = 0;
}
}
}
}
static void
e1000g_82547_timeout(void *arg)
{
tx_ring->timer_id_82547 = 0;
}
static void
{
tx_ring->timer_id_82547 = 0;
if (tid != 0) {
}
}