mbuf: update Tx VLAN and QinQ flags documentation
[dpdk.git] / drivers / crypto / dpaa2_sec / hw / desc / algo.h
index bac6b05..b6cfa87 100644 (file)
@@ -1,7 +1,8 @@
-/*
- * Copyright 2008-2016 Freescale Semiconductor, Inc.
+/* SPDX-License-Identifier: (BSD-3-Clause OR GPL-2.0)
+ *
+ * Copyright 2008-2016 Freescale Semiconductor Inc.
+ * Copyright 2016,2019 NXP
  *
- * SPDX-License-Identifier: BSD-3-Clause or GPL-2.0+
  */
 
 #ifndef __DESC_ALGO_H__
@@ -124,7 +125,12 @@ cnstr_shdsc_snow_f9(uint32_t *descbuf, bool ps, bool swap,
  * @descbuf: pointer to descriptor-under-construction buffer
  * @ps: if 36/40bit addressing is desired, this parameter must be true
  * @swap: must be true when core endianness doesn't match SEC endianness
+ * @share: sharing type of shared descriptor
  * @cipherdata: pointer to block cipher transform definitions
+ *              Valid algorithm values one of OP_ALG_ALGSEL_* {DES, 3DES, AES}
+ *              Valid modes for:
+ *                  AES: OP_ALG_AAI_* {CBC, CTR}
+ *                  DES, 3DES: OP_ALG_AAI_CBC
  * @iv: IV data; if NULL, "ivlen" bytes from the input frame will be read as IV
  * @ivlen: IV length
  * @dir: DIR_ENC/DIR_DEC
@@ -133,13 +139,16 @@ cnstr_shdsc_snow_f9(uint32_t *descbuf, bool ps, bool swap,
  */
 static inline int
 cnstr_shdsc_blkcipher(uint32_t *descbuf, bool ps, bool swap,
+                     enum rta_share_type share,
                      struct alginfo *cipherdata, uint8_t *iv,
                      uint32_t ivlen, uint8_t dir)
 {
        struct program prg;
        struct program *p = &prg;
-       const bool is_aes_dec = (dir == DIR_DEC) &&
-                               (cipherdata->algtype == OP_ALG_ALGSEL_AES);
+       uint32_t iv_off = 0;
+       const bool need_dk = (dir == DIR_DEC) &&
+                            (cipherdata->algtype == OP_ALG_ALGSEL_AES) &&
+                            (cipherdata->algmode == OP_ALG_AAI_CBC);
        LABEL(keyjmp);
        LABEL(skipdk);
        REFERENCE(pkeyjmp);
@@ -150,14 +159,14 @@ cnstr_shdsc_blkcipher(uint32_t *descbuf, bool ps, bool swap,
                PROGRAM_SET_BSWAP(p);
        if (ps)
                PROGRAM_SET_36BIT_ADDR(p);
-       SHR_HDR(p, SHR_SERIAL, 1, SC);
+       SHR_HDR(p, share, 1, SC);
 
        pkeyjmp = JUMP(p, keyjmp, LOCAL_JUMP, ALL_TRUE, SHRD);
        /* Insert Key */
        KEY(p, KEY1, cipherdata->key_enc_flags, cipherdata->key,
            cipherdata->keylen, INLINE_KEY(cipherdata));
 
-       if (is_aes_dec) {
+       if (need_dk) {
                ALG_OPERATION(p, cipherdata->algtype, cipherdata->algmode,
                              OP_ALG_AS_INITFINAL, ICV_CHECK_DISABLE, dir);
 
@@ -165,7 +174,7 @@ cnstr_shdsc_blkcipher(uint32_t *descbuf, bool ps, bool swap,
        }
        SET_LABEL(p, keyjmp);
 
-       if (is_aes_dec) {
+       if (need_dk) {
                ALG_OPERATION(p, OP_ALG_ALGSEL_AES, cipherdata->algmode |
                              OP_ALG_AAI_DK, OP_ALG_AS_INITFINAL,
                              ICV_CHECK_DISABLE, dir);
@@ -175,12 +184,15 @@ cnstr_shdsc_blkcipher(uint32_t *descbuf, bool ps, bool swap,
                              OP_ALG_AS_INITFINAL, ICV_CHECK_DISABLE, dir);
        }
 
+       if (cipherdata->algmode == OP_ALG_AAI_CTR)
+               iv_off = 16;
+
        if (iv)
                /* IV load, convert size */
-               LOAD(p, (uintptr_t)iv, CONTEXT1, 0, ivlen, IMMED | COPY);
+               LOAD(p, (uintptr_t)iv, CONTEXT1, iv_off, ivlen, IMMED | COPY);
        else
                /* IV is present first before the actual message */
-               SEQLOAD(p, CONTEXT1, 0, ivlen, 0);
+               SEQLOAD(p, CONTEXT1, iv_off, ivlen, 0);
 
        MATHB(p, SEQINSZ, SUB, MATH2, VSEQINSZ, 4, 0);
        MATHB(p, SEQINSZ, SUB, MATH2, VSEQOUTSZ, 4, 0);
@@ -190,7 +202,7 @@ cnstr_shdsc_blkcipher(uint32_t *descbuf, bool ps, bool swap,
        SEQFIFOSTORE(p, MSG, 0, 0, VLF);
 
        PATCH_JUMP(p, pkeyjmp, keyjmp);
-       if (is_aes_dec)
+       if (need_dk)
                PATCH_JUMP(p, pskipdk, skipdk);
 
        return PROGRAM_FINALIZE(p);
@@ -201,6 +213,7 @@ cnstr_shdsc_blkcipher(uint32_t *descbuf, bool ps, bool swap,
  * @descbuf: pointer to descriptor-under-construction buffer
  * @ps: if 36/40bit addressing is desired, this parameter must be true
  * @swap: must be true when core endianness doesn't match SEC endianness
+ * @share: sharing type of shared descriptor
  * @authdata: pointer to authentication transform definitions;
  *            message digest algorithm: OP_ALG_ALGSEL_MD5/ SHA1-512.
  * @do_icv: 0 if ICV checking is not desired, any other value if ICV checking
@@ -215,6 +228,7 @@ cnstr_shdsc_blkcipher(uint32_t *descbuf, bool ps, bool swap,
  */
 static inline int
 cnstr_shdsc_hmac(uint32_t *descbuf, bool ps, bool swap,
+                enum rta_share_type share,
                 struct alginfo *authdata, uint8_t do_icv,
                 uint8_t trunc_len)
 {
@@ -260,7 +274,7 @@ cnstr_shdsc_hmac(uint32_t *descbuf, bool ps, bool swap,
                PROGRAM_SET_BSWAP(p);
        if (ps)
                PROGRAM_SET_36BIT_ADDR(p);
-       SHR_HDR(p, SHR_SERIAL, 1, SC);
+       SHR_HDR(p, share, 1, SC);
 
        pkeyjmp = JUMP(p, keyjmp, LOCAL_JUMP, ALL_TRUE, SHRD);
        KEY(p, KEY2, authdata->key_enc_flags, authdata->key, authdata->keylen,
@@ -428,4 +442,213 @@ cnstr_shdsc_crc(uint32_t *descbuf, bool swap)
        return PROGRAM_FINALIZE(p);
 }
 
+/**
+ * cnstr_shdsc_gcm_encap - AES-GCM encap as a shared descriptor
+ * @descbuf: pointer to descriptor-under-construction buffer
+ * @ps: if 36/40bit addressing is desired, this parameter must be true
+ * @swap: must be true when core endianness doesn't match SEC endianness
+ * @share: sharing type of shared descriptor
+ * @cipherdata: pointer to block cipher transform definitions
+ *             Valid algorithm values - OP_ALG_ALGSEL_AES ANDed with
+ *             OP_ALG_AAI_GCM.
+ * @ivlen: Initialization vector length
+ * @icvsize: integrity check value (ICV) size (truncated or full)
+ *
+ * Return: size of descriptor written in words or negative number on error
+ */
+static inline int
+cnstr_shdsc_gcm_encap(uint32_t *descbuf, bool ps, bool swap,
+                     enum rta_share_type share,
+                     struct alginfo *cipherdata,
+                     uint32_t ivlen, uint32_t icvsize)
+{
+       struct program prg;
+       struct program *p = &prg;
+
+       LABEL(keyjmp);
+       LABEL(zeroassocjump2);
+       LABEL(zeroassocjump1);
+       LABEL(zeropayloadjump);
+       REFERENCE(pkeyjmp);
+       REFERENCE(pzeroassocjump2);
+       REFERENCE(pzeroassocjump1);
+       REFERENCE(pzeropayloadjump);
+
+       PROGRAM_CNTXT_INIT(p, descbuf, 0);
+
+       if (swap)
+               PROGRAM_SET_BSWAP(p);
+       if (ps)
+               PROGRAM_SET_36BIT_ADDR(p);
+
+       SHR_HDR(p, share, 1, SC);
+
+       pkeyjmp = JUMP(p, keyjmp, LOCAL_JUMP, ALL_TRUE, SELF | SHRD);
+       /* Insert Key */
+       KEY(p, KEY1, cipherdata->key_enc_flags, cipherdata->key,
+           cipherdata->keylen, INLINE_KEY(cipherdata));
+
+       SET_LABEL(p, keyjmp);
+
+       /* class 1 operation */
+       ALG_OPERATION(p, cipherdata->algtype, cipherdata->algmode,
+                     OP_ALG_AS_INITFINAL, ICV_CHECK_DISABLE, DIR_ENC);
+
+       MATHB(p, DPOVRD, AND, 0x7fffffff, MATH3, 4, IMMED2);
+
+       /* if assoclen + cryptlen is ZERO, skip to ICV write */
+       MATHB(p, SEQINSZ, SUB, ivlen, VSEQOUTSZ, 4, IMMED2);
+       pzeroassocjump2 = JUMP(p, zeroassocjump2, LOCAL_JUMP, ALL_TRUE, MATH_Z);
+
+       SEQFIFOLOAD(p, IV1, ivlen, FLUSH1);
+
+       /* if assoclen is ZERO, skip reading the assoc data */
+       MATHB(p, ZERO, ADD, MATH3, VSEQINSZ, 4, 0);
+       pzeroassocjump1 = JUMP(p, zeroassocjump1, LOCAL_JUMP, ALL_TRUE, MATH_Z);
+
+       MATHB(p, ZERO, ADD, MATH3, VSEQOUTSZ, 4, 0);
+
+       /* skip assoc data */
+       SEQFIFOSTORE(p, SKIP, 0, 0, VLF);
+
+       /* cryptlen = seqinlen - assoclen */
+       MATHB(p, SEQINSZ, SUB, MATH3, VSEQOUTSZ, 4, 0);
+
+       /* if cryptlen is ZERO jump to zero-payload commands */
+       pzeropayloadjump = JUMP(p, zeropayloadjump, LOCAL_JUMP, ALL_TRUE,
+                               MATH_Z);
+
+       /* read assoc data */
+       SEQFIFOLOAD(p, AAD1, 0, CLASS1 | VLF | FLUSH1);
+       SET_LABEL(p, zeroassocjump1);
+
+       MATHB(p, SEQINSZ, SUB, MATH0, VSEQINSZ, 4, 0);
+
+       /* write encrypted data */
+       SEQFIFOSTORE(p, MSG, 0, 0, VLF);
+
+       /* read payload data */
+       SEQFIFOLOAD(p, MSG1, 0, CLASS1 | VLF | LAST1);
+
+       /* jump the zero-payload commands */
+       JUMP(p, 4, LOCAL_JUMP, ALL_TRUE, 0);
+
+       /* zero-payload commands */
+       SET_LABEL(p, zeropayloadjump);
+
+       /* read assoc data */
+       SEQFIFOLOAD(p, AAD1, 0, CLASS1 | VLF | LAST1);
+
+       JUMP(p, 2, LOCAL_JUMP, ALL_TRUE, 0);
+
+       /* There is no input data */
+       SET_LABEL(p, zeroassocjump2);
+
+       SEQFIFOLOAD(p, IV1, ivlen, FLUSH1 | LAST1);
+
+       /* write ICV */
+       SEQSTORE(p, CONTEXT1, 0, icvsize, 0);
+
+       PATCH_JUMP(p, pkeyjmp, keyjmp);
+       PATCH_JUMP(p, pzeroassocjump2, zeroassocjump2);
+       PATCH_JUMP(p, pzeroassocjump1, zeroassocjump1);
+       PATCH_JUMP(p, pzeropayloadjump, zeropayloadjump);
+
+       return PROGRAM_FINALIZE(p);
+}
+
+/**
+ * cnstr_shdsc_gcm_decap - AES-GCM decap as a shared descriptor
+ * @descbuf: pointer to descriptor-under-construction buffer
+ * @ps: if 36/40bit addressing is desired, this parameter must be true
+ * @swap: must be true when core endianness doesn't match SEC endianness
+ * @share: sharing type of shared descriptor
+ * @cipherdata: pointer to block cipher transform definitions
+ *             Valid algorithm values - OP_ALG_ALGSEL_AES ANDed with
+ *             OP_ALG_AAI_GCM.
+ * @icvsize: integrity check value (ICV) size (truncated or full)
+ *
+ * Return: size of descriptor written in words or negative number on error
+ */
+static inline int
+cnstr_shdsc_gcm_decap(uint32_t *descbuf, bool ps, bool swap,
+                     enum rta_share_type share,
+                     struct alginfo *cipherdata,
+                     uint32_t ivlen, uint32_t icvsize)
+{
+       struct program prg;
+       struct program *p = &prg;
+
+       LABEL(keyjmp);
+       LABEL(zeroassocjump1);
+       LABEL(zeropayloadjump);
+       REFERENCE(pkeyjmp);
+       REFERENCE(pzeroassocjump1);
+       REFERENCE(pzeropayloadjump);
+
+       PROGRAM_CNTXT_INIT(p, descbuf, 0);
+
+       if (swap)
+               PROGRAM_SET_BSWAP(p);
+       if (ps)
+               PROGRAM_SET_36BIT_ADDR(p);
+
+       SHR_HDR(p, share, 1, SC);
+
+       pkeyjmp = JUMP(p, keyjmp, LOCAL_JUMP, ALL_TRUE, SELF | SHRD);
+       /* Insert Key */
+       KEY(p, KEY1, cipherdata->key_enc_flags, cipherdata->key,
+           cipherdata->keylen, INLINE_KEY(cipherdata));
+
+       SET_LABEL(p, keyjmp);
+
+       /* class 1 operation */
+       ALG_OPERATION(p, cipherdata->algtype, cipherdata->algmode,
+                     OP_ALG_AS_INITFINAL, ICV_CHECK_ENABLE, DIR_DEC);
+
+       MATHB(p, DPOVRD, AND, 0x7fffffff, MATH3, 4, IMMED2);
+       SEQFIFOLOAD(p, IV1, ivlen, FLUSH1);
+
+       /* if assoclen is ZERO, skip reading the assoc data */
+       MATHB(p, ZERO, ADD, MATH3, VSEQINSZ, 4, 0);
+       pzeroassocjump1 = JUMP(p, zeroassocjump1, LOCAL_JUMP, ALL_TRUE, MATH_Z);
+
+       MATHB(p, ZERO, ADD, MATH3, VSEQOUTSZ, 4, 0);
+
+       /* skip assoc data */
+       SEQFIFOSTORE(p, SKIP, 0, 0, VLF);
+
+       /* read assoc data */
+       SEQFIFOLOAD(p, AAD1, 0, CLASS1 | VLF | FLUSH1);
+
+       SET_LABEL(p, zeroassocjump1);
+
+       /* cryptlen = seqoutlen - assoclen */
+       MATHB(p, SEQOUTSZ, SUB, MATH0, VSEQINSZ, 4, 0);
+
+       /* jump to zero-payload command if cryptlen is zero */
+       pzeropayloadjump = JUMP(p, zeropayloadjump, LOCAL_JUMP, ALL_TRUE,
+                               MATH_Z);
+
+       MATHB(p, SEQOUTSZ, SUB, MATH0, VSEQOUTSZ, 4, 0);
+
+       /* store encrypted data */
+       SEQFIFOSTORE(p, MSG, 0, 0, VLF);
+
+       /* read payload data */
+       SEQFIFOLOAD(p, MSG1, 0, CLASS1 | VLF | FLUSH1);
+
+       /* zero-payload command */
+       SET_LABEL(p, zeropayloadjump);
+
+       /* read ICV */
+       SEQFIFOLOAD(p, ICV1, icvsize, CLASS1 | LAST1);
+
+       PATCH_JUMP(p, pkeyjmp, keyjmp);
+       PATCH_JUMP(p, pzeroassocjump1, zeroassocjump1);
+       PATCH_JUMP(p, pzeropayloadjump, zeropayloadjump);
+
+       return PROGRAM_FINALIZE(p);
+}
+
 #endif /* __DESC_ALGO_H__ */