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