stuirda.c revision 1.2.4.1 1 /* $NetBSD: stuirda.c,v 1.2.4.1 2007/06/21 15:14:18 itohy 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 #ifndef USB_USE_IFATTACH
110 USB_MATCH_START(stuirda, uaa);
111 #else
112 USB_IFMATCH_START(stuirda, uaa);
113 #endif /* USB_USE_IFATTACH */
114
115 DPRINTFN(50,("stuirda_match\n"));
116
117 #ifndef USB_USE_IFATTACH
118 if (uaa->iface == NULL)
119 return (UMATCH_NONE);
120 #endif /* USB_USE_IFATTACH */
121
122 if (stuirda_lookup(uaa->vendor, uaa->product) != NULL)
123 return (UMATCH_VENDOR_PRODUCT);
124
125 return (UMATCH_NONE);
126 }
127
128 void uirda_attach(struct device *,struct device *,void *);
129
130 USB_ATTACH(stuirda)
131 {
132 #ifndef USB_USE_IFATTACH
133 USB_ATTACH_START(stuirda, sc, uaa);
134 #else
135 USB_IFATTACH_START(stuirda, sc, uaa);
136 #endif /* USB_USE_IFATTACH */
137
138 (void)uaa;
139
140 sc->sc_uirda.sc_loadfw = stuirda_fwload;
141 sc->sc_uirda.sc_irm = &stuirda_methods;
142 sc->sc_uirda.sc_hdszi = STUIRDA_HEADER_SIZE;
143
144 uirda_attach(parent,self,aux);
145 }
146
147 int
148 stuirda_fwload(struct uirda_softc *sc) {
149
150
151 int rc;
152 firmware_handle_t fh;
153 off_t fwsize;
154 usb_device_descriptor_t usbddsc;
155 usbd_xfer_handle fwxfer;
156 usbd_pipe_handle fwpipe;
157 usbd_status status;
158 usb_device_request_t req;
159 char *buffer;
160 char *p;
161 char fwname[12];
162 int n;
163 /* size_t bsize; */
164
165 printf("%s: needing to download firmware\n",
166 USBDEVNAME(sc->sc_dev));
167
168 status = usbd_get_device_desc(sc->sc_udev, &usbddsc);
169 if (status) {
170 printf("%s: can't get device descriptor, status %d\n",
171 USBDEVNAME(sc->sc_dev), status);
172 return status;
173 }
174
175 rc = usbd_get_class_desc(sc->sc_udev, UDESC_IRDA, 0,
176 USB_IRDA_DESCRIPTOR_SIZE, &sc->sc_irdadesc);
177 printf("error %d reading class desc\n", rc);
178
179 sprintf(fwname, "4210%02x%02x.sb",
180 usbddsc.bcdDevice[1],
181 usbddsc.bcdDevice[0]);
182
183 printf("%s: Attempting to load firmware %s\n",
184 USBDEVNAME(sc->sc_dev), fwname);
185
186 rc = firmware_open("uirda", fwname, &fh);
187
188 if (rc) {
189 printf("%s: Cannot load firmware\n",
190 USBDEVNAME(sc->sc_dev));
191 return 0;
192 return rc;
193 }
194 fwsize = firmware_get_size(fh);
195
196 printf("%s: Firmware size %lld\n",
197 USBDEVNAME(sc->sc_dev), (long long)fwsize);
198
199 buffer = firmware_malloc(fwsize);
200 if (buffer == NULL) {
201 printf("%s: Cannot load firmware: out of memory\n",
202 USBDEVNAME(sc->sc_dev));
203 goto giveup2;
204 }
205
206 rc = firmware_read(fh, 0, buffer, (size_t)fwsize);
207
208 if (rc) {
209 printf("%s: Cannot read firmware\n", USBDEVNAME(sc->sc_dev));
210 goto giveup3;
211 }
212
213 for (p = buffer + sizeof("Product Version:");
214 p < buffer + fwsize - 5; p++) {
215
216 if (0x1A == *p)
217 break;
218 }
219 if (0x1a != *p || memcmp(p+1, "STMP", 4) != 0) {
220 /* firmware bad */
221 printf("%s: Bad firmware\n", USBDEVNAME(sc->sc_dev));
222 goto giveup3;
223 }
224
225 p += 5;
226
227 req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
228 req.bRequest = 2 /* XXX magic */;
229 USETW(req.wValue, 0);
230 USETW(req.wIndex, 0);
231 USETW(req.wLength, 0);
232 rc = usbd_do_request(sc->sc_udev, &req, 0);
233 if (rc) {
234 printf("%s: Cannot switch to f/w d/l mode, error %d\n",
235 USBDEVNAME(sc->sc_dev), rc);
236 goto giveup4;
237 }
238
239 delay(100000);
240
241 rc = usbd_open_pipe(sc->sc_iface, sc->sc_wr_addr, 0, &fwpipe);
242 if (rc) {
243 printf("%s: Cannot open pipe, rc=%d\n",
244 USBDEVNAME(sc->sc_dev), rc);
245 goto giveup3;
246 }
247 fwxfer = usbd_alloc_xfer(sc->sc_udev, fwpipe);
248 if (fwxfer == NULL) {
249 printf("%s: Cannot alloc xfer\n", USBDEVNAME(sc->sc_dev));
250 goto giveup4;
251 }
252 n = (buffer + fwsize - p);
253 while (n > 0) {
254 if (n > 1023)
255 n = 1023;
256 rc = usbd_bulk_transfer(fwxfer, fwpipe,
257 USBD_NO_COPY|USBD_SYNCHRONOUS|USBD_FORCE_SHORT_XFER,
258 5000, p, &n, "uirda-fw-wr");
259 printf("%s: write: rc=%d, %d left\n",
260 USBDEVNAME(sc->sc_dev), rc, n);
261 if (rc) {
262 printf("%s: write: rc=%d, %d bytes written\n",
263 USBDEVNAME(sc->sc_dev), rc, n);
264 goto giveup4;
265 }
266 printf("%s: written %d\n", USBDEVNAME(sc->sc_dev), n);
267 p += n;
268 n = (buffer + fwsize - p);
269 }
270 delay(100000);
271 /* TODO: more code here */
272 rc = 0;
273
274 usbd_free_xfer(fwxfer);
275 giveup4: usbd_close_pipe(fwpipe);
276 giveup3: firmware_free(buffer, fwsize);
277 giveup2: firmware_close(fh);
278
279 return rc;
280
281 }
282
283 int
284 stuirda_write(void *h, struct uio *uio, int flag)
285 {
286 struct uirda_softc *sc = h;
287 usbd_status err;
288 u_int32_t n;
289 int error = 0;
290
291 DPRINTFN(1,("%s: sc=%p\n", __func__, sc));
292
293 if (sc->sc_dying)
294 return (EIO);
295
296 #ifdef DIAGNOSTIC
297 if (sc->sc_wr_buf == NULL)
298 return (EINVAL);
299 #endif
300
301 n = uio->uio_resid;
302 if (n > sc->sc_params.maxsize)
303 return (EINVAL);
304
305 sc->sc_refcnt++;
306 lockmgr(&sc->sc_wr_buf_lk, LK_EXCLUSIVE, NULL);
307
308 sc->sc_wr_buf[0] = UIRDA_EB_NO_CHANGE | UIRDA_NO_SPEED;
309
310 sc->sc_wr_buf[1] = 0;
311 sc->sc_wr_buf[2] = 7; /* XXX turnaround - maximum for now */
312 if ((n > 0 && (n % 128) == 0 && (n % 512) != 0)) {
313 sc->sc_wr_buf[1] = 1;
314 }
315
316 error = uiomove(sc->sc_wr_buf + STUIRDA_HEADER_SIZE, n, uio);
317 if (!error) {
318 DPRINTFN(1, ("uirdawrite: transfer %d bytes\n", n));
319
320 n += STUIRDA_HEADER_SIZE + sc->sc_wr_buf[1];
321 err = usbd_bulk_transfer(sc->sc_wr_xfer, sc->sc_wr_pipe,
322 USBD_FORCE_SHORT_XFER|USBD_NO_COPY,
323 UIRDA_WR_TIMEOUT,
324 sc->sc_wr_buf, &n, "uirdawr");
325 DPRINTFN(2, ("uirdawrite: err=%d\n", err));
326 if (err) {
327 if (err == USBD_INTERRUPTED)
328 error = EINTR;
329 else if (err == USBD_TIMEOUT)
330 error = ETIMEDOUT;
331 else
332 error = EIO;
333 }
334 }
335
336 lockmgr(&sc->sc_wr_buf_lk, LK_RELEASE, NULL);
337 if (--sc->sc_refcnt < 0)
338 usb_detach_wakeup(USBDEV(sc->sc_dev));
339
340 DPRINTFN(1,("%s: sc=%p done\n", __func__, sc));
341 return (error);
342 }
343