Jerry Bradshaw / Mbed OS HSP_Release

This is a mbed 5.2 Release

Dependencies:   USBDevice

Fork of mbed-os-test by Jerry Bradshaw

HSP/Interfaces/QuadSpiInterface.h@0:e4a10ed6eb92, 2016-10-25 (annotated)

Committer:
jbradshaw
Date:
Tue Oct 25 15:22:11 2016 +0000
Revision:
0:e4a10ed6eb92
tewt

Who changed what in which revision?

UserRevisionLine numberNew contents of line
jbradshaw 0:e4a10ed6eb92 1 /*******************************************************************************
jbradshaw 0:e4a10ed6eb92 2 * Copyright (C) 2016 Maxim Integrated Products, Inc., All Rights Reserved.
jbradshaw 0:e4a10ed6eb92 3 *
jbradshaw 0:e4a10ed6eb92 4 * Permission is hereby granted, free of charge, to any person obtaining a
jbradshaw 0:e4a10ed6eb92 5 * copy of this software and associated documentation files (the "Software"),
jbradshaw 0:e4a10ed6eb92 6 * to deal in the Software without restriction, including without limitation
jbradshaw 0:e4a10ed6eb92 7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
jbradshaw 0:e4a10ed6eb92 8 * and/or sell copies of the Software, and to permit persons to whom the
jbradshaw 0:e4a10ed6eb92 9 * Software is furnished to do so, subject to the following conditions:
jbradshaw 0:e4a10ed6eb92 10 *
jbradshaw 0:e4a10ed6eb92 11 * The above copyright notice and this permission notice shall be included
jbradshaw 0:e4a10ed6eb92 12 * in all copies or substantial portions of the Software.
jbradshaw 0:e4a10ed6eb92 13 *
jbradshaw 0:e4a10ed6eb92 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
jbradshaw 0:e4a10ed6eb92 15 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
jbradshaw 0:e4a10ed6eb92 16 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
jbradshaw 0:e4a10ed6eb92 17 * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
jbradshaw 0:e4a10ed6eb92 18 * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
jbradshaw 0:e4a10ed6eb92 19 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
jbradshaw 0:e4a10ed6eb92 20 * OTHER DEALINGS IN THE SOFTWARE.
jbradshaw 0:e4a10ed6eb92 21 *
jbradshaw 0:e4a10ed6eb92 22 * Except as contained in this notice, the name of Maxim Integrated
jbradshaw 0:e4a10ed6eb92 23 * Products, Inc. shall not be used except as stated in the Maxim Integrated
jbradshaw 0:e4a10ed6eb92 24 * Products, Inc. Branding Policy.
jbradshaw 0:e4a10ed6eb92 25 *
jbradshaw 0:e4a10ed6eb92 26 * The mere transfer of this software does not imply any licenses
jbradshaw 0:e4a10ed6eb92 27 * of trade secrets, proprietary technology, copyrights, patents,
jbradshaw 0:e4a10ed6eb92 28 * trademarks, maskwork rights, or any other form of intellectual
jbradshaw 0:e4a10ed6eb92 29 * property whatsoever. Maxim Integrated Products, Inc. retains all
jbradshaw 0:e4a10ed6eb92 30 * ownership rights.
jbradshaw 0:e4a10ed6eb92 31 *******************************************************************************
jbradshaw 0:e4a10ed6eb92 32 */
jbradshaw 0:e4a10ed6eb92 33 #ifndef _QUADSPIINTERFACE_H_
jbradshaw 0:e4a10ed6eb92 34 #define _QUADSPIINTERFACE_H_
jbradshaw 0:e4a10ed6eb92 35
jbradshaw 0:e4a10ed6eb92 36 #include "mbed.h"
jbradshaw 0:e4a10ed6eb92 37 #include "QuadSpi.h"
jbradshaw 0:e4a10ed6eb92 38
jbradshaw 0:e4a10ed6eb92 39 class QuadSpiInterface {
jbradshaw 0:e4a10ed6eb92 40 public:
jbradshaw 0:e4a10ed6eb92 41 /**
jbradshaw 0:e4a10ed6eb92 42 * @brief Constructor that accepts pin names for the QUAD SPI interface
jbradshaw 0:e4a10ed6eb92 43 * @param mosi master out slave in pin name
jbradshaw 0:e4a10ed6eb92 44 * @param miso master in slave out pin name
jbradshaw 0:e4a10ed6eb92 45 * @param sclk serial clock pin name
jbradshaw 0:e4a10ed6eb92 46 * @param cs chip select pin name
jbradshaw 0:e4a10ed6eb92 47 */
jbradshaw 0:e4a10ed6eb92 48 QuadSpiInterface(PinName mosi, PinName miso, PinName sclk, PinName cs);
jbradshaw 0:e4a10ed6eb92 49 /**
jbradshaw 0:e4a10ed6eb92 50 * @brief Transmit and recieve QUAD SPI data
jbradshaw 0:e4a10ed6eb92 51 * @param tx_buf pointer to transmit byte buffer
jbradshaw 0:e4a10ed6eb92 52 * @param tx_size number of bytes to transmit
jbradshaw 0:e4a10ed6eb92 53 * @param rx_buf pointer to the recieve buffer
jbradshaw 0:e4a10ed6eb92 54 * @param rx_size number of bytes to recieve
jbradshaw 0:e4a10ed6eb92 55 * @param last flag to indicate if this is the last QUAD SPI transaction for
jbradshaw 0:e4a10ed6eb92 56 * the current chip select cycle
jbradshaw 0:e4a10ed6eb92 57 */
jbradshaw 0:e4a10ed6eb92 58 int SPI_Transmit(const uint8_t *tx_buf, uint32_t tx_size, uint8_t *rx_buf,
jbradshaw 0:e4a10ed6eb92 59 uint32_t rx_size, int last = 1);
jbradshaw 0:e4a10ed6eb92 60
jbradshaw 0:e4a10ed6eb92 61 /**
jbradshaw 0:e4a10ed6eb92 62 * @brief Transmit and recieve Four Wrire SPI data
jbradshaw 0:e4a10ed6eb92 63 * @param tx_buf pointer to transmit byte buffer
jbradshaw 0:e4a10ed6eb92 64 * @param tx_size number of bytes to transmit
jbradshaw 0:e4a10ed6eb92 65 * @param rx_buf pointer to the recieve buffer
jbradshaw 0:e4a10ed6eb92 66 * @param rx_size number of bytes to recieve
jbradshaw 0:e4a10ed6eb92 67 * @param last flag to indicate if this is the last QUAD SPI transaction for
jbradshaw 0:e4a10ed6eb92 68 * the current chip select cycle
jbradshaw 0:e4a10ed6eb92 69 */
jbradshaw 0:e4a10ed6eb92 70 int SPI_Transmit4Wire(const uint8_t *tx_buf, uint32_t tx_size,
jbradshaw 0:e4a10ed6eb92 71 uint8_t *rx_buf, uint32_t rx_size, int last = 1);
jbradshaw 0:e4a10ed6eb92 72
jbradshaw 0:e4a10ed6eb92 73 private:
jbradshaw 0:e4a10ed6eb92 74 // QUAD SPI object
jbradshaw 0:e4a10ed6eb92 75 QuadSPI spi;
jbradshaw 0:e4a10ed6eb92 76 // chip select object
jbradshaw 0:e4a10ed6eb92 77 DigitalOut csPin;
jbradshaw 0:e4a10ed6eb92 78 };
jbradshaw 0:e4a10ed6eb92 79
jbradshaw 0:e4a10ed6eb92 80 #endif // _QUADSPIINTERFACE_H_