gem5  [DEVELOP-FOR-23.0]
•All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Classes | Public Types | Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
gem5::RegisterBank< BankByteOrder > Class Template Reference

#include <reg_bank.hh>

Inheritance diagram for gem5::RegisterBank< BankByteOrder >:
gem5::RegisterBankBase gem5::Uart8250::Registers

Classes

class  Register
 
class  RegisterAdder
 
class  RegisterBase
 
class  RegisterBuf
 
class  RegisterLBuf
 
class  RegisterRao
 
class  RegisterRaz
 
class  RegisterRoFill
 

Public Types

using Register8 = Register< uint8_t >
 
using Register8LE = Register< uint8_t, ByteOrder::little >
 
using Register8BE = Register< uint8_t, ByteOrder::big >
 
using Register16 = Register< uint16_t >
 
using Register16LE = Register< uint16_t, ByteOrder::little >
 
using Register16BE = Register< uint16_t, ByteOrder::big >
 
using Register32 = Register< uint32_t >
 
using Register32LE = Register< uint32_t, ByteOrder::little >
 
using Register32BE = Register< uint32_t, ByteOrder::big >
 
using Register64 = Register< uint64_t >
 
using Register64LE = Register< uint64_t, ByteOrder::little >
 
using Register64BE = Register< uint64_t, ByteOrder::big >
 

Public Member Functions

constexpr RegisterBank (const std::string &new_name, Addr new_base)
 
virtual ~RegisterBank ()
 
void addRegisters (std::initializer_list< RegisterAdder > adders)
 
void addRegister (RegisterAdder reg)
 
Addr base () const
 
Addr size () const
 
const std::string & name () const
 
virtual void read (Addr addr, void *buf, Addr bytes)
 
virtual void write (Addr addr, const void *buf, Addr bytes)
 
virtual void reset ()
 

Static Public Member Functions

template<typename Data >
static constexpr Data readWithMask (const Data &value, const Data &bitmask)
 
template<typename Data >
static constexpr Data writeWithMask (const Data &old, const Data &value, const Data &bitmask)
 

Private Attributes

std::map< Addr, std::reference_wrapper< RegisterBase > > _offsetMap
 
Addr _base = 0
 
Addr _size = 0
 
const std::string _name
 

Detailed Description

template<ByteOrder BankByteOrder>
class gem5::RegisterBank< BankByteOrder >

Definition at line 332 of file reg_bank.hh.

Member Typedef Documentation

◆ Register16

template<ByteOrder BankByteOrder>
using gem5::RegisterBank< BankByteOrder >::Register16 = Register<uint16_t>

Definition at line 876 of file reg_bank.hh.

◆ Register16BE

template<ByteOrder BankByteOrder>
using gem5::RegisterBank< BankByteOrder >::Register16BE = Register<uint16_t, ByteOrder::big>

Definition at line 878 of file reg_bank.hh.

◆ Register16LE

template<ByteOrder BankByteOrder>
using gem5::RegisterBank< BankByteOrder >::Register16LE = Register<uint16_t, ByteOrder::little>

Definition at line 877 of file reg_bank.hh.

◆ Register32

template<ByteOrder BankByteOrder>
using gem5::RegisterBank< BankByteOrder >::Register32 = Register<uint32_t>

Definition at line 879 of file reg_bank.hh.

◆ Register32BE

template<ByteOrder BankByteOrder>
using gem5::RegisterBank< BankByteOrder >::Register32BE = Register<uint32_t, ByteOrder::big>

Definition at line 881 of file reg_bank.hh.

◆ Register32LE

template<ByteOrder BankByteOrder>
using gem5::RegisterBank< BankByteOrder >::Register32LE = Register<uint32_t, ByteOrder::little>

Definition at line 880 of file reg_bank.hh.

◆ Register64

template<ByteOrder BankByteOrder>
using gem5::RegisterBank< BankByteOrder >::Register64 = Register<uint64_t>

Definition at line 882 of file reg_bank.hh.

◆ Register64BE

template<ByteOrder BankByteOrder>
using gem5::RegisterBank< BankByteOrder >::Register64BE = Register<uint64_t, ByteOrder::big>

Definition at line 884 of file reg_bank.hh.

◆ Register64LE

template<ByteOrder BankByteOrder>
using gem5::RegisterBank< BankByteOrder >::Register64LE = Register<uint64_t, ByteOrder::little>

Definition at line 883 of file reg_bank.hh.

◆ Register8

template<ByteOrder BankByteOrder>
using gem5::RegisterBank< BankByteOrder >::Register8 = Register<uint8_t>

Definition at line 873 of file reg_bank.hh.

◆ Register8BE

template<ByteOrder BankByteOrder>
using gem5::RegisterBank< BankByteOrder >::Register8BE = Register<uint8_t, ByteOrder::big>

Definition at line 875 of file reg_bank.hh.

◆ Register8LE

template<ByteOrder BankByteOrder>
using gem5::RegisterBank< BankByteOrder >::Register8LE = Register<uint8_t, ByteOrder::little>

Definition at line 874 of file reg_bank.hh.

Constructor & Destructor Documentation

◆ RegisterBank()

template<ByteOrder BankByteOrder>
constexpr gem5::RegisterBank< BankByteOrder >::RegisterBank ( const std::string &  new_name,
Addr  new_base 
)
inlineconstexpr

Definition at line 887 of file reg_bank.hh.

◆ ~RegisterBank()

template<ByteOrder BankByteOrder>
virtual gem5::RegisterBank< BankByteOrder >::~RegisterBank ( )
inlinevirtual

Definition at line 891 of file reg_bank.hh.

Member Function Documentation

◆ addRegister()

template<ByteOrder BankByteOrder>
void gem5::RegisterBank< BankByteOrder >::addRegister ( RegisterAdder  reg)
inline

Definition at line 938 of file reg_bank.hh.

Referenced by TEST_F().

◆ addRegisters()

template<ByteOrder BankByteOrder>
void gem5::RegisterBank< BankByteOrder >::addRegisters ( std::initializer_list< RegisterAdder >  adders)
inline

Definition at line 913 of file reg_bank.hh.

Referenced by gem5::RegisterBank< ByteOrder::little >::addRegister(), gem5::Uart8250::Registers::Registers(), gem5::SysSecCtrl::SysSecCtrl(), and TEST_F().

◆ base()

template<ByteOrder BankByteOrder>
Addr gem5::RegisterBank< BankByteOrder >::base ( ) const
inline

Definition at line 940 of file reg_bank.hh.

Referenced by gem5::RegisterBank< ByteOrder::little >::read(), TEST_F(), and gem5::RegisterBank< ByteOrder::little >::write().

◆ name()

template<ByteOrder BankByteOrder>
const std::string& gem5::RegisterBank< BankByteOrder >::name ( ) const
inline

Definition at line 942 of file reg_bank.hh.

Referenced by gem5::RegisterBank< ByteOrder::little >::addRegisters(), gem5::RegisterBank< ByteOrder::little >::read(), TEST_F(), and gem5::RegisterBank< ByteOrder::little >::write().

◆ read()

template<ByteOrder BankByteOrder>
virtual void gem5::RegisterBank< BankByteOrder >::read ( Addr  addr,
void *  buf,
Addr  bytes 
)
inlinevirtual

Definition at line 945 of file reg_bank.hh.

Referenced by gem5::SysSecCtrl::read(), gem5::X86ISA::I8237::read(), gem5::Clint::read(), gem5::Plic::read(), and gem5::Uart8250::read().

◆ readWithMask()

template<ByteOrder BankByteOrder>
template<typename Data >
static constexpr Data gem5::RegisterBank< BankByteOrder >::readWithMask ( const Data &  value,
const Data &  bitmask 
)
inlinestaticconstexpr

Definition at line 338 of file reg_bank.hh.

Referenced by gem5::RegisterBank< ByteOrder::little >::writeWithMask().

◆ reset()

template<ByteOrder BankByteOrder>
virtual void gem5::RegisterBank< BankByteOrder >::reset ( )
inlinevirtual

Definition at line 1060 of file reg_bank.hh.

◆ size()

template<ByteOrder BankByteOrder>
Addr gem5::RegisterBank< BankByteOrder >::size ( ) const
inline

Definition at line 941 of file reg_bank.hh.

Referenced by gem5::RegisterBank< ByteOrder::little >::read(), TEST_F(), and gem5::RegisterBank< ByteOrder::little >::write().

◆ write()

template<ByteOrder BankByteOrder>
virtual void gem5::RegisterBank< BankByteOrder >::write ( Addr  addr,
const void *  buf,
Addr  bytes 
)
inlinevirtual

Definition at line 1002 of file reg_bank.hh.

Referenced by gem5::SysSecCtrl::write(), gem5::fastmodel::ResetControllerExample::write(), gem5::X86ISA::I8237::write(), gem5::Clint::write(), gem5::Plic::write(), and gem5::Uart8250::write().

◆ writeWithMask()

template<ByteOrder BankByteOrder>
template<typename Data >
static constexpr Data gem5::RegisterBank< BankByteOrder >::writeWithMask ( const Data &  old,
const Data &  value,
const Data &  bitmask 
)
inlinestaticconstexpr

Definition at line 345 of file reg_bank.hh.

Referenced by gem5::RegisterBank< BankByteOrder >::Register< BackingType >::update().

Member Data Documentation

◆ _base

template<ByteOrder BankByteOrder>
Addr gem5::RegisterBank< BankByteOrder >::_base = 0
private

Definition at line 867 of file reg_bank.hh.

Referenced by gem5::RegisterBank< ByteOrder::little >::addRegisters(), and gem5::RegisterBank< ByteOrder::little >::base().

◆ _name

template<ByteOrder BankByteOrder>
const std::string gem5::RegisterBank< BankByteOrder >::_name
private

Definition at line 869 of file reg_bank.hh.

Referenced by gem5::RegisterBank< ByteOrder::little >::name().

◆ _offsetMap

template<ByteOrder BankByteOrder>
std::map<Addr, std::reference_wrapper<RegisterBase> > gem5::RegisterBank< BankByteOrder >::_offsetMap
private

Definition at line 865 of file reg_bank.hh.

Referenced by gem5::RegisterBank< ByteOrder::little >::addRegisters(), gem5::RegisterBank< ByteOrder::little >::read(), gem5::RegisterBank< ByteOrder::little >::reset(), and gem5::RegisterBank< ByteOrder::little >::write().

◆ _size

template<ByteOrder BankByteOrder>
Addr gem5::RegisterBank< BankByteOrder >::_size = 0
private

Definition at line 868 of file reg_bank.hh.

Referenced by gem5::RegisterBank< ByteOrder::little >::addRegisters(), and gem5::RegisterBank< ByteOrder::little >::size().

The documentation for this class was generated from the following file:
Generated on Sun Jul 30 2023 01:57:16 for gem5 by doxygen 1.8.17