usb4bsd: Port aue(4), cue(4), ipheth(4) and kue(4) USB ethernet drivers.
[dragonfly.git] / sys / bus / u4b / net / if_kuereg.h
1 /*-
2  * Copyright (c) 1997, 1998, 1999, 2000
3  *      Bill Paul <wpaul@ee.columbia.edu>.  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  * 3. All advertising materials mentioning features or use of this software
14  *    must display the following acknowledgement:
15  *      This product includes software developed by Bill Paul.
16  * 4. Neither the name of the author nor the names of any co-contributors
17  *    may be used to endorse or promote products derived from this software
18  *    without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND
21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23  * ARE DISCLAIMED.  IN NO EVENT SHALL Bill Paul OR THE VOICES IN HIS HEAD
24  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
30  * THE POSSIBILITY OF SUCH DAMAGE.
31  *
32  * $FreeBSD: head/sys/dev/usb/net/if_kuereg.h 196219 2009-08-14 20:03:53Z jhb $
33  */
34
35 /*
36  * Definitions for the KLSI KL5KUSB101B USB to ethernet controller.
37  * The KLSI part is controlled via vendor control requests, the structure
38  * of which depend a bit on the firmware running on the internal
39  * microcontroller.  The one exception is the 'send scan data' command,
40  * which is used to load the firmware.
41  */
42
43 #define KUE_CMD_GET_ETHER_DESCRIPTOR            0x00
44 #define KUE_CMD_SET_MCAST_FILTERS               0x01
45 #define KUE_CMD_SET_PKT_FILTER                  0x02
46 #define KUE_CMD_GET_ETHERSTATS                  0x03
47 #define KUE_CMD_GET_GPIO                        0x04
48 #define KUE_CMD_SET_GPIO                        0x05
49 #define KUE_CMD_SET_MAC                         0x06
50 #define KUE_CMD_GET_MAC                         0x07
51 #define KUE_CMD_SET_URB_SIZE                    0x08
52 #define KUE_CMD_SET_SOFS                        0x09
53 #define KUE_CMD_SET_EVEN_PKTS                   0x0A
54 #define KUE_CMD_SEND_SCAN                       0xFF
55
56 struct kue_ether_desc {
57         uint8_t kue_len;
58         uint8_t kue_rsvd0;
59         uint8_t kue_rsvd1;
60         uint8_t kue_macaddr[ETHER_ADDR_LEN];
61         uint8_t kue_etherstats[4];
62         uint8_t kue_maxseg[2];
63         uint8_t kue_mcastfilt[2];
64         uint8_t kue_rsvd2;
65 } __packed;
66
67 #define KUE_ETHERSTATS(x)       UGETDW((x)->sc_desc.kue_etherstats)
68 #define KUE_MAXSEG(x)           UGETW((x)->sc_desc.kue_maxseg)
69 #define KUE_MCFILTCNT(x)        (UGETW((x)->sc_desc.kue_mcastfilt) & 0x7FFF)
70 #define KUE_MCFILT(x, y)        \
71         (char *)&(sc->sc_mcfilters[y * ETHER_ADDR_LEN])
72
73 #define KUE_STAT_TX_OK                  0x00000001
74 #define KUE_STAT_RX_OK                  0x00000002
75 #define KUE_STAT_TX_ERR                 0x00000004
76 #define KUE_STAT_RX_ERR                 0x00000008
77 #define KUE_STAT_RX_NOBUF               0x00000010
78 #define KUE_STAT_TX_UCAST_BYTES         0x00000020
79 #define KUE_STAT_TX_UCAST_FRAMES        0x00000040
80 #define KUE_STAT_TX_MCAST_BYTES         0x00000080
81 #define KUE_STAT_TX_MCAST_FRAMES        0x00000100
82 #define KUE_STAT_TX_BCAST_BYTES         0x00000200
83 #define KUE_STAT_TX_BCAST_FRAMES        0x00000400
84 #define KUE_STAT_RX_UCAST_BYTES         0x00000800
85 #define KUE_STAT_RX_UCAST_FRAMES        0x00001000
86 #define KUE_STAT_RX_MCAST_BYTES         0x00002000
87 #define KUE_STAT_RX_MCAST_FRAMES        0x00004000
88 #define KUE_STAT_RX_BCAST_BYTES         0x00008000
89 #define KUE_STAT_RX_BCAST_FRAMES        0x00010000
90 #define KUE_STAT_RX_CRCERR              0x00020000
91 #define KUE_STAT_TX_QUEUE_LENGTH        0x00040000
92 #define KUE_STAT_RX_ALIGNERR            0x00080000
93 #define KUE_STAT_TX_SINGLECOLL          0x00100000
94 #define KUE_STAT_TX_MULTICOLL           0x00200000
95 #define KUE_STAT_TX_DEFERRED            0x00400000
96 #define KUE_STAT_TX_MAXCOLLS            0x00800000
97 #define KUE_STAT_RX_OVERRUN             0x01000000
98 #define KUE_STAT_TX_UNDERRUN            0x02000000
99 #define KUE_STAT_TX_SQE_ERR             0x04000000
100 #define KUE_STAT_TX_CARRLOSS            0x08000000
101 #define KUE_STAT_RX_LATECOLL            0x10000000
102
103 #define KUE_RXFILT_PROMISC              0x0001
104 #define KUE_RXFILT_ALLMULTI             0x0002
105 #define KUE_RXFILT_UNICAST              0x0004
106 #define KUE_RXFILT_BROADCAST            0x0008
107 #define KUE_RXFILT_MULTICAST            0x0010
108
109 #define KUE_TIMEOUT             1000
110 #define KUE_MIN_FRAMELEN        60
111
112 #define KUE_CTL_READ            0x01
113 #define KUE_CTL_WRITE           0x02
114
115 #define KUE_CONFIG_IDX          0       /* config number 1 */
116 #define KUE_IFACE_IDX           0
117
118 /* The interrupt endpoint is currently unused by the KLSI part. */
119 #define KUE_ENDPT_MAX           4
120 enum {
121         KUE_BULK_DT_WR,
122         KUE_BULK_DT_RD,
123         KUE_N_TRANSFER,
124 };
125
126 struct kue_softc {
127         struct usb_ether        sc_ue;
128         struct lock             sc_lock;
129         struct kue_ether_desc   sc_desc;
130         struct usb_xfer *sc_xfer[KUE_N_TRANSFER];
131         uint8_t                 *sc_mcfilters;
132
133         int                     sc_flags;
134 #define KUE_FLAG_LINK           0x0001
135
136         uint16_t                sc_rxfilt;
137 };
138
139 #define KUE_LOCK(_sc)           lockmgr(&(_sc)->sc_lock, LK_EXCLUSIVE)
140 #define KUE_UNLOCK(_sc)         lockmgr(&(_sc)->sc_lock, LK_RELEASE)
141 #define KUE_LOCK_ASSERT(_sc)    KKASSERT(lockowned(&(_sc)->sc_lock))