summaryrefslogtreecommitdiffstats
path: root/bsps/arm/atsam/include/libchip/include/qspi.h
diff options
context:
space:
mode:
authorChris Johns <chrisj@rtems.org>2017-12-23 18:18:56 +1100
committerSebastian Huber <sebastian.huber@embedded-brains.de>2018-01-25 08:45:26 +0100
commit2afb22b7e1ebcbe40373ff7e0efae7d207c655a9 (patch)
tree44759efe9374f13200a97e96d91bd9a2b7e5ce2a /bsps/arm/atsam/include/libchip/include/qspi.h
parentMAINTAINERS: Add myself to Write After Approval. (diff)
downloadrtems-2afb22b7e1ebcbe40373ff7e0efae7d207c655a9.tar.bz2
Remove make preinstall
A speciality of the RTEMS build system was the make preinstall step. It copied header files from arbitrary locations into the build tree. The header files were included via the -Bsome/build/tree/path GCC command line option. This has at least seven problems: * The make preinstall step itself needs time and disk space. * Errors in header files show up in the build tree copy. This makes it hard for editors to open the right file to fix the error. * There is no clear relationship between source and build tree header files. This makes an audit of the build process difficult. * The visibility of all header files in the build tree makes it difficult to enforce API barriers. For example it is discouraged to use BSP-specifics in the cpukit. * An introduction of a new build system is difficult. * Include paths specified by the -B option are system headers. This may suppress warnings. * The parallel build had sporadic failures on some hosts. This patch removes the make preinstall step. All installed header files are moved to dedicated include directories in the source tree. Let @RTEMS_CPU@ be the target architecture, e.g. arm, powerpc, sparc, etc. Let @RTEMS_BSP_FAMILIY@ be a BSP family base directory, e.g. erc32, imx, qoriq, etc. The new cpukit include directories are: * cpukit/include * cpukit/score/cpu/@RTEMS_CPU@/include * cpukit/libnetworking The new BSP include directories are: * bsps/include * bsps/@RTEMS_CPU@/include * bsps/@RTEMS_CPU@/@RTEMS_BSP_FAMILIY@/include There are build tree include directories for generated files. The include directory order favours the most general header file, e.g. it is not possible to override general header files via the include path order. The "bootstrap -p" option was removed. The new "bootstrap -H" option should be used to regenerate the "headers.am" files. Update #3254.
Diffstat (limited to 'bsps/arm/atsam/include/libchip/include/qspi.h')
-rw-r--r--bsps/arm/atsam/include/libchip/include/qspi.h236
1 files changed, 236 insertions, 0 deletions
diff --git a/bsps/arm/atsam/include/libchip/include/qspi.h b/bsps/arm/atsam/include/libchip/include/qspi.h
new file mode 100644
index 0000000000..c1f81f6ad6
--- /dev/null
+++ b/bsps/arm/atsam/include/libchip/include/qspi.h
@@ -0,0 +1,236 @@
+/* ---------------------------------------------------------------------------- */
+/* Atmel Microcontroller Software Support */
+/* SAM Software Package License */
+/* ---------------------------------------------------------------------------- */
+/* Copyright (c) 2015, Atmel Corporation */
+/* */
+/* All rights reserved. */
+/* */
+/* Redistribution and use in source and binary forms, with or without */
+/* modification, are permitted provided that the following condition is met: */
+/* */
+/* - Redistributions of source code must retain the above copyright notice, */
+/* this list of conditions and the disclaimer below. */
+/* */
+/* Atmel's name may not be used to endorse or promote products derived from */
+/* this software without specific prior written permission. */
+/* */
+/* DISCLAIMER: THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR */
+/* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF */
+/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE */
+/* DISCLAIMED. IN NO EVENT SHALL ATMEL BE LIABLE FOR ANY DIRECT, INDIRECT, */
+/* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT */
+/* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, */
+/* OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF */
+/* LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING */
+/* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, */
+/* EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */
+/* ---------------------------------------------------------------------------- */
+
+
+/**
+ * \file
+ *
+ * Interface for Serial Peripheral Interface (SPI) controller.
+ *
+ */
+
+#ifndef _QSPI_
+#define _QSPI_
+/*----------------------------------------------------------------------------
+ * Macros
+ *----------------------------------------------------------------------------*/
+
+/**
+ *
+ * Here are several macros which should be used when configuring a SPI
+ * peripheral.
+ *
+ * \section qspi_configuration_macros SPI Configuration Macros
+ * - \ref QSPI_PCS
+ * - \ref QSPI_SCBR
+ * - \ref QSPI_DLYBS
+ * - \ref QSPI_DLYBCT
+ */
+
+/** Calculates the value of the CSR SCBR field given the baudrate and MCK. */
+#define QSPI_SCBR(baudrate, masterClock) \
+ ((uint32_t) (masterClock / baudrate) << 8)
+
+/** Calculates the value of the CSR DLYBS field given the desired delay (in ns) */
+#define QSPI_DLYBS(delay, masterClock) \
+ ((uint32_t) (((masterClock / 1000000) * delay) / 1000) << 16)
+
+/** Calculates the value of the CSR DLYBCT field given the desired delay (in ns) */
+#define QSPI_DLYBCT(delay, masterClock) \
+ ((uint32_t) (((masterClock / 1000000) * delay) / 32000) << 24)
+
+/*--------------------------------------------------------------------------- */
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/*----------------------------------------------------------------------------
+ * Exported functions
+ *----------------------------------------------------------------------------*/
+
+/** \brief qspi access modes
+ */
+typedef enum {
+ CmdAccess = 0,
+ ReadAccess,
+ WriteAccess
+} Access_t;
+
+/** \brief qspi modes SPI or QSPI
+ */
+typedef enum {
+ SpiMode = QSPI_MR_SMM_SPI,
+ QspiMemMode = QSPI_MR_SMM_MEMORY
+} QspiMode_t;
+
+
+/** \brief qspi clock modes , regarding clock phase and clock polarity
+ */
+typedef enum {
+ ClockMode_00 = 0,
+ ClockMode_10,
+ ClockMode_01,
+ ClockMode_11
+} QspiClockMode_t;
+
+
+/** \brief qspi status codes
+ */
+typedef enum {
+ QSPI_SUCCESS = 0,
+ QSPI_BUSY,
+ QSPI_BUSY_SENDING,
+ QSPI_READ_ERROR,
+ QSPI_WRITE_ERROR,
+ QSPI_UNKNOWN_ERROR,
+ QSPI_INIT_ERROR,
+ QSPI_INPUT_ERROR,
+ QSPI_TOTAL_ERROR
+} QspidStatus_t;
+
+
+/** \brief qspi status regiter bits
+ */
+typedef enum {
+ IsReceived = QSPI_SR_RDRF,
+ IsTxSent = QSPI_SR_TDRE,
+ IsTxEmpty = QSPI_SR_TXEMPTY,
+ IsOverrun = QSPI_SR_OVRES,
+ IsCsRise = QSPI_SR_CSR,
+ IsCsAsserted = QSPI_SR_CSS,
+ IsEofInst = QSPI_SR_INSTRE,
+ IsEnabled = QSPI_SR_QSPIENS
+} QspiStatus_t;
+
+/** \brief qspi command structure
+ */
+typedef struct {
+ uint8_t Instruction;
+ uint8_t Option;
+} QspiMemCmd_t;
+
+/** \brief qspi buffer structure
+ */
+typedef struct {
+ uint32_t TxDataSize; /* Tx buffer size */
+ uint32_t RxDataSize; /* Rx buffer size */
+ const void *pDataTx; /* Tx buffer */
+ void *pDataRx; /* Rx buffer */
+} QspiBuffer_t;
+
+
+/** \brief qspi frame structure for QSPI mode
+ */
+typedef struct {
+ union _QspiInstFrame {
+ uint32_t val;
+ struct _QspiInstFrameBM {
+ uint32_t bwidth: 3, /** Width of QSPI Addr , inst data */
+ reserved0: 1, /** Reserved*/
+ bInstEn: 1, /** Enable Inst */
+ bAddrEn: 1, /** Enable Address */
+ bOptEn: 1, /** Enable Option */
+ bDataEn: 1, /** Enable Data */
+ bOptLen: 2, /** Option Length*/
+ bAddrLen: 1, /** Addrs Length*/
+ reserved1: 1, /** Option Length*/
+ bXfrType: 2, /** Transfer type*/
+ bContinuesRead: 1, /** Continoues read mode*/
+ reserved2: 1, /** Reserved*/
+ bDummyCycles: 5, /**< Unicast hash match */
+ reserved3: 11; /** Reserved*/
+ } bm;
+ } InstFrame;
+ uint32_t Addr;
+} QspiInstFrame_t;
+
+/** \brief qspi driver structure
+ */
+typedef struct {
+ uint8_t qspiId; /* QSPI ID */
+ Qspi *pQspiHw; /* QSPI Hw instance */
+ QspiMode_t qspiMode; /* Qspi mode: SPI or QSPI */
+ QspiMemCmd_t qspiCommand; /* Qspi command structure*/
+ QspiBuffer_t qspiBuffer; /* Qspi buffer*/
+ QspiInstFrame_t *pQspiFrame; /* Qspi QSPI mode Fram register informations*/
+} Qspid_t;
+
+
+void QSPI_SwReset(Qspi *pQspi);
+
+void QSPI_Disable(Qspi *pQspi);
+
+void QSPI_Enable(Qspi *pQspi);
+
+QspidStatus_t QSPI_EndTransfer(Qspi *pQspi);
+
+uint32_t QSPI_GetStatus(Qspi *pQspi, const QspiStatus_t rStatus);
+
+void QSPI_ConfigureClock(Qspi *pQspi, QspiClockMode_t ClockMode,
+ uint32_t dwClockCfg);
+
+QspidStatus_t QSPI_SingleReadSPI(Qspid_t *pQspid, uint16_t *const pData);
+
+QspidStatus_t QSPI_MultiReadSPI(Qspid_t *pQspid, uint16_t *
+ const pData, uint32_t NumOfBytes);
+
+QspidStatus_t QSPI_SingleWriteSPI(Qspid_t *pQspid, uint16_t const *pData);
+
+QspidStatus_t QSPI_MultiWriteSPI(Qspid_t *pQspid, uint16_t const *pData ,
+ uint32_t NumOfBytes);
+
+QspidStatus_t QSPI_EnableIt(Qspi *pQspi, uint32_t dwSources);
+
+QspidStatus_t QSPI_DisableIt(Qspi *pQspi, uint32_t dwSources);
+
+uint32_t QSPI_GetItMask(Qspi *pQspi);
+
+uint32_t QSPI_GetEnabledItStatus(Qspi *pQspi);
+
+QspidStatus_t QSPI_ConfigureInterface(Qspid_t *pQspid, QspiMode_t Mode,
+ uint32_t dwConfiguration);
+
+QspidStatus_t QSPI_SendCommand(Qspid_t *pQspi, uint8_t const KeepCfg);
+
+QspidStatus_t QSPI_SendCommandWithData(Qspid_t *pQspi, uint8_t const KeepCfg);
+
+QspidStatus_t QSPI_ReadCommand(Qspid_t *pQspi, uint8_t const KeepCfg);
+
+QspidStatus_t QSPI_EnableMemAccess(Qspid_t *pQspi, uint8_t const KeepCfg,
+ uint8_t ScrambleFlag);
+
+QspidStatus_t QSPI_ReadWriteMem(Qspid_t *pQspid, Access_t const ReadWrite);
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* #ifndef _QSPI_ */
+