2 * Copyright (c) 1988, 1992 The University of Utah and the Center
3 * for Software Science (CSS).
4 * Copyright (c) 1992, 1993
5 * The Regents of the University of California. All rights reserved.
7 * This code is derived from software contributed to Berkeley by
8 * the Center for Software Science of the University of Utah Computer
9 * Science Department. CSS requests users of this software to return
10 * to css-dist@cs.utah.edu any improvements that they make and grant
11 * CSS redistribution rights.
13 * Redistribution and use in source and binary forms, with or without
14 * modification, are permitted provided that the following conditions
16 * 1. Redistributions of source code must retain the above copyright
17 * notice, this list of conditions and the following disclaimer.
18 * 2. Redistributions in binary form must reproduce the above copyright
19 * notice, this list of conditions and the following disclaimer in the
20 * documentation and/or other materials provided with the distribution.
21 * 3. Neither the name of the University nor the names of its contributors
22 * may be used to endorse or promote products derived from this software
23 * without specific prior written permission.
25 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
26 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
28 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
29 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
30 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
31 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
32 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
33 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
34 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
37 * from: @(#)rmp_var.h 8.1 (Berkeley) 6/4/93
39 * from: Utah Hdr: rmp_var.h 3.1 92/07/06
40 * Author: Jeff Forys, University of Utah CSS
46 * Possible values for "rmp_type" fields.
49 #define RMP_BOOT_REQ 1 /* boot request packet */
50 #define RMP_BOOT_REPL 129 /* boot reply packet */
51 #define RMP_READ_REQ 2 /* read request packet */
52 #define RMP_READ_REPL 130 /* read reply packet */
53 #define RMP_BOOT_DONE 3 /* boot complete packet */
59 #define RMP_VERSION 2 /* protocol version */
60 #define RMP_TIMEOUT 600 /* timeout connection after ten minutes */
61 #define RMP_PROBESID 0xffff /* session ID for probes */
62 #define RMP_HOSTLEN 13 /* max length of server's name */
63 #define RMP_MACHLEN 20 /* length of machine type field */
70 #define RMP_E_EOF 2 /* read reply: returned end of file */
71 #define RMP_E_ABORT 3 /* abort operation */
72 #define RMP_E_BUSY 4 /* boot reply: server busy */
73 #define RMP_E_TIMEOUT 5 /* lengthen time out (not implemented) */
74 #define RMP_E_NOFILE 16 /* boot reply: file does not exist */
75 #define RMP_E_OPENFILE 17 /* boot reply: file open failed */
76 #define RMP_E_NODFLT 18 /* boot reply: default file does not exist */
77 #define RMP_E_OPENDFLT 19 /* boot reply: default file open failed */
78 #define RMP_E_BADSID 25 /* read reply: bad session ID */
79 #define RMP_E_BADPACKET 27 /* Bad packet detected */
82 * RMPDATALEN is the maximum number of data octets that can be stuffed
83 * into an RMP packet. This excludes the 802.2 LLC w/HP extensions.
85 #define RMPDATALEN (RMP_MAX_PACKET - (sizeof(struct hp_hdr) + \
86 sizeof(struct hp_llc)))
89 * Define sizes of packets we send. Boot and Read replies are variable
90 * in length depending on the length of `s'.
92 * Also, define how much space `restofpkt' can take up for outgoing
93 * Boot and Read replies. Boot Request packets are effectively
94 * limited to 255 bytes due to the preceding 1-byte length field.
97 #define RMPBOOTSIZE(s) (sizeof(struct hp_hdr) + sizeof(struct hp_llc) + \
98 sizeof(struct rmp_boot_repl) + s - sizeof(restofpkt))
99 #define RMPREADSIZE(s) (sizeof(struct hp_hdr) + sizeof(struct hp_llc) + \
100 sizeof(struct rmp_read_repl) + s - sizeof(restofpkt) \
102 #define RMPDONESIZE (sizeof(struct hp_hdr) + sizeof(struct hp_llc) + \
103 sizeof(struct rmp_boot_done))
104 #define RMPBOOTDATA 255
105 #define RMPREADDATA (RMPDATALEN - \
106 (2*sizeof(u_int8_t)+sizeof(u_int16_t)+sizeof(u_word)))
109 * This protocol defines some field sizes as "rest of ethernet packet".
110 * There is no easy way to specify this in C, so we use a one character
111 * field to denote it, and index past it to the end of the packet.
114 typedef char restofpkt;
117 * Due to the RMP packet layout, we'll run into alignment problems
118 * on machines that can't access (or don't, by default, align) words
119 * on half-word boundaries. If you know that your machine does not suffer
120 * from this problem, add it to the vax/tahoe/m68k #define below.
122 * The following macros are used to deal with this problem:
123 * WORDZE(w) Return True if u_word `w' is zero, False otherwise.
124 * ZEROWORD(w) Set u_word `w' to zero.
125 * COPYWORD(w1,w2) Copy u_word `w1' to `w2'.
126 * GETWORD(w,i) Copy u_word `w' into int `i'.
127 * PUTWORD(i,w) Copy int `i' into u_word `w'.
129 * N.B. Endianness is handled by use of ntohl/htonl
131 #if defined(__vax__) || defined(__tahoe__) || defined(__m68k__)
133 typedef u_int32_t u_word;
135 #define WORDZE(w) ((w) == 0)
136 #define ZEROWORD(w) (w) = 0
137 #define COPYWORD(w1,w2) (w2) = (w1)
138 #define GETWORD(w, i) (i) = ntohl(w)
139 #define PUTWORD(i, w) (w) = htonl(i)
143 #define _WORD_HIGHPART 0
144 #define _WORD_LOWPART 1
146 typedef struct _uword { u_int16_t val[2]; } u_word;
149 ((w.val[_WORD_HIGHPART] == 0) && (w.val[_WORD_LOWPART] == 0))
150 #define ZEROWORD(w) \
151 (w).val[_WORD_HIGHPART] = (w).val[_WORD_LOWPART] = 0
152 #define COPYWORD(w1, w2) \
153 { (w2).val[_WORD_HIGHPART] = (w1).val[_WORD_HIGHPART]; \
154 (w2).val[_WORD_LOWPART] = (w1).val[_WORD_LOWPART]; \
156 #define GETWORD(w, i) \
157 (i) = (((u_int32_t)ntohs((w).val[_WORD_HIGHPART])) << 16) | ntohs((w).val[_WORD_LOWPART])
158 #define PUTWORD(i, w) \
159 { (w).val[_WORD_HIGHPART] = htons((u_int16_t) ((i >> 16) & 0xffff)); \
160 (w).val[_WORD_LOWPART] = htons((u_int16_t) (i & 0xffff)); \
169 struct rmp_raw { /* generic RMP packet */
170 u_int8_t rmp_type; /* packet type */
171 u_int8_t rmp_rawdata[RMPDATALEN-1];
174 struct rmp_boot_req { /* boot request */
175 u_int8_t rmp_type; /* packet type (RMP_BOOT_REQ) */
176 u_int8_t rmp_retcode; /* return code (0) */
177 u_word rmp_seqno; /* sequence number (real time clock) */
178 u_int16_t rmp_session; /* session id (normally 0) */
179 u_int16_t rmp_version; /* protocol version (RMP_VERSION) */
180 char rmp_machtype[RMP_MACHLEN]; /* machine type */
181 u_int8_t rmp_flnmsize; /* length of rmp_flnm */
182 restofpkt rmp_flnm; /* name of file to be read */
185 struct rmp_boot_repl { /* boot reply */
186 u_int8_t rmp_type; /* packet type (RMP_BOOT_REPL) */
187 u_int8_t rmp_retcode; /* return code (normally 0) */
188 u_word rmp_seqno; /* sequence number (from boot req) */
189 u_int16_t rmp_session; /* session id (generated) */
190 u_int16_t rmp_version; /* protocol version (RMP_VERSION) */
191 u_int8_t rmp_flnmsize; /* length of rmp_flnm */
192 restofpkt rmp_flnm; /* name of file (from boot req) */
195 struct rmp_read_req { /* read request */
196 u_int8_t rmp_type; /* packet type (RMP_READ_REQ) */
197 u_int8_t rmp_retcode; /* return code (0) */
198 u_word rmp_offset; /* file relative byte offset */
199 u_int16_t rmp_session; /* session id (from boot repl) */
200 u_int16_t rmp_size; /* max no of bytes to send */
203 struct rmp_read_repl { /* read reply */
204 u_int8_t rmp_type; /* packet type (RMP_READ_REPL) */
205 u_int8_t rmp_retcode; /* return code (normally 0) */
206 u_word rmp_offset; /* byte offset (from read req) */
207 u_int16_t rmp_session; /* session id (from read req) */
208 restofpkt rmp_data; /* data (max size from read req) */
209 u_int8_t rmp_unused; /* padding to 16-bit boundary */
212 struct rmp_boot_done { /* boot complete */
213 u_int8_t rmp_type; /* packet type (RMP_BOOT_DONE) */
214 u_int8_t rmp_retcode; /* return code (0) */
215 u_word rmp_unused; /* not used (0) */
216 u_int16_t rmp_session; /* session id (from read repl) */
220 struct hp_hdr hp_hdr;
221 struct hp_llc hp_llc;
223 struct rmp_boot_req rmp_brq; /* boot request */
224 struct rmp_boot_repl rmp_brpl; /* boot reply */
225 struct rmp_read_req rmp_rrq; /* read request */
226 struct rmp_read_repl rmp_rrpl; /* read reply */
227 struct rmp_boot_done rmp_done; /* boot complete */
228 struct rmp_raw rmp_raw; /* raw data */
233 * Make life easier...
236 #define r_type rmp_proto.rmp_raw.rmp_type
237 #define r_data rmp_proto.rmp_raw.rmp_rawdata
238 #define r_brq rmp_proto.rmp_brq
239 #define r_brpl rmp_proto.rmp_brpl
240 #define r_rrq rmp_proto.rmp_rrq
241 #define r_rrpl rmp_proto.rmp_rrpl
242 #define r_done rmp_proto.rmp_done