1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
|
/*
* Copyright (C) 2017-2024 Alibaba Group Holding Limited
*
* SPDX-License-Identifier: Apache-2.0
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/******************************************************************************
* @file drv/sha.h
* @brief Header File for SHA Driver
* @version V1.0
* @date 9. Oct 2020
* @model sha
******************************************************************************/
#ifndef _DRV_SHA_H_
#define _DRV_SHA_H_
#include <drv/common.h>
#include <drv/dma.h>
#ifdef __cplusplus
extern "C" {
#endif
/****** SHA mode ******/
typedef enum {
SHA_MODE_1 = 1U, /* SHA_1 mode */
SHA_MODE_256, /* SHA_256 mode */
SHA_MODE_224, /* SHA_224 mode */
SHA_MODE_512, /* SHA_512 mode */
SHA_MODE_384, /* SHA_384 mode */
SHA_MODE_512_256, /* SHA_512_256 mode */
SHA_MODE_512_224, /* SHA_512_224 mode */
SHA_MODE_MD5 /* MD5 mode */
} csi_sha_mode_t;
/****** SHA State ******/
typedef struct {
uint32_t busy : 1; /* Calculate busy flag */
uint32_t error : 1; /* Calculate error flag */
} csi_sha_state_t;
/****** SHA Context ******/
typedef struct {
csi_sha_mode_t mode; /* SHA mode */
uint32_t total[2]; /* Number of bytes processed */
uint32_t state[16]; /* Intermediate digest state */
uint8_t buffer[128]; /* Data block being processed */
} csi_sha_context_t;
/****** SHA Event ******/
typedef enum {
SHA_EVENT_COMPLETE = 0U, /*Calculate completed*/
SHA_EVENT_ERROR /*Calculate error*/
} csi_sha_event_t;
/****** SHA Ctrl ******/
typedef struct csi_sha csi_sha_t;
struct csi_sha{
csi_dev_t dev;
void (*callback)(csi_sha_t *sha, csi_sha_event_t event, void *arg); /* SHA event callback for user */
void *arg; /* SHA custom designed param passed to evt_cb */
csi_dma_ch_t *dma_in; /* SHA in dma handle param */
csi_sha_state_t state; /* SHA state */
void *priv;
};
/**
\brief Initialize SHA Interface. Initializes the resources needed for the SHA interface
\param[in] sha Operate handle
\param[in] idx Index of SHA
\return Error code \ref csi_error_t
*/
csi_error_t csi_sha_init(csi_sha_t *sha, uint32_t idx);
/**
\brief De-initialize SHA Interface. Stops operation and releases the software resources used by the interface
\param[in] sha SHA handle to operate
\return None
*/
void csi_sha_uninit(csi_sha_t *sha);
/**
\brief Start the engine
\param[in] sha Handle to operate
\param[in] context Pointer to the SHA context \ref csi_sha_context_t
\param[in] mode SHA mode \ref csi_sha_mode_t
\return Error code \ref csi_error_t
*/
csi_error_t csi_sha_start(csi_sha_t *sha, csi_sha_context_t *context, csi_sha_mode_t mode);
/**
\brief Update the engine
\param[in] sha Handle to operate
\param[in] context Pointer to the SHA context \ref csi_sha_context_t
\param[in] input Pointer to the Source data
\param[in] size The data size
\return Error code \ref csi_error_t
*/
csi_error_t csi_sha_update(csi_sha_t *sha, csi_sha_context_t *context, const void *input, uint32_t size);
/**
\brief Finish the engine
\param[in] sha Handle to operate
\param[in] context Pointer to the SHA context \ref csi_sha_context_t
\param[out] output Pointer to the result data
\param[out] out_size Pointer to the result data size(bytes)
\return Error code \ref csi_error_t
*/
csi_error_t csi_sha_finish(csi_sha_t *sha, csi_sha_context_t *context, void *output, uint32_t *out_size);
#ifdef __cplusplus
}
#endif
#endif /* _DRV_SHA_H_ */
|
