Maxim Integrated / MAX30001EVSYSKIT

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.

HSP/QuadSPI/QuadSpi.h@1:957e5bad16c2, 2018-06-27 (annotated)

Committer:
Emre.Eken
Date:
Wed Jun 27 14:17:34 2018 +0300
Revision:
1:957e5bad16c2
first rev

Who changed what in which revision?

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