sha256sw.h

Go to the documentation of this file.

/******************************************************************************
 *  Copyright (c) 2022-2023 Texas Instruments Incorporated
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions are met:
 *
 *  1) Redistributions of source code must retain the above copyright notice,
 *     this list of conditions and the following disclaimer.
 *
 *  2) Redistributions in binary form must reproduce the above copyright notice,
 *     this list of conditions and the following disclaimer in the documentation
 *     and/or other materials provided with the distribution.
 *
 *  3) Neither the name of the copyright holder nor the names of its
 *     contributors may be used to endorse or promote products derived from this
 *     software without specific prior written permission.
 *
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 *  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 *  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 *  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 *  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 *  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 *  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 *  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 *  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 *  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 *  POSSIBILITY OF SUCH DAMAGE.
 *
 ******************************************************************************/
#ifndef SHA256SW_H_
#define SHA256SW_H_

#include <stddef.h>
#include <stdint.h>

#include "sha2sw_common.h"
#include "sha2sw_config.h"

typedef struct
{
    uint32_t bitsProcessed; // Only 2^32 bits (512 MiBytes) are supported
    int8_t offsetWb;        // Byte offset into Ws, used to load message
    uint8_t reserved1;
    uint8_t reserved2;
    uint8_t reserved3;
    uint32_t digest32[8]; // Holds intermediate/final digest
    uint32_t Ws32[16];    // Message schedule, indexed by (s & 0xF),
                          // where s = 63 - t, and t is NIST 180-4's
                          // message schedule index
} SHA256SW_Object;

typedef SHA256SW_Object *SHA256SW_Handle;

/* Include this file after the type definitions above, to break cyclic dependency between hapi.h and sha256sw.h */
#include "hapi.h"

extern int_fast16_t SHA256SWHashData(SHA256SW_Handle handle,
                                     SHA2SW_HashType hashType,
                                     const void *data,
                                     size_t length,
                                     uint32_t digest[8]);

#define SHA256SWHashData HAPI_TABLE_POINTER->sha256SwHashData

extern int_fast16_t SHA256SWStart(SHA256SW_Handle handle, SHA2SW_HashType hashType);

#define SHA256SWStart HAPI_TABLE_POINTER->sha256SwStart

extern int_fast16_t SHA256SWAddData(SHA256SW_Handle handle, const void *data, size_t length);

#define SHA256SWAddData HAPI_TABLE_POINTER->sha256SwAddData

extern int_fast16_t SHA256SWFinalize(SHA256SW_Handle handle, uint32_t digest[8]);

#define SHA256SWFinalize HAPI_TABLE_POINTER->sha256SwFinalize

#endif /* SHA256SW_H_ */