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