xref: /netbsd/sys/arch/next68k/dev/mb8795var.h (revision 5d64eb7f)
1 /*	$NetBSD: mb8795var.h,v 1.16 2023/02/03 23:04:35 tsutsui Exp $	*/
2 /*
3  * Copyright (c) 1998 Darrin B. Jewell
4  * All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
16  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
19  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25  */
26 
27 #include <sys/rndsource.h>
28 
29 #define MB8795_NRXBUFS (32)
30 
31 struct mb8795_softc;
32 
33 /*
34  * Function switch used as glue to MD code.
35  */
36 struct mb8795_glue {
37 	/* Mandatory entry points. */
38 	u_char	(*gl_read_reg)(struct mb8795_softc *, int);
39 	void	(*gl_write_reg)(struct mb8795_softc *, int, u_char);
40 	void	(*gl_dma_reset)(struct mb8795_softc *);
41 	void	(*gl_dma_rx_setup)(struct mb8795_softc *);
42 	void	(*gl_dma_rx_go)(struct mb8795_softc *);
43 	struct mbuf *	(*gl_dma_rx_mbuf)(struct mb8795_softc *);
44 	void	(*gl_dma_tx_setup)(struct mb8795_softc *);
45 	void	(*gl_dma_tx_go)(struct mb8795_softc *);
46 	int	(*gl_dma_tx_mbuf)(struct mb8795_softc *, struct mbuf *);
47 	int	(*gl_dma_tx_isactive)(struct mb8795_softc *);
48 	/* Optional entry points. */
49 };
50 
51 struct mb8795_softc {
52 	device_t		sc_dev;		/* base device glue */
53 	struct ethercom		sc_ethercom;	/* Ethernet common part */
54 
55 	struct	mb8795_glue 	*sc_glue;	/* glue to MD code */
56 
57 	void	*sc_sh;		/* shutdownhook cookie */
58 
59 	int sc_debug;
60 
61 	bus_space_tag_t sc_bmap_bst;    /* bus space tag */
62 
63 	bus_space_handle_t sc_bmap_bsh; /* bus space handle */
64 
65 	uint8_t sc_enaddr[6];
66 
67 	struct ifaltq sc_tx_snd;
68 
69 	struct ifmedia sc_media;
70 
71 	krndsource_t     rnd_source;
72 
73 };
74 
75 /*
76  * Macros to read and write the chip's registers.
77  */
78 #define	MB_READ_REG(sc, reg)		\
79 	(*(sc)->sc_glue->gl_read_reg)((sc), (reg))
80 #define	MB_WRITE_REG(sc, reg, val)	\
81 	(*(sc)->sc_glue->gl_write_reg)((sc), (reg), (val))
82 
83 /*
84  * DMA macros for mb8795
85  */
86 #define	MBDMA_RESET(sc)	(*(sc)->sc_glue->gl_dma_reset)((sc))
87 #define	MBDMA_SETUP(sc, addr, len, datain, dmasize)	\
88      (*(sc)->sc_glue->gl_dma_setup)((sc), (addr), (len), (datain), (dmasize))
89 #define	MBDMA_GO(sc)		(*(sc)->sc_glue->gl_dma_go)((sc))
90 #define	MBDMA_ISACTIVE(sc)	(*(sc)->sc_glue->gl_dma_isactive)((sc))
91 #define MBDMA_RX_SETUP(sc)	(*(sc)->sc_glue->gl_dma_rx_setup) ((sc))
92 #define MBDMA_RX_GO(sc)		(*(sc)->sc_glue->gl_dma_rx_go) ((sc))
93 #define MBDMA_RX_MBUF(sc)	(*(sc)->sc_glue->gl_dma_rx_mbuf) ((sc))
94 #define MBDMA_TX_SETUP(sc)	(*(sc)->sc_glue->gl_dma_tx_setup) ((sc))
95 #define MBDMA_TX_GO(sc)		(*(sc)->sc_glue->gl_dma_tx_go) ((sc))
96 #define MBDMA_TX_MBUF(sc,m)	(*(sc)->sc_glue->gl_dma_tx_mbuf) ((sc), (m))
97 #define	MBDMA_TX_ISACTIVE(sc)	(*(sc)->sc_glue->gl_dma_tx_isactive)((sc))
98 
99 void mb8795_config(struct mb8795_softc *, int *, int, int);
100 void mb8795_init(struct mb8795_softc *);
101 int mb8795_ioctl(struct ifnet *, u_long, void *);
102 void mb8795_reset(struct mb8795_softc *);
103 void mb8795_start(struct ifnet *);
104 void mb8795_stop(struct mb8795_softc *);
105 void mb8795_watchdog(struct ifnet *);
106 
107 void mb8795_rint(struct mb8795_softc *);
108 void mb8795_tint(struct mb8795_softc *);
109