firewirereg.h revision 169130 
1/*-
2 * Copyright (c) 2003 Hidetoshi Shimokawa
3 * Copyright (c) 1998-2002 Katsushi Kobayashi and Hidetoshi Shimokawa
4 * All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
8 * are met:
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:
16 *
17 *    This product includes software developed by K. Kobayashi and H. Shimokawa
18 *
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.
21 *
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.
33 *
34 * $FreeBSD: head/sys/dev/firewire/firewirereg.h 169130 2007-04-30 13:41:40Z simokawa $
35 *
36 */
37
38#ifdef __DragonFly__
39typedef	d_thread_t fw_proc;
40#include <sys/select.h>
41#elif __FreeBSD_version >= 500000
42typedef	struct thread fw_proc;
43#include <sys/selinfo.h>
44#else
45typedef	struct proc fw_proc;
46#include <sys/select.h>
47#endif
48
49#include <sys/uio.h>
50
51#define	splfw splimp
52
53STAILQ_HEAD(fw_xferlist, fw_xfer);
54
55struct fw_device{
56	uint16_t dst;
57	struct fw_eui64 eui;
58	uint8_t speed;
59	uint8_t maxrec;
60	uint8_t nport;
61	uint8_t power;
62#define CSRROMOFF 0x400
63#define CSRROMSIZE 0x400
64	int rommax;	/* offset from 0xffff f000 0000 */
65	uint32_t csrrom[CSRROMSIZE/4];
66	int rcnt;
67	struct firewire_comm *fc;
68	uint32_t status;
69#define FWDEVINIT	1
70#define FWDEVATTACHED	2
71#define FWDEVINVAL	3
72	STAILQ_ENTRY(fw_device) link;
73};
74
75struct firewire_softc {
76#if defined(__FreeBSD__) && __FreeBSD_version >= 500000
77	struct cdev *dev;
78#endif
79	struct firewire_comm *fc;
80};
81
82#define FW_MAX_DMACH 0x20
83#define FW_MAX_DEVCH FW_MAX_DMACH
84#define FW_XFERTIMEOUT 1
85
86struct firewire_dev_comm {
87	device_t dev;
88	struct firewire_comm *fc;
89	void (*post_busreset) (void *);
90	void (*post_explore) (void *);
91};
92
93struct tcode_info {
94	u_char hdr_len;	/* IEEE1394 header length */
95	u_char flag;
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)
101};
102
103struct firewire_comm{
104	device_t dev;
105	device_t bdev;
106	uint16_t busid:10,
107		  nodeid:6;
108	u_int mode;
109	u_int nport;
110	u_int speed;
111	u_int maxrec;
112	u_int irm;
113	u_int max_node;
114	u_int max_hop;
115#define FWPHYASYST (1 << 0)
116	uint32_t ongobus:10,
117		  ongonode:6,
118		  ongoaddr:16;
119	struct fw_device *ongodev;
120	struct fw_eui64 ongoeui;
121#define	FWMAXCSRDIR     16
122	SLIST_HEAD(, csrdir) ongocsr;
123	SLIST_HEAD(, csrdir) csrfree;
124	uint32_t status;
125#define	FWBUSNOTREADY	(-1)
126#define	FWBUSRESET	0
127#define	FWBUSINIT	1
128#define	FWBUSCYMELECT	2
129#define	FWBUSMGRELECT	3
130#define	FWBUSMGRDONE	4
131#define	FWBUSEXPLORE	5
132#define	FWBUSPHYCONF	6
133#define	FWBUSEXPDONE	7
134#define	FWBUSCOMPLETION	10
135	int nisodma;
136	struct fw_eui64 eui;
137	struct fw_xferq
138		*arq, *atq, *ars, *ats, *it[FW_MAX_DMACH],*ir[FW_MAX_DMACH];
139	struct fw_xferlist tlabels[0x40];
140	STAILQ_HEAD(, fw_bind) binds;
141	STAILQ_HEAD(, fw_device) devices;
142	u_int  sid_cnt;
143#define CSRSIZE 0x4000
144	uint32_t csr_arc[CSRSIZE/4];
145#define CROMSIZE 0x400
146	uint32_t *config_rom;
147	struct crom_src_buf *crom_src_buf;
148	struct crom_src *crom_src;
149	struct crom_chunk *crom_root;
150	struct fw_topology_map *topology_map;
151	struct fw_speed_map *speed_map;
152	struct callout busprobe_callout;
153	struct callout bmr_callout;
154	struct callout timeout_callout;
155	uint32_t (*cyctimer) (struct  firewire_comm *);
156	void (*ibr) (struct firewire_comm *);
157	uint32_t (*set_bmr) (struct firewire_comm *, uint32_t);
158	int (*ioctl) (struct cdev *, u_long, caddr_t, int, fw_proc *);
159	int (*irx_enable) (struct firewire_comm *, int);
160	int (*irx_disable) (struct firewire_comm *, int);
161	int (*itx_enable) (struct firewire_comm *, int);
162	int (*itx_disable) (struct firewire_comm *, int);
163	void (*timeout) (void *);
164	void (*poll) (struct firewire_comm *, int, int);
165	void (*set_intr) (struct firewire_comm *, int);
166	void (*irx_post) (struct firewire_comm *, uint32_t *);
167	void (*itx_post) (struct firewire_comm *, uint32_t *);
168	struct tcode_info *tcode;
169	bus_dma_tag_t dmat;
170};
171#define CSRARC(sc, offset) ((sc)->csr_arc[(offset)/4])
172
173struct csrdir{
174	uint32_t ongoaddr;
175	uint32_t off;
176	SLIST_ENTRY(csrdir) link;
177};
178
179struct fw_xferq {
180	int flag;
181#define FWXFERQ_CHTAGMASK 0xff
182#define FWXFERQ_RUNNING (1 << 8)
183#define FWXFERQ_STREAM (1 << 9)
184
185#define FWXFERQ_BULK (1 << 11)
186#define FWXFERQ_MODEMASK (7 << 10)
187
188#define FWXFERQ_EXTBUF (1 << 13)
189#define FWXFERQ_OPEN (1 << 14)
190
191#define FWXFERQ_HANDLER (1 << 16)
192#define FWXFERQ_WAKEUP (1 << 17)
193	void (*start) (struct firewire_comm*);
194	int dmach;
195	struct fw_xferlist q;
196	u_int queued;
197	u_int maxq;
198	u_int psize;
199	struct fwdma_alloc_multi *buf;
200	u_int bnchunk;
201	u_int bnpacket;
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;
207	struct selinfo rsel;
208	caddr_t sc;
209	void (*hand) (struct fw_xferq *);
210};
211
212struct fw_bulkxfer{
213	int poffset;
214	struct mbuf *mbuf;
215	STAILQ_ENTRY(fw_bulkxfer) link;
216	caddr_t start;
217	caddr_t end;
218	int resp;
219};
220
221struct fw_bind{
222	u_int64_t start;
223	u_int64_t end;
224	struct fw_xferlist xferlist;
225	STAILQ_ENTRY(fw_bind) fclist;
226	STAILQ_ENTRY(fw_bind) chlist;
227	void *sc;
228};
229
230struct fw_xfer{
231	caddr_t sc;
232	struct firewire_comm *fc;
233	struct fw_xferq *q;
234	struct timeval tv;
235	int8_t resp;
236#define FWXF_INIT 0
237#define FWXF_INQ 1
238#define FWXF_START 2
239#define FWXF_SENT 3
240#define FWXF_SENTERR 4
241#define FWXF_BUSY 8
242#define FWXF_RCVD 10
243	uint8_t state;
244	int8_t tl;
245	void (*hand) (struct fw_xfer *);
246	struct {
247		struct fw_pkt hdr;
248		uint32_t *payload;
249		uint16_t pay_len;
250		uint8_t spd;
251	} send, recv;
252	struct mbuf *mbuf;
253	STAILQ_ENTRY(fw_xfer) link;
254	STAILQ_ENTRY(fw_xfer) tlabel;
255	struct malloc_type *malloc;
256};
257
258struct fw_rcv_buf {
259	struct firewire_comm *fc;
260	struct fw_xfer *xfer;
261	struct iovec *vec;
262	u_int nvec;
263	uint8_t spd;
264};
265
266void fw_sidrcv (struct firewire_comm *, uint32_t *, u_int);
267void fw_rcv (struct fw_rcv_buf *);
268void fw_xfer_unload ( struct fw_xfer*);
269void fw_xfer_free_buf ( struct fw_xfer*);
270void fw_xfer_free ( struct fw_xfer*);
271struct fw_xfer *fw_xfer_alloc (struct malloc_type *);
272struct fw_xfer *fw_xfer_alloc_buf (struct malloc_type *, int, int);
273void fw_init (struct firewire_comm *);
274int fw_tbuf_update (struct firewire_comm *, int, int);
275int fw_rbuf_update (struct firewire_comm *, int, int);
276int fw_bindadd (struct firewire_comm *, struct fw_bind *);
277int fw_bindremove (struct firewire_comm *, struct fw_bind *);
278int fw_xferlist_add (struct fw_xferlist *, struct malloc_type *, int, int, int,
279    struct firewire_comm *, void *, void (*)(struct fw_xfer *));
280void fw_xferlist_remove (struct fw_xferlist *);
281int fw_asyreq (struct firewire_comm *, int, struct fw_xfer*);
282void fw_busreset (struct firewire_comm *, uint32_t);
283uint16_t fw_crc16 (uint32_t *, uint32_t);
284void fw_xfer_timeout (void *);
285void fw_xfer_done (struct fw_xfer *);
286void fw_asy_callback (struct fw_xfer *);
287void fw_asy_callback_free (struct fw_xfer *);
288struct fw_device *fw_noderesolve_nodeid (struct firewire_comm *, int);
289struct fw_device *fw_noderesolve_eui64 (struct firewire_comm *, struct fw_eui64 *);
290struct fw_bind *fw_bindlookup (struct firewire_comm *, uint16_t, uint32_t);
291void fw_drain_txq (struct firewire_comm *);
292int fwdev_makedev (struct firewire_softc *);
293int fwdev_destroydev (struct firewire_softc *);
294void fwdev_clone (void *, struct ucred *, char *, int, struct cdev **);
295
296extern int firewire_debug;
297extern devclass_t firewire_devclass;
298
299#ifdef __DragonFly__
300#define		FWPRI		PCATCH
301#else
302#define		FWPRI		((PZERO+8)|PCATCH)
303#endif
304
305#if defined(__DragonFly__) || __FreeBSD_version < 500000
306#define CALLOUT_INIT(x) callout_init(x)
307#else
308#define CALLOUT_INIT(x) callout_init(x, 0 /* mpsafe */)
309#endif
310
311#if defined(__DragonFly__) || __FreeBSD_version < 500000
312/* compatibility shim for 4.X */
313#define bio buf
314#define bio_bcount b_bcount
315#define bio_cmd b_flags
316#define bio_count b_count
317#define bio_data b_data
318#define bio_dev b_dev
319#define bio_error b_error
320#define bio_flags b_flags
321#define bio_offset b_offset
322#define bio_resid b_resid
323#define BIO_ERROR B_ERROR
324#define BIO_READ B_READ
325#define BIO_WRITE B_WRITE
326#define MIN(a,b) (((a)<(b))?(a):(b))
327#define MAX(a,b) (((a)>(b))?(a):(b))
328#endif
329
330MALLOC_DECLARE(M_FW);
331MALLOC_DECLARE(M_FWXFER);
332