package/ubsec_ssb/src/ubsecreg.h

   1 /* $Id: $ */
   2
   3 /*
   4  * Copyright (c) 2008 Daniel Mueller (daniel@danm.de)
   5  * Copyright (c) 2000 Theo de Raadt
   6  * Copyright (c) 2001 Patrik Lindergren (patrik@ipunplugged.com)
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  *
  12  * 1. Redistributions of source code must retain the above copyright
  13  *    notice, this list of conditions and the following disclaimer.
  14  * 2. Redistributions in binary form must reproduce the above copyright
  15  *    notice, this list of conditions and the following disclaimer in the
  16  *    documentation and/or other materials provided with the distribution.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  19  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  20  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  21  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  22  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  23  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  24  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  25  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  26  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  27  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28  *
  29  * Effort sponsored in part by the Defense Advanced Research Projects
  30  * Agency (DARPA) and Air Force Research Laboratory, Air Force
  31  * Materiel Command, USAF, under agreement number F30602-01-2-0537.
  32  *
  33  */
  34
  35 /*
  36  * Register definitions for 5601 BlueSteel Networks Ubiquitous Broadband
  37  * Security "uBSec" chip.  Definitions from revision 2.8 of the product
  38  * datasheet.
  39  */
  40
  41 #define BS_BAR          0x10    /* DMA base address register */
  42 #define BS_TRDY_TIMEOUT     0x40    /* TRDY timeout */
  43 #define BS_RETRY_TIMEOUT    0x41    /* DMA retry timeout */
  44
  45 #define UBS_PCI_RTY_SHIFT           8
  46 #define UBS_PCI_RTY_MASK            0xff
  47 #define UBS_PCI_RTY(misc) \
  48     (((misc) >> UBS_PCI_RTY_SHIFT) & UBS_PCI_RTY_MASK)
  49
  50 #define UBS_PCI_TOUT_SHIFT          0
  51 #define UBS_PCI_TOUT_MASK           0xff
  52 #define UBS_PCI_TOUT(misc) \
  53     (((misc) >> PCI_TOUT_SHIFT) & PCI_TOUT_MASK)
  54
  55 /*
  56  * DMA Control & Status Registers (offset from BS_BAR)
  57  */
  58 #define BS_MCR1     0x20    /* DMA Master Command Record 1 */
  59 #define BS_CTRL     0x24    /* DMA Control */
  60 #define BS_STAT     0x28    /* DMA Status */
  61 #define BS_ERR      0x2c    /* DMA Error Address */
  62 #define BS_DEV_ID   0x34    /* IPSec Device ID */
  63
  64 /* BS_CTRL - DMA Control */
  65 #define BS_CTRL_RESET       0x80000000  /* hardware reset, 5805/5820 */
  66 #define BS_CTRL_MCR2INT     0x40000000  /* enable intr MCR for MCR2 */
  67 #define BS_CTRL_MCR1INT     0x20000000  /* enable intr MCR for MCR1 */
  68 #define BS_CTRL_OFM     0x10000000  /* Output fragment mode */
  69 #define BS_CTRL_BE32        0x08000000  /* big-endian, 32bit bytes */
  70 #define BS_CTRL_BE64        0x04000000  /* big-endian, 64bit bytes */
  71 #define BS_CTRL_DMAERR      0x02000000  /* enable intr DMA error */
  72 #define BS_CTRL_RNG_M       0x01800000  /* RNG mode */
  73 #define BS_CTRL_RNG_1       0x00000000  /* 1bit rn/one slow clock */
  74 #define BS_CTRL_RNG_4       0x00800000  /* 1bit rn/four slow clocks */
  75 #define BS_CTRL_RNG_8       0x01000000  /* 1bit rn/eight slow clocks */
  76 #define BS_CTRL_RNG_16      0x01800000  /* 1bit rn/16 slow clocks */
  77 #define BS_CTRL_SWNORM      0x00400000  /* 582[01], sw normalization */
  78 #define BS_CTRL_FRAG_M      0x0000ffff  /* output fragment size mask */
  79 #define BS_CTRL_LITTLE_ENDIAN   (BS_CTRL_BE32 | BS_CTRL_BE64)
  80
  81 /* BS_STAT - DMA Status */
  82 #define BS_STAT_MCR1_BUSY   0x80000000  /* MCR1 is busy */
  83 #define BS_STAT_MCR1_FULL   0x40000000  /* MCR1 is full */
  84 #define BS_STAT_MCR1_DONE   0x20000000  /* MCR1 is done */
  85 #define BS_STAT_DMAERR      0x10000000  /* DMA error */
  86 #define BS_STAT_MCR2_FULL   0x08000000  /* MCR2 is full */
  87 #define BS_STAT_MCR2_DONE   0x04000000  /* MCR2 is done */
  88 #define BS_STAT_MCR1_ALLEMPTY   0x02000000  /* 5821, MCR1 is empty */
  89 #define BS_STAT_MCR2_ALLEMPTY   0x01000000  /* 5821, MCR2 is empty */
  90
  91 /* BS_ERR - DMA Error Address */
  92 #define BS_ERR_ADDR     0xfffffffc  /* error address mask */
  93 #define BS_ERR_READ     0x00000002  /* fault was on read */
  94
  95 struct ubsec_pktctx {
  96     u_int32_t   pc_deskey[6];       /* 3DES key */
  97     u_int32_t   pc_hminner[5];      /* hmac inner state */
  98     u_int32_t   pc_hmouter[5];      /* hmac outer state */
  99     u_int32_t   pc_iv[2];       /* [3]DES iv */
 100     u_int16_t   pc_flags;       /* flags, below */
 101     u_int16_t   pc_offset;      /* crypto offset */
 102 } __attribute__ ((packed));
 103
 104 #define UBS_PKTCTX_ENC_3DES 0x8000      /* use 3des */
 105 #define UBS_PKTCTX_ENC_AES  0x8000      /* use aes */
 106 #define UBS_PKTCTX_ENC_NONE 0x0000      /* no encryption */
 107 #define UBS_PKTCTX_INBOUND  0x4000      /* inbound packet */
 108 #define UBS_PKTCTX_AUTH     0x3000      /* authentication mask */
 109 #define UBS_PKTCTX_AUTH_NONE    0x0000      /* no authentication */
 110 #define UBS_PKTCTX_AUTH_MD5 0x1000      /* use hmac-md5 */
 111 #define UBS_PKTCTX_AUTH_SHA1    0x2000      /* use hmac-sha1 */
 112 #define UBS_PKTCTX_AES128   0x0         /* AES 128bit keys */
 113 #define UBS_PKTCTX_AES192   0x100       /* AES 192bit keys */
 114 #define UBS_PKTCTX_AES256   0x200       /* AES 256bit keys */
 115
 116 struct ubsec_pktctx_des {
 117     volatile u_int16_t  pc_len;     /* length of ctx struct */
 118     volatile u_int16_t  pc_type;    /* context type */
 119     volatile u_int16_t  pc_flags;   /* flags, same as above */
 120     volatile u_int16_t  pc_offset;  /* crypto/auth offset */
 121     volatile u_int32_t  pc_deskey[6];   /* 3DES key */
 122     volatile u_int32_t  pc_iv[2];   /* [3]DES iv */
 123     volatile u_int32_t  pc_hminner[5];  /* hmac inner state */
 124     volatile u_int32_t  pc_hmouter[5];  /* hmac outer state */
 125 } __attribute__ ((packed));
 126
 127 struct ubsec_pktctx_aes128 {
 128     volatile u_int16_t  pc_len;         /* length of ctx struct */
 129     volatile u_int16_t  pc_type;        /* context type */
 130     volatile u_int16_t  pc_flags;       /* flags, same as above */
 131     volatile u_int16_t  pc_offset;      /* crypto/auth offset */
 132     volatile u_int32_t  pc_aeskey[4];   /* AES 128bit key */
 133     volatile u_int32_t  pc_iv[4];       /* AES iv */
 134     volatile u_int32_t  pc_hminner[5];  /* hmac inner state */
 135     volatile u_int32_t  pc_hmouter[5];  /* hmac outer state */
 136 } __attribute__ ((packed));
 137
 138 struct ubsec_pktctx_aes192 {
 139     volatile u_int16_t  pc_len;         /* length of ctx struct */
 140     volatile u_int16_t  pc_type;        /* context type */
 141     volatile u_int16_t  pc_flags;       /* flags, same as above */
 142     volatile u_int16_t  pc_offset;      /* crypto/auth offset */
 143     volatile u_int32_t  pc_aeskey[6];   /* AES 192bit key */
 144     volatile u_int32_t  pc_iv[4];       /* AES iv */
 145     volatile u_int32_t  pc_hminner[5];  /* hmac inner state */
 146     volatile u_int32_t  pc_hmouter[5];  /* hmac outer state */
 147 } __attribute__ ((packed));
 148
 149 struct ubsec_pktctx_aes256 {
 150     volatile u_int16_t  pc_len;         /* length of ctx struct */
 151     volatile u_int16_t  pc_type;        /* context type */
 152     volatile u_int16_t  pc_flags;       /* flags, same as above */
 153     volatile u_int16_t  pc_offset;      /* crypto/auth offset */
 154     volatile u_int32_t  pc_aeskey[8];   /* AES 256bit key */
 155     volatile u_int32_t  pc_iv[4];       /* AES iv */
 156     volatile u_int32_t  pc_hminner[5];  /* hmac inner state */
 157     volatile u_int32_t  pc_hmouter[5];  /* hmac outer state */
 158 } __attribute__ ((packed));
 159
 160 #define UBS_PKTCTX_TYPE_IPSEC_DES   0x0000
 161 #define UBS_PKTCTX_TYPE_IPSEC_AES   0x0040
 162
 163 struct ubsec_pktbuf {
 164     volatile u_int32_t  pb_addr;    /* address of buffer start */
 165     volatile u_int32_t  pb_next;    /* pointer to next pktbuf */
 166     volatile u_int32_t  pb_len;     /* packet length */
 167 } __attribute__ ((packed));
 168 #define UBS_PKTBUF_LEN      0x0000ffff  /* length mask */
 169
 170 struct ubsec_mcr {
 171     volatile u_int16_t  mcr_pkts;   /* #pkts in this mcr */
 172     volatile u_int16_t  mcr_flags;  /* mcr flags (below) */
 173     volatile u_int32_t  mcr_cmdctxp;    /* command ctx pointer */
 174     struct ubsec_pktbuf mcr_ipktbuf;    /* input chain header */
 175     volatile u_int16_t  mcr_reserved;
 176     volatile u_int16_t  mcr_pktlen;
 177     struct ubsec_pktbuf mcr_opktbuf;    /* output chain header */
 178 } __attribute__ ((packed));
 179
 180 struct ubsec_mcr_add {
 181     volatile u_int32_t  mcr_cmdctxp;    /* command ctx pointer */
 182     struct ubsec_pktbuf mcr_ipktbuf;    /* input chain header */
 183     volatile u_int16_t  mcr_reserved;
 184     volatile u_int16_t  mcr_pktlen;
 185     struct ubsec_pktbuf mcr_opktbuf;    /* output chain header */
 186 } __attribute__ ((packed));
 187
 188 #define UBS_MCR_DONE        0x0001      /* mcr has been processed */
 189 #define UBS_MCR_ERROR       0x0002      /* error in processing */
 190 #define UBS_MCR_ERRORCODE   0xff00      /* error type */
 191
 192 struct ubsec_ctx_keyop {
 193     volatile u_int16_t  ctx_len;    /* command length */
 194     volatile u_int16_t  ctx_op;     /* operation code */
 195     volatile u_int8_t   ctx_pad[60];    /* padding */
 196 } __attribute__ ((packed));
 197 #define UBS_CTXOP_DHPKGEN   0x01        /* dh public key generation */
 198 #define UBS_CTXOP_DHSSGEN   0x02        /* dh shared secret gen. */
 199 #define UBS_CTXOP_RSAPUB    0x03        /* rsa public key op */
 200 #define UBS_CTXOP_RSAPRIV   0x04        /* rsa private key op */
 201 #define UBS_CTXOP_DSASIGN   0x05        /* dsa signing op */
 202 #define UBS_CTXOP_DSAVRFY   0x06        /* dsa verification */
 203 #define UBS_CTXOP_RNGBYPASS 0x41        /* rng direct test mode */
 204 #define UBS_CTXOP_RNGSHA1   0x42        /* rng sha1 test mode */
 205 #define UBS_CTXOP_MODADD    0x43        /* modular addition */
 206 #define UBS_CTXOP_MODSUB    0x44        /* modular subtraction */
 207 #define UBS_CTXOP_MODMUL    0x45        /* modular multiplication */
 208 #define UBS_CTXOP_MODRED    0x46        /* modular reduction */
 209 #define UBS_CTXOP_MODEXP    0x47        /* modular exponentiation */
 210 #define UBS_CTXOP_MODINV    0x48        /* modular inverse */
 211
 212 struct ubsec_ctx_rngbypass {
 213     volatile u_int16_t  rbp_len;    /* command length, 64 */
 214     volatile u_int16_t  rbp_op;     /* rng bypass, 0x41 */
 215     volatile u_int8_t   rbp_pad[60];    /* padding */
 216 } __attribute__ ((packed));
 217
 218 /* modexp: C = (M ^ E) mod N */
 219 struct ubsec_ctx_modexp {
 220     volatile u_int16_t  me_len;     /* command length */
 221     volatile u_int16_t  me_op;      /* modexp, 0x47 */
 222     volatile u_int16_t  me_E_len;   /* E (bits) */
 223     volatile u_int16_t  me_N_len;   /* N (bits) */
 224     u_int8_t        me_N[2048/8];   /* N */
 225 } __attribute__ ((packed));
 226
 227 struct ubsec_ctx_rsapriv {
 228     volatile u_int16_t  rpr_len;    /* command length */
 229     volatile u_int16_t  rpr_op;     /* rsaprivate, 0x04 */
 230     volatile u_int16_t  rpr_q_len;  /* q (bits) */
 231     volatile u_int16_t  rpr_p_len;  /* p (bits) */
 232     u_int8_t        rpr_buf[5 * 1024 / 8];  /* parameters: */
 233                         /* p, q, dp, dq, pinv */
 234 } __attribute__ ((packed));