drivers: crc: Add hardware-based CRC driver #74977

zkat2 · 2024-06-25T15:29:54Z

Adds hardware support for CRC-8-CCITT and CRC-32-IEEE calculations and introduces a devicetree binding for STM32 CRC.

github-actions · 2024-06-25T15:30:33Z

Hello @zkat2, and thank you very much for your first pull request to the Zephyr project!
Our Continuous Integration pipeline will execute a series of checks on your Pull Request commit messages and code, and you are expected to address any failures by updating the PR. Please take a look at our commit message guidelines to find out how to format your commit messages, and at our contribution workflow to understand how to update your Pull Request. If you haven't already, please make sure to review the project's Contributor Expectations and update (by amending and force-pushing the commits) your pull request if necessary.
If you are stuck or need help please join us on Discord and ask your question there. Additionally, you can escalate the review when applicable. 😊

erwango · 2024-06-25T15:35:56Z

@mathieuchopstm Would you mind having a look ?

drivers/crc/crc_hw.h

drivers/crc/Kconfig

drivers/crc/Kconfig.stm32

pdgendt

This is going in the right direction IMO, there are some compliance issues that need attention.

drivers/crc/Kconfig.stm32

include/zephyr/drivers/crc.h

pdgendt · 2024-07-04T06:48:58Z

drivers/crc/crc_stm32.c

+#include <zephyr/logging/log.h>
+#include <errno.h>
+#include <soc.h>
+#include <zephyr/device.h>
+#include <zephyr/drivers/clock_control/stm32_clock_control.h>
+#include <zephyr/init.h>
+#include <zephyr/drivers/crc.h>
+#include "stm32_ll_crc.h"
+
+LOG_MODULE_REGISTER(crc_stm32);


You need to pass the logging level from Kconfig.

Try to group includes and have some order like system > zephyr > SoC

#include <zephyr/logging/log.h> LOG_MODULE_REGISTER(crc_stm32, CONFIG_CRC_HW_LOG_LEVEL); #include <errno.h> #include <zephyr/device.h> #include <zephyr/drivers/clock_control/stm32_clock_control.h> #include <zephyr/drivers/crc.h> #include <soc.h> #include <stm32_ll_crc.h>

erwango

Looks promising, thanks.

Some additional requests as you're introducing a brand new API:

API doc, see doc/hardware/peripherals/dac.rst as a minimum doc page
Add yourself as maintainer in MAINTAINERS.yaml
Last (maybe the most important): please provide a sample or a test (both would be ideal ;)) in order:
- to demonstrate how to use the API and how to configure a device
- ensure the API and related drivers are compiled systematically in CI

drivers/crc/Kconfig.stm32

dts/bindings/crc/st,stm32-crc.yaml

drivers/crc/crc_stm32.c

include/zephyr/drivers/crc.h

drivers/crc/crc_stm32.c

tests/drivers/crc/testcase.yaml

erwango

Few more comments but we're getting there, thanks for the work so far.

Also, as you're introducing a new API, I've added flag "Architecture review", so it could be introduced to Architecture working group on next session (Tuesday 5PM CET, see https://github.com/zephyrproject-rtos/zephyr/wiki/Architecture-Working-Group). It would be nice that you're able to join, but it is not blocking if you can't .

samples/drivers/crc/src/main.c

tests/drivers/crc/src/main.c

dts/arm/st/g4/stm32g474.dtsi

tests/drivers/crc/src/main.c

dts/arm/st/g4/stm32g474.dtsi

MAINTAINERS.yml

doc/hardware/peripherals/crc.rst

drivers/crc/Kconfig.stm32

henrikbrixandersen · 2024-08-05T16:55:31Z

Any plans to make this driver subsystem provide backends for https://github.com/zephyrproject-rtos/zephyr/blob/main/include/zephyr/sys/crc.h ?

Adds support for hardware-based CRC-8-CCITT and CRC-32-IEEE calculations. Signed-off-by: Zoe Kaute <zoe.kaute@brillpower.com>

Introduces a new sample that demonstrates how to use the hardware-based CRC API. Signed-off-by: Zoe Kaute <zoe.kaute@brillpower.com>

Add a test suite to validate the hardware-based CRC API. Signed-off-by: Zoe Kaute <zoe.kaute@brillpower.com>

Add the CRC node to stm32g4 device tree source file. Signed-off-by: Zoe Kaute <zoe.kaute@brillpower.com>

carlescufi · 2024-08-06T15:44:31Z

Architecture WG:

@gmarull and @carlescufi object with the fact that we are now left with 2 completely separate CRC APIs: the one in this PR and the existing software-based one in sys/crc.h
One option would be to introduce something akin to the random subsystem, where there is a single API and then multiple backends, one of which uses the entropy driver API
The other option would be to keep the API in this PR but add a software implementation, but then instancing may be an issue
Check if mbedTLS has support for CRC APIs? @ceolin
@zkat2 feel free to join the Architecture WG to discuss this again

zkat2 · 2024-08-06T17:02:23Z

@carlescufi Are you able to elaborate what these two options would entail? Are you suggesting an API rework or grouping the hardware and software implementations in a subsystem? Any additional details or examples would be appreciated.

ceolin · 2024-08-07T05:54:14Z

Architecture WG:

@gmarull and @carlescufi object with the fact that we are now left with 2 completely separate CRC APIs: the one in this PR and the existing software-based one in sys/crc.h

One option would be to introduce something akin to the random subsystem, where there is a single API and then multiple backends, one of which uses the entropy driver API

The other option would be to keep the API in this PR but add a software implementation, but then instancing may be an issue

Check if mbedTLS has support for CRC APIs? @ceolin

As far as I can tell you there is no CRC.

@zkat2 feel free to join the Architecture WG to discuss this again

github-actions · 2024-10-07T00:34:30Z

This pull request has been marked as stale because it has been open (more than) 60 days with no activity. Remove the stale label or add a comment saying that you would like to have the label removed otherwise this pull request will automatically be closed in 14 days. Note, that you can always re-open a closed pull request at any time.

henrikbrixandersen · 2025-03-12T11:46:30Z

@zkat2 Hey! Sorry to see this work abandoned. Do you have any plans - and bandwidth - for resuming work on this? I'd love to collaborate on it, if needed.

thenguyenyf · 2025-03-17T10:12:38Z

@zkat2 Hey! Sorry to see this work abandoned. Do you have any plans - and bandwidth - for resuming work on this? I'd love to collaborate on it, if needed.

Hello @henrikbrixandersen . We are preparing for a CRC hardware-based device driver (which similar to implementation in this PR) and we also introduce a CRC subsystem (implementation is quite similar to random system) includes a software backend (using sys/crc.h) and a CRC hardware backend (using CRC device driver). It will be sent out at the end of this week.

thenguyenyf · 2025-03-24T11:18:40Z

Hello. I have sent out a PR to add a CRC device driver implementation for Renesas RA device that referred to this PR here #87557. I'm also implement a new CRC subsystem using software/hardware backend implementation.
@henrikbrixandersen , @zkat2 , could you please visit and leave it some comment?

zephyrbot added platform: STM32 ST Micro STM32 area: Devicetree Binding PR modifies or adds a Device Tree binding labels Jun 25, 2024

zephyrbot requested review from ajarmouni-st, decsny, erwango, FRASTM, galak, gautierg-st, GeorgeCGV and marwaiehm-st June 25, 2024 15:30

zephyrbot assigned erwango Jun 25, 2024

zkat2 marked this pull request as draft June 25, 2024 17:05

pdgendt reviewed Jun 25, 2024

View reviewed changes

drivers/crc/crc_hw.h Outdated Show resolved Hide resolved

zkat2 force-pushed the zkat2_branch branch from 6686f99 to 9e36668 Compare June 25, 2024 17:12

pdgendt requested a review from ceolin June 26, 2024 06:35

This comment was marked as outdated.

Sign in to view

zkat2 force-pushed the zkat2_branch branch from 8fb3d07 to 0fed94b Compare June 27, 2024 11:44

mathieuchopstm reviewed Jun 28, 2024

View reviewed changes

drivers/crc/Kconfig Outdated Show resolved Hide resolved

drivers/crc/Kconfig Outdated Show resolved Hide resolved

drivers/crc/Kconfig Outdated Show resolved Hide resolved

drivers/crc/Kconfig.stm32 Outdated Show resolved Hide resolved

zkat2 force-pushed the zkat2_branch branch from 27d0c36 to 90cf0ed Compare July 3, 2024 17:06

zkat2 marked this pull request as ready for review July 3, 2024 17:11

pdgendt reviewed Jul 4, 2024

View reviewed changes

erwango requested changes Jul 4, 2024

View reviewed changes

drivers/crc/Kconfig.stm32 Outdated Show resolved Hide resolved

dts/bindings/crc/st,stm32-crc.yaml Outdated Show resolved Hide resolved

mathieuchopstm reviewed Jul 4, 2024

View reviewed changes

zkat2 marked this pull request as draft July 8, 2024 17:24

zkat2 force-pushed the zkat2_branch branch from dc0875a to 425478e Compare July 8, 2024 17:27

bp-amitchone reviewed Jul 9, 2024

View reviewed changes

tests/drivers/crc/testcase.yaml Outdated Show resolved Hide resolved

bp-amitchone reviewed Jul 9, 2024

View reviewed changes

tests/drivers/crc/testcase.yaml Outdated Show resolved Hide resolved

erwango requested changes Aug 5, 2024

View reviewed changes

zkat2 marked this pull request as draft August 5, 2024 12:47

zkat2 force-pushed the zkat2_branch branch 6 times, most recently from 3423893 to 53243de Compare August 5, 2024 16:07

zkat2 force-pushed the zkat2_branch branch 4 times, most recently from f16c5fb to 8864920 Compare August 6, 2024 10:00

Zoe Kaute added 4 commits August 6, 2024 11:32

drivers: crc: Add hardware-based CRC driver

4b51773

Adds support for hardware-based CRC-8-CCITT and CRC-32-IEEE calculations. Signed-off-by: Zoe Kaute <zoe.kaute@brillpower.com>

samples: drivers: crc Add sample for hardware based CRC API

d99de4a

Introduces a new sample that demonstrates how to use the hardware-based CRC API. Signed-off-by: Zoe Kaute <zoe.kaute@brillpower.com>

tests: drivers: crc: Add test suite for hardware-based CRC API

7106ea3

Add a test suite to validate the hardware-based CRC API. Signed-off-by: Zoe Kaute <zoe.kaute@brillpower.com>

dts: arm: st: g4: Add CRC node

d75c121

Add the CRC node to stm32g4 device tree source file. Signed-off-by: Zoe Kaute <zoe.kaute@brillpower.com>

zkat2 force-pushed the zkat2_branch branch from 8864920 to d75c121 Compare August 6, 2024 10:42

zkat2 marked this pull request as ready for review August 6, 2024 10:45

zkat2 mentioned this pull request Aug 6, 2024

Nominate zkat2 as Contributor #76722

Closed

github-actions bot added the Stale label Oct 7, 2024

github-actions bot closed this Oct 21, 2024

thenguyenyf mentioned this pull request Mar 27, 2025

drivers: crc: initial support for renesas,ra-crc driver #87557

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

drivers: crc: Add hardware-based CRC driver #74977

drivers: crc: Add hardware-based CRC driver #74977

zkat2 commented Jun 25, 2024

github-actions bot commented Jun 25, 2024

erwango commented Jun 25, 2024

This comment was marked as outdated.

pdgendt left a comment

pdgendt Jul 4, 2024

erwango left a comment

erwango left a comment

henrikbrixandersen commented Aug 5, 2024

carlescufi commented Aug 6, 2024 •

edited

Loading

zkat2 commented Aug 6, 2024 •

edited

Loading

ceolin commented Aug 7, 2024

github-actions bot commented Oct 7, 2024

henrikbrixandersen commented Mar 12, 2025

thenguyenyf commented Mar 17, 2025

thenguyenyf commented Mar 24, 2025

drivers: crc: Add hardware-based CRC driver #74977

drivers: crc: Add hardware-based CRC driver #74977

Conversation

zkat2 commented Jun 25, 2024

github-actions bot commented Jun 25, 2024

erwango commented Jun 25, 2024

This comment was marked as outdated.

pdgendt left a comment

Choose a reason for hiding this comment

pdgendt Jul 4, 2024

Choose a reason for hiding this comment

erwango left a comment

Choose a reason for hiding this comment

erwango left a comment

Choose a reason for hiding this comment

henrikbrixandersen commented Aug 5, 2024

carlescufi commented Aug 6, 2024 • edited Loading

zkat2 commented Aug 6, 2024 • edited Loading

ceolin commented Aug 7, 2024

github-actions bot commented Oct 7, 2024

henrikbrixandersen commented Mar 12, 2025

thenguyenyf commented Mar 17, 2025

thenguyenyf commented Mar 24, 2025

carlescufi commented Aug 6, 2024 •

edited

Loading

zkat2 commented Aug 6, 2024 •

edited

Loading