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