io_port.h

Go to the documentation of this file.

 
 
/******************************************************************************
The MIT License(MIT)
 
Embedded Template Library.
https://github.com/ETLCPP/etl
https://www.etlcpp.com
 
Copyright(c) 2014 John Wellbelove
 
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files(the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and / or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions :
 
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
******************************************************************************/
 
#ifndef ETL_IO_PORT_INCLUDED
#define ETL_IO_PORT_INCLUDED
 
 
#include "platform.h"
#include "nullptr.h"
#include "iterator.h"
 
#include <stdint.h>
 
namespace etl
{
  //***************************************************************************
  //***************************************************************************
  template <typename T, uintptr_t ADDRESS = 0>
  class io_port_rw : public etl::iterator<ETL_OR_STD::forward_iterator_tag, T>
  {
  public:
 
    typedef volatile T*       pointer;
    typedef volatile const T* const_pointer;
    typedef volatile T&       reference;
    typedef volatile const T& const_reference;
 
    operator T() const
    {
      return *reinterpret_cast<const_pointer>(ADDRESS);
    }
 
    T read() const
    {
      return *reinterpret_cast<const_pointer>(ADDRESS);
    }
 
    void write(T value_)
    {
      *reinterpret_cast<pointer>(ADDRESS) = value_;
    }
 
    io_port_rw& operator =(T value_)
    {
      *reinterpret_cast<pointer>(ADDRESS) = value_;
      return *this;
    }
 
    reference operator *()
    {
      return *reinterpret_cast<pointer>(ADDRESS);
    }
 
    const_reference operator *() const
    {
      return *reinterpret_cast<const_pointer>(ADDRESS);
    }
 
    io_port_rw& operator ++()
    {
      return *this;
    }
 
    io_port_rw operator ++(int)
    {
      return *this;
    }
 
    pointer get_address()
    {
      return reinterpret_cast<pointer>(ADDRESS);
    }
 
    const_pointer get_address() const
    {
      return reinterpret_cast<const_pointer>(ADDRESS);
    }
 
  private:
 
    io_port_rw& operator =(const io_port_rw&);
  };
 
  //***************************************************************************
  //***************************************************************************
  template <typename T, uintptr_t ADDRESS = 0>
  class io_port_ro : public etl::iterator<ETL_OR_STD::input_iterator_tag, T>
  {
  public:
 
    typedef volatile T*       pointer;
    typedef volatile const T* const_pointer;
    typedef volatile T&       reference;
    typedef volatile const T& const_reference;
 
    operator T() const
    {
      return *reinterpret_cast<const_pointer>(ADDRESS);
    }
 
    T read() const
    {
      return *reinterpret_cast<const_pointer>(ADDRESS);
    }
 
    const_reference operator *() const
    {
      return *reinterpret_cast<const_pointer>(ADDRESS);
    }
 
    io_port_ro& operator ++()
    {
      return *this;
    }
 
    io_port_ro operator ++(int)
    {
      return *this;
    }
 
    pointer get_address()
    {
      return reinterpret_cast<pointer>(ADDRESS);
    }
 
    const_pointer get_address() const
    {
      return reinterpret_cast<const_pointer>(ADDRESS);
    }
 
  private:
 
    void operator =(T value);
 
    io_port_ro& operator =(const io_port_ro&);
  };
 
  //***************************************************************************
  //***************************************************************************
  template <typename T, uintptr_t ADDRESS = 0>
  class io_port_wo : public etl::iterator<ETL_OR_STD::output_iterator_tag, T>
  {
  public:
 
    typedef volatile T*       pointer;
    typedef volatile const T* const_pointer;
    typedef volatile T&       reference;
    typedef volatile const T& const_reference;
 
    void operator =(T value)
    {
      *reinterpret_cast<pointer>(ADDRESS) = value;
    }
 
    void write(T value_)
    {
      *reinterpret_cast<pointer>(ADDRESS) = value_;
    }
 
    io_port_wo& operator *()
    {
      return *this;
    }
 
    io_port_wo& operator ++()
    {
      return *this;
    }
 
    io_port_wo operator ++(int)
    {
      return *this;
    }
 
    pointer get_address()
    {
      return reinterpret_cast<pointer>(ADDRESS);
    }
 
    const_pointer get_address() const
    {
      return reinterpret_cast<const_pointer>(ADDRESS);
    }
 
  private:
 
    operator T() const;
 
    io_port_wo& operator =(const io_port_wo&);
  };
 
  //***************************************************************************
  //***************************************************************************
  template <typename T, uintptr_t ADDRESS = 0>
  class io_port_wos : public etl::iterator<ETL_OR_STD::forward_iterator_tag, T>
  {
  public:
 
    typedef volatile T*       pointer;
    typedef volatile const T* const_pointer;
    typedef volatile T&       reference;
    typedef volatile const T& const_reference;
 
    io_port_wos()
      : shadow_value(T())
    {
    }
 
    operator T() const
    {
      return shadow_value;
    }
 
    T read() const
    {
      return shadow_value;
    }
 
    void write(T value_)
    {
      shadow_value = value_;
      *reinterpret_cast<pointer>(ADDRESS) = shadow_value;
    }
 
    io_port_wos& operator =(T value_)
    {
      shadow_value = value_;
      *reinterpret_cast<pointer>(ADDRESS) = shadow_value;
      return *this;
    }
 
    io_port_wos& operator *()
    {
      return *this;
    }
 
    const_reference operator *() const
    {
      return shadow_value;
    }
 
    io_port_wos& operator ++()
    {
      return *this;
    }
 
    io_port_wos operator ++(int)
    {
      return *this;
    }
 
    pointer get_address()
    {
      return reinterpret_cast<pointer>(ADDRESS);
    }
 
  private:
 
    io_port_wos& operator =(const io_port_wos&);
 
    T shadow_value;
  };
 
  //***************************************************************************
  //***************************************************************************
  template <typename T>
  class io_port_rw<T, 0> : public etl::iterator<ETL_OR_STD::forward_iterator_tag, T>
  {
  public:
 
    typedef volatile T*       pointer;
    typedef volatile const T* const_pointer;
    typedef volatile T&       reference;
    typedef volatile const T& const_reference;
 
    io_port_rw()
      : address(ETL_NULLPTR)
    {
    }
 
    io_port_rw(void* address_)
      : address(reinterpret_cast<pointer>(address_))
    {
    }
 
    io_port_rw(const io_port_rw& other_)
      : address(reinterpret_cast<pointer>(other_.address))
    {
    }
 
    io_port_rw& operator =(const io_port_rw& other_)
    {
      address = other_.address;
      return *this;
    }
 
    void set_address(void* address_)
    {
      address = reinterpret_cast<pointer>(address_);
    }
 
    pointer get_address()
    {
      return address;
    }
 
    const_pointer get_address() const
    {
      return address;
    }
 
    operator T() const
    {
      return *address;
    }
 
    T read() const
    {
      return *address;
    }
 
    void write(T value_)
    {
      *address = value_;
    }
 
    io_port_rw& operator =(T value_)
    {
      *address = value_;
      return *this;
    }
 
    reference operator *()
    {
      return *address;
    }
 
    const_reference operator *() const
    {
      return *address;
    }
 
    io_port_rw& operator ++()
    {
      return *this;
    }
 
    io_port_rw operator ++(int)
    {
      return *this;
    }
 
  private:
 
    pointer address;
  };
 
  //***************************************************************************
  //***************************************************************************
  template <typename T>
  class io_port_ro<T, 0> : public etl::iterator<ETL_OR_STD::input_iterator_tag, T>
  {
  public:
 
    typedef volatile T*       pointer;
    typedef volatile const T* const_pointer;
    typedef volatile T&       reference;
    typedef volatile const T& const_reference;
 
    io_port_ro()
      : address(ETL_NULLPTR)
    {
    }
 
    io_port_ro(void* address_)
      : address(reinterpret_cast<pointer>(address_))
    {
    }
 
    io_port_ro(const io_port_ro& other_)
      : address(reinterpret_cast<pointer>(other_.address))
    {
    }
 
    io_port_ro& operator =(const io_port_ro& other_)
    {
      address = other_.address;
      return *this;
    }
 
    void set_address(void* address_)
    {
      address = reinterpret_cast<pointer>(address_);
    }
 
    const_pointer get_address() const
    {
      return address;
    }
 
    operator T() const
    {
      return *address;
    }
 
    T read() const
    {
      return *address;
    }
 
    const_reference operator *() const
    {
      return *address;
    }
 
    io_port_ro& operator ++()
    {
      return *this;
    }
 
    io_port_ro operator ++(int)
    {
      return *this;
    }
 
  private:
 
    void operator =(T value);
 
    pointer address;
  };
 
  //***************************************************************************
  //***************************************************************************
  template <typename T>
  class io_port_wo<T, 0> : public etl::iterator<ETL_OR_STD::output_iterator_tag, T>
  {
  public:
 
    typedef volatile T*       pointer;
    typedef volatile const T* const_pointer;
    typedef volatile T&       reference;
    typedef volatile const T& const_reference;
 
    io_port_wo()
      : address(ETL_NULLPTR)
    {
    }
 
    io_port_wo(void* address_)
      : address(reinterpret_cast<pointer>(address_))
    {
    }
 
    io_port_wo(const io_port_wo& other_)
      : address(reinterpret_cast<pointer>(other_.address))
    {
    }
 
    io_port_wo& operator =(const io_port_wo& other_)
    {
      address = other_.address;
      return *this;
    }
 
    void set_address(void* address_)
    {
      address = reinterpret_cast<pointer>(address_);
    }
 
    pointer get_address()
    {
      return address;
    }
 
    const_pointer get_address() const
    {
      return address;
    }
 
    void write(T value_)
    {
      *address = value_;
    }
 
    void operator =(T value)
    {
      *address = value;
    }
 
    io_port_wo& operator *()
    {
      return *this;
    }
 
    io_port_wo& operator ++()
    {
      return *this;
    }
 
    io_port_wo operator ++(int)
    {
      return *this;
    }
 
  private:
 
    operator T() const;
 
    pointer address;
  };
 
  //***************************************************************************
  //***************************************************************************
  template <typename T>
  class io_port_wos<T, 0> : public etl::iterator<ETL_OR_STD::forward_iterator_tag, T>
  {
  public:
 
    typedef volatile T*       pointer;
    typedef volatile const T* const_pointer;
    typedef volatile T&       reference;
    typedef volatile const T& const_reference;
 
    class iterator : public etl::iterator<ETL_OR_STD::bidirectional_iterator_tag, T>
    {
      typedef io_port_wos<T, 0> iop_t;
 
    public:
 
      iterator(iop_t& iop)
        : p_iop(&iop)
      {
      }
 
      iterator(const iterator& other)
        : p_iop(other.p_iop)
      {
      }
 
      iterator& operator =(const iterator& other)
      {
        p_iop = other.p_iop;
        return *this;
      }
 
      iop_t& operator *()
      {
        return *p_iop;
      }
 
      const iop_t& operator *() const
      {
        return *p_iop;
      }
 
      iterator& operator ++()
      {
        return *this;
      }
 
      iterator operator ++(int)
      {
        return *this;
      }
 
      iterator& operator --()
      {
        return *this;
      }
 
      iterator operator --(int)
      {
        return *this;
      }
 
    private:
 
      iop_t* p_iop;
    };
 
    io_port_wos()
      : address(ETL_NULLPTR)
    {
    }
 
    io_port_wos(void* address_)
      : address(reinterpret_cast<pointer>(address_))
    {
    }
 
    io_port_wos(const io_port_wos& other_)
      : shadow_value(other_.shadow_value),
        address(reinterpret_cast<pointer>(other_.address))
    {
    }
 
    io_port_wos& operator =(const io_port_wos& other_)
    {
      shadow_value = other_.shadow_value;
      address      = other_.address;
      return *this;
    }
 
    void set_address(void* address_)
    {
      address = reinterpret_cast<pointer>(address_);
    }
 
    pointer get_address()
    {
      return address;
    }
 
    const_pointer get_address() const
    {
      return address;
    }
 
    iterator get_iterator()
    {
      return iterator(*this);
    }
 
    operator T() const
    {
      return shadow_value;
    }
 
    T read() const
    {
      return shadow_value;
    }
 
    void write(T value_)
    {
      shadow_value = value_;
      *address = shadow_value;
    }
 
    io_port_wos& operator =(T value_)
    {
      shadow_value = value_;
      *address     = shadow_value;
      return *this;
    }
 
    io_port_wos&  operator *()
    {
      return *this;
    }
 
    const_reference operator *() const
    {
      return shadow_value;
    }
 
    io_port_wos& operator ++()
    {
      return *this;
    }
 
    io_port_wos operator ++(int)
    {
      return *this;
    }
 
  private:
 
    T       shadow_value;
    pointer address;
  };
}
 
#endif