Home | History | Annotate | Line # | Download | only in ic
dp83932var.h revision 1.4
      1 /*	$NetBSD: dp83932var.h,v 1.4 2003/01/15 22:35:47 bouyer Exp $	*/
      2 
      3 /*-
      4  * Copyright (c) 2001 The NetBSD Foundation, Inc.
      5  * All rights reserved.
      6  *
      7  * This code is derived from software contributed to The NetBSD Foundation
      8  * by Jason R. Thorpe.
      9  *
     10  * Redistribution and use in source and binary forms, with or without
     11  * modification, are permitted provided that the following conditions
     12  * are met:
     13  * 1. Redistributions of source code must retain the above copyright
     14  *    notice, this list of conditions and the following disclaimer.
     15  * 2. Redistributions in binary form must reproduce the above copyright
     16  *    notice, this list of conditions and the following disclaimer in the
     17  *    documentation and/or other materials provided with the distribution.
     18  * 3. All advertising materials mentioning features or use of this software
     19  *    must display the following acknowledgement:
     20  *	This product includes software developed by the NetBSD
     21  *	Foundation, Inc. and its contributors.
     22  * 4. Neither the name of The NetBSD Foundation nor the names of its
     23  *    contributors may be used to endorse or promote products derived
     24  *    from this software without specific prior written permission.
     25  *
     26  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
     27  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
     28  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
     29  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
     30  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
     31  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
     32  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
     33  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
     34  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
     35  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
     36  * POSSIBILITY OF SUCH DAMAGE.
     37  */
     38 
     39 #ifndef _DEV_IC_DP83932VAR_H_
     40 #define	_DEV_IC_DP83932VAR_H_
     41 
     42 /*
     43  * Data structure definitions for the National Semiconductor DP83932
     44  * Systems-Oriented Network Interface Controller (SONIC).
     45  */
     46 
     47 /*
     48  * NOTE: The control data for the SONIC must not cross a 64k boundary,
     49  * so we have to be careful about how we size things.
     50  *
     51  * Also, since the SONIC is only a 10Mb/s chip, and systems on which
     52  * it is present tend to be low on memory, we try to keep the data
     53  * structure sizes small.
     54  */
     55 
     56 /*
     57  * Transmit descriptor list size.
     58  */
     59 #define	SONIC_NTXDESC		32
     60 #define	SONIC_NTXDESC_MASK	(SONIC_NTXDESC - 1)
     61 #define	SONIC_NEXTTX(x)		(((x) + 1) & SONIC_NTXDESC_MASK)
     62 
     63 /*
     64  * Receive descriptor list size.
     65  */
     66 #define	SONIC_NRXDESC		32
     67 #define	SONIC_NRXDESC_MASK	(SONIC_NRXDESC - 1)
     68 #define	SONIC_NEXTRX(x)		(((x) + 1) & SONIC_NRXDESC_MASK)
     69 #define	SONIC_PREVRX(x)		(((x) - 1) & SONIC_NRXDESC_MASK)
     70 #define	SONIC_RXSEQ_TO_DESC(x)	((x) & SONIC_NRXDESC_MASK)
     71 
     72 /*
     73  * Control structures are DMA'd to the SONIC chip.  We allocate them in
     74  * a single clump that maps to a single DMA segment to make several things
     75  * easier.
     76  */
     77 struct sonic_control_data16 {
     78 	/*
     79 	 * The transmit descriptors.
     80 	 */
     81 	struct sonic_tda16 scd_txdescs[SONIC_NTXDESC];
     82 
     83 	/*
     84 	 * The receive descriptors.
     85 	 */
     86 	struct sonic_rda16 scd_rxdescs[SONIC_NRXDESC];
     87 
     88 	/*
     89 	 * The receive resource descriptors.
     90 	 */
     91 	struct sonic_rra16 scd_rxbufs[SONIC_NRXDESC];
     92 
     93 	/*
     94 	 * The CAM descriptors.
     95 	 */
     96 	struct sonic_cda16 scd_cam[16];
     97 };
     98 
     99 #define	SONIC_CDOFF16(x)	offsetof(struct sonic_control_data16, x)
    100 #define	SONIC_CDTXOFF16(x)	SONIC_CDOFF16(scd_txdescs[(x)])
    101 #define	SONIC_CDRXOFF16(x)	SONIC_CDOFF16(scd_rxdescs[(x)])
    102 #define	SONIC_CDRROFF16(x)	SONIC_CDOFF16(scd_rxbufs[(x)])
    103 #define	SONIC_CDCAMOFF16	SONIC_CDOFF16(scd_cam)
    104 
    105 struct sonic_control_data32 {
    106 	/*
    107 	 * The transmit descriptors.
    108 	 */
    109 	struct sonic_tda32 scd_txdescs[SONIC_NTXDESC];
    110 
    111 	/*
    112 	 * The receive descriptors.
    113 	 */
    114 	struct sonic_rda32 scd_rxdescs[SONIC_NRXDESC];
    115 
    116 	/*
    117 	 * The receive resource descriptors.
    118 	 */
    119 	struct sonic_rra32 scd_rxbufs[SONIC_NRXDESC];
    120 
    121 	/*
    122 	 * The CAM descriptors.
    123 	 */
    124 	struct sonic_cda32 scd_cam[16];
    125 };
    126 
    127 #define	SONIC_CDOFF32(x)	offsetof(struct sonic_control_data32, x)
    128 #define	SONIC_CDTXOFF32(x)	SONIC_CDOFF32(scd_txdescs[(x)])
    129 #define	SONIC_CDRXOFF32(x)	SONIC_CDOFF32(scd_rxdescs[(x)])
    130 #define	SONIC_CDRROFF32(x)	SONIC_CDOFF32(scd_rxbufs[(x)])
    131 #define	SONIC_CDCAMOFF32	SONIC_CDOFF32(scd_cam)
    132 
    133 /*
    134  * Software state for transmit and receive descriptors.
    135  */
    136 struct sonic_descsoft {
    137 	struct mbuf *ds_mbuf;		/* head of mbuf chain */
    138 	bus_dmamap_t ds_dmamap;		/* our DMA map */
    139 };
    140 
    141 /*
    142  * Software state per device.
    143  */
    144 struct sonic_softc {
    145 	struct device sc_dev;		/* generic device information */
    146 	bus_space_tag_t sc_st;		/* bus space tag */
    147 	bus_space_handle_t sc_sh;	/* bus space handle */
    148 	bus_dma_tag_t sc_dmat;		/* bus DMA tag */
    149 	struct ethercom sc_ethercom;	/* ethernet common data */
    150 	void *sc_sdhook;		/* shutdown hook */
    151 
    152 	int sc_32bit;			/* use 32-bit mode */
    153 	int sc_bigendian;		/* BMODE -> Vcc */
    154 
    155 	/* Our register map. */
    156 	bus_addr_t sc_regmap[SONIC_NREGS];
    157 
    158 	bus_dmamap_t sc_cddmamap;	/* control data DMA map */
    159 #define	sc_cddma	sc_cddmamap->dm_segs[0].ds_addr
    160 	bus_dmamap_t sc_nulldmamap;	/* DMA map for the pad buffer */
    161 #define sc_nulldma     sc_nulldmamap->dm_segs[0].ds_addr
    162 
    163 	/*
    164 	 * Software state for transmit and receive descriptors.
    165 	 */
    166 	struct sonic_descsoft sc_txsoft[SONIC_NTXDESC];
    167 	struct sonic_descsoft sc_rxsoft[SONIC_NRXDESC];
    168 
    169 	/*
    170 	 * Control data structures.
    171 	 */
    172 	union {
    173 		struct sonic_control_data16 *cdun_16;
    174 		struct sonic_control_data32 *cdun_32;
    175 	} sc_cdun;
    176 #define	sc_cdata16	sc_cdun.cdun_16
    177 #define	sc_cdata32	sc_cdun.cdun_32
    178 
    179 #define	sc_tda16	sc_cdun.cdun_16->scd_txdescs
    180 #define	sc_rda16	sc_cdun.cdun_16->scd_rxdescs
    181 #define	sc_rra16	sc_cdun.cdun_16->scd_rxbufs
    182 #define	sc_cda16	sc_cdun.cdun_16->scd_cam
    183 
    184 #define	sc_tda32	sc_cdun.cdun_32->scd_txdescs
    185 #define	sc_rda32	sc_cdun.cdun_32->scd_rxdescs
    186 #define	sc_rra32	sc_cdun.cdun_32->scd_rxbufs
    187 #define	sc_cda32	sc_cdun.cdun_32->scd_cam
    188 
    189 	int	sc_txpending;		/* number of Tx requests pending */
    190 	int	sc_txdirty;		/* first dirty Tx descriptor */
    191 	int	sc_txlast;		/* last used Tx descriptor */
    192 
    193 	int	sc_rxptr;		/* next ready Rx descriptor */
    194 
    195 	uint16_t sc_imr;		/* prototype IMR */
    196 	uint16_t sc_dcr;		/* prototype DCR */
    197 	uint16_t sc_dcr2;		/* prototype DCR2 */
    198 };
    199 
    200 #define	CSR_READ(sc, reg)						\
    201 	bus_space_read_2((sc)->sc_st, (sc)->sc_sh,			\
    202 	    (sc)->sc_regmap[(reg)])
    203 
    204 #define	CSR_WRITE(sc, reg, val)						\
    205 	bus_space_write_2((sc)->sc_st, (sc)->sc_sh,			\
    206 	    (sc)->sc_regmap[(reg)], (val))
    207 
    208 #define	SONIC_CDTXADDR16(sc, x)						\
    209 	((sc)->sc_cddma + SONIC_CDTXOFF16((x)))
    210 
    211 #define	SONIC_CDTXADDR32(sc, x)						\
    212 	((sc)->sc_cddma + SONIC_CDTXOFF32((x)))
    213 
    214 #define	SONIC_CDTXADDR(sc, x)						\
    215 	((sc)->sc_32bit ? SONIC_CDTXADDR32((sc), (x)) :			\
    216 	    SONIC_CDTXADDR16((sc), (x)))
    217 
    218 #define	SONIC_CDRXADDR16(sc, x)						\
    219 	((sc)->sc_cddma + SONIC_CDRXOFF16((x)))
    220 
    221 #define	SONIC_CDRXADDR32(sc, x)						\
    222 	((sc)->sc_cddma + SONIC_CDRXOFF32((x)))
    223 
    224 #define	SONIC_CDRXADDR(sc, x)						\
    225 	((sc)->sc_32bit ? SONIC_CDRXADDR32((sc), (x)) :			\
    226 	    SONIC_CDRXADDR16((sc), (x)))
    227 
    228 #define	SONIC_CDRRADDR(sc, x)						\
    229 	((sc)->sc_cddma +						\
    230 	 ((sc)->sc_32bit ? SONIC_CDRROFF32((x)) : SONIC_CDRROFF16((x))))
    231 
    232 #define	SONIC_CDCAMADDR(sc)						\
    233 	((sc)->sc_cddma +						\
    234 	 ((sc)->sc_32bit ? SONIC_CDCAMOFF32 : SONIC_CDCAMOFF32))
    235 
    236 #define	SONIC_CDTXSYNC16(sc, x, ops)					\
    237 	bus_dmamap_sync((sc)->sc_dmat, (sc)->sc_cddmamap,		\
    238 	    SONIC_CDTXOFF16((x)), sizeof(struct sonic_tda16), (ops))
    239 
    240 #define	SONIC_CDTXSYNC32(sc, x, ops)					\
    241 	bus_dmamap_sync((sc)->sc_dmat, (sc)->sc_cddmamap,		\
    242 	    SONIC_CDTXOFF32((x)), sizeof(struct sonic_tda32), (ops))
    243 
    244 #define	SONIC_CDRXSYNC16(sc, x, ops)					\
    245 	bus_dmamap_sync((sc)->sc_dmat, (sc)->sc_cddmamap,		\
    246 	    SONIC_CDRXOFF16((x)), sizeof(struct sonic_rda16), (ops))
    247 
    248 #define	SONIC_CDRXSYNC32(sc, x, ops)					\
    249 	bus_dmamap_sync((sc)->sc_dmat, (sc)->sc_cddmamap,		\
    250 	    SONIC_CDRXOFF32((x)), sizeof(struct sonic_rda32), (ops))
    251 
    252 #define	SONIC_CDRRSYNC16(sc, x, ops)					\
    253 	bus_dmamap_sync((sc)->sc_dmat, (sc)->sc_cddmamap,		\
    254 	    SONIC_CDRROFF16((x)), sizeof(struct sonic_rra16), (ops))
    255 
    256 #define	SONIC_CDRRSYNC32(sc, x, ops)					\
    257 	bus_dmamap_sync((sc)->sc_dmat, (sc)->sc_cddmamap,		\
    258 	    SONIC_CDRROFF32((x)), sizeof(struct sonic_rra32), (ops))
    259 
    260 #define	SONIC_CDCAMSYNC(sc, ops)					\
    261 do {									\
    262 	if ((sc)->sc_32bit)						\
    263 		bus_dmamap_sync((sc)->sc_dmat, (sc)->sc_cddmamap,	\
    264 		    SONIC_CDCAMOFF32, sizeof(struct sonic_cda32) * 16,	\
    265 		    (ops));						\
    266 	else								\
    267 		bus_dmamap_sync((sc)->sc_dmat, (sc)->sc_cddmamap,	\
    268 		    SONIC_CDCAMOFF16, sizeof(struct sonic_cda16) * 16,	\
    269 		    (ops));						\
    270 } while (/*CONSTCOND*/0)
    271 
    272 #define	SONIC_INIT_RXDESC(sc, x)					\
    273 do {									\
    274 	struct sonic_descsoft *__ds = &(sc)->sc_rxsoft[(x)];		\
    275 	struct mbuf *__m = __ds->ds_mbuf;				\
    276 									\
    277 	if ((sc)->sc_32bit) {						\
    278 		/*							\
    279 		 * Unfortuantely, in 32-bit mode, the Rx buffer must	\
    280 		 * be 32-bit aligned.					\
    281 		 */							\
    282 		struct sonic_rda32 *__rda = &(sc)->sc_rda32[(x)];	\
    283 		struct sonic_rda32 *__prda =				\
    284 		    &(sc)->sc_rda32[SONIC_PREVRX((x))];			\
    285 		struct sonic_rra32 *__rra = &(sc)->sc_rra32[(x)];	\
    286 									\
    287 		__m->m_data = __m->m_ext.ext_buf;			\
    288 									\
    289 		__rra->rra_ptr1 =					\
    290 		    __ds->ds_dmamap->dm_segs[0].ds_addr >> 16;		\
    291 		__rra->rra_ptr0 =					\
    292 		    __ds->ds_dmamap->dm_segs[0].ds_addr & 0xffff;	\
    293 		__rra->rra_wc1 = 0;					\
    294 		__rra->rra_wc0 = (ETHER_MAX_LEN + 6) / 2;		\
    295 									\
    296 		__rda->rda_link =					\
    297 		    (SONIC_CDRXADDR32((sc), SONIC_NEXTRX((x))) & 0xffff) |\
    298 		    RDA_LINK_EOL;					\
    299 		__rda->rda_inuse = 1;					\
    300 									\
    301 		__prda->rda_link = SONIC_CDRXADDR32((sc), (x));		\
    302 									\
    303 		SONIC_CDRRSYNC32((sc), (x), BUS_DMASYNC_PREWRITE);	\
    304 		SONIC_CDRXSYNC32((sc), (x),				\
    305 		    BUS_DMASYNC_PREREAD|BUS_DMASYNC_PREWRITE);		\
    306 		SONIC_CDRXSYNC32((sc), SONIC_PREVRX(x),			\
    307 		    BUS_DMASYNC_PREREAD|BUS_DMASYNC_PREWRITE);		\
    308 	} else {							\
    309 		/*							\
    310 		 * In 16-bit mode, we scoot the packet forward 2 bytes	\
    311 		 * so that the payload after the Ethernet header is	\
    312 		 * suitably aligned.					\
    313 		 */							\
    314 		struct sonic_rda16 *__rda = &(sc)->sc_rda16[(x)];	\
    315 		struct sonic_rda16 *__prda =				\
    316 		    &(sc)->sc_rda16[SONIC_PREVRX((x))];			\
    317 		struct sonic_rra16 *__rra = &(sc)->sc_rra16[(x)];	\
    318 									\
    319 		__m->m_data = __m->m_ext.ext_buf + 2;			\
    320 									\
    321 		__rra->rra_ptr1 =					\
    322 		    __ds->ds_dmamap->dm_segs[0].ds_addr >> 16;		\
    323 		__rra->rra_ptr0 =					\
    324 		    (__ds->ds_dmamap->dm_segs[0].ds_addr + 2) & 0xffff;	\
    325 		__rra->rra_wc1 = 0;					\
    326 		__rra->rra_wc0 = (ETHER_MAX_LEN + 2) / 2;		\
    327 									\
    328 		__rda->rda_link =					\
    329 		    (SONIC_CDRXADDR16((sc), SONIC_NEXTRX((x))) & 0xffff) |\
    330 		    RDA_LINK_EOL;					\
    331 		__rda->rda_inuse = 1;					\
    332 									\
    333 		__prda->rda_link = SONIC_CDRXADDR16((sc), (x));		\
    334 									\
    335 		SONIC_CDRRSYNC16((sc), (x), BUS_DMASYNC_PREWRITE);	\
    336 		SONIC_CDRXSYNC16((sc), (x),				\
    337 		    BUS_DMASYNC_PREREAD|BUS_DMASYNC_PREWRITE);		\
    338 		SONIC_CDRXSYNC16((sc), SONIC_PREVRX(x),			\
    339 		    BUS_DMASYNC_PREREAD|BUS_DMASYNC_PREWRITE);		\
    340 	}								\
    341 } while (/*CONSTCOND*/0)
    342 
    343 static __inline uint16_t __attribute__((__unused__))
    344 htosonic16(struct sonic_softc *sc, uint16_t val)
    345 {
    346 
    347 	if (sc->sc_bigendian)
    348 		return (htobe16(val));
    349 	return (htole16(val));
    350 }
    351 
    352 static __inline uint16_t __attribute__((__unused__))
    353 sonic16toh(struct sonic_softc *sc, uint16_t val)
    354 {
    355 
    356 	if (sc->sc_bigendian)
    357 		return (be16toh(val));
    358 	return (le16toh(val));
    359 }
    360 
    361 static __inline uint32_t __attribute__((__unused__))
    362 htosonic32(struct sonic_softc *sc, uint32_t val)
    363 {
    364 
    365 	if (sc->sc_bigendian)
    366 		return (htobe32(val));
    367 	return (htole32(val));
    368 }
    369 
    370 static __inline uint32_t __attribute__((__unused__))
    371 sonic32toh(struct sonic_softc *sc, uint32_t val)
    372 {
    373 
    374 	if (sc->sc_bigendian)
    375 		return (be32toh(val));
    376 	return (le32toh(val));
    377 }
    378 
    379 #ifdef _KERNEL
    380 void	sonic_attach(struct sonic_softc *, const uint8_t *);
    381 int	sonic_intr(void *);
    382 #endif /* _KERNEL */
    383 
    384 #endif /* _DEV_IC_DP83932VAR_H_ */
    385