mbuf: update Tx VLAN and QinQ flags documentation
[dpdk.git] / drivers / crypto / dpaa2_sec / hw / desc / algo.h
index 166bc3a..b6cfa87 100644 (file)
@@ -1,41 +1,8 @@
-/*-
- * This file is provided under a dual BSD/GPLv2 license. When using or
- * redistributing this file, you may do so under either license.
- *
- *   BSD LICENSE
+/* SPDX-License-Identifier: (BSD-3-Clause OR GPL-2.0)
  *
  * Copyright 2008-2016 Freescale Semiconductor Inc.
- * Copyright (c) 2016 NXP.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions are met:
- * * Redistributions of source code must retain the above copyright
- * notice, this list of conditions and the following disclaimer.
- * * Redistributions in binary form must reproduce the above copyright
- * notice, this list of conditions and the following disclaimer in the
- * documentation and/or other materials provided with the distribution.
- * * Neither the name of the above-listed copyright holders nor the
- * names of any contributors may be used to endorse or promote products
- * derived from this software without specific prior written permission.
- *
- *   GPL LICENSE SUMMARY
- *
- * ALTERNATIVELY, this software may be distributed under the terms of the
- * GNU General Public License ("GPL") as published by the Free Software
- * Foundation, either version 2 of that License or (at your option) any
- * later version.
+ * Copyright 2016,2019 NXP
  *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
- * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
- * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
- * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
- * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
- * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
- * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
- * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
- * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
- * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
- * POSSIBILITY OF SUCH DAMAGE.
  */
 
 #ifndef __DESC_ALGO_H__
@@ -158,6 +125,7 @@ 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:
@@ -171,6 +139,7 @@ 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)
 {
@@ -190,7 +159,7 @@ 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 */
@@ -244,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
@@ -258,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)
 {
@@ -303,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,
@@ -471,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__ */