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.
39 typedef d_thread_t fw_proc;
40 #include <sys/select.h>
41 #elif __FreeBSD_version >= 500000
42 typedef struct thread fw_proc;
43 #include <sys/selinfo.h>
45 typedef struct proc fw_proc;
46 #include <sys/select.h>
53 STAILQ_HEAD(fw_xferlist, fw_xfer);
62 #define CSRROMOFF 0x400
63 #define CSRROMSIZE 0x400
64 int rommax; /* offset from 0xffff f000 0000 */
65 uint32_t csrrom[CSRROMSIZE/4];
67 struct firewire_comm *fc;
70 #define FWDEVATTACHED 2
72 STAILQ_ENTRY(fw_device) link;
75 struct firewire_softc {
76 #if defined(__FreeBSD__) && __FreeBSD_version >= 500000
79 struct firewire_comm *fc;
82 #define FW_MAX_DMACH 0x20
83 #define FW_MAX_DEVCH FW_MAX_DMACH
84 #define FW_XFERTIMEOUT 1
86 struct firewire_dev_comm {
88 struct firewire_comm *fc;
89 void (*post_busreset) (void *);
90 void (*post_explore) (void *);
94 u_char hdr_len; /* IEEE1394 header length */
96 #define FWTI_REQ (1 << 0)
97 #define FWTI_RES (1 << 1)
98 #define FWTI_TLABEL (1 << 2)
99 #define FWTI_BLOCK_STR (1 << 3)
100 #define FWTI_BLOCK_ASY (1 << 4)
103 struct firewire_comm{
115 #define FWPHYASYST (1 << 0)
117 #define FWBUSDETACH (-2)
118 #define FWBUSNOTREADY (-1)
121 #define FWBUSCYMELECT 2
122 #define FWBUSMGRELECT 3
123 #define FWBUSMGRDONE 4
124 #define FWBUSEXPLORE 5
125 #define FWBUSPHYCONF 6
126 #define FWBUSEXPDONE 7
127 #define FWBUSCOMPLETION 10
131 *arq, *atq, *ars, *ats, *it[FW_MAX_DMACH],*ir[FW_MAX_DMACH];
132 struct fw_xferlist tlabels[0x40];
133 STAILQ_HEAD(, fw_bind) binds;
134 STAILQ_HEAD(, fw_device) devices;
136 #define CSRSIZE 0x4000
137 uint32_t csr_arc[CSRSIZE/4];
138 #define CROMSIZE 0x400
139 uint32_t *config_rom;
140 struct crom_src_buf *crom_src_buf;
141 struct crom_src *crom_src;
142 struct crom_chunk *crom_root;
143 struct fw_topology_map *topology_map;
144 struct fw_speed_map *speed_map;
145 struct callout busprobe_callout;
146 struct callout bmr_callout;
147 struct callout timeout_callout;
148 uint32_t (*cyctimer) (struct firewire_comm *);
149 void (*ibr) (struct firewire_comm *);
150 uint32_t (*set_bmr) (struct firewire_comm *, uint32_t);
151 int (*ioctl) (struct cdev *, u_long, caddr_t, int, fw_proc *);
152 int (*irx_enable) (struct firewire_comm *, int);
153 int (*irx_disable) (struct firewire_comm *, int);
154 int (*itx_enable) (struct firewire_comm *, int);
155 int (*itx_disable) (struct firewire_comm *, int);
156 void (*timeout) (void *);
157 void (*poll) (struct firewire_comm *, int, int);
158 void (*set_intr) (struct firewire_comm *, int);
159 void (*irx_post) (struct firewire_comm *, uint32_t *);
160 void (*itx_post) (struct firewire_comm *, uint32_t *);
161 struct tcode_info *tcode;
164 #define CSRARC(sc, offset) ((sc)->csr_arc[(offset)/4])
168 #define FWXFERQ_CHTAGMASK 0xff
169 #define FWXFERQ_RUNNING (1 << 8)
170 #define FWXFERQ_STREAM (1 << 9)
172 #define FWXFERQ_BULK (1 << 11)
173 #define FWXFERQ_MODEMASK (7 << 10)
175 #define FWXFERQ_EXTBUF (1 << 13)
176 #define FWXFERQ_OPEN (1 << 14)
178 #define FWXFERQ_HANDLER (1 << 16)
179 #define FWXFERQ_WAKEUP (1 << 17)
180 void (*start) (struct firewire_comm*);
182 struct fw_xferlist q;
186 struct fwdma_alloc_multi *buf;
189 struct fw_bulkxfer *bulkxfer;
190 STAILQ_HEAD(, fw_bulkxfer) stvalid;
191 STAILQ_HEAD(, fw_bulkxfer) stfree;
192 STAILQ_HEAD(, fw_bulkxfer) stdma;
193 struct fw_bulkxfer *stproc;
196 void (*hand) (struct fw_xferq *);
202 STAILQ_ENTRY(fw_bulkxfer) link;
211 struct fw_xferlist xferlist;
212 STAILQ_ENTRY(fw_bind) fclist;
213 STAILQ_ENTRY(fw_bind) chlist;
219 struct firewire_comm *fc;
227 #define FWXF_SENTERR 4
232 void (*hand) (struct fw_xfer *);
240 STAILQ_ENTRY(fw_xfer) link;
241 STAILQ_ENTRY(fw_xfer) tlabel;
242 struct malloc_type *malloc;
246 struct firewire_comm *fc;
247 struct fw_xfer *xfer;
253 void fw_sidrcv (struct firewire_comm *, uint32_t *, u_int);
254 void fw_rcv (struct fw_rcv_buf *);
255 void fw_xfer_unload ( struct fw_xfer*);
256 void fw_xfer_free_buf ( struct fw_xfer*);
257 void fw_xfer_free ( struct fw_xfer*);
258 struct fw_xfer *fw_xfer_alloc (struct malloc_type *);
259 struct fw_xfer *fw_xfer_alloc_buf (struct malloc_type *, int, int);
260 void fw_init (struct firewire_comm *);
261 int fw_tbuf_update (struct firewire_comm *, int, int);
262 int fw_rbuf_update (struct firewire_comm *, int, int);
263 int fw_bindadd (struct firewire_comm *, struct fw_bind *);
264 int fw_bindremove (struct firewire_comm *, struct fw_bind *);
265 int fw_xferlist_add (struct fw_xferlist *, struct malloc_type *, int, int, int,
266 struct firewire_comm *, void *, void (*)(struct fw_xfer *));
267 void fw_xferlist_remove (struct fw_xferlist *);
268 int fw_asyreq (struct firewire_comm *, int, struct fw_xfer*);
269 void fw_busreset (struct firewire_comm *, uint32_t);
270 uint16_t fw_crc16 (uint32_t *, uint32_t);
271 void fw_xfer_timeout (void *);
272 void fw_xfer_done (struct fw_xfer *);
273 void fw_asy_callback (struct fw_xfer *);
274 void fw_asy_callback_free (struct fw_xfer *);
275 struct fw_device *fw_noderesolve_nodeid (struct firewire_comm *, int);
276 struct fw_device *fw_noderesolve_eui64 (struct firewire_comm *, struct fw_eui64 *);
277 struct fw_bind *fw_bindlookup (struct firewire_comm *, uint16_t, uint32_t);
278 void fw_drain_txq (struct firewire_comm *);
279 int fwdev_makedev (struct firewire_softc *);
280 int fwdev_destroydev (struct firewire_softc *);
281 void fwdev_clone (void *, struct ucred *, char *, int, struct cdev **);
283 extern int firewire_debug;
284 extern devclass_t firewire_devclass;
289 #define FWPRI ((PZERO+8)|PCATCH)
292 #if defined(__DragonFly__) || __FreeBSD_version < 500000
293 #define CALLOUT_INIT(x) callout_init(x)
295 #define CALLOUT_INIT(x) callout_init(x, 0 /* mpsafe */)
298 #if defined(__DragonFly__) || __FreeBSD_version < 500000
299 /* compatibility shim for 4.X */
301 #define bio_bcount b_bcount
302 #define bio_cmd b_flags
303 #define bio_count b_count
304 #define bio_data b_data
305 #define bio_dev b_dev
306 #define bio_error b_error
307 #define bio_flags b_flags
308 #define bio_offset b_offset
309 #define bio_resid b_resid
310 #define BIO_ERROR B_ERROR
311 #define BIO_READ B_READ
312 #define BIO_WRITE B_WRITE
313 #define MIN(a,b) (((a)<(b))?(a):(b))
314 #define MAX(a,b) (((a)>(b))?(a):(b))
317 MALLOC_DECLARE(M_FW);
318 MALLOC_DECLARE(M_FWXFER);