]> git.saurik.com Git - apple/xnu.git/blame - bsd/netat/appletalk.h
xnu-792.24.17.tar.gz
[apple/xnu.git] / bsd / netat / appletalk.h
CommitLineData
1c79356b 1/*
5d5c5d0d
A
2 * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
3 *
6601e61a 4 * @APPLE_LICENSE_HEADER_START@
1c79356b 5 *
6601e61a
A
6 * The contents of this file constitute Original Code as defined in and
7 * are subject to the Apple Public Source License Version 1.1 (the
8 * "License"). You may not use this file except in compliance with the
9 * License. Please obtain a copy of the License at
10 * http://www.apple.com/publicsource and read it before using this file.
8f6c56a5 11 *
6601e61a
A
12 * This Original Code and all software distributed under the License are
13 * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
8f6c56a5
A
14 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
15 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
6601e61a
A
16 * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT. Please see the
17 * License for the specific language governing rights and limitations
18 * under the License.
8f6c56a5 19 *
6601e61a 20 * @APPLE_LICENSE_HEADER_END@
1c79356b
A
21 */
22/*
23 *
24 * ORIGINS: 82
25 *
26 * (C) COPYRIGHT Apple Computer, Inc. 1992-1996
27 * All Rights Reserved
28 *
29 */
30
31/* Miscellaneous definitions for AppleTalk used by all protocol
32 * modules.
33 */
34
35#ifndef _NETAT_APPLETALK_H_
36#define _NETAT_APPLETALK_H_
9bccf70c 37#include <sys/appleapiopts.h>
1c79356b
A
38
39#include <sys/types.h>
40#include <sys/uio.h>
41
91447636
A
42#ifdef __APPLE_API_OBSOLETE
43
1c79356b
A
44/*
45 Non-aligned types are used in packet headers.
46*/
47
48/* New fundemental types: non-aligned variations of u_short and u_long */
49typedef u_char ua_short[2]; /* Unaligned short */
50typedef u_char ua_long[4]; /* Unaligned long */
51
52/* Two at_net typedefs; the first is aligned the other isn't */
53typedef u_short at_net_al; /* Aligned AppleTalk network number */
54typedef ua_short at_net_unal; /* Unaligned AppleTalk network number */
55
56/* Miscellaneous types */
57typedef u_char at_node; /* AppleTalk node number */
58typedef u_char at_socket; /* AppleTalk socket number */
59
60typedef at_net_unal at_net; /* Default: Unaligned AppleTalk network number */
61struct atalk_addr {
62 u_char atalk_unused;
63 at_net atalk_net;
64 at_node atalk_node;
65};
66
67/* Macros to manipulate unaligned fields */
68#define UAS_ASSIGN(x,s) *(unsigned short *) &(x[0]) = (unsigned short) (s)
69#define UAS_UAS(x,y) *(unsigned short *) &(x[0]) = *(unsigned short *) &(y[0])
70#define UAS_VALUE(x) (*(unsigned short *) &(x[0]))
71#define UAL_ASSIGN(x,l) *(unsigned long *) &(x[0]) = (unsigned long) (l)
72#define UAL_UAL(x,y) *(unsigned long *) &(x[0]) = *(unsigned long *) &(y[0])
73#define UAL_VALUE(x) (*(unsigned long *) &(x[0]))
74
75/* Macros to manipulate at_net variables */
6601e61a
A
76#define NET_ASSIGN(x,s) *(unsigned short *)&(x[0]) = (unsigned short)(s)
77#define NET_NET(x, y) *(unsigned short *)&(x[0]) = *(unsigned short *)&(y[0])
78#define NET_VALUE(x) (*(unsigned short *) &(x[0]))
1c79356b
A
79#define ATALK_ASSIGN(a, net, node, unused ) \
80 a.atalk_unused = unused; a.atalk_node = node; NET_ASSIGN(a.atalk_net, net)
81
82#define NET_EQUAL(a, b) (NET_VALUE(a) == NET_VALUE(b))
83#define NET_NOTEQ(a, b) (NET_VALUE(a) != NET_VALUE(b))
84#define NET_EQUAL0(a) (NET_VALUE(a) == 0)
85#define NET_NOTEQ0(a) (NET_VALUE(a) != 0)
86
87
88/*
89 AppleTalk Internet Address
90*/
91
92typedef struct at_inet {
93 u_short net; /* Network Address */
94 u_char node; /* Node number */
95 u_char socket; /* Socket number */
96} at_inet_t;
97
98/*
99 DDP Address for OT
100*/
101
102typedef struct ddp_addr {
103 at_inet_t inet;
104 u_short ddptype;
105} ddp_addr_t;
106
107/*
108 AppleTalk address
109*/
110
111struct at_addr {
112 u_short s_net; /* 16-bit network address */
113 u_char s_node; /* 8-bit node # (1-0xfd) */
114};
115
116/*
117 Appletalk sockaddr definition
118*/
119struct sockaddr_at {
120 u_char sat_len; /* total length */
121 u_char sat_family; /* address family (AF_APPLETALK) */
122 u_char sat_port; /* 8-bit "socket number" */
123 struct at_addr sat_addr; /* 16-bit "net" and 8-bit "node */
124 char sat_zero[8]; /* used for netrange in netatalk */
125};
126
127#define ATADDR_ANYNET (u_short)0x0000
128#define ATADDR_ANYNODE (u_char)0x00
129#define ATADDR_ANYPORT (u_char)0x00
130
131#define ATADDR_BCASTNODE (u_char)0xff /* There is no BCAST for NET */
132
133/* make sure the net, node and socket numbers are in legal range :
134 *
135 * Net# 0 Local Net
136 * 1 - 0xfffe Legal net nos
137 * 0xffff Reserved by Apple for future use.
138 * Node# 0 Illegal
139 * 1 - 0x7f Legal (user node id's)
140 * 0x80 - 0xfe Legal (server node id's; 0xfe illegal in
141 * Phase II nodes)
142 * 0xff Broadcast
143 * Socket# 0 Illegal
144 * 1 - 0xfe Legal
145 * 0xff Illegal
146 */
147#define valid_at_addr(addr) \
148 ((!(addr) || (addr)->net == 0xffff || (addr)->node == 0 || \
149 (addr)->socket == 0 || (addr)->socket == 0xff)? 0: 1)
150
151/*** * ETHERTYPE_ definitions are in netinet/if_ether.h *** */
152#define ETHERTYPE_AT 0x809B /* AppleTalk protocol */
153#define ETHERTYPE_AARP 0x80F3 /* AppleTalk ARP */
154
155/*
156 DDP protocol types
157*/
158
159#define DDP_RTMP 0x01
160#define DDP_NBP 0x02
161#define DDP_ATP 0x03
162#define DDP_ECHO 0x04
163#define DDP_RTMP_REQ 0x05
164#define DDP_ZIP 0x06
165#define DDP_ADSP 0x07
166
167/*
168 Protocols for the socket API
169*/
170
171#define ATPROTO_NONE 0 /* no corresponding DDP type exists */
172
173#define ATPROTO_ATP DDP_ATP /* must match DDP type */
174#define ATPROTO_ADSP DDP_ADSP /* must match DDP type */
175
176#define ATPROTO_DDP 249 /* *** to be eliminated eventually *** */
177#define ATPROTO_LAP 250 /* *** to be eliminated eventually *** */
178
179#define ATPROTO_AURP 251 /* no corresponding DDP type exists */
180#define ATPROTO_ASP 252 /* no corresponding DDP type exists */
181#define ATPROTO_AFP 253 /* no corresponding DDP type exists */
182
183#define ATPROTO_RAW 255 /* no corresponding DDP type exists */
184
185/*
186 Options for use with [gs]etsockopt at the DDP level.
187 First word of comment is data type; bool is stored in int.
188*/
189#define DDP_CHKSUM_ON 1 /* int; default = FALSE;
190 DDP checksums should be used */
191#define DDP_HDRINCL 2 /* int; default = FALSE;
192 header is included with data */
193#define DDP_GETSOCKNAME 3 /* used to get ddp_addr_t */
194#define DDP_SLFSND_ON 4 /* int; default = FALSE;
195 packets sent to the cable-multicast address
196 on this socket will be looped back */
197#define DDP_STRIPHDR 5 /* int; default = FALSE;
198 drop DDP header on receive (raw) */
199
200/*
201 AppleTalk protocol retry and timeout
202*/
203
204typedef struct at_retry {
205 short interval; /* Retry interval in seconds */
206 short retries; /* Maximum number of retries */
207 u_char backoff; /* Retry backoff, must be 1 through 4 */
208} at_retry_t;
209
210/*
211 Basic NBP Definitions needed for AppleTalk framework
212*/
213
214#define MAX_ZONES 50
215
216#define NBP_NVE_STR_SIZE 32 /* Maximum NBP tuple string size */
217typedef struct at_nvestr {
218 u_char len;
219 u_char str[NBP_NVE_STR_SIZE];
220} at_nvestr_t;
221
222/* Entity Name */
223typedef struct at_entity {
224 at_nvestr_t object;
225 at_nvestr_t type;
226 at_nvestr_t zone;
227} at_entity_t;
228
229#define NBP_TUPLE_SIZE ((3*NBP_NVE_STR_SIZE)+3)
230 /* 3 for field lengths + 3*32 for three names */
231typedef struct at_nbptuple {
232 at_inet_t enu_addr;
233 u_char enu_enum;
234 at_entity_t enu_entity;
235} at_nbptuple_t;
236
237/*
238 Basic ATP Definitions needed for LibcAT
239*/
240
241#define ATP_TRESP_MAX 8 /* Maximum number of Tresp pkts */
242
243/* Response buffer structure for atp_sendreq() and atp_sendrsp() */
244typedef struct at_resp {
245 u_char bitmap; /* Bitmap of responses */
246 u_char filler[3]; /* Force 68K to RISC alignment */
247 struct iovec resp[ATP_TRESP_MAX]; /* Buffer for response data */
248 long userdata[ATP_TRESP_MAX]; /* Buffer for response user data */
249} at_resp_t;
250
251/*
252 Needed for ASP and ADSP
253*/
254
255typedef struct {
256 int maxlen; /* max buffer length */
257 int len; /* length of data */
258 char *buf; /* pointer to buffer */
259} strbuf_t;
260
261#define IFID_HOME 1 /* home port in ifID_table */
262
263#define ATALK_VALUE(a) ((*(u_long *) &(a))&0x00ffffff)
6601e61a 264#define ATALK_EQUAL(a, b) (ATALK_VALUE(a) == ATALK_VALUE(b))
1c79356b
A
265
266#define VERSION_LENGTH 80 /* length of version string */
267
268/* struture containing general information regarding the state of
269 * the Appletalk networking
270 */
271typedef struct at_state {
272 unsigned int flags; /* various init flags */
273} at_state_t;
274
275/* at_state_t 'flags' defines */
9bccf70c
A
276#define AT_ST_STARTED 0x0001 /* set if protocol is fully enabled */
277#define AT_ST_STARTING 0x0002 /* set if interfaces are configured */
1c79356b
A
278#define AT_ST_MULTIHOME 0x0080 /* set if multihome mode */
279#define AT_ST_ROUTER 0x0100 /* set if we are a router */
280#define AT_ST_IF_CHANGED 0x0200 /* set when state of any I/F
281 changes (for SNMP) */
282#define AT_ST_RT_CHANGED 0x0400 /* route table changed (for SNMP)*/
283#define AT_ST_ZT_CHANGED 0x0800 /* zone table changed (for SNMP) */
284#define AT_ST_NBP_CHANGED 0x1000 /* if nbp table changed (for SNMP)*/
285
91447636 286#ifdef KERNEL_PRIVATE
1c79356b
A
287extern at_state_t at_state; /* global state of AT network */
288
289#define ROUTING_MODE (at_state.flags & AT_ST_ROUTER)
290#define MULTIHOME_MODE (at_state.flags & AT_ST_MULTIHOME)
291#define MULTIPORT_MODE (ROUTING_MODE || MULTIHOME_MODE)
91447636 292#endif /* KERNEL_PRIVATE */
1c79356b
A
293
294/* defines originally from h/at_elap.h */
295#define AT_ADDR 0
296#define ET_ADDR 1
297#define AT_ADDR_NO_LOOP 2 /* disables packets from looping back */
298
91447636 299#endif /* __APPLE_API_OBSOLETE */
1c79356b 300#endif /* _NETAT_APPLETALK_H_ */