aboutsummaryrefslogtreecommitdiffstats
path: root/os/hal/include
diff options
context:
space:
mode:
authorMichael Spradling <mike@mspradling.com>2015-06-29 21:54:13 -0400
committerMichael Spradling <mike@mspradling.com>2015-08-16 01:26:07 -0400
commit316c3b4825689afca170576e5a5681302f64fdfa (patch)
treea00655dd3e1a38efa06b030f3051863a1eb15b2e /os/hal/include
parentab80aabfd48b50e122f6ff43adeedd1af4a5a607 (diff)
downloadChibiOS-Contrib-316c3b4825689afca170576e5a5681302f64fdfa.tar.gz
ChibiOS-Contrib-316c3b4825689afca170576e5a5681302f64fdfa.tar.bz2
ChibiOS-Contrib-316c3b4825689afca170576e5a5681302f64fdfa.zip
Add CRC Driver
This patch includes a high level and two low level drivers. The high level driver is enabled with flag HAL_USE_CRC The low level drivers include: * Hardware CRC for the STM32 cortex processor lines.(when supported) * Enabled with flag STM32_CRC_USE_CRC1 * DMA is enabled with CRC_USE_DMA * SYNC api will use DMA, but put calling thread to sleep * ASYNC api enabled. * DMA Disabled * SYNC api spin while calculating CRC * ASYNC api disabled * Software CRC (3 modes) * CRCSW_CRC32_TABLE - Enables crc32 with lookup table. * CRCSW_CRC16_TABLE - Enables crc16 with lookup tables. * CRCSW_PROGRAMMBLE - Enables any crc done with computation. * Can calculate any crc configuration. * CRC_USE_DMA obviously not support with software CRC
Diffstat (limited to 'os/hal/include')
-rw-r--r--os/hal/include/crc.h158
-rw-r--r--os/hal/include/hal_community.h1
2 files changed, 159 insertions, 0 deletions
diff --git a/os/hal/include/crc.h b/os/hal/include/crc.h
new file mode 100644
index 0000000..baa274b
--- /dev/null
+++ b/os/hal/include/crc.h
@@ -0,0 +1,158 @@
+/*
+ ChibiOS - Copyright (C) 2015 Michael D. Spradling
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+*/
+
+#ifndef _CRC_H_
+#define _CRC_H_
+
+#if HAL_USE_CRC || defined(__DOXYGEN__)
+
+/*===========================================================================*/
+/* Driver constants. */
+/*===========================================================================*/
+
+/*===========================================================================*/
+/* Driver pre-compile time settings. */
+/*===========================================================================*/
+
+/**
+ * @name Configuration options
+ * @{
+ */
+
+/**
+ * @brief Enable DMA CRC
+ * @note Enables DMA when doing CRC calculations. This may be less
+ * efficient with smaller CRC calculations.
+ */
+#if !defined(CRC_USE_DMA) || defined(__DOXYGEN__)
+#define CRC_USE_DMA FALSE
+#endif
+
+/**
+ * @brief Enables the @p crcAcquireBus() and @p crcReleaseBus() APIs.
+ * @note Disabling this option saves both code and data space.
+ */
+#if !defined(CRC_USE_MUTUAL_EXCLUSION) || defined(__DOXYGEN__)
+#define CRC_USE_MUTUAL_EXCLUSION TRUE
+#endif
+
+/*===========================================================================*/
+/* Derived constants and error checks. */
+/*===========================================================================*/
+
+#if STM32_CRC_USE_CRC1 != TRUE && CRCSW_USE_CRC1 != TRUE
+#error "CRC requires at least one LLD driver."
+#endif
+
+/*===========================================================================*/
+/* Driver data structures and types. */
+/*===========================================================================*/
+
+/**
+ * @brief Driver state machine possible states.
+ */
+typedef enum {
+ CRC_UNINIT, /* Not initialized. */
+ CRC_STOP, /* Stopped. */
+ CRC_READY, /* Ready. */
+ CRC_ACTIVE, /* Calculating CRC. */
+ CRC_COMPLETE /* Asynchronous operation complete. */
+} crcstate_t;
+
+#include "crc_lld.h" /* Include software LL driver */
+#include "crcsw.h"
+
+
+/*===========================================================================*/
+/* Driver macros. */
+/*===========================================================================*/
+
+/**
+ * @name Low level driver helper macros
+ * @{
+ */
+
+/**
+ * @brief Wakes up the waiting thread.
+ *
+ * @param[in] crcp pointer to the @p CRCDriver object
+ *
+ * @notapi
+ */
+#define _crc_wakeup_isr(crcp) { \
+ osalSysLockFromISR(); \
+ osalThreadResumeI(&(crcp)->thread, MSG_OK); \
+ osalSysUnlockFromISR(); \
+}
+
+/**
+ * @brief Common ISR code.
+ * @details This code handles the portable part of the ISR code:
+ * - Callback invocation.
+ * - Waiting thread wakeup, if any.
+ * - Driver state transitions.
+ * .
+ * @note This macro is meant to be used in the low level drivers
+ * implementation only.
+ *
+ * @param[in] crcp pointer to the @p CRCDriver object
+ *
+ * @notapi
+ */
+#define _crc_isr_code(crcp, crc) { \
+ if ((crcp)->config->end_cb) { \
+ (crcp)->state = CRC_COMPLETE; \
+ (crcp)->config->end_cb(crcp, crc); \
+ if ((crcp)->state == CRC_COMPLETE) \
+ (crcp)->state = CRC_READY; \
+ } \
+ else \
+ (crcp)->state = CRC_READY; \
+ _crc_wakeup_isr(crcp); \
+}
+
+/*===========================================================================*/
+/* External declarations. */
+/*===========================================================================*/
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+ void crcInit(void);
+ void crcObjectInit(CRCDriver *crcp);
+ void crcStart(CRCDriver *crcp, const CRCConfig *config);
+ void crcStop(CRCDriver *crcp);
+ void crcReset(CRCDriver *crcp);
+ void crcResetI(CRCDriver *crcp);
+ uint32_t crcCalc(CRCDriver *crcp, size_t n, const void *buf);
+ uint32_t crcCalcI(CRCDriver *crcp, size_t n, const void *buf);
+#if CRC_USE_DMA == TRUE
+ void crcStartCalc(CRCDriver *crcp, size_t n, const void *buf);
+ void crcStartCalcI(CRCDriver *crcp, size_t n, const void *buf);
+#endif
+#if CRC_USE_MUTUAL_EXCLUSION == TRUE
+ void crcAcquireUnit(CRCDriver *crcp);
+ void crcReleaseUnit(CRCDriver *crcp);
+#endif
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* HAL_USE_CRC */
+
+#endif /* _CRC_H_ */
+
+/** @} */
diff --git a/os/hal/include/hal_community.h b/os/hal/include/hal_community.h
index 6cd6b66..426fadd 100644
--- a/os/hal/include/hal_community.h
+++ b/os/hal/include/hal_community.h
@@ -35,6 +35,7 @@
/* Complex drivers.*/
#include "onewire.h"
+#include "crc.h"
/*===========================================================================*/
/* Driver constants. */