Efabless Logo

SW_SHA256

SHA-256 Cryptographic Hash Function Soft IP

SW_SHA256

Hardware implementation of the SHA-256 cryptographic hash function. The rtl is based on this repo

General Information

  • Maturity: Integrated
  • Certification: EF Certified
  • Provider: secworks
  • License: Open Source
  • Category: Cryptography
  • Foundry: N/A
  • Node: N/A
  • PDK: Soft IP

The wrapped IP

AHBL wrapper is provided, APB and wishbone wrappers will be provided soon.

Wrapped IP System Integration

Based on your use case, use one of the provided wrappers or create a wrapper for your system bus type. For an example of how to integrate the AHBL wrapper:

SW_SHA256_AHBL INST (
        `TB_AHBL_SLAVE_CONN
);

NOTE: `TB_AHBL_SLAVE_CONN is a convenient macro provided by BusWrap.

Implementation example

The following table is the result for implementing the SW_SHA256 IP with different wrappers using Sky130 PDK and OpenLane2 flow.

Module Number of cells Max. freq
SW_SHA256 TBD TBD
SW_SHA256_APB TBD TBD
SW_SHA256_AHBL TBD TBD
SW_SHA256_WB TBD TBD

The Programmer's Interface

Registers

Name Offset Reset Value Access Mode Description
STATUS 0000 0x00000000 r Status register bit 0: digest is valid , bit 1: ready
CTRL 0004 0x00000000 w Control register bit 0: Initial bit (init) bit 1: Next bit , bit 2: Mode bit
BLOCK0 0008 0x00000000 w Contains the bits 31-0 of the input block value
BLOCK1 000c 0x00000000 w Contains the bits 63-32 of the input block value
BLOCK2 0010 0x00000000 w Contains the bits 95-64 of the input block value
BLOCK3 0014 0x00000000 w Contains the bits 127-96 of the input block value
BLOCK4 0018 0x00000000 w Contains the bits 159-128 of the input block value
BLOCK5 001c 0x00000000 w Contains the bits 191-160 of the input block value
BLOCK6 0020 0x00000000 w Contains the bits 223-192 of the input block value
BLOCK7 0024 0x00000000 w Contains the bits 255-224 of the input block value
BLOCK8 0028 0x00000000 w Contains the bits 287-256 of the input block value
BLOCK9 002c 0x00000000 w Contains the bits 319-288 of the input block value
BLOCK10 0030 0x00000000 w Contains the bits 351-320 of the input block value
BLOCK11 0034 0x00000000 w Contains the bits 383-352 of the input block value
BLOCK12 0038 0x00000000 w Contains the bits 415-384 of the input block value
BLOCK13 003c 0x00000000 w Contains the bits 447-416 of the input block value
BLOCK14 0040 0x00000000 w Contains the bits 479-448 of the input block value
BLOCK15 0044 0x00000000 w Contains the bits 512-480 of the input block value
DIGEST0 0048 0x00000000 w Contains the bits 31-0 of the input digest value
DIGEST1 004c 0x00000000 w Contains the bits 63-32 of the input digest value
DIGEST2 0050 0x00000000 w Contains the bits 95-64 of the input digest value
DIGEST3 0054 0x00000000 w Contains the bits 127-96 of the input digest value
DIGEST4 0058 0x00000000 w Contains the bits 159-128 of the input digest value
DIGEST5 005c 0x00000000 w Contains the bits 191-160 of the input digest value
DIGEST6 0060 0x00000000 w Contains the bits 223-192 of the input digest value
DIGEST7 0064 0x00000000 w Contains the bits 255-224 of the input digest value
IM ff00 0x00000000 w Interrupt Mask Register; write 1/0 to enable/disable interrupts; check the interrupt flags table for more details
RIS ff08 0x00000000 w Raw Interrupt Status; reflects the current interrupts status;check the interrupt flags table for more details
MIS ff04 0x00000000 w Masked Interrupt Status; On a read, this register gives the current masked status value of the corresponding interrupt. A write has no effect; check the interrupt flags table for more details
IC ff0c 0x00000000 w Interrupt Clear Register; On a write of 1, the corresponding interrupt (both raw interrupt and masked interrupt, if enabled) is cleared; check the interrupt flags table for more details

STATUS Register [Offset: 0x0, mode: r]

Status register bit 0: digest is valid , bit 1: ready

bit field name width description
6 ready_reg 1 Ready to start
7 digest_valid_reg 1 Digest is valid

CTRL Register [Offset: 0x4, mode: w]

Control register bit 0: Initial bit (init) bit 1: Next bit , bit 2: Mode bit

bit field name width description
0 init_reg 1 Initial bit
1 next_reg 1 Next bit
2 mode_reg 1 Mode bit; “0” means SHA224 “1” means SHA256"

BLOCK0 Register [Offset: 0x8, mode: w]

Contains the bits 31-0 of the input block value

BLOCK1 Register [Offset: 0xc, mode: w]

Contains the bits 63-32 of the input block value

BLOCK2 Register [Offset: 0x10, mode: w]

Contains the bits 95-64 of the input block value

BLOCK3 Register [Offset: 0x14, mode: w]

Contains the bits 127-96 of the input block value

BLOCK4 Register [Offset: 0x18, mode: w]

Contains the bits 159-128 of the input block value

BLOCK5 Register [Offset: 0x1c, mode: w]

Contains the bits 191-160 of the input block value

BLOCK6 Register [Offset: 0x20, mode: w]

Contains the bits 223-192 of the input block value

BLOCK7 Register [Offset: 0x24, mode: w]

Contains the bits 255-224 of the input block value

BLOCK8 Register [Offset: 0x28, mode: w]

Contains the bits 287-256 of the input block value

BLOCK9 Register [Offset: 0x2c, mode: w]

Contains the bits 319-288 of the input block value

BLOCK10 Register [Offset: 0x30, mode: w]

Contains the bits 351-320 of the input block value

BLOCK11 Register [Offset: 0x34, mode: w]

Contains the bits 383-352 of the input block value

BLOCK12 Register [Offset: 0x38, mode: w]

Contains the bits 415-384 of the input block value

BLOCK13 Register [Offset: 0x3c, mode: w]

Contains the bits 447-416 of the input block value

BLOCK14 Register [Offset: 0x40, mode: w]

Contains the bits 479-448 of the input block value

BLOCK15 Register [Offset: 0x44, mode: w]

Contains the bits 512-480 of the input block value

DIGEST0 Register [Offset: 0x48, mode: w]

Contains the bits 31-0 of the input digest value

DIGEST1 Register [Offset: 0x4c, mode: w]

Contains the bits 63-32 of the input digest value

DIGEST2 Register [Offset: 0x50, mode: w]

Contains the bits 95-64 of the input digest value

DIGEST3 Register [Offset: 0x54, mode: w]

Contains the bits 127-96 of the input digest value

DIGEST4 Register [Offset: 0x58, mode: w]

Contains the bits 159-128 of the input digest value

DIGEST5 Register [Offset: 0x5c, mode: w]

Contains the bits 191-160 of the input digest value

DIGEST6 Register [Offset: 0x60, mode: w]

Contains the bits 223-192 of the input digest value

DIGEST7 Register [Offset: 0x64, mode: w]

Contains the bits 255-224 of the input digest value

Interrupt Flags

The wrapped IP provides four registers to deal with interrupts: IM, RIS, MIS and IC. These registers exist for all wrapper types generated by the BusWrap bus_wrap.py utility.

Each register has a group of bits for the interrupt sources/flags.

  • IM: is used to enable/disable interrupt sources.

  • RIS: has the current interrupt status (interrupt flags) whether they are enabled or disabled.

  • MIS: is the result of masking (ANDing) RIS by IM.

  • IC: is used to clear an interrupt flag.

The following are the bit definitions for the interrupt registers:

Bit Flag Width Description
0 VALID 1 Digest is valid
1 READY 1 Ready to start

The Interface

Ports

Port Direction Width Description
init input 1 Initial bit
next input 1 Next bit
mode input 1 Mode bit; '0' means SHA224 '1' means SHA256
block input 512 block value
ready output 1 ready to start
digest output 256 digest value
digest_valid output 1 digest is valid

F/W Usage Guidelines:

TBD

Installation:

You can either clone repo or use IPM which is an open-source IPs Package Manager

  • To clone repo: git clone https://github.com/efabless/SW_SHA256
  • To download via IPM , follow installation guides here then run ipm install SW_SHA256

Run cocotb UVM Testbench:

TBD

Summary

Catalog ID

SW_SHA256

Provider

Vendor

Vendor

secworks

Category

Cryptography

Price & Licensing

Pricing

Free

License Type

Open Source

License

BSD

Quality

Certification

EF Certified

Maturity

Integrated