hal_pke.h 文件参考

#include "crypto_osal_lib.h"
#include "crypto_pke_struct.h"
#include "hal_common.h"
#include "rom_lib.h"

hal_pke.h 的引用(Include)关系图:

此图展示该文件直接或间接的被哪些文件引用了:

浏览源代码.

枚举
enum	pke_mode { PKE_SINGLE_INSTR0 = 0x0 , PKE_SINGLE_INSTR1 = 0x1 , PKE_BATCH_INSTR = 0x2 }
enum	pke_data_work_len {   PKE_192_BIT_WORK_LEN = 0x3 , PKE_224_BIT_WORK_LEN = 0x4 , PKE_256_BIT_WORK_LEN = 0x4 , PKE_384_BIT_WORK_LEN = 0x6 ,   PKE_BRAINPOOL_512_BIT_WORK_LEN = 0x8 , PKE_512_BIT_WORK_LEN = 0x9 , PKE_2048_BIT_WORK_LEN = 0x20 , PKE_3072_BIT_WORK_LEN = 0x30 ,   PKE_4096_BIT_WORK_LEN = 0x40 }

函数
td_s32	hal_pke_init (void)
td_s32	hal_pke_deinit (void)
td_s32	hal_pke_lock (void)
void	hal_pke_unlock (void)
void	hal_pke_enable_noise (void)
void	hal_pke_disable_noise (void)
td_s32	hal_pke_pre_process (void)
	set mask random into registerfor set_ram and get_ram.
void	hal_pke_set_wait_event (crypto_wait_t *wait, const crypto_wait_timeout_interruptible wait_func, const td_u32 timeout_ms, const td_bool wait_done)
td_s32	hal_pke_check_free (void)
	check PKE busy, if success, then do next steps.
td_void	hal_pke_set_ram (td_u32 ram_section, const td_u8 *data, td_u32 data_len, td_u32 aligned_len CIPHER_CHECK_WORD)
	set data to PKE DRAM.
td_void	hal_pke_get_ram (td_u32 ram_section, td_u8 *data, td_u32 data_len CIPHER_CHECK_WORD)
	get result data in PKE DRAM
td_s32	hal_pke_clean_ram (void)
	clear the data in DRAM as random value. Only need to clear at the last calculate.
td_s32	hal_pke_set_mode (pke_mode mode, td_u32 single_instr, const rom_lib *batch_instr, pke_data_work_len work_len CIPHER_CHECK_WORD)
	set calculate mode, work_len and instr to register.
td_s32	hal_pke_start (pke_mode mode CIPHER_CHECK_WORD)
	start PKE calculate
td_s32	hal_pke_wait_done (void)
	PKE wait calculation finish
td_s32	hal_pke_get_align_val (const td_u32 len, td_u32 *aligned_len)
	Get the align val object of PKE, which depending on the chip version.
td_s32	hal_pke_set_mont_para (td_u32 low_bit, td_u32 high_bit CIPHER_CHECK_WORD)
	Set the montgomery parameter for modular multiplication.
td_s32	hal_pke_set_init_param (const pke_ecc_init_param *init_param, const drv_pke_ecc_curve *ecc_curve)
	set the initial parameters into DRAM.

变量
td_u32	g_pke_initialize

枚举类型说明

pke_data_work_len

enum pke_data_work_len

枚举值
PKE_192_BIT_WORK_LEN
PKE_224_BIT_WORK_LEN
PKE_256_BIT_WORK_LEN
PKE_384_BIT_WORK_LEN
PKE_BRAINPOOL_512_BIT_WORK_LEN
PKE_512_BIT_WORK_LEN
PKE_2048_BIT_WORK_LEN
PKE_3072_BIT_WORK_LEN
PKE_4096_BIT_WORK_LEN

pke_mode

enum pke_mode

Copyright (c) HiSilicon (Shanghai) Technologies Co., Ltd. 2022-2022. All rights reserved. Description: Head file of pke HAL API and logical algorithm API

Create: 2022-08-09

枚举值
PKE_SINGLE_INSTR0
PKE_SINGLE_INSTR1
PKE_BATCH_INSTR

函数说明

hal_pke_check_free()

td_s32 hal_pke_check_free

(

void

)

check PKE busy, if success, then do next steps.

返回

td_s32 TD_SUCCESS or other.

hal_pke_clean_ram()

td_s32 hal_pke_clean_ram

(

void

)

clear the data in DRAM as random value. Only need to clear at the last calculate.

返回

td_s32

hal_pke_deinit()

td_s32 hal_pke_deinit

(

void

)

hal_pke_disable_noise()

void hal_pke_disable_noise

(

void

)

hal_pke_enable_noise()

void hal_pke_enable_noise

(

void

)

hal_pke_get_align_val()

td_s32 hal_pke_get_align_val	(	const td_u32	len,
		td_u32 *	aligned_len
	)

Get the align val object of PKE, which depending on the chip version.

参数

len	the input data len.
aligned_len	the aligned length used to calculate.

hal_pke_get_ram()

td_void hal_pke_get_ram	(	td_u32	ram_section,
		td_u8 *	data,
		td_u32 data_len	CIPHER_CHECK_WORD
	)

get result data in PKE DRAM

参数

ram_section	the address of offset block in DRAM for data to get out.
data	the data value.
data_len	the effective length of data in byte.
CIPHER_CHECK_WORD	ifdef SEC_ENHANCE, the value is XOR result of parameters, otherwise it doesn't exist.

hal_pke_init()

td_s32 hal_pke_init

(

void

)

Copyright (c) HiSilicon (Shanghai) Technologies Co., Ltd. 2023-2023. All rights reserved. Description: Corresponds ROM functions to their implementation ROM addresses.

Create: 2023-05-17

hal_pke_lock()

td_s32 hal_pke_lock

(

void

)

hal_pke_pre_process()

td_s32 hal_pke_pre_process

(

void

)

set mask random into registerfor set_ram and get_ram.

返回

td_s32

hal_pke_set_init_param()

td_s32 hal_pke_set_init_param	(	const pke_ecc_init_param *	init_param,
		const drv_pke_ecc_curve *	ecc_curve
	)

set the initial parameters into DRAM.

参数

init_param	the initial parameters.
ecc_curve	the ecc curve type.

返回

td_s32 TD_SUCCESS or others.

hal_pke_set_mode()

td_s32 hal_pke_set_mode	(	pke_mode	mode,
		td_u32	single_instr,
		const rom_lib *	batch_instr,
		pke_data_work_len work_len	CIPHER_CHECK_WORD
	)

set calculate mode, work_len and instr to register.

参数

mode	calculation mode, see pke_mode.
single_instr	If the mode is PKE_SINGLE_INSTR0 or PKE_SINGLE_INSTR1, then set this. Otherwise, set it 0.
batch_instr	If the mode is PKE_BATCH_INSTR, then set this. Otherwise, set it TD_NULL.
work_len	work_len=ceiling(width/64), width is the data aligned bit width length, or work_len=ceiling(aligned_len/8).
CIPHER_CHECK_WORD	ifdef SEC_ENHANCE, the value is XOR result of parameters, otherwise it doesn't exist.

返回

td_s32 TD_SUCCESS or others.

hal_pke_set_mont_para()

td_s32 hal_pke_set_mont_para	(	td_u32	low_bit,
		td_u32 high_bit	CIPHER_CHECK_WORD
	)

Set the montgomery parameter for modular multiplication.

参数

low_bit	the low 32bit data.
high_bit	the high 32bit data.
CIPHER_CHECK_WORD	ifdef SEC_ENHANCE, the value is XOR result of parameters, otherwise it doesn't exist.

返回

td_s32 TD_SUCCESS or others.

hal_pke_set_ram()

td_void hal_pke_set_ram	(	td_u32	ram_section,
		const td_u8 *	data,
		td_u32	data_len,
		td_u32 aligned_len	CIPHER_CHECK_WORD
	)

set data to PKE DRAM.

参数

ram_section	the address of offset block in DRAM for data to write into.
data	the data value.
data_len	the effective length of data in byte.
aligned_len	the aligned length of data in byte when participate in calculate. In old IP, this is the klen, such as 32(256bit), 48(384bit), 64(512bit), 68(521bit), etc. This API mainly used in RSA calculate, for ecc, the input curve parameters are aligned, no need to process.
CIPHER_CHECK_WORD	ifdef SEC_ENHANCE, the value is XOR result of parameters, otherwise it doesn't exist.

返回

td_void

hal_pke_set_wait_event()

void hal_pke_set_wait_event	(	crypto_wait_t *	wait,
		const crypto_wait_timeout_interruptible	wait_func,
		const td_u32	timeout_ms,
		const td_bool	wait_done
	)

hal_pke_start()

td_s32 hal_pke_start

(

pke_mode mode

CIPHER_CHECK_WORD

)

start PKE calculate

参数

mode	SINGLE_INSTR or BATCH_INSTR
CIPHER_CHECK_WORD	ifdef SEC_ENHANCE, the value is XOR result of parameters, otherwise it doesn't exist.

返回

td_s32 TD_SUCCESS or others.

hal_pke_unlock()

void hal_pke_unlock

(

void

)

hal_pke_wait_done()

td_s32 hal_pke_wait_done

(

void

)

PKE wait calculation finish

返回

td_s32

变量说明

g_pke_initialize

td_u32 g_pke_initialize

extern