git.sur5r.net Git - freertos/blob

   1 /******************************************************************************
   2 *
   3 * Copyright (C) 2014 Xilinx, Inc.  All rights reserved.
   4 *
   5 * Permission is hereby granted, free of charge, to any person obtaining a copy
   6 * of this software and associated documentation files (the "Software"), to deal
   7 * in the Software without restriction, including without limitation the rights
   8 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
   9 * copies of the Software, and to permit persons to whom the Software is
  10 * furnished to do so, subject to the following conditions:
  11 *
  12 * The above copyright notice and this permission notice shall be included in
  13 * all copies or substantial portions of the Software.
  14 *
  15 * Use of the Software is limited solely to applications:
  16 * (a) running on a Xilinx device, or
  17 * (b) that interact with a Xilinx device through a bus or interconnect.
  18 *
  19 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  20 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  21 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
  22 * XILINX  BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
  23 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF
  24 * OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  25 * SOFTWARE.
  26 *
  27 * Except as contained in this notice, the name of the Xilinx shall not be used
  28 * in advertising or otherwise to promote the sale, use or other dealings in
  29 * this Software without prior written authorization from Xilinx.
  30 *
  31 ******************************************************************************/
  32 /*****************************************************************************/
  33 /**
  34 *
  35 * @file xqspipsu.h
  36 * @addtogroup qspipsu_v1_0
  37 * @{
  38 * @details
  39 *
  40 * This is the header file for the implementation of QSPIPSU driver.
  41 * Generic QSPI interface allows for communication to any QSPI slave device.
  42 * GQSPI contains a GENFIFO into which the bus transfers required are to be
  43 * pushed with appropriate configuration. The controller provides TX and RX
  44 * FIFO's and a DMA to be used for RX transfers. The controller executes each
  45 * GENFIFO entry noting the configuration and places data on the bus as required
  46 *
  47 * The different options in GENFIFO are as follows:
  48 * IMM_DATA : Can be one byte of data to be transmitted, number of clocks or
  49 *            number of bytes in transfer.
  50 * DATA_XFER : Indicates that data/clocks need to be transmitted or received.
  51 * EXPONENT : e when 2^e bytes are involved in transfer.
  52 * SPI_MODE : SPI/Dual SPI/Quad SPI
  53 * CS : Lower or Upper CS or Both
  54 * Bus : Lower or Upper Bus or Both
  55 * TX : When selected, controller transmits data in IMM or fetches number of
  56 *      bytes mentioned form TX FIFO. If not selected, dummies are pumped.
  57 * RX : When selected, controller receives and fills the RX FIFO/allows RX DMA
  58 *      of requested number of bytes. If not selected, RX data is discarded.
  59 * Stripe : Byte stripe over lower and upper bus or not.
  60 * Poll : Polls response to match for to a set value (used along with POLL_CFG
  61 *        registers) and then proceeds to next GENFIFO entry.
  62 *        This feature is not currently used in the driver.
  63 *
  64 * GENFIFO has manual and auto start options.
  65 * All DMA requests need a 4-byte aligned destination address buffer and
  66 * size of transfer should also be a multiple of 4.
  67 * This driver supports DMA RX and IO RX.
  68 *
  69 * Initialization:
  70 * This driver uses the GQSPI controller with RX DMA. It supports both
  71 * interrupt and polled transfers. Manual start of GENFIFO is used.
  72 * XQspiPsu_CfgInitialize() initializes the instance variables.
  73 * Additional setting can be done using SetOptions/ClearOptions functions
  74 * and SelectSlave function.
  75 *
  76 * Transfer:
  77 * Polled or Interrupt transfers can be done. The transfer function needs the
  78 * message(s) to be transmitted in the form of an array of type XQspiPsu_Msg.
  79 * This is supposed to contain the byte count and any TX/RX buffers as required.
  80 * Flags can be used indicate further information such as whether the message
  81 * should be striped. The transfer functions form and write GENFIFO entries,
  82 * check the status of the transfer and report back to the application
  83 * when done.
  84 *
  85 * <pre>
  86 * MODIFICATION HISTORY:
  87 *
  88 * Ver   Who Date     Changes
  89 * ----- --- -------- -----------------------------------------------.
  90 * 1.0   hk  08/21/14 First release
  91 *       sk  03/13/15 Added IO mode support.
  92 *       hk  03/18/15 Switch to I/O mode before clearing RX FIFO.
  93 *                    Clear and disbale DMA interrupts/status in abort.
  94 *                    Use DMA DONE bit instead of BUSY as recommended.
  95 *       sk  04/24/15 Modified the code according to MISRAC-2012.
  96 *       sk  06/17/15 Removed NULL checks for Rx/Tx buffers. As
  97 *                    writing/reading from 0x0 location is permitted.
  98 *
  99 * </pre>
 100 *
 101 ******************************************************************************/
 102 #ifndef XQSPIPSU_H_             /* prevent circular inclusions */
 103 #define XQSPIPSU_H_             /* by using protection macros */
 104
 105 #ifdef __cplusplus
 106 extern "C" {
 107 #endif
 108
 109 /***************************** Include Files *********************************/
 110
 111 #include "xstatus.h"
 112 #include "xqspipsu_hw.h"
 113 #include "xil_cache.h"
 114
 115 /**************************** Type Definitions *******************************/
 116 /**
 117  * The handler data type allows the user to define a callback function to
 118  * handle the asynchronous processing for the QSPIPSU device.  The application
 119  * using this driver is expected to define a handler of this type to support
 120  * interrupt driven mode.  The handler executes in an interrupt context, so
 121  * only minimal processing should be performed.
 122  *
 123  * @param       CallBackRef is the callback reference passed in by the upper
 124  *              layer when setting the callback functions, and passed back to
 125  *              the upper layer when the callback is invoked. Its type is
 126  *              not important to the driver, so it is a void pointer.
 127  * @param       StatusEvent holds one or more status events that have occurred.
 128  *              See the XQspiPsu_SetStatusHandler() for details on the status
 129  *              events that can be passed in the callback.
 130  * @param       ByteCount indicates how many bytes of data were successfully
 131  *              transferred.  This may be less than the number of bytes
 132  *              requested if the status event indicates an error.
 133  */
 134 typedef void (*XQspiPsu_StatusHandler) (void *CallBackRef, u32 StatusEvent,
 135                                         u32 ByteCount);
 136
 137 /**
 138  * This typedef contains configuration information for a flash message.
 139  */
 140 typedef struct {
 141         u8 *TxBfrPtr;
 142         u8 *RxBfrPtr;
 143         u32 ByteCount;
 144         u32 BusWidth;
 145         u32 Flags;
 146 } XQspiPsu_Msg;
 147
 148 /**
 149  * This typedef contains configuration information for the device.
 150  */
 151 typedef struct {
 152         u16 DeviceId;           /**< Unique ID  of device */
 153         u32 BaseAddress;        /**< Base address of the device */
 154         u32 InputClockHz;       /**< Input clock frequency */
 155         u8  ConnectionMode; /**< Single, Stacked and Parallel mode */
 156         u8  BusWidth;   /**< Bus width available on board */
 157 } XQspiPsu_Config;
 158
 159 /**
 160  * The XQspiPsu driver instance data. The user is required to allocate a
 161  * variable of this type for every QSPIPSU device in the system. A pointer
 162  * to a variable of this type is then passed to the driver API functions.
 163  */
 164 typedef struct {
 165         XQspiPsu_Config Config;  /**< Configuration structure */
 166         u32 IsReady;             /**< Device is initialized and ready */
 167
 168         u8 *SendBufferPtr;       /**< Buffer to send (state) */
 169         u8 *RecvBufferPtr;       /**< Buffer to receive (state) */
 170         u8 *GenFifoBufferPtr;    /**< Gen FIFO entries */
 171         s32 TxBytes;     /**< Number of bytes to transfer (state) */
 172         s32 RxBytes;     /**< Number of bytes left to transfer(state) */
 173         s32 GenFifoEntries;      /**< Number of Gen FIFO entries remaining */
 174         u32 IsBusy;              /**< A transfer is in progress (state) */
 175         u32 ReadMode;            /**< DMA or IO mode */
 176         u32 GenFifoCS;
 177         u32 GenFifoBus;
 178         s32 NumMsg;
 179         s32 MsgCnt;
 180         s32 IsUnaligned;
 181         u8 IsManualstart;
 182         XQspiPsu_Msg *Msg;
 183         XQspiPsu_StatusHandler StatusHandler;
 184         void *StatusRef;         /**< Callback reference for status handler */
 185 } XQspiPsu;
 186
 187 /***************** Macros (Inline Functions) Definitions *********************/
 188
 189 #define XQSPIPSU_READMODE_DMA   0x0U
 190 #define XQSPIPSU_READMODE_IO    0x1U
 191
 192 #define XQSPIPSU_SELECT_FLASH_CS_LOWER  0x1U
 193 #define XQSPIPSU_SELECT_FLASH_CS_UPPER  0x2U
 194 #define XQSPIPSU_SELECT_FLASH_CS_BOTH   0x3U
 195
 196 #define XQSPIPSU_SELECT_FLASH_BUS_LOWER 0x1U
 197 #define XQSPIPSU_SELECT_FLASH_BUS_UPPER 0x2U
 198 #define XQSPIPSU_SELECT_FLASH_BUS_BOTH  0x3U
 199
 200 #define XQSPIPSU_SELECT_MODE_SPI        0x1U
 201 #define XQSPIPSU_SELECT_MODE_DUALSPI    0x2U
 202 #define XQSPIPSU_SELECT_MODE_QUADSPI    0x4U
 203
 204 #define XQSPIPSU_GENFIFO_CS_SETUP       0x05U
 205 #define XQSPIPSU_GENFIFO_CS_HOLD        0x04U
 206
 207 #define XQSPIPSU_CLK_ACTIVE_LOW_OPTION  0x2U
 208 #define XQSPIPSU_CLK_PHASE_1_OPTION     0x4U
 209 #define XQSPIPSU_MANUAL_START_OPTION    0x8U
 210
 211 #define XQSPIPSU_GENFIFO_EXP_START      0x100U
 212
 213 #define XQSPIPSU_DMA_BYTES_MAX          0x10000000U
 214
 215 #define XQSPIPSU_CLK_PRESCALE_2         0x00U
 216 #define XQSPIPSU_CLK_PRESCALE_4         0x01U
 217 #define XQSPIPSU_CLK_PRESCALE_8         0x02U
 218 #define XQSPIPSU_CLK_PRESCALE_16                0x03U
 219 #define XQSPIPSU_CLK_PRESCALE_32                0x04U
 220 #define XQSPIPSU_CLK_PRESCALE_64                0x05U
 221 #define XQSPIPSU_CLK_PRESCALE_128       0x06U
 222 #define XQSPIPSU_CLK_PRESCALE_256       0x07U
 223 #define XQSPIPSU_CR_PRESC_MAXIMUM       7U
 224
 225 #define XQSPIPSU_CONNECTION_MODE_SINGLE         0U
 226 #define XQSPIPSU_CONNECTION_MODE_STACKED        1U
 227 #define XQSPIPSU_CONNECTION_MODE_PARALLEL       2U
 228
 229 /* Add more flags as required */
 230 #define XQSPIPSU_MSG_FLAG_STRIPE        0x1U
 231 #define XQSPIPSU_MSG_FLAG_RX            0x2U
 232 #define XQSPIPSU_MSG_FLAG_TX            0x4U
 233
 234 #define XQspiPsu_Select(InstancePtr)    XQspiPsu_Out32(((InstancePtr)->Config.BaseAddress) + XQSPIPSU_SEL_OFFSET, XQSPIPSU_SEL_MASK)
 235
 236 #define XQspiPsu_Enable(InstancePtr)    XQspiPsu_Out32(((InstancePtr)->Config.BaseAddress) + XQSPIPSU_EN_OFFSET, XQSPIPSU_EN_MASK)
 237
 238 #define XQspiPsu_Disable(InstancePtr)   XQspiPsu_Out32(((InstancePtr)->Config.BaseAddress) + XQSPIPSU_EN_OFFSET, 0x0U)
 239
 240 /************************** Function Prototypes ******************************/
 241
 242 /* Initialization and reset */
 243 XQspiPsu_Config *XQspiPsu_LookupConfig(u16 DeviceId);
 244 s32 XQspiPsu_CfgInitialize(XQspiPsu *InstancePtr, XQspiPsu_Config *ConfigPtr,
 245                                 u32 EffectiveAddr);
 246 void XQspiPsu_Reset(XQspiPsu *InstancePtr);
 247 void XQspiPsu_Abort(XQspiPsu *InstancePtr);
 248
 249 /* Transfer functions and handlers */
 250 s32 XQspiPsu_PolledTransfer(XQspiPsu *InstancePtr, XQspiPsu_Msg *Msg,
 251                                 u32 NumMsg);
 252 s32 XQspiPsu_InterruptTransfer(XQspiPsu *InstancePtr, XQspiPsu_Msg *Msg,
 253                                 u32 NumMsg);
 254 s32 XQspiPsu_InterruptHandler(XQspiPsu *InstancePtr);
 255 void XQspiPsu_SetStatusHandler(XQspiPsu *InstancePtr, void *CallBackRef,
 256                                 XQspiPsu_StatusHandler FuncPointer);
 257
 258 /* Configuration functions */
 259 s32 XQspiPsu_SetClkPrescaler(XQspiPsu *InstancePtr, u8 Prescaler);
 260 void XQspiPsu_SelectFlash(XQspiPsu *InstancePtr, u8 FlashCS, u8 FlashBus);
 261 s32 XQspiPsu_SetOptions(XQspiPsu *InstancePtr, u32 Options);
 262 s32 XQspiPsu_ClearOptions(XQspiPsu *InstancePtr, u32 Options);
 263 u32 XQspiPsu_GetOptions(XQspiPsu *InstancePtr);
 264 s32 XQspiPsu_SetReadMode(XQspiPsu *InstancePtr, u32 Mode);
 265
 266 #ifdef __cplusplus
 267 }
 268 #endif
 269
 270
 271 #endif /* XQSPIPSU_H_ */
 272 /** @} */