drivers: crypto: Add initial support for rpi_pico sha256 accelerator #85036

soburi · 2025-02-03T01:49:02Z

Add basic support for RaspberryPi Pico's SHA256 hardware accelerator.

soburi · 2025-02-14T22:22:08Z

Could you take a look if you have a bit of a while?

valeriosetti

The PR looks OK to me. I cannot test it locally because I don't have a board at hand, but at least the test that was extended builds correctly. I only left one minor non-blocking question/comment.

drivers/crypto/crypto_rpi_pico_sha256.c

ThreeEights · 2025-02-17T16:40:23Z

drivers/crypto/CMakeLists.txt

+zephyr_library_sources_ifdef(CONFIG_CRYPTO_SMARTBOND            crypto_smartbond.c)
+zephyr_library_sources_ifdef(CONFIG_CRYPTO_STM32                crypto_stm32.c)
+zephyr_library_sources_ifdef(CONFIG_CRYPTO_TINYCRYPT_SHIM       crypto_tc_shim.c)
+# zephyr-keep-sorted-stop


Sorting - good idea!

nit: I'd prefer it if the sorting is one commit, and the addition is a separate commit. The end result is the same, but it's easier to to see the two orthogonal things going on.

valeriosetti

Thanks for addressing previous comment. However reviewing the PR again I found a couple of new ones that I missed before. Sorry

drivers/crypto/crypto_rpi_pico_sha256.c

soburi · 2025-03-17T20:04:28Z

@ceolin @ThreeEights @ajf58

Could you take a look at it?

ajf58

The change looks functionally good, but I am concerned about the outright copy and paste of BSD code, then relabeling it as Apache 2.

I feel like someone else needs to comment on this.

ajf58 · 2025-03-17T21:23:15Z

drivers/crypto/CMakeLists.txt

+zephyr_library_sources_ifdef(CONFIG_CRYPTO_SMARTBOND            crypto_smartbond.c)
+zephyr_library_sources_ifdef(CONFIG_CRYPTO_STM32                crypto_stm32.c)
+zephyr_library_sources_ifdef(CONFIG_CRYPTO_TINYCRYPT_SHIM       crypto_tc_shim.c)
+# zephyr-keep-sorted-stop


nit: I'd prefer it if the sorting is one commit, and the addition is a separate commit. The end result is the same, but it's easier to to see the two orthogonal things going on.

ajf58 · 2025-03-17T21:53:37Z

drivers/crypto/crypto_rpi_pico_sha256.c

+LOG_MODULE_REGISTER(sha_rpi_pico_sha256, CONFIG_CRYPTO_LOG_LEVEL);
+
+/*
+ * This is based on the pico_sha256 implementation in the Pico-SDK.


Original code is a https://github.com/raspberrypi/pico-sdk/blob/2.1.0/src/rp2_common/pico_sha256/sha256.c , it's 3-Clause BSD (BSD-3-Clause).

I feel like this file has lifted-and-shifted too much for someone to ignore (many lines of code are the same, just formatted to meet the Zephyr Project's coding style).

I'd be happy if this file had a BSD-3-Clause on it. Zephyr must be compatible with this, we link against BSD-3-Clause all over the place. It's not easy t osee examples of that, however.

Alternatively, we could modify the version of the source code in the hal_rpi_pico. This is something I prefer to avoid, but that feels better at ensuring the software licence is upheld.

The codes derived from pico-sdk were separated into crypto_rpi_pico_sha256.h, and the license changed to BSD-3.

nit: I'd prefer it if the sorting is one commit, and the addition is a separate commit. The end result is the same, but it's easier to to see the two orthogonal things going on.

Addressed.

dsseng · 2025-09-21T15:09:59Z

drivers/crypto/CMakeLists.txt

+zephyr_library_sources_ifdef(CONFIG_CRYPTO_ATAES132A            crypto_ataes132a.c)
+zephyr_library_sources_ifdef(CONFIG_CRYPTO_CC23X0               crypto_cc23x0.c)
+zephyr_library_sources_ifdef(CONFIG_CRYPTO_INTEL_SHA            crypto_intel_sha.c)
 zephyr_library_sources_ifdef(CONFIG_CRYPTO_IT51XXX_SHA		crypto_it51xxx_sha.c)


Despite all other entries being transitioned to uniform space indentation, this remains tabs

dsseng · 2025-09-21T15:10:23Z

drivers/crypto/CMakeLists.txt

+zephyr_library_sources_ifdef(CONFIG_CRYPTO_SI32                 crypto_si32.c)
+zephyr_library_sources_ifdef(CONFIG_CRYPTO_SMARTBOND            crypto_smartbond.c)
+zephyr_library_sources_ifdef(CONFIG_CRYPTO_STM32                crypto_stm32.c)
+zephyr_library_sources_ifdef(CONFIG_CRYPTO_STM32_HASH		crypto_stm32_hash.c)


Could this also be converted to spaces for alignment?

dsseng · 2025-09-21T15:12:14Z

drivers/crypto/Kconfig.rpi_pico

+# SPDX-License-Identifier: Apache-2.0
+
+config CRYPTO_RPI_PICO_SHA256
+	bool "RasberryPi Pico SHA256 Accelerator driver"


Suggested change

bool "RasberryPi Pico SHA256 Accelerator driver"

bool "Raspberry Pi Pico SHA256 Accelerator driver"

or maybe even like this, as Pico is a board and the driver is for SoC. It's opinionated though, feel free to reject:

Suggested change

bool "RasberryPi Pico SHA256 Accelerator driver"

bool "Raspberry Pi microcontrollers SHA256 Accelerator driver"

dsseng · 2025-09-21T15:12:38Z

drivers/crypto/Kconfig.rpi_pico

+	depends on DT_HAS_RASPBERRYPI_PICO_SHA256_ENABLED
+	select PICOSDK_USE_SHA256
+	help
+	  RaspberryPi Pico SHA256 accelarator driver.


Suggested change

RaspberryPi Pico SHA256 accelarator driver.

Raspberry Pi Pico SHA256 accelarator driver.

dsseng · 2025-09-21T15:15:42Z

drivers/crypto/crypto_rpi_pico_sha256.c

+
+static int crypto_rpi_pico_sha256_query_hw_caps(const struct device *dev)
+{
+	return (CAP_SEPARATE_IO_BUFS | CAP_SYNC_OPS);


personal opinion: readability would be better without parentheses:

Suggested change

return (CAP_SEPARATE_IO_BUFS | CAP_SYNC_OPS);

return CAP_SEPARATE_IO_BUFS | CAP_SYNC_OPS;

By the recent SDK update, compilation will fail if `pico_platform_common` is not added to the include path, so that we fix this. Signed-off-by: TOKITA Hiroshi <[email protected]>

Update hal_rpi_pico to commit 09e9575 to introduce hardware sha256. Signed-off-by: TOKITA Hiroshi <[email protected]>

Add `zephyr-keep-sorted` and reorder file entries alphabetically. Signed-off-by: TOKITA Hiroshi <[email protected]>

Add `hardware_sha256/include` to `zephyr_include_directories`. Use the header only. Signed-off-by: TOKITA Hiroshi <[email protected]>

Add basic support for RaspberryPi Pico's SHA256 hardware accelerator. Signed-off-by: TOKITA Hiroshi <[email protected]>

Added sha256 accelerator to rpi_pico. Signed-off-by: TOKITA Hiroshi <[email protected]>

Add rpi_pico2 to the crypto_hash test target. Signed-off-by: TOKITA Hiroshi <[email protected]>

sonarqubecloud · 2025-10-14T22:31:13Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

soburi · 2025-10-14T23:24:38Z

@valeriosetti @dsseng @ajf58

Could you revisit? I would like to include this in v4.3.0 if we can meet the deadline.

dsseng · 2025-10-15T06:10:42Z

drivers/crypto/crypto_rpi_pico_sha256.c

+	sha256_set_bswap(true);
+	sha256_start();
+
+	pico_sha256_update(&data->state, pkt->in_buf, pkt->in_len);


Are there limits on the input size by the HAL? If so, please test for them to return EINVAL

dsseng · 2025-10-15T06:14:50Z

tests/crypto/crypto_hash/socs/rp2350a_m33.overlay

Does this also work on Hazard3 as it's merged now? Cannot test right now, sorry, but interested whether or not bootrom call works fine, as those are somewhat interesting on RISC-V mode due to emulation being involved and may require application/RTOS to allocate a stack for BootROM emulator in some cases

soburi marked this pull request as draft February 3, 2025 01:49

zephyrbot added area: Crypto / RNG platform: Raspberry Pi Pico Raspberry Pi Pico (RPi Pico) labels Feb 3, 2025

zephyrbot requested review from ThreeEights, ceolin and yonsch February 3, 2025 01:49

zephyrbot assigned ceolin Feb 3, 2025

soburi mentioned this pull request Feb 3, 2025

TaskList for Supporting RaspberryPi Pico peripherals #53810

Open

57 tasks

soburi force-pushed the rpi_pico_sha256 branch from 0d6e6b8 to a2b3bb7 Compare February 3, 2025 02:32

soburi added the DNM This PR should not be merged (Do Not Merge) label Feb 3, 2025

soburi marked this pull request as ready for review February 3, 2025 04:02

valeriosetti self-requested a review February 10, 2025 08:31

soburi force-pushed the rpi_pico_sha256 branch from a2b3bb7 to 19c04b7 Compare February 11, 2025 20:31

soburi removed the DNM This PR should not be merged (Do Not Merge) label Feb 11, 2025

valeriosetti reviewed Feb 17, 2025

View reviewed changes

drivers/crypto/crypto_rpi_pico_sha256.c Outdated Show resolved Hide resolved

ThreeEights reviewed Feb 17, 2025

View reviewed changes

valeriosetti mentioned this pull request Feb 19, 2025

Add crypto support to TI cc23x0 SoC #84523

Merged

soburi force-pushed the rpi_pico_sha256 branch from 19c04b7 to 3f8ef55 Compare March 8, 2025 01:59

zephyrbot requested a review from ajf58 March 8, 2025 02:00

soburi requested review from ThreeEights and valeriosetti March 8, 2025 03:34

valeriosetti requested changes Mar 10, 2025

View reviewed changes

drivers/crypto/crypto_rpi_pico_sha256.c Outdated Show resolved Hide resolved

drivers/crypto/crypto_rpi_pico_sha256.c Outdated Show resolved Hide resolved

soburi force-pushed the rpi_pico_sha256 branch 2 times, most recently from a6aeaeb to f2ca146 Compare March 10, 2025 22:42

soburi requested a review from valeriosetti March 11, 2025 05:36

soburi force-pushed the rpi_pico_sha256 branch from f2ca146 to ee650de Compare March 14, 2025 13:15

valeriosetti previously approved these changes Mar 14, 2025

View reviewed changes

ajf58 reviewed Mar 17, 2025

View reviewed changes

soburi force-pushed the rpi_pico_sha256 branch 4 times, most recently from 6b6de83 to e568f8c Compare September 21, 2025 10:37

soburi requested review from dsseng and valeriosetti September 21, 2025 14:45

dsseng reviewed Sep 21, 2025

View reviewed changes

soburi force-pushed the rpi_pico_sha256 branch from e568f8c to 08dfdb5 Compare October 13, 2025 06:38

zephyrbot added area: Devicetree Bindings area: Tests Issues related to a particular existing or missing test area: Boards/SoCs labels Oct 13, 2025

zephyrbot requested a review from nashif October 13, 2025 06:40

soburi force-pushed the rpi_pico_sha256 branch from 08dfdb5 to a64fdfa Compare October 13, 2025 07:03

zephyrbot added the area: Samples Samples label Oct 13, 2025

zephyrbot requested review from JarmouniA and kartben October 13, 2025 07:04

soburi force-pushed the rpi_pico_sha256 branch 2 times, most recently from 19ad0c7 to a577c96 Compare October 14, 2025 20:42

soburi added 4 commits October 15, 2025 06:22

modules: hal_rpi_pico: Add pico_platform_common to include path

92741a8

By the recent SDK update, compilation will fail if `pico_platform_common` is not added to the include path, so that we fix this. Signed-off-by: TOKITA Hiroshi <[email protected]>

manifest: Update hal_rpi_pico module

aaf6af8

Update hal_rpi_pico to commit 09e9575 to introduce hardware sha256. Signed-off-by: TOKITA Hiroshi <[email protected]>

drivers: crypto: sort file entries

4da6e34

Add `zephyr-keep-sorted` and reorder file entries alphabetically. Signed-off-by: TOKITA Hiroshi <[email protected]>

modules: hal_rpi_pico: Add hardware_sha256 to include directories

1348963

Add `hardware_sha256/include` to `zephyr_include_directories`. Use the header only. Signed-off-by: TOKITA Hiroshi <[email protected]>

soburi force-pushed the rpi_pico_sha256 branch from a577c96 to 11c24e7 Compare October 14, 2025 21:23

soburi added 3 commits October 15, 2025 07:04

drivers: crypto: Add initial support for rpi_pico sha256 accelerator

78ca39e

Add basic support for RaspberryPi Pico's SHA256 hardware accelerator. Signed-off-by: TOKITA Hiroshi <[email protected]>

boards: raspberrypi: rpi_pico2: Add sha256 accelerator

ab7ed3f

Added sha256 accelerator to rpi_pico. Signed-off-by: TOKITA Hiroshi <[email protected]>

tests: crypto: crypto_hash: Add rpi_pico2 to test target

2c17f5e

Add rpi_pico2 to the crypto_hash test target. Signed-off-by: TOKITA Hiroshi <[email protected]>

soburi force-pushed the rpi_pico_sha256 branch from 11c24e7 to 2c17f5e Compare October 14, 2025 22:04

dsseng approved these changes Oct 15, 2025

View reviewed changes

	bool "RasberryPi Pico SHA256 Accelerator driver"
	bool "Raspberry Pi Pico SHA256 Accelerator driver"

	bool "RasberryPi Pico SHA256 Accelerator driver"
	bool "Raspberry Pi microcontrollers SHA256 Accelerator driver"

	RaspberryPi Pico SHA256 accelarator driver.
	Raspberry Pi Pico SHA256 accelarator driver.

	return (CAP_SEPARATE_IO_BUFS \| CAP_SYNC_OPS);
	return CAP_SEPARATE_IO_BUFS \| CAP_SYNC_OPS;

drivers: crypto: Add initial support for rpi_pico sha256 accelerator #85036

Are you sure you want to change the base?

drivers: crypto: Add initial support for rpi_pico sha256 accelerator #85036

Conversation

soburi commented Feb 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

soburi commented Feb 14, 2025

Uh oh!

valeriosetti left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

valeriosetti left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

soburi commented Mar 17, 2025

Uh oh!

ajf58 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sonarqubecloud bot commented Oct 14, 2025

Quality Gate passed

Uh oh!

soburi commented Oct 14, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

9 participants

soburi commented Feb 3, 2025 •

edited

Loading