1 /* $NetBSD: dm9000var.h,v 1.3 2018/04/19 21:50:08 christos Exp $ */ 2 3 /* 4 * Copyright (c) 2009 Paul Fleischer 5 * All rights reserved. 6 * 7 * 1. Redistributions of source code must retain the above copyright 8 * notice, this list of conditions and the following disclaimer. 9 * 2. Redistributions in binary form must reproduce the above copyright 10 * notice, this list of conditions and the following disclaimer in the 11 * documentation and/or other materials provided with the distribution. 12 * 3. The name of the company nor the name of the author may be used to 13 * endorse or promote products derived from this software without specific 14 * prior written permission. 15 * 16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED 17 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 18 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 19 * IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, 20 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES 21 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 22 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 26 * SUCH DAMAGE. 27 */ 28 29 /* Based on sys/dev/ic/cs89x0var.h */ 30 /* 31 * Copyright 1997 32 * Digital Equipment Corporation. All rights reserved. 33 * 34 * This software is furnished under license and may be used and 35 * copied only in accordance with the following terms and conditions. 36 * Subject to these conditions, you may download, copy, install, 37 * use, modify and distribute this software in source and/or binary 38 * form. No title or ownership is transferred hereby. 39 * 40 * 1) Any source code used, modified or distributed must reproduce 41 * and retain this copyright notice and list of conditions as 42 * they appear in the source file. 43 * 44 * 2) No right is granted to use any trade name, trademark, or logo of 45 * Digital Equipment Corporation. Neither the "Digital Equipment 46 * Corporation" name nor any trademark or logo of Digital Equipment 47 * Corporation may be used to endorse or promote products derived 48 * from this software without the prior written permission of 49 * Digital Equipment Corporation. 50 * 51 * 3) This software is provided "AS-IS" and any express or implied 52 * warranties, including but not limited to, any implied warranties 53 * of merchantability, fitness for a particular purpose, or 54 * non-infringement are disclaimed. In no event shall DIGITAL be 55 * liable for any damages whatsoever, and in particular, DIGITAL 56 * shall not be liable for special, indirect, consequential, or 57 * incidental damages or damages for lost profits, loss of 58 * revenue or loss of use, whether such damages arise in contract, 59 * negligence, tort, under statute, in equity, at law or otherwise, 60 * even if advised of the possibility of such damage. 61 */ 62 63 #ifndef _DEV_IC_DM9000VAR_H_ 64 #define _DEV_IC_DM9000VAR_H_ 65 66 #include <sys/callout.h> 67 68 #define DM9000_MODE_8BIT 2 69 #define DM9000_MODE_16BIT 0 70 #define DM9000_MODE_32BIT 1 71 72 struct dme_softc { 73 device_t sc_dev; /* Generic Base Device */ 74 75 struct ethercom sc_ethercom; /* Ethernet common data */ 76 struct ifmedia sc_media; /* Media control structures */ 77 78 uint sc_media_active; 79 uint sc_media_status; 80 81 bus_space_tag_t sc_iot; 82 bus_space_handle_t sc_ioh; 83 void *sc_ih; 84 85 uint dme_io; 86 uint dme_data; 87 88 uint16_t sc_vendor_id; 89 uint16_t sc_product_id; 90 91 uint8_t sc_data_width; 92 93 uint8_t sc_enaddr[ETHER_ADDR_LEN]; 94 95 int txbusy; /* A packet is being transmitted. */ 96 int txready; /* A packet has been sent to the DM9000 97 for transmission. */ 98 uint16_t txready_length; 99 100 int (*sc_pkt_write)(struct dme_softc*, struct mbuf *); 101 int (*sc_pkt_read)(struct dme_softc*, struct ifnet *, struct mbuf **); 102 103 callout_t sc_link_callout; 104 105 bool sc_phy_initialized; 106 107 #ifdef DIAGNOSTIC 108 bool sc_inside_interrupt; 109 #endif 110 }; 111 112 /* Function declarations */ 113 int dme_attach(struct dme_softc *, const uint8_t *); 114 int dme_detach(struct dme_softc *); 115 int dme_intr(void *); 116 117 /* Helper method used by sc_pkt_read */ 118 struct mbuf* dme_alloc_receive_buffer(struct ifnet *, unsigned int); 119 120 /* Inline memory access methods */ 121 static __inline uint8_t 122 dme_read(struct dme_softc *sc, int reg) 123 { 124 bus_space_write_1(sc->sc_iot, sc->sc_ioh, sc->dme_io, reg); 125 return (bus_space_read_1(sc->sc_iot, sc->sc_ioh, sc->dme_data)); 126 } 127 128 static __inline void 129 dme_write(struct dme_softc *sc, int reg, uint8_t value) 130 { 131 bus_space_write_1(sc->sc_iot, sc->sc_ioh, sc->dme_io, reg); 132 bus_space_write_1(sc->sc_iot, sc->sc_ioh, sc->dme_data, value); 133 } 134 135 static __inline void 136 dme_write2(struct dme_softc *sc, int reg, uint16_t value) 137 { 138 bus_space_write_1(sc->sc_iot, sc->sc_ioh, sc->dme_io, reg); 139 bus_space_write_2(sc->sc_iot, sc->sc_ioh, sc->dme_data, value); 140 } 141 142 static __inline void 143 dme_write_c(struct dme_softc *sc, int reg, uint8_t value[], uint count) 144 { 145 for(int i=0; i<count; i++) { 146 dme_write(sc, reg+i, value[i]); 147 } 148 } 149 150 static __inline void 151 dme_read_c(struct dme_softc *sc, int reg, uint8_t *value, uint count) 152 { 153 for(int i=0; i<count; i++) { 154 value[i] = dme_read(sc, reg+i); 155 } 156 } 157 158 #endif /* _DEV_IC_DM9000VAR_H_ */ 159 160