LATconstants.py

Go to the documentation of this file.

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

__facility__ = "Online"
__abstract__ = "LAT related constants"
__author__   = "S. Tuvi <Stuvi@SLAC.Stanford.edu> SLAC - GLAST LAT I&T/Online"
__date__     = "2005/12/20 00:00:00"
__updated__  = "$Date: 2006/03/07 23:10:14 $"
__version__  = "$Revision: 1.8 $"
__release__  = "$Name: HEAD $"
__credits__  = "SLAC"

import LICOS.copyright_SLAC

import os

## Online root environment variable
ONLINE_ROOT_ENV = "ONLINE_ROOT"

## Online root path prefix
ONLINE_ROOT = os.environ[ONLINE_ROOT_ENV]

## LICOS Scripts root path
LICOS_SCRIPTS_ROOT = "LICOS_Scripts"

## LICOS Config root path
LICOS_CONFIG_ROOT = "LICOS_Config"

## Root directories relative to $ONLINE_ROOT
ROOT_DIRS = ['LICOS', LICOS_SCRIPTS_ROOT, LICOS_CONFIG_ROOT]

## Number of towers
N_TOWERS      = 16

## Number of ACD free boards
N_FREE_BOARDS = 12

## Base directory where LICOS_Config package is located
LICOS_CONFIG_BASE = os.path.expandvars("$%s/%s" % (ONLINE_ROOT_ENV, LICOS_CONFIG_ROOT))

## Directory where LHK configuration files are located
LICOS_CONFIG_LHK  = os.path.join(LICOS_CONFIG_BASE, "lhk")

## Directory where script configuration files are located
LICOS_CONFIG_APPS = os.path.join(LICOS_CONFIG_BASE, "apps")

## Base directory where LICOS_Scripts package is located
LICOS_SCRIPTS_BASE = os.path.expandvars("$%s/%s" % (ONLINE_ROOT_ENV, LICOS_SCRIPTS_ROOT))

## XSL style sheet used in the generation of test reports
LICOS_TEST_REPORT_XSL = os.path.join(LICOS_SCRIPTS_BASE, "lib/reportStyle.xsl")

## Prefix for the XML version of the rcReport.out generated by the pipeline
# Deprecated, the pipeline changes the prefix too frequently.
# LICOS_Scripts should use the rcReport.xml soft link that is created by the pipeline
#PIPELINE_RUN_REPORT_PREFIX = 'updateELogDB-licos-v3r5p1'
PIPELINE_RUN_REPORT_PREFIX = ''

# enums from FILE traveler document.  Used in FILE and LFS commands
## Boot device enum
FSW_DEVICE_BOOT  = 0
## RAM disk device enum
FSW_DEVICE_RAM   = 1
## SIB EEPROM partition 0 enum
FSW_DEVICE_EE0   = 2
## SIB EEPROM partition 1 enum
FSW_DEVICE_EE1   = 3
## Host temp file system enum
FSW_DEVICE_TMP   = 4
## User-defined device 0 enum
FSW_DEVICE_USR0  = 5
## User-defined device 1 enum
FSW_DEVICE_USR1  = 6
## Device names used in directory listings
FSW_DEVICE_NAMES = ["boot", "ram", "ee0", "ee1", "tmp", "usr0", "usr1"  ]
## SIU unit enum
FSW_UNIT_SIU     = 0
## EPU 0 unit enum
FSW_UNIT_EPU0    = 1
## EPU 1 unit enum
FSW_UNIT_EPU1    = 2
## EPU 2 unit enum
FSW_UNIT_EPU2    = 3
## EPU 3 unit enum
FSW_UNIT_EPU3    = 4
## Unit names used in directory listings
FSW_UNIT_NAMES = [ 'SIU', 'EPU0', 'EPU1', 'EPU2', 'EPU3' ]
## FSW allowed directory range, [FSW_GUIDE], 5.2.2, fig 5
FSW_DIR_RANGE = range(0,111)
## ROOT directory = 127 : [FSW_GUIDE], 5.2.2, in text.
FSW_DIR_ROOT  = 0x7f

# Following enums from http://www.slac.stanford.edu/exp/glast/flight/web/a_cat/prod/WOC/hide/MEM/cmd/LMEMDUMPMEM/00a__F.CDEST-dest.shtml
## FSW 1553 destination enum.  Used in LMEMDUMPMEM
FSW_DEST_1553 = 0
## FSW SSR destination enum.  Used in LMEMDUMPMEM
FSW_DEST_SSR  = 1
## FSW destination names
FSW_DEST_NAMES = ['1553', 'SSR ']

# memory pool enums from MEM user manual Traveler
## FSW System memory pool
FSW_POOL_SYSTEM = 0
## FSW Application memory pool
FSW_POOL_APPLICATION = 1


# Comments from MEMMGT_001.py from FSW:
# 0x00300000 - 0x00C00000 is the RAM address space that is initialized by PBC.
# 0x00010000 - 0x00300000 is RAM address space that is not used by RTOS in SBC.
## Start of PBC memory address space
RAM_PBC_START = 0x00300000
## End of PBC memory address space
RAM_PBC_STOP  = 0x00C00000
## Start of SBC memory address space
RAM_SBC_START = 0x00010000
## End of SBC memory address space
RAM_SBC_STOP  = 0x00300000
## Start of SUROM memory address space
MEM_SUROM_START = 0xFFF00000
## End of SUROM memory address space
MEM_SUROM_STOP  = 0xFFF40000

# As per verbal agreement with Tony Waite (051108) INT can have
#   directories 8-15 for it's own use.  Note:  Any directory > 15
#   needs to be created
## LATC configuration file directory
INT_DIR_LATC     = 10
## LCI configuration file directory
INT_DIR_LCI      = 11
## LHK configuration file directory
INT_DIR_LHK      = 13

## Standard Command/Response timeout
STANDARD_TIMEOUT = 60
## Long Command/response timeout
LONG_TIMEOUT     = 3*STANDARD_TIMEOUT
## Short Command/Response timeout
SHORT_TIMEOUT    = 3

## standard LAT epoch, '2001-01-01 00:00:00'
LAT_EPOCH        = 978307200

---