1193880Syongari/*- 2193880Syongari * Copyright (c) 2009, Pyun YongHyeon <yongari@FreeBSD.org> 3193880Syongari * All rights reserved. 4193880Syongari * 5193880Syongari * Redistribution and use in source and binary forms, with or without 6193880Syongari * modification, are permitted provided that the following conditions 7193880Syongari * are met: 8193880Syongari * 1. Redistributions of source code must retain the above copyright 9193880Syongari * notice unmodified, this list of conditions, and the following 10193880Syongari * disclaimer. 11193880Syongari * 2. Redistributions in binary form must reproduce the above copyright 12193880Syongari * notice, this list of conditions and the following disclaimer in the 13193880Syongari * documentation and/or other materials provided with the distribution. 14193880Syongari * 15193880Syongari * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 16193880Syongari * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 17193880Syongari * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 18193880Syongari * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 19193880Syongari * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 20193880Syongari * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 21193880Syongari * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 22193880Syongari * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 23193880Syongari * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 24193880Syongari * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 25193880Syongari * SUCH DAMAGE. 26193880Syongari * 27193880Syongari * $FreeBSD: stable/11/sys/dev/alc/if_alcvar.h 312358 2017-01-18 01:52:04Z yongari $ 28193880Syongari */ 29193880Syongari 30193880Syongari#ifndef _IF_ALCVAR_H 31193880Syongari#define _IF_ALCVAR_H 32193880Syongari 33193880Syongari#define ALC_TX_RING_CNT 256 34193880Syongari#define ALC_TX_RING_ALIGN sizeof(struct tx_desc) 35193880Syongari#define ALC_RX_RING_CNT 256 36193880Syongari#define ALC_RX_RING_ALIGN sizeof(struct rx_desc) 37193880Syongari#define ALC_RX_BUF_ALIGN 4 38193880Syongari#define ALC_RR_RING_CNT ALC_RX_RING_CNT 39193880Syongari#define ALC_RR_RING_ALIGN sizeof(struct rx_rdesc) 40193880Syongari#define ALC_CMB_ALIGN 8 41193880Syongari#define ALC_SMB_ALIGN 8 42193880Syongari 43193880Syongari#define ALC_TSO_MAXSEGSIZE 4096 44193880Syongari#define ALC_TSO_MAXSIZE (65535 + sizeof(struct ether_vlan_header)) 45263957Syongari#define ALC_MAXTXSEGS 35 46193880Syongari 47193880Syongari#define ALC_ADDR_LO(x) ((uint64_t) (x) & 0xFFFFFFFF) 48193880Syongari#define ALC_ADDR_HI(x) ((uint64_t) (x) >> 32) 49193880Syongari 50193880Syongari#define ALC_DESC_INC(x, y) ((x) = ((x) + 1) % (y)) 51193880Syongari 52193880Syongari/* Water mark to kick reclaiming Tx buffers. */ 53193880Syongari#define ALC_TX_DESC_HIWAT ((ALC_TX_RING_CNT * 6) / 10) 54193880Syongari 55272730Syongari/* 56272730Syongari * AR816x controllers support up to 16 messages but this driver 57272730Syongari * uses single message. 58272730Syongari */ 59193880Syongari#define ALC_MSI_MESSAGES 1 60193880Syongari#define ALC_MSIX_MESSAGES 1 61193880Syongari 62193880Syongari#define ALC_TX_RING_SZ \ 63193880Syongari (sizeof(struct tx_desc) * ALC_TX_RING_CNT) 64193880Syongari#define ALC_RX_RING_SZ \ 65193880Syongari (sizeof(struct rx_desc) * ALC_RX_RING_CNT) 66193880Syongari#define ALC_RR_RING_SZ \ 67193880Syongari (sizeof(struct rx_rdesc) * ALC_RR_RING_CNT) 68193880Syongari#define ALC_CMB_SZ (sizeof(struct cmb)) 69193880Syongari#define ALC_SMB_SZ (sizeof(struct smb)) 70193880Syongari 71193880Syongari#define ALC_PROC_MIN 16 72193880Syongari#define ALC_PROC_MAX (ALC_RX_RING_CNT - 1) 73193880Syongari#define ALC_PROC_DEFAULT (ALC_RX_RING_CNT / 4) 74193880Syongari 75193880Syongari/* 76211105Syongari * The number of bits reserved for MSS in AR813x/AR815x controllers 77193880Syongari * are 13 bits. This limits the maximum interface MTU size in TSO 78193880Syongari * case(8191 + sizeof(struct ip) + sizeof(struct tcphdr)) as upper 79193880Syongari * stack should not generate TCP segments with MSS greater than the 80193880Syongari * limit. Also Atheros says that maximum MTU for TSO is 6KB. 81193880Syongari */ 82193880Syongari#define ALC_TSO_MTU (6 * 1024) 83193880Syongari 84193880Syongaristruct alc_rxdesc { 85193880Syongari struct mbuf *rx_m; 86193880Syongari bus_dmamap_t rx_dmamap; 87193880Syongari struct rx_desc *rx_desc; 88193880Syongari}; 89193880Syongari 90193880Syongaristruct alc_txdesc { 91193880Syongari struct mbuf *tx_m; 92193880Syongari bus_dmamap_t tx_dmamap; 93193880Syongari}; 94193880Syongari 95193880Syongaristruct alc_ring_data { 96193880Syongari struct tx_desc *alc_tx_ring; 97193880Syongari bus_addr_t alc_tx_ring_paddr; 98193880Syongari struct rx_desc *alc_rx_ring; 99193880Syongari bus_addr_t alc_rx_ring_paddr; 100193880Syongari struct rx_rdesc *alc_rr_ring; 101193880Syongari bus_addr_t alc_rr_ring_paddr; 102193880Syongari struct cmb *alc_cmb; 103193880Syongari bus_addr_t alc_cmb_paddr; 104193880Syongari struct smb *alc_smb; 105193880Syongari bus_addr_t alc_smb_paddr; 106193880Syongari}; 107193880Syongari 108193880Syongaristruct alc_chain_data { 109193880Syongari bus_dma_tag_t alc_parent_tag; 110193880Syongari bus_dma_tag_t alc_buffer_tag; 111193880Syongari bus_dma_tag_t alc_tx_tag; 112193880Syongari struct alc_txdesc alc_txdesc[ALC_TX_RING_CNT]; 113193880Syongari bus_dma_tag_t alc_rx_tag; 114193880Syongari struct alc_rxdesc alc_rxdesc[ALC_RX_RING_CNT]; 115193880Syongari bus_dma_tag_t alc_tx_ring_tag; 116193880Syongari bus_dmamap_t alc_tx_ring_map; 117193880Syongari bus_dma_tag_t alc_rx_ring_tag; 118193880Syongari bus_dmamap_t alc_rx_ring_map; 119193880Syongari bus_dma_tag_t alc_rr_ring_tag; 120193880Syongari bus_dmamap_t alc_rr_ring_map; 121193880Syongari bus_dmamap_t alc_rx_sparemap; 122193880Syongari bus_dma_tag_t alc_cmb_tag; 123193880Syongari bus_dmamap_t alc_cmb_map; 124193880Syongari bus_dma_tag_t alc_smb_tag; 125193880Syongari bus_dmamap_t alc_smb_map; 126193880Syongari 127193880Syongari int alc_tx_prod; 128193880Syongari int alc_tx_cons; 129193880Syongari int alc_tx_cnt; 130193880Syongari int alc_rx_cons; 131193880Syongari int alc_rr_cons; 132193880Syongari int alc_rxlen; 133193880Syongari 134193880Syongari struct mbuf *alc_rxhead; 135193880Syongari struct mbuf *alc_rxtail; 136193880Syongari struct mbuf *alc_rxprev_tail; 137193880Syongari}; 138193880Syongari 139193880Syongaristruct alc_hw_stats { 140193880Syongari /* Rx stats. */ 141193880Syongari uint32_t rx_frames; 142193880Syongari uint32_t rx_bcast_frames; 143193880Syongari uint32_t rx_mcast_frames; 144193880Syongari uint32_t rx_pause_frames; 145193880Syongari uint32_t rx_control_frames; 146193880Syongari uint32_t rx_crcerrs; 147193880Syongari uint32_t rx_lenerrs; 148193880Syongari uint64_t rx_bytes; 149193880Syongari uint32_t rx_runts; 150193880Syongari uint32_t rx_fragments; 151193880Syongari uint32_t rx_pkts_64; 152193880Syongari uint32_t rx_pkts_65_127; 153193880Syongari uint32_t rx_pkts_128_255; 154193880Syongari uint32_t rx_pkts_256_511; 155193880Syongari uint32_t rx_pkts_512_1023; 156193880Syongari uint32_t rx_pkts_1024_1518; 157193880Syongari uint32_t rx_pkts_1519_max; 158193880Syongari uint32_t rx_pkts_truncated; 159193880Syongari uint32_t rx_fifo_oflows; 160193880Syongari uint32_t rx_rrs_errs; 161193880Syongari uint32_t rx_alignerrs; 162193880Syongari uint64_t rx_bcast_bytes; 163193880Syongari uint64_t rx_mcast_bytes; 164193880Syongari uint32_t rx_pkts_filtered; 165193880Syongari /* Tx stats. */ 166193880Syongari uint32_t tx_frames; 167193880Syongari uint32_t tx_bcast_frames; 168193880Syongari uint32_t tx_mcast_frames; 169193880Syongari uint32_t tx_pause_frames; 170193880Syongari uint32_t tx_excess_defer; 171193880Syongari uint32_t tx_control_frames; 172193880Syongari uint32_t tx_deferred; 173193880Syongari uint64_t tx_bytes; 174193880Syongari uint32_t tx_pkts_64; 175193880Syongari uint32_t tx_pkts_65_127; 176193880Syongari uint32_t tx_pkts_128_255; 177193880Syongari uint32_t tx_pkts_256_511; 178193880Syongari uint32_t tx_pkts_512_1023; 179193880Syongari uint32_t tx_pkts_1024_1518; 180193880Syongari uint32_t tx_pkts_1519_max; 181193880Syongari uint32_t tx_single_colls; 182193880Syongari uint32_t tx_multi_colls; 183193880Syongari uint32_t tx_late_colls; 184193880Syongari uint32_t tx_excess_colls; 185193880Syongari uint32_t tx_abort; 186193880Syongari uint32_t tx_underrun; 187193880Syongari uint32_t tx_desc_underrun; 188193880Syongari uint32_t tx_lenerrs; 189193880Syongari uint32_t tx_pkts_truncated; 190193880Syongari uint64_t tx_bcast_bytes; 191193880Syongari uint64_t tx_mcast_bytes; 192193880Syongari}; 193193880Syongari 194211105Syongaristruct alc_ident { 195211105Syongari uint16_t vendorid; 196211105Syongari uint16_t deviceid; 197211105Syongari uint32_t max_framelen; 198211105Syongari const char *name; 199211105Syongari}; 200211105Syongari 201193880Syongari/* 202193880Syongari * Software state per device. 203193880Syongari */ 204193880Syongaristruct alc_softc { 205193880Syongari struct ifnet *alc_ifp; 206193880Syongari device_t alc_dev; 207193880Syongari device_t alc_miibus; 208193880Syongari struct resource *alc_res[1]; 209193880Syongari struct resource_spec *alc_res_spec; 210193880Syongari struct resource *alc_irq[ALC_MSI_MESSAGES]; 211193880Syongari struct resource_spec *alc_irq_spec; 212193880Syongari void *alc_intrhand[ALC_MSI_MESSAGES]; 213211105Syongari struct alc_ident *alc_ident; 214193880Syongari int alc_rev; 215193880Syongari int alc_chip_rev; 216193880Syongari int alc_phyaddr; 217193880Syongari uint8_t alc_eaddr[ETHER_ADDR_LEN]; 218193880Syongari uint32_t alc_dma_rd_burst; 219193880Syongari uint32_t alc_dma_wr_burst; 220193880Syongari uint32_t alc_rcb; 221211053Syongari int alc_expcap; 222211053Syongari int alc_pmcap; 223193880Syongari int alc_flags; 224193880Syongari#define ALC_FLAG_PCIE 0x0001 225193880Syongari#define ALC_FLAG_PCIX 0x0002 226193880Syongari#define ALC_FLAG_MSI 0x0004 227193880Syongari#define ALC_FLAG_MSIX 0x0008 228211053Syongari#define ALC_FLAG_PM 0x0010 229193880Syongari#define ALC_FLAG_FASTETHER 0x0020 230193880Syongari#define ALC_FLAG_JUMBO 0x0040 231193880Syongari#define ALC_FLAG_CMB_BUG 0x0100 232193880Syongari#define ALC_FLAG_SMB_BUG 0x0200 233211105Syongari#define ALC_FLAG_L0S 0x0400 234211105Syongari#define ALC_FLAG_L1S 0x0800 235211105Syongari#define ALC_FLAG_APS 0x1000 236272730Syongari#define ALC_FLAG_AR816X_FAMILY 0x2000 237272730Syongari#define ALC_FLAG_LINK_WAR 0x4000 238312358Syongari#define ALC_FLAG_E2X00 0x8000 239312358Syongari#define ALC_FLAG_LINK 0x10000 240193880Syongari 241193880Syongari struct callout alc_tick_ch; 242193880Syongari struct alc_hw_stats alc_stats; 243193880Syongari struct alc_chain_data alc_cdata; 244193880Syongari struct alc_ring_data alc_rdata; 245193880Syongari int alc_if_flags; 246193880Syongari int alc_watchdog_timer; 247193880Syongari int alc_process_limit; 248193880Syongari volatile int alc_morework; 249193880Syongari int alc_int_rx_mod; 250193880Syongari int alc_int_tx_mod; 251193880Syongari int alc_buf_size; 252193880Syongari 253193880Syongari struct task alc_int_task; 254193880Syongari struct taskqueue *alc_tq; 255193880Syongari struct mtx alc_mtx; 256193880Syongari}; 257193880Syongari 258193880Syongari/* Register access macros. */ 259193880Syongari#define CSR_WRITE_4(_sc, reg, val) \ 260193880Syongari bus_write_4((_sc)->alc_res[0], (reg), (val)) 261193880Syongari#define CSR_WRITE_2(_sc, reg, val) \ 262193880Syongari bus_write_2((_sc)->alc_res[0], (reg), (val)) 263193880Syongari#define CSR_WRITE_1(_sc, reg, val) \ 264193880Syongari bus_write_1((_sc)->alc_res[0], (reg), (val)) 265193880Syongari#define CSR_READ_2(_sc, reg) \ 266193880Syongari bus_read_2((_sc)->alc_res[0], (reg)) 267193880Syongari#define CSR_READ_4(_sc, reg) \ 268193880Syongari bus_read_4((_sc)->alc_res[0], (reg)) 269193880Syongari 270193880Syongari#define ALC_RXCHAIN_RESET(_sc) \ 271193880Syongarido { \ 272193880Syongari (_sc)->alc_cdata.alc_rxhead = NULL; \ 273193880Syongari (_sc)->alc_cdata.alc_rxtail = NULL; \ 274193880Syongari (_sc)->alc_cdata.alc_rxprev_tail = NULL; \ 275193880Syongari (_sc)->alc_cdata.alc_rxlen = 0; \ 276193880Syongari} while (0) 277193880Syongari 278193880Syongari#define ALC_LOCK(_sc) mtx_lock(&(_sc)->alc_mtx) 279193880Syongari#define ALC_UNLOCK(_sc) mtx_unlock(&(_sc)->alc_mtx) 280193880Syongari#define ALC_LOCK_ASSERT(_sc) mtx_assert(&(_sc)->alc_mtx, MA_OWNED) 281193880Syongari 282193880Syongari#define ALC_TX_TIMEOUT 5 283193880Syongari#define ALC_RESET_TIMEOUT 100 284193880Syongari#define ALC_TIMEOUT 1000 285193880Syongari#define ALC_PHY_TIMEOUT 1000 286193880Syongari 287193880Syongari#endif /* _IF_ALCVAR_H */ 288