ugensa.c revision 292080 
1/* $FreeBSD: head/sys/dev/usb/serial/ugensa.c 292080 2015-12-11 05:28:00Z imp $ */
2/*	$NetBSD: ugensa.c,v 1.9.2.1 2007/03/24 14:55:50 yamt Exp $	*/
3
4/*
5 * Copyright (c) 2004, 2005 The NetBSD Foundation, Inc.
6 * All rights reserved.
7 *
8 * This code is derived from software contributed to The NetBSD Foundation
9 * by Roland C. Dowdeswell <elric@netbsd.org>.
10 *
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
13 * are met:
14 * 1. Redistributions of source code must retain the above copyright
15 *    notice, this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 *    notice, this list of conditions and the following disclaimer in the
18 *    documentation and/or other materials provided with the distribution.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
21 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
22 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
23 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
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 THE
30 * POSSIBILITY OF SUCH DAMAGE.
31 */
32
33/*
34 * NOTE: all function names beginning like "ugensa_cfg_" can only
35 * be called from within the config thread function !
36 */
37
38#include <sys/stdint.h>
39#include <sys/stddef.h>
40#include <sys/param.h>
41#include <sys/queue.h>
42#include <sys/types.h>
43#include <sys/systm.h>
44#include <sys/kernel.h>
45#include <sys/bus.h>
46#include <sys/module.h>
47#include <sys/lock.h>
48#include <sys/mutex.h>
49#include <sys/condvar.h>
50#include <sys/sysctl.h>
51#include <sys/sx.h>
52#include <sys/unistd.h>
53#include <sys/callout.h>
54#include <sys/malloc.h>
55#include <sys/priv.h>
56
57#include <dev/usb/usb.h>
58#include <dev/usb/usbdi.h>
59#include "usbdevs.h"
60
61#define	USB_DEBUG_VAR usb_debug
62#include <dev/usb/usb_debug.h>
63#include <dev/usb/usb_process.h>
64
65#include <dev/usb/serial/usb_serial.h>
66
67#define	UGENSA_BUF_SIZE		2048	/* bytes */
68#define	UGENSA_CONFIG_INDEX	0
69#define	UGENSA_IFACE_INDEX	0
70#define	UGENSA_IFACE_MAX	8	/* exclusivly */
71
72enum {
73	UGENSA_BULK_DT_WR,
74	UGENSA_BULK_DT_RD,
75	UGENSA_N_TRANSFER,
76};
77
78struct ugensa_sub_softc {
79	struct ucom_softc *sc_ucom_ptr;
80	struct usb_xfer *sc_xfer[UGENSA_N_TRANSFER];
81};
82
83struct ugensa_softc {
84	struct ucom_super_softc sc_super_ucom;
85	struct ucom_softc sc_ucom[UGENSA_IFACE_MAX];
86	struct ugensa_sub_softc sc_sub[UGENSA_IFACE_MAX];
87
88	struct mtx sc_mtx;
89	uint8_t	sc_niface;
90};
91
92/* prototypes */
93
94static device_probe_t ugensa_probe;
95static device_attach_t ugensa_attach;
96static device_detach_t ugensa_detach;
97static void ugensa_free_softc(struct ugensa_softc *);
98
99static usb_callback_t ugensa_bulk_write_callback;
100static usb_callback_t ugensa_bulk_read_callback;
101
102static void	ugensa_free(struct ucom_softc *);
103static void	ugensa_start_read(struct ucom_softc *);
104static void	ugensa_stop_read(struct ucom_softc *);
105static void	ugensa_start_write(struct ucom_softc *);
106static void	ugensa_stop_write(struct ucom_softc *);
107static void	ugensa_poll(struct ucom_softc *ucom);
108
109static const struct usb_config ugensa_xfer_config[UGENSA_N_TRANSFER] = {
110
111	[UGENSA_BULK_DT_WR] = {
112		.type = UE_BULK,
113		.endpoint = UE_ADDR_ANY,
114		.direction = UE_DIR_OUT,
115		.bufsize = UGENSA_BUF_SIZE,
116		.flags = {.pipe_bof = 1,.force_short_xfer = 1,},
117		.callback = &ugensa_bulk_write_callback,
118	},
119
120	[UGENSA_BULK_DT_RD] = {
121		.type = UE_BULK,
122		.endpoint = UE_ADDR_ANY,
123		.direction = UE_DIR_IN,
124		.bufsize = UGENSA_BUF_SIZE,
125		.flags = {.pipe_bof = 1,.short_xfer_ok = 1,},
126		.callback = &ugensa_bulk_read_callback,
127	},
128};
129
130static const struct ucom_callback ugensa_callback = {
131	.ucom_start_read = &ugensa_start_read,
132	.ucom_stop_read = &ugensa_stop_read,
133	.ucom_start_write = &ugensa_start_write,
134	.ucom_stop_write = &ugensa_stop_write,
135	.ucom_poll = &ugensa_poll,
136	.ucom_free = &ugensa_free,
137};
138
139static device_method_t ugensa_methods[] = {
140	/* Device methods */
141	DEVMETHOD(device_probe, ugensa_probe),
142	DEVMETHOD(device_attach, ugensa_attach),
143	DEVMETHOD(device_detach, ugensa_detach),
144	DEVMETHOD_END
145};
146
147static devclass_t ugensa_devclass;
148
149static driver_t ugensa_driver = {
150	.name = "ugensa",
151	.methods = ugensa_methods,
152	.size = sizeof(struct ugensa_softc),
153};
154
155static const STRUCT_USB_HOST_ID ugensa_devs[] = {
156	{USB_VPI(USB_VENDOR_AIRPRIME, USB_PRODUCT_AIRPRIME_PC5220, 0)},
157	{USB_VPI(USB_VENDOR_CMOTECH, USB_PRODUCT_CMOTECH_CDMA_MODEM1, 0)},
158	{USB_VPI(USB_VENDOR_KYOCERA2, USB_PRODUCT_KYOCERA2_CDMA_MSM_K, 0)},
159	{USB_VPI(USB_VENDOR_HP, USB_PRODUCT_HP_49GPLUS, 0)},
160	{USB_VPI(USB_VENDOR_NOVATEL2, USB_PRODUCT_NOVATEL2_FLEXPACKGPS, 0)},
161};
162
163DRIVER_MODULE(ugensa, uhub, ugensa_driver, ugensa_devclass, NULL, 0);
164MODULE_DEPEND(ugensa, ucom, 1, 1, 1);
165MODULE_DEPEND(ugensa, usb, 1, 1, 1);
166MODULE_VERSION(ugensa, 1);
167USB_PNP_HOST_INFO(ugensa_devs);
168
169static int
170ugensa_probe(device_t dev)
171{
172	struct usb_attach_arg *uaa = device_get_ivars(dev);
173
174	if (uaa->usb_mode != USB_MODE_HOST) {
175		return (ENXIO);
176	}
177	if (uaa->info.bConfigIndex != UGENSA_CONFIG_INDEX) {
178		return (ENXIO);
179	}
180	if (uaa->info.bIfaceIndex != 0) {
181		return (ENXIO);
182	}
183	return (usbd_lookup_id_by_uaa(ugensa_devs, sizeof(ugensa_devs), uaa));
184}
185
186static int
187ugensa_attach(device_t dev)
188{
189	struct usb_attach_arg *uaa = device_get_ivars(dev);
190	struct ugensa_softc *sc = device_get_softc(dev);
191	struct ugensa_sub_softc *ssc;
192	struct usb_interface *iface;
193	int32_t error;
194	uint8_t iface_index;
195	int x, cnt;
196
197	device_set_usb_desc(dev);
198	mtx_init(&sc->sc_mtx, "ugensa", NULL, MTX_DEF);
199	ucom_ref(&sc->sc_super_ucom);
200
201	/* Figure out how many interfaces this device has got */
202	for (cnt = 0; cnt < UGENSA_IFACE_MAX; cnt++) {
203		if ((usbd_get_endpoint(uaa->device, cnt, ugensa_xfer_config + 0) == NULL) ||
204		    (usbd_get_endpoint(uaa->device, cnt, ugensa_xfer_config + 1) == NULL)) {
205			/* we have reached the end */
206			break;
207		}
208	}
209
210	if (cnt == 0) {
211		device_printf(dev, "No interfaces\n");
212		goto detach;
213	}
214	for (x = 0; x < cnt; x++) {
215		iface = usbd_get_iface(uaa->device, x);
216		if (iface->idesc->bInterfaceClass != UICLASS_VENDOR)
217			/* Not a serial port, most likely a SD reader */
218			continue;
219
220		ssc = sc->sc_sub + sc->sc_niface;
221		ssc->sc_ucom_ptr = sc->sc_ucom + sc->sc_niface;
222
223		iface_index = (UGENSA_IFACE_INDEX + x);
224		error = usbd_transfer_setup(uaa->device,
225		    &iface_index, ssc->sc_xfer, ugensa_xfer_config,
226		    UGENSA_N_TRANSFER, ssc, &sc->sc_mtx);
227
228		if (error) {
229			device_printf(dev, "allocating USB "
230			    "transfers failed\n");
231			goto detach;
232		}
233		/* clear stall at first run */
234		mtx_lock(&sc->sc_mtx);
235		usbd_xfer_set_stall(ssc->sc_xfer[UGENSA_BULK_DT_WR]);
236		usbd_xfer_set_stall(ssc->sc_xfer[UGENSA_BULK_DT_RD]);
237		mtx_unlock(&sc->sc_mtx);
238
239		/* initialize port number */
240		ssc->sc_ucom_ptr->sc_portno = sc->sc_niface;
241		sc->sc_niface++;
242		if (x != uaa->info.bIfaceIndex)
243			usbd_set_parent_iface(uaa->device, x,
244			    uaa->info.bIfaceIndex);
245	}
246	device_printf(dev, "Found %d interfaces.\n", sc->sc_niface);
247
248	error = ucom_attach(&sc->sc_super_ucom, sc->sc_ucom, sc->sc_niface, sc,
249	    &ugensa_callback, &sc->sc_mtx);
250	if (error) {
251		DPRINTF("attach failed\n");
252		goto detach;
253	}
254	ucom_set_pnpinfo_usb(&sc->sc_super_ucom, dev);
255
256	return (0);			/* success */
257
258detach:
259	ugensa_detach(dev);
260	return (ENXIO);			/* failure */
261}
262
263static int
264ugensa_detach(device_t dev)
265{
266	struct ugensa_softc *sc = device_get_softc(dev);
267	uint8_t x;
268
269	ucom_detach(&sc->sc_super_ucom, sc->sc_ucom);
270
271	for (x = 0; x < sc->sc_niface; x++) {
272		usbd_transfer_unsetup(sc->sc_sub[x].sc_xfer, UGENSA_N_TRANSFER);
273	}
274
275	device_claim_softc(dev);
276
277	ugensa_free_softc(sc);
278
279	return (0);
280}
281
282UCOM_UNLOAD_DRAIN(ugensa);
283
284static void
285ugensa_free_softc(struct ugensa_softc *sc)
286{
287	if (ucom_unref(&sc->sc_super_ucom)) {
288		mtx_destroy(&sc->sc_mtx);
289		device_free_softc(sc);
290	}
291}
292
293static void
294ugensa_free(struct ucom_softc *ucom)
295{
296	ugensa_free_softc(ucom->sc_parent);
297}
298
299static void
300ugensa_bulk_write_callback(struct usb_xfer *xfer, usb_error_t error)
301{
302	struct ugensa_sub_softc *ssc = usbd_xfer_softc(xfer);
303	struct usb_page_cache *pc;
304	uint32_t actlen;
305
306	switch (USB_GET_STATE(xfer)) {
307	case USB_ST_SETUP:
308	case USB_ST_TRANSFERRED:
309tr_setup:
310		pc = usbd_xfer_get_frame(xfer, 0);
311		if (ucom_get_data(ssc->sc_ucom_ptr, pc, 0,
312		    UGENSA_BUF_SIZE, &actlen)) {
313			usbd_xfer_set_frame_len(xfer, 0, actlen);
314			usbd_transfer_submit(xfer);
315		}
316		return;
317
318	default:			/* Error */
319		if (error != USB_ERR_CANCELLED) {
320			/* try to clear stall first */
321			usbd_xfer_set_stall(xfer);
322			goto tr_setup;
323		}
324		return;
325	}
326}
327
328static void
329ugensa_bulk_read_callback(struct usb_xfer *xfer, usb_error_t error)
330{
331	struct ugensa_sub_softc *ssc = usbd_xfer_softc(xfer);
332	struct usb_page_cache *pc;
333	int actlen;
334
335	usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL);
336
337	switch (USB_GET_STATE(xfer)) {
338	case USB_ST_TRANSFERRED:
339		pc = usbd_xfer_get_frame(xfer, 0);
340		ucom_put_data(ssc->sc_ucom_ptr, pc, 0, actlen);
341
342	case USB_ST_SETUP:
343tr_setup:
344		usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer));
345		usbd_transfer_submit(xfer);
346		return;
347
348	default:			/* Error */
349		if (error != USB_ERR_CANCELLED) {
350			/* try to clear stall first */
351			usbd_xfer_set_stall(xfer);
352			goto tr_setup;
353		}
354		return;
355	}
356}
357
358static void
359ugensa_start_read(struct ucom_softc *ucom)
360{
361	struct ugensa_softc *sc = ucom->sc_parent;
362	struct ugensa_sub_softc *ssc = sc->sc_sub + ucom->sc_portno;
363
364	usbd_transfer_start(ssc->sc_xfer[UGENSA_BULK_DT_RD]);
365}
366
367static void
368ugensa_stop_read(struct ucom_softc *ucom)
369{
370	struct ugensa_softc *sc = ucom->sc_parent;
371	struct ugensa_sub_softc *ssc = sc->sc_sub + ucom->sc_portno;
372
373	usbd_transfer_stop(ssc->sc_xfer[UGENSA_BULK_DT_RD]);
374}
375
376static void
377ugensa_start_write(struct ucom_softc *ucom)
378{
379	struct ugensa_softc *sc = ucom->sc_parent;
380	struct ugensa_sub_softc *ssc = sc->sc_sub + ucom->sc_portno;
381
382	usbd_transfer_start(ssc->sc_xfer[UGENSA_BULK_DT_WR]);
383}
384
385static void
386ugensa_stop_write(struct ucom_softc *ucom)
387{
388	struct ugensa_softc *sc = ucom->sc_parent;
389	struct ugensa_sub_softc *ssc = sc->sc_sub + ucom->sc_portno;
390
391	usbd_transfer_stop(ssc->sc_xfer[UGENSA_BULK_DT_WR]);
392}
393
394static void
395ugensa_poll(struct ucom_softc *ucom)
396{
397	struct ugensa_softc *sc = ucom->sc_parent;
398	struct ugensa_sub_softc *ssc = sc->sc_sub + ucom->sc_portno;
399
400	usbd_transfer_poll(ssc->sc_xfer, UGENSA_N_TRANSFER);
401}
402