You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
167 lines
5.8 KiB
C
167 lines
5.8 KiB
C
4 years ago
|
/**
|
||
|
|
* \file
|
||
|
|
*
|
||
|
|
* \brief SPI related functionality declaration.
|
||
|
|
*
|
||
|
|
* Copyright (c) 2015-2018 Microchip Technology Inc. and its subsidiaries.
|
||
|
|
*
|
||
|
|
* \asf_license_start
|
||
|
|
*
|
||
|
|
* \page License
|
||
|
|
*
|
||
|
|
* Subject to your compliance with these terms, you may use Microchip
|
||
|
|
* software and any derivatives exclusively with Microchip products.
|
||
|
|
* It is your responsibility to comply with third party license terms applicable
|
||
|
|
* to your use of third party software (including open source software) that
|
||
|
|
* may accompany Microchip software.
|
||
|
|
*
|
||
|
|
* THIS SOFTWARE IS SUPPLIED BY MICROCHIP "AS IS". NO WARRANTIES,
|
||
|
|
* WHETHER EXPRESS, IMPLIED OR STATUTORY, APPLY TO THIS SOFTWARE,
|
||
|
|
* INCLUDING ANY IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY,
|
||
|
|
* AND FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT WILL MICROCHIP BE
|
||
|
|
* LIABLE FOR ANY INDIRECT, SPECIAL, PUNITIVE, INCIDENTAL OR CONSEQUENTIAL
|
||
|
|
* LOSS, DAMAGE, COST OR EXPENSE OF ANY KIND WHATSOEVER RELATED TO THE
|
||
|
|
* SOFTWARE, HOWEVER CAUSED, EVEN IF MICROCHIP HAS BEEN ADVISED OF THE
|
||
|
|
* POSSIBILITY OR THE DAMAGES ARE FORESEEABLE. TO THE FULLEST EXTENT
|
||
|
|
* ALLOWED BY LAW, MICROCHIP'S TOTAL LIABILITY ON ALL CLAIMS IN ANY WAY
|
||
|
|
* RELATED TO THIS SOFTWARE WILL NOT EXCEED THE AMOUNT OF FEES, IF ANY,
|
||
|
|
* THAT YOU HAVE PAID DIRECTLY TO MICROCHIP FOR THIS SOFTWARE.
|
||
|
|
*
|
||
|
|
* \asf_license_stop
|
||
|
|
*
|
||
|
|
*/
|
||
|
|
|
||
|
|
#ifndef _HPL_SPI_M_SYNC_H_INCLUDED
|
||
|
|
#define _HPL_SPI_M_SYNC_H_INCLUDED
|
||
|
|
|
||
|
|
#include <hpl_spi.h>
|
||
|
|
#include <hpl_spi_sync.h>
|
||
|
|
|
||
|
|
/**
|
||
|
|
* \addtogroup hpl_spi HPL SPI
|
||
|
|
*
|
||
|
|
*@{
|
||
|
|
*/
|
||
|
|
|
||
|
|
#ifdef __cplusplus
|
||
|
|
extern "C" {
|
||
|
|
#endif
|
||
|
|
|
||
|
|
/** Uses common SPI sync device driver. */
|
||
|
|
#define _spi_m_sync_dev _spi_sync_dev
|
||
|
|
|
||
|
|
/**
|
||
|
|
* \name HPL functions
|
||
|
|
*/
|
||
|
|
//@{
|
||
|
|
/**
|
||
|
|
* \brief Initialize SPI for access without interrupts
|
||
|
|
* It will load default hardware configuration and software struct.
|
||
|
|
* \param[in, out] dev Pointer to the SPI device instance.
|
||
|
|
* \param[in] hw Pointer to the hardware base.
|
||
|
|
* \return Operation status.
|
||
|
|
* \retval ERR_INVALID_ARG Input parameter problem.
|
||
|
|
* \retval ERR_BUSY SPI hardware not ready (resetting).
|
||
|
|
* \retval ERR_DENIED SPI has been enabled.
|
||
|
|
* \retval 0 Operation done successfully.
|
||
|
|
*/
|
||
|
|
int32_t _spi_m_sync_init(struct _spi_m_sync_dev *dev, void *const hw);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* \brief Deinitialize SPI
|
||
|
|
* Disable, reset the hardware and the software struct.
|
||
|
|
* \param[in, out] dev Pointer to the SPI device instance.
|
||
|
|
* \return Operation status.
|
||
|
|
* \retval 0 Operation done successfully.
|
||
|
|
*/
|
||
|
|
int32_t _spi_m_sync_deinit(struct _spi_m_sync_dev *dev);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* \brief Enable SPI for access without interrupts
|
||
|
|
* \param[in, out] dev Pointer to the SPI device instance.
|
||
|
|
* \return Operation status.
|
||
|
|
* \retval ERR_BUSY SPI hardware not ready (resetting).
|
||
|
|
* \retval 0 Operation done successfully.
|
||
|
|
*/
|
||
|
|
int32_t _spi_m_sync_enable(struct _spi_m_sync_dev *dev);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* \brief Disable SPI for access without interrupts
|
||
|
|
* Disable SPI. Deactivate all CS pins if works as master.
|
||
|
|
* \param[in, out] dev Pointer to the SPI device instance.
|
||
|
|
* \return Operation status.
|
||
|
|
* \retval 0 Operation done successfully.
|
||
|
|
*/
|
||
|
|
int32_t _spi_m_sync_disable(struct _spi_m_sync_dev *dev);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* \brief Set SPI transfer mode
|
||
|
|
* Set SPI transfer mode (\ref spi_transfer_mode),
|
||
|
|
* which controls clock polarity and clock phase.
|
||
|
|
* Mode 0: leading edge is rising edge, data sample on leading edge.
|
||
|
|
* Mode 1: leading edge is rising edge, data sample on trailing edge.
|
||
|
|
* Mode 2: leading edge is falling edge, data sample on leading edge.
|
||
|
|
* Mode 3: leading edge is falling edge, data sample on trailing edge.
|
||
|
|
* \param[in, out] dev Pointer to the SPI device instance.
|
||
|
|
* \param[in] mode The SPI transfer mode.
|
||
|
|
* \return Operation status.
|
||
|
|
* \retval ERR_BUSY SPI is not ready to accept new setting.
|
||
|
|
* \retval 0 Operation done successfully.
|
||
|
|
*/
|
||
|
|
int32_t _spi_m_sync_set_mode(struct _spi_m_sync_dev *dev, const enum spi_transfer_mode mode);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* \brief Set SPI baudrate
|
||
|
|
* \param[in, out] dev Pointer to the SPI device instance.
|
||
|
|
* \param[in] baud_val The SPI baudrate value, see \ref _spi_calc_baud_val() on
|
||
|
|
* how it's generated.
|
||
|
|
* \return Operation status.
|
||
|
|
* \retval ERR_BUSY SPI is not ready to accept new setting.
|
||
|
|
* \retval 0 Operation done successfully.
|
||
|
|
*/
|
||
|
|
int32_t _spi_m_sync_set_baudrate(struct _spi_m_sync_dev *dev, const uint32_t baud_val);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* \brief Set SPI char size
|
||
|
|
* \param[in, out] dev Pointer to the SPI device instance.
|
||
|
|
* \param[in] char_size The character size, see \ref spi_char_size.
|
||
|
|
* \return Operation status.
|
||
|
|
* \retval ERR_INVALID_ARG The character size is not supported.
|
||
|
|
* \retval ERR_BUSY SPI is not ready to accept new setting.
|
||
|
|
* \retval 0 Operation done successfully.
|
||
|
|
*/
|
||
|
|
int32_t _spi_m_sync_set_char_size(struct _spi_m_sync_dev *dev, const enum spi_char_size char_size);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* \brief Set SPI data order
|
||
|
|
* \param[in, out] dev Pointer to the SPI device instance.
|
||
|
|
* \param[in] dord SPI data order (LSB/MSB first).
|
||
|
|
* \return Operation status.
|
||
|
|
* \retval ERR_INVALID_ARG The character size is not supported.
|
||
|
|
* \retval ERR_BUSY SPI is not ready to accept new setting.
|
||
|
|
* \retval 0 Operation done successfully.
|
||
|
|
*/
|
||
|
|
int32_t _spi_m_sync_set_data_order(struct _spi_m_sync_dev *dev, const enum spi_data_order dord);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* \brief Transfer the whole message without interrupt
|
||
|
|
* Transfer the message, it will keep waiting until the message finish or
|
||
|
|
* error.
|
||
|
|
* \param[in, out] dev Pointer to the SPI device instance.
|
||
|
|
* \param[in] msg Pointer to the message instance to process.
|
||
|
|
* \return Error or number of characters transferred.
|
||
|
|
* \retval ERR_BUSY SPI hardware is not ready to start transfer (not
|
||
|
|
* enabled, busy applying settings, ...).
|
||
|
|
* \retval SPI_ERR_OVERFLOW Overflow error.
|
||
|
|
* \retval >=0 Number of characters transferred.
|
||
|
|
*/
|
||
|
|
int32_t _spi_m_sync_trans(struct _spi_m_sync_dev *dev, const struct spi_msg *msg);
|
||
|
|
//@}
|
||
|
|
|
||
|
|
#ifdef __cplusplus
|
||
|
|
}
|
||
|
|
#endif
|
||
|
|
|
||
|
|
/**@}*/
|
||
|
|
#endif /* ifndef _HPL_SPI_M_SYNC_H_INCLUDED */
|