URL https://opencores.org/ocsvn/ssbcc/ssbcc/trunk

Subversion Repositories ssbcc

[/] [ssbcc/] [trunk/] [ssbccConfig.py] - Blame information for rev 12

Details | Compare with Previous | View Log


# Copyright 2012-2015, Sinclair R.F., Inc.
# Utilities required by ssbcc.
 
import math
import os
import re
import sys
 
from ssbccPeripheral import SSBCCinterruptPeripheral
from ssbccUtil import *
 
class SSBCCconfig():
  """
  Container for ssbcc configuration commands, the associated parsing, and
  program generation.
  """
 
  def __init__(self):
    """
    Initialize the empty dictionaries holding the processor configuration
    parameters.  Initialize the paths to search for peripherals.
    """
    self.config         = dict();               # various settings, etc.
    self.constants      = dict();               # CONSTANTs
    self.defines        = dict();               # defines
    self.functions      = dict();               # list of functions to define
    self.inports        = list();               # INPORT definitions
    self.ios            = list();               # List of I/Os
    self.outports       = list();               # OUTPORT definitions (see AddOutport)
    self.parameters     = list();               # PARAMETERs and LOCALPARAMs
    self.peripheral     = list();               # PERIPHERALs
    self.signals        = list();               # internal signals
    self.symbols        = list();               # constant, I/O, inport, etc.  names
 
    # list of memories
    self.memories = dict(name=list(), type=list(), maxLength=list());
 
    # list of how the memories will be instantiated
    self.config['combine'] = list();
 
    # initial search path for .INCLUDE configuration commands
    self.includepaths = list();
    self.includepaths.append('.');
 
    # initial search paths for peripherals
    self.peripheralpaths = list();
    self.peripheralpaths.append('.');
    self.peripheralpaths.append('peripherals');
    self.peripheralpaths.append(os.path.join(sys.path[0],'core/peripherals'));
 
  def AddConstant(self,name,value,loc):
    """
    Add the constant for the "CONSTANT" configuration command to the "constants"
    dictionary.\n
    name        symbol for the constant
    value       value of the constant
    loc         file name and line number for error messages
    """
    self.AddSymbol(name,loc);
    if name in self.constants:
      raise SSBCCException('CONSTANT "%s" already declared at %s' % (name,loc,));
    if not ((type(value) == int) or IsIntExpr(value)):
      raise SSBCCException('Could not evaluate expression "%s" for constant at %s' % (value,loc,));
    self.constants[name] = ParseIntExpr(value);
 
  def AddDefine(self,name):
    """
    Add the defined symbol.\n
    name        name for the symbol (must start with "D_")\n
    Note:  This is only invoked for the command line arguments so there is no
           "loc" available.\n
    Note:  Defines can be declared more than once on the command line with no
           ill effects.
    """
    if not self.IsDefine(name):
      self.AddSymbol(name);
      self.defines[name] = 1;
 
  def AddIO(self,name,nBits,iotype,loc):
    """
    Add an I/O signal to the processor interface to the system.\n
    name        name of the I/O signal
    nBits       number of bits in the I/O signal
    iotype      signal direction:  "input", "output", or "inout"
    """
    if iotype != 'comment':
      self.AddSymbol(name,loc);
    self.ios.append((name,nBits,iotype,));
 
  def AddInport(self,port,loc):
    """
    Add an INPORT symbol to the processor.\n
    port        name of the INPORT symbol
    loc         file name and line number for error messages
    """
    name = port[0];
    self.AddSymbol(name,loc);
    self.inports.append(port);
 
  def AddMemory(self,cmd,loc):
    """
    Add a memory to the list of memories.\n
    cmd         3-element list as follows:
                [0] ==> type:  "RAM" or "ROM"
                [1] ==> memory name
                [2] ==> memory length (must be a power of 2)
    loc         file name and line number for error messages
    """
    self.memories['type'].append(cmd[0]);
    self.memories['name'].append(cmd[1]);
    maxLength = eval(cmd[2]);
    if not IsPowerOf2(maxLength):
      raise SSBCCException('Memory length must be a power of 2, not "%s", at %s' % (cmd[2],loc,));
    self.memories['maxLength'].append(eval(cmd[2]));
 
  def AddOutport(self,port,loc):
    """
    Add an OUTPORT symbol to the processor.\n
    port        tuple as follows:
                port[0] - name of the OUTPORT symbol
                port[1] - True if the outport is a strobe-only outport, False
                          otherwise
                port[2:] - zero or more tuples as follows:
                  (o_signal,width,type,[initialization],)
                where
                  o_signal is the name of the output signal
                  width is the number of bits in the signal
                  type is 'data' or 'strobe'
                  initialization is an optional initial/reset value for the
                    output signal
    loc         file name and line number for error messages
    """
    self.AddSymbol(port[0],loc);
    self.outports.append(port);
 
  def AddParameter(self,name,value,loc):
    """
    Add a PARAMETER to the processor.\n
    name        name of the PARAMETER
    value       value of the PARAMETER
    loc         file name and line number for error messages
    """
    if not re.match(r'[LG]_\w+$',name):
      raise Exception('Program Bug -- bad parameter name at %s' % loc);
    self.AddSymbol(name,loc);
    self.parameters.append((name,value,));
 
  def AddSignal(self,name,nBits,loc):
    """
    Add a signal without an initial value to the processor.\n
    name        name of the signal
    nBits       number of bits in the signal
    loc         file name and line number for error messages
    """
    self.AddSymbol(name,loc);
    self.signals.append((name,nBits,));
 
  def AddSignalWithInit(self,name,nBits,init,loc):
    """
    Add a signal with an initial/reset value to the processor.\n
    name        name of the signal
    nBits       number of bits in the signal
    init        initial/reset value of the signal
    loc         file name and line number for error messages
    """
    self.AddSymbol(name,loc);
    self.signals.append((name,nBits,init,));
 
  def AddSymbol(self,name,loc=None):
    """
    Add the specified name to the list of symbols.\n
    Note:  This symbol has no associated functionality and is only used for
           ".ifdef" conditionals.
    """
    if name in self.symbols:
      if loc == None:
        raise SSBCCException('Symbol "%s" already defined, no line number provided');
      else:
        raise SSBCCException('Symbol "%s" already defined before %s' % (name,loc,));
    self.symbols.append(name);
 
  def AppendIncludePath(self,path):
    """
    Add the specified path to the end of the paths to search for .INCLUDE
    configuration commands.\n
    path        path to add to the list
    """
    self.includepaths.insert(-1,path);
 
  def CompleteCombines(self):
    """
    Ensure all memories are assigned addresses.\n
    This modifies config['combine'] to include singleton entries for any
    memories not subject to the COMBINE configuration command.  It then computes
    how the memories will be packed together as well as properites for the
    packed memories.  These properties are:
      packing   how the memories will be packed as per PackCombinedMemory
      memName   HDL name of the memory
      memLength number of words in the memory
      memWidth  bit width of the memory words
    """
    # Create singleton entries for memory types and memories that aren't already listed in 'combine'.
    if not self.IsCombined('INSTRUCTION'):
      self.config['combine'].append({'mems':['INSTRUCTION',], 'memArch':'sync'});
    for memType in ('DATA_STACK','RETURN_STACK',):
      if not self.IsCombined(memType):
        self.config['combine'].append({'mems':[memType,], 'memArch':'LUT'});
    for memName in self.memories['name']:
      if not self.IsCombined(memName):
        self.config['combine'].append({'mems':[memName,], 'memArch':'LUT'});
    # Determine the HDL names for the memories.
    nRAMROMs = 0;
    for combined in self.config['combine']:
      if combined['mems'][0] == 'INSTRUCTION':
        combined['memName'] = 's_opcodeMemory';
      elif combined['mems'][0] == 'DATA_STACK':
        combined['memName'] = 's_data_stack';
      elif combined['mems'][0] == 'RETURN_STACK':
        combined['memName'] = 's_R_stack';
      else:
        nRAMROMs += 1;
    if nRAMROMs > 0:
      memNameFormat = 's_mem_%%0%dx' % ((CeilLog2(nRAMROMs)+3)/4);
    ixRAMROM = 0;
    for combined in self.config['combine']:
      if 'memName' in combined:
        continue;
      if nRAMROMs == 1:
        combined['memName'] = 's_mem';
      else:
        combined['memName'] = memNameFormat % ixRAMROM;
        ixRAMROM += 1;
    # Perform packing for all memories.
    for combined in self.config['combine']:
      self.PackCombinedMemory(combined);
 
  def Exists(self,name):
    """
    Return true if the requested attribute has been created in the ssbccConfig
    object.
    """
    return name in self.config;
 
  def Get(self,name):
    """
    Return the requested attribute from the ssbccConfig object.
    """
    if not self.Exists(name):
      raise Exception('Program Bug:  "%s" not found in config' % name);
    return self.config[name];
 
  def GetMemoryByBank(self,ixBank):
    """
    Return the parameters for a memory by its bank address.\n
    ixBank      index of the requested memory bank
    """
    if not 'bank' in self.memories:
      return None;
    if ixBank not in self.memories['bank']:
      return None;
    ixMem = self.memories['bank'].index(ixBank);
    return self.GetMemoryParameters(ixMem);
 
  def GetMemoryByName(self,name):
    """
    Return the parameters for a memory by its name.\n
    name        name of the requested memory
    """
    if not name in self.memories['name']:
      return None;
    ixMem = self.memories['name'].index(name);
    return self.GetMemoryParameters(ixMem);
 
  def GetMemoryParameters(self,rawIndex):
    """
    Return the parameters for a memory by its index in the list of memories.\n
    rawIndex    index within the list of memories
    """
    if type(rawIndex) == str:
      if not self.IsMemory(rawIndex):
        raise Exception('Program Bug:  reference to non-existent memory');
      ix = self.memories['name'].index(rawIndex);
    elif type(rawIndex) == int:
      if (rawIndex < 0) or (rawIndex >= len(self.memories['name'])):
        raise Exception('Program Bug:  bad memory index %d' % rawIndex);
      ix = rawIndex;
    else:
      raise Exception('Program Bug:  unrecognized index type "%s"' % type(rawIndex));
    outvalue = dict();
    outvalue['index'] = ix;
    for field in self.memories:
      outvalue[field] = self.memories[field][ix];
    return outvalue;
 
  def GetPacking(self,name):
    """
    Get the memory packing for the provided memory.
    """
    for combined in self.config['combine']:
      if name not in combined['mems']:
        continue;
      for port in combined['port']:
        for packing in port['packing']:
          if packing['name'] == name:
            return (combined,port,packing,);
    else:
      raise Exception('Program Bug -- %s not found in combined memories' % name);
 
  def GetParameterValue(self,name):
    """
    Get the value associated with the named parameter.
    """
    if name.find('[') != -1:
      ix = name.index('[');
      thisSlice = name[ix:];
      name = name[:ix];
    else:
      thisSlice = '[0+:8]';
    for ix in range(len(self.parameters)):
      if self.parameters[ix][0] == name:
        return ExtractBits(IntValue(self.parameters[ix][1]),thisSlice);
    else:
      raise Exception('Program Bug:  Parameter "%s" not found' % name);
 
  def InsertPeripheralPath(self,path):
    """
    Add the specified path to the beginning of the paths to search for
    peripherals.\n
    path        path to add to the list
    """
    self.peripheralpaths.insert(-1,path);
 
  def InterruptVector(self):
    """
    Indicate whether or not interrupts have been enabled and, if so, what the
    interrupt address is.\n
    Note:  The interrupt address cannot be zero because .main starts at address
 
    Note:  Returning "None" when there is not interrupt address ensures both a
           "False" evaluation and that the value cannot be turned into an
           integer for an address.
    """
    if not self.Exists('interruptAddress'):
      return None;
    else:
      return self.Get('interruptAddress');
 
  def IsCombined(self,name):
    """
    Indicate whether or not the specified memory type has already been listed
    in a "COMBINE" configuration command.  The memory type should be one of
    DATA_STACK, INSTRUCTION, or RETURN_STACK.\n
    name        name of the specified memory type\n
    """
    for combined in self.config['combine']:
      if name in combined['mems']:
        return True;
    else:
      return False;
 
  def IsConstant(self,name):
    """
    Indicate whether or not the specified symbol is a recognized constant.
    """
    if re.match(r'C_\w+$',name) and name in self.constants:
      return True;
    else:
      return False;
 
  def IsDefine(self,name):
    """
    Indicate whether or not the specified symbol is a recognized define.
    """
    if re.match(r'D_\w+$',name) and name in self.defines:
      return True;
    else:
      return False;
 
  def IsMemory(self,name):
    """
    Indicate whether or not the specified symbol is the name of a memory.
    """
    return (name in self.memories['name']);
 
  def IsParameter(self,name):
    """
    Indicate whether or not the specified symbol is the name of a parameter.
    """
    if re.match(r'[GL]_\w+$',name) and name in self.symbols:
      return True;
    else:
      return False;
 
  def IsRAM(self,name):
    """
    Indicate whether or not the specified symbol is the name of a RAM.
    """
    if name not in self.memories['name']:
      return False;
    ix = self.memories['name'].index(name);
    return self.memories['type'][ix] == 'RAM';
 
  def IsROM(self,name):
    """
    Indicate whether or not the specified symbol is the name of a RAM.
    """
    if name not in self.memories['name']:
      return False;
    ix = self.memories['name'].index(name);
    return self.memories['type'][ix] == 'ROM';
 
  def IsStrobeOnlyOutport(self,outport):
    """
    Indicate whether or not the specified outport symbol only has strobes
    associated with it (i.e., it has no data signals).
    """
    return outport[1];
 
  def IsSymbol(self,name):
    """
    Indicate whether or not the specified name is a symbol.
    """
    return (name in self.symbols);
 
  def MemoryNameLengthList(self):
    """
    Return a list of tuples where each tuple is the name of a memory and its
    length.
    """
    outlist = list();
    for ix in range(len(self.memories['name'])):
      outlist.append((self.memories['name'][ix],self.memories['maxLength'][ix],));
    return outlist;
 
  def NInports(self):
    """
    Return the number of INPORTS.
    """
    return len(self.inports);
 
  def NMemories(self):
    """
    Return the number of memories.
    """
    return len(self.memories['name']);
 
  def NOutports(self):
    """
    Return the number of OUTPORTS.
    """
    return len(self.outports);
 
  def OverrideParameter(self,name,value):
    """
    Change the value of the specified parameter (based on the command line
    argument instead of the architecture file).\n
    name        name of the parameter to change
    value       new value of the parameter
    """
    for ix in range(len(self.parameters)):
      if self.parameters[ix][0] == name:
        break;
    else:
      raise SSBCCException('Command-line parameter or localparam "%s" not specified in the architecture file' % name);
    self.parameters[ix] = (name,value,);
 
  def PackCombinedMemory(self,combined):
    """
    Utility function for CompleteCombines.\n
    Determine packing strategy and resulting memory addresses and sizes.  This
    list has everything ssbccGenVerilog needs to construct the memory.\n
    The dual port memories can be used to do the following:
      1.  pack a single memory, either single-port or dual-port
      2.  pack two single-port memories sequentially, i.e., one at the start of
          the RAM and one toward the end of the RAM
      3.  pack one single-port memory at the start of the RAM and pack several
          compatible single-port memories in parallel toward the end of the RAM.
          Note:  Compatible means that they have the same address.
      4.  pack several compatible dual-port memories in parallel.\n
    These single-port or dual-port single or parallel packed memories are
    described in the 'port' list in combined.  Each entry in the port list has
    several parameters described below and a 'packing' list that describes the
    single or multiple memories attached to that port.\n
    The parameters for each of port is as follows:
      offset    start address of the memory in the packing
      nWords    number of RAM words reserved for the memory
                Note:  This can be larger than the aggregate number of words
                       required by the memory in order to align the memories to
                       power-of-2 address alignments.
      ratio     number of base memory entries for the memory
                Note:  This must be a power of 2.\n
    The contents of each entry in the packing are as follows:
      -- the following are from the memory declaration
      name      memory name
      length    number of elements in the memory based on the declared memory
                size
                Note:  This is based on the number of addresses required for
                       each memory entry (see ratio).
      nbits     width of the memory type
      -- the following are derived for the packing
      lane      start bit
                Note:  This is required in particular when memories are stacked
                       in parallel.
      nWords    number of memory addresses allocated for the memory based on
                the packing
                Note:  This will be larger than length when a small memory is
                       packed in parallel with a larger memory.  I.e., when
                       ratio is not one.
      ratio     number of base memory entries required to extract a single word
                for the memory type
                Note:  This allows return stack entries to occupy more than one
                       memory address when the return stack is combined with
                       other memory addresses.
                Note:  This must be a power of 2.\n
    The following entries are also added to "combined":
      nWords    number of words in the memory
      memWidth  bit width of the memory words\n
    Note:  If memories are being combined with the instructions space, they are
           always packed at the end of the instruction space, so the
           instruction space allocation is not included in the packing.
    """
    # Count how many memories of each type are being combined.
    nSinglePort = 0;
    nRAMs = 0;
    nROMs = 0;
    for memName in combined['mems']:
      if memName in ('INSTRUCTION','DATA_STACK','RETURN_STACK',):
        nSinglePort += 1;
      elif self.IsROM(memName):
        nROMs += 1;
      else:
        nRAMs += 1;
    if nRAMs > 0:
      nRAMs += nROMs;
      nROMs = 0;
    # Ensure the COMBINE configuration command is implementable in a dual-port RAM.
    if nSinglePort > 0 and nRAMs > 0:
      raise SSBCCException('Cannot combine RAMs with other memory types in COMBINE configuration command at %s' % combined['loc']);
    if nSinglePort > 2 or (nSinglePort > 1 and nROMs > 0):
      raise SSBCCException('Too many memory types in COMBINE configuration command at %s' % combined['loc']);
    # Start splitting the listed memories into the one or two output lists and ensure that single-port memories are listed in the correct order.
    mems = combined['mems'];
    ixMem = 0;
    split = list();
    if 'INSTRUCTION' in mems:
      if mems[0] != 'INSTRUCTION':
        raise SSBCCException('INSTRUCTION must be the first memory listed in the COMBINE configuration command at %s' % combined['loc']);
      split.append(['INSTRUCTION']);
      ixMem += 1;
    while len(mems[ixMem:]) > 0 and mems[ixMem] in ('DATA_STACK','RETURN_STACK',):
      split.append([mems[ixMem]]);
      ixMem += 1;
    for memName in ('DATA_STACK','RETURN_STACK',):
      if memName in mems[ixMem:]:
        raise SSBCCException('Single-port memory %s must be listed before ROMs in COMBINE configuration command at %s' % combined['loc']);
    if mems[ixMem:]:
      split.append(mems[ixMem:]);
    if not (1 <= len(split) <= 2):
      raise Exception('Program Bug -- bad COMBINE configuration command not caught');
    # Create the detailed packing information.
    combined['port'] = list();
    for thisSplit in split:
      packing = list();
      for memName in thisSplit:
        if memName == 'INSTRUCTION':
          packing.append({'name':memName, 'length':self.Get('nInstructions')['length'], 'nbits':9});
        elif memName == 'DATA_STACK':
          packing.append({'name':memName, 'length':self.Get('data_stack'), 'nbits':self.Get('data_width')});
        elif memName == 'RETURN_STACK':
          nbits = max(self.Get('data_width'),self.Get('nInstructions')['nbits']);
          packing.append({'name':memName, 'length':self.Get('return_stack'), 'nbits':nbits});
        else:
          thisMemory = self.GetMemoryParameters(memName);
          packing.append({'name':memName, 'length':CeilPow2(thisMemory['maxLength']), 'nbits':self.Get('data_width')});
      combined['port'].append({ 'packing':packing });
    # Calculate the width of the base memory.
    # Note:  This accommodates RETURN_STACK being an isolated memory.
    memWidth = combined['port'][0]['packing'][0]['nbits'] if len(combined['port']) == 1 else None;
    for port in combined['port']:
      for packing in port['packing']:
        tempMemWidth = packing['nbits'];
        if tempMemWidth > self.Get('sram_width'):
          tempMemWidth = self.Get('sram_width');
        if not memWidth:
          memWidth = tempMemWidth;
        elif tempMemWidth > memWidth:
          memWidth = tempMemWidth;
    combined['memWidth'] = memWidth;
    # Determine how the memories are packed.
    # Note:  "ratio" should be non-unity only for RETURN_STACK.
    for port in combined['port']:
      lane = 0;
      for packing in port['packing']:
        packing['lane'] = lane;
        ratio = CeilPow2((packing['nbits']+memWidth-1)/memWidth);
        packing['ratio'] = ratio;
        packing['nWords'] = ratio * packing['length'];
        lane += ratio;
    # Aggregate parameters each memory port.
    for port in combined['port']:
      ratio = CeilPow2(sum(packing['ratio'] for packing in port['packing']));
      maxLength = max(packing['length'] for packing in port['packing']);
      port['ratio'] = ratio;
      port['nWords'] = ratio * maxLength;
    combined['port'][0]['offset'] = 0;
    if len(combined['port']) > 1:
      if combined['mems'][0] == 'INSTRUCTION':
        nWordsTail = combined['port'][1]['nWords'];
        port0 = combined['port'][0];
        if port0['nWords'] <= nWordsTail:
          raise SSBCCException('INSTRUCTION length too small for "COMBINE INSTRUCTION,..." at %s' % combined['loc']);
        port0['nWords'] -= nWordsTail;
        port0['packing'][0]['nWords'] -= nWordsTail;
        port0['packing'][0]['length'] -= nWordsTail;
      else:
        maxNWords = max(port['nWords'] for port in combined['port']);
        for port in combined['port']:
          port['nWords'] = maxNWords;
      combined['port'][1]['offset'] = combined['port'][0]['nWords'];
    combined['nWords'] = sum(port['nWords'] for port in combined['port']);
 
  def ProcessCombine(self,loc,line):
    """
    Parse the "COMBINE" configuration command as follows:\n
    Validate the arguments to the "COMBINE" configuration command and append
    the list of combined memories and the associated arguments to "combine"
    property.\n
    The argument consists of one of the following:
      INSTRUCTION,{DATA_STACK,RETURN_STACK,rom_list}
      DATA_STACK
      DATA_STACK,{RETURN_STACK,rom_list}
      RETURN_STACK
      RETURN_STACK,{DATA_STACK,rom_list}
      mem_list
    where rom_list is a comma separated list of one or more ROMs and mem_list is
    a list of one or more RAMs or ROMs.
    """
    # Perform some syntax checking and get the list of memories to combine.
    cmd = re.findall(r'\s*COMBINE\s+(\S+)\s*$',line);
    if not cmd:
      raise SSBCCException('Malformed COMBINE configuration command on %s' % loc);
    mems = re.split(r',',cmd[0]);
    if (len(mems)==1) and ('INSTRUCTION' in mems):
      raise SSBCCException('"COMBINE INSTRUCTION" doesn\'t make sense at %s' % loc);
    if ('INSTRUCTION' in mems) and (mems[0] != 'INSTRUCTION'):
      raise SSBCCException('"INSTRUCTION" must be listed first in COMBINE configuration command at %s' % loc);
    recognized = ['INSTRUCTION','DATA_STACK','RETURN_STACK'] + self.memories['name'];
    unrecognized = [memName for memName in mems if memName not in recognized];
    if unrecognized:
      raise SSBCCException('"%s" not recognized in COMBINE configuration command at %s' % (unrecognized[0],loc,));
    alreadyUsed = [memName for memName in mems if self.IsCombined(memName)];
    if alreadyUsed:
      raise SSBCCException('"%s" already used in COMBINE configuration command before %s' % (alreadyUsed[0],loc,));
    repeated = [mems[ix] for ix in range(len(mems)-1) if mems[ix] in mems[ix+1:]];
    if repeated:
      raise SSBCCException('"%s" repeated in COMBINE configuration command on %s' % (repeated[0],loc,));
    # Count the number of the different memory types being combined and validate the combination.
    nSinglePort = sum([thisMemName in ('INSTRUCTION','DATA_STACK','RETURN_STACK',) for thisMemName in mems]);
    nROM = len([thisMemName for thisMemName in mems if self.IsROM(thisMemName)]);
    nRAM = len([thisMemName for thisMemName in mems if self.IsRAM(thisMemName)]);
    if nRAM > 0:
      nRAM += nROM;
      nROM = 0;
    if nROM > 0:
      nSinglePort += 1;
    nDualPort = 1 if nRAM > 0 else 0;
    if nSinglePort + 2*nDualPort > 2:
      raise SSBCCException('Too many ports required for COMBINE configuration command at %s' % loc);
    # Append the listed memory types to the list of combined memories.
    self.config['combine'].append({'mems':mems, 'memArch':'sync', 'loc':loc});
 
  def ProcessInport(self,loc,line):
    """
    Parse the "INPORT" configuration commands as follows:
      The configuration command is well formatted.
      The number of signals matches the corresponding list of signal declarations.
      The port name starts with 'I_'.
      The signal declarations are valid.
        n-bit where n is an integer
        set-reset
        strobe
      That no other signals are specified in conjunction with a "set-reset" signal.
      The total input data with does not exceed the maximum data width.\n
    The input port is appended to the list of inputs as a tuple.  The first
    entry in the tuple is the port name.  The subsequent entries are tuples
    consisting of the following:
      signal name
      signal width
      signal type
    """
    cmd = re.findall(r'\s*INPORT\s+(\S+)\s+(\S+)\s+(I_\w+)\s*$',line);
    if not cmd:
      raise SSBCCException('Malformed INPORT statement at %s: "%s"' % (loc,line[:-1],));
    modes = re.findall(r'([^,]+)',cmd[0][0]);
    names = re.findall(r'([^,]+)',cmd[0][1]);
    portName = cmd[0][2];
    if len(modes) != len(names):
      raise SSBCCException('Malformed INPORT configuration command -- number of options don\'t match on %s: "%s"' % (loc,line[:-1],));
    # Append the input signal names, mode, and bit-width to the list of I/Os.
    has__set_reset = False;
    nBits = 0;
    thisPort = (portName,);
    for ix in range(len(names)):
      if re.match(r'^\d+-bit$',modes[ix]):
        thisNBits = int(modes[ix][0:-4]);
        self.AddIO(names[ix],thisNBits,'input',loc);
        thisPort += ((names[ix],thisNBits,'data',),);
        nBits = nBits + thisNBits;
      elif modes[ix] == 'set-reset':
        has__set_reset = True;
        self.AddIO(names[ix],1,'input',loc);
        thisPort += ((names[ix],1,'set-reset',),);
        self.AddSignal('s_SETRESET_%s' % names[ix],1,loc);
      elif modes[ix] == 'strobe':
        self.AddIO(names[ix],1,'output',loc);
        thisPort += ((names[ix],1,'strobe',),);
      else:
        raise SSBCCException('Unrecognized INPORT signal type "%s"' % modes[ix]);
      if has__set_reset and len(names) > 1:
        raise SSBCCException('set-reset cannot be simultaneous with other signals in "%s"' % line[:-1]);
      if nBits > self.Get('data_width'):
        raise SSBCCException('Signal width too wide in "%s"' % line[:-1]);
    self.AddInport(thisPort,loc);
 
  def ProcessOutport(self,line,loc):
    """
    Parse the "OUTPORT" configuration commands as follows:
      The configuration command is well formatted.
      The number of signals matches the corresponding list of signal declarations.
      The port name starts with 'O_'.
      The signal declarations are valid.
        n-bit[=value]
        strobe
      The total output data with does not exceed the maximum data width.\n
    The output port is appended to the list of outports as a tuple.  The first
    entry in this tuple is the port name.  The subsequent entries are tuples
    consisting of the following:
      signal name
      signal width
      signal type
      initial value (optional)
    """
    cmd = re.findall(r'^\s*OUTPORT\s+(\S+)\s+(\S+)\s+(O_\w+)\s*$',line);
    if not cmd:
      raise SSBCCException('Malformed OUTPUT configuration command on %s: "%s"' % (loc,line[:-1],));
    modes = re.findall(r'([^,]+)',cmd[0][0]);
    names = re.findall(r'([^,]+)',cmd[0][1]);
    portName = cmd[0][2];
    if len(modes) != len(names):
      raise SSBCCException('Malformed OUTPORT configuration command -- number of widths/types and signal names don\'t match on %s: "%s"' % (loc,line[:-1],));
    # Append the input signal names, mode, and bit-width to the list of I/Os.
    nBits = 0;
    isStrobeOnly = True;
    thisPort = tuple();
    for ix in range(len(names)):
      if re.match(r'\d+-bit',modes[ix]):
        isStrobeOnly = False;
        a = re.match(r'(\d+)-bit(=\S+)?$',modes[ix]);
        if not a:
          raise SSBCCException('Malformed bitwith/bitwidth=initialization on %s:  "%s"' % (loc,modes[ix],));
        thisNBits = int(a.group(1));
        self.AddIO(names[ix],thisNBits,'output',loc);
        if a.group(2):
          thisPort += ((names[ix],thisNBits,'data',a.group(2)[1:],),);
        else:
          thisPort += ((names[ix],thisNBits,'data',),);
        nBits = nBits + thisNBits;
        self.config['haveBitOutportSignals'] = 'True';
      elif modes[ix] == 'strobe':
        self.AddIO(names[ix],1,'output',loc);
        thisPort += ((names[ix],1,'strobe',),);
      else:
        raise SSBCCException('Unrecognized OUTPORT signal type on %s: "%s"' % (loc,modes[ix],));
      if nBits > 8:
        raise SSBCCException('Signal width too wide on %s:  in "%s"' % (loc,line[:-1],));
    self.AddOutport((portName,isStrobeOnly,)+thisPort,loc);
 
  def ProcessPeripheral(self,loc,line):
    """
    Process the "PERIPHERAL" configuration command as follows:
      Validate the format of the configuration command.
      Find the peripheral in the candidate list of paths for peripherals.
      Execute the file declaring the peripheral.
        Note:  This is done since I couldn't find a way to "import" the
               peripheral.  Executing the peripheral makes its definition local
               to this invokation of the ProcessPeripheral function, but the
               object subsequently created retains the required functionality
               to instantiate the peripheral
      Go through the parameters for the peripheral and do the following for each:
        If the argument for the peripheral is the string "help", then print the
          docstring for the peripheral and exit.
        Append the parameter name and its argument to the list of parameters
          (use "None" as the argument if no argument was provided).
      Append the instantiated peripheral to the list of peripherals.
        Note:  The "exec" function dynamically executes the instruction to
               instantiate the peripheral and append it to the list of
               peripherals.
    """
    # Validate the format of the peripheral configuration command and the the name of the peripheral.
    cmd = re.findall(r'\s*PERIPHERAL\s+(\w+)\s*(.*)$',line);
    if not cmd:
      raise SSBCCException('Missing peripheral name in %s:  %s' % (loc,line[:-1],));
    peripheral = cmd[0][0];
    # Find and execute the peripheral Python script.
    # Note:  Because "execfile" and "exec" method are used to load the
    #        peripheral python script, the __file__ object is set to be this
    #        file, not the peripheral source file.
    for testPath in self.peripheralpaths:
      fullperipheral = os.path.join(testPath,'%s.py' % peripheral);
      if os.path.isfile(fullperipheral):
        break;
    else:
      raise SSBCCException('Peripheral "%s" not found' % peripheral);
    execfile(fullperipheral);
    # Convert the space delimited parameters to a list of tuples.
    param_list = list();
    for param_string in re.findall(r'(\w+="[^"]*"|\w+=\S+|\w+)\s*',cmd[0][1]):
      if param_string == "help":
        exec('helpmsg = %s.__doc__' % peripheral);
        if not helpmsg:
          raise SSBCCException('No help for peripheral %s is provided' % fullperipheral);
        print;
        print 'Help message for peripheral:  %s' % peripheral;
        print 'Located at:  %s' % fullperipheral;
        print;
        print helpmsg;
        raise SSBCCException('Terminated by "help" for peripheral %s' % peripheral);
      ix = param_string.find('=');
      if param_string.find('="') > 0:
        param_list.append((param_string[:ix],param_string[ix+2:-1],));
      elif param_string.find('=') > 0:
        param_list.append((param_string[:ix],param_string[ix+1:],));
      else:
        param_list.append((param_string,None));
    # Add the peripheral to the micro controller configuration.
    exec('self.peripheral.append(%s(fullperipheral,self,param_list,loc));' % peripheral);
 
  def Set(self,name,value):
    """
    Create or override the specified attribute in the ssbccConfig object.
    """
    self.config[name] = value;
 
  def SetMemoryBlock(self,name,value,errorInfo):
    """
    Set an attribute in the ssbccConfig object for the specified memory with
    the specified memory architecture.\n
    "value" must be a string with the format "\d+" or "\d+*\d+" where "\d+" is
    an integer.  The first format specifies a single memory with the stated
    size and the size must be a power of two.  The second format specified
    allocation of multiple memory blocks where the size is given by the first
    integer and must be a power of 2 and the number of blocks is given by the
    second integer and doesn't need to be a power of 2.
    """
    findStar = value.find('*');
    if findStar == -1:
      blockSize = int(value);
      nBlocks = 1;
    else:
      blockSize = int(value[0:findStar]);
      nBlocks = int(value[findStar+1:]);
    nbits_blockSize = int(round(math.log(blockSize,2)));
    if blockSize != 2**nbits_blockSize:
      raise SSBCCException('block size must be a power of 2 at %s: "%s"' % errorInfo);
    nbits_nBlocks = CeilLog2(nBlocks);
    self.Set(name, dict(
                   length=blockSize*nBlocks,
                   nbits=nbits_blockSize+nbits_nBlocks,
                   blockSize=blockSize,
                   nbits_blockSize=nbits_blockSize,
                   nBlocks=nBlocks,
                   nbits_nBlocks=nbits_nBlocks));
 
  def SetMemoryParameters(self,memParam,values):
    """
    Record the body of the specified memory based on the assembler output.
    """
    index = memParam['index'];
    for field in values:
      if field not in self.memories:
        self.memories[field] = list();
        for ix in range(len(self.memories['name'])):
          self.memories[field].append(None);
      self.memories[field][index] = values[field];
 
  def SignalLengthList(self):
    """
    Generate a list of the I/O signals and their lengths.
    """
    outlist = list();
    for io in self.ios:
      if io[2] == 'comment':
        continue;
      outlist.append((io[0],io[1],));
    return outlist;

Line No.	Rev	Author	Line
1	12	sinclairrf	`# Copyright 2012-2015, Sinclair R.F., Inc.`
2			`# Utilities required by ssbcc.`
3	2	sinclairrf
4			`import math`
5			`import os`
6			`import re`
7			`import sys`
8
9	12	sinclairrf	`from ssbccPeripheral import SSBCCinterruptPeripheral`
10	2	sinclairrf	`from ssbccUtil import *`
11
12			`class SSBCCconfig():`
13			`"""`
14			`Container for ssbcc configuration commands, the associated parsing, and`
15			`program generation.`
16			`"""`
17
18			`def __init__(self):`
19			`"""`
20			`Initialize the empty dictionaries holding the processor configuration`
21			`parameters. Initialize the paths to search for peripherals.`
22			`"""`
23			`self.config = dict(); # various settings, etc.`
24			`self.constants = dict(); # CONSTANTs`
25	9	sinclairrf	`self.defines = dict(); # defines`
26	2	sinclairrf	`self.functions = dict(); # list of functions to define`
27			`self.inports = list(); # INPORT definitions`
28			`self.ios = list(); # List of I/Os`
29			`self.outports = list(); # OUTPORT definitions (see AddOutport)`
30			`self.parameters = list(); # PARAMETERs and LOCALPARAMs`
31			`self.peripheral = list(); # PERIPHERALs`
32			`self.signals = list(); # internal signals`
33			`self.symbols = list(); # constant, I/O, inport, etc. names`
34
35			`# list of memories`
36			`self.memories = dict(name=list(), type=list(), maxLength=list());`
37
38			`# list of how the memories will be instantiated`
39			`self.config['combine'] = list();`
40
41	3	sinclairrf	`# initial search path for .INCLUDE configuration commands`
42			`self.includepaths = list();`
43			`self.includepaths.append('.');`
44
45	2	sinclairrf	`# initial search paths for peripherals`
46	3	sinclairrf	`self.peripheralpaths = list();`
47	2	sinclairrf	`self.peripheralpaths.append('.');`
48			`self.peripheralpaths.append('peripherals');`
49			`self.peripheralpaths.append(os.path.join(sys.path[0],'core/peripherals'));`
50
51			`def AddConstant(self,name,value,loc):`
52			`"""`
53			`Add the constant for the "CONSTANT" configuration command to the "constants"`
54			`dictionary.\n`
55			`name symbol for the constant`
56			`value value of the constant`
57			`loc file name and line number for error messages`
58			`"""`
59			`self.AddSymbol(name,loc);`
60			`if name in self.constants:`
61			`raise SSBCCException('CONSTANT "%s" already declared at %s' % (name,loc,));`
62	12	sinclairrf	`if not ((type(value) == int) or IsIntExpr(value)):`
63	8	sinclairrf	`raise SSBCCException('Could not evaluate expression "%s" for constant at %s' % (value,loc,));`
64			`self.constants[name] = ParseIntExpr(value);`
65	2	sinclairrf
66	9	sinclairrf	`def AddDefine(self,name):`
67			`"""`
68			`Add the defined symbol.\n`
69			`name name for the symbol (must start with "D_")\n`
70			`Note: This is only invoked for the command line arguments so there is no`
71			`"loc" available.\n`
72			`Note: Defines can be declared more than once on the command line with no`
73			`ill effects.`
74			`"""`
75			`if not self.IsDefine(name):`
76			`self.AddSymbol(name);`
77			`self.defines[name] = 1;`
78
79	2	sinclairrf	`def AddIO(self,name,nBits,iotype,loc):`
80			`"""`
81			`Add an I/O signal to the processor interface to the system.\n`
82			`name name of the I/O signal`
83			`nBits number of bits in the I/O signal`
84			`iotype signal direction: "input", "output", or "inout"`
85			`"""`
86			`if iotype != 'comment':`
87			`self.AddSymbol(name,loc);`
88			`self.ios.append((name,nBits,iotype,));`
89
90			`def AddInport(self,port,loc):`
91			`"""`
92			`Add an INPORT symbol to the processor.\n`
93			`port name of the INPORT symbol`
94			`loc file name and line number for error messages`
95			`"""`
96			`name = port[0];`
97			`self.AddSymbol(name,loc);`
98			`self.inports.append(port);`
99
100			`def AddMemory(self,cmd,loc):`
101			`"""`
102			`Add a memory to the list of memories.\n`
103			`cmd 3-element list as follows:`
104			`[0] ==> type: "RAM" or "ROM"`
105			`[1] ==> memory name`
106			`[2] ==> memory length (must be a power of 2)`
107			`loc file name and line number for error messages`
108			`"""`
109			`self.memories['type'].append(cmd[0]);`
110			`self.memories['name'].append(cmd[1]);`
111			`maxLength = eval(cmd[2]);`
112			`if not IsPowerOf2(maxLength):`
113			`raise SSBCCException('Memory length must be a power of 2, not "%s", at %s' % (cmd[2],loc,));`
114			`self.memories['maxLength'].append(eval(cmd[2]));`
115
116			`def AddOutport(self,port,loc):`
117			`"""`
118			`Add an OUTPORT symbol to the processor.\n`
119			`port tuple as follows:`
120			`port[0] - name of the OUTPORT symbol`
121	12	sinclairrf	`port[1] - True if the outport is a strobe-only outport, False`
122	2	sinclairrf	`otherwise`
123			`port[2:] - zero or more tuples as follows:`
124			`(o_signal,width,type,[initialization],)`
125			`where`
126			`o_signal is the name of the output signal`
127			`width is the number of bits in the signal`
128			`type is 'data' or 'strobe'`
129			`initialization is an optional initial/reset value for the`
130			`output signal`
131			`loc file name and line number for error messages`
132			`"""`
133			`self.AddSymbol(port[0],loc);`
134			`self.outports.append(port);`
135
136			`def AddParameter(self,name,value,loc):`
137			`"""`
138			`Add a PARAMETER to the processor.\n`
139			`name name of the PARAMETER`
140			`value value of the PARAMETER`
141			`loc file name and line number for error messages`
142			`"""`
143			`if not re.match(r'[LG]_\w+$',name):`
144			`raise Exception('Program Bug -- bad parameter name at %s' % loc);`
145			`self.AddSymbol(name,loc);`
146			`self.parameters.append((name,value,));`
147
148			`def AddSignal(self,name,nBits,loc):`
149			`"""`
150			`Add a signal without an initial value to the processor.\n`
151			`name name of the signal`
152			`nBits number of bits in the signal`
153			`loc file name and line number for error messages`
154			`"""`
155			`self.AddSymbol(name,loc);`
156			`self.signals.append((name,nBits,));`
157
158			`def AddSignalWithInit(self,name,nBits,init,loc):`
159			`"""`
160			`Add a signal with an initial/reset value to the processor.\n`
161			`name name of the signal`
162			`nBits number of bits in the signal`
163			`init initial/reset value of the signal`
164			`loc file name and line number for error messages`
165			`"""`
166			`self.AddSymbol(name,loc);`
167			`self.signals.append((name,nBits,init,));`
168
169			`def AddSymbol(self,name,loc=None):`
170			`"""`
171			`Add the specified name to the list of symbols.\n`
172			`Note: This symbol has no associated functionality and is only used for`
173			`".ifdef" conditionals.`
174			`"""`
175			`if name in self.symbols:`
176			`if loc == None:`
177			`raise SSBCCException('Symbol "%s" already defined, no line number provided');`
178			`else:`
179			`raise SSBCCException('Symbol "%s" already defined before %s' % (name,loc,));`
180			`self.symbols.append(name);`
181
182	3	sinclairrf	`def AppendIncludePath(self,path):`
183			`"""`
184			`Add the specified path to the end of the paths to search for .INCLUDE`
185			`configuration commands.\n`
186			`path path to add to the list`
187			`"""`
188			`self.includepaths.insert(-1,path);`
189
190	2	sinclairrf	`def CompleteCombines(self):`
191			`"""`
192			`Ensure all memories are assigned addresses.\n`
193			`This modifies config['combine'] to include singleton entries for any`
194			`memories not subject to the COMBINE configuration command. It then computes`
195			`how the memories will be packed together as well as properites for the`
196			`packed memories. These properties are:`
197			`packing how the memories will be packed as per PackCombinedMemory`
198			`memName HDL name of the memory`
199			`memLength number of words in the memory`
200			`memWidth bit width of the memory words`
201			`"""`
202			`# Create singleton entries for memory types and memories that aren't already listed in 'combine'.`
203			`if not self.IsCombined('INSTRUCTION'):`
204			`self.config['combine'].append({'mems':['INSTRUCTION',], 'memArch':'sync'});`
205			`for memType in ('DATA_STACK','RETURN_STACK',):`
206			`if not self.IsCombined(memType):`
207			`self.config['combine'].append({'mems':[memType,], 'memArch':'LUT'});`
208			`for memName in self.memories['name']:`
209			`if not self.IsCombined(memName):`
210			`self.config['combine'].append({'mems':[memName,], 'memArch':'LUT'});`
211			`# Determine the HDL names for the memories.`
212			`nRAMROMs = 0;`
213			`for combined in self.config['combine']:`
214			`if combined['mems'][0] == 'INSTRUCTION':`
215			`combined['memName'] = 's_opcodeMemory';`
216			`elif combined['mems'][0] == 'DATA_STACK':`
217			`combined['memName'] = 's_data_stack';`
218			`elif combined['mems'][0] == 'RETURN_STACK':`
219			`combined['memName'] = 's_R_stack';`
220			`else:`
221			`nRAMROMs += 1;`
222			`if nRAMROMs > 0:`
223			`memNameFormat = 's_mem_%%0%dx' % ((CeilLog2(nRAMROMs)+3)/4);`
224			`ixRAMROM = 0;`
225			`for combined in self.config['combine']:`
226			`if 'memName' in combined:`
227			`continue;`
228			`if nRAMROMs == 1:`
229			`combined['memName'] = 's_mem';`
230			`else:`
231			`combined['memName'] = memNameFormat % ixRAMROM;`
232			`ixRAMROM += 1;`
233			`# Perform packing for all memories.`
234			`for combined in self.config['combine']:`
235			`self.PackCombinedMemory(combined);`
236
237			`def Exists(self,name):`
238			`"""`
239			`Return true if the requested attribute has been created in the ssbccConfig`
240			`object.`
241			`"""`
242			`return name in self.config;`
243
244			`def Get(self,name):`
245			`"""`
246			`Return the requested attribute from the ssbccConfig object.`
247			`"""`
248			`if not self.Exists(name):`
249			`raise Exception('Program Bug: "%s" not found in config' % name);`
250			`return self.config[name];`
251
252			`def GetMemoryByBank(self,ixBank):`
253			`"""`
254			`Return the parameters for a memory by its bank address.\n`
255			`ixBank index of the requested memory bank`
256			`"""`
257			`if not 'bank' in self.memories:`
258			`return None;`
259			`if ixBank not in self.memories['bank']:`
260			`return None;`
261			`ixMem = self.memories['bank'].index(ixBank);`
262			`return self.GetMemoryParameters(ixMem);`
263
264			`def GetMemoryByName(self,name):`
265			`"""`
266			`Return the parameters for a memory by its name.\n`
267			`name name of the requested memory`
268			`"""`
269			`if not name in self.memories['name']:`
270			`return None;`
271			`ixMem = self.memories['name'].index(name);`
272			`return self.GetMemoryParameters(ixMem);`
273
274			`def GetMemoryParameters(self,rawIndex):`
275			`"""`
276			`Return the parameters for a memory by its index in the list of memories.\n`
277			`rawIndex index within the list of memories`
278			`"""`
279			`if type(rawIndex) == str:`
280			`if not self.IsMemory(rawIndex):`
281			`raise Exception('Program Bug: reference to non-existent memory');`
282			`ix = self.memories['name'].index(rawIndex);`
283			`elif type(rawIndex) == int:`
284			`if (rawIndex < 0) or (rawIndex >= len(self.memories['name'])):`
285			`raise Exception('Program Bug: bad memory index %d' % rawIndex);`
286			`ix = rawIndex;`
287			`else:`
288			`raise Exception('Program Bug: unrecognized index type "%s"' % type(rawIndex));`
289			`outvalue = dict();`
290			`outvalue['index'] = ix;`
291			`for field in self.memories:`
292			`outvalue[field] = self.memories[field][ix];`
293			`return outvalue;`
294
295			`def GetPacking(self,name):`
296			`"""`
297			`Get the memory packing for the provided memory.`
298			`"""`
299			`for combined in self.config['combine']:`
300			`if name not in combined['mems']:`
301			`continue;`
302			`for port in combined['port']:`
303			`for packing in port['packing']:`
304			`if packing['name'] == name:`
305			`return (combined,port,packing,);`
306			`else:`
307			`raise Exception('Program Bug -- %s not found in combined memories' % name);`
308
309			`def GetParameterValue(self,name):`
310			`"""`
311			`Get the value associated with the named parameter.`
312			`"""`
313			`if name.find('[') != -1:`
314			`ix = name.index('[');`
315			`thisSlice = name[ix:];`
316			`name = name[:ix];`
317			`else:`
318			`thisSlice = '[0+:8]';`
319			`for ix in range(len(self.parameters)):`
320			`if self.parameters[ix][0] == name:`
321	3	sinclairrf	`return ExtractBits(IntValue(self.parameters[ix][1]),thisSlice);`
322	2	sinclairrf	`else:`
323			`raise Exception('Program Bug: Parameter "%s" not found' % name);`
324
325			`def InsertPeripheralPath(self,path):`
326			`"""`
327			`Add the specified path to the beginning of the paths to search for`
328			`peripherals.\n`
329			`path path to add to the list`
330			`"""`
331			`self.peripheralpaths.insert(-1,path);`
332
333	12	sinclairrf	`def InterruptVector(self):`
334			`"""`
335			`Indicate whether or not interrupts have been enabled and, if so, what the`
336			`interrupt address is.\n`
337			`Note: The interrupt address cannot be zero because .main starts at address`
338
339			`Note: Returning "None" when there is not interrupt address ensures both a`
340			`"False" evaluation and that the value cannot be turned into an`
341			`integer for an address.`
342			`"""`
343			`if not self.Exists('interruptAddress'):`
344			`return None;`
345			`else:`
346			`return self.Get('interruptAddress');`
347
348	2	sinclairrf	`def IsCombined(self,name):`
349			`"""`
350			`Indicate whether or not the specified memory type has already been listed`
351			`in a "COMBINE" configuration command. The memory type should be one of`
352			`DATA_STACK, INSTRUCTION, or RETURN_STACK.\n`
353			`name name of the specified memory type\n`
354			`"""`
355			`for combined in self.config['combine']:`
356			`if name in combined['mems']:`
357			`return True;`
358			`else:`
359			`return False;`
360
361	4	sinclairrf	`def IsConstant(self,name):`
362			`"""`
363			`Indicate whether or not the specified symbol is a recognized constant.`
364			`"""`
365			`if re.match(r'C_\w+$',name) and name in self.constants:`
366			`return True;`
367			`else:`
368			`return False;`
369
370	9	sinclairrf	`def IsDefine(self,name):`
371			`"""`
372			`Indicate whether or not the specified symbol is a recognized define.`
373			`"""`
374			`if re.match(r'D_\w+$',name) and name in self.defines:`
375			`return True;`
376			`else:`
377			`return False;`
378
379	2	sinclairrf	`def IsMemory(self,name):`
380			`"""`
381			`Indicate whether or not the specified symbol is the name of a memory.`
382			`"""`
383			`return (name in self.memories['name']);`
384
385			`def IsParameter(self,name):`
386			`"""`
387			`Indicate whether or not the specified symbol is the name of a parameter.`
388			`"""`
389	4	sinclairrf	`if re.match(r'[GL]_\w+$',name) and name in self.symbols:`
390	2	sinclairrf	`return True;`
391			`else:`
392			`return False;`
393
394			`def IsRAM(self,name):`
395			`"""`
396			`Indicate whether or not the specified symbol is the name of a RAM.`
397			`"""`
398			`if name not in self.memories['name']:`
399			`return False;`
400			`ix = self.memories['name'].index(name);`
401			`return self.memories['type'][ix] == 'RAM';`
402
403			`def IsROM(self,name):`
404			`"""`
405			`Indicate whether or not the specified symbol is the name of a RAM.`
406			`"""`
407			`if name not in self.memories['name']:`
408			`return False;`
409			`ix = self.memories['name'].index(name);`
410			`return self.memories['type'][ix] == 'ROM';`
411
412			`def IsStrobeOnlyOutport(self,outport):`
413			`"""`
414			`Indicate whether or not the specified outport symbol only has strobes`
415			`associated with it (i.e., it has no data signals).`
416			`"""`
417			`return outport[1];`
418
419			`def IsSymbol(self,name):`
420			`"""`
421			`Indicate whether or not the specified name is a symbol.`
422			`"""`
423			`return (name in self.symbols);`
424
425			`def MemoryNameLengthList(self):`
426			`"""`
427			`Return a list of tuples where each tuple is the name of a memory and its`
428			`length.`
429			`"""`
430			`outlist = list();`
431			`for ix in range(len(self.memories['name'])):`
432			`outlist.append((self.memories['name'][ix],self.memories['maxLength'][ix],));`
433			`return outlist;`
434
435			`def NInports(self):`
436			`"""`
437			`Return the number of INPORTS.`
438			`"""`
439			`return len(self.inports);`
440
441			`def NMemories(self):`
442			`"""`
443			`Return the number of memories.`
444			`"""`
445			`return len(self.memories['name']);`
446
447			`def NOutports(self):`
448			`"""`
449			`Return the number of OUTPORTS.`
450			`"""`
451			`return len(self.outports);`
452
453			`def OverrideParameter(self,name,value):`
454			`"""`
455			`Change the value of the specified parameter (based on the command line`
456			`argument instead of the architecture file).\n`
457			`name name of the parameter to change`
458			`value new value of the parameter`
459			`"""`
460			`for ix in range(len(self.parameters)):`
461			`if self.parameters[ix][0] == name:`
462			`break;`
463			`else:`
464			`raise SSBCCException('Command-line parameter or localparam "%s" not specified in the architecture file' % name);`
465			`self.parameters[ix] = (name,value,);`
466
467			`def PackCombinedMemory(self,combined):`
468			`"""`
469			`Utility function for CompleteCombines.\n`
470			`Determine packing strategy and resulting memory addresses and sizes. This`
471			`list has everything ssbccGenVerilog needs to construct the memory.\n`
472			`The dual port memories can be used to do the following:`
473			`1. pack a single memory, either single-port or dual-port`
474			`2. pack two single-port memories sequentially, i.e., one at the start of`
475			`the RAM and one toward the end of the RAM`
476			`3. pack one single-port memory at the start of the RAM and pack several`
477			`compatible single-port memories in parallel toward the end of the RAM.`
478			`Note: Compatible means that they have the same address.`
479			`4. pack several compatible dual-port memories in parallel.\n`
480			`These single-port or dual-port single or parallel packed memories are`
481			`described in the 'port' list in combined. Each entry in the port list has`
482			`several parameters described below and a 'packing' list that describes the`
483			`single or multiple memories attached to that port.\n`
484			`The parameters for each of port is as follows:`
485			`offset start address of the memory in the packing`
486			`nWords number of RAM words reserved for the memory`
487			`Note: This can be larger than the aggregate number of words`
488			`required by the memory in order to align the memories to`
489			`power-of-2 address alignments.`
490			`ratio number of base memory entries for the memory`
491			`Note: This must be a power of 2.\n`
492			`The contents of each entry in the packing are as follows:`
493			`-- the following are from the memory declaration`
494			`name memory name`
495			`length number of elements in the memory based on the declared memory`
496			`size`
497			`Note: This is based on the number of addresses required for`
498			`each memory entry (see ratio).`
499			`nbits width of the memory type`
500			`-- the following are derived for the packing`

Browse

Tools

Subversion Repositories ssbcc

[/] [ssbcc/] [trunk/] [ssbccConfig.py] - Blame information for rev 12