1 /* $FreeBSD: src/sys/dev/hifn/hifn7751var.h,v 1.1.2.2 2003/06/04 17:56:59 sam Exp $ */ 2 /* $DragonFly: src/sys/dev/crypto/hifn/hifn7751var.h,v 1.2 2003/06/17 04:28:27 dillon Exp $ */ 3 /* $OpenBSD: hifn7751var.h,v 1.42 2002/04/08 17:49:42 jason Exp $ */ 4 5 /* 6 * Invertex AEON / Hifn 7751 driver 7 * Copyright (c) 1999 Invertex Inc. All rights reserved. 8 * Copyright (c) 1999 Theo de Raadt 9 * Copyright (c) 2000-2001 Network Security Technologies, Inc. 10 * http://www.netsec.net 11 * 12 * Please send any comments, feedback, bug-fixes, or feature requests to 13 * software@invertex.com. 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 * 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. The name of the author may not be used to endorse or promote products 25 * derived from this software without specific prior written permission. 26 * 27 * 28 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 29 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 30 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 31 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 32 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 33 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 34 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 35 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 36 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 37 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 38 * 39 * Effort sponsored in part by the Defense Advanced Research Projects 40 * Agency (DARPA) and Air Force Research Laboratory, Air Force 41 * Materiel Command, USAF, under agreement number F30602-01-2-0537. 42 * 43 */ 44 45 #ifndef __HIFN7751VAR_H__ 46 #define __HIFN7751VAR_H__ 47 48 #ifdef _KERNEL 49 50 /* 51 * Some configurable values for the driver. By default command+result 52 * descriptor rings are the same size. The src+dst descriptor rings 53 * are sized at 3.5x the number of potential commands. Slower parts 54 * (e.g. 7951) tend to run out of src descriptors; faster parts (7811) 55 * src+cmd/result descriptors. It's not clear that increasing the size 56 * of the descriptor rings helps performance significantly as other 57 * factors tend to come into play (e.g. copying misaligned packets). 58 */ 59 #define HIFN_D_CMD_RSIZE 24 /* command descriptors */ 60 #define HIFN_D_SRC_RSIZE ((HIFN_D_CMD_RSIZE * 7) / 2) /* source descriptors */ 61 #define HIFN_D_RES_RSIZE HIFN_D_CMD_RSIZE /* result descriptors */ 62 #define HIFN_D_DST_RSIZE HIFN_D_SRC_RSIZE /* destination descriptors */ 63 64 /* 65 * Length values for cryptography 66 */ 67 #define HIFN_DES_KEY_LENGTH 8 68 #define HIFN_3DES_KEY_LENGTH 24 69 #define HIFN_MAX_CRYPT_KEY_LENGTH HIFN_3DES_KEY_LENGTH 70 #define HIFN_IV_LENGTH 8 71 72 /* 73 * Length values for authentication 74 */ 75 #define HIFN_MAC_KEY_LENGTH 64 76 #define HIFN_MD5_LENGTH 16 77 #define HIFN_SHA1_LENGTH 20 78 #define HIFN_MAC_TRUNC_LENGTH 12 79 80 #define MAX_SCATTER 64 81 82 /* 83 * Data structure to hold all 4 rings and any other ring related data. 84 */ 85 struct hifn_dma { 86 /* 87 * Descriptor rings. We add +1 to the size to accomidate the 88 * jump descriptor. 89 */ 90 struct hifn_desc cmdr[HIFN_D_CMD_RSIZE+1]; 91 struct hifn_desc srcr[HIFN_D_SRC_RSIZE+1]; 92 struct hifn_desc dstr[HIFN_D_DST_RSIZE+1]; 93 struct hifn_desc resr[HIFN_D_RES_RSIZE+1]; 94 95 struct hifn_command *hifn_commands[HIFN_D_RES_RSIZE]; 96 97 u_char command_bufs[HIFN_D_CMD_RSIZE][HIFN_MAX_COMMAND]; 98 u_char result_bufs[HIFN_D_CMD_RSIZE][HIFN_MAX_RESULT]; 99 u_int32_t slop[HIFN_D_CMD_RSIZE]; 100 101 u_int64_t test_src, test_dst; 102 103 /* 104 * Our current positions for insertion and removal from the desriptor 105 * rings. 106 */ 107 int cmdi, srci, dsti, resi; 108 volatile int cmdu, srcu, dstu, resu; 109 int cmdk, srck, dstk, resk; 110 }; 111 112 struct hifn_session { 113 int hs_state; 114 int hs_prev_op; /* XXX collapse into hs_flags? */ 115 u_int8_t hs_iv[HIFN_IV_LENGTH]; 116 }; 117 118 #define HIFN_RING_SYNC(sc, r, i, f) \ 119 bus_dmamap_sync((sc)->sc_dmat, (sc)->sc_dmamap, (f)) 120 121 #define HIFN_CMDR_SYNC(sc, i, f) HIFN_RING_SYNC((sc), cmdr, (i), (f)) 122 #define HIFN_RESR_SYNC(sc, i, f) HIFN_RING_SYNC((sc), resr, (i), (f)) 123 #define HIFN_SRCR_SYNC(sc, i, f) HIFN_RING_SYNC((sc), srcr, (i), (f)) 124 #define HIFN_DSTR_SYNC(sc, i, f) HIFN_RING_SYNC((sc), dstr, (i), (f)) 125 126 #define HIFN_CMD_SYNC(sc, i, f) \ 127 bus_dmamap_sync((sc)->sc_dmat, (sc)->sc_dmamap, (f)) 128 129 #define HIFN_RES_SYNC(sc, i, f) \ 130 bus_dmamap_sync((sc)->sc_dmat, (sc)->sc_dmamap, (f)) 131 132 /* We use a state machine to on sessions */ 133 #define HS_STATE_FREE 0 /* unused session entry */ 134 #define HS_STATE_USED 1 /* allocated, but key not on card */ 135 #define HS_STATE_KEY 2 /* allocated and key is on card */ 136 137 /* 138 * Holds data specific to a single HIFN board. 139 */ 140 struct hifn_softc { 141 device_t sc_dev; /* device backpointer */ 142 bus_dma_tag_t sc_dmat; /* parent DMA tag decriptor */ 143 struct resource *sc_bar0res; 144 bus_space_handle_t sc_sh0; /* bar0 bus space handle */ 145 bus_space_tag_t sc_st0; /* bar0 bus space tag */ 146 bus_size_t sc_bar0_lastreg;/* bar0 last reg written */ 147 struct resource *sc_bar1res; 148 bus_space_handle_t sc_sh1; /* bar1 bus space handle */ 149 bus_space_tag_t sc_st1; /* bar1 bus space tag */ 150 bus_size_t sc_bar1_lastreg;/* bar1 last reg written */ 151 struct resource *sc_irq; 152 void *sc_intrhand; /* interrupt handle */ 153 154 u_int32_t sc_dmaier; 155 u_int32_t sc_drammodel; /* 1=dram, 0=sram */ 156 157 158 struct hifn_dma *sc_dma; 159 bus_dmamap_t sc_dmamap; 160 bus_dma_segment_t sc_dmasegs[1]; 161 bus_addr_t sc_dma_physaddr;/* physical address of sc_dma */ 162 int sc_dmansegs; 163 int32_t sc_cid; 164 int sc_maxses; 165 int sc_ramsize; 166 int sc_flags; 167 #define HIFN_HAS_RNG 0x1 /* includes random number generator */ 168 #define HIFN_HAS_PUBLIC 0x2 /* includes public key support */ 169 #define HIFN_IS_7811 0x4 /* Hifn 7811 part */ 170 struct callout sc_rngto; /* for polling RNG */ 171 struct callout sc_tickto; /* for managing DMA */ 172 int sc_rngfirst; 173 int sc_rnghz; /* RNG polling frequency */ 174 struct rndtest_state *sc_rndtest; /* RNG test state */ 175 void (*sc_harvest)(struct rndtest_state *, 176 void *, u_int); 177 int sc_c_busy; /* command ring busy */ 178 int sc_s_busy; /* source data ring busy */ 179 int sc_d_busy; /* destination data ring busy */ 180 int sc_r_busy; /* result ring busy */ 181 int sc_active; /* for initial countdown */ 182 int sc_needwakeup; /* ops q'd wating on resources */ 183 int sc_curbatch; /* # ops submitted w/o int */ 184 int sc_suspended; 185 struct hifn_session sc_sessions[2048]; 186 }; 187 188 /* 189 * hifn_command_t 190 * 191 * This is the control structure used to pass commands to hifn_encrypt(). 192 * 193 * flags 194 * ----- 195 * Flags is the bitwise "or" values for command configuration. A single 196 * encrypt direction needs to be set: 197 * 198 * HIFN_ENCODE or HIFN_DECODE 199 * 200 * To use cryptography, a single crypto algorithm must be included: 201 * 202 * HIFN_CRYPT_3DES or HIFN_CRYPT_DES 203 * 204 * To use authentication is used, a single MAC algorithm must be included: 205 * 206 * HIFN_MAC_MD5 or HIFN_MAC_SHA1 207 * 208 * By default MD5 uses a 16 byte hash and SHA-1 uses a 20 byte hash. 209 * If the value below is set, hash values are truncated or assumed 210 * truncated to 12 bytes: 211 * 212 * HIFN_MAC_TRUNC 213 * 214 * Keys for encryption and authentication can be sent as part of a command, 215 * or the last key value used with a particular session can be retrieved 216 * and used again if either of these flags are not specified. 217 * 218 * HIFN_CRYPT_NEW_KEY, HIFN_MAC_NEW_KEY 219 * 220 * session_num 221 * ----------- 222 * A number between 0 and 2048 (for DRAM models) or a number between 223 * 0 and 768 (for SRAM models). Those who don't want to use session 224 * numbers should leave value at zero and send a new crypt key and/or 225 * new MAC key on every command. If you use session numbers and 226 * don't send a key with a command, the last key sent for that same 227 * session number will be used. 228 * 229 * Warning: Using session numbers and multiboard at the same time 230 * is currently broken. 231 * 232 * mbuf 233 * ---- 234 * Either fill in the mbuf pointer and npa=0 or 235 * fill packp[] and packl[] and set npa to > 0 236 * 237 * mac_header_skip 238 * --------------- 239 * The number of bytes of the source_buf that are skipped over before 240 * authentication begins. This must be a number between 0 and 2^16-1 241 * and can be used by IPsec implementers to skip over IP headers. 242 * *** Value ignored if authentication not used *** 243 * 244 * crypt_header_skip 245 * ----------------- 246 * The number of bytes of the source_buf that are skipped over before 247 * the cryptographic operation begins. This must be a number between 0 248 * and 2^16-1. For IPsec, this number will always be 8 bytes larger 249 * than the auth_header_skip (to skip over the ESP header). 250 * *** Value ignored if cryptography not used *** 251 * 252 */ 253 struct hifn_operand { 254 union { 255 struct mbuf *m; 256 struct uio *io; 257 } u; 258 bus_dmamap_t map; 259 bus_size_t mapsize; 260 int nsegs; 261 bus_dma_segment_t segs[MAX_SCATTER]; 262 }; 263 struct hifn_command { 264 u_int16_t session_num; 265 u_int16_t base_masks, cry_masks, mac_masks; 266 u_int8_t iv[HIFN_IV_LENGTH], *ck, mac[HIFN_MAC_KEY_LENGTH]; 267 int cklen; 268 int sloplen, slopidx; 269 270 struct hifn_operand src; 271 struct hifn_operand dst; 272 273 struct hifn_softc *softc; 274 struct cryptop *crp; 275 struct cryptodesc *enccrd, *maccrd; 276 }; 277 278 #define src_m src.u.m 279 #define src_io src.u.io 280 #define src_map src.map 281 #define src_mapsize src.mapsize 282 #define src_segs src.segs 283 #define src_nsegs src.nsegs 284 285 #define dst_m dst.u.m 286 #define dst_io dst.u.io 287 #define dst_map dst.map 288 #define dst_mapsize dst.mapsize 289 #define dst_segs dst.segs 290 #define dst_nsegs dst.nsegs 291 292 /* 293 * Return values for hifn_crypto() 294 */ 295 #define HIFN_CRYPTO_SUCCESS 0 296 #define HIFN_CRYPTO_BAD_INPUT (-1) 297 #define HIFN_CRYPTO_RINGS_FULL (-2) 298 299 /************************************************************************** 300 * 301 * Function: hifn_crypto 302 * 303 * Purpose: Called by external drivers to begin an encryption on the 304 * HIFN board. 305 * 306 * Blocking/Non-blocking Issues 307 * ============================ 308 * The driver cannot block in hifn_crypto (no calls to tsleep) currently. 309 * hifn_crypto() returns HIFN_CRYPTO_RINGS_FULL if there is not enough 310 * room in any of the rings for the request to proceed. 311 * 312 * Return Values 313 * ============= 314 * 0 for success, negative values on error 315 * 316 * Defines for negative error codes are: 317 * 318 * HIFN_CRYPTO_BAD_INPUT : The passed in command had invalid settings. 319 * HIFN_CRYPTO_RINGS_FULL : All DMA rings were full and non-blocking 320 * behaviour was requested. 321 * 322 *************************************************************************/ 323 324 /* 325 * Convert back and forth from 'sid' to 'card' and 'session' 326 */ 327 #define HIFN_CARD(sid) (((sid) & 0xf0000000) >> 28) 328 #define HIFN_SESSION(sid) ((sid) & 0x000007ff) 329 #define HIFN_SID(crd,ses) (((crd) << 28) | ((ses) & 0x7ff)) 330 331 #endif /* _KERNEL */ 332 333 struct hifn_stats { 334 u_int64_t hst_ibytes; 335 u_int64_t hst_obytes; 336 u_int32_t hst_ipackets; 337 u_int32_t hst_opackets; 338 u_int32_t hst_invalid; 339 u_int32_t hst_nomem; /* malloc or one of hst_nomem_* */ 340 u_int32_t hst_abort; 341 u_int32_t hst_noirq; /* IRQ for no reason */ 342 u_int32_t hst_totbatch; /* ops submitted w/o interrupt */ 343 u_int32_t hst_maxbatch; /* max ops submitted together */ 344 u_int32_t hst_unaligned; /* unaligned src caused copy */ 345 /* 346 * The following divides hst_nomem into more specific buckets. 347 */ 348 u_int32_t hst_nomem_map; /* bus_dmamap_create failed */ 349 u_int32_t hst_nomem_load; /* bus_dmamap_load_* failed */ 350 u_int32_t hst_nomem_mbuf; /* MGET* failed */ 351 u_int32_t hst_nomem_mcl; /* MCLGET* failed */ 352 u_int32_t hst_nomem_cr; /* out of command/result descriptor */ 353 u_int32_t hst_nomem_sd; /* out of src/dst descriptors */ 354 }; 355 356 #endif /* __HIFN7751VAR_H__ */ 357