diff options
| author | Giovanni Di Sirio <gdisirio@gmail.com> | 2016-07-07 08:37:51 +0000 |
|---|---|---|
| committer | Giovanni Di Sirio <gdisirio@gmail.com> | 2016-07-07 08:37:51 +0000 |
| commit | c7a343c1721124be84ce84fd8d60c95da86172e4 (patch) | |
| tree | d9d97f4c5d406248d1e08400a019fc08ff788a0a /os/hal/templates/hal_qspi_lld.h | |
| parent | 53055a4b73bdad4f7c0e8b0bfbe34fdffc70361e (diff) | |
| download | ChibiOS-c7a343c1721124be84ce84fd8d60c95da86172e4.tar.gz ChibiOS-c7a343c1721124be84ce84fd8d60c95da86172e4.tar.bz2 ChibiOS-c7a343c1721124be84ce84fd8d60c95da86172e4.zip | |
QSPI templates.
git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@9685 35acf78f-673a-0410-8e92-d51de3d6d3f4
Diffstat (limited to 'os/hal/templates/hal_qspi_lld.h')
| -rw-r--r-- | os/hal/templates/hal_qspi_lld.h | 158 |
1 files changed, 158 insertions, 0 deletions
diff --git a/os/hal/templates/hal_qspi_lld.h b/os/hal/templates/hal_qspi_lld.h new file mode 100644 index 000000000..18e07f9e6 --- /dev/null +++ b/os/hal/templates/hal_qspi_lld.h @@ -0,0 +1,158 @@ +/*
+ ChibiOS - Copyright (C) 2006..2016 Giovanni Di Sirio
+
+ 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.
+*/
+
+/**
+ * @file hal_qspi_lld.h
+ * @brief PLATFORM QSPI subsystem low level driver header.
+ *
+ * @addtogroup QSPI
+ * @{
+ */
+
+#ifndef HAL_QSPI_LLD_H
+#define HAL_QSPI_LLD_H
+
+#if HAL_USE_QSPI || defined(__DOXYGEN__)
+
+/*===========================================================================*/
+/* Driver constants. */
+/*===========================================================================*/
+
+/**
+ * @name QSPI capabilities
+ * @{
+ */
+#define QSPI_SUPPORTS_MEMMAP TRUE
+/** @} */
+
+/*===========================================================================*/
+/* Driver pre-compile time settings. */
+/*===========================================================================*/
+
+/**
+ * @name Configuration options
+ * @{
+ */
+/**
+ * @brief QSPID1 driver enable switch.
+ * @details If set to @p TRUE the support for QSPID1 is included.
+ * @note The default is @p FALSE.
+ */
+#if !defined(PLATFORM_QSPI_USE_QSPI1) || defined(__DOXYGEN__)
+#define PLATFORM_QSPI_USE_QSPI1 FALSE
+#endif
+/** @} */
+
+/*===========================================================================*/
+/* Derived constants and error checks. */
+/*===========================================================================*/
+
+/*===========================================================================*/
+/* Driver data structures and types. */
+/*===========================================================================*/
+
+/**
+ * @brief Type of a structure representing an QSPI driver.
+ */
+typedef struct QSPIDriver QSPIDriver;
+
+/**
+ * @brief Type of a QSPI notification callback.
+ *
+ * @param[in] qspip pointer to the @p QSPIDriver object triggering the
+ * callback
+ */
+typedef void (*qspicallback_t)(QSPIDriver *qspip);
+
+/**
+ * @brief Driver configuration structure.
+ */
+typedef struct {
+ /**
+ * @brief Operation complete callback or @p NULL.
+ */
+ qspicallback_t end_cb;
+ /* End of the mandatory fields.*/
+} QSPIConfig;
+
+/**
+ * @brief Structure representing an QSPI driver.
+ */
+struct QSPIDriver {
+ /**
+ * @brief Driver state.
+ */
+ qspistate_t state;
+ /**
+ * @brief Current configuration data.
+ */
+ const QSPIConfig *config;
+#if QSPI_USE_WAIT || defined(__DOXYGEN__)
+ /**
+ * @brief Waiting thread.
+ */
+ thread_reference_t thread;
+#endif /* QSPI_USE_WAIT */
+#if QSPI_USE_MUTUAL_EXCLUSION || defined(__DOXYGEN__)
+ /**
+ * @brief Mutex protecting the peripheral.
+ */
+ mutex_t mutex;
+#endif /* QSPI_USE_MUTUAL_EXCLUSION */
+#if defined(QSPI_DRIVER_EXT_FIELDS)
+ QSPI_DRIVER_EXT_FIELDS
+#endif
+ /* End of the mandatory fields.*/
+};
+
+/*===========================================================================*/
+/* Driver macros. */
+/*===========================================================================*/
+
+/*===========================================================================*/
+/* External declarations. */
+/*===========================================================================*/
+
+#if PLATFORM_QSPI_USE_QSPI1 && !defined(__DOXYGEN__)
+extern QSPIDriver QSPID1;
+#endif
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+ void qspi_lld_init(void);
+ void qspi_lld_start(QSPIDriver *qspip);
+ void qspi_lld_stop(QSPIDriver *qspip);
+ void qspi_lld_command(QSPIDriver *qspip, const qspi_command_t *cmdp);
+ void qspi_lld_send(QSPIDriver *qspip, const qspi_command_t *cmdp,
+ size_t n, const uint8_t *txbuf);
+ void qspi_lld_receive(QSPIDriver *qspip, const qspi_command_t *cmdp,
+ size_t n, uint8_t *rxbuf);
+#if QSPI_SUPPORTS_MEMMAP == TRUE
+ void qspi_lld_map_flash(QSPIDriver *qspip,
+ const qspi_command_t *cmdp,
+ uint8_t **addrp);
+ void qspi_lld_unmap_flash(QSPIDriver *qspip);
+#endif
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* HAL_USE_QSPI */
+
+#endif /* HAL_QSPI_LLD_H */
+
+/** @} */
|