gLCB.py

#!/usr/local/bin/python
#
#                               Copyright 2004
#                                     by
#                        The Board of Trustees of the
#                     Leland Stanford Junior University.
#                            All rights reserved.
#


__facility__ = "Online"
__abstract__ = "GLAST LCB functional block"
__author__  = "R. Claus <claus@slac.stanford.edu> SLAC - GLAST LAT I&T/Online"
__date__     = ("$Date: 2005/05/27 01:37:40 $").split(' ')[1]
__version__ = "$Revision: 2.12 $"
__release__  = "$Name: R04-12-00 $"
__credits__ = "SLAC"

import LATTE.copyright_SLAC

import gDb
import gAttr

import logging

class GLCB(gDb.Gdb):
  """\brief LCB node.

  Has GLCB specific registers and dataless commands.

  Valid Registers:
  - \c parity_latp_cell_header
  - \c parity_latp_cell_body
  - \c back_pressure_once
  - \c back_pressure
  - \c board_id

  """
  Online        = 0
  Offline       = 1
  Uninitialized = 2

  State = {Online:        "online",
           Offline:       "offline",
           Uninitialized: "uninitialized"}

  __attrs = [
    # Registers
    gAttr.GattrBF('parity_latp_cell_header', 0, 4, 5),
    gAttr.GattrBF('parity_latp_cell_body',   0, 5, 6),
    gAttr.GattrBF('back_pressure_once',      0, 6, 7),
    gAttr.GattrBF('back_pressure',           0, 7, 8),
    gAttr.GattrBF('board_id',                0, 8, 13)
    ]

  __tmo = 100

  def __init__(self, client):
    """\brief Initialize valid registers as Gattrs.
    """
    flags = {'BoardId'           : 0x22,
             'UseRedundant'      : 0,
             'UseBitWide'        : 0,
             'UseTrailingIclock' : 0,
             'UseTrailingOclock' : 0,
             'IgnoreMissingNodes': 1}
    self.stats = GLCBSTATS(client, self)
    gDb.Gdb.__init__(self, client, None, 0, self.__attrs, None, flags)

  def read(self, reg):
    return self.cmdrsp('LCBC_csr_access', 'lcb', 0, 0, self.__tmo, '!I', '!I')

  def load(self, reg, value):
    return self.cmdrsp('LCBC_csr_access', 'lcb', value, 0xffff, self.__tmo, 0, 0)

  def setEvtEnable(self, enable):
    """\brief Sets the LCB event enable bit to true or false.

    \param enable boolean.
    """
    return self.cmdrsp('LCBD_evt_enable', 'lcb', enable)

  def start(self, lcbmask):
    rsp = self.cmdrsp('load_lcb', lcbmask)
    return rsp.status()

  def start_wait(self, lcbmask, timeout):
    tmo = self.client().gettimeout()
    if timeout is not None:
      self.client().settimeout(timeout)
    rsp = self.cmdrsp('load_wait_lcb', lcbmask)
    self.client().settimeout(tmo)
    return rsp.status()

  def switch(self, lcbmask):
    rsp = self.cmdrsp('switch_lcb', lcbmask)
    return rsp.status()

  def switch_wait(self, timeout):
    tmo = self.client().gettimeout()
    if timeout is not None:
      self.client().settimeout(timeout)
    rsp = self.cmdrsp('switch_wait_lcb')
    self.client().settimeout(tmo)
    return rsp.status()

  def state(self):
    rsp = self.cmdrsp('LCBD_state_get', 'lcb')
    return rsp.status()


class GLCBSTATS(gDb.Gdb):
  """\brief LCB stats access

  Has stats-specific registers

  Valid Registers:
  - \c packets_received Number of event packets received
  - \c body_parity_error Latched data cell parity error
  - \c header_parity_error Latched data header parity error
  - \c latp_address_error Improperly addressed packet rejected
  """

    # Registers
  __attrs = [
    gAttr.GattrBF('packets_received'  ,  0,  0, 14, gAttr.ATTR_READ_ONLY),
    gAttr.GattrBF('body_parity_error',   0, 14, 15, gAttr.ATTR_READ_ONLY),
    gAttr.GattrBF('header_parity_error', 0, 15, 16, gAttr.ATTR_READ_ONLY),
    gAttr.GattrBF('latp_address_error',  0, 16, 17, gAttr.ATTR_READ_ONLY)
    ]

  __tmo = 100

  def __init__(self, client, parent):
    """\brief Initialize valid registers as Gattrs.
    """
    gDb.Gdb.__init__(self, client, parent, 0, self.__attrs)

  def read(self, reg):
    return self.cmdrsp('LCBC_rxstats_access', 'lcb', 0, 0, self.__tmo, '!I', '!I')

  def reset(self):
    return self.cmdrsp('LCBC_rxstats_access', 'lcb', 0, 0xFFFF, self.__tmo, 0, 0)

---