2 * Copyright (c) 2003 Hidetoshi Shimokawa
3 * Copyright (c) 1998-2002 Katsushi Kobayashi and Hidetoshi Shimokawa
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
14 * 3. All advertising materials mentioning features or use of this software
15 * must display the acknowledgement as bellow:
17 * This product includes software developed by K. Kobayashi and H. Shimokawa
19 * 4. The name of the author may not be used to endorse or promote products
20 * derived from this software without specific prior written permission.
22 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
23 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
24 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
25 * DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
26 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
27 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
28 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
30 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
31 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
32 * POSSIBILITY OF SUCH DAMAGE.
34 * $FreeBSD: src/sys/dev/firewire/firewirereg.h,v 1.1.2.14 2003/05/01 06:24:37 simokawa Exp $
35 * $DragonFly: src/sys/bus/firewire/firewirereg.h,v 1.5 2003/08/27 11:42:34 rob Exp $
39 #if __FreeBSD_version >= 500000
40 typedef struct thread fw_proc;
41 #include <sys/selinfo.h>
43 typedef struct thread fw_proc;
44 #include <sys/select.h>
58 #define CSRROMOFF 0x400
59 #define CSRROMSIZE 0x400
60 int rommax; /* offset from 0xffff f000 0000 */
61 u_int32_t csrrom[CSRROMSIZE/4];
63 struct firewire_comm *fc;
66 #define FWDEVATTACHED 2
68 STAILQ_ENTRY(fw_device) link;
71 struct firewire_softc {
72 #if __FreeBSD_version >= 500000
75 dev_t dev[FWMAXNDMA+1];
77 struct firewire_comm *fc;
80 #define FW_MAX_DMACH 0x20
81 #define FW_MAX_DEVCH FW_MAX_DMACH
82 #define FW_XFERTIMEOUT 1
84 struct firewire_dev_comm {
86 struct firewire_comm *fc;
87 void (*post_busreset) (void *);
88 void (*post_explore) (void *);
92 u_char hdr_len; /* IEEE1394 header length */
94 #define FWTI_REQ (1 << 0)
95 #define FWTI_RES (1 << 1)
96 #define FWTI_TLABEL (1 << 2)
97 #define FWTI_BLOCK_STR (1 << 3)
98 #define FWTI_BLOCK_ASY (1 << 4)
101 struct firewire_comm{
114 #define FWPHYASYST (1 << 0)
116 u_int32_t ongobus:10,
119 struct fw_device *ongodev;
120 struct fw_eui64 ongoeui;
121 #define FWMAXCSRDIR 16
122 SLIST_HEAD(, csrdir) ongocsr;
123 SLIST_HEAD(, csrdir) csrfree;
127 #define FWBUSCYMELECT 2
128 #define FWBUSMGRELECT 3
129 #define FWBUSMGRDONE 4
130 #define FWBUSEXPLORE 5
131 #define FWBUSPHYCONF 6
132 #define FWBUSEXPDONE 7
133 #define FWBUSCOMPLETION 10
137 *arq, *atq, *ars, *ats, *it[FW_MAX_DMACH],*ir[FW_MAX_DMACH];
138 STAILQ_HEAD(, tlabel) tlabels[0x40];
139 STAILQ_HEAD(, fw_bind) binds;
140 STAILQ_HEAD(, fw_device) devices;
141 STAILQ_HEAD(, fw_xfer) pending;
143 #define CSRSIZE 0x4000
144 u_int32_t csr_arc[CSRSIZE/4];
145 #define CROMSIZE 0x400
146 u_int32_t *config_rom;
147 struct fw_topology_map *topology_map;
148 struct fw_speed_map *speed_map;
149 struct callout busprobe_callout;
150 struct callout bmr_callout;
151 struct callout timeout_callout;
152 struct callout retry_probe_callout;
153 u_int32_t (*cyctimer) (struct firewire_comm *);
154 void (*ibr) (struct firewire_comm *);
155 u_int32_t (*set_bmr) (struct firewire_comm *, u_int32_t);
156 int (*ioctl) (dev_t, u_long, caddr_t, int, fw_proc *);
157 int (*irx_enable) (struct firewire_comm *, int);
158 int (*irx_disable) (struct firewire_comm *, int);
159 int (*itx_enable) (struct firewire_comm *, int);
160 int (*itx_disable) (struct firewire_comm *, int);
161 void (*timeout) (void *);
162 void (*poll) (struct firewire_comm *, int, int);
163 void (*set_intr) (struct firewire_comm *, int);
164 void (*irx_post) (struct firewire_comm *, u_int32_t *);
165 void (*itx_post) (struct firewire_comm *, u_int32_t *);
166 struct tcode_info *tcode;
169 #define CSRARC(sc, offset) ((sc)->csr_arc[(offset)/4])
174 SLIST_ENTRY(csrdir) link;
179 #define FWXFERQ_CHTAGMASK 0xff
180 #define FWXFERQ_RUNNING (1 << 8)
181 #define FWXFERQ_STREAM (1 << 9)
183 #define FWXFERQ_BULK (1 << 11)
184 #define FWXFERQ_MODEMASK (7 << 10)
186 #define FWXFERQ_EXTBUF (1 << 13)
187 #define FWXFERQ_OPEN (1 << 14)
189 #define FWXFERQ_HANDLER (1 << 16)
190 #define FWXFERQ_WAKEUP (1 << 17)
192 void (*start) (struct firewire_comm*);
193 STAILQ_HEAD(, fw_xfer) q;
197 STAILQ_HEAD(, fw_bind) binds;
198 struct fwdma_alloc_multi *buf;
201 struct fw_bulkxfer *bulkxfer;
202 STAILQ_HEAD(, fw_bulkxfer) stvalid;
203 STAILQ_HEAD(, fw_bulkxfer) stfree;
204 STAILQ_HEAD(, fw_bulkxfer) stdma;
205 struct fw_bulkxfer *stproc;
208 void (*hand) (struct fw_xferq *);
214 STAILQ_ENTRY(fw_bulkxfer) link;
221 struct fw_xfer *xfer;
222 STAILQ_ENTRY(tlabel) link;
226 u_int32_t start_hi, start_lo, addrlen;
227 STAILQ_HEAD(, fw_xfer) xferlist;
228 STAILQ_ENTRY(fw_bind) fclist;
229 STAILQ_ENTRY(fw_bind) chlist;
239 struct firewire_comm *fc;
242 /* XXX should be removed */
243 u_int32_t dst; /* XXX for if_fwe */
250 #define FWXF_SENTERR 4
256 void (*retry_req) (struct fw_xfer *);
258 void (*hand) (struct fw_xfer *);
265 STAILQ_ENTRY(fw_xfer) link;
266 struct malloc_type *malloc;
268 void fw_sidrcv (struct firewire_comm *, u_int32_t *, u_int);
269 void fw_rcv (struct firewire_comm *, struct iovec *, int, u_int, u_int);
270 void fw_xfer_unload ( struct fw_xfer*);
271 void fw_xfer_free ( struct fw_xfer*);
272 struct fw_xfer *fw_xfer_alloc (struct malloc_type *);
273 struct fw_xfer *fw_xfer_alloc_buf (struct malloc_type *, int, int);
274 void fw_init (struct firewire_comm *);
275 int fw_tbuf_update (struct firewire_comm *, int, int);
276 int fw_rbuf_update (struct firewire_comm *, int, int);
277 void fw_asybusy (struct fw_xfer *);
278 int fw_bindadd (struct firewire_comm *, struct fw_bind *);
279 int fw_bindremove (struct firewire_comm *, struct fw_bind *);
280 int fw_asyreq (struct firewire_comm *, int, struct fw_xfer*);
281 void fw_busreset (struct firewire_comm *);
282 u_int16_t fw_crc16 (u_int32_t *, u_int32_t);
283 void fw_xfer_timeout (void *);
284 void fw_xfer_done (struct fw_xfer *);
285 void fw_asy_callback (struct fw_xfer *);
286 struct fw_device *fw_noderesolve_nodeid (struct firewire_comm *, int);
287 struct fw_device *fw_noderesolve_eui64 (struct firewire_comm *, struct fw_eui64 *);
288 struct fw_bind *fw_bindlookup (struct firewire_comm *, u_int32_t, u_int32_t);
289 void fw_drain_txq (struct firewire_comm *);
292 extern int firewire_debug;
293 extern devclass_t firewire_devclass;
297 #if __FreeBSD_version >= 500000
298 #define CALLOUT_INIT(x) callout_init(x, 0 /* mpsafe */)
300 #define CALLOUT_INIT(x) callout_init(x)
303 MALLOC_DECLARE(M_FW);
304 MALLOC_DECLARE(M_FWXFER);