xref: /freebsd/sys/dev/usb/usb_pf.c (revision aa0a1e58f0189b0fde359a8bda032887e72057fa)
1 /*-
2  * Copyright (c) 1990, 1991, 1993
3  *	The Regents of the University of California.  All rights reserved.
4  *
5  * This code is derived from the Stanford/CMU enet packet filter,
6  * (net/enet.c) distributed as part of 4.3BSD, and code contributed
7  * to Berkeley by Steven McCanne and Van Jacobson both of Lawrence
8  * Berkeley Laboratory.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  * 4. Neither the name of the University nor the names of its 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 THE REGENTS 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 THE REGENTS OR CONTRIBUTORS BE LIABLE
26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32  * SUCH DAMAGE.
33  */
34 
35 #include <sys/cdefs.h>
36 __FBSDID("$FreeBSD$");
37 #include <sys/param.h>
38 #include <sys/kernel.h>
39 #include <sys/bus.h>
40 #include <sys/fcntl.h>
41 #include <sys/malloc.h>
42 #include <sys/proc.h>
43 #include <sys/socket.h>
44 #include <sys/sockio.h>
45 #include <net/if.h>
46 #include <net/if_types.h>
47 #include <net/bpf.h>
48 
49 #include <dev/usb/usb.h>
50 #include <dev/usb/usbdi.h>
51 #include <dev/usb/usb_busdma.h>
52 #include <dev/usb/usb_controller.h>
53 #include <dev/usb/usb_core.h>
54 #include <dev/usb/usb_process.h>
55 #include <dev/usb/usb_device.h>
56 #include <dev/usb/usb_bus.h>
57 #include <dev/usb/usb_pf.h>
58 #include <dev/usb/usb_transfer.h>
59 
60 void
61 usbpf_attach(struct usb_bus *ubus)
62 {
63 	struct ifnet *ifp;
64 
65 	ifp = ubus->ifp = if_alloc(IFT_USB);
66 	if_initname(ifp, "usbus", device_get_unit(ubus->bdev));
67 	ifp->if_flags = IFF_CANTCONFIG;
68 	if_attach(ifp);
69 	if_up(ifp);
70 
71 	KASSERT(sizeof(struct usbpf_pkthdr) == USBPF_HDR_LEN,
72 	    ("wrong USB pf header length (%zd)", sizeof(struct usbpf_pkthdr)));
73 
74 	/*
75 	 * XXX According to the specification of DLT_USB, it indicates packets
76 	 * beginning with USB setup header.  But not sure all packets would be.
77 	 */
78 	bpfattach(ifp, DLT_USB, USBPF_HDR_LEN);
79 
80 	if (bootverbose)
81 		device_printf(ubus->parent, "usbpf attached\n");
82 }
83 
84 void
85 usbpf_detach(struct usb_bus *ubus)
86 {
87 	struct ifnet *ifp = ubus->ifp;
88 
89 	if (ifp != NULL) {
90 		bpfdetach(ifp);
91 		if_down(ifp);
92 		if_detach(ifp);
93 		if_free(ifp);
94 	}
95 	ubus->ifp = NULL;
96 }
97 
98 static uint32_t
99 usbpf_aggregate_xferflags(struct usb_xfer_flags *flags)
100 {
101 	uint32_t val = 0;
102 
103 	if (flags->force_short_xfer == 1)
104 		val |= USBPF_FLAG_FORCE_SHORT_XFER;
105 	if (flags->short_xfer_ok == 1)
106 		val |= USBPF_FLAG_SHORT_XFER_OK;
107 	if (flags->short_frames_ok == 1)
108 		val |= USBPF_FLAG_SHORT_FRAMES_OK;
109 	if (flags->pipe_bof == 1)
110 		val |= USBPF_FLAG_PIPE_BOF;
111 	if (flags->proxy_buffer == 1)
112 		val |= USBPF_FLAG_PROXY_BUFFER;
113 	if (flags->ext_buffer == 1)
114 		val |= USBPF_FLAG_EXT_BUFFER;
115 	if (flags->manual_status == 1)
116 		val |= USBPF_FLAG_MANUAL_STATUS;
117 	if (flags->no_pipe_ok == 1)
118 		val |= USBPF_FLAG_NO_PIPE_OK;
119 	if (flags->stall_pipe == 1)
120 		val |= USBPF_FLAG_STALL_PIPE;
121 	return (val);
122 }
123 
124 static uint32_t
125 usbpf_aggregate_status(struct usb_xfer_flags_int *flags)
126 {
127 	uint32_t val = 0;
128 
129 	if (flags->open == 1)
130 		val |= USBPF_STATUS_OPEN;
131 	if (flags->transferring == 1)
132 		val |= USBPF_STATUS_TRANSFERRING;
133 	if (flags->did_dma_delay == 1)
134 		val |= USBPF_STATUS_DID_DMA_DELAY;
135 	if (flags->did_close == 1)
136 		val |= USBPF_STATUS_DID_CLOSE;
137 	if (flags->draining == 1)
138 		val |= USBPF_STATUS_DRAINING;
139 	if (flags->started == 1)
140 		val |= USBPF_STATUS_STARTED;
141 	if (flags->bandwidth_reclaimed == 1)
142 		val |= USBPF_STATUS_BW_RECLAIMED;
143 	if (flags->control_xfr == 1)
144 		val |= USBPF_STATUS_CONTROL_XFR;
145 	if (flags->control_hdr == 1)
146 		val |= USBPF_STATUS_CONTROL_HDR;
147 	if (flags->control_act == 1)
148 		val |= USBPF_STATUS_CONTROL_ACT;
149 	if (flags->control_stall == 1)
150 		val |= USBPF_STATUS_CONTROL_STALL;
151 	if (flags->short_frames_ok == 1)
152 		val |= USBPF_STATUS_SHORT_FRAMES_OK;
153 	if (flags->short_xfer_ok == 1)
154 		val |= USBPF_STATUS_SHORT_XFER_OK;
155 #if USB_HAVE_BUSDMA
156 	if (flags->bdma_enable == 1)
157 		val |= USBPF_STATUS_BDMA_ENABLE;
158 	if (flags->bdma_no_post_sync == 1)
159 		val |= USBPF_STATUS_BDMA_NO_POST_SYNC;
160 	if (flags->bdma_setup == 1)
161 		val |= USBPF_STATUS_BDMA_SETUP;
162 #endif
163 	if (flags->isochronous_xfr == 1)
164 		val |= USBPF_STATUS_ISOCHRONOUS_XFR;
165 	if (flags->curr_dma_set == 1)
166 		val |= USBPF_STATUS_CURR_DMA_SET;
167 	if (flags->can_cancel_immed == 1)
168 		val |= USBPF_STATUS_CAN_CANCEL_IMMED;
169 	if (flags->doing_callback == 1)
170 		val |= USBPF_STATUS_DOING_CALLBACK;
171 
172 	return (val);
173 }
174 
175 void
176 usbpf_xfertap(struct usb_xfer *xfer, int type)
177 {
178 	struct usb_endpoint *ep = xfer->endpoint;
179 	struct usb_page_search res;
180 	struct usb_xfer_root *info = xfer->xroot;
181 	struct usb_bus *bus = info->bus;
182 	struct usbpf_pkthdr *up;
183 	usb_frlength_t isoc_offset = 0;
184 	int i;
185 	char *buf, *ptr, *end;
186 
187 	if (!bpf_peers_present(bus->ifp->if_bpf))
188 		return;
189 
190 	/*
191 	 * XXX TODO
192 	 * Allocating the buffer here causes copy operations twice what's
193 	 * really inefficient. Copying usbpf_pkthdr and data is for USB packet
194 	 * read filter to pass a virtually linear buffer.
195 	 */
196 	buf = ptr = malloc(sizeof(struct usbpf_pkthdr) + (USB_PAGE_SIZE * 5),
197 	    M_TEMP, M_NOWAIT);
198 	if (buf == NULL) {
199 		printf("usbpf_xfertap: out of memory\n");	/* XXX */
200 		return;
201 	}
202 	end = buf + sizeof(struct usbpf_pkthdr) + (USB_PAGE_SIZE * 5);
203 
204 	bzero(ptr, sizeof(struct usbpf_pkthdr));
205 	up = (struct usbpf_pkthdr *)ptr;
206 	up->up_busunit = htole32(device_get_unit(bus->bdev));
207 	up->up_type = type;
208 	up->up_xfertype = ep->edesc->bmAttributes & UE_XFERTYPE;
209 	up->up_address = xfer->address;
210 	up->up_endpoint = xfer->endpointno;
211 	up->up_flags = htole32(usbpf_aggregate_xferflags(&xfer->flags));
212 	up->up_status = htole32(usbpf_aggregate_status(&xfer->flags_int));
213 	switch (type) {
214 	case USBPF_XFERTAP_SUBMIT:
215 		up->up_length = htole32(xfer->sumlen);
216 		up->up_frames = htole32(xfer->nframes);
217 		break;
218 	case USBPF_XFERTAP_DONE:
219 		up->up_length = htole32(xfer->actlen);
220 		up->up_frames = htole32(xfer->aframes);
221 		break;
222 	default:
223 		panic("wrong usbpf type (%d)", type);
224 	}
225 
226 	up->up_error = htole32(xfer->error);
227 	up->up_interval = htole32(xfer->interval);
228 	ptr += sizeof(struct usbpf_pkthdr);
229 
230 	for (i = 0; i < up->up_frames; i++) {
231 		if (ptr + sizeof(uint32_t) >= end)
232 			goto done;
233 		*((uint32_t *)ptr) = htole32(xfer->frlengths[i]);
234 		ptr += sizeof(uint32_t);
235 
236 		if (ptr + xfer->frlengths[i] >= end)
237 			goto done;
238 		if (xfer->flags_int.isochronous_xfr == 1) {
239 			usbd_get_page(&xfer->frbuffers[0], isoc_offset, &res);
240 			isoc_offset += xfer->frlengths[i];
241 		} else
242 			usbd_get_page(&xfer->frbuffers[i], 0, &res);
243 		bcopy(res.buffer, ptr, xfer->frlengths[i]);
244 		ptr += xfer->frlengths[i];
245 	}
246 
247 	bpf_tap(bus->ifp->if_bpf, buf, ptr - buf);
248 done:
249 	free(buf, M_TEMP);
250 }
251