@CHIP-RTOS C Library - TCP/IP API

Crypt_SHA1_Init

Initialize SHA1 hash checksum generator.

int Crypt_SHA1_Init ( Crypt_SHA1_ContextPtr sha1context );

Parameters

sha1context

[out]   Pointer to SHA1 context structure to be initialized by this API.

Return Value

0: Success
-1: failed

Comments

This function must be called prior to making the first call to Crypt_SHA1_Update() when a SHA1 hash value is to be computed.

No initialization of the object at sha1context by the caller is required.   This API will perform the initialization.

See Also

Crypt_SHA1_Update        Crypt_SHA1_Final        Crypt_MD5_Init

RTOS API

This library function invokes a RTOS software interrupt. Refer to this RTOS API function's documentation for more details.

On SC1x3/SC2x (RTOS version >= 1.35, CLIB version >= 2.19) there is also a version of this function available which uses dynamic linking instead of the software interrupt.   This reduces the function's overhead and thus speeds up your application.   This function's name is Crypt_SHA1_Init_Dyn, however you should not use this function directly.   Instead you should add the define TCPIP_DYN_LINK to your program before including the CLIB's header file(s), as follows:

#define TCPIP_DYN_LINK
#include <clib.h>

This compilation switch will map the original function's name to the dynamic link version.   In this manner, you can easily switch existing programs over to the dynamic link API.

Supported since or modified in @CHIP-RTOS version

SC12	SC13	SC11	SC1x3	SC2x
n/a	n/a	n/a	V1.11	V1.00

Supported by @CHIP-RTOS C Library since version

CLIB
V2.08