1dececc3836315b3e5978df1bc9d9b1847907097
[dragonfly.git] / sys / bus / firewire / firewirereg.h
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: src/sys/dev/firewire/firewirereg.h,v 1.33 2004/01/06 14:30:46 simokawa Exp $
35  * $DragonFly: src/sys/bus/firewire/firewirereg.h,v 1.12 2006/09/10 01:26:32 dillon Exp $
36  *
37  */
38
39 #ifdef __DragonFly__
40 typedef struct thread fw_proc;
41 #elif __FreeBSD_version >= 500000
42 typedef struct thread fw_proc;
43 #else
44 typedef struct proc fw_proc;
45 #endif
46
47 #include <sys/selinfo.h>
48 #include <sys/uio.h>
49
50 struct dev_ioctl_args;
51
52 struct fw_device{
53         u_int16_t dst;
54         struct fw_eui64 eui;
55         u_int8_t speed;
56         u_int8_t maxrec;
57         u_int8_t nport;
58         u_int8_t power;
59 #define CSRROMOFF 0x400
60 #define CSRROMSIZE 0x400
61         int rommax;     /* offset from 0xffff f000 0000 */
62         u_int32_t csrrom[CSRROMSIZE/4];
63         int rcnt;
64         struct firewire_comm *fc;
65         u_int32_t status;
66 #define FWDEVINIT       1
67 #define FWDEVATTACHED   2
68 #define FWDEVINVAL      3
69         STAILQ_ENTRY(fw_device) link;
70 };
71
72 struct firewire_softc {
73 #if defined(__FreeBSD__) && __FreeBSD_version >= 500000
74         cdev_t dev;
75 #endif
76         struct firewire_comm *fc;
77 };
78
79 #define FW_MAX_DMACH 0x20
80 #define FW_MAX_DEVCH FW_MAX_DMACH
81 #define FW_XFERTIMEOUT 1
82
83 struct firewire_dev_comm {
84         device_t dev;
85         struct firewire_comm *fc;
86         void (*post_busreset) (void *);
87         void (*post_explore) (void *);
88 };
89
90 struct tcode_info {
91         u_char hdr_len; /* IEEE1394 header length */
92         u_char flag;
93 #define FWTI_REQ        (1 << 0)
94 #define FWTI_RES        (1 << 1)
95 #define FWTI_TLABEL     (1 << 2)
96 #define FWTI_BLOCK_STR  (1 << 3)
97 #define FWTI_BLOCK_ASY  (1 << 4)
98 };
99
100 struct firewire_comm{
101         device_t dev;
102         device_t bdev;
103         u_int16_t busid:10,
104                   nodeid:6;
105         u_int mode;
106         u_int nport;
107         u_int speed;
108         u_int maxrec;
109         u_int irm;
110         u_int max_node;
111         u_int max_hop;
112         u_int max_asyretry;
113 #define FWPHYASYST (1 << 0)
114         u_int retry_count;
115         u_int32_t ongobus:10,
116                   ongonode:6,
117                   ongoaddr:16;
118         struct fw_device *ongodev;
119         struct fw_eui64 ongoeui;
120 #define FWMAXCSRDIR     16
121         SLIST_HEAD(, csrdir) ongocsr;
122         SLIST_HEAD(, csrdir) csrfree;
123         u_int32_t status;
124 #define FWBUSNOTREADY   (-1)
125 #define FWBUSRESET      0
126 #define FWBUSINIT       1
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
134         int nisodma;
135         struct fw_eui64 eui;
136         struct fw_xferq
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         u_int  sid_cnt;
142 #define CSRSIZE 0x4000
143         u_int32_t csr_arc[CSRSIZE/4];
144 #define CROMSIZE 0x400
145         u_int32_t *config_rom;
146         struct crom_src_buf *crom_src_buf;
147         struct crom_src *crom_src;
148         struct crom_chunk *crom_root;
149         struct fw_topology_map *topology_map;
150         struct fw_speed_map *speed_map;
151         struct callout busprobe_callout;
152         struct callout bmr_callout;
153         struct callout timeout_callout;
154         struct callout retry_probe_callout;
155         u_int32_t (*cyctimer) (struct  firewire_comm *);
156         void (*ibr) (struct firewire_comm *);
157         u_int32_t (*set_bmr) (struct firewire_comm *, u_int32_t);
158         int (*ioctl) (struct dev_ioctl_args *);
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 *, u_int32_t *);
167         void (*itx_post) (struct firewire_comm *, u_int32_t *);
168         struct tcode_info *tcode;
169         bus_dma_tag_t dmat;
170 };
171 #define CSRARC(sc, offset) ((sc)->csr_arc[(offset)/4])
172
173 struct csrdir{
174         u_int32_t ongoaddr;
175         u_int32_t off;
176         SLIST_ENTRY(csrdir) link;
177 };
178
179 struct 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
213 struct 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
222 struct tlabel{
223         struct fw_xfer  *xfer;
224         STAILQ_ENTRY(tlabel) link;
225 };
226
227 struct 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         u_int8_t act_type;
237         u_int8_t sub;
238 };
239
240 struct 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         u_int8_t state;
254         u_int8_t retry;
255         u_int8_t tl;
256         void (*retry_req) (struct fw_xfer *);
257         union{
258                 void (*hand) (struct fw_xfer *);
259         } act;
260         struct {
261                 struct fw_pkt hdr;
262                 u_int32_t *payload;
263                 u_int16_t pay_len;
264                 u_int8_t spd;
265         } send, recv;
266         struct mbuf *mbuf;
267         STAILQ_ENTRY(fw_xfer) link;
268         struct malloc_type *malloc;
269 };
270
271 struct fw_rcv_buf {
272         struct firewire_comm *fc;
273         struct fw_xfer *xfer;
274         struct iovec *vec;
275         u_int nvec;
276         u_int8_t spd;
277 };
278
279 void fw_sidrcv (struct firewire_comm *, u_int32_t *, u_int);
280 void fw_rcv (struct fw_rcv_buf *);
281 void fw_xfer_unload ( struct fw_xfer*);
282 void fw_xfer_free_buf ( struct fw_xfer*);
283 void fw_xfer_free ( struct fw_xfer*);
284 struct fw_xfer *fw_xfer_alloc (struct malloc_type *);
285 struct fw_xfer *fw_xfer_alloc_buf (struct malloc_type *, int, int);
286 void fw_init (struct firewire_comm *);
287 int fw_tbuf_update (struct firewire_comm *, int, int);
288 int fw_rbuf_update (struct firewire_comm *, int, int);
289 void fw_asybusy (struct fw_xfer *);
290 int fw_bindadd (struct firewire_comm *, struct fw_bind *);
291 int fw_bindremove (struct firewire_comm *, struct fw_bind *);
292 int fw_asyreq (struct firewire_comm *, int, struct fw_xfer*);
293 void fw_busreset (struct firewire_comm *);
294 u_int16_t fw_crc16 (u_int32_t *, u_int32_t);
295 void fw_xfer_timeout (void *);
296 void fw_xfer_done (struct fw_xfer *);
297 void fw_asy_callback (struct fw_xfer *);
298 void fw_asy_callback_free (struct fw_xfer *);
299 struct fw_device *fw_noderesolve_nodeid (struct firewire_comm *, int);
300 struct fw_device *fw_noderesolve_eui64 (struct firewire_comm *, struct fw_eui64 *);
301 struct fw_bind *fw_bindlookup (struct firewire_comm *, u_int16_t, u_int32_t);
302 void fw_drain_txq (struct firewire_comm *);
303 int fwdev_makedev (struct firewire_softc *);
304 int fwdev_destroydev (struct firewire_softc *);
305 void fwdev_clone (void *, char *, int, cdev_t *);
306
307 extern int firewire_debug;
308 extern devclass_t firewire_devclass;
309
310 #ifdef __DragonFly__
311 #define         FWPRI           PCATCH
312 #else
313 #define         FWPRI           ((PZERO+8)|PCATCH)
314 #endif
315
316 #if defined(__DragonFly__) || __FreeBSD_version < 500000
317 #define CALLOUT_INIT(x) callout_init(x)
318 #else
319 #define CALLOUT_INIT(x) callout_init(x, 0 /* mpsafe */)
320 #endif
321
322 #if defined(__DragonFly__)
323 #define MIN(a,b) (((a)<(b))?(a):(b))
324 #define MAX(a,b) (((a)>(b))?(a):(b))
325 #endif
326
327 MALLOC_DECLARE(M_FW);
328 MALLOC_DECLARE(M_FWXFER);