1 /*	$NetBSD: dp8390var.h,v 1.33 2015/04/13 16:33:24 riastradh Exp $	*/
2 
3 /*
4  * Device driver for National Semiconductor DS8390/WD83C690 based ethernet
5  * adapters.
6  *
7  * Copyright (c) 1994, 1995 Charles M. Hannum.  All rights reserved.
8  *
9  * Copyright (C) 1993, David Greenman.  This software may be used, modified,
10  * copied, distributed, and sold, in both source and binary form provided that
11  * the above copyright and these terms are retained.  Under no circumstances is
12  * the author responsible for the proper functioning of this software, nor does
13  * the author assume any responsibility for damages incurred with its use.
14  */
15 
16 #include <sys/rndsource.h>
17 
18 /*
19  * We include MII glue here -- some DP8390 compatible chips have
20  * MII interfaces on them (scary, isn't it...).
21  */
22 #include <dev/mii/miivar.h>
23 
24 #define INTERFACE_NAME_LEN	32
25 
26 /*
27  * dp8390_softc: per line info and status
28  */
29 struct dp8390_softc {
30 	device_t	sc_dev;
31 	void	*sc_ih;
32 	int	sc_flags;		/* interface flags, from config */
33 
34 	struct ethercom sc_ec;		/* ethernet common */
35 	struct mii_data sc_mii;		/* MII glue */
36 #define	sc_media sc_mii.mii_media	/* compatibilty definition */
37 
38 	bus_space_tag_t	sc_regt;	/* NIC register space tag */
39 	bus_space_handle_t sc_regh;	/* NIC register space handle */
40 	bus_space_tag_t	sc_buft;	/* Buffer space tag */
41 	bus_space_handle_t sc_bufh;	/* Buffer space handle */
42 
43 	bus_size_t sc_reg_map[16];	/* register map (offsets) */
44 
45 	int	is790;		/* NIC is a 790 */
46 
47 	u_int8_t cr_proto;	/* values always set in CR */
48 	u_int8_t rcr_proto;	/* values always set in RCR */
49 	u_int8_t dcr_reg;	/* override DCR iff LS is set */
50 
51 	int	mem_start;	/* offset of NIC memory */
52 	int	mem_end;	/* offset of NIC memory end */
53 	int	mem_size;	/* total shared memory size */
54 	int	mem_ring;	/* offset of start of RX ring-buffer */
55 
56 	u_short	txb_cnt;	/* Number of transmit buffers */
57 	u_short	txb_inuse;	/* number of transmit buffers active */
58 
59 	u_short	txb_new;	/* pointer to where new buffer will be added */
60 	u_short	txb_next_tx;	/* pointer to next buffer ready to xmit */
61 	u_short	txb_len[8];	/* buffered xmit buffer lengths */
62 	u_short	tx_page_start;	/* first page of TX buffer area */
63 	u_short	rec_page_start; /* first page of RX ring-buffer */
64 	u_short	rec_page_stop;	/* last page of RX ring-buffer */
65 	u_short	next_packet;	/* pointer to next unread RX packet */
66 
67 	u_int8_t sc_enaddr[ETHER_ADDR_LEN];	/* storage for MAC address */
68 
69 	int	sc_enabled;	/* boolean; power enabled on interface */
70 
71 	krndsource_t rnd_source; /* random source */
72 
73 	int	(*test_mem)(struct dp8390_softc *);
74 	void	(*init_card)(struct dp8390_softc *);
75 	void	(*stop_card)(struct dp8390_softc *);
76 	void	(*read_hdr)(struct dp8390_softc *, int, struct dp8390_ring *);
77 	void	(*recv_int)(struct dp8390_softc *);
78 	int	(*ring_copy)(struct dp8390_softc *, int, void *, u_short);
79 	int	(*write_mbuf)(struct dp8390_softc *, struct mbuf *, int);
80 
81 	int	(*sc_enable)(struct dp8390_softc *);
82 	void	(*sc_disable)(struct dp8390_softc *);
83 
84 	void	(*sc_media_init)(struct dp8390_softc *);
85 	void	(*sc_media_fini)(struct dp8390_softc *);
86 
87 	int	(*sc_mediachange)(struct dp8390_softc *);
88 	void	(*sc_mediastatus)(struct dp8390_softc *, struct ifmediareq *);
89 };
90 
91 /*
92  * Vendor types
93  */
94 #define DP8390_VENDOR_UNKNOWN	0xff	/* Unknown network card */
95 #define DP8390_VENDOR_WD_SMC	0x00	/* Western Digital/SMC */
96 #define DP8390_VENDOR_3COM	0x01	/* 3Com */
97 #define DP8390_VENDOR_NOVELL	0x02	/* Novell */
98 #define DP8390_VENDOR_APPLE	0x10	/* Apple Ethernet card */
99 #define DP8390_VENDOR_INTERLAN	0x11	/* Interlan A310 card (GatorCard) */
100 #define DP8390_VENDOR_DAYNA	0x12	/* DaynaPORT E/30s (and others?) */
101 #define DP8390_VENDOR_ASANTE	0x13	/* Asante MacCon II/E */
102 #define DP8390_VENDOR_FARALLON	0x14	/* Farallon EtherMac II-TP */
103 #define DP8390_VENDOR_FOCUS	0x15	/* FOCUS Enhancements EtherLAN */
104 #define DP8390_VENDOR_KINETICS	0x16	/* Kinetics EtherPort SE/30 */
105 #define DP8390_VENDOR_CABLETRON	0x17	/* Cabletron Ethernet */
106 
107 /*
108  * Compile-time config flags
109  */
110 /*
111  * This sets the default for enabling/disabling the tranceiver.
112  */
113 #define DP8390_DISABLE_TRANCEIVER	0x0001
114 
115 /*
116  * This forces the board to be used in 8/16-bit mode even if it autoconfigs
117  * differently.
118  */
119 #define DP8390_FORCE_8BIT_MODE		0x0002
120 #define DP8390_FORCE_16BIT_MODE		0x0004
121 
122 /*
123  * This disables the use of multiple transmit buffers.
124  */
125 #define DP8390_NO_MULTI_BUFFERING	0x0008
126 
127 /*
128  * This forces all operations with the NIC memory to use Programmed I/O (i.e.
129  * not via shared memory).
130  */
131 #define DP8390_FORCE_PIO		0x0010
132 
133 /*
134  * The chip is ASIX AX88190 and needs work around.
135  */
136 #define	DP8390_DO_AX88190_WORKAROUND	0x0020
137 
138 #define DP8390_ATTACHED			0x0040	/* attach has succeeded */
139 
140 /*
141  * ASIX AX88796 doesn't have remote DMA conmplete bit in ISR, so don't
142  * check ISR.RDC
143  */
144 #define DP8390_NO_REMOTE_DMA_COMPLETE	0x0080
145 
146 /*
147  * NIC register access macros
148  */
149 #define NIC_GET(t, h, reg)	bus_space_read_1(t, h,			\
150 				    ((sc)->sc_reg_map[reg]))
151 #define NIC_PUT(t, h, reg, val)	bus_space_write_1(t, h,			\
152 				    ((sc)->sc_reg_map[reg]), (val))
153 #define	NIC_BARRIER(t, h)	bus_space_barrier(t, h, 0, 0x10,	\
154 			    BUS_SPACE_BARRIER_READ | BUS_SPACE_BARRIER_WRITE)
155 
156 int	dp8390_config(struct dp8390_softc *);
157 int	dp8390_intr(void *);
158 int	dp8390_ioctl(struct ifnet *, u_long, void *);
159 void	dp8390_start(struct ifnet *);
160 void	dp8390_watchdog(struct ifnet *);
161 void	dp8390_reset(struct dp8390_softc *);
162 void	dp8390_init(struct dp8390_softc *);
163 void	dp8390_stop(struct dp8390_softc *);
164 
165 void	dp8390_rint(struct dp8390_softc *);
166 
167 void	dp8390_getmcaf(struct ethercom *, u_int8_t *);
168 struct mbuf *dp8390_get(struct dp8390_softc *, int, u_short);
169 void	dp8390_read(struct dp8390_softc *, int, u_short);
170 
171 int	dp8390_enable(struct dp8390_softc *);
172 void	dp8390_disable(struct dp8390_softc *);
173 
174 int	dp8390_activate(device_t, enum devact);
175 
176 int	dp8390_detach(struct dp8390_softc *, int);
177 
178 int	dp8390_mediachange(struct ifnet *);
179 void	dp8390_mediastatus(struct ifnet *, struct ifmediareq *);
180 
181 void	dp8390_media_init(struct dp8390_softc *);
182 
183 #ifdef IPKDB_DP8390
184 int	dp8390_ipkdb_attach(struct ipkdb_if *);
185 #endif
186