QuadSpi.cpp

00001 /*******************************************************************************
00002  * Copyright (C) 2016 Maxim Integrated Products, Inc., All Rights Reserved.
00003  *
00004  * Permission is hereby granted, free of charge, to any person obtaining a
00005  * copy of this software and associated documentation files (the "Software"),
00006  * to deal in the Software without restriction, including without limitation
00007  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
00008  * and/or sell copies of the Software, and to permit persons to whom the
00009  * Software is furnished to do so, subject to the following conditions:
00010  *
00011  * The above copyright notice and this permission notice shall be included
00012  * in all copies or substantial portions of the Software.
00013  *
00014  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
00015  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
00016  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
00017  * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
00018  * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
00019  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
00020  * OTHER DEALINGS IN THE SOFTWARE.
00021  *
00022  * Except as contained in this notice, the name of Maxim Integrated
00023  * Products, Inc. shall not be used except as stated in the Maxim Integrated
00024  * Products, Inc. Branding Policy.
00025  *
00026  * The mere transfer of this software does not imply any licenses
00027  * of trade secrets, proprietary technology, copyrights, patents,
00028  * trademarks, maskwork rights, or any other form of intellectual
00029  * property whatsoever. Maxim Integrated Products, Inc. retains all
00030  * ownership rights.
00031  *******************************************************************************
00032  */
00033 #include "QuadSpi.h"
00034 #include "spi_multi_api.h"
00035 
00036 /** Initialize a SPI master for Quad SPI
00037  *
00038  * @param mosi   Pin used for Master Out Slave In
00039  * @param miso   Pin used for Master In Slave Out
00040  * @param sclk   Pin used for Clock
00041  * @param ssel   Pin used for Chip Select
00042  */
00043 QuadSPI::QuadSPI(PinName mosi, PinName miso, PinName sclk, PinName ssel)
00044     : SPI(mosi, miso, sclk, ssel) {
00045 }
00046 
00047 /******************************************************************************/
00048 void QuadSPI::setQuadMode() { spi_master_width(&_spi, WidthQuad); }
00049 /******************************************************************************/
00050 void QuadSPI::setSingleMode() { spi_master_width(&_spi, WidthSingle); }
00051 
00052 /** Write a byte out in master mode and receive a value
00053  *
00054  * @param value   Byte Value to send
00055  * @return Returns Zero
00056  */
00057 int QuadSPI::write(int value) {
00058   aquire();
00059   spi_master_write(&_spi, value);
00060   return 0;
00061 }
00062 
00063 /** Read a byte in master mode using Quad SPI simplex transfer
00064  *
00065  * @return Returns the value received from Quad SPI
00066  */
00067 int QuadSPI::read(void) {
00068   aquire();
00069   return spi_master_read(&_spi);
00070 }