qspi.h

Go to the documentation of this file.

/* ---------------------------------------------------------------------------- */
/*                  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.                           */
/* ---------------------------------------------------------------------------- */


#ifndef _QSPI_
#define _QSPI_
/*----------------------------------------------------------------------------
 *        Macros
 *----------------------------------------------------------------------------*/

#define QSPI_SCBR(baudrate, masterClock) \
    ((uint32_t) (masterClock / baudrate) << 8)

#define QSPI_DLYBS(delay, masterClock) \
    ((uint32_t) (((masterClock / 1000000) * delay) / 1000) << 16)

#define QSPI_DLYBCT(delay, masterClock) \
    ((uint32_t) (((masterClock / 1000000) * delay) / 32000) << 24)

/*--------------------------------------------------------------------------- */

#ifdef __cplusplus
extern "C" {
#endif

/*----------------------------------------------------------------------------
 *        Exported functions
 *----------------------------------------------------------------------------*/

typedef enum {
    CmdAccess = 0,
    ReadAccess,
    WriteAccess
} Access_t;

typedef enum {
    SpiMode = QSPI_MR_SMM_SPI,
    QspiMemMode = QSPI_MR_SMM_MEMORY
} QspiMode_t;


typedef enum {
    ClockMode_00 = 0,
    ClockMode_10,
    ClockMode_01,
    ClockMode_11
} QspiClockMode_t;


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;


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;

typedef struct {
    uint8_t       Instruction;
    uint8_t       Option;
} QspiMemCmd_t;

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;


typedef struct {
    union _QspiInstFrame {
        uint32_t val;
        struct _QspiInstFrameBM {
            uint32_t bwidth: 3,         
                     reserved0: 1,       
                     bInstEn: 1,        
                     bAddrEn: 1,        
                     bOptEn: 1,         
                     bDataEn: 1,        
                     bOptLen: 2,        
                     bAddrLen: 1,       
                     reserved1: 1,       
                     bXfrType: 2,       
                     bContinuesRead: 1, 
                     reserved2: 1,       
                     bDummyCycles: 5,   
                     reserved3: 11;      
        } bm;
    } InstFrame;
    uint32_t       Addr;
} QspiInstFrame_t;

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_ */