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.9 2006/04/30 17:22:15 dillon 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 #include <sys/thread2.h>
  64
  65 #ifdef __DragonFly__
  66 #include "firewire.h"
  67 #include "firewirereg.h"
  68 #include "fwmem.h"
  69 #else
  70 #include <dev/firewire/firewire.h>
  71 #include <dev/firewire/firewirereg.h>
  72 #include <dev/firewire/fwmem.h>
  73 #endif
  74
  75 static int fwmem_speed=2, fwmem_debug=0;
  76 static struct fw_eui64 fwmem_eui64;
  77 SYSCTL_DECL(_hw_firewire);
  78 SYSCTL_NODE(_hw_firewire, OID_AUTO, fwmem, CTLFLAG_RD, 0,
  79         "FireWire Memory Access");
  80 SYSCTL_UINT(_hw_firewire_fwmem, OID_AUTO, eui64_hi, CTLFLAG_RW,
  81         &fwmem_eui64.hi, 0, "Fwmem target EUI64 high");
  82 SYSCTL_UINT(_hw_firewire_fwmem, OID_AUTO, eui64_lo, CTLFLAG_RW,
  83         &fwmem_eui64.lo, 0, "Fwmem target EUI64 low");
  84 SYSCTL_INT(_hw_firewire_fwmem, OID_AUTO, speed, CTLFLAG_RW, &fwmem_speed, 0,
  85         "Fwmem link speed");
  86 SYSCTL_INT(_debug, OID_AUTO, fwmem_debug, CTLFLAG_RW, &fwmem_debug, 0,
  87         "Fwmem driver debug flag");
  88
  89 MALLOC_DEFINE(M_FWMEM, "fwmem", "fwmem/FireWire");
  90
  91 #define MAXLEN (512 << fwmem_speed)
  92
  93 struct fwmem_softc {
  94         struct fw_eui64 eui;
  95         int refcount;
  96 };
  97
  98 static struct fw_xfer *
  99 fwmem_xfer_req(
 100         struct fw_device *fwdev,
 101         caddr_t sc,
 102         int spd,
 103         int slen,
 104         int rlen,
 105         void *hand)
 106 {
 107         struct fw_xfer *xfer;
 108
 109         xfer = fw_xfer_alloc(M_FWMEM);
 110         if (xfer == NULL)
 111                 return NULL;
 112
 113         xfer->fc = fwdev->fc;
 114         xfer->send.hdr.mode.hdr.dst = FWLOCALBUS | fwdev->dst;
 115         if (spd < 0)
 116                 xfer->send.spd = fwdev->speed;
 117         else
 118                 xfer->send.spd = min(spd, fwdev->speed);
 119         xfer->act.hand = hand;
 120         xfer->retry_req = fw_asybusy;
 121         xfer->sc = sc;
 122         xfer->send.pay_len = slen;
 123         xfer->recv.pay_len = rlen;
 124
 125         return xfer;
 126 }
 127
 128 struct fw_xfer *
 129 fwmem_read_quad(
 130         struct fw_device *fwdev,
 131         caddr_t sc,
 132         u_int8_t spd,
 133         u_int16_t dst_hi,
 134         u_int32_t dst_lo,
 135         void *data,
 136         void (*hand)(struct fw_xfer *))
 137 {
 138         struct fw_xfer *xfer;
 139         struct fw_pkt *fp;
 140
 141         xfer = fwmem_xfer_req(fwdev, (void *)sc, spd, 0, 4, hand);
 142         if (xfer == NULL) {
 143                 return NULL;
 144         }
 145
 146         fp = &xfer->send.hdr;
 147         fp->mode.rreqq.tcode = FWTCODE_RREQQ;
 148         fp->mode.rreqq.dest_hi = dst_hi;
 149         fp->mode.rreqq.dest_lo = dst_lo;
 150
 151         xfer->send.payload = NULL;
 152         xfer->recv.payload = (u_int32_t *)data;
 153
 154         if (fwmem_debug)
 155                 printf("fwmem_read_quad: %d %04x:%08x\n", fwdev->dst,
 156                                 dst_hi, dst_lo);
 157
 158         if (fw_asyreq(xfer->fc, -1, xfer) == 0)
 159                 return xfer;
 160
 161         fw_xfer_free(xfer);
 162         return NULL;
 163 }
 164
 165 struct fw_xfer *
 166 fwmem_write_quad(
 167         struct fw_device *fwdev,
 168         caddr_t sc,
 169         u_int8_t spd,
 170         u_int16_t dst_hi,
 171         u_int32_t dst_lo,
 172         void *data,
 173         void (*hand)(struct fw_xfer *))
 174 {
 175         struct fw_xfer *xfer;
 176         struct fw_pkt *fp;
 177
 178         xfer = fwmem_xfer_req(fwdev, sc, spd, 0, 0, hand);
 179         if (xfer == NULL)
 180                 return NULL;
 181
 182         fp = &xfer->send.hdr;
 183         fp->mode.wreqq.tcode = FWTCODE_WREQQ;
 184         fp->mode.wreqq.dest_hi = dst_hi;
 185         fp->mode.wreqq.dest_lo = dst_lo;
 186         fp->mode.wreqq.data = *(u_int32_t *)data;
 187
 188         xfer->send.payload = xfer->recv.payload = NULL;
 189
 190         if (fwmem_debug)
 191                 printf("fwmem_write_quad: %d %04x:%08x %08x\n", fwdev->dst,
 192                         dst_hi, dst_lo, *(u_int32_t *)data);
 193
 194         if (fw_asyreq(xfer->fc, -1, xfer) == 0)
 195                 return xfer;
 196
 197         fw_xfer_free(xfer);
 198         return NULL;
 199 }
 200
 201 struct fw_xfer *
 202 fwmem_read_block(
 203         struct fw_device *fwdev,
 204         caddr_t sc,
 205         u_int8_t spd,
 206         u_int16_t dst_hi,
 207         u_int32_t dst_lo,
 208         int len,
 209         void *data,
 210         void (*hand)(struct fw_xfer *))
 211 {
 212         struct fw_xfer *xfer;
 213         struct fw_pkt *fp;
 214
 215         xfer = fwmem_xfer_req(fwdev, sc, spd, 0, roundup2(len, 4), hand);
 216         if (xfer == NULL)
 217                 return NULL;
 218
 219         fp = &xfer->send.hdr;
 220         fp->mode.rreqb.tcode = FWTCODE_RREQB;
 221         fp->mode.rreqb.dest_hi = dst_hi;
 222         fp->mode.rreqb.dest_lo = dst_lo;
 223         fp->mode.rreqb.len = len;
 224         fp->mode.rreqb.extcode = 0;
 225
 226         xfer->send.payload = NULL;
 227         xfer->recv.payload = data;
 228
 229         if (fwmem_debug)
 230                 printf("fwmem_read_block: %d %04x:%08x %d\n", fwdev->dst,
 231                                 dst_hi, dst_lo, len);
 232         if (fw_asyreq(xfer->fc, -1, xfer) == 0)
 233                 return xfer;
 234
 235         fw_xfer_free(xfer);
 236         return NULL;
 237 }
 238
 239 struct fw_xfer *
 240 fwmem_write_block(
 241         struct fw_device *fwdev,
 242         caddr_t sc,
 243         u_int8_t spd,
 244         u_int16_t dst_hi,
 245         u_int32_t dst_lo,
 246         int len,
 247         void *data,
 248         void (*hand)(struct fw_xfer *))
 249 {
 250         struct fw_xfer *xfer;
 251         struct fw_pkt *fp;
 252
 253         xfer = fwmem_xfer_req(fwdev, sc, spd, len, 0, hand);
 254         if (xfer == NULL)
 255                 return NULL;
 256
 257         fp = &xfer->send.hdr;
 258         fp->mode.wreqb.tcode = FWTCODE_WREQB;
 259         fp->mode.wreqb.dest_hi = dst_hi;
 260         fp->mode.wreqb.dest_lo = dst_lo;
 261         fp->mode.wreqb.len = len;
 262         fp->mode.wreqb.extcode = 0;
 263
 264         xfer->send.payload = data;
 265         xfer->recv.payload = NULL;
 266
 267         if (fwmem_debug)
 268                 printf("fwmem_write_block: %d %04x:%08x %d\n", fwdev->dst,
 269                                 dst_hi, dst_lo, len);
 270         if (fw_asyreq(xfer->fc, -1, xfer) == 0)
 271                 return xfer;
 272
 273         fw_xfer_free(xfer);
 274         return NULL;
 275 }
 276
 277
 278 int
 279 fwmem_open (dev_t dev, int flags, int fmt, fw_proc *td)
 280 {
 281         struct fwmem_softc *fms;
 282
 283         if (dev->si_drv1 != NULL) {
 284                 if ((flags & FWRITE) != 0)
 285                         return (EBUSY);
 286                 fms = (struct fwmem_softc *)dev->si_drv1;
 287                 fms->refcount ++;
 288         } else {
 289                 fms = (struct fwmem_softc *)malloc(sizeof(struct fwmem_softc),
 290                                                         M_FWMEM, M_WAITOK);
 291                 if (fms == NULL)
 292                         return ENOMEM;
 293                 bcopy(&fwmem_eui64, &fms->eui, sizeof(struct fw_eui64));
 294                 dev->si_drv1 = (void *)fms;
 295                 dev->si_iosize_max = DFLTPHYS;
 296                 fms->refcount = 1;
 297         }
 298         if (fwmem_debug)
 299                 printf("%s: refcount=%d\n", __func__, fms->refcount);
 300
 301         return (0);
 302 }
 303
 304 int
 305 fwmem_close (dev_t dev, int flags, int fmt, fw_proc *td)
 306 {
 307         struct fwmem_softc *fms;
 308
 309         fms = (struct fwmem_softc *)dev->si_drv1;
 310         fms->refcount --;
 311         if (fwmem_debug)
 312                 printf("%s: refcount=%d\n", __func__, fms->refcount);
 313         if (fms->refcount < 1) {
 314                 free(dev->si_drv1, M_FW);
 315                 dev->si_drv1 = NULL;
 316         }
 317
 318         return (0);
 319 }
 320
 321
 322 static void
 323 fwmem_biodone(struct fw_xfer *xfer)
 324 {
 325         struct bio *bio;
 326         struct buf *bp;
 327
 328         bio = (struct bio *)xfer->sc;
 329         bp = bio->bio_buf;
 330         bp->b_error = xfer->resp;
 331
 332         if (bp->b_error != 0) {
 333                 if (fwmem_debug)
 334                         printf("%s: err=%d\n", __func__, bp->b_error);
 335                 bp->b_flags |= B_ERROR;
 336                 bp->b_resid = bp->b_bcount;
 337         }
 338         fw_xfer_free(xfer);
 339         biodone(bio);
 340 }
 341
 342 void
 343 fwmem_strategy(dev_t dev, struct bio *bio)
 344 {
 345         struct buf *bp = bio->bio_buf;
 346         struct firewire_softc *sc;
 347         struct fwmem_softc *fms;
 348         struct fw_device *fwdev;
 349         struct fw_xfer *xfer;
 350         int unit, err=0, iolen;
 351
 352         /* XXX check request length */
 353
 354         unit = DEV2UNIT(dev);
 355         sc = devclass_get_softc(firewire_devclass, unit);
 356
 357         crit_enter();
 358         fms = (struct fwmem_softc *)dev->si_drv1;
 359         fwdev = fw_noderesolve_eui64(sc->fc, &fms->eui);
 360         if (fwdev == NULL) {
 361                 if (fwmem_debug)
 362                         printf("fwmem: no such device ID:%08x%08x\n",
 363                                         fms->eui.hi, fms->eui.lo);
 364                 err = EINVAL;
 365                 goto error;
 366         }
 367         if (bio->bio_offset == NOOFFSET) {
 368                 printf("fwmem: offset was not set bp %p\n", bp);
 369                 err = EINVAL;
 370                 goto error;
 371         }
 372
 373         iolen = MIN(bp->b_bcount, MAXLEN);
 374         if (bp->b_cmd == BUF_CMD_READ) {
 375                 if (iolen == 4 && (bio->bio_offset & 3) == 0)
 376                         xfer = fwmem_read_quad(fwdev,
 377                             (void *) bio, fwmem_speed,
 378                             bio->bio_offset >> 32, bio->bio_offset & 0xffffffff,
 379                             bp->b_data, fwmem_biodone);
 380                 else
 381                         xfer = fwmem_read_block(fwdev,
 382                             (void *) bio, fwmem_speed,
 383                             bio->bio_offset >> 32, bio->bio_offset & 0xffffffff,
 384                             iolen, bp->b_data, fwmem_biodone);
 385         } else {
 386                 if (iolen == 4 && (bio->bio_offset & 3) == 0)
 387                         xfer = fwmem_write_quad(fwdev,
 388                             (void *)bio, fwmem_speed,
 389                             bio->bio_offset >> 32, bio->bio_offset & 0xffffffff,
 390                             bp->b_data, fwmem_biodone);
 391                 else
 392                         xfer = fwmem_write_block(fwdev,
 393                             (void *)bio, fwmem_speed,
 394                             bio->bio_offset >> 32, bio->bio_offset & 0xffffffff,
 395                             iolen, bp->b_data, fwmem_biodone);
 396         }
 397         if (xfer == NULL) {
 398                 err = EIO;
 399                 goto error;
 400         }
 401         /* XXX */
 402         bp->b_resid = bp->b_bcount - iolen;
 403 error:
 404         crit_exit();
 405         if (err != 0) {
 406                 if (fwmem_debug)
 407                         printf("%s: err=%d\n", __func__, err);
 408                 bp->b_error = err;
 409                 bp->b_flags |= B_ERROR;
 410                 bp->b_resid = bp->b_bcount;
 411                 biodone(bio);
 412         }
 413 }
 414
 415 int
 416 fwmem_ioctl (dev_t dev, u_long cmd, caddr_t data, int flag, fw_proc *td)
 417 {
 418         struct fwmem_softc *fms;
 419         int err = 0;
 420
 421         fms = (struct fwmem_softc *)dev->si_drv1;
 422         switch (cmd) {
 423         case FW_SDEUI64:
 424                 bcopy(data, &fms->eui, sizeof(struct fw_eui64));
 425                 break;
 426         case FW_GDEUI64:
 427                 bcopy(&fms->eui, data, sizeof(struct fw_eui64));
 428                 break;
 429         default:
 430                 err = EINVAL;
 431         }
 432         return(err);
 433 }
 434 int
 435 fwmem_poll (dev_t dev, int events, fw_proc *td)
 436 {
 437         return EINVAL;
 438 }
 439 int
 440 #if defined(__DragonFly__) || __FreeBSD_version < 500102
 441 fwmem_mmap (dev_t dev, vm_offset_t offset, int nproto)
 442 #else
 443 fwmem_mmap (dev_t dev, vm_offset_t offset, vm_paddr_t *paddr, int nproto)
 444 #endif
 445 {
 446         return EINVAL;
 447 }