gMem.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 remote memory accessors"
__author__  = "Selim Tuvi <stuvi@slac.stanford.edu> SLAC - GLAST LAT I&T/Online"
__date__     = ("$Date: 2004/09/20 18:13:04 $").split(' ')[1]
__version__ = "$Revision: 1.5 $"
__release__  = "$Name: R04-12-00 $"
__credits__ = "SLAC"

import LATTE.copyright_SLAC

import struct
import gDb
import gAttr

class GMem(gDb.Gdb):
  """\brief Memory node.

  Has GMem specific registers

  Dataless Commands:
  none

  """
  __VX_READ  = 0
  __VX_WRITE = 1

  __fmt = {1 : 'B', 2 : 'H', 4 : 'I', 8 : 'Q'}

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

  def gMEMread(self, addr, size=4):
    """SBC MEM read command

    \param  addr SBC address
    \param  size Addressing used (1=8bit, 2=16bit, 4=32bit, 8=64bit, default is 4)
    \return A tuple containing the user id, status and value

    """
    payload = '!' + self.__fmt[size]
    return self.cmdrsp('vxMemProbe', addr, GMem.__VX_READ, size, payload)

  def gMEMload(self, addr, val, size=4):
    """SBC MEM load command

    \param  addr SBC address
    \param  val  Value to be set at address \a addr
    \param  size Addressing used (1=8bit, 2=16bit, 4=32bit, 8=64bit, default is 4)
    \return A tuple containing the user id, status and timestamp
    """
    input = '>' + struct.pack('>'+self.__fmt[size], val) # val to big endian
    return self.cmdrsp('vxMemProbe', addr, GMem.__VX_WRITE, size, input)

  def gMEMbusToLocal(self, space, addr):
    """Translate an address in some space to local (PPC) space

    \param  space Bus address space in which \a addr resides
    \param  addr  Bus address to convert
    \return A tuple containing the user id, status, local address value and timestamp

    """
    return self.cmdrsp('sysBusToLocalAdrs', space, addr, '!I')

  def gMEMlocalToBus(self, space, addr):
    """Translate an address in local (PPC) space to some space

    \param  space Bus address space in which \a addr resides
    \param  addr  Local address to convert
    \return A tuple containing the user id, status, bus address value and timestamp

    """
    return self.cmdrsp('sysLocalToBusAdrs', space, addr, '!I')

---