sta-core/include/sta/bus/spi/spi.hpp

/**
 * @file
 * @brief SPI bus software interface.
 */
#ifndef STA_CORE_SPI_SPI_HPP
#define STA_CORE_SPI_SPI_HPP

#include <sta/bus/interface.hpp>
#include <sta/bus/spi/settings.hpp>
#include <sta/mutex.hpp>

#include <cstddef>
#include <cstdint>


namespace sta
{
    /**
     * @brief Interface class for %SPI hardware.
     *
     * Represents a single %SPI bus that can be shared by multiple devices.
     *
     * @ingroup sta_core_spi
     */
    class SPI : public Interface
    {
    public:
        /**
         * @param settings  %SPI bus settings
         * @param mutex     Mutex object for managing shared access. Pass nullptr for no access control
         */
        SPI(const SPISettings & settings, Mutex * mutex = nullptr);

        /**
		 * @brief Send and receive data simultaneously.
		 *
		 * @param txBuffer  Send buffer
		 * @param rxBuffer  Receive buffer
		 * @param size      Number of bytes to transfer
		 */
		virtual bool transfer(const uint8_t * txBuffer, uint8_t * rxBuffer, size_t size, uint32_t timeout = STA_MAX_TIMEOUT) = 0;

        /**
         * @brief Get %SPI interface settings.
         *
         * @return %SPI settings
         */
        const SPISettings & settings();
    private:
        SPISettings settings_;  /**< %SPI settings */
    };
} // namespace sta


#endif // STA_CORE_SPI_SPI_HPP