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