Darien Figueroa / Mbed OS Final_Program

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.

Dependencies:   USBDevice

MAXREFDES100FW300/e4a10ed6eb92/HSP/Interfaces/QuadSpiInterface.h@3:36de8b9e4b1a, 2021-04-10 (annotated)

Committer:
darienf
Date:
Sat Apr 10 03:05:42 2021 +0000
Revision:
3:36de8b9e4b1a
Parent:
HSP/Interfaces/QuadSpiInterface.h@0:832122ce6748 
ayoooo

Who changed what in which revision?

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