Darien Figueroa / Mbed 2 deprecated repo3

repo time

Dependencies:   mbed MAX14720 MAX30205 USBDevice

e4a10ed6eb92/HSP/QuadSPI/QuadSpi.h@20:6d2af70c92ab, 2021-04-06 (annotated)

Committer:
darienf
Date:
Tue Apr 06 06:41:40 2021 +0000
Revision:
20:6d2af70c92ab
another repo

Who changed what in which revision?

UserRevisionLine numberNew contents of line
darienf 20:6d2af70c92ab 1 /*******************************************************************************
darienf 20:6d2af70c92ab 2 * Copyright (C) 2016 Maxim Integrated Products, Inc., All Rights Reserved.
darienf 20:6d2af70c92ab 3 *
darienf 20:6d2af70c92ab 4 * Permission is hereby granted, free of charge, to any person obtaining a
darienf 20:6d2af70c92ab 5 * copy of this software and associated documentation files (the "Software"),
darienf 20:6d2af70c92ab 6 * to deal in the Software without restriction, including without limitation
darienf 20:6d2af70c92ab 7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
darienf 20:6d2af70c92ab 8 * and/or sell copies of the Software, and to permit persons to whom the
darienf 20:6d2af70c92ab 9 * Software is furnished to do so, subject to the following conditions:
darienf 20:6d2af70c92ab 10 *
darienf 20:6d2af70c92ab 11 * The above copyright notice and this permission notice shall be included
darienf 20:6d2af70c92ab 12 * in all copies or substantial portions of the Software.
darienf 20:6d2af70c92ab 13 *
darienf 20:6d2af70c92ab 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
darienf 20:6d2af70c92ab 15 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
darienf 20:6d2af70c92ab 16 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
darienf 20:6d2af70c92ab 17 * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
darienf 20:6d2af70c92ab 18 * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
darienf 20:6d2af70c92ab 19 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
darienf 20:6d2af70c92ab 20 * OTHER DEALINGS IN THE SOFTWARE.
darienf 20:6d2af70c92ab 21 *
darienf 20:6d2af70c92ab 22 * Except as contained in this notice, the name of Maxim Integrated
darienf 20:6d2af70c92ab 23 * Products, Inc. shall not be used except as stated in the Maxim Integrated
darienf 20:6d2af70c92ab 24 * Products, Inc. Branding Policy.
darienf 20:6d2af70c92ab 25 *
darienf 20:6d2af70c92ab 26 * The mere transfer of this software does not imply any licenses
darienf 20:6d2af70c92ab 27 * of trade secrets, proprietary technology, copyrights, patents,
darienf 20:6d2af70c92ab 28 * trademarks, maskwork rights, or any other form of intellectual
darienf 20:6d2af70c92ab 29 * property whatsoever. Maxim Integrated Products, Inc. retains all
darienf 20:6d2af70c92ab 30 * ownership rights.
darienf 20:6d2af70c92ab 31 *******************************************************************************
darienf 20:6d2af70c92ab 32 */
darienf 20:6d2af70c92ab 33 #ifndef _QUADSPI_H_
darienf 20:6d2af70c92ab 34 #define _QUADSPI_H_
darienf 20:6d2af70c92ab 35
darienf 20:6d2af70c92ab 36 #include "mbed.h"
darienf 20:6d2af70c92ab 37
darienf 20:6d2af70c92ab 38
darienf 20:6d2af70c92ab 39
darienf 20:6d2af70c92ab 40
darienf 20:6d2af70c92ab 41 /**
darienf 20:6d2af70c92ab 42 * This class provides a Quad SPI interface for quad spi devices
darienf 20:6d2af70c92ab 43 * the class also allows single (4-Wire) communication
darienf 20:6d2af70c92ab 44 */
darienf 20:6d2af70c92ab 45 class QuadSPI : SPI {
darienf 20:6d2af70c92ab 46
darienf 20:6d2af70c92ab 47 public:
darienf 20:6d2af70c92ab 48 /** Create a QuadSPI master connected to the specified pins
darienf 20:6d2af70c92ab 49 *
darienf 20:6d2af70c92ab 50 * mosi or miso can be specfied as NC if not used
darienf 20:6d2af70c92ab 51 *
darienf 20:6d2af70c92ab 52 * @param mosi QuadSPI Master Out, Slave In pin
darienf 20:6d2af70c92ab 53 * @param miso QuadSPI Master In, Slave Out pin
darienf 20:6d2af70c92ab 54 * @param sclk QuadSPI Clock pin
darienf 20:6d2af70c92ab 55 * @param ssel QuadSPI chip select pin
darienf 20:6d2af70c92ab 56 */
darienf 20:6d2af70c92ab 57 QuadSPI(PinName mosi, PinName miso, PinName sclk, PinName ssel = NC);
darienf 20:6d2af70c92ab 58
darienf 20:6d2af70c92ab 59 /** Write to the Quad SPI Slave and return the response
darienf 20:6d2af70c92ab 60 *
darienf 20:6d2af70c92ab 61 * @param value Data to be sent to the SPI slave
darienf 20:6d2af70c92ab 62 *
darienf 20:6d2af70c92ab 63 * @returns
darienf 20:6d2af70c92ab 64 * none
darienf 20:6d2af70c92ab 65 */
darienf 20:6d2af70c92ab 66 int write(int value);
darienf 20:6d2af70c92ab 67
darienf 20:6d2af70c92ab 68 /** Read from the Quad SPI Slave and return the response
darienf 20:6d2af70c92ab 69 *
darienf 20:6d2af70c92ab 70 * @param none
darienf 20:6d2af70c92ab 71 *
darienf 20:6d2af70c92ab 72 * @returns
darienf 20:6d2af70c92ab 73 * Response from the SPI slave
darienf 20:6d2af70c92ab 74 */
darienf 20:6d2af70c92ab 75 int read(void);
darienf 20:6d2af70c92ab 76
darienf 20:6d2af70c92ab 77 /** Allow switching to and from Single SPI and Quad SPI
darienf 20:6d2af70c92ab 78 *
darienf 20:6d2af70c92ab 79 * @param none
darienf 20:6d2af70c92ab 80 *
darienf 20:6d2af70c92ab 81 * @returns
darienf 20:6d2af70c92ab 82 * Response from the SPI slave
darienf 20:6d2af70c92ab 83 */
darienf 20:6d2af70c92ab 84 void setSingleMode();
darienf 20:6d2af70c92ab 85 void setQuadMode();
darienf 20:6d2af70c92ab 86 };
darienf 20:6d2af70c92ab 87
darienf 20:6d2af70c92ab 88 #endif /* _QUADSPI_H_ */