1 /* $OpenBSD: if_skvar.h,v 1.10 2017/01/08 18:08:14 visa Exp $ */ 2 /* $NetBSD: if_skvar.h,v 1.6 2005/05/30 04:35:22 christos Exp $ */ 3 4 /*- 5 * Copyright (c) 2003 The NetBSD Foundation, Inc. 6 * All rights reserved. 7 * 8 * Redistribution and use in source and binary forms, with or without 9 * modification, are permitted provided that the following conditions 10 * are met: 11 * 1. Redistributions of source code must retain the above copyright 12 * notice, this list of conditions and the following disclaimer. 13 * 2. Redistributions in binary form must reproduce the above copyright 14 * notice, this list of conditions and the following disclaimer in the 15 * documentation and/or other materials provided with the distribution. 16 * 17 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 18 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 19 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 20 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 21 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 22 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 23 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 24 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 25 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 26 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 27 * POSSIBILITY OF SUCH DAMAGE. 28 */ 29 /* $OpenBSD: if_skvar.h,v 1.10 2017/01/08 18:08:14 visa Exp $ */ 30 31 /* 32 * Copyright (c) 1997, 1998, 1999, 2000 33 * Bill Paul <wpaul@ctr.columbia.edu>. All rights reserved. 34 * 35 * Redistribution and use in source and binary forms, with or without 36 * modification, are permitted provided that the following conditions 37 * are met: 38 * 1. Redistributions of source code must retain the above copyright 39 * notice, this list of conditions and the following disclaimer. 40 * 2. Redistributions in binary form must reproduce the above copyright 41 * notice, this list of conditions and the following disclaimer in the 42 * documentation and/or other materials provided with the distribution. 43 * 3. All advertising materials mentioning features or use of this software 44 * must display the following acknowledgement: 45 * This product includes software developed by Bill Paul. 46 * 4. Neither the name of the author nor the names of any co-contributors 47 * may be used to endorse or promote products derived from this software 48 * without specific prior written permission. 49 * 50 * THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND 51 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 52 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 53 * ARE DISCLAIMED. IN NO EVENT SHALL Bill Paul OR THE VOICES IN HIS HEAD 54 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 55 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 56 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 57 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 58 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 59 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF 60 * THE POSSIBILITY OF SUCH DAMAGE. 61 * 62 * $FreeBSD: /c/ncvs/src/sys/pci/if_skreg.h,v 1.9 2000/04/22 02:16:37 wpaul Exp $ 63 */ 64 65 /* 66 * Copyright (c) 2003 Nathan L. Binkert <binkertn@umich.edu> 67 * 68 * Permission to use, copy, modify, and distribute this software for any 69 * purpose with or without fee is hereby granted, provided that the above 70 * copyright notice and this permission notice appear in all copies. 71 * 72 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 73 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 74 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 75 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 76 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 77 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 78 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. 79 */ 80 81 #ifndef _DEV_PCI_IF_SKVAR_H_ 82 #define _DEV_PCI_IF_SKVAR_H_ 83 84 struct sk_chain { 85 void *sk_desc; 86 struct mbuf *sk_mbuf; 87 struct sk_chain *sk_next; 88 }; 89 90 /* 91 * Number of DMA segments in a TxCB. Note that this is carefully 92 * chosen to make the total struct size an even power of two. It's 93 * critical that no TxCB be split across a page boundary since 94 * no attempt is made to allocate physically contiguous memory. 95 * 96 */ 97 #define SK_NTXSEG 30 98 99 struct sk_txmap_entry { 100 bus_dmamap_t dmamap; 101 SIMPLEQ_ENTRY(sk_txmap_entry) link; 102 }; 103 104 struct sk_chain_data { 105 struct sk_chain sk_tx_chain[SK_TX_RING_CNT]; 106 struct sk_chain sk_rx_chain[SK_RX_RING_CNT]; 107 struct sk_txmap_entry *sk_tx_map[SK_TX_RING_CNT]; 108 bus_dmamap_t sk_rx_map[SK_RX_RING_CNT]; 109 int sk_tx_prod; 110 int sk_tx_cons; 111 int sk_tx_cnt; 112 int sk_rx_prod; 113 int sk_rx_cons; 114 struct if_rxring sk_rx_ring; 115 }; 116 117 struct sk_ring_data { 118 struct sk_tx_desc sk_tx_ring[SK_TX_RING_CNT]; 119 struct sk_rx_desc sk_rx_ring[SK_RX_RING_CNT]; 120 }; 121 122 #define SK_TX_RING_ADDR(sc, i) \ 123 ((sc)->sk_ring_map->dm_segs[0].ds_addr + \ 124 offsetof(struct sk_ring_data, sk_tx_ring[(i)])) 125 126 #define SK_RX_RING_ADDR(sc, i) \ 127 ((sc)->sk_ring_map->dm_segs[0].ds_addr + \ 128 offsetof(struct sk_ring_data, sk_rx_ring[(i)])) 129 130 #define SK_CDOFF(x) offsetof(struct sk_ring_data, x) 131 #define SK_CDTXOFF(x) SK_CDOFF(sk_tx_ring[(x)]) 132 #define SK_CDRXOFF(x) SK_CDOFF(sk_rx_ring[(x)]) 133 134 #define SK_CDTXSYNC(sc, x, n, ops) \ 135 do { \ 136 int __x, __n; \ 137 \ 138 __x = (x); \ 139 __n = (n); \ 140 \ 141 /* If it will wrap around, sync to the end of the ring. */ \ 142 if ((__x + __n) > SK_TX_RING_CNT) { \ 143 bus_dmamap_sync((sc)->sk_softc->sc_dmatag, \ 144 (sc)->sk_ring_map, SK_CDTXOFF(__x), \ 145 sizeof(struct sk_tx_desc) * (SK_TX_RING_CNT - __x),\ 146 (ops)); \ 147 __n -= (SK_TX_RING_CNT - __x); \ 148 __x = 0; \ 149 } \ 150 \ 151 /* Now sync whatever is left. */ \ 152 bus_dmamap_sync((sc)->sk_softc->sc_dmatag, (sc)->sk_ring_map, \ 153 SK_CDTXOFF((__x)), sizeof(struct sk_tx_desc) * __n, (ops)); \ 154 } while (/*CONSTCOND*/0) 155 156 #define SK_CDRXSYNC(sc, x, ops) \ 157 do { \ 158 bus_dmamap_sync((sc)->sk_softc->sc_dmatag, (sc)->sk_ring_map, \ 159 SK_CDRXOFF((x)), sizeof(struct sk_rx_desc), (ops)); \ 160 } while (/*CONSTCOND*/0) 161 162 struct sk_bcom_hack { 163 int reg; 164 int val; 165 }; 166 167 #define SK_INC(x, y) (x) = (x + 1) % y 168 169 /* Forward decl. */ 170 struct sk_if_softc; 171 172 /* Softc for the GEnesis controller. */ 173 struct sk_softc { 174 struct device sk_dev; /* generic device */ 175 bus_space_handle_t sk_bhandle; /* bus space handle */ 176 bus_space_tag_t sk_btag; /* bus space tag */ 177 bus_size_t sk_bsize; /* bus space size */ 178 void *sk_intrhand; /* irq handler handle */ 179 pci_chipset_tag_t sk_pc; 180 u_int8_t sk_coppertype; 181 u_int8_t sk_pmd; /* physical media type */ 182 u_int8_t sk_type; 183 u_int8_t sk_rev; 184 u_int8_t sk_macs; /* # of MACs */ 185 char *sk_name; 186 u_int32_t sk_rboff; /* RAMbuffer offset */ 187 u_int32_t sk_ramsize; /* amount of RAM on NIC */ 188 u_int32_t sk_intrmask; 189 bus_dma_tag_t sc_dmatag; 190 struct sk_if_softc *sk_if[2]; 191 }; 192 193 /* Softc for each logical interface */ 194 struct sk_if_softc { 195 struct device sk_dev; /* generic device */ 196 struct arpcom arpcom; /* interface info */ 197 struct mii_data sk_mii; 198 u_int8_t sk_port; /* port # on controller */ 199 u_int8_t sk_xmac_rev; /* XMAC chip rev (B2 or C1) */ 200 u_int32_t sk_rx_ramstart; 201 u_int32_t sk_rx_ramend; 202 u_int32_t sk_tx_ramstart; 203 u_int32_t sk_tx_ramend; 204 u_int8_t sk_phytype; 205 int sk_phyaddr; 206 int sk_cnt; 207 int sk_link; 208 struct timeout sk_tick_ch; 209 struct sk_chain_data sk_cdata; 210 struct sk_ring_data *sk_rdata; 211 bus_dmamap_t sk_ring_map; 212 bus_dma_segment_t sk_ring_seg; 213 int sk_ring_nseg; 214 struct sk_softc *sk_softc; /* parent controller */ 215 int sk_tx_bmu; /* TX BMU register */ 216 SIMPLEQ_HEAD(__sk_txmaphead, sk_txmap_entry) sk_txmap_head; 217 }; 218 219 struct skc_attach_args { 220 u_int16_t skc_port; 221 u_int8_t skc_type; 222 u_int8_t skc_rev; 223 }; 224 225 #define SK_TX_TIMEOUT 5 226 227 #endif /* _DEV_PCI_IF_SKVAR_H_ */ 228