Rewrote interface to make sure port and pin lookup are done at compile time

This commit is contained in:
BlackMark 2018-04-26 15:23:42 +02:00
parent 093c0a6a02
commit a69465fca0

335
inout.h
View File

@ -1,7 +1,7 @@
/* /*
* Copyright (c) by BlackMark 2015-2018 * Copyright (c) by BlackMark 2015-2018
* Date 24/04/2018 * Date 26/04/2018
* Version 2.8 * Version 3.0
*/ */
#ifndef INOUT_H #ifndef INOUT_H
@ -12,7 +12,11 @@
#include <avr/io.h> #include <avr/io.h>
/************************************************************************/
////////////////////////////////////////////////////////////////////////// //////////////////////////////////////////////////////////////////////////
namespace InOut
{
#define AVR_DIP40 defined (__AVR_ATmega32A__) || defined (__AVR_ATmega644P__) || defined (__AVR_ATmega1284P__) #define AVR_DIP40 defined (__AVR_ATmega32A__) || defined (__AVR_ATmega644P__) || defined (__AVR_ATmega1284P__)
#define AVR_DIP28 defined (__AVR_ATmega8__) || defined (__AVR_ATmega8A__) || defined (__AVR_ATmega168A__) || defined (__AVR_ATmega328P__) #define AVR_DIP28 defined (__AVR_ATmega8__) || defined (__AVR_ATmega8A__) || defined (__AVR_ATmega168A__) || defined (__AVR_ATmega328P__)
#define AVR_DIP8 defined (__AVR_ATtiny13A__) || defined (__AVR_ATtiny85__) #define AVR_DIP8 defined (__AVR_ATtiny13A__) || defined (__AVR_ATtiny85__)
@ -57,11 +61,6 @@ static constexpr volatile uint8_t *IO_DDRD = nullptr;
static constexpr volatile uint8_t *IO_PORTD = nullptr; static constexpr volatile uint8_t *IO_PORTD = nullptr;
#endif #endif
/************************************************************************/
//////////////////////////////////////////////////////////////////////////
struct InOut
{
enum class Pin enum class Pin
{ {
#if AVR_DIP40 #if AVR_DIP40
@ -130,35 +129,12 @@ struct InOut
enum class Type enum class Type
{ {
PIN,
DDR, DDR,
PIN,
PORT PORT
}; };
static constexpr volatile uint8_t* getPort( Pin enmPin, Type enmType ); constexpr volatile uint8_t* getPort( Pin enmPin, Type enmType )
static constexpr uint8_t getPin( Pin enmPin );
static inline void setPinDirection( volatile uint8_t *vpui8Port, uint8_t ui8Pin, Dir enmDir );
static inline bool readPin( volatile uint8_t *vpui8Port, uint8_t ui8Pin );
static inline void writePin( volatile uint8_t *vpui8Port, uint8_t ui8Pin, bool bValue );
static inline void setPortDirection( volatile uint8_t *vpui8Port, Dir enmDir );
static inline uint8_t readPort( volatile uint8_t *vpui8Port );
static inline void writePort( volatile uint8_t *vpui8Port, uint8_t ui8Value );
static inline void setPinDirection( Pin enmPin, Dir enmDir );
static inline void setPinPullup( Pin enmPin, bool bPullup );
static inline bool readPin( Pin enmPin );
static inline void writePin( Pin enmPin, bool bValue );
static inline void setPortDirection( Port enmPort, Dir enmDir );
static inline void setPortPullup( Port enmPort, bool bPullup );
static inline uint8_t readPort( Port enmPort );
static inline void writePort( Port enmPort, uint8_t ui8Value );
};
//////////////////////////////////////////////////////////////////////////
constexpr volatile uint8_t* InOut::getPort( Pin enmPin, Type enmType )
{ {
volatile uint8_t *vpui8Port = nullptr; volatile uint8_t *vpui8Port = nullptr;
uint8_t ui8Port = static_cast<uint16_t>( enmPin ) >> 4 & 0x0F; uint8_t ui8Port = static_cast<uint16_t>( enmPin ) >> 4 & 0x0F;
@ -167,10 +143,10 @@ constexpr volatile uint8_t* InOut::getPort( Pin enmPin, Type enmType )
{ {
case 0: case 0:
{ {
if( enmType == Type::PIN ) if( enmType == Type::DDR )
vpui8Port = IO_PINA;
else if( enmType == Type::DDR )
vpui8Port = IO_DDRA; vpui8Port = IO_DDRA;
else if( enmType == Type::PIN )
vpui8Port = IO_PINA;
else if( enmType == Type::PORT ) else if( enmType == Type::PORT )
vpui8Port = IO_PORTA; vpui8Port = IO_PORTA;
break; break;
@ -178,10 +154,10 @@ constexpr volatile uint8_t* InOut::getPort( Pin enmPin, Type enmType )
case 1: case 1:
{ {
if( enmType == Type::PIN ) if( enmType == Type::DDR )
vpui8Port = IO_PINB;
else if( enmType == Type::DDR )
vpui8Port = IO_DDRB; vpui8Port = IO_DDRB;
else if( enmType == Type::PIN )
vpui8Port = IO_PINB;
else if( enmType == Type::PORT ) else if( enmType == Type::PORT )
vpui8Port = IO_PORTB; vpui8Port = IO_PORTB;
break; break;
@ -189,10 +165,10 @@ constexpr volatile uint8_t* InOut::getPort( Pin enmPin, Type enmType )
case 2: case 2:
{ {
if( enmType == Type::PIN ) if( enmType == Type::DDR )
vpui8Port = IO_PINC;
else if( enmType == Type::DDR )
vpui8Port = IO_DDRC; vpui8Port = IO_DDRC;
else if( enmType == Type::PIN )
vpui8Port = IO_PINC;
else if( enmType == Type::PORT ) else if( enmType == Type::PORT )
vpui8Port = IO_PORTC; vpui8Port = IO_PORTC;
break; break;
@ -200,10 +176,10 @@ constexpr volatile uint8_t* InOut::getPort( Pin enmPin, Type enmType )
case 3: case 3:
{ {
if( enmType == Type::PIN ) if( enmType == Type::DDR )
vpui8Port = IO_PIND;
else if( enmType == Type::DDR )
vpui8Port = IO_DDRD; vpui8Port = IO_DDRD;
else if( enmType == Type::PIN )
vpui8Port = IO_PIND;
else if( enmType == Type::PORT ) else if( enmType == Type::PORT )
vpui8Port = IO_PORTD; vpui8Port = IO_PORTD;
break; break;
@ -213,252 +189,129 @@ constexpr volatile uint8_t* InOut::getPort( Pin enmPin, Type enmType )
return vpui8Port; return vpui8Port;
} }
////////////////////////////////////////////////////////////////////////// constexpr uint8_t getPin( Pin enmPin )
constexpr uint8_t InOut::getPin( Pin enmPin )
{ {
return static_cast<uint16_t>( enmPin ) & 0x0F; return static_cast<uint16_t>( enmPin ) & 0x0F;
} }
}
/************************************************************************/
////////////////////////////////////////////////////////////////////////// //////////////////////////////////////////////////////////////////////////
inline void InOut::setPinDirection( volatile uint8_t *vpui8Port, uint8_t ui8Pin, Dir enmDir ) template<InOut::Pin enmPin>
class InOutPin
{ {
if( enmDir == Dir::OUT ) public:
*vpui8Port |= ( 1 << ui8Pin ); inline InOutPin() __attribute__( (always_inline) );
static inline void setDirection( InOut::Dir enmDir ) __attribute__( (always_inline) );
static inline void setPullup( bool bPullup ) __attribute__( (always_inline) );
static inline bool read() __attribute__( (always_inline) );
static inline void write( bool bValue ) __attribute__( (always_inline) );
};
//////////////////////////////////////////////////////////////////////////
template<InOut::Pin enmPin>
inline InOutPin<enmPin>::InOutPin()
{}
//////////////////////////////////////////////////////////////////////////
template<InOut::Pin enmPin>
inline void InOutPin<enmPin>::setDirection( InOut::Dir enmDir )
{
constexpr volatile uint8_t *vpui8DDR = InOut::getPort( enmPin, InOut::Type::DDR );
constexpr uint8_t ui8Pin = InOut::getPin( enmPin );
if( enmDir == InOut::Dir::OUT )
*vpui8DDR |= ( 1 << ui8Pin );
else else
*vpui8Port &= ~( 1 << ui8Pin ); *vpui8DDR &= ~( 1 << ui8Pin );
} }
////////////////////////////////////////////////////////////////////////// //////////////////////////////////////////////////////////////////////////
inline bool InOut::readPin( volatile uint8_t *vpui8Port, uint8_t ui8Pin ) template<InOut::Pin enmPin>
inline void InOutPin<enmPin>::setPullup( bool bPullup )
{ {
if( *vpui8Port >> ui8Pin & 1 ) write( bPullup );
}
//////////////////////////////////////////////////////////////////////////
template<InOut::Pin enmPin>
inline bool InOutPin<enmPin>::read()
{
constexpr volatile uint8_t *vpui8PIN = InOut::getPort( enmPin, InOut::Type::PIN );
constexpr uint8_t ui8Pin = InOut::getPin( enmPin );
if( *vpui8PIN >> ui8Pin & 1 )
return true; return true;
return false; return false;
} }
////////////////////////////////////////////////////////////////////////// //////////////////////////////////////////////////////////////////////////
inline void InOut::writePin( volatile uint8_t *vpui8Port, uint8_t ui8Pin, bool bValue ) template<InOut::Pin enmPin>
inline void InOutPin<enmPin>::write( bool bValue )
{ {
constexpr volatile uint8_t *vpui8PORT = InOut::getPort( enmPin, InOut::Type::PORT );
constexpr uint8_t ui8Pin = InOut::getPin( enmPin );
if( bValue ) if( bValue )
*vpui8Port |= ( 1 << ui8Pin ); *vpui8PORT |= ( 1 << ui8Pin );
else else
*vpui8Port &= ~( 1 << ui8Pin ); *vpui8PORT &= ~( 1 << ui8Pin );
}
//////////////////////////////////////////////////////////////////////////
inline void InOut::setPortDirection( volatile uint8_t *vpui8Port, Dir enmDir )
{
*vpui8Port = ( enmDir == Dir::OUT ) ? 0xFF : 0x00;
}
//////////////////////////////////////////////////////////////////////////
inline uint8_t InOut::readPort( volatile uint8_t *vpui8Port )
{
return *vpui8Port;
}
//////////////////////////////////////////////////////////////////////////
inline void InOut::writePort( volatile uint8_t *vpui8Port, uint8_t ui8Value )
{
*vpui8Port = ui8Value;
}
//////////////////////////////////////////////////////////////////////////
inline void InOut::setPinDirection( Pin enmPin, Dir enmDir )
{
volatile uint8_t *vpui8PortDir = getPort( enmPin, Type::DDR );
uint8_t ui8Pin = getPin( enmPin );
setPinDirection( vpui8PortDir, ui8Pin, enmDir );
}
//////////////////////////////////////////////////////////////////////////
inline void InOut::setPinPullup( Pin enmPin, bool bPullup )
{
volatile uint8_t *vpui8PortOut = getPort( enmPin, Type::PORT );
uint8_t ui8Pin = getPin( enmPin );
writePin( vpui8PortOut, ui8Pin, bPullup );
}
//////////////////////////////////////////////////////////////////////////
inline bool InOut::readPin( Pin enmPin )
{
volatile uint8_t *vpui8Port = getPort( enmPin, Type::PIN );
uint8_t ui8Pin = getPin( enmPin );
return readPin( vpui8Port, ui8Pin );
}
//////////////////////////////////////////////////////////////////////////
inline void InOut::writePin( Pin enmPin, bool bValue )
{
volatile uint8_t *vpui8Port = getPort( enmPin, Type::PORT );
uint8_t ui8Pin = getPin( enmPin );
writePin( vpui8Port, ui8Pin, bValue );
}
//////////////////////////////////////////////////////////////////////////
inline void InOut::setPortDirection( Port enmPort, Dir enmDir )
{
volatile uint8_t *vpui8PortDir = getPort( static_cast<Pin>( enmPort ), Type::DDR );
setPortDirection( vpui8PortDir, enmDir );
}
//////////////////////////////////////////////////////////////////////////
inline void InOut::setPortPullup( Port enmPort, bool bPullup )
{
volatile uint8_t *vpui8PortOut = getPort( static_cast<Pin>( enmPort ), Type::PORT );
writePort( vpui8PortOut, bPullup ? 0xFF : 0x00 );
}
//////////////////////////////////////////////////////////////////////////
inline uint8_t InOut::readPort( Port enmPort )
{
volatile uint8_t *vpui8Port = getPort( static_cast<Pin>( enmPort ), Type::PIN );
return readPort( vpui8Port );
}
//////////////////////////////////////////////////////////////////////////
inline void InOut::writePort( Port enmPort, uint8_t ui8Value )
{
volatile uint8_t *vpui8Port = getPort( static_cast<Pin>( enmPort ), Type::PORT );
writePort( vpui8Port, ui8Value );
}
/************************************************************************/
//////////////////////////////////////////////////////////////////////////
class InOutPin
{
private:
volatile uint8_t *m_pvui8PIN;
volatile uint8_t *m_pvui8DDR;
volatile uint8_t *m_pvui8PORT;
uint8_t m_ui8Pin;
public:
inline InOutPin();
inline InOutPin( InOut::Pin enmPin );
inline void setPin( InOut::Pin enmPin );
inline void setDirection( InOut::Dir enmDir );
inline void setPullup( bool bPullup );
inline bool read();
inline void write( bool bValue );
};
//////////////////////////////////////////////////////////////////////////
inline InOutPin::InOutPin() :
m_pvui8PIN( nullptr ), m_pvui8DDR( nullptr ), m_pvui8PORT( nullptr ), m_ui8Pin( 0xFF )
{}
//////////////////////////////////////////////////////////////////////////
inline InOutPin::InOutPin( InOut::Pin enmPin ) :
m_pvui8PIN( InOut::getPort( enmPin, InOut::Type::PIN ) ),
m_pvui8DDR( InOut::getPort( enmPin, InOut::Type::DDR ) ),
m_pvui8PORT( InOut::getPort( enmPin, InOut::Type::PORT ) ),
m_ui8Pin( InOut::getPin( enmPin ) )
{}
//////////////////////////////////////////////////////////////////////////
inline void InOutPin::setPin( InOut::Pin enmPin )
{
m_pvui8PIN = InOut::getPort( enmPin, InOut::Type::PIN );
m_pvui8DDR = InOut::getPort( enmPin, InOut::Type::DDR );
m_pvui8PORT = InOut::getPort( enmPin, InOut::Type::PORT );
m_ui8Pin = InOut::getPin( enmPin );
}
//////////////////////////////////////////////////////////////////////////
inline void InOutPin::setDirection( InOut::Dir enmDir )
{
InOut::setPinDirection( m_pvui8DDR, m_ui8Pin, enmDir );
}
//////////////////////////////////////////////////////////////////////////
inline void InOutPin::setPullup( bool bPullup )
{
InOut::writePin( m_pvui8PORT, m_ui8Pin, bPullup );
}
//////////////////////////////////////////////////////////////////////////
inline bool InOutPin::read()
{
return InOut::readPin( m_pvui8PIN, m_ui8Pin );
}
//////////////////////////////////////////////////////////////////////////
inline void InOutPin::write( bool bValue )
{
InOut::writePin( m_pvui8PORT, m_ui8Pin, bValue );
} }
/************************************************************************/ /************************************************************************/
////////////////////////////////////////////////////////////////////////// //////////////////////////////////////////////////////////////////////////
template<InOut::Port enmPort>
class InOutPort class InOutPort
{ {
private:
volatile uint8_t *m_pvui8PIN;
volatile uint8_t *m_pvui8DDR;
volatile uint8_t *m_pvui8PORT;
public: public:
inline InOutPort(); inline InOutPort() __attribute__( (always_inline) );
inline InOutPort( InOut::Port enmPort );
inline void setPort( InOut::Port enmPort ); static inline void setDirection( InOut::Dir enmDir ) __attribute__( (always_inline) );
static inline void setPullup( bool bPullup ) __attribute__( (always_inline) );
inline void setDirection( InOut::Dir enmDir ); static inline uint8_t read() __attribute__( (always_inline) );
inline void setPullup( bool bPullup ); static inline void write( uint8_t ui8Value ) __attribute__( (always_inline) );
inline uint8_t read();
inline void write( uint8_t ui8Value );
}; };
////////////////////////////////////////////////////////////////////////// //////////////////////////////////////////////////////////////////////////
inline InOutPort::InOutPort() : template<InOut::Port enmPort>
m_pvui8PIN( nullptr ), m_pvui8DDR( nullptr ), m_pvui8PORT( nullptr ) inline InOutPort<enmPort>::InOutPort()
{} {}
////////////////////////////////////////////////////////////////////////// //////////////////////////////////////////////////////////////////////////
inline InOutPort::InOutPort( InOut::Port enmPort ) : template<InOut::Port enmPort>
m_pvui8PIN( InOut::getPort( static_cast<InOut::Pin>( enmPort ), InOut::Type::PIN ) ), inline void InOutPort<enmPort>::setDirection( InOut::Dir enmDir )
m_pvui8DDR( InOut::getPort( static_cast<InOut::Pin>( enmPort ), InOut::Type::DDR ) ),
m_pvui8PORT( InOut::getPort( static_cast<InOut::Pin>( enmPort ), InOut::Type::PORT ) )
{}
//////////////////////////////////////////////////////////////////////////
inline void InOutPort::setPort( InOut::Port enmPort )
{ {
m_pvui8PIN = InOut::getPort( static_cast<InOut::Pin>( enmPort ), InOut::Type::PIN ); constexpr volatile uint8_t *vpui8DDR = InOut::getPort( static_cast<InOut::Pin>( enmPort ), InOut::Type::DDR );
m_pvui8DDR = InOut::getPort( static_cast<InOut::Pin>( enmPort ), InOut::Type::DDR ); *vpui8DDR = ( enmDir == InOut::Dir::OUT ) ? 0xFF : 0x00;
m_pvui8PORT = InOut::getPort( static_cast<InOut::Pin>( enmPort ), InOut::Type::PORT );
} }
////////////////////////////////////////////////////////////////////////// //////////////////////////////////////////////////////////////////////////
inline void InOutPort::setDirection( InOut::Dir enmDir ) template<InOut::Port enmPort>
inline void InOutPort<enmPort>::setPullup( bool bPullup )
{ {
InOut::setPortDirection( m_pvui8DDR, enmDir ); write( bPullup ? 0xFF : 0x00 );
} }
////////////////////////////////////////////////////////////////////////// //////////////////////////////////////////////////////////////////////////
inline void InOutPort::setPullup( bool bPullup ) template<InOut::Port enmPort>
inline uint8_t InOutPort<enmPort>::read()
{ {
InOut::writePort( m_pvui8PORT, bPullup ? 0xFF : 0x00 ); constexpr volatile uint8_t *vpui8PIN = InOut::getPort( static_cast<InOut::Pin>( enmPort ), InOut::Type::PIN );
return *vpui8PIN;
} }
////////////////////////////////////////////////////////////////////////// //////////////////////////////////////////////////////////////////////////
inline uint8_t InOutPort::read() template<InOut::Port enmPort>
inline void InOutPort<enmPort>::write( uint8_t ui8Value )
{ {
return InOut::readPort( m_pvui8PIN ); constexpr volatile uint8_t *vpui8PORT = InOut::getPort( static_cast<InOut::Pin>( enmPort ), InOut::Type::PORT );
} *vpui8PORT = ui8Value;
//////////////////////////////////////////////////////////////////////////
inline void InOutPort::write( uint8_t ui8Value )
{
InOut::writePort( m_pvui8PORT, ui8Value );
} }
#endif #endif