linux-imx

/* SPDX-License-Identifier: GPL-2.0 */

/*

 * caam - Freescale FSL CAAM support for Public Key Cryptography descriptors

 *

 * Copyright 2016 Freescale Semiconductor, Inc.

 *

 * There is no Shared Descriptor for PKC so that the Job Descriptor must carry

 * all the desired key parameters, input and output pointers.

 */

​

#ifndef _PKC_DESC_H_

#define _PKC_DESC_H_

#include "compat.h"

#include "pdb.h"

​

/**

 * caam_priv_key_form - CAAM RSA private key representation

 * CAAM RSA private key may have either of three forms.

 *

 * 1. The first representation consists of the pair (n, d), where the

 *    components have the following meanings:

 *        n      the RSA modulus

 *        d      the RSA private exponent

 *

 * 2. The second representation consists of the triplet (p, q, d), where the

 *    components have the following meanings:

 *        p      the first prime factor of the RSA modulus n

 *        q      the second prime factor of the RSA modulus n

 *        d      the RSA private exponent

 *

 * 3. The third representation consists of the quintuple (p, q, dP, dQ, qInv),

 *    where the components have the following meanings:

 *        p      the first prime factor of the RSA modulus n

 *        q      the second prime factor of the RSA modulus n

 *        dP     the first factors's CRT exponent

 *        dQ     the second factors's CRT exponent

 *        qInv   the (first) CRT coefficient

 *

 * The benefit of using the third or the second key form is lower computational

 * cost for the decryption and signature operations.

 */

enum caam_priv_key_form {

    FORM1,

    FORM2,

    FORM3

};

​

/**

 * caam_rsa_key - CAAM RSA key structure. Keys are allocated in DMA zone.

 * @n           : RSA modulus raw byte stream

 * @e           : RSA public exponent raw byte stream

 * @d           : RSA private exponent raw byte stream

 * @p           : RSA prime factor p of RSA modulus n

 * @q           : RSA prime factor q of RSA modulus n

 * @dp          : RSA CRT exponent of p

 * @dp          : RSA CRT exponent of q

 * @qinv        : RSA CRT coefficient

 * @tmp1        : CAAM uses this temporary buffer as internal state buffer.

 *                It is assumed to be as long as p.

 * @tmp2        : CAAM uses this temporary buffer as internal state buffer.

 *                It is assumed to be as long as q.

 * @n_sz        : length in bytes of RSA modulus n

 * @e_sz        : length in bytes of RSA public exponent