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>
50 #include <sys/mutex.h>
51 #include <sys/taskqueue.h>
55 STAILQ_HEAD(fw_xferlist, fw_xfer);
64 #define CSRROMOFF 0x400
65 #define CSRROMSIZE 0x400
66 int rommax; /* offset from 0xffff f000 0000 */
67 uint32_t csrrom[CSRROMSIZE/4];
69 struct firewire_comm *fc;
72 #define FWDEVATTACHED 2
74 STAILQ_ENTRY(fw_device) link;
77 struct firewire_softc {
78 #if defined(__FreeBSD__) && __FreeBSD_version >= 500000
81 struct firewire_comm *fc;
84 #define FW_MAX_DMACH 0x20
85 #define FW_MAX_DEVCH FW_MAX_DMACH
86 #define FW_XFERTIMEOUT 1
88 struct firewire_dev_comm {
90 struct firewire_comm *fc;
91 void (*post_busreset) (void *);
92 void (*post_explore) (void *);
96 u_char hdr_len; /* IEEE1394 header length */
98 #define FWTI_REQ (1 << 0)
99 #define FWTI_RES (1 << 1)
100 #define FWTI_TLABEL (1 << 2)
101 #define FWTI_BLOCK_STR (1 << 3)
102 #define FWTI_BLOCK_ASY (1 << 4)
106 struct firewire_comm{
118 #define FWPHYASYST (1 << 0)
120 #define FWBUSDETACH (-2)
121 #define FWBUSNOTREADY (-1)
124 #define FWBUSCYMELECT 2
125 #define FWBUSMGRELECT 3
126 #define FWBUSMGRDONE 4
127 #define FWBUSEXPLORE 5
128 #define FWBUSPHYCONF 6
129 #define FWBUSEXPDONE 7
130 #define FWBUSCOMPLETION 10
134 *arq, *atq, *ars, *ats, *it[FW_MAX_DMACH],*ir[FW_MAX_DMACH];
135 struct fw_xferlist tlabels[0x40];
136 STAILQ_HEAD(, fw_bind) binds;
137 STAILQ_HEAD(, fw_device) devices;
139 #define CSRSIZE 0x4000
140 uint32_t csr_arc[CSRSIZE/4];
141 #define CROMSIZE 0x400
142 uint32_t *config_rom;
143 struct crom_src_buf *crom_src_buf;
144 struct crom_src *crom_src;
145 struct crom_chunk *crom_root;
146 struct fw_topology_map *topology_map;
147 struct fw_speed_map *speed_map;
148 struct callout busprobe_callout;
149 struct callout bmr_callout;
150 struct callout timeout_callout;
151 struct task task_timeout;
152 uint32_t (*cyctimer) (struct firewire_comm *);
153 void (*ibr) (struct firewire_comm *);
154 uint32_t (*set_bmr) (struct firewire_comm *, uint32_t);
155 int (*ioctl) (struct cdev *, u_long, caddr_t, int, fw_proc *);
156 int (*irx_enable) (struct firewire_comm *, int);
157 int (*irx_disable) (struct firewire_comm *, int);
158 int (*itx_enable) (struct firewire_comm *, int);
159 int (*itx_disable) (struct firewire_comm *, int);
160 void (*timeout) (void *);
161 void (*poll) (struct firewire_comm *, int, int);
162 void (*set_intr) (struct firewire_comm *, int);
163 void (*irx_post) (struct firewire_comm *, uint32_t *);
164 void (*itx_post) (struct firewire_comm *, uint32_t *);
165 struct tcode_info *tcode;
168 struct mtx wait_lock;
169 struct taskqueue *taskqueue;
170 struct proc *probe_thread;
172 #define CSRARC(sc, offset) ((sc)->csr_arc[(offset)/4])
174 #define FW_GMTX(fc) (&(fc)->mtx)
175 #define FW_GLOCK(fc) mtx_lock(FW_GMTX(fc))
176 #define FW_GUNLOCK(fc) mtx_unlock(FW_GMTX(fc))
177 #define FW_GLOCK_ASSERT(fc) mtx_assert(FW_GMTX(fc), MA_OWNED)
181 #define FWXFERQ_CHTAGMASK 0xff
182 #define FWXFERQ_RUNNING (1 << 8)
183 #define FWXFERQ_STREAM (1 << 9)
185 #define FWXFERQ_BULK (1 << 11)
186 #define FWXFERQ_MODEMASK (7 << 10)
188 #define FWXFERQ_EXTBUF (1 << 13)
189 #define FWXFERQ_OPEN (1 << 14)
191 #define FWXFERQ_HANDLER (1 << 16)
192 #define FWXFERQ_WAKEUP (1 << 17)
193 void (*start) (struct firewire_comm*);
195 struct fw_xferlist q;
199 struct fwdma_alloc_multi *buf;
202 struct fw_bulkxfer *bulkxfer;
203 STAILQ_HEAD(, fw_bulkxfer) stvalid;
204 STAILQ_HEAD(, fw_bulkxfer) stfree;
205 STAILQ_HEAD(, fw_bulkxfer) stdma;
206 struct fw_bulkxfer *stproc;
209 void (*hand) (struct fw_xferq *);
215 STAILQ_ENTRY(fw_bulkxfer) link;
224 struct fw_xferlist xferlist;
225 STAILQ_ENTRY(fw_bind) fclist;
226 STAILQ_ENTRY(fw_bind) chlist;
232 struct firewire_comm *fc;
236 #define FWXF_INIT 0x00
237 #define FWXF_INQ 0x01
238 #define FWXF_START 0x02
239 #define FWXF_SENT 0x04
240 #define FWXF_SENTERR 0x08
241 #define FWXF_BUSY 0x10
242 #define FWXF_RCVD 0x20
244 #define FWXF_WAKE 0x80
247 void (*hand) (struct fw_xfer *);
255 STAILQ_ENTRY(fw_xfer) link;
256 STAILQ_ENTRY(fw_xfer) tlabel;
257 struct malloc_type *malloc;
261 struct firewire_comm *fc;
262 struct fw_xfer *xfer;
268 void fw_sidrcv (struct firewire_comm *, uint32_t *, u_int);
269 void fw_rcv (struct fw_rcv_buf *);
270 void fw_xfer_unload ( struct fw_xfer*);
271 void fw_xfer_free_buf ( struct fw_xfer*);
272 void fw_xfer_free ( struct fw_xfer*);
273 struct fw_xfer *fw_xfer_alloc (struct malloc_type *);
274 struct fw_xfer *fw_xfer_alloc_buf (struct malloc_type *, int, int);
275 void fw_init (struct firewire_comm *);
276 int fw_tbuf_update (struct firewire_comm *, int, int);
277 int fw_rbuf_update (struct firewire_comm *, int, int);
278 int fw_bindadd (struct firewire_comm *, struct fw_bind *);
279 int fw_bindremove (struct firewire_comm *, struct fw_bind *);
280 int fw_xferlist_add (struct fw_xferlist *, struct malloc_type *, int, int, int,
281 struct firewire_comm *, void *, void (*)(struct fw_xfer *));
282 void fw_xferlist_remove (struct fw_xferlist *);
283 int fw_asyreq (struct firewire_comm *, int, struct fw_xfer*);
284 void fw_busreset (struct firewire_comm *, uint32_t);
285 uint16_t fw_crc16 (uint32_t *, uint32_t);
286 void fw_xfer_timeout (void *);
287 void fw_xfer_done (struct fw_xfer *);
288 void fw_xferwake (struct fw_xfer *);
289 int fw_xferwait (struct fw_xfer *);
290 void fw_asy_callback_free (struct fw_xfer *);
291 struct fw_device *fw_noderesolve_nodeid (struct firewire_comm *, int);
292 struct fw_device *fw_noderesolve_eui64 (struct firewire_comm *, struct fw_eui64 *);
293 struct fw_bind *fw_bindlookup (struct firewire_comm *, uint16_t, uint32_t);
294 void fw_drain_txq (struct firewire_comm *);
295 int fwdev_makedev (struct firewire_softc *);
296 int fwdev_destroydev (struct firewire_softc *);
297 void fwdev_clone (void *, struct ucred *, char *, int, struct cdev **);
298 int fw_open_isodma(struct firewire_comm *, int);
300 extern int firewire_debug;
301 extern devclass_t firewire_devclass;
302 extern int firewire_phydma_enable;
307 #define FWPRI ((PZERO+8)|PCATCH)
310 #if defined(__DragonFly__) || __FreeBSD_version < 500000
311 #define CALLOUT_INIT(x) callout_init(x)
313 #define CALLOUT_INIT(x) callout_init(x, 1 /* mpsafe */)
316 #if defined(__DragonFly__) || __FreeBSD_version < 500000
317 /* compatibility shim for 4.X */
319 #define bio_bcount b_bcount
320 #define bio_cmd b_flags
321 #define bio_count b_count
322 #define bio_data b_data
323 #define bio_dev b_dev
324 #define bio_error b_error
325 #define bio_flags b_flags
326 #define bio_offset b_offset
327 #define bio_resid b_resid
328 #define BIO_ERROR B_ERROR
329 #define BIO_READ B_READ
330 #define BIO_WRITE B_WRITE
331 #define MIN(a,b) (((a)<(b))?(a):(b))
332 #define MAX(a,b) (((a)>(b))?(a):(b))
335 MALLOC_DECLARE(M_FW);
336 MALLOC_DECLARE(M_FWXFER);