firewirereg.h revision 167630 
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 167630 2007-03-16 05:11:42Z 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
53struct fw_device{
54	uint16_t dst;
55	struct fw_eui64 eui;
56	uint8_t speed;
57	uint8_t maxrec;
58	uint8_t nport;
59	uint8_t power;
60#define CSRROMOFF 0x400
61#define CSRROMSIZE 0x400
62	int rommax;	/* offset from 0xffff f000 0000 */
63	uint32_t csrrom[CSRROMSIZE/4];
64	int rcnt;
65	struct firewire_comm *fc;
66	uint32_t status;
67#define FWDEVINIT	1
68#define FWDEVATTACHED	2
69#define FWDEVINVAL	3
70	STAILQ_ENTRY(fw_device) link;
71};
72
73struct firewire_softc {
74#if defined(__FreeBSD__) && __FreeBSD_version >= 500000
75	struct cdev *dev;
76#endif
77	struct firewire_comm *fc;
78};
79
80#define FW_MAX_DMACH 0x20
81#define FW_MAX_DEVCH FW_MAX_DMACH
82#define FW_XFERTIMEOUT 1
83
84struct firewire_dev_comm {
85	device_t dev;
86	struct firewire_comm *fc;
87	void (*post_busreset) (void *);
88	void (*post_explore) (void *);
89};
90
91struct tcode_info {
92	u_char hdr_len;	/* IEEE1394 header length */
93	u_char flag;
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)
99};
100
101struct firewire_comm{
102	device_t dev;
103	device_t bdev;
104	uint16_t busid:10,
105		  nodeid:6;
106	u_int mode;
107	u_int nport;
108	u_int speed;
109	u_int maxrec;
110	u_int irm;
111	u_int max_node;
112	u_int max_hop;
113	u_int max_asyretry;
114#define FWPHYASYST (1 << 0)
115	u_int retry_count;
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	STAILQ_HEAD(, tlabel) 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	STAILQ_HEAD(, fw_xfer) q;
196	u_int queued;
197	u_int maxq;
198	u_int psize;
199	STAILQ_HEAD(, fw_bind) binds;
200	struct fwdma_alloc_multi *buf;
201	u_int bnchunk;
202	u_int bnpacket;
203	struct fw_bulkxfer *bulkxfer;
204	STAILQ_HEAD(, fw_bulkxfer) stvalid;
205	STAILQ_HEAD(, fw_bulkxfer) stfree;
206	STAILQ_HEAD(, fw_bulkxfer) stdma;
207	struct fw_bulkxfer *stproc;
208	struct selinfo rsel;
209	caddr_t sc;
210	void (*hand) (struct fw_xferq *);
211};
212
213struct fw_bulkxfer{
214	int poffset;
215	struct mbuf *mbuf;
216	STAILQ_ENTRY(fw_bulkxfer) link;
217	caddr_t start;
218	caddr_t end;
219	int resp;
220};
221
222struct tlabel{
223	struct fw_xfer  *xfer;
224	STAILQ_ENTRY(tlabel) link;
225};
226
227struct fw_bind{
228	u_int64_t start;
229	u_int64_t end;
230	STAILQ_HEAD(, fw_xfer) xferlist;
231	STAILQ_ENTRY(fw_bind) fclist;
232	STAILQ_ENTRY(fw_bind) chlist;
233#define FWACT_NULL	0
234#define FWACT_XFER	2
235#define FWACT_CH	3
236	uint8_t act_type;
237	uint8_t sub;
238};
239
240struct fw_xfer{
241	caddr_t sc;
242	struct firewire_comm *fc;
243	struct fw_xferq *q;
244	struct timeval tv;
245	int8_t resp;
246#define FWXF_INIT 0
247#define FWXF_INQ 1
248#define FWXF_START 2
249#define FWXF_SENT 3
250#define FWXF_SENTERR 4
251#define FWXF_BUSY 8
252#define FWXF_RCVD 10
253	uint8_t state;
254	uint8_t tl;
255	union{
256		void (*hand) (struct fw_xfer *);
257	} act;
258	struct {
259		struct fw_pkt hdr;
260		uint32_t *payload;
261		uint16_t pay_len;
262		uint8_t spd;
263	} send, recv;
264	struct mbuf *mbuf;
265	STAILQ_ENTRY(fw_xfer) link;
266	struct malloc_type *malloc;
267};
268
269struct fw_rcv_buf {
270	struct firewire_comm *fc;
271	struct fw_xfer *xfer;
272	struct iovec *vec;
273	u_int nvec;
274	uint8_t spd;
275};
276
277void fw_sidrcv (struct firewire_comm *, uint32_t *, u_int);
278void fw_rcv (struct fw_rcv_buf *);
279void fw_xfer_unload ( struct fw_xfer*);
280void fw_xfer_free_buf ( struct fw_xfer*);
281void fw_xfer_free ( struct fw_xfer*);
282struct fw_xfer *fw_xfer_alloc (struct malloc_type *);
283struct fw_xfer *fw_xfer_alloc_buf (struct malloc_type *, int, int);
284void fw_init (struct firewire_comm *);
285int fw_tbuf_update (struct firewire_comm *, int, int);
286int fw_rbuf_update (struct firewire_comm *, int, int);
287void fw_asybusy (struct fw_xfer *);
288int fw_bindadd (struct firewire_comm *, struct fw_bind *);
289int fw_bindremove (struct firewire_comm *, struct fw_bind *);
290int fw_asyreq (struct firewire_comm *, int, struct fw_xfer*);
291void fw_busreset (struct firewire_comm *);
292uint16_t fw_crc16 (uint32_t *, uint32_t);
293void fw_xfer_timeout (void *);
294void fw_xfer_done (struct fw_xfer *);
295void fw_asy_callback (struct fw_xfer *);
296void fw_asy_callback_free (struct fw_xfer *);
297struct fw_device *fw_noderesolve_nodeid (struct firewire_comm *, int);
298struct fw_device *fw_noderesolve_eui64 (struct firewire_comm *, struct fw_eui64 *);
299struct fw_bind *fw_bindlookup (struct firewire_comm *, uint16_t, uint32_t);
300void fw_drain_txq (struct firewire_comm *);
301int fwdev_makedev (struct firewire_softc *);
302int fwdev_destroydev (struct firewire_softc *);
303void fwdev_clone (void *, struct ucred *, char *, int, struct cdev **);
304
305extern int firewire_debug;
306extern devclass_t firewire_devclass;
307
308#ifdef __DragonFly__
309#define		FWPRI		PCATCH
310#else
311#define		FWPRI		((PZERO+8)|PCATCH)
312#endif
313
314#if defined(__DragonFly__) || __FreeBSD_version < 500000
315#define CALLOUT_INIT(x) callout_init(x)
316#else
317#define CALLOUT_INIT(x) callout_init(x, 0 /* mpsafe */)
318#endif
319
320#if defined(__DragonFly__) || __FreeBSD_version < 500000
321/* compatibility shim for 4.X */
322#define bio buf
323#define bio_bcount b_bcount
324#define bio_cmd b_flags
325#define bio_count b_count
326#define bio_data b_data
327#define bio_dev b_dev
328#define bio_error b_error
329#define bio_flags b_flags
330#define bio_offset b_offset
331#define bio_resid b_resid
332#define BIO_ERROR B_ERROR
333#define BIO_READ B_READ
334#define BIO_WRITE B_WRITE
335#define MIN(a,b) (((a)<(b))?(a):(b))
336#define MAX(a,b) (((a)>(b))?(a):(b))
337#endif
338
339MALLOC_DECLARE(M_FW);
340MALLOC_DECLARE(M_FWXFER);
341