Document MAKEOBJDIRPREFIX.
[dragonfly.git] / sys / net / iso88025.h
1 /*
2  * Copyright (c) 1998, Larry Lile
3  * All rights reserved.
4  *
5  * For latest sources and information on this driver, please
6  * go to http://anarchy.stdio.com.
7  *
8  * Questions, comments or suggestions should be directed to
9  * Larry Lile <lile@stdio.com>.
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions
13  * are met:
14  * 1. Redistributions of source code must retain the above copyright
15  *    notice unmodified, this list of conditions, and the following
16  *    disclaimer.
17  * 2. Redistributions in binary form must reproduce the above copyright
18  *    notice, this list of conditions and the following disclaimer in the
19  *    documentation and/or other materials provided with the distribution.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31  * SUCH DAMAGE.
32  *
33  * $FreeBSD: src/sys/net/iso88025.h,v 1.3.2.2 2002/06/18 00:15:31 kbyanc Exp $
34  * $DragonFly: src/sys/net/Attic/iso88025.h,v 1.5 2005/11/28 17:13:45 dillon Exp $
35  *
36  * Information gathered from tokenring@freebsd, /sys/net/ethernet.h and
37  * the Mach token ring driver.
38  */
39
40 /*
41  * Fundamental constants relating to iso 802.5
42  */
43
44 #ifndef _NET_ISO88025_H_
45 #define _NET_ISO88025_H_
46
47 /*
48  * General ISO 802.5 definitions
49  */
50 #define ISO88025_ADDR_LEN       6
51 #define ISO88025_HDR_LEN        (ISO88025_CF_LEN + (ISO88025_ADDR_LEN * 2))
52 #define ISO88025_CF_LEN         2
53 #define RCF_LEN                 2
54 #define RIF_MAX_RD              14
55 #define RIF_MAX_LEN             16
56
57 #define TR_AC                   0x10
58 #define TR_LLC_FRAME            0x40
59
60 #define TR_4MBPS                4000000
61 #define TR_16MBPS               16000000
62 #define TR_100MBPS              100000000
63
64 /*
65  * Source routing 
66  */
67 #define TR_RII                  0x80
68 #define TR_RCF_BCST_MASK        0xe000
69 #define TR_RCF_LEN_MASK         0x1f00
70 #define TR_RCF_DIR              0x0080
71 #define TR_RCF_LF_MASK          0x0070
72
73 #define TR_RCF_RIFLEN(x)        ((ntohs(x) & TR_RCF_LEN_MASK) >> 8)
74
75 /*
76  * Minimum and maximum packet payload lengths.
77  */
78 #define ISO88025_MIN_LEN        0 
79 #define ISO88025_MAX_LEN        17960   
80
81 /*
82  * A macro to validate a length with
83  */
84 #define ISO88025_IS_VALID_LEN(foo)      \
85         ((foo) >= ISO88025_MIN_LEN && (foo) <= ISO88025_MAX_LEN)
86
87 /*
88  * ISO 802.5 physical header
89  */
90 struct iso88025_header {
91         u_char  ac;                                 /* access control field */
92         u_char  fc;                                 /* frame control field */
93         u_char  iso88025_dhost[ISO88025_ADDR_LEN];  /* destination address */
94         u_char  iso88025_shost[ISO88025_ADDR_LEN];  /* source address */
95         u_short rcf;                                /* route control field */
96         u_short rd[RIF_MAX_RD];                     /* routing designators */
97 };
98
99 struct iso88025_sockaddr_data {
100         u_char ether_dhost[ISO88025_ADDR_LEN];
101         u_char ether_shost[ISO88025_ADDR_LEN];
102         u_char ac;
103         u_char fc;
104 };
105
106 struct iso88025_sockaddr_dl_data {
107         u_short  trld_rcf;
108         u_short *trld_route[RIF_MAX_LEN];
109 };
110
111 #define ISO88025_MAX(a, b)      (((a)>(b))?(a):(b))
112 #define SDL_ISO88025(s)         ((struct iso88025_sockaddr_dl_data *)   \
113                                  ((s)->sdl_data + \
114                                   ISO88025_MAX((s)->sdl_nlen + (s)->sdl_alen + \
115                                                (s)->sdl_slen, 12)))
116
117 /*
118  * Structure of a 48-bit iso 802.5 address.
119  *  ( We could also add the 16 bit addresses as a union)
120  */
121 struct  iso88025_addr {
122         u_char octet[ISO88025_ADDR_LEN];
123 };
124
125 #define ISO88025_MAX_MTU        18000
126 #define ISO88025_DEFAULT_MTU    1500
127 #define senderr(e) { error = (e); goto bad;}
128
129 struct lwkt_serialize;
130
131 void    iso88025_ifattach (struct ifnet *, struct lwkt_serialize *);
132 int     iso88025_ioctl (struct ifnet *, int , caddr_t );
133
134 #endif