modm API documentation
Public Typedefs | Public Types | Static Public Member Functions | Static Public Attributes | Static Protected Member Functions | Static Protected Attributes | List of all members
modm::platform::SoftwareGpioPort< Gpios > Class Template Reference
Platform HAL » General Purpose I/O (GPIO)

#include <modm/platform/gpio/software_port.hpp>

Inheritance diagram for modm::platform::SoftwareGpioPort< Gpios >:
modm::GpioPort modm::platform::GpioSet< Gpios... > modm::platform::Gpio

Public Typedefs

using PortType = std::conditional_t< (width > 8), uint16_t, uint8_t >
 
using PortType = uint16_t
 may also be uint8_t, depending on port width
 

Public Types

enum  DataOrder : bool { DataOrder::Normal = false, DataOrder::Reversed = true }
 This enum can be used to reverse the bit order of the Data. More...
 
enum  InputTrigger : uint8_t { InputTrigger::LowLevel = 0b00, InputTrigger::BothEdges = 0b01, InputTrigger::FallingEdge = 0b10, InputTrigger::RisingEdge = 0b11 }
 Each External Interrupt can be configured to trigger on these conditions. More...
 
enum  InputType : uint8_t { InputType::Floating, InputType::PullUp }
 Each Input Pin can be configured in one of these states. More...
 
enum  OutputType : uint8_t { OutputType::PushPull }
 
enum  Port {
  A, B, C, D,
  E, F, G
}
 Available ports on this device.
 
enum  Signal {
  BitBang, Ain0, Ain1, Clko0,
  Icp, In0, In1, In2,
  In3, In4, In5, In6,
  In7, Miso, Mosi, Oca,
  Ocb, Occ, Rxd, Sck,
  Scl, Sda, Ss, T,
  Tck, Tdi, Tdo, Tms,
  Tosc1, Tosc2, Txd, Xck
}
 

Static Public Member Functions

static PortType isSet ()
 
static void write (PortType data)
 
static PortType read ()
 
static constexpr DataOrder getDataOrder ()
 returns the chosen data order
 
static PortType read ()
 The read data is always right-aligned regardless of physical mapping.
 
static void setInput ()
 
static void setOutput ()
 
static void toggle ()
 Toggle the output states of all pins.
 
static void write (PortType data)
 The write data is always right-aligned regardless of physical mapping.
 
static void configure (OutputType)
 
static void configure (InputType type)
 
static void reset ()
 
static void set ()
 
static void set (bool status)
 
static void setInput ()
 
static void setInput (InputType type)
 
static void setOutput ()
 
static void setOutput (bool status)
 
static void setOutput (OutputType)
 
static void toggle ()
 

Static Public Attributes

static constexpr uint8_t number_of_ports
 
static constexpr uint8_t width
 
static constexpr uint8_t number_of_ports
 
static constexpr uint8_t width
 

Static Protected Member Functions

static constexpr int8_t shift_mask (uint8_t id, uint8_t pos)
 
static constexpr uint8_t inverted (uint8_t id)
 
static constexpr uint8_t mask (uint8_t id)
 
static constexpr uint8_t numberOfPorts ()
 

Static Protected Attributes

static constexpr int8_t shift_masks [7][width]
 
static constexpr uint8_t inverteds [7]
 
static constexpr uint8_t masks [7]
 

Detailed Description

template<class... Gpios>
class modm::platform::SoftwareGpioPort< Gpios >

Create an up to 16-bit port from arbitrary pins.

This class optimizes the data type for the read() and write() methods. Supplying up to 8 Gpios will use uint8_t, up to 16 Gpios uint16_t.

Note
Since the bit order is explicitly given by the order of template arguments, this class only supports DataOrder::Normal. If you need reverse bit order, reverse the order of Gpios!
Template Parameters
GpiosUp to 16 GpioIO classes, ordered MSB to LSB
Author
Niklas Hauser

Member Enumeration Documentation

enum modm::GpioPort::DataOrder : bool
inheritedstrong

This enum can be used to reverse the bit order of the Data.

Enum ValuesDocumentation
Normal 

bit order of data is the same as bit order of port

Reversed 

bit order of data is the reverse bit order of port

enum modm::platform::Gpio::InputTrigger : uint8_t
inheritedstrong

Each External Interrupt can be configured to trigger on these conditions.

Enum ValuesDocumentation
LowLevel 

triggers continuously during low level

BothEdges 

triggers on both rising and falling edge

FallingEdge 

triggers on falling edge

RisingEdge 

triggers on rising edge

enum modm::platform::Gpio::InputType : uint8_t
inheritedstrong

Each Input Pin can be configured in one of these states.

Enum ValuesDocumentation
Floating 

The input pin is left floating.

PullUp 

The input pin is pulled to Vcc.

enum modm::platform::Gpio::OutputType : uint8_t
inheritedstrong
Enum ValuesDocumentation
PushPull 

push-pull on output

Member Data Documentation

constexpr uint8_t modm::GpioPort::number_of_ports
inheritedstaticconstexpr

This holds the number of unique platform ports that this implementation accesses. It's always at least 1.

template<class... Gpios>
constexpr int8_t modm::platform::SoftwareGpioPort< Gpios >::shift_masks[7][width]
staticprotectedconstexpr
Initial value:
{
{(Gpios::port == Set::Port::A ? Gpios::pin : -1)...},
{(Gpios::port == Set::Port::B ? Gpios::pin : -1)...},
{(Gpios::port == Set::Port::C ? Gpios::pin : -1)...},
{(Gpios::port == Set::Port::D ? Gpios::pin : -1)...},
{(Gpios::port == Set::Port::E ? Gpios::pin : -1)...},
{(Gpios::port == Set::Port::F ? Gpios::pin : -1)...},
{(Gpios::port == Set::Port::G ? Gpios::pin : -1)...},
}
constexpr uint8_t modm::GpioPort::width
inheritedstaticconstexpr

This holds the width of the port as number of bits and can be used in drivers to assert the correct requirements

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