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