xref: /netbsd/sys/dev/usb/if_kuereg.h (revision 9bdecb50)
1 /*	$NetBSD: if_kuereg.h,v 1.24 2019/08/16 08:51:09 mrg Exp $	*/
2 
3 /*
4  * Copyright (c) 1997, 1998, 1999, 2000
5  *	Bill Paul <wpaul@ee.columbia.edu>.  All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  * 3. All advertising materials mentioning features or use of this software
16  *    must display the following acknowledgement:
17  *	This product includes software developed by Bill Paul.
18  * 4. Neither the name of the author nor the names of any co-contributors
19  *    may be used to endorse or promote products derived from this software
20  *    without specific prior written permission.
21  *
22  * THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND
23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25  * ARE DISCLAIMED.  IN NO EVENT SHALL Bill Paul OR THE VOICES IN HIS HEAD
26  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
27  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
28  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
29  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
30  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
31  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
32  * THE POSSIBILITY OF SUCH DAMAGE.
33  *
34  * $FreeBSD: src/sys/dev/usb/if_kuereg.h,v 1.2 2000/01/06 07:39:07 wpaul Exp $
35  */
36 
37 /*
38  * Definitions for the KLSI KL5KUSB101B USB to ethernet controller.
39  * The KLSI part is controlled via vendor control requests, the structure
40  * of which depend a bit on the firmware running on the internal
41  * microcontroller. The one exception is the 'send scan data' command,
42  * which is used to load the firmware.
43  */
44 
45 #include <sys/rndsource.h>
46 
47 #define KUE_CONFIG_NO		1
48 #define KUE_IFACE_IDX		0
49 
50 #define KUE_CMD_GET_ETHER_DESCRIPTOR		0x00
51 #define KUE_CMD_SET_MCAST_FILTERS		0x01
52 #define KUE_CMD_SET_PKT_FILTER			0x02
53 #define KUE_CMD_GET_ETHERSTATS			0x03
54 #define KUE_CMD_GET_GPIO			0x04
55 #define KUE_CMD_SET_GPIO			0x05
56 #define KUE_CMD_SET_MAC				0x06
57 #define KUE_CMD_GET_MAC				0x07
58 #define KUE_CMD_SET_URB_SIZE			0x08
59 #define KUE_CMD_SET_SOFS			0x09
60 #define KUE_CMD_SET_EVEN_PKTS			0x0A
61 #define KUE_CMD_SEND_SCAN			0xFF
62 
63 struct kue_ether_desc {
64 	uint8_t			kue_len;
65 	uint8_t			kue_rsvd0;
66 	uint8_t			kue_rsvd1;
67 	uint8_t			kue_macaddr[ETHER_ADDR_LEN];
68 	uint8_t			kue_etherstats[4];
69 	uint8_t			kue_maxseg[2];
70 	uint8_t			kue_mcastfilt[2];
71 	uint8_t			kue_rsvd2;
72 };
73 
74 #define KUE_ETHERSTATS(x)	\
75 	le32dec((x)->kue_desc.kue_etherstats)
76 #define KUE_MAXSEG(x)		\
77 	le16dec((x)->kue_desc.kue_maxseg)
78 #define KUE_MCFILTCNT(x)	\
79 	(le16dec((x)->kue_desc.kue_mcastfilt) & 0x7FFF)
80 
81 #define KUE_STAT_TX_OK			0x00000001
82 #define KUE_STAT_RX_OK			0x00000002
83 #define KUE_STAT_TX_ERR			0x00000004
84 #define KUE_STAT_RX_ERR			0x00000008
85 #define KUE_STAT_RX_NOBUF		0x00000010
86 #define KUE_STAT_TX_UCAST_BYTES		0x00000020
87 #define KUE_STAT_TX_UCAST_FRAMES	0x00000040
88 #define KUE_STAT_TX_MCAST_BYTES		0x00000080
89 #define KUE_STAT_TX_MCAST_FRAMES	0x00000100
90 #define KUE_STAT_TX_BCAST_BYTES		0x00000200
91 #define KUE_STAT_TX_BCAST_FRAMES	0x00000400
92 #define KUE_STAT_RX_UCAST_BYTES		0x00000800
93 #define KUE_STAT_RX_UCAST_FRAMES	0x00001000
94 #define KUE_STAT_RX_MCAST_BYTES		0x00002000
95 #define KUE_STAT_RX_MCAST_FRAMES	0x00004000
96 #define KUE_STAT_RX_BCAST_BYTES		0x00008000
97 #define KUE_STAT_RX_BCAST_FRAMES	0x00010000
98 #define KUE_STAT_RX_CRCERR		0x00020000
99 #define KUE_STAT_TX_QUEUE_LENGTH	0x00040000
100 #define KUE_STAT_RX_ALIGNERR		0x00080000
101 #define KUE_STAT_TX_SINGLECOLL		0x00100000
102 #define KUE_STAT_TX_MULTICOLL		0x00200000
103 #define KUE_STAT_TX_DEFERRED		0x00400000
104 #define KUE_STAT_TX_MAXCOLLS		0x00800000
105 #define KUE_STAT_RX_OVERRUN		0x01000000
106 #define KUE_STAT_TX_UNDERRUN		0x02000000
107 #define KUE_STAT_TX_SQE_ERR		0x04000000
108 #define KUE_STAT_TX_CARRLOSS		0x08000000
109 #define KUE_STAT_RX_LATECOLL		0x10000000
110 
111 #define KUE_RXFILT_PROMISC		0x0001
112 #define KUE_RXFILT_ALLMULTI		0x0002
113 #define KUE_RXFILT_UNICAST		0x0004
114 #define KUE_RXFILT_BROADCAST		0x0008
115 #define KUE_RXFILT_MULTICAST		0x0010
116 
117 #define KUE_CTL_READ		0x01
118 #define KUE_CTL_WRITE		0x02
119 
120 #define KUE_WARM_REV		0x0202
121