umsm(4) -> ugensa(4) as it makes much more sense - there is nothing Qualcomm
[dragonfly.git] / sys / dev / usbmisc / ugensa / ugensa.c
1 /* $DragonFly: src/sys/dev/usbmisc/ugensa/ugensa.c,v 1.1 2008/02/11 18:13:58 hasso Exp $ */
2 /* $OpenBSD: umsm.c,v 1.15 2007/06/14 10:11:16 mbalmer Exp $ */
3
4 /*
5  * Copyright (c) 2006 Jonathan Gray <jsg@openbsd.org>
6  *
7  * Permission to use, copy, modify, and distribute this software for any
8  * purpose with or without fee is hereby granted, provided that the above
9  * copyright notice and this permission notice appear in all copies.
10  *
11  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
12  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
13  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
14  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
15  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
16  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
17  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
18  */
19
20 /*
21  * Generic USB serial driver used for devices where hardware specific
22  * don't apply or doesn't make sense (for example Qualcomm MSM EVDO, UMTS
23  * and other similar communication devices).
24  */
25
26 #include <sys/param.h>
27 #include <sys/systm.h>
28 #include <sys/kernel.h>
29 #include <sys/device.h>
30 #include <sys/conf.h>
31 #include <sys/tty.h>
32 #include <sys/types.h>
33 #include <sys/bus.h>
34 #include <sys/module.h>
35
36 #include <bus/usb/usb.h>
37 #include <bus/usb/usbdi.h>
38 #include <bus/usb/usbdi_util.h>
39 #include <dev/usbmisc/ucom/ucomvar.h>
40
41 #ifdef UGENSA_DEBUG
42 static int      ugensadebug = 1;
43 #define DPRINTFN(n, x)  do { if (ugensadebug > (n)) kprintf x; } while (0)
44 #else
45 #define DPRINTFN(n, x)
46 #endif
47 #define DPRINTF(x) DPRINTFN(0, x)
48
49 #define UGENSABUFSZ     4096
50
51 struct ugensa_softc {
52         struct ucom_softc        sc_ucom;
53 };
54
55 struct ucom_callback ugensa_callback = {
56         NULL,
57         NULL,
58         NULL,
59         NULL,
60         NULL,
61         NULL,
62         NULL,
63         NULL
64 };
65
66 static const struct usb_devno ugensa_devs[] = {
67         { USB_DEVICE(0x05c6, 0x6613) }, /* Qualcomm HSDPA MSM */
68         { USB_DEVICE(0x0c88, 0x17da) }, /* Kyocera KPC650 */
69         { USB_DEVICE(0x0f3d, 0x0112) }, /* AirPrime PC5220 */
70         { USB_DEVICE(0x1199, 0x0017) }, /* Sierra Wireless EM5625 */
71         { USB_DEVICE(0x1199, 0x0018) }, /* Sierra Wireless MC5720 */
72         { USB_DEVICE(0x1199, 0x0019) }, /* Sierra Wireless AirCard 595 */
73         { USB_DEVICE(0x1199, 0x0020) }, /* Sierra Wireless MC5725 */
74         { USB_DEVICE(0x1199, 0x0112) }, /* Sierra Wireless Aircard 580 */
75         { USB_DEVICE(0x1199, 0x0218) }, /* Sierra Wireless MC5720 */
76         { USB_DEVICE(0x1199, 0x6802) }, /* Sierra Wireless MC8755 */
77         { USB_DEVICE(0x1199, 0x6803) }, /* Sierra Wireless MC8765 */
78         { USB_DEVICE(0x1199, 0x6804) }, /* Sierra Wireless MC8755 */
79         { USB_DEVICE(0x1199, 0x6812) }, /* Sierra Wireless MC8775 */
80         { USB_DEVICE(0x1199, 0x6813) }, /* Sierra Wireless MC8755 */
81         { USB_DEVICE(0x1199, 0x6820) }, /* Sierra Wireless Aircard 875 */
82         { USB_DEVICE(0x12d1, 0x1001) }, /* Huawei Mobile Connect */
83         { USB_DEVICE(0x1410, 0x1100) }, /* Novatel Wireless ExpressCard 3G */
84         { USB_DEVICE(0x1410, 0x1110) }, /* Novatel Wireless Merlin V620 */
85         { USB_DEVICE(0x1410, 0x1130) }, /* Novatel Wireless S720 */
86         { USB_DEVICE(0x1410, 0x1410) }, /* Novatel Wireless U740 */
87         { USB_DEVICE(0x1410, 0x1430) }, /* Novatel Wireless XU870 */
88         { USB_DEVICE(0x1410, 0x2100) }, /* Novatel Wireless ES620 */
89         { USB_DEVICE(0x1410, 0x2110) }, /* Novatel Wireless U720 */
90         { USB_DEVICE(0x413c, 0x8115) }, /* Dell W5500 */
91 };
92
93 static device_probe_t ugensa_match;
94 static device_attach_t ugensa_attach;
95 static device_detach_t ugensa_detach;
96
97 static device_method_t ugensa_methods[] = {
98         /* Device interface */
99         DEVMETHOD(device_probe, ugensa_match),
100         DEVMETHOD(device_attach, ugensa_attach),
101         DEVMETHOD(device_detach, ugensa_detach),
102         { 0, 0 }
103 };
104
105 static driver_t ugensa_driver = { 
106         "ucom",
107         ugensa_methods,
108         sizeof (struct ugensa_softc)
109 };
110
111 DRIVER_MODULE(ugensa, uhub, ugensa_driver, ucom_devclass, usbd_driver_load, 0);
112 MODULE_DEPEND(ugensa, usb, 1, 1, 1);
113 MODULE_DEPEND(ugensa, ucom, UCOM_MINVER, UCOM_PREFVER, UCOM_MAXVER);
114 MODULE_VERSION(ugensa, 1);
115
116 static int
117 ugensa_match(device_t self)
118 {
119         struct usb_attach_arg *uaa = device_get_ivars(self);
120
121         if (uaa->iface == NULL)
122                 return UMATCH_NONE;
123
124         return (usb_lookup(ugensa_devs, uaa->vendor, uaa->product) != NULL) ?
125             UMATCH_VENDOR_IFACESUBCLASS : UMATCH_NONE;
126 }
127
128 static int
129 ugensa_attach(device_t self)
130 {
131         struct ugensa_softc *sc = device_get_softc(self);
132         struct usb_attach_arg *uaa = device_get_ivars(self);
133         struct ucom_softc *ucom;
134         usb_interface_descriptor_t *id;
135         usb_endpoint_descriptor_t *ed;
136         int i;
137
138         ucom = &sc->sc_ucom;
139         bzero(sc, sizeof (struct ugensa_softc));
140
141         ucom->sc_dev = self;
142         ucom->sc_udev = uaa->device;
143         ucom->sc_iface = uaa->iface;
144
145         id = usbd_get_interface_descriptor(ucom->sc_iface);
146
147         ucom->sc_bulkin_no = ucom->sc_bulkout_no = -1;
148         for (i = 0; i < id->bNumEndpoints; i++) {
149                 ed = usbd_interface2endpoint_descriptor(ucom->sc_iface, i);
150                 if (ed == NULL) {
151                         device_printf(ucom->sc_dev, "no endpoint descriptor "
152                                       "found for %d\n", i);
153                         goto error;
154                 }
155
156                 if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_IN &&
157                     UE_GET_XFERTYPE(ed->bmAttributes) == UE_BULK)
158                         ucom->sc_bulkin_no = ed->bEndpointAddress;
159                 else if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_OUT &&
160                     UE_GET_XFERTYPE(ed->bmAttributes) == UE_BULK)
161                         ucom->sc_bulkout_no = ed->bEndpointAddress;
162         }
163         if (ucom->sc_bulkin_no == -1 || ucom->sc_bulkout_no == -1) {
164                 device_printf(ucom->sc_dev, "missing endpoint\n");
165                 goto error;
166         }
167
168         ucom->sc_parent = sc;
169         ucom->sc_portno = UCOM_UNK_PORTNO;
170         ucom->sc_ibufsize = UGENSABUFSZ;
171         ucom->sc_obufsize = UGENSABUFSZ;
172         ucom->sc_ibufsizepad = UGENSABUFSZ;
173         ucom->sc_opkthdrlen = 0;
174         ucom->sc_callback = &ugensa_callback;
175
176         usbd_add_drv_event(USB_EVENT_DRIVER_ATTACH, ucom->sc_udev,
177                            ucom->sc_dev);
178
179         DPRINTF(("%s: in = 0x%x, out = 0x%x\n",
180                  device_get_nameunit(ucom->sc_dev), ucom->sc_bulkin_no,
181                  ucom->sc_bulkout_no));
182
183         ucom_attach(&sc->sc_ucom);
184
185         return 0;
186
187 error:
188         ucom->sc_dying = 1;
189         return ENXIO;
190 }
191
192 static int
193 ugensa_detach(device_t self)
194 {
195         struct ugensa_softc *sc = device_get_softc(self);
196         int rv = 0;
197
198         DPRINTF(("ugensa_detach: sc=%p\n", sc));
199         sc->sc_ucom.sc_dying = 1;
200         rv = ucom_detach(&sc->sc_ucom);
201         usbd_add_drv_event(USB_EVENT_DRIVER_DETACH, sc->sc_ucom.sc_udev,
202                            sc->sc_ucom.sc_dev);
203
204         return (rv);
205 }
206
207 #if 0 /* not yet */
208 int
209 ugensa_activate(struct device *self, enum devact act)
210 {
211         struct ugensa_softc *sc = (struct ugensa_softc *)self;
212         int rv = 0;
213
214         switch (act) {
215         case DVACT_ACTIVATE:
216                 break;
217
218         case DVACT_DEACTIVATE:
219                 if (sc->sc_subdev != NULL)
220                         rv = config_deactivate(sc->sc_subdev);
221                 sc->sc_dying = 1;
222                 break;
223         }
224         return (rv);
225 }
226 #endif