mbed-os/targets/TARGET_Maxim/TARGET_MAX32620/spi_multi_api.h

68 lines
2.4 KiB
C

/*******************************************************************************
* Copyright (C) 2016 Maxim Integrated Products, Inc., All Rights Reserved.
*
* Permission is hereby granted, free of charge, to any person obtaining a
* copy of this software and associated documentation files (the "Software"),
* to deal in the Software without restriction, including without limitation
* the rights to use, copy, modify, merge, publish, distribute, sublicense,
* and/or sell copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included
* in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
* OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
* IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
* OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
* ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
* OTHER DEALINGS IN THE SOFTWARE.
*
* Except as contained in this notice, the name of Maxim Integrated
* Products, Inc. shall not be used except as stated in the Maxim Integrated
* Products, Inc. Branding Policy.
*
* The mere transfer of this software does not imply any licenses
* of trade secrets, proprietary technology, copyrights, patents,
* trademarks, maskwork rights, or any other form of intellectual
* property whatsoever. Maxim Integrated Products, Inc. retains all
* ownership rights.
*******************************************************************************
*/
#ifndef MBED_SPI_MULTI_H
#define MBED_SPI_MULTI_H
#include "spi_api.h"
typedef enum {
WidthSingle = 0,
WidthDual = 1,
WidthQuad = 2,
} SpiWidth;
#ifdef __cplusplus
extern "C" {
#endif
/** Read a byte in master mode, this is use for Dual or Quad SPI when a simplex transfer is needed
*
* @param[in] obj The SPI peripheral to use for sending
* @return Returns the value received
*/
int spi_master_read(spi_t *obj);
/** Specify I/O width of SPI transaction
*
* @param[in] obj The SPI peripheral to use for sending
* @param[in] width The I/O width of SPI transaction
*/
void spi_master_width(spi_t *obj, SpiWidth width);
#ifdef __cplusplus
}
#endif // __cplusplus
#endif // MBED_SPI_MULTI_H