2 * SPDX-License-Identifier: BSD-4-Clause
4 * Copyright (c) 2003 Hidetoshi Shimokawa
5 * Copyright (c) 1998-2002 Katsushi Kobayashi and Hidetoshi Shimokawa
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
16 * 3. All advertising materials mentioning features or use of this software
17 * must display the acknowledgement as bellow:
19 * This product includes software developed by K. Kobayashi and H. Shimokawa
21 * 4. The name of the author may not be used to endorse or promote products
22 * derived from this software without specific prior written permission.
24 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
25 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
26 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
27 * DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
28 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
29 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
30 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
32 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
33 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
34 * POSSIBILITY OF SUCH DAMAGE.
64 struct fw_asybindreq {
74 #define MAXREC(x) (2 << (x))
75 #define FWPMAX_S400 (2048 + 20) /* MAXREC plus space for control data */
76 #define FWMAXQUEUE 128
78 #define FWLOCALBUS 0xffc0
80 #define FWTCODE_WREQQ 0
81 #define FWTCODE_WREQB 1
82 #define FWTCODE_WRES 2
83 #define FWTCODE_RREQQ 4
84 #define FWTCODE_RREQB 5
85 #define FWTCODE_RRESQ 6
86 #define FWTCODE_RRESB 7
87 #define FWTCODE_CYCS 8
88 #define FWTCODE_LREQ 9
89 #define FWTCODE_STREAM 0xa
90 #define FWTCODE_LRES 0xb
91 #define FWTCODE_PHY 0xe
98 #define FWRCODE_COMPLETE 0
99 #define FWRCODE_ER_CONFL 4
100 #define FWRCODE_ER_DATA 5
101 #define FWRCODE_ER_TYPE 6
102 #define FWRCODE_ER_ADDR 7
112 #define FWSPD_S1600 4
113 #define FWSPD_S3200 5
115 #define FWP_TL_VALID (1 << 7)
125 #if BYTE_ORDER == BIG_ENDIAN
126 #define BIT4x2(x,y) uint8_t x:4, y:4
127 #define BIT16x2(x,y) uint32_t x:16, y:16
129 #define BIT4x2(x,y) uint8_t y:4, x:4
130 #define BIT16x2(x,y) uint32_t y:16, x:16
134 #if BYTE_ORDER == BIG_ENDIAN
135 #define COMMON_HDR(a,b,c,d) uint32_t a:16,b:8,c:4,d:4
136 #define COMMON_RES(a,b,c,d) uint32_t a:16,b:4,c:4,d:8
138 #define COMMON_HDR(a,b,c,d) uint32_t d:4,c:4,b:8,a:16
139 #define COMMON_RES(a,b,c,d) uint32_t d:8,c:4,b:4,a:16
146 COMMON_HDR(, , tcode, );
149 COMMON_HDR(len, chtag, tcode, sy);
153 COMMON_HDR(dst, tlrt, tcode, pri);
157 COMMON_HDR(dst, tlrt, tcode, pri);
158 BIT16x2(src, dest_hi);
162 COMMON_HDR(dst, tlrt, tcode, pri);
163 COMMON_RES(src, rtcode, , );
167 COMMON_HDR(dst, tlrt, tcode, pri);
168 BIT16x2(src, dest_hi);
170 BIT16x2(len, extcode);
173 COMMON_HDR(dst, tlrt, tcode, pri);
174 BIT16x2(src, dest_hi);
179 COMMON_HDR(dst, tlrt, tcode, pri);
180 BIT16x2(src, dest_hi);
185 COMMON_HDR(dst, tlrt, tcode, pri);
186 COMMON_RES(src, rtcode, , );
191 COMMON_HDR(dst, tlrt, tcode, pri);
192 BIT16x2(src, dest_hi);
194 BIT16x2(len, extcode);
198 COMMON_HDR(dst, tlrt, tcode, pri);
199 BIT16x2(src, dest_hi);
201 BIT16x2(len, extcode);
205 COMMON_HDR(dst, tlrt, tcode, pri);
206 COMMON_RES(src, rtcode, , );
208 BIT16x2(len, extcode);
212 COMMON_HDR(dst, tlrt, tcode, pri);
213 COMMON_RES(src, rtcode, , );
215 BIT16x2(len, extcode);
222 * Response code (rtcode)
224 /* The node has successfully completed the command. */
226 /* A resource conflict was detected. The request may be retried. */
227 #define RESP_CONFLICT_ERROR 4
228 /* Hardware error, data is unavailable. */
229 #define RESP_DATA_ERROR 5
230 /* A field in the request packet header was set to an unsupported or incorrect
231 * value, or an invalid transaction was attempted (e.g., a write to a read-only
233 #define RESP_TYPE_ERROR 6
234 /* The destination offset field in the request was set to an address not
235 * accessible in the destination node. */
236 #define RESP_ADDRESS_ERROR 7
239 * Extended transaction code (extcode)
241 #define EXTCODE_MASK_SWAP 1
242 #define EXTCODE_CMP_SWAP 2
243 #define EXTCODE_FETCH_ADD 3
244 #define EXTCODE_LITTLE_ADD 4
245 #define EXTCODE_BOUNDED_ADD 5
246 #define EXTCODE_WRAP_ADD 6
251 #define FW_EUI64_BYTE(eui, x) \
253 ((eui)->hi >> (8 * (3 - (x)))): \
254 ((eui)->lo >> (8 * (7 - (x)))) \
256 #define FW_EUI64_EQUAL(x, y) \
257 ((x).hi == (y).hi && (x).lo == (y).lo)
263 #define FWASREQNODE 0
266 #define FWASREQSTREAM 3
282 #define FW_MAX_DEVLST 70
283 struct fw_devlstreq {
286 struct fw_devinfo dev[FW_MAX_DEVLST];
290 * Defined in IEEE 1394a-2000
293 #define FW_SELF_ID_PORT_CONNECTED_TO_CHILD 3
294 #define FW_SELF_ID_PORT_CONNECTED_TO_PARENT 2
295 #define FW_SELF_ID_PORT_NOT_CONNECTED 1
296 #define FW_SELF_ID_PORT_NOT_EXISTS 0
298 #define FW_SELF_ID_PAGE0 0
299 #define FW_SELF_ID_PAGE1 1
301 #if BYTE_ORDER == BIG_ENDIAN
355 uint32_t more_packets:1,
371 uint32_t more_packets:1,
405 struct fw_topology_map {
409 uint32_t self_id_count:16,
411 union fw_self_id self_id[4 * 64];
414 struct fw_speed_map {
418 uint8_t speed[64][64];
428 * FireWire specific system requests.
430 #define FW_SSTBUF _IOWR('S', 86, struct fw_isobufreq)
431 #define FW_GSTBUF _IOWR('S', 87, struct fw_isobufreq)
432 #define FW_SRSTREAM _IOWR('S', 88, struct fw_isochreq)
433 #define FW_GRSTREAM _IOWR('S', 89, struct fw_isochreq)
434 #define FW_STSTREAM _IOWR('S', 90, struct fw_isochreq)
435 #define FW_GTSTREAM _IOWR('S', 91, struct fw_isochreq)
437 #define FW_ASYREQ _IOWR('S', 92, struct fw_asyreq)
438 #define FW_IBUSRST _IOR('S', 1, unsigned int)
439 #define FW_GDEVLST _IOWR('S', 2, struct fw_devlstreq)
440 #define FW_SBINDADDR _IOWR('S', 3, struct fw_asybindreq)
441 #define FW_CBINDADDR _IOWR('S', 4, struct fw_asybindreq)
442 #define FW_GTPMAP _IOR('S', 5, struct fw_topology_map)
443 #define FW_GCROM _IOWR('S', 7, struct fw_crom_buf)
445 #define FW_SDEUI64 _IOW('S', 20, struct fw_eui64)
446 #define FW_GDEUI64 _IOR('S', 21, struct fw_eui64)
448 #define FWOHCI_RDREG _IOWR('S', 80, struct fw_reg_req_t)
449 #define FWOHCI_WRREG _IOWR('S', 81, struct fw_reg_req_t)
450 #define FWOHCI_RDPHYREG _IOWR('S', 82, struct fw_reg_req_t)
451 #define FWOHCI_WRPHYREG _IOWR('S', 83, struct fw_reg_req_t)
453 #define DUMPDMA _IOWR('S', 82, uint32_t)
457 #define FWMAXNDMA 0x100 /* 8 bits DMA channel id. in device No. */
459 #define MAKEMINOR(f, u, s) \
460 ((f) | (((u) & 0xff) << 8) | (s & 0xff))
461 #define DEV2UNIT(x) ((dev2unit(x) & 0xff00) >> 8)
462 #define DEV2SUB(x) (dev2unit(x) & 0xff)
464 #define FWMEM_FLAG 0x10000
465 #define DEV_FWMEM(x) (dev2unit(x) & FWMEM_FLAG)