#include <bus.hh>

Inheritance diagram for I2CBus:

Public Member Functions
	I2CBus (const I2CBusParams *p)
	4KB - see e.g. More...

Tick	read (PacketPtr pkt) override
	Reads will always be to SB_CONTROLS. More...

Tick	write (PacketPtr pkt) override
	The default i2c bus driver used by the realview pbx board writes to this device one bit at a time. 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 BasicPioDevice
	BasicPioDevice (const Params *p, Addr size)

const Params *	params () const

virtual AddrRangeList	getAddrRanges () const
	Determine the address ranges that this device responds to. More...

Public Member Functions inherited from PioDevice
	PioDevice (const Params *p)

virtual	~PioDevice ()

const Params *	params () const

virtual void	init ()
	init() is called after all C++ SimObjects have been created and all ports are connected. More...

virtual BaseSlavePort &	getSlavePort (const std::string &if_name, PortID idx=InvalidPortID)
	Get a slave port with a given name and index. More...

Public Member Functions inherited from MemObject
const Params *	params () const

	MemObject (const Params *params)

virtual BaseMasterPort &	getMasterPort (const std::string &if_name, PortID idx=InvalidPortID)
	Get a master port with a given name and index. More...

Public Member Functions inherited from ClockedObject
	ClockedObject (const ClockedObjectParams *p)

const Params *	params () const

void	serialize (CheckpointOut &cp) const override
	Serialize an object. More...

void	unserialize (CheckpointIn &cp) override
	Unserialize an object. More...

Enums::PwrState	pwrState () const

std::string	pwrStateName () const

std::vector< double >	pwrStateWeights () const
	Returns the percentage residency for each power state. More...

void	computeStats ()
	Record stats values like state residency by computing the time difference from previous update. More...

void	pwrState (Enums::PwrState)

void	regStats () override
	Register statistics for this object. More...

Public Member Functions inherited from SimObject
const Params *	params () const

	SimObject (const Params *_params)

virtual	~SimObject ()

virtual const std::string	name () const

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	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...

Public Member Functions inherited from Clocked
void	updateClockPeriod () const
	Update the tick to the current tick. More...

Tick	clockEdge (Cycles cycles=Cycles(0)) const
	Determine the tick when a cycle begins, by default the current one, but the argument also enables the caller to determine a future cycle. More...

Cycles	curCycle () const
	Determine the current cycle, corresponding to a tick aligned to a clock edge. More...

Tick	nextCycle () const
	Based on the clock of the object, determine the start tick of the first cycle that is at least one cycle in the future. More...

uint64_t	frequency () const

Tick	clockPeriod () const

double	voltage () const

Cycles	ticksToCycles (Tick t) const

Tick	cyclesToTicks (Cycles c) const

Protected Types
enum	I2CState { IDLE, RECEIVING_ADDR, RECEIVING_DATA, SENDING_DATA }

Protected Member Functions
void	updateSignals (PacketPtr pkt)
	Update data (sda) and clock (scl) to match any transitions specified by pkt. More...

bool	isClockSet (PacketPtr pkt) const
	Clock set check. More...

bool	isStart (PacketPtr pkt) const
	i2c start signal check More...

bool	isEnd (PacketPtr pkt) const
	i2c end signal check More...

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...

Protected Member Functions inherited from Clocked
	Clocked (ClockDomain &clk_domain)
	Create a clocked object and set the clock domain based on the parameters. More...

	Clocked (Clocked &)=delete

Clocked &	operator= (Clocked &)=delete

virtual	~Clocked ()
	Virtual destructor due to inheritance. More...

void	resetClock () const
	Reset the object's clock using the current global tick value. More...

Protected Attributes
uint8_t	scl
	I2C clock wire (0, 1). More...

uint8_t	sda
	I2C data wire (0, 1) More...

enum I2CState	state
	State used by I2CBus::write to determine what stage of an i2c transmission it is currently in. More...

int	currBit
	Order of the bit of the current message that is being sent or received (0 - 7). More...

uint8_t	i2cAddr
	Key used to access a device in the slave devices map. More...

uint8_t	message
	8-bit buffer used to send and receive messages bit by bit. More...

std::map< uint8_t, I2CDevice * >	devices
	All the slave i2c devices that are connected to this bus. More...

Protected Attributes inherited from BasicPioDevice
Addr	pioAddr
	Address that the device listens to. More...

Addr	pioSize
	Size that the device's address range. More...

Tick	pioDelay
	Delay that the device experinces on an access. More...

Protected Attributes inherited from PioDevice
System *	sys

PioPort	pioPort
	The pioPort that handles the requests for us and provides us requests that it sees. More...

Protected Attributes inherited from ClockedObject
Enums::PwrState	_currPwrState
	To keep track of the current power state. More...

Tick	prvEvalTick

Stats::Scalar	numPwrStateTransitions

Stats::Distribution	pwrStateClkGateDist

Stats::Vector	pwrStateResidencyTicks

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...

Static Protected Attributes
static const int	SB_CONTROLS = 0x0
	Read [and Set] serial control bits: Bit [0] is SCL Bit [1] is SDA. More...

static const int	SB_CONTROLC = 0x4
	Clear control bits. More...

Additional Inherited Members
Public Types inherited from BasicPioDevice
typedef BasicPioDeviceParams	Params

Public Types inherited from PioDevice
typedef PioDeviceParams	Params

Public Types inherited from MemObject
typedef MemObjectParams	Params

Public Types inherited from ClockedObject
typedef ClockedObjectParams	Params
	Parameters of ClockedObject. More...

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

Detailed Description

Definition at line 55 of file bus.hh.

Member Enumeration Documentation

enum I2CBus::I2CState

protected

Enumerator
IDLE
RECEIVING_ADDR
RECEIVING_DATA
SENDING_DATA

Definition at line 59 of file bus.hh.

Constructor & Destructor Documentation

I2CBus::I2CBus ( const I2CBusParams * p )

4KB - see e.g.

http://infocenter.arm.com/help/topic/com.arm.doc.dui0440b/Bbajihec.html

Definition at line 55 of file bus.cc.

References ArmISA::d, and devices.

Member Function Documentation

bool I2CBus::isClockSet ( PacketPtr pkt ) const

protected

Clock set check.

Parameters

pkt	memory request packet

Returns: true if pkt indicates that scl transition from 0 to 1

Definition at line 193 of file bus.cc.

References Packet::get(), Packet::getAddr(), BasicPioDevice::pioAddr, and SB_CONTROLS.

Referenced by write().

bool I2CBus::isEnd ( PacketPtr pkt ) const

protected

i2c end signal check

Parameters

pkt	memory request packet

Returns: true if pkt indicates stopping the current transmission

Definition at line 209 of file bus.cc.

References Packet::get(), Packet::getAddr(), BasicPioDevice::pioAddr, SB_CONTROLS, and scl.

Referenced by write().

bool I2CBus::isStart ( PacketPtr pkt ) const

protected

i2c start signal check

Parameters

pkt	memory request packet

Returns: true if pkt indicates a new transmission

Definition at line 201 of file bus.cc.

References Packet::get(), Packet::getAddr(), BasicPioDevice::pioAddr, SB_CONTROLC, and scl.

Referenced by write().

Tick I2CBus::read ( PacketPtr pkt )

overridevirtual

Reads will always be to SB_CONTROLS.

The kernel wants to know the state of sda and scl.

Implements PioDevice.

Definition at line 71 of file bus.cc.

References Packet::getAddr(), Packet::makeAtomicResponse(), BasicPioDevice::pioAddr, BasicPioDevice::pioDelay, SB_CONTROLS, scl, sda, and Packet::set().

void I2CBus::serialize ( CheckpointOut & cp ) const

overridevirtual

Serialize an object.

Output an object's state into the current checkpoint section.

Parameters

cp	Checkpoint state

Implements Serializable.

Definition at line 216 of file bus.cc.

References currBit, DPRINTF, i2cAddr, message, scl, sda, SERIALIZE_ENUM, SERIALIZE_SCALAR, and state.

void I2CBus::unserialize ( CheckpointIn & cp )

overridevirtual

Unserialize an object.

Read an object's state from the current checkpoint section.

Parameters

cp	Checkpoint state

Implements Serializable.

Definition at line 228 of file bus.cc.

References currBit, DPRINTF, i2cAddr, message, scl, sda, state, UNSERIALIZE_ENUM, and UNSERIALIZE_SCALAR.

void I2CBus::updateSignals ( PacketPtr pkt )

protected

Update data (sda) and clock (scl) to match any transitions specified by pkt.

Parameters

pkt	memory request packet

Definition at line 173 of file bus.cc.

References Packet::get(), Packet::getAddr(), BasicPioDevice::pioAddr, SB_CONTROLC, SB_CONTROLS, scl, and sda.

Referenced by write().

Tick I2CBus::write ( PacketPtr pkt )

overridevirtual

The default i2c bus driver used by the realview pbx board writes to this device one bit at a time.

To facilitate making new i2c devices, i2cBus::write takes care of the low-level details of the i2c protocol. See the I2C Specification [1] for a detailed description of the protocol.

[1] - http://www.nxp.com/documents/user_manual/UM10204.pdf

Implements PioDevice.

Definition at line 90 of file bus.cc.

References currBit, ArmISA::d, devices, Packet::getAddr(), i2cAddr, IDLE, isClockSet(), isEnd(), isStart(), message, panic, BasicPioDevice::pioAddr, BasicPioDevice::pioDelay, RECEIVING_ADDR, RECEIVING_DATA, SB_CONTROLC, SB_CONTROLS, sda, SENDING_DATA, state, and updateSignals().