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

Introduces a new sample that demonstrates how to use the
hardware-based CRC API.

Signed-off-by: Zoe Kaute <zoe.kaute@brillpower.com>

Author: Zoe Kaute

samples/drivers/crc/CMakeLists.txt

@@ -0,0 +1,8 @@
+# SPDX-License-Identifier: Apache-2.0
+
+cmake_minimum_required(VERSION 3.20.0)
+find_package(Zephyr REQUIRED HINTS $ENV{ZEPHYR_BASE})
+
+project(crc_sample)
+
+target_sources(app PRIVATE src/main.c)

samples/drivers/crc/README.rst

@@ -0,0 +1,24 @@
+.. zephyr:code-sample:: crc
+   :name: Cyclic Redundancy Check (CRC)
+   :relevant-api: crc_interface
+
+   Compute and verify a CRC checksum using the CRC driver API.
+
+Overview
+********
+
+This sample demonstrates how to use the :ref:`CRC driver API <crc_api>`.
+
+Building and Running
+********************
+
+Building and Running for ST Nucleo G474RE
+=========================================
+The sample can be built and executed for the
+:ref:`nucleo_g474re_board` as follows:
+
+.. zephyr-app-commands::
+   :zephyr-app: samples/drivers/crc
+   :board: nucleo_g474re
+   :goals: build flash
+   :compact:

samples/drivers/crc/prj.conf

@@ -0,0 +1,3 @@
+CONFIG_CRC_HW=y
+CONFIG_CRC_HW_LOG_LEVEL_INF=y
+CONFIG_LOG=y

samples/drivers/crc/sample.yaml

@@ -0,0 +1,10 @@
+# SPDX-License-Identifier: Apache-2.0
+
+sample:
+  name: CRC Sample
+tests:
+  crc_sample.test:
+    depends_on: crc
+    tags:
+      - drivers
+      - crc

samples/drivers/crc/src/main.c

@@ -0,0 +1,69 @@
+/*
+ * Copyright (c) 2024 Brill Power Ltd.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#include <zephyr/logging/log.h>
+LOG_MODULE_REGISTER(crc_example, CONFIG_LOG_DEFAULT_LEVEL);
+
+#include <zephyr/drivers/crc.h>
+#include <zephyr/device.h>
+#include <zephyr/kernel.h>
+
+int main(void)
+{
+	/* Retrieve the CRC device */
+	static const struct device *dev = DEVICE_DT_GET(DT_ALIAS(crc0));
+
+	/* Ensure the device is ready */
+	if (!device_is_ready(dev)) {
+		LOG_ERR("CRC device not found or not ready\n");
+		return -ENODEV;
+	}
+
+	/* Define the data to compute CRC */
+	uint8_t data[8] = {0x0A, 0x2B, 0x4C, 0x6D, 0x8E, 0x49, 0x00, 0xC4};
+
+	/* Define the CRC context */
+	struct crc_ctx ctx = {.type = CRC8_CCITT_HW,
+			      .flags = 0,
+			      .polynomial = CRC8_CCITT_POLY,
+			      .initial_value = CRC8_CCITT_INIT_VAL};
+
+	/* Start CRC computation */
+	int ret = crc_begin(dev, &ctx);
+
+	if (ret != 0) {
+		LOG_ERR("Failed to begin CRC: %d\n", ret);
+		return ret;
+	}
+
+	/* Update CRC computation */
+	ret = crc_update(dev, &ctx, data, 8);
+
+	if (ret != 0) {
+		LOG_ERR("Failed to update CRC: %d\n", ret);
+		return ret;
+	}
+
+	/* Finish CRC computation */
+	ret = crc_finish(dev, &ctx);
+
+	if (ret != 0) {
+		LOG_ERR("Failed to finish CRC: %d\n", ret);
+		return ret;
+	}
+
+	/* Verify the computed CRC (example expected value: 0x4D) */
+	ret = crc_verify(&ctx, 0x4D);
+
+	if (ret != 0) {
+		LOG_ERR("CRC verification failed: %d\n", ret);
+		return ret;
+	}
+
+	LOG_INF("CRC verification succeeded");
+
+	return ret;
+}