modm API documentation
Public Typedefs | Public Types | Static Public Member Functions | List of all members
modm::platform::BitBangSpiMaster< Sck, Mosi, Miso > Class Template Reference
Platform HAL » Software Serial Peripheral Interface (SPI)

#include <modm/platform/spi/bitbang_spi_master.hpp>

Inheritance diagram for modm::platform::BitBangSpiMaster< Sck, Mosi, Miso >:
modm::SpiMaster modm::PeripheralDriver modm::Spi

Public Typedefs

using ConfigurationHandler = void (*)()
 The signature of the configuration function.
 

Public Types

enum  DataMode : uint8_t { DataMode::Mode0 = 0b00, DataMode::Mode1 = 0b01, DataMode::Mode2 = 0b10, DataMode::Mode3 = 0b11 }
 Spi Data Mode, Mode0 is the most common mode. More...
 
enum  DataOrder : uint8_t { MsbFirst = 0b0, LsbFirst = 0b1 }
 Spi Data Order, MsbFirst is the most common mode.
 

Static Public Member Functions

template<class... Signals>
static void connect ()
 
template<class SystemClock , baudrate_t baudrate, percent_t tolerance = pct(5)>
static void initialize ()
 Baudrate is limited to 500kbps.
 
static void setDataMode (DataMode mode)
 
static void setDataOrder (DataOrder order)
 
static uint8_t acquire (void *ctx, ConfigurationHandler handler=nullptr)
 
static uint8_t release (void *ctx)
 
static uint8_t transferBlocking (uint8_t data)
 
static void transferBlocking (const uint8_t *tx, uint8_t *rx, std::size_t length)
 
static modm::ResumableResult< uint8_t > transfer (uint8_t data)
 
static modm::ResumableResult< void > transfer (const uint8_t *tx, uint8_t *rx, std::size_t length)
 
static void acknowledgeInterruptFlag ()
 
template<baudrate_t available, baudrate_t requested, percent_t tolerance>
static void assertBaudrateInTolerance ()
 
static void configurePurpose ()
 configures a peripheral for a specific purpose
 
static bool getInterruptFlag ()
 Read an interrupt flag.
 
static void getParameter ()
 returns a parameter
 
static void initialize ()
 initializes the peripheral, must be called before use.
 
static void setParameter ()
 sets a parameter
 

Detailed Description

template<typename Sck, typename Mosi, typename Miso = GpioUnused>
class modm::platform::BitBangSpiMaster< Sck, Mosi, Miso >

Software emulation of a Simple Spi.

Template Parameters
Sckclock pin [output]
Mosimaster out slave in pin [output]
Misomaster in slave out pin [input]
Author
Niklas Hauser
See also
gpio

Member Enumeration Documentation

enum modm::Spi::DataMode : uint8_t
inheritedstrong

Spi Data Mode, Mode0 is the most common mode.

Enum ValuesDocumentation
Mode0 

clock normal, sample on rising edge

Mode1 

clock normal, sample on falling edge

Mode2 

clock inverted, sample on falling edge

Mode3 

clock inverted, sample on rising edge

Member Function Documentation

static void modm::PeripheralDriver::acknowledgeInterruptFlag ( )
inheritedstatic

Acknowledge an interrupt flag.

We use acknowledge here, since it describes the intention rather than the actual implementation.

template<baudrate_t available, baudrate_t requested, percent_t tolerance>
static void modm::PeripheralDriver::assertBaudrateInTolerance ( )
inheritedinlinestatic

Since baudrates are usually generated by prescaling a system clock, only several distinct values can be generated. This method checks if the user requested baudrate is within error tolerance of the system achievable baudrate.

The documentation for this class was generated from the following file: