spi_driver.h

Go to the documentation of this file.

/*
 * The Clear BSD License
 * Copyright (c) 2018 Adesto Technologies Corporation, Inc
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification,
 * are permitted (subject to the limitations in the disclaimer below) provided
 *  that the following conditions are met:
 *
 * o Redistributions of source code must retain the above copyright notice, this list
 *   of conditions and the following disclaimer.
 *
 * o Redistributions in binary form must reproduce the above copyright notice, this
 *   list of conditions and the following disclaimer in the documentation and/or
 *   other materials provided with the distribution.
 *
 * o Neither the name of the copyright holder nor the names of its
 *   contributors may be used to endorse or promote products derived from this
 *   software without specific prior written permission.
 *
 * NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE GRANTED BY THIS LICENSE.
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "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 THE COPYRIGHT HOLDER OR CONTRIBUTORS 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 SPI_DRIVER_H_
#define SPI_DRIVER_H_

#include "user_config.h"

#define SPI_CSB_PORT  USER_CONFIG_CSB_PORT

#define SPI_TRIGGER_PORT  USER_CONFIG_TRIGGER_PORT

#define SPI_SCK_PORT  USER_CONFIG_SCK_PORT

#define SPI_MOSI_PORT USER_CONFIG_MOSI_PORT

#define SPI_MISO_PORT USER_CONFIG_MISO_PORT

#define SPI_WPB_PORT  USER_CONFIG_IO2_PORT

#define SPI_HOLDB_PORT USER_CONFIG_IO3_PORT

#define SPI_CSB_PIN  USER_CONFIG_CSB_PIN
#define SPI_TRIGGER_PIN  USER_CONFIG_TRIGGER_PIN
#define SPI_SCK_PIN  USER_CONFIG_SCK_PIN
#define SPI_MOSI_PIN USER_CONFIG_MOSI_PIN
#define SPI_MISO_PIN USER_CONFIG_MISO_PIN
#define SPI_WPB_PIN USER_CONFIG_IO2_PIN
#define SPI_HOLDB_PIN USER_CONFIG_IO3_PIN
#define DELAY 5U

#define SPI 0
#define QPI 1

void SPI_PinInit(uint32_t port, uint32_t pin, enum directionIO direction);

void SPI_PinClear(uint32_t port, uint32_t pin);

void SPI_PinSet(uint32_t port, uint32_t pin);

uint32_t SPI_PinRead(uint32_t port, uint32_t pin);

void SPI_Exchange(uint8_t *txBuffer,
                  uint32_t txNumBytes,
                  uint8_t *rxBuffer,
                  uint32_t rxNumBytes,
                  uint32_t dummyNumBytes);

void SPI_DualExchange(uint8_t standardSPINumBytes,
                      uint8_t *txBuffer,
                      uint32_t txNumBytes,
                      uint8_t *rxBuffer,
                      uint32_t rxNumBytes,
                      uint32_t dummyNumBytes);

void SPI_QuadExchange(uint8_t standardSPINumBytes,
                      uint8_t *txBuffer,
                      uint32_t txNumBytes,
                      uint8_t *rxBuffer,
                      uint32_t rxNumBytes,
                      uint32_t dummyNumBytes);

uint8_t SPI_ReceiveByte();

uint8_t SPI_DualReceiveByte();

void SPI_SendByte(uint8_t transmittedByte);

void SPI_DualSendByte(uint8_t transmittedByte);

void SPI_ClockTick();

void SPI_SendBit(uint8_t transmittedBit);

void SPI_Delay(uint32_t delayTime);

void SPI_ConfigureSingleSPIIOs();

void SPI_ReturnToSingleSPIIOs();

void SPI_ConfigureDualSPIIOsInput();

void SPI_ConfigureDualSPIIOsOutput();

void SPI_ConfigureQuadSPIIOsInput();

void SPI_ConfigureQuadSPIIOsOutput();

void SPI_QuadSendByte(uint8_t transmittedByte);

uint8_t SPI_QuadReceiveByte();

void SPI_Trigger();

void SPI_JEDECReset();

#endif /* SPI_DRIVER_H_ */