/*
    RSA driver header file

    RSA driver header file.

    @file       rsa.h
    @ingroup    mIDrvMisc_RSA
    @note       Nothing

    Copyright   Novatek Microelectronics Corp. 2020.  All rights reserved.
*/

#ifndef _RSA_H
#define _RSA_H

#include <kwrap/nvt_type.h>

/**
    @addtogroup mIDrvMisc_RSA
*/
/**
    Rsa engine clock rate
*/
typedef enum
{
    RSA_CLOCK_240MHz = 0x00,         ///< Select RSA clock rate 240 MHz
    RSA_CLOCK_320MHz,                ///< Select RSA clock rate 320 MHz
    RSA_CLOCK_Reserved,              ///< Select RSA clock rate Reserved
    RSA_CLOCK_PLL9,                  ///< Select RSA clock rate PLL9(for IDE/ETH)

    RSA_CLOCK_RATE_NUM,
    ENUM_DUMMY4WORD(RSA_CLOCK_RATE)
} RSA_CLOCK_RATE;


//@{
/**
    Rsa engine Key Width
*/
typedef enum
{
    RSA_KEY_256 = 0x00,              ///< Select RSA key width for 256 bit
    RSA_KEY_512,                     ///< Select RSA key width for 512 bit
    RSA_KEY_1024,                    ///< Select RSA key width for 1024 bit
    RSA_KEY_2048,                    ///< Select RSA key width for 2048 bit
    RSA_KEY_4096,                    ///< Select RSA key width for 4096 bit

    RSA_KEY_NUM,
    ENUM_DUMMY4WORD(RSA_KEY)
} RSA_KEY;

/**
    Rsa engine Key Width
*/
typedef enum
{
    RSA_MODE_NORMAL = 0x00,           ///< Select RSA mode for encryption or decryption
    RSA_MODE_CRC_KEY_ED,              ///< Select RSA mode for Key E/D CRC check
    RSA_MODE_CRC_KEY_N = 0x03,        ///< Select RSA mode for Key N   CRC check

    RSA_MODE_NUM,
    ENUM_DUMMY4WORD(RSA_MODE_CFG)
} RSA_MODE_CFG;


/**
    Rsa engine CRC32 Configuration
*/
typedef enum
{
    RSA_CRC_INIT = 0x00,               ///< Select RSA mode for encryption or decryption
    RSA_CRC_POLY,                      ///< Select RSA mode for Key N CRC check

    RSA_CRC_NUM,
    ENUM_DUMMY4WORD(RSA_CRC)
} RSA_CRC;


/**
    Rsa order
*/
typedef enum
{
    RSA_ORDER_LSB_FIRST = 0x00,        ///< Select RSA order for lsb byte first
    RSA_ORDER_MSB_FIRST,               ///< Select RSA order for msb byte first

    RSA_ORDER_NUM,
    ENUM_DUMMY4WORD(RSA_ORDER_CFG)
} RSA_ORDER_CFG;


/**
    Rsa configuration identifier

    @note For Rsa_setConfig()
*/
typedef enum
{
    RSA_CONFIG_ID_CLOCK_RATE,           ///< Select RSA engine internal clock rate usage
                                        ///< Context can be any of:
                                        ///< - @b RSA_CLOCK_240MHz:     Internal clock rate 240MHz
                                        ///< - @b RSA_CLOCK_320MHz:     Internal clock rate 320MHz
                                        ///< - @b RSA_CLOCK_PLL9:       Internal clock rate PLL9
    RSA_CONFIG_ID_KEY_WIDTH,            ///< Select RSA engine key width usage
                                        ///< Context can be any of:
                                        ///< - @b RSA_KEY_256
                                        ///< - @b RSA_KEY_512
                                        ///< - @b RSA_KEY_1024
                                        ///< - @b RSA_KEY_2048
                                        ///< - @b RSA_KEY_4096
    RSA_CONFIG_ID_MODE,                 ///< Select RSA engine operation mode usage
                                        ///< Context can be any of:
                                        ///< - @b RSA_MODE_NORMAL
                                        ///< - @b RSA_MODE_CRC_KEY_ED
                                        ///< - @b RSA_MODE_CRC_KEY_N
    RSA_CONFIG_ID_CRC32,                ///< Select RSA engine CRC32 Initial Value and Polynoms
                                        ///< Context can be any of:
                                        ///< - @b RSA_CRC_INIT
                                        ///< - @b RSA_CRC_POLY
    RSA_CONFIG_ID_REORDER,              ///< Select RSA engine byte order usage
                                        ///< Context can be any of:
                                        ///< - @b RSA_ORDER_LSB_FIRST
                                        ///< - @b RSA_ORDER_MSB_FIRST
    ENUM_DUMMY4WORD(RSA_CONFIG_ID)
} RSA_CONFIG_ID;

extern ER   rsa_open(void);
extern ER   rsa_close(void);
extern ER   rsa_setConfig(RSA_CONFIG_ID cfgid, UINT32 cfgvalue);
extern void rsa_setkey_n(UINT8* key, UINT32 len, UINT32 msb_first);
extern void rsa_setkey_ed(UINT8* key, UINT32 len, UINT32 msb_first);
extern void rsa_pio_enable(UINT8* data, UINT32 len, UINT32 msb_first);
extern void rsa_getOutput(UINT8 * Output, UINT32 len);
extern void rsa_getKey_ed(UINT8 * key);
extern void rsa_KeyCheck(UINT32 * Output, UINT32 crc_init, UINT32 key_poly);

#if defined(_NVT_FPGA_) || defined(_NVT_EMULATION_)
extern int  rsa_CheckSRAM(UINT32 sram_mask, UINT32 pattern);
#endif

//@}

#endif /* _RSA_H */