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