SHA2CC26X2.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2017-2018, Texas Instruments Incorporated
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *
9  * * Redistributions of source code must retain the above copyright
10  * notice, this list of conditions and the following disclaimer.
11  *
12  * * Redistributions in binary form must reproduce the above copyright
13  * notice, this list of conditions and the following disclaimer in the
14  * documentation and/or other materials provided with the distribution.
15  *
16  * * Neither the name of Texas Instruments Incorporated nor the names of
17  * its contributors may be used to endorse or promote products derived
18  * from this software without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
22  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
23  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
24  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
25  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
26  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
27  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
28  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
29  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
30  * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  */
56 #ifndef ti_drivers_sha2_SHA2CC26X2__include
57 #define ti_drivers_sha2_SHA2CC26X2__include
58 
59 #include <stdint.h>
60 #include <stdbool.h>
61 
62 #include <ti/drivers/SHA2.h>
63 
64 #ifdef __cplusplus
65 extern "C" {
66 #endif
67 
68 
75 typedef struct {
76  uint8_t intPriority;
91 
92 
95 #define SHA2CC26X2_MAX_BLOCK_SIZE_BYTES (SHA2_BLOCK_SIZE_BYTES_512)
96 #define SHA2CC26X2_MAX_DIGEST_LENGTH_BYTES (SHA2_DIGEST_LENGTH_BYTES_512)
97 
98 /*
99  * SHACC26XX Object
100  *
101  * The application must not access any member variables of this structure!
102  */
103 typedef struct {
104  bool isOpen;
105  volatile bool operationInProgress;
106  bool operationCanceled;
107  SHA2_ReturnBehavior returnBehavior;
108  int_fast16_t returnStatus;
109  uint32_t accessTimeout;
110  SHA2_CallbackFxn callbackFxn;
111  SHA2_HashType hashType;
112  uint16_t bytesInBuffer;
113  uint32_t bytesProcessed;
114  uint8_t buffer[SHA2CC26X2_MAX_BLOCK_SIZE_BYTES];
115  uint32_t digest[SHA2CC26X2_MAX_DIGEST_LENGTH_BYTES / 4];
116 } SHA2CC26X2_Object;
117 
118 /*
119  * This function exists only because of mbedTLS. It is not a
120  * top-level function for now.
121  *
122  * Use it like this:
123  *
124  * SHA2CC26X2_Object object;
125  * const SHA2CC26X2_HWAttrs attrs = {
126  * .intPriority = 0xFF;
127  * };
128  *
129  * SHA2_Config config = {
130  * .object = &object,
131  * .hwAttrs = &hwAttrs
132  * };
133  *
134  * SHA2_Handle handle = SHA2_construct(&config, ...);
135  *
136  */
137 SHA2_Handle SHA2CC26X2_construct(SHA2_Config *config, const SHA2_Params *params);
138 
141 #ifdef __cplusplus
142 }
143 #endif
144 
145 #endif /* ti_drivers_sha2_SHA2CC26X2__include */
SHA2 Global configuration.
Definition: SHA2.h:352
SHA2_ReturnBehavior
The way in which SHA2 function calls return after performing an operation.
Definition: SHA2.h:284
SHA2_HashType
Enum for the hash types supported by the driver.
Definition: SHA2.h:304
Hardware-specific configuration attributes.
Definition: SHA2CC26X2.h:75
SHA2 driver header.
SHA2 Parameters.
Definition: SHA2.h:385
void(* SHA2_CallbackFxn)(SHA2_Handle handle, int_fast16_t returnStatus)
The definition of a callback function used by the SHA2 driver when used in SHA2_RETURN_BEHAVIOR_CALLB...
Definition: SHA2.h:375
uint8_t intPriority
Definition: SHA2CC26X2.h:76
© Copyright 1995-2019, Texas Instruments Incorporated. All rights reserved.
Trademarks | Privacy policy | Terms of use | Terms of sale