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