1/* $NetBSD: rmp_var.h,v 1.10 2003/08/07 11:25:41 agc Exp $ */ 2 3/* 4 * Copyright (c) 1988, 1992 The University of Utah and the Center 5 * for Software Science (CSS). 6 * Copyright (c) 1992, 1993 7 * The Regents of the University of California. All rights reserved. 8 * 9 * This code is derived from software contributed to Berkeley by 10 * the Center for Software Science of the University of Utah Computer 11 * Science Department. CSS requests users of this software to return 12 * to css-dist@cs.utah.edu any improvements that they make and grant 13 * CSS redistribution rights. 14 * 15 * Redistribution and use in source and binary forms, with or without 16 * modification, are permitted provided that the following conditions 17 * are met: 18 * 1. Redistributions of source code must retain the above copyright 19 * notice, this list of conditions and the following disclaimer. 20 * 2. Redistributions in binary form must reproduce the above copyright 21 * notice, this list of conditions and the following disclaimer in the 22 * documentation and/or other materials provided with the distribution. 23 * 3. Neither the name of the University nor the names of its contributors 24 * may be used to endorse or promote products derived from this software 25 * without specific prior written permission. 26 * 27 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 28 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 29 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 30 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 31 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 32 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 33 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 34 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 35 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 36 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 37 * SUCH DAMAGE. 38 * 39 * from: @(#)rmp_var.h 8.1 (Berkeley) 6/4/93 40 * 41 * from: Utah Hdr: rmp_var.h 3.1 92/07/06 42 * Author: Jeff Forys, University of Utah CSS 43 */ 44 45/* 46 * Possible values for "rmp_type" fields. 47 */ 48 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 */ 54 55/* 56 * Useful constants. 57 */ 58 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 */ 64 65/* 66 * RMP error codes 67 */ 68 69#define RMP_E_OKAY 0 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 */ 80 81/* 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. 84 */ 85#define RMPDATALEN (RMP_MAX_PACKET - (sizeof(struct hp_hdr) + \ 86 sizeof(struct hp_llc))) 87 88/* 89 * Define sizes of packets we send. Boot and Read replies are variable 90 * in length depending on the length of `s'. 91 * 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. 95 */ 96 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) \ 101 - sizeof(u_int8_t)) 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))) 107 108/* 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. 112 */ 113 114typedef char restofpkt; 115 116/* 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) 32-bit words 119 * on half-word (16-bit) boundaries. If you know that your machine does 120 * not suffer from this problem, add it to the vax/tahoe/m68k #define below. 121 * Don't confuse this with structure packing, which for ELF objects we 122 * need to specify regardless. 123 * 124 * The following macros are used to deal with this problem: 125 * WORDZE(w) Return True if u_word `w' is zero, False otherwise. 126 * ZEROWORD(w) Set u_word `w' to zero. 127 * COPYWORD(w1,w2) Copy u_word `w1' to `w2'. 128 * GETWORD(w,i) Copy u_word `w' into int `i'. 129 * PUTWORD(i,w) Copy int `i' into u_word `w'. 130 * 131 * N.B. Endianness is handled by use of ntohl/htonl 132 */ 133#if defined(__vax__) || defined(__tahoe__) || defined(__m68k__) 134 135typedef u_int32_t u_word; 136 137#define WORDZE(w) ((w) == 0) 138#define ZEROWORD(w) (w) = 0 139#define COPYWORD(w1,w2) (w2) = (w1) 140#define GETWORD(w, i) (i) = ntohl(w) 141#define PUTWORD(i, w) (w) = htonl(i) 142 143#else 144 145#define _WORD_HIGHPART 0 146#define _WORD_LOWPART 1 147 148typedef struct _uword { u_int16_t val[2]; } u_word; 149 150#define WORDZE(w) \ 151 ((w.val[_WORD_HIGHPART] == 0) && (w.val[_WORD_LOWPART] == 0)) 152#define ZEROWORD(w) \ 153 (w).val[_WORD_HIGHPART] = (w).val[_WORD_LOWPART] = 0 154#define COPYWORD(w1, w2) \ 155 { (w2).val[_WORD_HIGHPART] = (w1).val[_WORD_HIGHPART]; \ 156 (w2).val[_WORD_LOWPART] = (w1).val[_WORD_LOWPART]; \ 157 } 158#define GETWORD(w, i) \ 159 (i) = (((u_int32_t)ntohs((w).val[_WORD_HIGHPART])) << 16) | ntohs((w).val[_WORD_LOWPART]) 160#define PUTWORD(i, w) \ 161 { (w).val[_WORD_HIGHPART] = htons((u_int16_t) ((i >> 16) & 0xffff)); \ 162 (w).val[_WORD_LOWPART] = htons((u_int16_t) (i & 0xffff)); \ 163 } 164 165#endif 166 167/* 168 * Packet structures. 169 */ 170 171struct rmp_raw { /* generic RMP packet */ 172 u_int8_t rmp_type; /* packet type */ 173 u_int8_t rmp_rawdata[RMPDATALEN-1]; 174}; 175 176struct rmp_boot_req { /* boot request */ 177 u_int8_t rmp_type; /* packet type (RMP_BOOT_REQ) */ 178 u_int8_t rmp_retcode; /* return code (0) */ 179 u_word rmp_seqno; /* sequence number (real time clock) */ 180 u_int16_t rmp_session; /* session id (normally 0) */ 181 u_int16_t rmp_version; /* protocol version (RMP_VERSION) */ 182 char rmp_machtype[RMP_MACHLEN]; /* machine type */ 183 u_int8_t rmp_flnmsize; /* length of rmp_flnm */ 184 restofpkt rmp_flnm; /* name of file to be read */ 185} __attribute__((__packed__)); 186 187struct rmp_boot_repl { /* boot reply */ 188 u_int8_t rmp_type; /* packet type (RMP_BOOT_REPL) */ 189 u_int8_t rmp_retcode; /* return code (normally 0) */ 190 u_word rmp_seqno; /* sequence number (from boot req) */ 191 u_int16_t rmp_session; /* session id (generated) */ 192 u_int16_t rmp_version; /* protocol version (RMP_VERSION) */ 193 u_int8_t rmp_flnmsize; /* length of rmp_flnm */ 194 restofpkt rmp_flnm; /* name of file (from boot req) */ 195} __attribute__((__packed__)); 196 197struct rmp_read_req { /* read request */ 198 u_int8_t rmp_type; /* packet type (RMP_READ_REQ) */ 199 u_int8_t rmp_retcode; /* return code (0) */ 200 u_word rmp_offset; /* file relative byte offset */ 201 u_int16_t rmp_session; /* session id (from boot repl) */ 202 u_int16_t rmp_size; /* max no of bytes to send */ 203} __attribute__((__packed__)); 204 205struct rmp_read_repl { /* read reply */ 206 u_int8_t rmp_type; /* packet type (RMP_READ_REPL) */ 207 u_int8_t rmp_retcode; /* return code (normally 0) */ 208 u_word rmp_offset; /* byte offset (from read req) */ 209 u_int16_t rmp_session; /* session id (from read req) */ 210 restofpkt rmp_data; /* data (max size from read req) */ 211 u_int8_t rmp_unused; /* padding to 16-bit boundary */ 212} __attribute__((__packed__)); 213 214struct rmp_boot_done { /* boot complete */ 215 u_int8_t rmp_type; /* packet type (RMP_BOOT_DONE) */ 216 u_int8_t rmp_retcode; /* return code (0) */ 217 u_word rmp_unused; /* not used (0) */ 218 u_int16_t rmp_session; /* session id (from read repl) */ 219} __attribute__((__packed__)); 220 221struct rmp_packet { 222 struct hp_hdr hp_hdr; 223 struct hp_llc hp_llc; 224 union { 225 struct rmp_boot_req rmp_brq; /* boot request */ 226 struct rmp_boot_repl rmp_brpl; /* boot reply */ 227 struct rmp_read_req rmp_rrq; /* read request */ 228 struct rmp_read_repl rmp_rrpl; /* read reply */ 229 struct rmp_boot_done rmp_done; /* boot complete */ 230 struct rmp_raw rmp_raw; /* raw data */ 231 } rmp_proto; 232}; 233 234/* 235 * Make life easier... 236 */ 237 238#define r_type rmp_proto.rmp_raw.rmp_type 239#define r_data rmp_proto.rmp_raw.rmp_rawdata 240#define r_brq rmp_proto.rmp_brq 241#define r_brpl rmp_proto.rmp_brpl 242#define r_rrq rmp_proto.rmp_rrq 243#define r_rrpl rmp_proto.rmp_rrpl 244#define r_done rmp_proto.rmp_done 245