xref: /xnu-8792.61.2/bsd/netinet/bootp.h (revision 42e220869062b56f8d7d0726fd4c88954f87902c)
1 /*
2  * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
3  *
4  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5  *
6  * This file contains Original Code and/or Modifications of Original Code
7  * as defined in and that are subject to the Apple Public Source License
8  * Version 2.0 (the 'License'). You may not use this file except in
9  * compliance with the License. The rights granted to you under the License
10  * may not be used to create, or enable the creation or redistribution of,
11  * unlawful or unlicensed copies of an Apple operating system, or to
12  * circumvent, violate, or enable the circumvention or violation of, any
13  * terms of an Apple operating system software license agreement.
14  *
15  * Please obtain a copy of the License at
16  * http://www.opensource.apple.com/apsl/ and read it before using this file.
17  *
18  * The Original Code and all software distributed under the License are
19  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23  * Please see the License for the specific language governing rights and
24  * limitations under the License.
25  *
26  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27  */
28 /*
29  * Bootstrap Protocol (BOOTP).  RFC 951.
30  */
31 /*
32  * HISTORY
33  *
34  * 14 May 1992 ? at NeXT
35  *	Added correct padding to struct nextvend.  This is
36  *	needed for the i386 due to alignment differences wrt
37  *	the m68k.  Also adjusted the size of the array fields
38  *	because the NeXT vendor area was overflowing the bootp
39  *	packet.
40  */
41 
42 #include <netinet/in.h>
43 #include <netinet/ip.h>
44 #include <netinet/udp.h>
45 
46 #define iaddr_t struct in_addr
47 
48 struct bootp {
49 	u_char  bp_op;          /* packet opcode type */
50 #define BOOTREQUEST     1
51 #define BOOTREPLY       2
52 	u_char  bp_htype;       /* hardware addr type */
53 	u_char  bp_hlen;        /* hardware addr length */
54 	u_char  bp_hops;        /* gateway hops */
55 	u_int32_t bp_xid;       /* transaction ID */
56 	u_short bp_secs;        /* seconds since boot began */
57 	u_short bp_unused;
58 	iaddr_t bp_ciaddr;      /* client IP address */
59 	iaddr_t bp_yiaddr;      /* 'your' IP address */
60 	iaddr_t bp_siaddr;      /* server IP address */
61 	iaddr_t bp_giaddr;      /* gateway IP address */
62 	u_char  bp_chaddr[16];  /* client hardware address */
63 	u_char  bp_sname[64];   /* server host name */
64 	u_char  bp_file[128];   /* boot file name */
65 	u_char  bp_vend[64];    /* vendor-specific area */
66 };
67 
68 /*
69  * UDP port numbers, server and client.
70  */
71 #define IPPORT_BOOTPS           67
72 #define IPPORT_BOOTPC           68
73 
74 /*
75  * "vendor" data permitted for Stanford boot clients.
76  */
77 struct vend {
78 	u_char  v_magic[4];     /* magic number */
79 	u_int32_t v_flags;      /* flags/opcodes, etc. */
80 	u_char  v_unused[56];   /* currently unused */
81 };
82 #define VM_STANFORD     "STAN"  /* v_magic for Stanford */
83 
84 /* v_flags values */
85 #define VF_PCBOOT       1       /* an IBMPC or Mac wants environment info */
86 #define VF_HELP         2       /* help me, I'm not registered */
87 
88 #define NVMAXTEXT       55      /* don't change this, it just fits RFC951 */
89 struct nextvend {
90 	u_char nv_magic[4];     /* Magic number for vendor specificity */
91 	u_char nv_version;      /* NeXT protocol version */
92 	/*
93 	 * Round the beginning
94 	 * of the union to a 16
95 	 * bit boundary due to
96 	 * struct/union alignment
97 	 * on the m68k.
98 	 */
99 	unsigned short  :0;
100 	union {
101 		u_char NV0[58];
102 		struct {
103 			u_char NV1_opcode;      /* opcode - Version 1 */
104 			u_char NV1_xid; /* transcation id */
105 			u_char NV1_text[NVMAXTEXT];     /* text */
106 			u_char NV1_null;        /* null terminator */
107 		} NV1;
108 	} nv_U;
109 };
110 #define nv_unused       nv_U.NV0
111 #define nv_opcode       nv_U.NV1.NV1_opcode
112 #define nv_xid          nv_U.NV1.NV1_xid
113 #define nv_text         nv_U.NV1.NV1_text
114 #define nv_null         nv_U.NV1.NV1_null
115 
116 /* Magic number */
117 #define VM_NEXT         "NeXT"  /* v_magic for NeXT, Inc. */
118 
119 /* Opcodes */
120 #define BPOP_OK         0
121 #define BPOP_QUERY      1
122 #define BPOP_QUERY_NE   2
123 #define BPOP_ERROR      3
124 
125 struct bootp_packet {
126 	struct ip bp_ip;
127 	struct udphdr bp_udp;
128 	struct bootp bp_bootp;
129 };
130 
131 #define BOOTP_PKTSIZE (sizeof (struct bootp_packet))
132 
133 /* backoffs must be masks */
134 #define BOOTP_MIN_BACKOFF       0x7ff           /* 2.048 sec */
135 #define BOOTP_MAX_BACKOFF       0xffff          /* 65.535 sec */
136 #define BOOTP_RETRY             6               /* # retries */
137