/*
    Copyright (C) 2020 Yaotian Feng


    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
    You may obtain a copy of the License at

        http://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing, software
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
    limitations under the License.
*/

/**
 * @file    hal_spi_lld.h
 * @brief   ES32 SPI subsystem low level driver header.
 *
 * @addtogroup SPI
 * @{
 */
#ifndef HAL_SPI_LLD_H
#define HAL_SPI_LLD_H

#if HAL_USE_SPI || defined(__DOXYGEN__)

/*===========================================================================*/
/* Driver constants.                                                         */
/*===========================================================================*/

/*===========================================================================*/
/* Driver pre-compile time settings.                                         */
/*===========================================================================*/

/**
 * @name    ES32 configuration options
 * @{
 */
/**
 * @brief   SPI1 driver enable switch.
 * @details If set to @p TRUE the support for SPI0 is included.
 * @note    The default is @p FALSE.
 */
#if !defined(STM32_SPI_USE_SPI1) || defined(__DOXYGEN__)
#define STM32_SPI_USE_SPI1                  FALSE
#endif

/**
 * @brief   SPI2 driver enable switch.
 * @details If set to @p TRUE the support for SPI2 is included.
 * @note    The default is @p FALSE.
 */
#if !defined(STM32_SPI_USE_SPI2) || defined(__DOXYGEN__)
#define STM32_SPI_USE_SPI2                  FALSE
#endif
/** @} */

/*===========================================================================*/
/* Derived constants and error checks.                                       */
/*===========================================================================*/

/*===========================================================================*/
/* Driver data structures and types.                                         */
/*===========================================================================*/


/**
 * @brief Low Level fields of the SPI driver structure.
 */
#define spi_lld_driver_fields                                                  \
    SPI_TypeDef               *SPI;                                              \
    uint8_t                   *rxptr;                                            \
    const uint8_t             *txptr;                                            \
    size_t                    rxcnt;                                             \
    size_t                    txcnt;                                             \

    /**
     * @brief Low Level fields of the SPI configuration structure.
     */
#define spi_lld_config_fields                                                  \
    uint32_t                  cr0;                                             \
    uint32_t                  cr1;                                             \
    uint32_t                  cpr;                                             \
    uint32_t                  fcr;

    /*===========================================================================*/
    /* Driver macros.                                                            */
    /*===========================================================================*/

    /*===========================================================================*/
    /* External declarations.                                                    */
    /*===========================================================================*/

#if STM32_SPI_USE_SPI1 && !defined(__DOXYGEN__)
extern SPIDriver SPID1;
#endif

#if STM32_SPI_USE_SPI2 && !defined(__DOXYGEN__)
extern SPIDriver SPID2;
#endif

#ifdef __cplusplus
    extern "C" {
#endif
    void spi_lld_init(void);
    void spi_lld_start(SPIDriver *spip);
    void spi_lld_stop(SPIDriver *spip);
    void spi_lld_select(SPIDriver *spip);
    void spi_lld_unselect(SPIDriver *spip);
    void spi_lld_ignore(SPIDriver *spip, size_t n);
    void spi_lld_exchange(SPIDriver *spip, size_t n,
                          const void *txbuf, void *rxbuf);
    void spi_lld_send(SPIDriver *spip, size_t n, const void *txbuf);
    void spi_lld_receive(SPIDriver *spip, size_t n, void *rxbuf);
    uint16_t spi_lld_polled_exchange(SPIDriver *spip, uint16_t frame);
#ifdef __cplusplus
    }
#endif

#endif /* HAL_USE_SPI == TRUE */

#endif /* HAL_SPI_LLD_H */

/** @} */