timing.shells.fmc.FMCShell Class Reference

Inheritance diagram for timing.shells.fmc.FMCShell:

Collaboration diagram for timing.shells.fmc.FMCShell:

Public Member Functions
	getAX3Slave (self)
	getUIDSlave (self)
	getSIChipSlave (self)
	resetI2CnPll (self)
	enableI2CSwitch (self)
	reset (self, soft, forcepllcfg)
Public Member Functions inherited from timing.shells.boards.BoardShell
	soft_reset (self)
	readUID (self)
	scanI2C (self)
	pingI2CSlaves (self)
	measureClockFrequency (self)
	status (self)
	pllstatus (self, verbose=False)

Static Public Attributes
int	kFMCRev1 = 1
int	kFMCRev2 = 2
dict	kUIDRevisionMap
dict	kClockConfigMap
list	i2cMasters

Additional Inherited Members
Public Attributes inherited from timing.shells.boards.BoardShell
	i2cMasters = lIO.getNode(lI2CName)

Detailed Description

docstring for PC059Shell

Definition at line 18 of file fmc.py.

Member Function Documentation

enableI2CSwitch()

timing.shells.fmc.FMCShell.enableI2CSwitch

(

self

)

Reimplemented from timing.shells.boards.BoardShell.

Definition at line 88 of file fmc.py.

    def enableI2CSwitch(self):
        if self.info.carrierType == kCarrierEnclustraA35:
            super(FMCShell, self).enableI2CSwitch()

getAX3Slave()

timing.shells.fmc.FMCShell.getAX3Slave

(

self

)

Definition at line 55 of file fmc.py.

    def getAX3Slave(self):
        lIO = self.device.getNode('io')
        return lIO.getNode('uid_i2c').get_slave('AX3_Switch')

getSIChipSlave()

timing.shells.fmc.FMCShell.getSIChipSlave

(

self

)

Definition at line 67 of file fmc.py.

    def getSIChipSlave(self):
        lIO = self.device.getNode('io')
        return lIO.getNode('pll_i2c')

getUIDSlave()

timing.shells.fmc.FMCShell.getUIDSlave

(

self

)

Definition at line 61 of file fmc.py.

    def getUIDSlave(self):
        lIO = self.device.getNode('io')
        return lIO.getNode('uid_i2c').get_slave('FMC_UID_PROM')

reset()

timing.shells.fmc.FMCShell.reset	(		self,
			soft,
			forcepllcfg )

Perform a hard reset on the timing master, including

\b
- ipbus registers
- i2c buses
- pll and pll configuration

\b
Fanout mode:
0 = local master
1 = sfp

Definition at line 94 of file fmc.py.

    def reset(self, soft, forcepllcfg):
        '''
        Perform a hard reset on the timing master, including
 
        \b
        - ipbus registers
        - i2c buses
        - pll and pll configuration
 
        \b
        Fanout mode:
        0 = local master
        1 = sfp
        '''
 
        echo('Resetting ' + click.style(self.device.id(), fg='blue'))
 
        lDevice = self.device
        lBoardType = self.info.boardType
        lCarrierType = self.info.carrierType
        lDesignType = self.info.designType
 
        lIO = lDevice.getNode('io')
 
        # Global soft reset
        self.soft_reset()
 
        if not soft:
            time.sleep(0.1)
                
            # PLL and I2C reset 
            self.resetI2CnPll()
 
            # Enable I2C routing
            self.enableI2CSwitch()
 
            lUniqueID = self.readUID()
            # echo("Timing Board PROM UID: "+style(hex(lUniqueID), fg="blue"))
 
            # Ensure that the board is known to the revision DB
            try:
                lRevision = self.kUIDRevisionMap[lUniqueID]
            except KeyError:
                raise click.ClickException("No revision associated to UID "+hex(lUniqueID))
 
            # Access the clock chip
            lSIChip = self.getSIChipSlave()
 
            # Ensure that the board revision has a registered clock config
            if forcepllcfg is not None:
                lFullClockConfigPath = forcepllcfg
                echo("Using PLL Clock configuration file: "+style(basename(lFullClockConfigPath), fg='green') )
 
            else:
                try:
                    lClockConfigPath = self.kClockConfigMap[lRevision]    
                except KeyError:
                    raise ClickException("Board revision " << lRevision << " has no associated clock configuration")
 
 
                echo("PLL Clock configuration file: "+style(lClockConfigPath, fg='green') )
 
                # Configure the clock chip
                lFullClockConfigPath = expandvars(join('${TIMING_SHARE}/config/etc/clock', lClockConfigPath))
 
            lSIChip.configure(lFullClockConfigPath)
            echo("SI354x configuration id: {}".format(style(lSIChip.read_config_id(), fg='green')))
 
# ------------------------------------------------------------------------------
 

resetI2CnPll()

timing.shells.fmc.FMCShell.resetI2CnPll

(

self

)

Definition at line 74 of file fmc.py.

    def resetI2CnPll(self):
        lIO = self.device.getNode('io')
 
        time.sleep(0.1)
            
        # PLL and I2C reset 
        lIO.getNode('csr.ctrl.pll_rst').write(0x1)
        lIO.getClient().dispatch()
 
        lIO.getNode('csr.ctrl.pll_rst').write(0x0)
        lIO.getClient().dispatch()

Member Data Documentation

i2cMasters

list timing.shells.fmc.FMCShell.i2cMasters

static

Initial value:

= [
        'uid_i2c',
        'sfp_i2c',
        'pll_i2c'
    ]

Definition at line 48 of file fmc.py.

kClockConfigMap

dict timing.shells.fmc.FMCShell.kClockConfigMap

static

Initial value:

=  {
        kFMCRev1: "SI5344/PDTS0000.txt",
        kFMCRev2: "SI5344/PDTS0003.txt",
    }

Definition at line 43 of file fmc.py.

kFMCRev1

int timing.shells.fmc.FMCShell.kFMCRev1 = 1

static

Definition at line 20 of file fmc.py.

kFMCRev2

int timing.shells.fmc.FMCShell.kFMCRev2 = 2

static

Definition at line 21 of file fmc.py.

kUIDRevisionMap

dict timing.shells.fmc.FMCShell.kUIDRevisionMap

static

Initial value:

=  {
        0xd880395e720b: kFMCRev1,
        0xd880395e501a: kFMCRev1,
        0xd880395e50b8: kFMCRev1,
        0xd880395e501b: kFMCRev1,
        0xd880395e7201: kFMCRev1,
        0xd880395e4fcc: kFMCRev1,
        0xd880395e5069: kFMCRev1,
        0xd880395e7206: kFMCRev1,
        0xd880395e1c86: kFMCRev2,
        0xd880395e2630: kFMCRev2,
        0xd880395e262b: kFMCRev2,
        0xd880395e2b38: kFMCRev2,
        0xd880395e1a6a: kFMCRev2,
        0xd880395e36ae: kFMCRev2,
        0xd880395e2b2e: kFMCRev2,
        0xd880395e2b33: kFMCRev2,
        0xd880395e1c81: kFMCRev2,
    }

Definition at line 23 of file fmc.py.

---

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

• /github/workspace/dunedaq/sourcecode/timing/python/timing/shells/fmc.py