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

HSP/QuadSPI/QuadSpi.h@0:832122ce6748, 2021-04-07 (annotated)

Committer:
darienf
Date:
Wed Apr 07 22:37:59 2021 +0000
Revision:
0:832122ce6748
painnie

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 _QUADSPI_H_
darienf 0:832122ce6748 34 #define _QUADSPI_H_
darienf 0:832122ce6748 35
darienf 0:832122ce6748 36 #include "mbed.h"
darienf 0:832122ce6748 37
darienf 0:832122ce6748 38
darienf 0:832122ce6748 39
darienf 0:832122ce6748 40
darienf 0:832122ce6748 41 /**
darienf 0:832122ce6748 42 * This class provides a Quad SPI interface for quad spi devices
darienf 0:832122ce6748 43 * the class also allows single (4-Wire) communication
darienf 0:832122ce6748 44 */
darienf 0:832122ce6748 45 class QuadSPI : SPI {
darienf 0:832122ce6748 46
darienf 0:832122ce6748 47 public:
darienf 0:832122ce6748 48 /** Create a QuadSPI master connected to the specified pins
darienf 0:832122ce6748 49 *
darienf 0:832122ce6748 50 * mosi or miso can be specfied as NC if not used
darienf 0:832122ce6748 51 *
darienf 0:832122ce6748 52 * @param mosi QuadSPI Master Out, Slave In pin
darienf 0:832122ce6748 53 * @param miso QuadSPI Master In, Slave Out pin
darienf 0:832122ce6748 54 * @param sclk QuadSPI Clock pin
darienf 0:832122ce6748 55 * @param ssel QuadSPI chip select pin
darienf 0:832122ce6748 56 */
darienf 0:832122ce6748 57 QuadSPI(PinName mosi, PinName miso, PinName sclk, PinName ssel = NC);
darienf 0:832122ce6748 58
darienf 0:832122ce6748 59 /** Write to the Quad SPI Slave and return the response
darienf 0:832122ce6748 60 *
darienf 0:832122ce6748 61 * @param value Data to be sent to the SPI slave
darienf 0:832122ce6748 62 *
darienf 0:832122ce6748 63 * @returns
darienf 0:832122ce6748 64 * none
darienf 0:832122ce6748 65 */
darienf 0:832122ce6748 66 virtual int write(int value);
darienf 0:832122ce6748 67
darienf 0:832122ce6748 68 /** Read from the Quad SPI Slave and return the response
darienf 0:832122ce6748 69 *
darienf 0:832122ce6748 70 * @param none
darienf 0:832122ce6748 71 *
darienf 0:832122ce6748 72 * @returns
darienf 0:832122ce6748 73 * Response from the SPI slave
darienf 0:832122ce6748 74 */
darienf 0:832122ce6748 75 int read(void);
darienf 0:832122ce6748 76
darienf 0:832122ce6748 77 /** Allow switching to and from Single SPI and Quad SPI
darienf 0:832122ce6748 78 *
darienf 0:832122ce6748 79 * @param none
darienf 0:832122ce6748 80 *
darienf 0:832122ce6748 81 * @returns
darienf 0:832122ce6748 82 * Response from the SPI slave
darienf 0:832122ce6748 83 */
darienf 0:832122ce6748 84 void setSingleMode();
darienf 0:832122ce6748 85 void setQuadMode();
darienf 0:832122ce6748 86 };
darienf 0:832122ce6748 87
darienf 0:832122ce6748 88 #endif /* _QUADSPI_H_ */