QuadSpiInterface.h

00001 /*******************************************************************************
00002  * Copyright (C) 2016 Maxim Integrated Products, Inc., All Rights Reserved.
00003  *
00004  * Permission is hereby granted, free of charge, to any person obtaining a
00005  * copy of this software and associated documentation files (the "Software"),
00006  * to deal in the Software without restriction, including without limitation
00007  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
00008  * and/or sell copies of the Software, and to permit persons to whom the
00009  * Software is furnished to do so, subject to the following conditions:
00010  *
00011  * The above copyright notice and this permission notice shall be included
00012  * in all copies or substantial portions of the Software.
00013  *
00014  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
00015  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
00016  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
00017  * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
00018  * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
00019  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
00020  * OTHER DEALINGS IN THE SOFTWARE.
00021  *
00022  * Except as contained in this notice, the name of Maxim Integrated
00023  * Products, Inc. shall not be used except as stated in the Maxim Integrated
00024  * Products, Inc. Branding Policy.
00025  *
00026  * The mere transfer of this software does not imply any licenses
00027  * of trade secrets, proprietary technology, copyrights, patents,
00028  * trademarks, maskwork rights, or any other form of intellectual
00029  * property whatsoever. Maxim Integrated Products, Inc. retains all
00030  * ownership rights.
00031  *******************************************************************************
00032  */
00033 #ifndef _QUADSPIINTERFACE_H_
00034 #define _QUADSPIINTERFACE_H_
00035 
00036 #include "mbed.h"
00037 #include "QuadSpi.h"
00038 
00039 class QuadSpiInterface {
00040 public:
00041   /**
00042   * @brief Constructor that accepts pin names for the QUAD SPI interface
00043   * @param mosi master out slave in pin name
00044   * @param miso master in slave out pin name
00045   * @param sclk serial clock pin name
00046   * @param cs chip select pin name
00047   */
00048   QuadSpiInterface(PinName mosi, PinName miso, PinName sclk, PinName cs);
00049   /**
00050   * @brief Transmit and recieve QUAD SPI data
00051   * @param tx_buf pointer to transmit byte buffer
00052   * @param tx_size number of bytes to transmit
00053   * @param rx_buf pointer to the recieve buffer
00054   * @param rx_size number of bytes to recieve
00055   * @param last flag to indicate if this is the last QUAD SPI transaction for
00056   * the current chip select cycle
00057   */
00058   int SPI_Transmit(const uint8_t *tx_buf, uint32_t tx_size, uint8_t *rx_buf,
00059                    uint32_t rx_size, int last = 1);
00060 
00061   /**
00062   * @brief Transmit and recieve Four Wrire SPI data
00063   * @param tx_buf pointer to transmit byte buffer
00064   * @param tx_size number of bytes to transmit
00065   * @param rx_buf pointer to the recieve buffer
00066   * @param rx_size number of bytes to recieve
00067   * @param last flag to indicate if this is the last QUAD SPI transaction for
00068   * the current chip select cycle
00069   */
00070   int SPI_Transmit4Wire(const uint8_t *tx_buf, uint32_t tx_size,
00071                         uint8_t *rx_buf, uint32_t rx_size, int last = 1);
00072 
00073 private:
00074   // QUAD SPI object
00075   QuadSPI spi;
00076   // chip select object
00077   DigitalOut csPin;
00078 };
00079 
00080 #endif // _QUADSPIINTERFACE_H_