1 /*- 2 * SPDX-License-Identifier: BSD-4-Clause 3 * 4 * Copyright (c) 2002-2003 5 * Hidetoshi Shimokawa. All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 1. Redistributions of source code must retain the above copyright 11 * notice, this list of conditions and the following disclaimer. 12 * 2. Redistributions in binary form must reproduce the above copyright 13 * notice, this list of conditions and the following disclaimer in the 14 * documentation and/or other materials provided with the distribution. 15 * 3. All advertising materials mentioning features or use of this software 16 * must display the following acknowledgement: 17 * 18 * This product includes software developed by Hidetoshi Shimokawa. 19 * 20 * 4. Neither the name of the author nor the names of its contributors 21 * may be used to endorse or promote products derived from this software 22 * without specific prior written permission. 23 * 24 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 25 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 27 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 30 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 31 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 32 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 33 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 34 * SUCH DAMAGE. 35 */ 36 37 #ifdef HAVE_KERNEL_OPTION_HEADERS 38 #include "opt_device_polling.h" 39 #include "opt_inet.h" 40 #endif 41 42 #include <sys/param.h> 43 #include <sys/kernel.h> 44 #include <sys/malloc.h> 45 #include <sys/mbuf.h> 46 #include <sys/socket.h> 47 #include <sys/sockio.h> 48 #include <sys/sysctl.h> 49 #include <sys/systm.h> 50 #include <sys/module.h> 51 #include <sys/bus.h> 52 #include <machine/bus.h> 53 54 #include <net/bpf.h> 55 #include <net/ethernet.h> 56 #include <net/if.h> 57 #include <net/if_var.h> 58 #include <net/if_arp.h> 59 #include <net/if_types.h> 60 #include <net/if_vlan_var.h> 61 62 #include <dev/firewire/firewire.h> 63 #include <dev/firewire/firewirereg.h> 64 #include <dev/firewire/if_fwevar.h> 65 #include <dev/firewire/fw_net.h> 66 67 #define FWEDEBUG if (fwedebug) if_printf 68 #define TX_MAX_QUEUE (FWMAXQUEUE - 1) 69 70 /* network interface */ 71 static void fwe_start (if_t); 72 static int fwe_ioctl (if_t, u_long, caddr_t); 73 static void fwe_init (void *); 74 75 static void fwe_output_callback (struct fw_xfer *); 76 static void fwe_as_output (struct fwe_softc *, if_t); 77 static void fwe_as_input (struct fw_xferq *); 78 79 static int fwedebug = 0; 80 static int stream_ch = 1; 81 static int tx_speed = 2; 82 static int rx_queue_len = FWMAXQUEUE; 83 84 static MALLOC_DEFINE(M_FWE, "if_fwe", "Ethernet over FireWire interface"); 85 SYSCTL_INT(_debug, OID_AUTO, if_fwe_debug, CTLFLAG_RWTUN, &fwedebug, 0, ""); 86 SYSCTL_DECL(_hw_firewire); 87 static SYSCTL_NODE(_hw_firewire, OID_AUTO, fwe, CTLFLAG_RD | CTLFLAG_MPSAFE, 0, 88 "Ethernet emulation subsystem"); 89 SYSCTL_INT(_hw_firewire_fwe, OID_AUTO, stream_ch, CTLFLAG_RWTUN, &stream_ch, 0, 90 "Stream channel to use"); 91 SYSCTL_INT(_hw_firewire_fwe, OID_AUTO, tx_speed, CTLFLAG_RWTUN, &tx_speed, 0, 92 "Transmission speed"); 93 SYSCTL_INT(_hw_firewire_fwe, OID_AUTO, rx_queue_len, CTLFLAG_RWTUN, &rx_queue_len, 94 0, "Length of the receive queue"); 95 96 #ifdef DEVICE_POLLING 97 static poll_handler_t fwe_poll; 98 99 static int 100 fwe_poll(if_t ifp, enum poll_cmd cmd, int count) 101 { 102 struct fwe_softc *fwe; 103 struct firewire_comm *fc; 104 105 if (!(if_getdrvflags(ifp) & IFF_DRV_RUNNING)) 106 return (0); 107 108 fwe = ((struct fwe_eth_softc *)if_getsoftc(ifp))->fwe; 109 fc = fwe->fd.fc; 110 fc->poll(fc, (cmd == POLL_AND_CHECK_STATUS)?0:1, count); 111 return (0); 112 } 113 #endif /* DEVICE_POLLING */ 114 115 static void 116 fwe_identify(driver_t *driver, device_t parent) 117 { 118 BUS_ADD_CHILD(parent, 0, "fwe", device_get_unit(parent)); 119 } 120 121 static int 122 fwe_probe(device_t dev) 123 { 124 device_t pa; 125 126 pa = device_get_parent(dev); 127 if (device_get_unit(dev) != device_get_unit(pa)) { 128 return (ENXIO); 129 } 130 131 device_set_desc(dev, "Ethernet over FireWire"); 132 return (0); 133 } 134 135 static int 136 fwe_attach(device_t dev) 137 { 138 struct fwe_softc *fwe; 139 if_t ifp; 140 int unit, s; 141 u_char eaddr[6]; 142 struct fw_eui64 *eui; 143 144 fwe = ((struct fwe_softc *)device_get_softc(dev)); 145 unit = device_get_unit(dev); 146 147 bzero(fwe, sizeof(struct fwe_softc)); 148 mtx_init(&fwe->mtx, "fwe", NULL, MTX_DEF); 149 /* XXX */ 150 fwe->stream_ch = stream_ch; 151 fwe->dma_ch = -1; 152 153 fwe->fd.fc = device_get_ivars(dev); 154 if (tx_speed < 0) 155 tx_speed = fwe->fd.fc->speed; 156 157 fwe->fd.dev = dev; 158 fwe->fd.post_explore = NULL; 159 fwe->eth_softc.fwe = fwe; 160 161 fwe->pkt_hdr.mode.stream.tcode = FWTCODE_STREAM; 162 fwe->pkt_hdr.mode.stream.sy = 0; 163 fwe->pkt_hdr.mode.stream.chtag = fwe->stream_ch; 164 165 /* generate fake MAC address: first and last 3bytes from eui64 */ 166 #define LOCAL (0x02) 167 #define GROUP (0x01) 168 169 eui = &fwe->fd.fc->eui; 170 eaddr[0] = (FW_EUI64_BYTE(eui, 0) | LOCAL) & ~GROUP; 171 eaddr[1] = FW_EUI64_BYTE(eui, 1); 172 eaddr[2] = FW_EUI64_BYTE(eui, 2); 173 eaddr[3] = FW_EUI64_BYTE(eui, 5); 174 eaddr[4] = FW_EUI64_BYTE(eui, 6); 175 eaddr[5] = FW_EUI64_BYTE(eui, 7); 176 printf("if_fwe%d: Fake Ethernet address: " 177 "%02x:%02x:%02x:%02x:%02x:%02x\n", unit, 178 eaddr[0], eaddr[1], eaddr[2], eaddr[3], eaddr[4], eaddr[5]); 179 180 /* fill the rest and attach interface */ 181 ifp = fwe->eth_softc.ifp = if_alloc(IFT_ETHER); 182 if_setsoftc(ifp, &fwe->eth_softc); 183 184 if_initname(ifp, device_get_name(dev), unit); 185 if_setinitfn(ifp, fwe_init); 186 if_setstartfn(ifp, fwe_start); 187 if_setioctlfn(ifp, fwe_ioctl); 188 if_setflags(ifp, (IFF_BROADCAST|IFF_SIMPLEX|IFF_MULTICAST)); 189 if_setsendqlen(ifp, TX_MAX_QUEUE); 190 191 s = splimp(); 192 ether_ifattach(ifp, eaddr); 193 splx(s); 194 195 /* Tell the upper layer(s) we support long frames. */ 196 if_setifheaderlen(ifp, sizeof(struct ether_vlan_header)); 197 if_setcapabilitiesbit(ifp, IFCAP_VLAN_MTU | IFCAP_POLLING, 0); 198 if_setcapenablebit(ifp, IFCAP_VLAN_MTU, 0); 199 200 FWEDEBUG(ifp, "interface created\n"); 201 return (0); 202 } 203 204 static void 205 fwe_stop(struct fwe_softc *fwe) 206 { 207 struct firewire_comm *fc; 208 struct fw_xferq *xferq; 209 if_t ifp = fwe->eth_softc.ifp; 210 int i; 211 212 fc = fwe->fd.fc; 213 214 if (fwe->dma_ch >= 0) { 215 xferq = fc->ir[fwe->dma_ch]; 216 217 if (xferq->flag & FWXFERQ_RUNNING) 218 fc->irx_disable(fc, fwe->dma_ch); 219 xferq->flag &= 220 ~(FWXFERQ_MODEMASK | FWXFERQ_OPEN | FWXFERQ_STREAM | 221 FWXFERQ_EXTBUF | FWXFERQ_HANDLER | FWXFERQ_CHTAGMASK); 222 xferq->hand = NULL; 223 224 for (i = 0; i < xferq->bnchunk; i++) 225 m_freem(xferq->bulkxfer[i].mbuf); 226 free(xferq->bulkxfer, M_FWE); 227 228 FW_NET_FREE_XFERLIST(&fwe->xferlist); 229 STAILQ_INIT(&fwe->xferlist); 230 231 xferq->bulkxfer = NULL; 232 fwe->dma_ch = -1; 233 } 234 235 if_setdrvflagbits(ifp, 0, (IFF_DRV_RUNNING | IFF_DRV_OACTIVE)); 236 } 237 238 static int 239 fwe_detach(device_t dev) 240 { 241 struct fwe_softc *fwe; 242 if_t ifp; 243 int s; 244 245 fwe = device_get_softc(dev); 246 ifp = fwe->eth_softc.ifp; 247 248 #ifdef DEVICE_POLLING 249 if (if_getcapenable(ifp) & IFCAP_POLLING) 250 ether_poll_deregister(ifp); 251 #endif 252 s = splimp(); 253 254 fwe_stop(fwe); 255 ether_ifdetach(ifp); 256 if_free(ifp); 257 258 splx(s); 259 mtx_destroy(&fwe->mtx); 260 return 0; 261 } 262 263 static void 264 fwe_init(void *arg) 265 { 266 struct fwe_softc *fwe = ((struct fwe_eth_softc *)arg)->fwe; 267 struct firewire_comm *fc; 268 if_t ifp = fwe->eth_softc.ifp; 269 struct fw_xferq *xferq; 270 struct fw_xfer *xfer; 271 int i; 272 273 FWEDEBUG(ifp, "initializing\n"); 274 275 /* XXX keep promiscoud mode */ 276 if_setflagbits(ifp, IFF_PROMISC, 0); 277 278 fc = fwe->fd.fc; 279 if (fwe->dma_ch < 0) { 280 fwe->dma_ch = fw_open_isodma(fc, /* tx */0); 281 if (fwe->dma_ch < 0) 282 return; 283 xferq = fc->ir[fwe->dma_ch]; 284 xferq->flag |= FWXFERQ_EXTBUF | 285 FWXFERQ_HANDLER | FWXFERQ_STREAM; 286 fwe->stream_ch = stream_ch; 287 fwe->pkt_hdr.mode.stream.chtag = fwe->stream_ch; 288 xferq->flag &= ~0xff; 289 xferq->flag |= fwe->stream_ch & 0xff; 290 /* register fwe_input handler */ 291 xferq->sc = (caddr_t) fwe; 292 xferq->hand = fwe_as_input; 293 xferq->bnchunk = rx_queue_len; 294 xferq->bnpacket = 1; 295 xferq->psize = MCLBYTES; 296 xferq->queued = 0; 297 xferq->buf = NULL; 298 xferq->bulkxfer = (struct fw_bulkxfer *) malloc( 299 sizeof(struct fw_bulkxfer) * xferq->bnchunk, 300 M_FWE, M_WAITOK); 301 STAILQ_INIT(&xferq->stvalid); 302 STAILQ_INIT(&xferq->stfree); 303 STAILQ_INIT(&xferq->stdma); 304 xferq->stproc = NULL; 305 fw_net_init_iso_chunks(xferq); 306 STAILQ_INIT(&fwe->xferlist); 307 for (i = 0; i < TX_MAX_QUEUE; i++) { 308 xfer = fw_net_alloc_txfer(fwe->fd.fc, tx_speed, 309 fwe, fwe_output_callback, M_FWE); 310 if (xfer == NULL) 311 break; 312 STAILQ_INSERT_TAIL(&fwe->xferlist, xfer, link); 313 } 314 } else 315 xferq = fc->ir[fwe->dma_ch]; 316 317 318 /* start dma */ 319 if ((xferq->flag & FWXFERQ_RUNNING) == 0) 320 fc->irx_enable(fc, fwe->dma_ch); 321 322 if_setdrvflagbits(ifp, IFF_DRV_RUNNING, 0); 323 if_setdrvflagbits(ifp, 0, IFF_DRV_OACTIVE); 324 325 #if 0 326 /* attempt to start output */ 327 fwe_start(ifp); 328 #endif 329 } 330 331 332 static int 333 fwe_ioctl(if_t ifp, u_long cmd, caddr_t data) 334 { 335 struct fwe_softc *fwe = ((struct fwe_eth_softc *)if_getsoftc(ifp))->fwe; 336 struct ifstat *ifs = NULL; 337 int s, error; 338 339 switch (cmd) { 340 case SIOCSIFFLAGS: 341 s = splimp(); 342 if (if_getflags(ifp) & IFF_UP) { 343 if (!(if_getdrvflags(ifp) & IFF_DRV_RUNNING)) 344 fwe_init(&fwe->eth_softc); 345 } else { 346 if (if_getdrvflags(ifp) & IFF_DRV_RUNNING) 347 fwe_stop(fwe); 348 } 349 /* XXX keep promiscoud mode */ 350 if_setflagbits(ifp, IFF_PROMISC, 0); 351 splx(s); 352 break; 353 case SIOCADDMULTI: 354 case SIOCDELMULTI: 355 break; 356 357 case SIOCGIFSTATUS: 358 s = splimp(); 359 ifs = (struct ifstat *)data; 360 snprintf(ifs->ascii, sizeof(ifs->ascii), 361 "\tch %d dma %d\n", fwe->stream_ch, fwe->dma_ch); 362 splx(s); 363 break; 364 case SIOCSIFCAP: 365 #ifdef DEVICE_POLLING 366 { 367 struct ifreq *ifr = (struct ifreq *) data; 368 369 error = fw_net_poll_ioctl(ifp, ifr, 370 fwe->fd.fc, fwe_poll); 371 if (error >= 0) 372 return (error); 373 } 374 #endif /* DEVICE_POLLING */ 375 break; 376 default: 377 s = splimp(); 378 error = ether_ioctl(ifp, cmd, data); 379 splx(s); 380 return (error); 381 } 382 383 return (0); 384 } 385 386 static void 387 fwe_output_callback(struct fw_xfer *xfer) 388 { 389 struct fwe_softc *fwe; 390 if_t ifp; 391 int s; 392 393 fwe = (struct fwe_softc *)xfer->sc; 394 ifp = fwe->eth_softc.ifp; 395 /* XXX error check */ 396 FWEDEBUG(ifp, "resp = %d\n", xfer->resp); 397 if (xfer->resp != 0) 398 if_inc_counter(ifp, IFCOUNTER_OERRORS, 1); 399 m_freem(xfer->mbuf); 400 fw_xfer_unload(xfer); 401 402 s = splimp(); 403 FWE_LOCK(fwe); 404 STAILQ_INSERT_TAIL(&fwe->xferlist, xfer, link); 405 FWE_UNLOCK(fwe); 406 splx(s); 407 408 /* for queue full */ 409 if (!if_sendq_empty(ifp)) 410 fwe_start(ifp); 411 } 412 413 static void 414 fwe_start(if_t ifp) 415 { 416 struct fwe_softc *fwe = ((struct fwe_eth_softc *)if_getsoftc(ifp))->fwe; 417 int s; 418 419 FWEDEBUG(ifp, "starting\n"); 420 421 if (fwe->dma_ch < 0) { 422 FWEDEBUG(ifp, "not ready\n"); 423 424 s = splimp(); 425 fw_net_drain_sendq(ifp); 426 splx(s); 427 428 return; 429 } 430 431 s = splimp(); 432 if_setdrvflagbits(ifp, IFF_DRV_OACTIVE, 0); 433 434 if (!if_sendq_empty(ifp)) 435 fwe_as_output(fwe, ifp); 436 437 if_setdrvflagbits(ifp, 0, IFF_DRV_OACTIVE); 438 splx(s); 439 } 440 441 #define HDR_LEN 4 442 #ifndef ETHER_ALIGN 443 #define ETHER_ALIGN 2 444 #endif 445 /* Async. stream output */ 446 static void 447 fwe_as_output(struct fwe_softc *fwe, if_t ifp) 448 { 449 struct mbuf *m; 450 struct fw_xfer *xfer; 451 struct fw_xferq *xferq; 452 struct fw_pkt *fp; 453 int i = 0; 454 455 xfer = NULL; 456 xferq = fwe->fd.fc->atq; 457 while ((xferq->queued < xferq->maxq - 1) && 458 !if_sendq_empty(ifp)) { 459 FWE_LOCK(fwe); 460 xfer = STAILQ_FIRST(&fwe->xferlist); 461 if (xfer == NULL) { 462 #if 0 463 printf("if_fwe: lack of xfer\n"); 464 #endif 465 FWE_UNLOCK(fwe); 466 break; 467 } 468 STAILQ_REMOVE_HEAD(&fwe->xferlist, link); 469 FWE_UNLOCK(fwe); 470 471 m = if_dequeue(ifp); 472 if (m == NULL) { 473 FWE_LOCK(fwe); 474 STAILQ_INSERT_HEAD(&fwe->xferlist, xfer, link); 475 FWE_UNLOCK(fwe); 476 break; 477 } 478 BPF_MTAP(ifp, m); 479 480 /* keep ip packet alignment for alpha */ 481 M_PREPEND(m, ETHER_ALIGN, M_NOWAIT); 482 fp = &xfer->send.hdr; 483 *(uint32_t *)&xfer->send.hdr = *(int32_t *)&fwe->pkt_hdr; 484 fp->mode.stream.len = m->m_pkthdr.len; 485 xfer->mbuf = m; 486 xfer->send.pay_len = m->m_pkthdr.len; 487 488 if (fw_asyreq(fwe->fd.fc, -1, xfer) != 0) { 489 /* error */ 490 if_inc_counter(ifp, IFCOUNTER_OERRORS, 1); 491 /* XXX set error code */ 492 fwe_output_callback(xfer); 493 } else { 494 if_inc_counter(ifp, IFCOUNTER_OPACKETS, 1); 495 i++; 496 } 497 } 498 #if 0 499 if (i > 1) 500 printf("%d queued\n", i); 501 #endif 502 if (i > 0) 503 xferq->start(fwe->fd.fc); 504 } 505 506 /* Async. stream output */ 507 static void 508 fwe_as_input(struct fw_xferq *xferq) 509 { 510 struct mbuf *m, *m0; 511 if_t ifp; 512 struct fwe_softc *fwe; 513 struct fw_bulkxfer *sxfer; 514 struct fw_pkt *fp; 515 struct epoch_tracker et; 516 #if 0 517 u_char *c; 518 #endif 519 520 fwe = (struct fwe_softc *)xferq->sc; 521 ifp = fwe->eth_softc.ifp; 522 523 /* We do not need a lock here because the bottom half is serialized */ 524 while ((sxfer = STAILQ_FIRST(&xferq->stvalid)) != NULL) { 525 STAILQ_REMOVE_HEAD(&xferq->stvalid, link); 526 fp = mtod(sxfer->mbuf, struct fw_pkt *); 527 if (fwe->fd.fc->irx_post != NULL) 528 fwe->fd.fc->irx_post(fwe->fd.fc, fp->mode.ld); 529 m = sxfer->mbuf; 530 531 /* insert new rbuf */ 532 sxfer->mbuf = m0 = m_getcl(M_NOWAIT, MT_DATA, M_PKTHDR); 533 if (m0 != NULL) { 534 m0->m_len = m0->m_pkthdr.len = m0->m_ext.ext_size; 535 STAILQ_INSERT_TAIL(&xferq->stfree, sxfer, link); 536 } else 537 printf("%s: m_getcl failed\n", __FUNCTION__); 538 539 if (sxfer->resp != 0 || fp->mode.stream.len < 540 ETHER_ALIGN + sizeof(struct ether_header)) { 541 m_freem(m); 542 if_inc_counter(ifp, IFCOUNTER_IERRORS, 1); 543 continue; 544 } 545 546 m->m_data += HDR_LEN + ETHER_ALIGN; 547 #if 0 548 c = mtod(m, u_char *); 549 #endif 550 m->m_len = m->m_pkthdr.len = fp->mode.stream.len - ETHER_ALIGN; 551 m->m_pkthdr.rcvif = ifp; 552 #if 0 553 FWEDEBUG(ifp, "%02x %02x %02x %02x %02x %02x\n" 554 "%02x %02x %02x %02x %02x %02x\n" 555 "%02x %02x %02x %02x\n" 556 "%02x %02x %02x %02x\n" 557 "%02x %02x %02x %02x\n" 558 "%02x %02x %02x %02x\n", 559 c[0], c[1], c[2], c[3], c[4], c[5], 560 c[6], c[7], c[8], c[9], c[10], c[11], 561 c[12], c[13], c[14], c[15], 562 c[16], c[17], c[18], c[19], 563 c[20], c[21], c[22], c[23], 564 c[20], c[21], c[22], c[23] 565 ); 566 #endif 567 NET_EPOCH_ENTER(et); 568 if_input(ifp, m); 569 NET_EPOCH_EXIT(et); 570 if_inc_counter(ifp, IFCOUNTER_IPACKETS, 1); 571 } 572 if (STAILQ_FIRST(&xferq->stfree) != NULL) 573 fwe->fd.fc->irx_enable(fwe->fd.fc, fwe->dma_ch); 574 } 575 576 577 static device_method_t fwe_methods[] = { 578 /* device interface */ 579 DEVMETHOD(device_identify, fwe_identify), 580 DEVMETHOD(device_probe, fwe_probe), 581 DEVMETHOD(device_attach, fwe_attach), 582 DEVMETHOD(device_detach, fwe_detach), 583 DEVMETHOD_END 584 }; 585 586 static driver_t fwe_driver = { 587 "fwe", 588 fwe_methods, 589 sizeof(struct fwe_softc), 590 }; 591 592 593 DRIVER_MODULE(fwe, firewire, fwe_driver, 0, 0); 594 MODULE_VERSION(fwe, 1); 595 MODULE_DEPEND(fwe, firewire, 1, 1, 1); 596