This routine returns the status of the hash block.

None.

Returns the status of the HASH block. The status register is read only. The bit definition is provided below :

Nothing.

None.

This routine is used to check if the HASH block is busy.

None.

• 1 - block is busy,
• 0 - otherwise.

Nothing.

None.

This routine is used to start the HASH engine.

• ien: a Boolean value indicating the state of interrupts.

Nothing.

Nothing.

Once started, the GIRQ18 bit 9 reflects the done status (1 if done). It must be cleared after it is set.

This routine is used to check the done status of HASH block. The status register value is updated into the pointer passed by the buffer.

• hw_status: pointer where the status value will be stored. The bit definitions are listed below :

  Bit Numbers	Description
  31:16	Hash Status Register Value.
  15:0	Hash Control Register Value.

• 1 - if the done status,
• 0 - otherwise.

Nothing.

None.

This routine initializes the SHA12_CONTEXT_T Data structure for the specified mode. This routine does not effect a change on the Hash Hardware.

• psha12_ctx: pointer to the SHA context structure. The structure definition is given below :

  typedef struct sha12_context_s SHA12_CONTEXT_T;
  struct sha12_context_s {
      SHA12_DIGEST_U hash;
      union {
          uint32_t w[(SHA12_BLOCK_WLEN) * 2];
          uint8_t b[(SHA12_BLOCK_BLEN) * 2];
      } block;
      uint8_t mode;
      uint8_t block_len;
      uint8_t rsvd[2];
  #ifdef SHA_ENABLE_64BIT_MSG_LEN
      uint64_t total_msg_len;
  #else
      uint32_t total_msg_len;
  #endif
  #endif
  };
  

  The structure definition of SHA12_DIGEST_U is given below :

  typedef union {
    uint32_t w[SHA2_WLEN];
    uint8_t b[SHA2_BLEN];
  } SHA12_DIGEST_U; 
  

• mode: indicates the mode of SHA. The permitted modes are SHA_MODE_256 and SHA_MODE_1.

• SHA_RET_ERR_BAD_ADDR - if sha12_ctx2 points to NULL,
• SHA_RET_ERR_UNSUPPORTED - if sha_mode has a value other than the permitted ones,
• SHA_RET_OK - returned if the operation requested is successful.

Nothing.

None.

This routine initializes the SHA35_CONTEXT_T data structure for the mode specified.

• psha35_ctx: pointer to the SHA35_CONTEXT_T data structure. The structure definition is given below :

  typedef struct sha35_context_s SHA35_CONTEXT_T;
  struct sha35_context_s {
      SHA35_DIGEST_U hash;
      union {
          uint32_t w[(SHA35_BLOCK_WLEN) * 2];
          uint8_t  b[(SHA35_BLOCK_BLEN) * 2];
      } block;
      uint8_t mode;
      uint8_t block_len;
      uint8_t rsvd[2];
  #ifdef SHA_ENABLE_64BIT_MSG_LEN
      uint64_t total_msg_len[2];
  #else
      uint32_t total_msg_len;
  #endif
  } aligned(8);
  

  The structure definition of SHA35_DIGEST_U is given below :

  typedef union {
    uint32_t w[SHA5_WLEN];
    uint8_t b[SHA5_BLEN];
  } SHA35_DIGEST_U; 
  

• mode: the permitted mode for this operation is SHA_MODE_512.

• SHA_RET_ERR_BAD_ADDR - if sha35_ctx2 points to NULL,
• SHA_RET_ERR_UNSUPPORTED - if sha_mode has a value other than the permitted ones,
• SHA_RET_OK - returned if the operation requested is successful.

Nothing.

Valid only for CEC1702 MCU.

This routine runs Hash block on data and updates the SHA12_CONTEXT_T data structure with the number of bytes processed. The data must be aligned to a 4-byte boundary for SHA1 or SHA256.
If data length is not a multiple of 64-bytes, then the remaining bytes will be copied into SHA12_CONTEXT_T data structure to be processed by sha12_finalize.

• psha12_ctx: pointer to the SHA context structure. The structure definition is given below :

  typedef struct sha12_context_s SHA12_CONTEXT_T;
  struct sha12_context_s {
      SHA12_DIGEST_U hash;
      union {
          uint32_t w[(SHA12_BLOCK_WLEN) * 2];
          uint8_t b[(SHA12_BLOCK_BLEN) * 2];
      } block;
      uint8_t mode;
      uint8_t block_len;
      uint8_t rsvd[2];
  #ifdef SHA_ENABLE_64BIT_MSG_LEN
      uint64_t total_msg_len;
  #else
      uint32_t total_msg_len;
  #endif
  #endif
  };
  

  The structure definition of SHA12_DIGEST_U is given below :

  typedef union {
    uint32_t w[SHA2_WLEN];
    uint8_t b[SHA2_BLEN];
  } SHA12_DIGEST_U; 
  

• pdata: pointer to constant data consisting of data to be updated.
• num_bytes: length of data.

• SHA_RET_ERR_BAD_ADDR - if either sha12_ctx3 or data1 points to NULL,
• SHA_RET_ERR_UNSUPPORTED - if sha_mode has a value other than the permitted ones,
• SHA_RET_OK - returned if the operation requested is successful.

Nothing.

None.

This routine runs Hash block on data and updates the SHA35_CONTEXT_T data structure with the number of bytes processed. The data must be aligned to a 4-byte boundary for SHA1 or SHA256.
If data length is not a multiple of 64-bytes, then the remaining bytes will be copied into SHA35_CONTEXT_T data structure to be processed by sha35_finalize.

• psha35_ctx: pointer to the SHA context structure. The structure definition is given below :

  typedef struct sha35_context_s SHA35_CONTEXT_T;
  struct sha35_context_s {
      SHA35_DIGEST_U hash;
      union {
          uint32_t w[(SHA35_BLOCK_WLEN) * 2];
          uint8_t  b[(SHA35_BLOCK_BLEN) * 2];
      } block;
      uint8_t mode;
      uint8_t block_len;
      uint8_t rsvd[2];
  #ifdef SHA_ENABLE_64BIT_MSG_LEN
      uint64_t total_msg_len[2];
  #else
      uint32_t total_msg_len;
  #endif
  } aligned(8);
  

  The structure definition of SHA35_DIGEST_U is given below :

  typedef union {
    uint32_t w[SHA5_WLEN];
    uint8_t b[SHA5_BLEN];
  } SHA35_DIGEST_U; 
  

• pdata: pointer to constant data consisting of data to be updated.
• num_bytes: length of data.

• SHA_RET_ERR_BAD_ADDR - if either sha12_ctx3 or data1 points to NULL,
• SHA_RET_ERR_UNSUPPORTED - if sha_mode has a value other than the permitted ones,
• SHA_RET_OK - returned if the operation requested is successful.

Nothing.

Valid only for CEC1702 MCU.

This routine applies FIPS padding to SHA256 and performs final hash calculations. It must be used in sequence, sha256_init, sha256_update_start, wait for hash engine to finish, sha256_finalize.
The SHA256_CONTEXT_T object will be filled in with nay remaining bytes on the last call to sha256_update_start. SHA engine is approximately 1 cycle per byte for SHA1 and SHA256. It is 64 cycles per 64-byte block.

If the original message length has greater than 56 remaining bytes, the API will need to hash two additional blocks, one for the remaining 56 bytes and one to hold the message bit length.

• psha12_ctx pointer to the SHA context structure. The structure definition is given below :

  typedef struct sha12_context_s SHA12_CONTEXT_T;
  struct sha12_context_s {
      SHA12_DIGEST_U hash;
      union {
          uint32_t w[(SHA12_BLOCK_WLEN) * 2];
          uint8_t b[(SHA12_BLOCK_BLEN) * 2];
      } block;
      uint8_t mode;
      uint8_t block_len;
      uint8_t rsvd[2];
  #ifdef SHA_ENABLE_64BIT_MSG_LEN
      uint64_t total_msg_len;
  #else
      uint32_t total_msg_len;
  #endif
  #endif
  };
  

  The structure definition of SHA12_DIGEST_U is given below :

  typedef union {
    uint32_t w[SHA2_WLEN];
    uint8_t b[SHA2_BLEN];
  } SHA12_DIGEST_U; 
  

• SHA_RET_ERR_BAD_ADDR - if sha12_ctx2 points to NULL,
• SHA_RET_ERR_BUSY - this error value is returned if hash block is busy,
• SHA_RET_START - returned if the operation requested is successful.

Nothing.

None.

Finalizes the Hash operations by running Hash engine if bytes are left over and adds FIPS padding.

• psha35_ctx pointer to the SHA context structure. The structure definition is given below :

  typedef struct sha35_context_s SHA35_CONTEXT_T;
  struct sha35_context_s {
      SHA35_DIGEST_U hash;
      union {
          uint32_t w[(SHA35_BLOCK_WLEN) * 2];
          uint8_t  b[(SHA35_BLOCK_BLEN) * 2];
      } block;
      uint8_t mode;
      uint8_t block_len;
      uint8_t rsvd[2];
  #ifdef SHA_ENABLE_64BIT_MSG_LEN
      uint64_t total_msg_len[2];
  #else
      uint32_t total_msg_len;
  #endif
  } aligned(8);
  

  The structure definition of SHA35_DIGEST_U is given below :

  typedef union {
    uint32_t w[SHA5_WLEN];
    uint8_t b[SHA5_BLEN];
  } SHA35_DIGEST_U; 
  

• SHA_RET_ERR_BAD_ADDR - if sha35_ctx points to NULL,
• SHA_RET_ERR_BUSY - this error value is returned if hash block is busy,
• SHA_RET_START - returned if the operation requested is successful.

Nothing.

Valid only for CEC1702 MCU.

This routine initializes the hash engine for SHA operation. Programs supported SHA operation’s initial value, digest address and operation (SHA1, SHA256 or SHA384).
Hash engine does not need to be started. SHA1 and SHA256 require 4 byte alignment, while SHA384 require 8-byte alignment.

• mode: paramteter indicating the mode. Permitted modes are SHA_MODE_1 and SHA_MODE_256.
• pdigest: pointer to digest.

• 0 - Success.
• 1 - Hash Engine Busy.
• 2 - Unsupported SHA operation.
• 3 - Bad digest pointer, NULL or mis-aligned.

Nothing.

None.

This routine programs hash engine with data address and the number of data blocks to process. SHA block must be initialized before this routine is called.
SHA1 and SHA256 require 4 byte alignment while SHA384 require 8-byte alignment. Hash engine is not started, if return value is non-zero caller must call hash_start.

• pdata: pointer to data,
• nblocks: number of blocks,
• flags: Bit 0 indicates clear status(1-clear), bit enable interrupt status(1-enable) and bit indicates start/stop (1-start).

• 0 - Success.
• 1 - Hash Engine Busy.
• 2 - pdata is a null pointer.
• 3 - data is misaligned.

Nothing.

None.

This routine implement the standard SHA padding described in the FIPS standard.

• padbuf: pointer to the message padded according to the rules of fips standard.
• total_msg_len: length of message.
• prem: to constant data consisting of …?
• flags: Bit 0 indicates clear status(1-clear), bit enable interrupt status(1-enable) and bit indicates start/stop (1-start).

• 0 - Success.
• 1 - Hash Engine Busy.
• 2 - pdata is a null pointer.
• 3 - data is misaligned.

Nothing.

None.