aboutsummaryrefslogtreecommitdiffstats
path: root/os/hal/templates/hal_qspi_lld.c
diff options
context:
space:
mode:
authorGiovanni Di Sirio <gdisirio@gmail.com>2016-07-07 08:37:51 +0000
committerGiovanni Di Sirio <gdisirio@gmail.com>2016-07-07 08:37:51 +0000
commitc7a343c1721124be84ce84fd8d60c95da86172e4 (patch)
treed9d97f4c5d406248d1e08400a019fc08ff788a0a /os/hal/templates/hal_qspi_lld.c
parent53055a4b73bdad4f7c0e8b0bfbe34fdffc70361e (diff)
downloadChibiOS-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.c')
-rw-r--r--os/hal/templates/hal_qspi_lld.c208
1 files changed, 208 insertions, 0 deletions
diff --git a/os/hal/templates/hal_qspi_lld.c b/os/hal/templates/hal_qspi_lld.c
new file mode 100644
index 000000000..d380b6c20
--- /dev/null
+++ b/os/hal/templates/hal_qspi_lld.c
@@ -0,0 +1,208 @@
+/*
+ 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.c
+ * @brief PLATFORM QSPI subsystem low level driver source.
+ *
+ * @addtogroup QSPI
+ * @{
+ */
+
+#include "hal.h"
+
+#if HAL_USE_QSPI || defined(__DOXYGEN__)
+
+/*===========================================================================*/
+/* Driver local definitions. */
+/*===========================================================================*/
+
+/*===========================================================================*/
+/* Driver exported variables. */
+/*===========================================================================*/
+
+/** @brief QSPID1 driver identifier.*/
+#if PLATFORM_QSPI_USE_QSPI1 || defined(__DOXYGEN__)
+QSPIDriver QSPID1;
+#endif
+
+/*===========================================================================*/
+/* Driver local variables and types. */
+/*===========================================================================*/
+
+/*===========================================================================*/
+/* Driver local functions. */
+/*===========================================================================*/
+
+/*===========================================================================*/
+/* Driver interrupt handlers. */
+/*===========================================================================*/
+
+/*===========================================================================*/
+/* Driver exported functions. */
+/*===========================================================================*/
+
+/**
+ * @brief Low level QSPI driver initialization.
+ *
+ * @notapi
+ */
+void qspi_lld_init(void) {
+
+#if PLATFORM_QSPI_USE_QSPI1
+ qspiObjectInit(&QSPID1);
+#endif
+}
+
+/**
+ * @brief Configures and activates the QSPI peripheral.
+ *
+ * @param[in] qspip pointer to the @p QSPIDriver object
+ *
+ * @notapi
+ */
+void qspi_lld_start(QSPIDriver *qspip) {
+
+ /* If in stopped state then full initialization.*/
+ if (qspip->state == QSPI_STOP) {
+#if PLATFORM_QSPI_USE_QSPI1
+ if (&QSPID1 == qspip) {
+ }
+#endif
+
+ /* Common initializations.*/
+ }
+
+ /* QSPI setup and enable.*/
+}
+
+/**
+ * @brief Deactivates the QSPI peripheral.
+ *
+ * @param[in] qspip pointer to the @p QSPIDriver object
+ *
+ * @notapi
+ */
+void qspi_lld_stop(QSPIDriver *qspip) {
+
+ /* If in ready state then disables QSPI.*/
+ if (qspip->state == QSPI_READY) {
+
+ /* QSPI disable.*/
+
+ /* Stopping involved clocks.*/
+#if PLATFORM_QSPI_USE_QSPI1
+ if (&QSPID1 == qspip) {
+ }
+#endif
+ }
+}
+
+/**
+ * @brief Sends a command without data phase.
+ * @post At the end of the operation the configured callback is invoked.
+ *
+ * @param[in] qspip pointer to the @p QSPIDriver object
+ * @param[in] cmd pointer to the command descriptor
+ *
+ * @notapi
+ */
+void qspi_lld_command(QSPIDriver *qspip, const qspi_command_t *cmdp) {
+
+ (void)qspip;
+ (void)cmdp;
+}
+
+/**
+ * @brief Sends a command with data over the QSPI bus.
+ * @post At the end of the operation the configured callback is invoked.
+ *
+ * @param[in] qspip pointer to the @p QSPIDriver object
+ * @param[in] cmd pointer to the command descriptor
+ * @param[in] n number of bytes to send
+ * @param[in] txbuf the pointer to the transmit buffer
+ *
+ * @notapi
+ */
+void qspi_lld_send(QSPIDriver *qspip, const qspi_command_t *cmdp,
+ size_t n, const uint8_t *txbuf) {
+
+ (void)qspip;
+ (void)cmdp;
+ (void)n;
+ (void)txbuf;
+}
+
+/**
+ * @brief Sends a command then receives data over the QSPI bus.
+ * @post At the end of the operation the configured callback is invoked.
+ *
+ * @param[in] qspip pointer to the @p QSPIDriver object
+ * @param[in] cmd pointer to the command descriptor
+ * @param[in] n number of bytes to send
+ * @param[out] rxbuf the pointer to the receive buffer
+ *
+ * @notapi
+ */
+void qspi_lld_receive(QSPIDriver *qspip, const qspi_command_t *cmdp,
+ size_t n, uint8_t *rxbuf) {
+
+ (void)qspip;
+ (void)cmdp;
+ (void)n;
+ (void)rxbuf;
+}
+
+#if (QSPI_SUPPORTS_MEMMAP == TRUE) || defined(__DOXYGEN__)
+/**
+ * @brief Maps in memory space a QSPI flash device.
+ * @pre The memory flash device must be initialized appropriately
+ * before mapping it in memory space.
+ *
+ * @param[in] qspip pointer to the @p QSPIDriver object
+ * @param[in] cmdp pointer to the command descriptor
+ * @param[out] addrp pointer to the memory start address of the mapped
+ * flash or @p NULL
+ *
+ * @notapi
+ */
+void qspi_lld_map_flash(QSPIDriver *qspip,
+ const qspi_command_t *cmdp,
+ uint8_t **addrp) {
+
+ (void)qspip;
+ (void)cmdp;
+ (void)addrp;
+}
+
+/**
+ * @brief Maps in memory space a QSPI flash device.
+ * @post The memory flash device must be re-initialized for normal
+ * commands exchange.
+ *
+ * @param[in] qspip pointer to the @p QSPIDriver object
+ *
+ * @notapi
+ */
+void qspi_lld_unmap_flash(QSPIDriver *qspip) {
+
+ (void)qspip;
+}
+#endif /* QSPI_SUPPORTS_MEMMAP == TRUE */
+
+#endif /* HAL_USE_QSPI */
+
+/** @} */