Speeduino
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Public Attributes | Static Public Attributes | List of all members
port_pin_t Struct Reference

A structure to support direct port manipulation. More...

#include <port_pin.h>

Public Types

using port_register_t = decltype(type_detection_detail::return_type_of(&type_detection_detail::detectPortRegisterType))
 The return type of a "call" to portOutputRegister()
 
using pin_mask_t = decltype(type_detection_detail::return_type_of(&type_detection_detail::detectDigitalPinToBitMask))
 The return type of a "call" to digitalPinToBitMask()
 

Public Member Functions

bool isValid (void) const
 Is the port register initialised?
 

Public Attributes

port_register_t port = NULL_PORT
 
pin_mask_t mask = {0}
 

Static Public Attributes

static constexpr port_register_t NULL_PORT = {nullptr}
 

Detailed Description

A structure to support direct port manipulation.

See also
https://docs.arduino.cc/retired/hacking/software/PortManipulation/

Member Typedef Documentation

◆ pin_mask_t

using port_pin_t::pin_mask_t = decltype(type_detection_detail::return_type_of(&type_detection_detail::detectDigitalPinToBitMask))

The return type of a "call" to digitalPinToBitMask()

◆ port_register_t

using port_pin_t::port_register_t = decltype(type_detection_detail::return_type_of(&type_detection_detail::detectPortRegisterType))

The return type of a "call" to portOutputRegister()

Member Function Documentation

◆ isValid()

bool port_pin_t::isValid ( void  ) const
inline

Is the port register initialised?

Here is the caller graph for this function:

Member Data Documentation

◆ mask

pin_mask_t port_pin_t::mask = {0}

◆ NULL_PORT

constexpr port_register_t port_pin_t::NULL_PORT = {nullptr}
staticconstexpr

◆ port

port_register_t port_pin_t::port = NULL_PORT

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