xref: /netbsd-src/sys/dev/usb/ugensa.c (revision 8b0f9554ff8762542c4defc4f70e1eb76fb508fa)
1 /*	$NetBSD: ugensa.c,v 1.13 2007/12/11 12:36:02 lukem Exp $	*/
2 
3 /*
4  * Copyright (c) 2004, 2005 The NetBSD Foundation, Inc.
5  * All rights reserved.
6  *
7  * This code is derived from software contributed to The NetBSD Foundation
8  * by Roland C. Dowdeswell <elric@netbsd.org>.
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  * 3. All advertising materials mentioning features or use of this software
19  *    must display the following acknowledgement:
20  *        This product includes software developed by the NetBSD
21  *        Foundation, Inc. and its contributors.
22  * 4. Neither the name of The NetBSD Foundation nor the names of its
23  *    contributors may be used to endorse or promote products derived
24  *    from this software without specific prior written permission.
25  *
26  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
27  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
28  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
29  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
30  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
31  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
32  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
33  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
34  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
35  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
36  * POSSIBILITY OF SUCH DAMAGE.
37  */
38 
39 #include <sys/cdefs.h>
40 __KERNEL_RCSID(0, "$NetBSD: ugensa.c,v 1.13 2007/12/11 12:36:02 lukem Exp $");
41 
42 #include <sys/param.h>
43 #include <sys/systm.h>
44 #include <sys/kernel.h>
45 #include <sys/device.h>
46 #include <sys/conf.h>
47 #include <sys/tty.h>
48 
49 #include <dev/usb/usb.h>
50 
51 #include <dev/usb/usbdi.h>
52 #include <dev/usb/usbdi_util.h>
53 #include <dev/usb/usbdevs.h>
54 
55 #include <dev/usb/ucomvar.h>
56 
57 /* XXXrcd: heh */
58 #define UGENSA_DEBUG 1
59 
60 #ifdef UGENSA_DEBUG
61 #define DPRINTF(x)	if (ugensadebug) printf x
62 #define DPRINTFN(n,x)	if (ugensadebug>(n)) printf x
63 int ugensadebug = 0;
64 #else
65 #define DPRINTF(x)
66 #define DPRINTFN(n,x)
67 #endif
68 
69 struct ugensa_softc {
70 	USBBASEDEVICE		sc_dev;		/* base device */
71 	usbd_device_handle	sc_udev;	/* device */
72 	usbd_interface_handle	sc_iface;	/* interface */
73 
74 	device_ptr_t		sc_subdev;
75 	int			sc_numcon;
76 
77 	u_char			sc_dying;
78 };
79 
80 struct ucom_methods ugensa_methods = {
81 	NULL,
82 	NULL,
83 	NULL,
84 	NULL,
85 	NULL,
86 	NULL,
87 	NULL,
88 	NULL,
89 };
90 
91 #define UGENSA_CONFIG_INDEX	0
92 #define UGENSA_IFACE_INDEX	0
93 #define UGENSA_BUFSIZE		1024
94 
95 static const struct usb_devno ugensa_devs[] = {
96 	{ USB_VENDOR_AIRPRIME, USB_PRODUCT_AIRPRIME_PC5220 },
97 	{ USB_VENDOR_NOVATEL, USB_PRODUCT_NOVATEL_FLEXPACKGPS },
98 	{ USB_VENDOR_QUALCOMM_K, USB_PRODUCT_QUALCOMM_K_CDMA_MSM_K },
99 	{ USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_AIRCARD580 },
100 	{ USB_VENDOR_NOVATEL2, USB_PRODUCT_NOVATEL2_CDMA_MODEM },
101 	{ USB_VENDOR_DELL, USB_PRODUCT_DELL_HSDPA }
102 };
103 #define ugensa_lookup(v, p) usb_lookup(ugensa_devs, v, p)
104 
105 USB_DECLARE_DRIVER(ugensa);
106 
107 USB_MATCH(ugensa)
108 {
109 	USB_MATCH_START(ugensa, uaa);
110 
111 	DPRINTFN(20,("ugensa: vendor=0x%x, product=0x%x\n",
112 		     uaa->vendor, uaa->product));
113 
114 	return (ugensa_lookup(uaa->vendor, uaa->product) != NULL ?
115 		UMATCH_VENDOR_PRODUCT : UMATCH_NONE);
116 }
117 
118 USB_ATTACH(ugensa)
119 {
120 	USB_ATTACH_START(ugensa, sc, uaa);
121 	usbd_device_handle dev = uaa->device;
122 	usbd_interface_handle iface;
123 	usb_interface_descriptor_t *id;
124 	usb_endpoint_descriptor_t *ed;
125 	char *devinfop;
126 	char *devname = USBDEVNAME(sc->sc_dev);
127 	usbd_status err;
128 	struct ucom_attach_args uca;
129 	int i;
130 
131 	DPRINTFN(10,("\nugensa_attach: sc=%p\n", sc));
132 
133 	/* Move the device into the configured state. */
134 	err = usbd_set_config_index(dev, UGENSA_CONFIG_INDEX, 1);
135 	if (err) {
136 		printf("\n%s: failed to set configuration, err=%s\n",
137 		       devname, usbd_errstr(err));
138 		goto bad;
139 	}
140 
141 	err = usbd_device2interface_handle(dev, UGENSA_IFACE_INDEX, &iface);
142 	if (err) {
143 		printf("\n%s: failed to get interface, err=%s\n",
144 		       devname, usbd_errstr(err));
145 		goto bad;
146 	}
147 
148 	devinfop = usbd_devinfo_alloc(dev, 0);
149 	USB_ATTACH_SETUP;
150 	printf("%s: %s\n", devname, devinfop);
151 	usbd_devinfo_free(devinfop);
152 
153 	id = usbd_get_interface_descriptor(iface);
154 
155 	sc->sc_udev = dev;
156 	sc->sc_iface = iface;
157 
158 	uca.info = "Generic Serial Device";
159 	uca.ibufsize = UGENSA_BUFSIZE;
160 	uca.obufsize = UGENSA_BUFSIZE;
161 	uca.ibufsizepad = UGENSA_BUFSIZE;
162 	uca.portno = UCOM_UNK_PORTNO;
163 	uca.opkthdrlen = 0;
164 	uca.device = dev;
165 	uca.iface = iface;
166 	uca.methods = &ugensa_methods;
167 	uca.arg = sc;
168 
169 	usbd_add_drv_event(USB_EVENT_DRIVER_ATTACH, sc->sc_udev,
170 			   USBDEV(sc->sc_dev));
171 
172 	uca.bulkin = uca.bulkout = -1;
173 	for (i = 0; i < id->bNumEndpoints; i++) {
174 		int addr, dir, attr;
175 
176 		ed = usbd_interface2endpoint_descriptor(iface, i);
177 		if (ed == NULL) {
178 			printf("%s: could not read endpoint descriptor"
179 			       ": %s\n", devname, usbd_errstr(err));
180 			goto bad;
181 		}
182 
183 		addr = ed->bEndpointAddress;
184 		dir = UE_GET_DIR(ed->bEndpointAddress);
185 		attr = ed->bmAttributes & UE_XFERTYPE;
186 		if (dir == UE_DIR_IN && attr == UE_BULK)
187 			uca.bulkin = addr;
188 		else if (dir == UE_DIR_OUT && attr == UE_BULK)
189 			uca.bulkout = addr;
190 		else
191 			printf("%s: unexpected endpoint\n", devname);
192 	}
193 	if (uca.bulkin == -1) {
194 		printf("%s: Could not find data bulk in\n",
195 		       USBDEVNAME(sc->sc_dev));
196 		goto bad;
197 	}
198 	if (uca.bulkout == -1) {
199 		printf("%s: Could not find data bulk out\n",
200 		       USBDEVNAME(sc->sc_dev));
201 		goto bad;
202 	}
203 
204 	DPRINTF(("ugensa: in=0x%x out=0x%x\n", uca.bulkin, uca.bulkout));
205 	sc->sc_subdev = config_found_sm_loc(self, "ucombus", NULL, &uca,
206 					    ucomprint, ucomsubmatch);
207 
208 	USB_ATTACH_SUCCESS_RETURN;
209 
210 bad:
211 	DPRINTF(("ugensa_attach: ATTACH ERROR\n"));
212 	sc->sc_dying = 1;
213 	USB_ATTACH_ERROR_RETURN;
214 }
215 
216 int
217 ugensa_activate(device_ptr_t self, enum devact act)
218 {
219 	struct ugensa_softc *sc = (struct ugensa_softc *)self;
220 	int rv = 0;
221 
222 	switch (act) {
223 	case DVACT_ACTIVATE:
224 		return (EOPNOTSUPP);
225 		break;
226 
227 	case DVACT_DEACTIVATE:
228 		sc->sc_dying = 1;
229 		if (sc->sc_subdev)
230 			rv = config_deactivate(sc->sc_subdev);
231 		break;
232 	}
233 	return (rv);
234 }
235 
236 USB_DETACH(ugensa)
237 {
238 	USB_DETACH_START(ugensa, sc);
239 	int rv = 0;
240 
241 	DPRINTF(("ugensa_detach: sc=%p flags=%d\n", sc, flags));
242 
243 	sc->sc_dying = 1;
244 
245 	if (sc->sc_subdev != NULL)
246 		rv = config_detach(sc->sc_subdev, flags);
247 
248 	usbd_add_drv_event(USB_EVENT_DRIVER_DETACH, sc->sc_udev,
249 			   USBDEV(sc->sc_dev));
250 
251 	return (rv);
252 }
253