ddd

Dependencies:   USBDevice

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