I2CDevice Class Reference

#include <device.hh>

Inheritance diagram for I2CDevice:

Public Member Functions
	I2CDevice (const I2CDeviceParams *p)
virtual	~I2CDevice ()
virtual uint8_t	read ()=0
	Return the next message that the device expects to send. More...
virtual void	write (uint8_t msg)=0
	Perform any actions triggered by an i2c write (save msg in a register, perform an interrupt, update a register pointer or command register, etc...) More...
virtual void	i2cStart ()=0
	Perform any initialization necessary for the device when it received a start signal from the bus master (devices frequently expect the first write to be a register address) More...
uint8_t	i2cAddr () const
Public Member Functions inherited from SimObject
const Params *	params () const
	SimObject (const Params *_params)
virtual	~SimObject ()
virtual const std::string	name () const
virtual void	init ()
	init() is called after all C++ SimObjects have been created and all ports are connected. More...
virtual void	loadState (CheckpointIn &cp)
	loadState() is called on each SimObject when restoring from a checkpoint. More...
virtual void	initState ()
	initState() is called on each SimObject when not restoring from a checkpoint. More...
virtual void	regStats ()
	Register statistics for this object. More...
virtual void	resetStats ()
	Reset statistics associated with this object. More...
virtual void	regProbePoints ()
	Register probe points for this object. More...
virtual void	regProbeListeners ()
	Register probe listeners for this object. More...
ProbeManager *	getProbeManager ()
	Get the probe manager for this object. More...
virtual void	startup ()
	startup() is the final initialization call before simulation. More...
DrainState	drain () override
	Provide a default implementation of the drain interface for objects that don't need draining. More...
virtual void	memWriteback ()
	Write back dirty buffers to memory using functional writes. More...
virtual void	memInvalidate ()
	Invalidate the contents of memory buffers. More...
void	serialize (CheckpointOut &cp) const override
	Serialize an object. More...
void	unserialize (CheckpointIn &cp) override
	Unserialize an object. More...
Public Member Functions inherited from EventManager
	EventManager (EventManager &em)
	EventManager (EventManager *em)
	EventManager (EventQueue *eq)
EventQueue *	eventQueue () const
void	schedule (Event &event, Tick when)
void	deschedule (Event &event)
void	reschedule (Event &event, Tick when, bool always=false)
void	schedule (Event *event, Tick when)
void	deschedule (Event *event)
void	reschedule (Event *event, Tick when, bool always=false)
void	wakeupEventQueue (Tick when=(Tick)-1)
void	setCurTick (Tick newVal)
Public Member Functions inherited from Serializable
	Serializable ()
virtual	~Serializable ()
void	serializeSection (CheckpointOut &cp, const char *name) const
	Serialize an object into a new section. More...
void	serializeSection (CheckpointOut &cp, const std::string &name) const
void	unserializeSection (CheckpointIn &cp, const char *name)
	Unserialize an a child object. More...
void	unserializeSection (CheckpointIn &cp, const std::string &name)
Public Member Functions inherited from Drainable
DrainState	drainState () const
	Return the current drain state of an object. More...
virtual void	notifyFork ()
	Notify a child process of a fork. More...

Protected Attributes
uint8_t	_addr
Protected Attributes inherited from SimObject
const SimObjectParams *	_params
	Cached copy of the object parameters. More...
Protected Attributes inherited from EventManager
EventQueue *	eventq
	A pointer to this object's event queue. More...

Additional Inherited Members
Public Types inherited from SimObject
typedef SimObjectParams	Params
Static Public Member Functions inherited from SimObject
static void	serializeAll (CheckpointOut &cp)
	Serialize all SimObjects in the system. More...
static SimObject *	find (const char *name)
	Find the SimObject with the given name and return a pointer to it. More...
Static Public Member Functions inherited from Serializable
static const std::string &	currentSection ()
	Get the fully-qualified name of the active section. More...
static void	serializeAll (const std::string &cpt_dir)
static void	unserializeGlobals (CheckpointIn &cp)
Static Public Attributes inherited from Serializable
static int	ckptCount = 0
static int	ckptMaxCount = 0
static int	ckptPrevCount = -1
Protected Member Functions inherited from Drainable
	Drainable ()
virtual	~Drainable ()
virtual void	drainResume ()
	Resume execution after a successful drain. More...
void	signalDrainDone () const
	Signal that an object is drained. More...

Detailed Description

Definition at line 52 of file device.hh.

Constructor & Destructor Documentation

I2CDevice::I2CDevice ( const I2CDeviceParams *  p )

inline

Definition at line 61 of file device.hh.

virtual I2CDevice::~I2CDevice ( )

inlinevirtual

Definition at line 65 of file device.hh.

Member Function Documentation

uint8_t I2CDevice::i2cAddr ( ) const

inline

Definition at line 92 of file device.hh.

References _addr.

virtual void I2CDevice::i2cStart ( )

pure virtual

Perform any initialization necessary for the device when it received a start signal from the bus master (devices frequently expect the first write to be a register address)

virtual uint8_t I2CDevice::read ( )

pure virtual

Return the next message that the device expects to send.

This will likely have side effects (e.g., incrementing a register pointer).

Returns

8-bit message the device has been set up to send

virtual void I2CDevice::write ( uint8_t  msg )

pure virtual

Perform any actions triggered by an i2c write (save msg in a register, perform an interrupt, update a register pointer or command register, etc...)

Parameters

msg	8-bit message from master

Member Data Documentation

uint8_t I2CDevice::_addr

protected

Definition at line 57 of file device.hh.

Referenced by i2cAddr().

---

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

• dev/i2c/device.hh