stuirda.c revision 1.6.2.1 1 /* $NetBSD: stuirda.c,v 1.6.2.1 2008/05/18 12:34:50 yamt Exp $ */
2
3 /*
4 * Copyright (c) 2001,2007 The NetBSD Foundation, Inc.
5 * All rights reserved.
6 *
7 * This code is derived from software contributed to The NetBSD Foundation
8 * by Lennart Augustsson (lennart (at) augustsson.net).
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 *
19 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
20 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
23 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29 * POSSIBILITY OF SUCH DAMAGE.
30 */
31
32 #include <sys/cdefs.h>
33 __KERNEL_RCSID(0, "$NetBSD: stuirda.c,v 1.6.2.1 2008/05/18 12:34:50 yamt Exp $");
34
35 #include <sys/param.h>
36
37 #include <sys/device.h>
38 #include <sys/systm.h>
39 #include <sys/kernel.h>
40 #include <sys/device.h>
41 #include <sys/ioctl.h>
42 #include <sys/conf.h>
43 #include <sys/file.h>
44 #include <sys/poll.h>
45 #include <sys/select.h>
46 #include <sys/proc.h>
47
48
49 #include <dev/firmload.h>
50 #include <dev/usb/usb.h>
51 #include <dev/usb/usbdi.h>
52 #include <dev/usb/usbdi_util.h>
53 #include <dev/usb/usbdevs.h>
54 #include <dev/usb/usb_port.h>
55
56 #include <dev/ir/ir.h>
57 #include <dev/ir/irdaio.h>
58 #include <dev/ir/irframevar.h>
59
60 #include <dev/usb/uirdavar.h>
61
62 #ifdef UIRDA_DEBUG
63 #define DPRINTF(x) if (stuirdadebug) logprintf x
64 #define DPRINTFN(n,x) if (stuirdadebug>(n)) logprintf x
65 int stuirdadebug = 1;
66 #else
67 #define DPRINTF(x)
68 #define DPRINTFN(n,x)
69 #endif
70
71 struct stuirda_softc {
72 struct uirda_softc sc_uirda;
73 };
74
75 int stuirda_fwload(struct uirda_softc *sc);
76
77 /*
78 * These devices need firmware download.
79 */
80 Static const struct usb_devno stuirda_devs[] = {
81 { USB_VENDOR_SIGMATEL, USB_PRODUCT_SIGMATEL_SIR4116 },
82 { USB_VENDOR_SIGMATEL, USB_PRODUCT_SIGMATEL_FIR4210 },
83 { USB_VENDOR_SIGMATEL, USB_PRODUCT_SIGMATEL_VFIR4220 },
84 };
85 #define stuirda_lookup(v, p) (usb_lookup(stuirda_devs, v, p))
86
87 int stuirda_write(void *h, struct uio *uio, int flag);
88
89 struct irframe_methods stuirda_methods = {
90 uirda_open, uirda_close, uirda_read, stuirda_write, uirda_poll,
91 uirda_kqfilter, uirda_set_params, uirda_get_speeds,
92 uirda_get_turnarounds
93 };
94
95 #define STUIRDA_HEADER_SIZE 3
96
97 #define stuirda_activate uirda_activate
98 #define stuirda_detach uirda_detach
99
100 USB_DECLARE_DRIVER(stuirda);
101
102 USB_MATCH(stuirda)
103 {
104 USB_IFMATCH_START(stuirda, uaa);
105
106 DPRINTFN(50,("stuirda_match\n"));
107
108 if (stuirda_lookup(uaa->vendor, uaa->product) != NULL)
109 return (UMATCH_VENDOR_PRODUCT);
110
111 return (UMATCH_NONE);
112 }
113
114 void uirda_attach(struct device *,struct device *,void *);
115
116 USB_ATTACH(stuirda)
117 {
118 USB_IFATTACH_START(stuirda, sc, uaa);
119
120 (void)uaa;
121
122 sc->sc_uirda.sc_loadfw = stuirda_fwload;
123 sc->sc_uirda.sc_irm = &stuirda_methods;
124 sc->sc_uirda.sc_hdszi = STUIRDA_HEADER_SIZE;
125
126 uirda_attach(parent,self,aux);
127 }
128
129 int
130 stuirda_fwload(struct uirda_softc *sc) {
131
132
133 int rc;
134 firmware_handle_t fh;
135 off_t fwsize;
136 usb_device_descriptor_t usbddsc;
137 usbd_xfer_handle fwxfer;
138 usbd_pipe_handle fwpipe;
139 usbd_status status;
140 usb_device_request_t req;
141 char *buffer;
142 char *p;
143 char fwname[12];
144 int n;
145 u_int8_t *usbbuf;
146 /* size_t bsize; */
147
148 printf("%s: needing to download firmware\n",
149 USBDEVNAME(sc->sc_dev));
150
151 status = usbd_get_device_desc(sc->sc_udev, &usbddsc);
152 if (status) {
153 printf("%s: can't get device descriptor, status %d\n",
154 USBDEVNAME(sc->sc_dev), status);
155 return status;
156 }
157
158 rc = usbd_get_class_desc(sc->sc_udev, UDESC_IRDA, 0,
159 USB_IRDA_DESCRIPTOR_SIZE, &sc->sc_irdadesc);
160 printf("error %d reading class desc\n", rc);
161
162 snprintf(fwname, sizeof(fwname), "4210%02x%02x.sb",
163 usbddsc.bcdDevice[1],
164 usbddsc.bcdDevice[0]);
165
166 printf("%s: Attempting to load firmware %s\n",
167 USBDEVNAME(sc->sc_dev), fwname);
168
169 rc = firmware_open("uirda", fwname, &fh);
170
171 if (rc) {
172 printf("%s: Cannot load firmware\n",
173 USBDEVNAME(sc->sc_dev));
174 return 0;
175 return rc;
176 }
177 fwsize = firmware_get_size(fh);
178
179 printf("%s: Firmware size %lld\n",
180 USBDEVNAME(sc->sc_dev), (long long)fwsize);
181
182 buffer = firmware_malloc(fwsize);
183 if (buffer == NULL) {
184 printf("%s: Cannot load firmware: out of memory\n",
185 USBDEVNAME(sc->sc_dev));
186 goto giveup2;
187 }
188
189 rc = firmware_read(fh, 0, buffer, (size_t)fwsize);
190
191 if (rc) {
192 printf("%s: Cannot read firmware\n", USBDEVNAME(sc->sc_dev));
193 goto giveup3;
194 }
195
196 for (p = buffer + sizeof("Product Version:");
197 p < buffer + fwsize - 5; p++) {
198
199 if (0x1A == *p)
200 break;
201 }
202 if (0x1a != *p || memcmp(p+1, "STMP", 4) != 0) {
203 /* firmware bad */
204 printf("%s: Bad firmware\n", USBDEVNAME(sc->sc_dev));
205 goto giveup3;
206 }
207
208 p += 5;
209
210 req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
211 req.bRequest = 2 /* XXX magic */;
212 USETW(req.wValue, 0);
213 USETW(req.wIndex, 0);
214 USETW(req.wLength, 0);
215 rc = usbd_do_request(sc->sc_udev, &req, 0);
216 if (rc) {
217 printf("%s: Cannot switch to f/w d/l mode, error %d\n",
218 USBDEVNAME(sc->sc_dev), rc);
219 goto giveup4;
220 }
221
222 delay(100000);
223
224 rc = usbd_open_pipe(sc->sc_iface, sc->sc_wr_addr, 0, &fwpipe);
225 if (rc) {
226 printf("%s: Cannot open pipe, rc=%d\n",
227 USBDEVNAME(sc->sc_dev), rc);
228 goto giveup3;
229 }
230 fwxfer = usbd_alloc_xfer(sc->sc_udev);
231 if (fwxfer == NULL) {
232 printf("%s: Cannot alloc xfer\n", USBDEVNAME(sc->sc_dev));
233 goto giveup4;
234 }
235 usbbuf = usbd_alloc_buffer(fwxfer, 1024);
236 if (usbbuf == NULL) {
237 printf("%s: Cannot alloc usb buf\n", USBDEVNAME(sc->sc_dev));
238 goto giveup5;
239 }
240 n = (buffer + fwsize - p);
241 while (n > 0) {
242 if (n > 1023)
243 n = 1023;
244 memcpy(usbbuf, p, n);
245 rc = usbd_bulk_transfer(fwxfer, fwpipe,
246 USBD_SYNCHRONOUS|USBD_FORCE_SHORT_XFER,
247 5000, usbbuf, &n, "uirda-fw-wr");
248 printf("%s: write: rc=%d, %d left\n",
249 USBDEVNAME(sc->sc_dev), rc, n);
250 if (rc) {
251 printf("%s: write: rc=%d, %d bytes written\n",
252 USBDEVNAME(sc->sc_dev), rc, n);
253 goto giveup4;
254 }
255 printf("%s: written %d\n", USBDEVNAME(sc->sc_dev), n);
256 p += n;
257 n = (buffer + fwsize - p);
258 }
259 delay(100000);
260 /* TODO: more code here */
261 rc = 0;
262 usbd_free_buffer(fwxfer);
263
264 giveup5: usbd_free_xfer(fwxfer);
265 giveup4: usbd_close_pipe(fwpipe);
266 giveup3: firmware_free(buffer, fwsize);
267 giveup2: firmware_close(fh);
268
269 return rc;
270
271 }
272
273 int
274 stuirda_write(void *h, struct uio *uio, int flag)
275 {
276 struct uirda_softc *sc = h;
277 usbd_status err;
278 u_int32_t n;
279 int error = 0;
280
281 DPRINTFN(1,("%s: sc=%p\n", __func__, sc));
282
283 if (sc->sc_dying)
284 return (EIO);
285
286 #ifdef DIAGNOSTIC
287 if (sc->sc_wr_buf == NULL)
288 return (EINVAL);
289 #endif
290
291 n = uio->uio_resid;
292 if (n > sc->sc_params.maxsize)
293 return (EINVAL);
294
295 sc->sc_refcnt++;
296 mutex_enter(&sc->sc_wr_buf_lk);
297
298 sc->sc_wr_buf[0] = UIRDA_EB_NO_CHANGE | UIRDA_NO_SPEED;
299
300 sc->sc_wr_buf[1] = 0;
301 sc->sc_wr_buf[2] = 7; /* XXX turnaround - maximum for now */
302 if ((n > 0 && (n % 128) == 0 && (n % 512) != 0)) {
303 sc->sc_wr_buf[1] = 1;
304 }
305
306 error = uiomove(sc->sc_wr_buf + STUIRDA_HEADER_SIZE, n, uio);
307 if (!error) {
308 DPRINTFN(1, ("uirdawrite: transfer %d bytes\n", n));
309
310 n += STUIRDA_HEADER_SIZE + sc->sc_wr_buf[1];
311 err = usbd_bulk_transfer(sc->sc_wr_xfer, sc->sc_wr_pipe,
312 USBD_FORCE_SHORT_XFER|USBD_NO_COPY,
313 UIRDA_WR_TIMEOUT,
314 sc->sc_wr_buf, &n, "uirdawr");
315 DPRINTFN(2, ("uirdawrite: err=%d\n", err));
316 if (err) {
317 if (err == USBD_INTERRUPTED)
318 error = EINTR;
319 else if (err == USBD_TIMEOUT)
320 error = ETIMEDOUT;
321 else
322 error = EIO;
323 }
324 }
325
326 mutex_exit(&sc->sc_wr_buf_lk);
327 if (--sc->sc_refcnt < 0)
328 usb_detach_wakeup(USBDEV(sc->sc_dev));
329
330 DPRINTFN(1,("%s: sc=%p done\n", __func__, sc));
331 return (error);
332 }
333