firewirereg.h revision 121780
1103285Sikob/* 2113584Ssimokawa * Copyright (c) 2003 Hidetoshi Shimokawa 3103285Sikob * Copyright (c) 1998-2002 Katsushi Kobayashi and Hidetoshi Shimokawa 4103285Sikob * All rights reserved. 5103285Sikob * 6103285Sikob * Redistribution and use in source and binary forms, with or without 7103285Sikob * modification, are permitted provided that the following conditions 8103285Sikob * are met: 9103285Sikob * 1. Redistributions of source code must retain the above copyright 10103285Sikob * notice, this list of conditions and the following disclaimer. 11103285Sikob * 2. Redistributions in binary form must reproduce the above copyright 12103285Sikob * notice, this list of conditions and the following disclaimer in the 13103285Sikob * documentation and/or other materials provided with the distribution. 14103285Sikob * 3. All advertising materials mentioning features or use of this software 15103285Sikob * must display the acknowledgement as bellow: 16103285Sikob * 17103285Sikob * This product includes software developed by K. Kobayashi and H. Shimokawa 18103285Sikob * 19103285Sikob * 4. The name of the author may not be used to endorse or promote products 20103285Sikob * derived from this software without specific prior written permission. 21103285Sikob * 22103285Sikob * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 23103285Sikob * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 24103285Sikob * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 25103285Sikob * DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, 26103285Sikob * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES 27103285Sikob * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 28103285Sikob * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 29103285Sikob * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 30103285Sikob * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN 31103285Sikob * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 32103285Sikob * POSSIBILITY OF SUCH DAMAGE. 33103285Sikob * 34103285Sikob * $FreeBSD: head/sys/dev/firewire/firewirereg.h 121780 2003-10-31 04:58:03Z simokawa $ 35103285Sikob * 36103285Sikob */ 37103285Sikob 38103285Sikob#if __FreeBSD_version >= 500000 39103285Sikobtypedef struct thread fw_proc; 40103285Sikob#include <sys/selinfo.h> 41103285Sikob#else 42103285Sikobtypedef struct proc fw_proc; 43103285Sikob#include <sys/select.h> 44103285Sikob#endif 45103285Sikob 46113584Ssimokawa#include <sys/uio.h> 47113584Ssimokawa 48103285Sikob#define splfw splimp 49103285Sikob 50103285Sikobstruct fw_device{ 51103285Sikob u_int16_t dst; 52103285Sikob struct fw_eui64 eui; 53103285Sikob u_int8_t speed; 54103285Sikob u_int8_t maxrec; 55103285Sikob u_int8_t nport; 56103285Sikob u_int8_t power; 57103285Sikob#define CSRROMOFF 0x400 58103285Sikob#define CSRROMSIZE 0x400 59103285Sikob int rommax; /* offset from 0xffff f000 0000 */ 60103285Sikob u_int32_t csrrom[CSRROMSIZE/4]; 61103285Sikob int rcnt; 62106810Ssimokawa struct firewire_comm *fc; 63103285Sikob u_int32_t status; 64103285Sikob#define FWDEVINIT 1 65103285Sikob#define FWDEVATTACHED 2 66103285Sikob#define FWDEVINVAL 3 67110193Ssimokawa STAILQ_ENTRY(fw_device) link; 68103285Sikob}; 69109645Ssimokawa 70103285Sikobstruct firewire_softc { 71103285Sikob#if __FreeBSD_version >= 500000 72103285Sikob dev_t dev; 73103285Sikob#endif 74103285Sikob struct firewire_comm *fc; 75103285Sikob}; 76109645Ssimokawa 77103285Sikob#define FW_MAX_DMACH 0x20 78103285Sikob#define FW_MAX_DEVCH FW_MAX_DMACH 79103285Sikob#define FW_XFERTIMEOUT 1 80109645Ssimokawa 81103285Sikobstruct firewire_dev_comm { 82103285Sikob device_t dev; 83103285Sikob struct firewire_comm *fc; 84113584Ssimokawa void (*post_busreset) __P((void *)); 85103285Sikob void (*post_explore) __P((void *)); 86103285Sikob}; 87103285Sikob 88103285Sikobstruct tcode_info { 89103285Sikob u_char hdr_len; /* IEEE1394 header length */ 90103285Sikob u_char flag; 91103285Sikob#define FWTI_REQ (1 << 0) 92103285Sikob#define FWTI_RES (1 << 1) 93103285Sikob#define FWTI_TLABEL (1 << 2) 94103285Sikob#define FWTI_BLOCK_STR (1 << 3) 95103285Sikob#define FWTI_BLOCK_ASY (1 << 4) 96103285Sikob}; 97103285Sikob 98103285Sikobstruct firewire_comm{ 99103285Sikob device_t dev; 100103285Sikob device_t bdev; 101103285Sikob u_int16_t busid:10, 102103285Sikob nodeid:6; 103103285Sikob u_int mode; 104103285Sikob u_int nport; 105103285Sikob u_int speed; 106103285Sikob u_int maxrec; 107103285Sikob u_int irm; 108103285Sikob u_int max_node; 109103285Sikob u_int max_hop; 110103285Sikob u_int max_asyretry; 111103285Sikob#define FWPHYASYST (1 << 0) 112103285Sikob u_int retry_count; 113103285Sikob u_int32_t ongobus:10, 114103285Sikob ongonode:6, 115103285Sikob ongoaddr:16; 116103285Sikob struct fw_device *ongodev; 117103285Sikob struct fw_eui64 ongoeui; 118103285Sikob#define FWMAXCSRDIR 16 119103285Sikob SLIST_HEAD(, csrdir) ongocsr; 120103285Sikob SLIST_HEAD(, csrdir) csrfree; 121103285Sikob u_int32_t status; 122116978Ssimokawa#define FWBUSNOTREADY (-1) 123103285Sikob#define FWBUSRESET 0 124103285Sikob#define FWBUSINIT 1 125103285Sikob#define FWBUSCYMELECT 2 126103285Sikob#define FWBUSMGRELECT 3 127103285Sikob#define FWBUSMGRDONE 4 128103285Sikob#define FWBUSEXPLORE 5 129103285Sikob#define FWBUSPHYCONF 6 130103285Sikob#define FWBUSEXPDONE 7 131103285Sikob#define FWBUSCOMPLETION 10 132103285Sikob int nisodma; 133109814Ssimokawa struct fw_eui64 eui; 134103285Sikob struct fw_xferq 135103285Sikob *arq, *atq, *ars, *ats, *it[FW_MAX_DMACH],*ir[FW_MAX_DMACH]; 136103285Sikob STAILQ_HEAD(, tlabel) tlabels[0x40]; 137103285Sikob STAILQ_HEAD(, fw_bind) binds; 138110193Ssimokawa STAILQ_HEAD(, fw_device) devices; 139103285Sikob STAILQ_HEAD(, fw_xfer) pending; 140103285Sikob u_int sid_cnt; 141103285Sikob#define CSRSIZE 0x4000 142103285Sikob u_int32_t csr_arc[CSRSIZE/4]; 143103285Sikob#define CROMSIZE 0x400 144103285Sikob u_int32_t *config_rom; 145116376Ssimokawa struct crom_src_buf *crom_src_buf; 146116376Ssimokawa struct crom_src *crom_src; 147116376Ssimokawa struct crom_chunk *crom_root; 148103285Sikob struct fw_topology_map *topology_map; 149103285Sikob struct fw_speed_map *speed_map; 150108853Ssimokawa struct callout busprobe_callout; 151110193Ssimokawa struct callout bmr_callout; 152110193Ssimokawa struct callout timeout_callout; 153110193Ssimokawa struct callout retry_probe_callout; 154103285Sikob u_int32_t (*cyctimer) __P((struct firewire_comm *)); 155103285Sikob void (*ibr) __P((struct firewire_comm *)); 156103285Sikob u_int32_t (*set_bmr) __P((struct firewire_comm *, u_int32_t)); 157103285Sikob int (*ioctl) __P((dev_t, u_long, caddr_t, int, fw_proc *)); 158103285Sikob int (*irx_enable) __P((struct firewire_comm *, int)); 159103285Sikob int (*irx_disable) __P((struct firewire_comm *, int)); 160103285Sikob int (*itx_enable) __P((struct firewire_comm *, int)); 161103285Sikob int (*itx_disable) __P((struct firewire_comm *, int)); 162103285Sikob void (*timeout) __P((void *)); 163103285Sikob void (*poll) __P((struct firewire_comm *, int, int)); 164103285Sikob void (*set_intr) __P((struct firewire_comm *, int)); 165103285Sikob void (*irx_post) __P((struct firewire_comm *, u_int32_t *)); 166103285Sikob void (*itx_post) __P((struct firewire_comm *, u_int32_t *)); 167103285Sikob struct tcode_info *tcode; 168113584Ssimokawa bus_dma_tag_t dmat; 169103285Sikob}; 170103285Sikob#define CSRARC(sc, offset) ((sc)->csr_arc[(offset)/4]) 171103285Sikob 172109645Ssimokawastruct csrdir{ 173109645Ssimokawa u_int32_t ongoaddr; 174109645Ssimokawa u_int32_t off; 175109645Ssimokawa SLIST_ENTRY(csrdir) link; 176109645Ssimokawa}; 177103285Sikob 178109645Ssimokawastruct fw_xferq { 179109645Ssimokawa int flag; 180109645Ssimokawa#define FWXFERQ_CHTAGMASK 0xff 181109645Ssimokawa#define FWXFERQ_RUNNING (1 << 8) 182109645Ssimokawa#define FWXFERQ_STREAM (1 << 9) 183109645Ssimokawa 184109645Ssimokawa#define FWXFERQ_BULK (1 << 11) 185109645Ssimokawa#define FWXFERQ_MODEMASK (7 << 10) 186109645Ssimokawa 187109645Ssimokawa#define FWXFERQ_EXTBUF (1 << 13) 188109645Ssimokawa#define FWXFERQ_OPEN (1 << 14) 189109645Ssimokawa 190109645Ssimokawa#define FWXFERQ_HANDLER (1 << 16) 191109645Ssimokawa#define FWXFERQ_WAKEUP (1 << 17) 192109645Ssimokawa void (*start) __P((struct firewire_comm*)); 193118293Ssimokawa int dmach; 194113584Ssimokawa STAILQ_HEAD(, fw_xfer) q; 195109645Ssimokawa u_int queued; 196109645Ssimokawa u_int maxq; 197109645Ssimokawa u_int psize; 198109645Ssimokawa STAILQ_HEAD(, fw_bind) binds; 199113584Ssimokawa struct fwdma_alloc_multi *buf; 200109645Ssimokawa u_int bnchunk; 201109645Ssimokawa u_int bnpacket; 202109645Ssimokawa struct fw_bulkxfer *bulkxfer; 203109645Ssimokawa STAILQ_HEAD(, fw_bulkxfer) stvalid; 204109645Ssimokawa STAILQ_HEAD(, fw_bulkxfer) stfree; 205109890Ssimokawa STAILQ_HEAD(, fw_bulkxfer) stdma; 206109645Ssimokawa struct fw_bulkxfer *stproc; 207109645Ssimokawa struct selinfo rsel; 208109645Ssimokawa caddr_t sc; 209109645Ssimokawa void (*hand) __P((struct fw_xferq *)); 210109645Ssimokawa}; 211109645Ssimokawa 212109645Ssimokawastruct fw_bulkxfer{ 213113584Ssimokawa int poffset; 214111942Ssimokawa struct mbuf *mbuf; 215109645Ssimokawa STAILQ_ENTRY(fw_bulkxfer) link; 216109645Ssimokawa caddr_t start; 217109645Ssimokawa caddr_t end; 218111942Ssimokawa int resp; 219109645Ssimokawa}; 220109645Ssimokawa 221109645Ssimokawastruct tlabel{ 222109645Ssimokawa struct fw_xfer *xfer; 223109645Ssimokawa STAILQ_ENTRY(tlabel) link; 224109645Ssimokawa}; 225109645Ssimokawa 226109645Ssimokawastruct fw_bind{ 227120660Ssimokawa u_int64_t start; 228120660Ssimokawa u_int64_t end; 229113584Ssimokawa STAILQ_HEAD(, fw_xfer) xferlist; 230109645Ssimokawa STAILQ_ENTRY(fw_bind) fclist; 231109645Ssimokawa STAILQ_ENTRY(fw_bind) chlist; 232113584Ssimokawa#define FWACT_NULL 0 233113584Ssimokawa#define FWACT_XFER 2 234113584Ssimokawa#define FWACT_CH 3 235113584Ssimokawa u_int8_t act_type; 236113584Ssimokawa u_int8_t sub; 237109645Ssimokawa}; 238109645Ssimokawa 239103285Sikobstruct fw_xfer{ 240103285Sikob caddr_t sc; 241103285Sikob struct firewire_comm *fc; 242103285Sikob struct fw_xferq *q; 243110577Ssimokawa struct timeval tv; 244113584Ssimokawa int8_t resp; 245103285Sikob#define FWXF_INIT 0 246103285Sikob#define FWXF_INQ 1 247103285Sikob#define FWXF_START 2 248103285Sikob#define FWXF_SENT 3 249103285Sikob#define FWXF_SENTERR 4 250103285Sikob#define FWXF_BUSY 8 251103285Sikob#define FWXF_RCVD 10 252113584Ssimokawa u_int8_t state; 253103285Sikob u_int8_t retry; 254103285Sikob u_int8_t tl; 255103285Sikob void (*retry_req) __P((struct fw_xfer *)); 256103285Sikob union{ 257103285Sikob void (*hand) __P((struct fw_xfer *)); 258103285Sikob } act; 259103285Sikob struct { 260120660Ssimokawa struct fw_pkt hdr; 261120660Ssimokawa u_int32_t *payload; 262120660Ssimokawa u_int16_t pay_len; 263120660Ssimokawa u_int8_t spd; 264103285Sikob } send, recv; 265103285Sikob struct mbuf *mbuf; 266103285Sikob STAILQ_ENTRY(fw_xfer) link; 267110269Ssimokawa struct malloc_type *malloc; 268103285Sikob}; 269120660Ssimokawa 270120660Ssimokawastruct fw_rcv_buf { 271120660Ssimokawa struct firewire_comm *fc; 272120660Ssimokawa struct fw_xfer *xfer; 273120660Ssimokawa struct iovec *vec; 274120660Ssimokawa u_int nvec; 275120660Ssimokawa u_int8_t spd; 276120660Ssimokawa}; 277120660Ssimokawa 278113584Ssimokawavoid fw_sidrcv __P((struct firewire_comm *, u_int32_t *, u_int)); 279120660Ssimokawavoid fw_rcv __P((struct fw_rcv_buf *)); 280113584Ssimokawavoid fw_xfer_unload __P(( struct fw_xfer*)); 281120660Ssimokawavoid fw_xfer_free_buf __P(( struct fw_xfer*)); 282103285Sikobvoid fw_xfer_free __P(( struct fw_xfer*)); 283110269Ssimokawastruct fw_xfer *fw_xfer_alloc __P((struct malloc_type *)); 284113584Ssimokawastruct fw_xfer *fw_xfer_alloc_buf __P((struct malloc_type *, int, int)); 285103285Sikobvoid fw_init __P((struct firewire_comm *)); 286103285Sikobint fw_tbuf_update __P((struct firewire_comm *, int, int)); 287103285Sikobint fw_rbuf_update __P((struct firewire_comm *, int, int)); 288103285Sikobvoid fw_asybusy __P((struct fw_xfer *)); 289103285Sikobint fw_bindadd __P((struct firewire_comm *, struct fw_bind *)); 290103285Sikobint fw_bindremove __P((struct firewire_comm *, struct fw_bind *)); 291103285Sikobint fw_asyreq __P((struct firewire_comm *, int, struct fw_xfer*)); 292103285Sikobvoid fw_busreset __P((struct firewire_comm *)); 293103285Sikobu_int16_t fw_crc16 __P((u_int32_t *, u_int32_t)); 294103285Sikobvoid fw_xfer_timeout __P((void *)); 295103285Sikobvoid fw_xfer_done __P((struct fw_xfer *)); 296103285Sikobvoid fw_asy_callback __P((struct fw_xfer *)); 297120660Ssimokawavoid fw_asy_callback_free __P((struct fw_xfer *)); 298110072Ssimokawastruct fw_device *fw_noderesolve_nodeid __P((struct firewire_comm *, int)); 299110582Ssimokawastruct fw_device *fw_noderesolve_eui64 __P((struct firewire_comm *, struct fw_eui64 *)); 300120660Ssimokawastruct fw_bind *fw_bindlookup __P((struct firewire_comm *, u_int16_t, u_int32_t)); 301110798Ssimokawavoid fw_drain_txq __P((struct firewire_comm *)); 302118455Ssimokawaint fwdev_makedev __P((struct firewire_softc *)); 303118455Ssimokawaint fwdev_destroydev __P((struct firewire_softc *)); 304118455Ssimokawavoid fwdev_clone __P((void *, char *, int, dev_t *)); 305103285Sikob 306103285Sikobextern int firewire_debug; 307103285Sikobextern devclass_t firewire_devclass; 308103285Sikob 309103285Sikob#define FWPRI ((PZERO+8)|PCATCH) 310103285Sikob 311111615Ssimokawa#if __FreeBSD_version >= 500000 312111615Ssimokawa#define CALLOUT_INIT(x) callout_init(x, 0 /* mpsafe */) 313111615Ssimokawa#else 314111615Ssimokawa#define CALLOUT_INIT(x) callout_init(x) 315111615Ssimokawa#endif 316111615Ssimokawa 317120660Ssimokawa#if __FreeBSD_version < 500000 318120660Ssimokawa/* compatibility shim for 4.X */ 319120660Ssimokawa#define bio buf 320120660Ssimokawa#define bio_bcount b_bcount 321120660Ssimokawa#define bio_cmd b_flags 322120660Ssimokawa#define bio_count b_count 323120660Ssimokawa#define bio_data b_data 324120660Ssimokawa#define bio_dev b_dev 325120660Ssimokawa#define bio_error b_error 326120660Ssimokawa#define bio_flags b_flags 327120660Ssimokawa#define bio_offset b_offset 328120660Ssimokawa#define bio_resid b_resid 329120660Ssimokawa#define BIO_ERROR B_ERROR 330120660Ssimokawa#define BIO_READ B_READ 331120660Ssimokawa#define BIO_WRITE B_WRITE 332120660Ssimokawa#define MIN(a,b) (((a)<(b))?(a):(b)) 333121780Ssimokawa#define MAX(a,b) (((a)>(b))?(a):(b)) 334120660Ssimokawa#endif 335120660Ssimokawa 336110195SsimokawaMALLOC_DECLARE(M_FW); 337110269SsimokawaMALLOC_DECLARE(M_FWXFER); 338