sys/bus/firewire/fwmem.c

   1 /*
   2  * Copyright (c) 2002-2003
   3  *      Hidetoshi Shimokawa. All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  * 3. All advertising materials mentioning features or use of this software
  14  *    must display the following acknowledgement:
  15  *
  16  *      This product includes software developed by Hidetoshi Shimokawa.
  17  *
  18  * 4. Neither the name of the author nor the names of its contributors
  19  *    may be used to endorse or promote products derived from this software
  20  *    without specific prior written permission.
  21  *
  22  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  25  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  28  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  31  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  32  * SUCH DAMAGE.
  33  *
  34  * $DragonFly: src/sys/bus/firewire/fwmem.c,v 1.5 2004/02/05 17:51:43 joerg Exp $
  35  */
  36
  37 #ifndef __DragonFly__
  38 #include <sys/cdefs.h>
  39 __FBSDID("$FreeBSD: src/sys/dev/firewire/fwmem.c,v 1.26 2004/01/05 14:21:18 simokawa Exp $");
  40 #endif
  41
  42 #include <sys/param.h>
  43 #include <sys/systm.h>
  44 #include <sys/types.h>
  45
  46 #include <sys/kernel.h>
  47 #include <sys/malloc.h>
  48 #include <sys/conf.h>
  49 #include <sys/sysctl.h>
  50 #if defined(__DragonFly__) || __FreeBSD_version < 500000
  51 #include <sys/buf.h>
  52 #else
  53 #include <sys/bio.h>
  54 #endif
  55
  56 #include <sys/bus.h>
  57 #include <machine/bus.h>
  58
  59 #include <sys/signal.h>
  60 #include <sys/mman.h>
  61 #include <sys/ioccom.h>
  62 #include <sys/fcntl.h>
  63
  64 #ifdef __DragonFly__
  65 #include "firewire.h"
  66 #include "firewirereg.h"
  67 #include "fwmem.h"
  68 #else
  69 #include <dev/firewire/firewire.h>
  70 #include <dev/firewire/firewirereg.h>
  71 #include <dev/firewire/fwmem.h>
  72 #endif
  73
  74 static int fwmem_speed=2, fwmem_debug=0;
  75 static struct fw_eui64 fwmem_eui64;
  76 SYSCTL_DECL(_hw_firewire);
  77 SYSCTL_NODE(_hw_firewire, OID_AUTO, fwmem, CTLFLAG_RD, 0,
  78         "FireWire Memory Access");
  79 SYSCTL_UINT(_hw_firewire_fwmem, OID_AUTO, eui64_hi, CTLFLAG_RW,
  80         &fwmem_eui64.hi, 0, "Fwmem target EUI64 high");
  81 SYSCTL_UINT(_hw_firewire_fwmem, OID_AUTO, eui64_lo, CTLFLAG_RW,
  82         &fwmem_eui64.lo, 0, "Fwmem target EUI64 low");
  83 SYSCTL_INT(_hw_firewire_fwmem, OID_AUTO, speed, CTLFLAG_RW, &fwmem_speed, 0,
  84         "Fwmem link speed");
  85 SYSCTL_INT(_debug, OID_AUTO, fwmem_debug, CTLFLAG_RW, &fwmem_debug, 0,
  86         "Fwmem driver debug flag");
  87
  88 MALLOC_DEFINE(M_FWMEM, "fwmem", "fwmem/FireWire");
  89
  90 #define MAXLEN (512 << fwmem_speed)
  91
  92 struct fwmem_softc {
  93         struct fw_eui64 eui;
  94         int refcount;
  95 };
  96
  97 static struct fw_xfer *
  98 fwmem_xfer_req(
  99         struct fw_device *fwdev,
 100         caddr_t sc,
 101         int spd,
 102         int slen,
 103         int rlen,
 104         void *hand)
 105 {
 106         struct fw_xfer *xfer;
 107
 108         xfer = fw_xfer_alloc(M_FWMEM);
 109         if (xfer == NULL)
 110                 return NULL;
 111
 112         xfer->fc = fwdev->fc;
 113         xfer->send.hdr.mode.hdr.dst = FWLOCALBUS | fwdev->dst;
 114         if (spd < 0)
 115                 xfer->send.spd = fwdev->speed;
 116         else
 117                 xfer->send.spd = min(spd, fwdev->speed);
 118         xfer->act.hand = hand;
 119         xfer->retry_req = fw_asybusy;
 120         xfer->sc = sc;
 121         xfer->send.pay_len = slen;
 122         xfer->recv.pay_len = rlen;
 123
 124         return xfer;
 125 }
 126
 127 struct fw_xfer *
 128 fwmem_read_quad(
 129         struct fw_device *fwdev,
 130         caddr_t sc,
 131         u_int8_t spd,
 132         u_int16_t dst_hi,
 133         u_int32_t dst_lo,
 134         void *data,
 135         void (*hand)(struct fw_xfer *))
 136 {
 137         struct fw_xfer *xfer;
 138         struct fw_pkt *fp;
 139
 140         xfer = fwmem_xfer_req(fwdev, (void *)sc, spd, 0, 4, hand);
 141         if (xfer == NULL) {
 142                 return NULL;
 143         }
 144
 145         fp = &xfer->send.hdr;
 146         fp->mode.rreqq.tcode = FWTCODE_RREQQ;
 147         fp->mode.rreqq.dest_hi = dst_hi;
 148         fp->mode.rreqq.dest_lo = dst_lo;
 149
 150         xfer->send.payload = NULL;
 151         xfer->recv.payload = (u_int32_t *)data;
 152
 153         if (fwmem_debug)
 154                 printf("fwmem_read_quad: %d %04x:%08x\n", fwdev->dst,
 155                                 dst_hi, dst_lo);
 156
 157         if (fw_asyreq(xfer->fc, -1, xfer) == 0)
 158                 return xfer;
 159
 160         fw_xfer_free(xfer);
 161         return NULL;
 162 }
 163
 164 struct fw_xfer *
 165 fwmem_write_quad(
 166         struct fw_device *fwdev,
 167         caddr_t sc,
 168         u_int8_t spd,
 169         u_int16_t dst_hi,
 170         u_int32_t dst_lo,
 171         void *data,
 172         void (*hand)(struct fw_xfer *))
 173 {
 174         struct fw_xfer *xfer;
 175         struct fw_pkt *fp;
 176
 177         xfer = fwmem_xfer_req(fwdev, sc, spd, 0, 0, hand);
 178         if (xfer == NULL)
 179                 return NULL;
 180
 181         fp = &xfer->send.hdr;
 182         fp->mode.wreqq.tcode = FWTCODE_WREQQ;
 183         fp->mode.wreqq.dest_hi = dst_hi;
 184         fp->mode.wreqq.dest_lo = dst_lo;
 185         fp->mode.wreqq.data = *(u_int32_t *)data;
 186
 187         xfer->send.payload = xfer->recv.payload = NULL;
 188
 189         if (fwmem_debug)
 190                 printf("fwmem_write_quad: %d %04x:%08x %08x\n", fwdev->dst,
 191                         dst_hi, dst_lo, *(u_int32_t *)data);
 192
 193         if (fw_asyreq(xfer->fc, -1, xfer) == 0)
 194                 return xfer;
 195
 196         fw_xfer_free(xfer);
 197         return NULL;
 198 }
 199
 200 struct fw_xfer *
 201 fwmem_read_block(
 202         struct fw_device *fwdev,
 203         caddr_t sc,
 204         u_int8_t spd,
 205         u_int16_t dst_hi,
 206         u_int32_t dst_lo,
 207         int len,
 208         void *data,
 209         void (*hand)(struct fw_xfer *))
 210 {
 211         struct fw_xfer *xfer;
 212         struct fw_pkt *fp;
 213
 214         xfer = fwmem_xfer_req(fwdev, sc, spd, 0, roundup2(len, 4), hand);
 215         if (xfer == NULL)
 216                 return NULL;
 217
 218         fp = &xfer->send.hdr;
 219         fp->mode.rreqb.tcode = FWTCODE_RREQB;
 220         fp->mode.rreqb.dest_hi = dst_hi;
 221         fp->mode.rreqb.dest_lo = dst_lo;
 222         fp->mode.rreqb.len = len;
 223         fp->mode.rreqb.extcode = 0;
 224
 225         xfer->send.payload = NULL;
 226         xfer->recv.payload = data;
 227
 228         if (fwmem_debug)
 229                 printf("fwmem_read_block: %d %04x:%08x %d\n", fwdev->dst,
 230                                 dst_hi, dst_lo, len);
 231         if (fw_asyreq(xfer->fc, -1, xfer) == 0)
 232                 return xfer;
 233
 234         fw_xfer_free(xfer);
 235         return NULL;
 236 }
 237
 238 struct fw_xfer *
 239 fwmem_write_block(
 240         struct fw_device *fwdev,
 241         caddr_t sc,
 242         u_int8_t spd,
 243         u_int16_t dst_hi,
 244         u_int32_t dst_lo,
 245         int len,
 246         void *data,
 247         void (*hand)(struct fw_xfer *))
 248 {
 249         struct fw_xfer *xfer;
 250         struct fw_pkt *fp;
 251
 252         xfer = fwmem_xfer_req(fwdev, sc, spd, len, 0, hand);
 253         if (xfer == NULL)
 254                 return NULL;
 255
 256         fp = &xfer->send.hdr;
 257         fp->mode.wreqb.tcode = FWTCODE_WREQB;
 258         fp->mode.wreqb.dest_hi = dst_hi;
 259         fp->mode.wreqb.dest_lo = dst_lo;
 260         fp->mode.wreqb.len = len;
 261         fp->mode.wreqb.extcode = 0;
 262
 263         xfer->send.payload = data;
 264         xfer->recv.payload = NULL;
 265
 266         if (fwmem_debug)
 267                 printf("fwmem_write_block: %d %04x:%08x %d\n", fwdev->dst,
 268                                 dst_hi, dst_lo, len);
 269         if (fw_asyreq(xfer->fc, -1, xfer) == 0)
 270                 return xfer;
 271
 272         fw_xfer_free(xfer);
 273         return NULL;
 274 }
 275
 276
 277 int
 278 fwmem_open (dev_t dev, int flags, int fmt, fw_proc *td)
 279 {
 280         struct fwmem_softc *fms;
 281
 282         if (dev->si_drv1 != NULL) {
 283                 if ((flags & FWRITE) != 0)
 284                         return (EBUSY);
 285                 fms = (struct fwmem_softc *)dev->si_drv1;
 286                 fms->refcount ++;
 287         } else {
 288                 fms = (struct fwmem_softc *)malloc(sizeof(struct fwmem_softc),
 289                                                         M_FWMEM, M_WAITOK);
 290                 if (fms == NULL)
 291                         return ENOMEM;
 292                 bcopy(&fwmem_eui64, &fms->eui, sizeof(struct fw_eui64));
 293                 dev->si_drv1 = (void *)fms;
 294                 dev->si_iosize_max = DFLTPHYS;
 295                 fms->refcount = 1;
 296         }
 297         if (fwmem_debug)
 298                 printf("%s: refcount=%d\n", __FUNCTION__, fms->refcount);
 299
 300         return (0);
 301 }
 302
 303 int
 304 fwmem_close (dev_t dev, int flags, int fmt, fw_proc *td)
 305 {
 306         struct fwmem_softc *fms;
 307
 308         fms = (struct fwmem_softc *)dev->si_drv1;
 309         fms->refcount --;
 310         if (fwmem_debug)
 311                 printf("%s: refcount=%d\n", __FUNCTION__, fms->refcount);
 312         if (fms->refcount < 1) {
 313                 free(dev->si_drv1, M_FW);
 314                 dev->si_drv1 = NULL;
 315         }
 316
 317         return (0);
 318 }
 319
 320
 321 static void
 322 fwmem_biodone(struct fw_xfer *xfer)
 323 {
 324         struct bio *bp;
 325
 326         bp = (struct bio *)xfer->sc;
 327         bp->bio_error = xfer->resp;
 328
 329         if (bp->bio_error != 0) {
 330                 if (fwmem_debug)
 331                         printf("%s: err=%d\n", __FUNCTION__, bp->bio_error);
 332                 bp->bio_flags |= BIO_ERROR;
 333                 bp->bio_resid = bp->bio_bcount;
 334         }
 335
 336         fw_xfer_free(xfer);
 337         biodone(bp);
 338 }
 339
 340 void
 341 fwmem_strategy(struct bio *bp)
 342 {
 343         struct firewire_softc *sc;
 344         struct fwmem_softc *fms;
 345         struct fw_device *fwdev;
 346         struct fw_xfer *xfer;
 347         dev_t dev;
 348         int unit, err=0, s, iolen;
 349
 350         dev = bp->bio_dev;
 351         /* XXX check request length */
 352
 353         unit = DEV2UNIT(dev);
 354         sc = devclass_get_softc(firewire_devclass, unit);
 355
 356         s = splfw();
 357         fms = (struct fwmem_softc *)dev->si_drv1;
 358         fwdev = fw_noderesolve_eui64(sc->fc, &fms->eui);
 359         if (fwdev == NULL) {
 360                 if (fwmem_debug)
 361                         printf("fwmem: no such device ID:%08x%08x\n",
 362                                         fms->eui.hi, fms->eui.lo);
 363                 err = EINVAL;
 364                 goto error;
 365         }
 366
 367         iolen = MIN(bp->bio_bcount, MAXLEN);
 368         if ((bp->bio_cmd & BIO_READ) == BIO_READ) {
 369                 if (iolen == 4 && (bp->bio_offset & 3) == 0)
 370                         xfer = fwmem_read_quad(fwdev,
 371                             (void *) bp, fwmem_speed,
 372                             bp->bio_offset >> 32, bp->bio_offset & 0xffffffff,
 373                             bp->bio_data, fwmem_biodone);
 374                 else
 375                         xfer = fwmem_read_block(fwdev,
 376                             (void *) bp, fwmem_speed,
 377                             bp->bio_offset >> 32, bp->bio_offset & 0xffffffff,
 378                             iolen, bp->bio_data, fwmem_biodone);
 379         } else {
 380                 if (iolen == 4 && (bp->bio_offset & 3) == 0)
 381                         xfer = fwmem_write_quad(fwdev,
 382                             (void *)bp, fwmem_speed,
 383                             bp->bio_offset >> 32, bp->bio_offset & 0xffffffff,
 384                             bp->bio_data, fwmem_biodone);
 385                 else
 386                         xfer = fwmem_write_block(fwdev,
 387                             (void *)bp, fwmem_speed,
 388                             bp->bio_offset >> 32, bp->bio_offset & 0xffffffff,
 389                             iolen, bp->bio_data, fwmem_biodone);
 390         }
 391         if (xfer == NULL) {
 392                 err = EIO;
 393                 goto error;
 394         }
 395         /* XXX */
 396         bp->bio_resid = bp->bio_bcount - iolen;
 397 error:
 398         splx(s);
 399         if (err != 0) {
 400                 if (fwmem_debug)
 401                         printf("%s: err=%d\n", __FUNCTION__, err);
 402                 bp->bio_error = err;
 403                 bp->bio_flags |= BIO_ERROR;
 404                 bp->bio_resid = bp->bio_bcount;
 405                 biodone(bp);
 406         }
 407 }
 408
 409 int
 410 fwmem_ioctl (dev_t dev, u_long cmd, caddr_t data, int flag, fw_proc *td)
 411 {
 412         struct fwmem_softc *fms;
 413         int err = 0;
 414
 415         fms = (struct fwmem_softc *)dev->si_drv1;
 416         switch (cmd) {
 417         case FW_SDEUI64:
 418                 bcopy(data, &fms->eui, sizeof(struct fw_eui64));
 419                 break;
 420         case FW_GDEUI64:
 421                 bcopy(&fms->eui, data, sizeof(struct fw_eui64));
 422                 break;
 423         default:
 424                 err = EINVAL;
 425         }
 426         return(err);
 427 }
 428 int
 429 fwmem_poll (dev_t dev, int events, fw_proc *td)
 430 {
 431         return EINVAL;
 432 }
 433 int
 434 #if defined(__DragonFly__) || __FreeBSD_version < 500102
 435 fwmem_mmap (dev_t dev, vm_offset_t offset, int nproto)
 436 #else
 437 fwmem_mmap (dev_t dev, vm_offset_t offset, vm_paddr_t *paddr, int nproto)
 438 #endif
 439 {
 440         return EINVAL;
 441 }