Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
Interface/QuadSpiInterface.h
- Committer:
- lucaslwl
- Date:
- 2019-08-26
- Revision:
- 22:5c07298d3383
- Parent:
- 20:652f0bf256bd
File content as of revision 22:5c07298d3383:
/*******************************************************************************
* Copyright (C) 2016 Maxim Integrated Products, Inc., All Rights Reserved.
*
* Permission is hereby granted, free of charge, to any person obtaining a
* copy of this software and associated documentation files (the "Software"),
* to deal in the Software without restriction, including without limitation
* the rights to use, copy, modify, merge, publish, distribute, sublicense,
* and/or sell copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included
* in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
* OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
* IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
* OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
* ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
* OTHER DEALINGS IN THE SOFTWARE.
*
* Except as contained in this notice, the name of Maxim Integrated
* Products, Inc. shall not be used except as stated in the Maxim Integrated
* Products, Inc. Branding Policy.
*
* The mere transfer of this software does not imply any licenses
* of trade secrets, proprietary technology, copyrights, patents,
* trademarks, maskwork rights, or any other form of intellectual
* property whatsoever. Maxim Integrated Products, Inc. retains all
* ownership rights.
*******************************************************************************
*/
#ifndef _QUADSPIINTERFACE_H_
#define _QUADSPIINTERFACE_H_
#include "mbed.h"
#include "QuadSpi.h"
class QuadSpiInterface {
public:
/**
* @brief Constructor that accepts pin names for the QUAD SPI interface
* @param mosi master out slave in pin name
* @param miso master in slave out pin name
* @param sclk serial clock pin name
* @param cs chip select pin name
*/
QuadSpiInterface(PinName mosi, PinName miso, PinName sclk, PinName cs);
/**
* @brief Transmit and recieve QUAD SPI data
* @param tx_buf pointer to transmit byte buffer
* @param tx_size number of bytes to transmit
* @param rx_buf pointer to the recieve buffer
* @param rx_size number of bytes to recieve
* @param last flag to indicate if this is the last QUAD SPI transaction for
* the current chip select cycle
*/
int SPI_Transmit(const uint8_t *tx_buf, uint32_t tx_size, uint8_t *rx_buf,
uint32_t rx_size, int last = 1);
/**
* @brief Transmit and recieve Four Wrire SPI data
* @param tx_buf pointer to transmit byte buffer
* @param tx_size number of bytes to transmit
* @param rx_buf pointer to the recieve buffer
* @param rx_size number of bytes to recieve
* @param last flag to indicate if this is the last QUAD SPI transaction for
* the current chip select cycle
*/
int SPI_Transmit4Wire(const uint8_t *tx_buf, uint32_t tx_size,
uint8_t *rx_buf, uint32_t rx_size, int last = 1);
private:
// QUAD SPI object
QuadSPI spi;
// chip select object
DigitalOut csPin;
};
#endif // _QUADSPIINTERFACE_H_