diff options
| author | Giovanni Di Sirio <gdisirio@gmail.com> | 2018-10-06 05:04:05 +0000 |
|---|---|---|
| committer | Giovanni Di Sirio <gdisirio@gmail.com> | 2018-10-06 05:04:05 +0000 |
| commit | d27c34d080bd4a72169921e2f458546dc621b4e7 (patch) | |
| tree | a66bb79daafa8596548b22ef690310482cd86cc5 /os/hal/include/hal_qspi.h | |
| parent | 5ad3d2426f44f13439baf3f7f9de7fb9ddf1c00c (diff) | |
| download | ChibiOS-d27c34d080bd4a72169921e2f458546dc621b4e7.tar.gz ChibiOS-d27c34d080bd4a72169921e2f458546dc621b4e7.tar.bz2 ChibiOS-d27c34d080bd4a72169921e2f458546dc621b4e7.zip | |
Removed QSPI driver and demos.
git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@12331 110e8d01-0319-4d1e-a829-52ad28d1bb01
Diffstat (limited to 'os/hal/include/hal_qspi.h')
| -rw-r--r-- | os/hal/include/hal_qspi.h | 321 |
1 files changed, 0 insertions, 321 deletions
diff --git a/os/hal/include/hal_qspi.h b/os/hal/include/hal_qspi.h deleted file mode 100644 index 0fe8c223f..000000000 --- a/os/hal/include/hal_qspi.h +++ /dev/null @@ -1,321 +0,0 @@ -/*
- ChibiOS - Copyright (C) 2006..2018 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.h
- * @brief QSPI Driver macros and structures.
- *
- * @addtogroup QSPI
- * @{
- */
-
-#ifndef HAL_QSPI_H
-#define HAL_QSPI_H
-
-#if (HAL_USE_QSPI == TRUE) || defined(__DOXYGEN__)
-
-/*===========================================================================*/
-/* Driver constants. */
-/*===========================================================================*/
-
-/**
- * @name Transfer options
- * @{
- */
-#define QSPI_CFG_CMD_MASK (0xFFLU << 0LU)
-#define QSPI_CFG_CMD(n) ((n) << 0LU)
-#define QSPI_CFG_CMD_MODE_MASK (3LU << 8LU)
-#define QSPI_CFG_CMD_MODE_NONE (0LU << 8LU)
-#define QSPI_CFG_CMD_MODE_ONE_LINE (1LU << 8LU)
-#define QSPI_CFG_CMD_MODE_TWO_LINES (2LU << 8LU)
-#define QSPI_CFG_CMD_MODE_FOUR_LINES (3LU << 8LU)
-#define QSPI_CFG_ADDR_MODE_MASK (3LU << 10LU)
-#define QSPI_CFG_ADDR_MODE_NONE (0LU << 10LU)
-#define QSPI_CFG_ADDR_MODE_ONE_LINE (1LU << 10LU)
-#define QSPI_CFG_ADDR_MODE_TWO_LINES (2LU << 10LU)
-#define QSPI_CFG_ADDR_MODE_FOUR_LINES (3LU << 10LU)
-#define QSPI_CFG_ADDR_SIZE_MASK (3LU << 12LU)
-#define QSPI_CFG_ADDR_SIZE_8 (0LU << 12LU)
-#define QSPI_CFG_ADDR_SIZE_16 (1LU << 12LU)
-#define QSPI_CFG_ADDR_SIZE_24 (2LU << 12LU)
-#define QSPI_CFG_ADDR_SIZE_32 (3LU << 12LU)
-#define QSPI_CFG_ALT_MODE_MASK (3LU << 14LU)
-#define QSPI_CFG_ALT_MODE_NONE (0LU << 14LU)
-#define QSPI_CFG_ALT_MODE_ONE_LINE (1LU << 14LU)
-#define QSPI_CFG_ALT_MODE_TWO_LINES (2LU << 14LU)
-#define QSPI_CFG_ALT_MODE_FOUR_LINES (3LU << 14LU)
-#define QSPI_CFG_ALT_SIZE_MASK (3LU << 16LU)
-#define QSPI_CFG_ALT_SIZE_8 (0LU << 16LU)
-
-#define QSPI_CFG_ALT_SIZE_16 (1LU << 16LU)
-#define QSPI_CFG_ALT_SIZE_24 (2LU << 16LU)
-#define QSPI_CFG_ALT_SIZE_32 (3LU << 16LU)
-#define QSPI_CFG_DUMMY_CYCLES_MASK (0x1FLU << 18LU)
-#define QSPI_CFG_DUMMY_CYCLES(n) ((n) << 18LU)
-#define QSPI_CFG_DATA_MODE_MASK (3LU << 24LU)
-#define QSPI_CFG_DATA_MODE_NONE (0LU << 24LU)
-#define QSPI_CFG_DATA_MODE_ONE_LINE (1LU << 24LU)
-#define QSPI_CFG_DATA_MODE_TWO_LINES (2LU << 24LU)
-#define QSPI_CFG_DATA_MODE_FOUR_LINES (3LU << 24LU)
-#define QSPI_CFG_SIOO (1LU << 28LU)
-#define QSPI_CFG_DDRM (1LU << 31LU)
-/** @} */
-
-/*===========================================================================*/
-/* Driver pre-compile time settings. */
-/*===========================================================================*/
-
-/**
- * @name QSPI configuration options
- * @{
- */
-/**
- * @brief Enables synchronous APIs.
- * @note Disabling this option saves both code and data space.
- */
-#if !defined(QSPI_USE_WAIT) || defined(__DOXYGEN__)
-#define QSPI_USE_WAIT TRUE
-#endif
-
-/**
- * @brief Enables the @p qspiAcquireBus() and @p qspiReleaseBus() APIs.
- * @note Disabling this option saves both code and data space.
- */
-#if !defined(QSPI_USE_MUTUAL_EXCLUSION) || defined(__DOXYGEN__)
-#define QSPI_USE_MUTUAL_EXCLUSION TRUE
-#endif
-/** @} */
-
-/*===========================================================================*/
-/* Derived constants and error checks. */
-/*===========================================================================*/
-
-/*===========================================================================*/
-/* Driver data structures and types. */
-/*===========================================================================*/
-
-/**
- * @brief Driver state machine possible states.
- */
-typedef enum {
- QSPI_UNINIT = 0, /**< Not initialized. */
- QSPI_STOP = 1, /**< Stopped. */
- QSPI_READY = 2, /**< Ready. */
- QSPI_ACTIVE = 3, /**< Exchanging data. */
- QSPI_COMPLETE = 4, /**< Asynchronous operation complete. */
- QSPI_MEMMAP = 5 /**< In memory mapped mode. */
-} qspistate_t;
-
-/**
- * @brief Type of a QSPI command descriptor.
- */
-typedef struct {
- uint32_t cfg;
- uint32_t addr;
- uint32_t alt;
-} qspi_command_t;
-
-#include "hal_qspi_lld.h"
-
-#if !defined(QSPI_SUPPORTS_MEMMAP)
-#error "low level does not define QSPI_SUPPORTS_MEMMAP"
-#endif
-
-/*===========================================================================*/
-/* Driver macros. */
-/*===========================================================================*/
-
-/**
- * @name Macro Functions
- * @{
- */
-/**
- * @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] cmdp pointer to the command descriptor
- *
- * @iclass
- */
-#define qspiStartCommandI(qspip, cmdp) { \
- osalDbgAssert(((cmdp)->cfg & QSPI_CFG_DATA_MODE_MASK) == \
- QSPI_CFG_DATA_MODE_NONE, \
- "data mode specified"); \
- (qspip)->state = QSPI_ACTIVE; \
- qspi_lld_command(qspip, cmdp); \
-}
-
-/**
- * @brief Sends data over the QSPI bus.
- * @details This asynchronous function starts a transmit operation.
- * @post At the end of the operation the configured callback is invoked.
- *
- * @param[in] qspip pointer to the @p QSPIDriver object
- * @param[in] cmdp pointer to the command descriptor
- * @param[in] n number of bytes to send or zero if no data phase
- * @param[in] txbuf the pointer to the transmit buffer
- *
- * @iclass
- */
-#define qspiStartSendI(qspip, cmdp, n, txbuf) { \
- osalDbgAssert(((cmdp)->cfg & QSPI_CFG_DATA_MODE_MASK) != \
- QSPI_CFG_DATA_MODE_NONE, \
- "data mode required"); \
- (qspip)->state = QSPI_ACTIVE; \
- qspi_lld_send(qspip, cmdp, n, txbuf); \
-}
-
-/**
- * @brief Receives data from the QSPI bus.
- * @details This asynchronous function starts a receive operation.
- * @post At the end of the operation the configured callback is invoked.
- *
- * @param[in] qspip pointer to the @p QSPIDriver object
- * @param[in] cmdp pointer to the command descriptor
- * @param[in] n number of bytes to receive or zero if no data phase
- * @param[out] rxbuf the pointer to the receive buffer
- *
- * @iclass
- */
-#define qspiStartReceiveI(qspip, cmdp, n, rxbuf) { \
- osalDbgAssert(((cmdp)->cfg & QSPI_CFG_DATA_MODE_MASK) != \
- QSPI_CFG_DATA_MODE_NONE, \
- "data mode required"); \
- (qspip)->state = QSPI_ACTIVE; \
- qspi_lld_receive(qspip, cmdp, n, 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
- *
- * @iclass
- */
-#define qspiMapFlashI(qspip, cmdp, addrp) \
- qspi_lld_map_flash(qspip, cmdp, 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
- *
- * @iclass
- */
-#define qspiUnmapFlashI(qspip) \
- qspi_lld_unmap_flash(qspip)
-#endif /* QSPI_SUPPORTS_MEMMAP == TRUE */
-/** @} */
-
-/**
- * @name Low level driver helper macros
- * @{
- */
-#if (QSPI_USE_WAIT == TRUE) || defined(__DOXYGEN__)
-/**
- * @brief Wakes up the waiting thread.
- *
- * @param[in] qspip pointer to the @p QSPIDriver object
- *
- * @notapi
- */
-#define _qspi_wakeup_isr(qspip) { \
- osalSysLockFromISR(); \
- osalThreadResumeI(&(qspip)->thread, MSG_OK); \
- osalSysUnlockFromISR(); \
-}
-#else /* !QSPI_USE_WAIT */
-#define _qspi_wakeup_isr(qspip)
-#endif /* !QSPI_USE_WAIT */
-
-/**
- * @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] qspip pointer to the @p QSPIDriver object
- *
- * @notapi
- */
-#define _qspi_isr_code(qspip) { \
- if ((qspip)->config->end_cb) { \
- (qspip)->state = QSPI_COMPLETE; \
- (qspip)->config->end_cb(qspip); \
- if ((qspip)->state == QSPI_COMPLETE) \
- (qspip)->state = QSPI_READY; \
- } \
- else \
- (qspip)->state = QSPI_READY; \
- _qspi_wakeup_isr(qspip); \
-}
-/** @} */
-
-/*===========================================================================*/
-/* External declarations. */
-/*===========================================================================*/
-
-#ifdef __cplusplus
-extern "C" {
-#endif
- void qspiInit(void);
- void qspiObjectInit(QSPIDriver *qspip);
- void qspiStart(QSPIDriver *qspip, const QSPIConfig *config);
- void qspiStop(QSPIDriver *qspip);
- void qspiStartCommand(QSPIDriver *qspip, const qspi_command_t *cmdp);
- void qspiStartSend(QSPIDriver *qspip, const qspi_command_t *cmdp,
- size_t n, const uint8_t *txbuf);
- void qspiStartReceive(QSPIDriver *qspip, const qspi_command_t *cmdp,
- size_t n, uint8_t *rxbuf);
-#if QSPI_USE_WAIT == TRUE
- void qspiCommand(QSPIDriver *qspip, const qspi_command_t *cmdp);
- void qspiSend(QSPIDriver *qspip, const qspi_command_t *cmdp,
- size_t n, const uint8_t *txbuf);
- void qspiReceive(QSPIDriver *qspip, const qspi_command_t *cmdp,
- size_t n, uint8_t *rxbuf);
-#endif
-#if QSPI_SUPPORTS_MEMMAP == TRUE
-void qspiMapFlash(QSPIDriver *qspip,
- const qspi_command_t *cmdp,
- uint8_t **addrp);
-void qspiUnmapFlash(QSPIDriver *qspip);
-#endif
-#if QSPI_USE_MUTUAL_EXCLUSION == TRUE
- void qspiAcquireBus(QSPIDriver *qspip);
- void qspiReleaseBus(QSPIDriver *qspip);
-#endif
-#ifdef __cplusplus
-}
-#endif
-
-#endif /* HAL_USE_QSPI == TRUE */
-
-#endif /* HAL_QSPI_H */
-
-/** @} */
|