qspi.h

Go to the documentation of this file.

/*NB_REVISION*/
 
/*NB_COPYRIGHT*/
 
#ifndef _QSPI_H
#define _QSPI_H
#include <basictypes.h>
#include <nbrtos.h>
 
/*
 *****************************************************************************-
 *
 * Queued Serial Peripheral Interface (QSPI)
 *
 * Interface consists of data output (QSPI_DOUT), data input (QSPI_DIN),
 * serial clock (QSPI_CLK) & peripheral chip selects (QSPI_CS[3:0]).
 *
 * SPI parameters are used to match the master (processor) with the slave
 * device. Chip select can be used to multiplex devices.
 *
 * The specific hardware initialization for MFCXXXX and MODXXXX are
 * microprocessor and module specific and need to be correctly
 * implemented in the module specific library for each SPI device.
 *
 * More than one SPI device requires careful coordination of hardware use
 * and synchronization of use.
 *
 *****************************************************************************-
 */
 
#define QSPI_OK (0) 
#define QSPI_BUSY (1) 
uint8_t QSPIInit(uint32_t baudRateInBps = 2000000,
 uint8_t transferSizeInBits = 8,
 uint8_t peripheralChipSelects = 0x0F,
 uint8_t chipSelectPolarity = 1,
 uint8_t clockPolarity = 0,
 uint8_t clockPhase = 1,
 BOOL doutHiz = TRUE,
 uint8_t csToClockDelay = 0,
 uint8_t delayAfterTransfer = 0);
 
uint8_t QSPIStart(puint8_t transmitBufferPtr, volatile uint8_t *receiveBufferPtr, uint32_t byteCount, OS_SEM *finishedSem = NULL);
 
BOOL QSPIdone(void);
 
struct QSPI_Record
{
 volatile uint8_t *pQSPIRxbuf; 
 volatile uint8_t *pQSPITxbuf; 
 uint8_t BitsPerQueue; 
 uint32_t QSPI_SizeLeft; 
 uint16_t Command_Mask; 
 OS_SEM *QSPI_Sem; 
};
 
#endif