xref: /xnu-11215.1.10/bsd/net/firewire.h (revision 8d741a5de7ff4191bf97d57b9f54c2f6d4a15585)
1*8d741a5dSApple OSS Distributions /*
2*8d741a5dSApple OSS Distributions  * Copyright (c) 2003 Apple Computer, Inc. All rights reserved.
3*8d741a5dSApple OSS Distributions  *
4*8d741a5dSApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5*8d741a5dSApple OSS Distributions  *
6*8d741a5dSApple OSS Distributions  * This file contains Original Code and/or Modifications of Original Code
7*8d741a5dSApple OSS Distributions  * as defined in and that are subject to the Apple Public Source License
8*8d741a5dSApple OSS Distributions  * Version 2.0 (the 'License'). You may not use this file except in
9*8d741a5dSApple OSS Distributions  * compliance with the License. The rights granted to you under the License
10*8d741a5dSApple OSS Distributions  * may not be used to create, or enable the creation or redistribution of,
11*8d741a5dSApple OSS Distributions  * unlawful or unlicensed copies of an Apple operating system, or to
12*8d741a5dSApple OSS Distributions  * circumvent, violate, or enable the circumvention or violation of, any
13*8d741a5dSApple OSS Distributions  * terms of an Apple operating system software license agreement.
14*8d741a5dSApple OSS Distributions  *
15*8d741a5dSApple OSS Distributions  * Please obtain a copy of the License at
16*8d741a5dSApple OSS Distributions  * http://www.opensource.apple.com/apsl/ and read it before using this file.
17*8d741a5dSApple OSS Distributions  *
18*8d741a5dSApple OSS Distributions  * The Original Code and all software distributed under the License are
19*8d741a5dSApple OSS Distributions  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20*8d741a5dSApple OSS Distributions  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21*8d741a5dSApple OSS Distributions  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22*8d741a5dSApple OSS Distributions  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23*8d741a5dSApple OSS Distributions  * Please see the License for the specific language governing rights and
24*8d741a5dSApple OSS Distributions  * limitations under the License.
25*8d741a5dSApple OSS Distributions  *
26*8d741a5dSApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27*8d741a5dSApple OSS Distributions  */
28*8d741a5dSApple OSS Distributions /*
29*8d741a5dSApple OSS Distributions  * Fundamental constants relating to FireWire network device.
30*8d741a5dSApple OSS Distributions  */
31*8d741a5dSApple OSS Distributions 
32*8d741a5dSApple OSS Distributions #ifndef _NET_FIREWIRE_H_
33*8d741a5dSApple OSS Distributions #define _NET_FIREWIRE_H_
34*8d741a5dSApple OSS Distributions 
35*8d741a5dSApple OSS Distributions #include <sys/appleapiopts.h>
36*8d741a5dSApple OSS Distributions 
37*8d741a5dSApple OSS Distributions /*
38*8d741a5dSApple OSS Distributions  * The number of bytes in a FireWire EUI-64.
39*8d741a5dSApple OSS Distributions  */
40*8d741a5dSApple OSS Distributions #define FIREWIRE_EUI64_LEN              8
41*8d741a5dSApple OSS Distributions 
42*8d741a5dSApple OSS Distributions /*
43*8d741a5dSApple OSS Distributions  * The number of bytes in the type field.
44*8d741a5dSApple OSS Distributions  */
45*8d741a5dSApple OSS Distributions #define FIREWIRE_TYPE_LEN               2
46*8d741a5dSApple OSS Distributions 
47*8d741a5dSApple OSS Distributions /*
48*8d741a5dSApple OSS Distributions  * The length of the header provided by the FireWire network device.
49*8d741a5dSApple OSS Distributions  */
50*8d741a5dSApple OSS Distributions #define FIREWIRE_HDR_LEN                (FIREWIRE_EUI64_LEN*2+FIREWIRE_TYPE_LEN)
51*8d741a5dSApple OSS Distributions 
52*8d741a5dSApple OSS Distributions /*
53*8d741a5dSApple OSS Distributions  * The minimum packet length.
54*8d741a5dSApple OSS Distributions  */
55*8d741a5dSApple OSS Distributions #define FIREWIRE_MIN_LEN                64
56*8d741a5dSApple OSS Distributions 
57*8d741a5dSApple OSS Distributions /*
58*8d741a5dSApple OSS Distributions  * The maximum packet length.
59*8d741a5dSApple OSS Distributions  */
60*8d741a5dSApple OSS Distributions #define FIREWIRE_MAX_LEN                4096
61*8d741a5dSApple OSS Distributions 
62*8d741a5dSApple OSS Distributions /*
63*8d741a5dSApple OSS Distributions  * A macro to validate a length with
64*8d741a5dSApple OSS Distributions  */
65*8d741a5dSApple OSS Distributions #define FIREWIRE_IS_VALID_LEN(foo)      \
66*8d741a5dSApple OSS Distributions 	((foo) >= FIREWIRE_MIN_LEN && (foo) <= FIREWIRE_MAX_LEN)
67*8d741a5dSApple OSS Distributions 
68*8d741a5dSApple OSS Distributions /*
69*8d741a5dSApple OSS Distributions  * Structure of header provided by the FireWire network device.
70*8d741a5dSApple OSS Distributions  *
71*8d741a5dSApple OSS Distributions  * The device uses a simplified header with just the non-changing
72*8d741a5dSApple OSS Distributions  * EUI-64 addresses and ethernet type specified;
73*8d741a5dSApple OSS Distributions  */
74*8d741a5dSApple OSS Distributions struct  firewire_header {
75*8d741a5dSApple OSS Distributions 	u_char  firewire_dhost[FIREWIRE_EUI64_LEN];
76*8d741a5dSApple OSS Distributions 	u_char  firewire_shost[FIREWIRE_EUI64_LEN];
77*8d741a5dSApple OSS Distributions 	u_short firewire_type;          /* ethertype */
78*8d741a5dSApple OSS Distributions };
79*8d741a5dSApple OSS Distributions 
80*8d741a5dSApple OSS Distributions /*
81*8d741a5dSApple OSS Distributions  * Format of FireWire EUI-64.
82*8d741a5dSApple OSS Distributions  */
83*8d741a5dSApple OSS Distributions struct  firewire_eui64 {
84*8d741a5dSApple OSS Distributions 	u_char octet[FIREWIRE_EUI64_LEN];
85*8d741a5dSApple OSS Distributions };
86*8d741a5dSApple OSS Distributions 
87*8d741a5dSApple OSS Distributions /*
88*8d741a5dSApple OSS Distributions  * Format of FireWire hardware address.
89*8d741a5dSApple OSS Distributions  */
90*8d741a5dSApple OSS Distributions struct firewire_address {
91*8d741a5dSApple OSS Distributions 	u_char      eui64[FIREWIRE_EUI64_LEN];
92*8d741a5dSApple OSS Distributions 	u_char      maxRec;
93*8d741a5dSApple OSS Distributions 	u_char      spd;
94*8d741a5dSApple OSS Distributions 	u_int16_t   unicastFifoHi;
95*8d741a5dSApple OSS Distributions 	u_int32_t   unicastFifoLo;
96*8d741a5dSApple OSS Distributions };
97*8d741a5dSApple OSS Distributions 
98*8d741a5dSApple OSS Distributions #define FIREWIRE_ADDR_LEN       16      /* sizeof(struct firewire_address) */
99*8d741a5dSApple OSS Distributions 
100*8d741a5dSApple OSS Distributions 
101*8d741a5dSApple OSS Distributions #define FIREWIRE_MTU    (FIREWIRE_MAX_LEN - FIREWIRE_HDR_LEN)
102*8d741a5dSApple OSS Distributions #define FIREWIRE_MIN    (FIREWIRE_MIN_LEN - FIREWIRE_HDR_LEN)
103*8d741a5dSApple OSS Distributions 
104*8d741a5dSApple OSS Distributions #endif /* !_NET_FIREWIRE_H_ */
105