1 /*-
2  * Copyright (c) 1998, 1999 Scott Mitchell
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24  * SUCH DAMAGE.
25  *
26  *	$Id: if_xe.c,v 1.20 1999/06/13 19:17:40 scott Exp $
27  * $FreeBSD: stable/9/sys/dev/xe/if_xevar.h 179551 2008-06-04 20:26:57Z jhb $
28  */
29 #ifndef DEV_XE_IF_XEDEV_H
30 #define DEV_XE_IF_XEDEV_H
31 
32 /*
33  * One of these structures per allocated device
34  */
35 struct xe_softc {
36 	struct ifmedia	ifmedia;
37 	struct ifmib_iso_8802_3 mibdata;
38 	struct callout	media_timer;
39 	struct callout	wdog_timer;
40 	int		tx_timeout;
41 	struct mtx	lock;
42 	struct ifnet	*ifp;
43 	struct ifmedia	*ifm;
44 	u_char		enaddr[ETHER_ADDR_LEN];
45 	const char	*card_type;	/* Card model name */
46 	const char	*vendor;	/* Card manufacturer */
47 	device_t	dev;		/* Device */
48 	void		*intrhand;
49 	struct resource	*irq_res;
50 	int		irq_rid;
51 	struct resource	*port_res;
52 	int		port_rid;
53 	struct resource	*ce2_port_res;
54 	int		ce2_port_rid;
55 	int		srev;     	/* Silicon revision */
56 	int		tx_queued;	/* Transmit packets currently waiting */
57 	int		tx_tpr;		/* Last value of TPR reg on card */
58 	int		tx_timeouts;	/* Count of transmit timeouts */
59 	uint16_t	tx_min;		/* Smallest packet for no padding */
60 	uint16_t	tx_thres;	/* Threshold bytes for early transmit */
61 	int		autoneg_status;	/* Autonegotiation progress state */
62 	int		media;		/* Private media word */
63 	u_char		version;	/* Bonding Version register from card */
64 	u_char		modem;		/* 1 = Card has a modem */
65 	u_char		ce2;		/* 1 = Card has CE2 silicon */
66 	u_char		mohawk;      	/* 1 = Card has Mohawk (CE3) silicon */
67 	u_char		dingo;    	/* 1 = Card has Dingo (CEM56) silicon */
68 	u_char		phy_ok;		/* 1 = MII-compliant PHY found */
69 	u_char		gone;		/* 1 = Card bailed out */
70 };
71 
72 #define	XE_LOCK(sc)		mtx_lock(&(sc)->lock)
73 #define	XE_UNLOCK(sc)		mtx_unlock(&(sc)->lock)
74 #define	XE_ASSERT_LOCKED(sc)	mtx_assert(&(sc)->lock, MA_OWNED)
75 
76 /*
77  * For accessing card registers
78  */
79 #define	XE_INB(r)		bus_read_1(scp->port_res, (r))
80 #define	XE_INW(r)		bus_read_2(scp->port_res, (r))
81 #define	XE_OUTB(r, b)		bus_write_1(scp->port_res, (r), (b))
82 #define	XE_OUTW(r, w)		bus_write_2(scp->port_res, (r), (w))
83 #define	XE_SELECT_PAGE(p)	XE_OUTB(XE_PR, (p))
84 
85 int	xe_attach(device_t dev);
86 int	xe_activate(device_t dev);
87 void	xe_deactivate(device_t dev);
88 void	xe_stop(struct xe_softc *scp);
89 
90 #endif /* DEV_XE_IF_XEVAR_H */
91