xref: /netbsd-src/sys/dev/usb/ugensa.c (revision 7fa608457b817eca6e0977b37f758ae064f3c99c)
1 /*	$NetBSD: ugensa.c,v 1.11 2007/10/25 19:32:15 plunky 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/param.h>
40 #include <sys/systm.h>
41 #include <sys/kernel.h>
42 #include <sys/device.h>
43 #include <sys/conf.h>
44 #include <sys/tty.h>
45 
46 #include <dev/usb/usb.h>
47 
48 #include <dev/usb/usbdi.h>
49 #include <dev/usb/usbdi_util.h>
50 #include <dev/usb/usbdevs.h>
51 
52 #include <dev/usb/ucomvar.h>
53 
54 /* XXXrcd: heh */
55 #define UGENSA_DEBUG 1
56 
57 #ifdef UGENSA_DEBUG
58 #define DPRINTF(x)	if (ugensadebug) printf x
59 #define DPRINTFN(n,x)	if (ugensadebug>(n)) printf x
60 int ugensadebug = 0;
61 #else
62 #define DPRINTF(x)
63 #define DPRINTFN(n,x)
64 #endif
65 
66 struct ugensa_softc {
67 	USBBASEDEVICE		sc_dev;		/* base device */
68 	usbd_device_handle	sc_udev;	/* device */
69 	usbd_interface_handle	sc_iface;	/* interface */
70 
71 	device_ptr_t		sc_subdev;
72 	int			sc_numcon;
73 
74 	u_char			sc_dying;
75 };
76 
77 struct ucom_methods ugensa_methods = {
78 	NULL,
79 	NULL,
80 	NULL,
81 	NULL,
82 	NULL,
83 	NULL,
84 	NULL,
85 	NULL,
86 };
87 
88 #define UGENSA_CONFIG_INDEX	0
89 #define UGENSA_IFACE_INDEX	0
90 #define UGENSA_BUFSIZE		1024
91 
92 static const struct usb_devno ugensa_devs[] = {
93 	{ USB_VENDOR_AIRPRIME, USB_PRODUCT_AIRPRIME_PC5220 },
94 	{ USB_VENDOR_NOVATEL, USB_PRODUCT_NOVATEL_FLEXPACKGPS },
95 	{ USB_VENDOR_QUALCOMM_K, USB_PRODUCT_QUALCOMM_K_CDMA_MSM_K },
96 	{ USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_AIRCARD580 },
97 	{ USB_VENDOR_NOVATEL2, USB_PRODUCT_NOVATEL2_CDMA_MODEM },
98 };
99 #define ugensa_lookup(v, p) usb_lookup(ugensa_devs, v, p)
100 
101 USB_DECLARE_DRIVER(ugensa);
102 
103 USB_MATCH(ugensa)
104 {
105 	USB_MATCH_START(ugensa, uaa);
106 
107 	DPRINTFN(20,("ugensa: vendor=0x%x, product=0x%x\n",
108 		     uaa->vendor, uaa->product));
109 
110 	return (ugensa_lookup(uaa->vendor, uaa->product) != NULL ?
111 		UMATCH_VENDOR_PRODUCT : UMATCH_NONE);
112 }
113 
114 USB_ATTACH(ugensa)
115 {
116 	USB_ATTACH_START(ugensa, sc, uaa);
117 	usbd_device_handle dev = uaa->device;
118 	usbd_interface_handle iface;
119 	usb_interface_descriptor_t *id;
120 	usb_endpoint_descriptor_t *ed;
121 	char *devinfop;
122 	char *devname = USBDEVNAME(sc->sc_dev);
123 	usbd_status err;
124 	struct ucom_attach_args uca;
125 	int i;
126 
127 	DPRINTFN(10,("\nugensa_attach: sc=%p\n", sc));
128 
129 	/* Move the device into the configured state. */
130 	err = usbd_set_config_index(dev, UGENSA_CONFIG_INDEX, 1);
131 	if (err) {
132 		printf("\n%s: failed to set configuration, err=%s\n",
133 		       devname, usbd_errstr(err));
134 		goto bad;
135 	}
136 
137 	err = usbd_device2interface_handle(dev, UGENSA_IFACE_INDEX, &iface);
138 	if (err) {
139 		printf("\n%s: failed to get interface, err=%s\n",
140 		       devname, usbd_errstr(err));
141 		goto bad;
142 	}
143 
144 	devinfop = usbd_devinfo_alloc(dev, 0);
145 	USB_ATTACH_SETUP;
146 	printf("%s: %s\n", devname, devinfop);
147 	usbd_devinfo_free(devinfop);
148 
149 	id = usbd_get_interface_descriptor(iface);
150 
151 	sc->sc_udev = dev;
152 	sc->sc_iface = iface;
153 
154 	uca.info = "Generic Serial Device";
155 	uca.ibufsize = UGENSA_BUFSIZE;
156 	uca.obufsize = UGENSA_BUFSIZE;
157 	uca.ibufsizepad = UGENSA_BUFSIZE;
158 	uca.portno = UCOM_UNK_PORTNO;
159 	uca.opkthdrlen = 0;
160 	uca.device = dev;
161 	uca.iface = iface;
162 	uca.methods = &ugensa_methods;
163 	uca.arg = sc;
164 
165 	usbd_add_drv_event(USB_EVENT_DRIVER_ATTACH, sc->sc_udev,
166 			   USBDEV(sc->sc_dev));
167 
168 	uca.bulkin = uca.bulkout = -1;
169 	for (i = 0; i < id->bNumEndpoints; i++) {
170 		int addr, dir, attr;
171 
172 		ed = usbd_interface2endpoint_descriptor(iface, i);
173 		if (ed == NULL) {
174 			printf("%s: could not read endpoint descriptor"
175 			       ": %s\n", devname, usbd_errstr(err));
176 			goto bad;
177 		}
178 
179 		addr = ed->bEndpointAddress;
180 		dir = UE_GET_DIR(ed->bEndpointAddress);
181 		attr = ed->bmAttributes & UE_XFERTYPE;
182 		if (dir == UE_DIR_IN && attr == UE_BULK)
183 			uca.bulkin = addr;
184 		else if (dir == UE_DIR_OUT && attr == UE_BULK)
185 			uca.bulkout = addr;
186 		else
187 			printf("%s: unexpected endpoint\n", devname);
188 	}
189 	if (uca.bulkin == -1) {
190 		printf("%s: Could not find data bulk in\n",
191 		       USBDEVNAME(sc->sc_dev));
192 		goto bad;
193 	}
194 	if (uca.bulkout == -1) {
195 		printf("%s: Could not find data bulk out\n",
196 		       USBDEVNAME(sc->sc_dev));
197 		goto bad;
198 	}
199 
200 	DPRINTF(("ugensa: in=0x%x out=0x%x\n", uca.bulkin, uca.bulkout));
201 	sc->sc_subdev = config_found_sm_loc(self, "ucombus", NULL, &uca,
202 					    ucomprint, ucomsubmatch);
203 
204 	USB_ATTACH_SUCCESS_RETURN;
205 
206 bad:
207 	DPRINTF(("ugensa_attach: ATTACH ERROR\n"));
208 	sc->sc_dying = 1;
209 	USB_ATTACH_ERROR_RETURN;
210 }
211 
212 int
213 ugensa_activate(device_ptr_t self, enum devact act)
214 {
215 	struct ugensa_softc *sc = (struct ugensa_softc *)self;
216 	int rv = 0;
217 
218 	switch (act) {
219 	case DVACT_ACTIVATE:
220 		return (EOPNOTSUPP);
221 		break;
222 
223 	case DVACT_DEACTIVATE:
224 		sc->sc_dying = 1;
225 		if (sc->sc_subdev)
226 			rv = config_deactivate(sc->sc_subdev);
227 		break;
228 	}
229 	return (rv);
230 }
231 
232 USB_DETACH(ugensa)
233 {
234 	USB_DETACH_START(ugensa, sc);
235 	int rv = 0;
236 
237 	DPRINTF(("ugensa_detach: sc=%p flags=%d\n", sc, flags));
238 
239 	sc->sc_dying = 1;
240 
241 	if (sc->sc_subdev != NULL)
242 		rv = config_detach(sc->sc_subdev, flags);
243 
244 	usbd_add_drv_event(USB_EVENT_DRIVER_DETACH, sc->sc_udev,
245 			   USBDEV(sc->sc_dev));
246 
247 	return (rv);
248 }
249