VxWorks BSP Reference : wrScout

sysLib [wrScout]

NAME

sysLib [wrScout] - system-dependent library: Motorola 75x/7400 with 8260 Scout

ROUTINES

environ( ) - environment pointer
sysLocalToBusAdrs( ) - convert a local address to a bus address
sysBusToLocalAdrs( ) - convert a bus address to a local address
sysBusIntAck( ) - acknowledge a bus interrupt
sysBusIntGen( ) - generate a bus interrupt
sysMailboxConnect( ) - connect a routine to the mailbox interrupt
sysMailboxEnable( ) - enable the mailbox interrupt
sysBusTas( ) - test and set a location across the bus
m8260IntrInit( ) - initialize the interrupt manager for the PowerPC 8260
m8260IntEnable( ) - enable the indicated interrupt
m8260IntDisable( ) - Disable one of the Level or IRQ interrupts into the SIU
m8260IvecToInum( ) - get the relevant interrupt number
m82xxDpramLibInit( ) - init DPRAM memory allocation driver
m82xxDpramMalloc( ) - allocate memory from DPRAM main pool
m82xxDpramAlignedMalloc( ) - allocate aligned memory from DPRAM main pool
m82xxDpramFree( ) - free allocated memory from DPRAM main pool
m82xxDpramFccMalloc( ) - allocate memory from DPRAM FCC special pool
m82xxDpramFccFree( ) - free allocated memory from DPRAM FCC special pool
sysSerialHwInit( ) - initialize the BSP serial devices to a quiesent state
sysSerialHwInit2( ) - connect BSP serial device interrupts
sysSerialChanGet( ) - get the SIO_CHAN device associated with a serial channel
sysSerialReset( ) - reset the serail device
m8260SioDevInit( ) - initialize the SCC
m8260SioResetChannel( ) - initialize an SCC channel
m8260SioInt( ) - handle an SCC interrupt
sysClkConnect( ) - connect a routine to the system clock interrupt
sysClkEnable( ) - turn on system clock interrupts
sysClkDisable( ) - turn off system clock interrupts
sysClkRateGet( ) - get the system clock rate
sysClkRateSet( ) - set the system clock rate
sysAuxClkConnect( ) - connect a routine to the auxiliary clock interrupt
sysAuxClkDisable( ) - turn off auxiliary clock interrupts
sysAuxClkEnable( ) - turn on auxiliary clock interrupts
sysAuxClkRateGet( ) - get the auxiliary clock rate
sysAuxClkRateSet( ) - set the auxiliary clock rate
sysTimestampConnect( ) - connect a user routine to the timestamp timer interrupt
sysTimestampEnable( ) - initialize and enable the timestamp timer
sysTimestampDisable( ) - turn off auxiliary clock interrupts
sysTimestampPeriod( ) - get the period of a timestamp timer
sysTimestampFreq( ) - get a timestamp timer clock frequency
sysTimestamp( ) - get a timestamp timer tick count
sysTimestampLock( ) - lock interrupts and get the timestamp timer tick count
sysNvRamGet( ) - get the contents of non-volatile RAM
sysNvRamSet( ) - write to non-volatile RAM
sysCacheLock( ) - locks specified data/instruction region
sysCacheUnlock( ) - Unlocks the previous locked cache
sysMotFccEndLoad( ) - load an istance of the motFccEnd driver
sysFccEnetEnable( ) - enable the MII interface to the FCC controller
sysFccEnetDisable( ) - disable MII interface to the FCC controller
sysFccEnetAddrGet( ) - get the hardware Ethernet address
sysFccEnetCommand( ) - issue a command to the Ethernet interface controller
sysFccMiiBitWr( ) - write one bit to the MII interface
sysFccMiiBitRd( ) - read one bit from the MII interface
sysMiiOptRegsHandle( ) - handle some MII optional registers
sysCheckIfVware( ) - check if we were lunched by vWARE
sysAltivecProbe( ) - Check if the CPU has ALTIVEC unit.
sysModel( ) - return the model name of the CPU board
sysBspRev( ) - return the bsp version with the revision eg 1.2/x
sysHwInit( ) - initialize the system hardware
sysPhysMemTop( ) - get the address of the top of physical memory
sysMemTop( ) - get the address of the top of VxWorks memory
sysToMonitor( ) - transfer control to the ROM monitor
sysHwInit2( ) - additional system configuration and initialization
sysProcNumGet( ) - get the processor number
sysProcNumSet( ) - set the processor number
vxImmrSet( ) - Set the IMMR to a specific value
vxImmrGet( ) - return the current IMMR value
sysInputFreqGet( ) - determines the Input Oscillator clock frequency
sysBaudClkFreq( ) - Obtains frequency of the BRG_CLK in HZ
sysCpuCheck( ) - confirm the CPU type

DESCRIPTION

This library provides board-specific routines. The chip drivers included are:

SEE ALSO

VxWorks Programmer's Guide: Configuration


wrScout : Routines

environ( )

NAME

environ( ) - environment pointer

SYNOPSIS

extern STATUS envLibInit
    (
    BOOL installHooks
    )

DESCRIPTION

The following macro is provided for code that manipulates the environment variable array directly.

SEE ALSO

sysLib


wrScout : Routines

sysLocalToBusAdrs( )

NAME

sysLocalToBusAdrs( ) - convert a local address to a bus address

SYNOPSIS

STATUS sysLocalToBusAdrs
    (
    int    adrsSpace,         /* bus address space in which busAdrs */
                              /* resides, use address modifier codes defined */
                              /* in vme.h, such as VME_AM_STD_SUP_DATA */ 
    char * localAdrs,         /* local address to convert */
    char * *pBusAdrs          /* where to return bus address */
    )

DESCRIPTION

This routine gets the VMEbus address that accesses a specified local memory address.

NOTE

This routine has no effect, since there is no VMEbus.

RETURNS

ERROR, always.

SEE ALSO

sysLib, sysBusToLocalAdrs( )


wrScout : Routines

sysBusToLocalAdrs( )

NAME

sysBusToLocalAdrs( ) - convert a bus address to a local address

SYNOPSIS

STATUS sysBusToLocalAdrs
    (
    int    adrsSpace,         /* bus address space in which busAdrs */
                              /* resides, use address modifier codes defined */
                              /* in vme.h, such as VME_AM_STD_SUP_DATA */ 
    char * busAdrs,           /* bus address to convert */
    char * *pLocalAdrs        /* where to return local address */
    )

DESCRIPTION

This routine gets the local address that accesses a specified VMEbus address.

NOTE

This routine has no effect, since there is no VMEbus.

RETURNS

ERROR, always.

SEE ALSO

sysLib, sysLocalToBusAdrs( )


wrScout : Routines

sysBusIntAck( )

NAME

sysBusIntAck( ) - acknowledge a bus interrupt

SYNOPSIS

int sysBusIntAck
    (
    int intLevel              /* interrupt level to acknowledge */
    )

DESCRIPTION

This routine acknowledges a specified VMEbus interrupt level.

NOTE

This routine has no effect, since there is no VMEbus.

RETURNS

NULL.

SEE ALSO

sysLib


wrScout : Routines

sysBusIntGen( )

NAME

sysBusIntGen( ) - generate a bus interrupt

SYNOPSIS

STATUS sysBusIntGen
    (
    int level,                /* bus interrupt level to generate */
    int vector                /* interrupt vector to return (0-255) */
    )

DESCRIPTION

This routine generates a VMEbus interrupt for a specified level with a specified vector.

NOTE

This routine has no effect, since there is no VMEbus.

RETURNS

ERROR, always.

SEE ALSO

sysLib


wrScout : Routines

sysMailboxConnect( )

NAME

sysMailboxConnect( ) - connect a routine to the mailbox interrupt

SYNOPSIS

STATUS sysMailboxConnect
    (
    FUNCPTR routine,          /* routine called at each mailbox interrupt */
    int     arg               /* argument with which to call routine */
    )

DESCRIPTION

This routine specifies the interrupt service routine to be called at each mailbox interrupt.

NOTE

This routine has no effect, since the hardware does not support mailbox interrupts.

RETURNS

ERROR, always.

SEE ALSO

sysLib, sysMailboxEnable( )


wrScout : Routines

sysMailboxEnable( )

NAME

sysMailboxEnable( ) - enable the mailbox interrupt

SYNOPSIS

STATUS sysMailboxEnable
    (
    INT8 * mailboxAdrs        /* mailbox address */
    )

DESCRIPTION

This routine enables the mailbox interrupt.

NOTE

This routine has no effect, since the hardware does not support mailbox interrupts.

RETURNS

ERROR, always.

SEE ALSO

sysLib, sysMailboxConnect( )


wrScout : Routines

sysBusTas( )

NAME

sysBusTas( ) - test and set a location across the bus

SYNOPSIS

BOOL sysBusTas
    (
    INT8 * addr               /* address to be tested and set */
    )

DESCRIPTION

This routine performs a test-and-set (TAS) instruction across the backplane.

NOTE

This routine is equivalent to vxTas( ), since there is no VMEbus.

RETURNS

TRUE if the value had not been set but is now, or FALSE if the value was set already.

SEE ALSO

sysLib, vxTas( )


wrScout : Routines

m8260IntrInit( )

NAME

m8260IntrInit( ) - initialize the interrupt manager for the PowerPC 8260

SYNOPSIS

STATUS m8260IntrInit ()

DESCRIPTION

This routine connects the default demultiplexer, m8260IntrDeMux( ), to the external interrupt vector and associates all interrupt sources with the default interrupt handler. This routine is called by sysHwInit( ) in sysLib.c.

NOTE

All interrupt from the SIU unit are enabled, CICR is setup so that SCC1 has the highest relative interrupt priority, through SCC4 with the lowest.

RETURN

OK always

SEE ALSO

sysLib


wrScout : Routines

m8260IntEnable( )

NAME

m8260IntEnable( ) - enable the indicated interrupt

SYNOPSIS

int m8260IntEnable
    (
    int intNum                /* interrupt level to enable */
    )

DESCRIPTION

This routine will enable the indicated interrupt by setting the appropriate bit in the SIU Interrupt Mask Registers.

The design of the 8260 presents the following design requirements:

1. the mapping from interrupt number to mask bit can not be represented by
   a function. An array, indexed by interrupt number (INUM), is used to map
   the interrupt number to the appropriate mask. 

2. There are two 32 bit mask registers (SIMR_L and SIMR_H). The interrupt
   number must be compared to 4 ranges to determine which register contains
   its mask bit:

  interrupt number
  in m8260IntrCtl.h       register
  ----------------        -------
  0-15                    SIMR_L
  16-31                   SIMR_H
  32-47                   SIMR_L
  48-63                   SIMR_H

RETURNS

0, always.

SEE ALSO

sysLib


wrScout : Routines

m8260IntDisable( )

NAME

m8260IntDisable( ) - Disable one of the Level or IRQ interrupts into the SIU

SYNOPSIS

int m8260IntDisable
    (
    int intNum                /* interrupt level to disable */
    )

DESCRIPTION

This routine will mask the bit in the SIMASK register corresponding to the requested interrupt level.

RETURNS

0, always.

SEE ALSO

sysLib


wrScout : Routines

m8260IvecToInum( )

NAME

m8260IvecToInum( ) - get the relevant interrupt number

SYNOPSIS

int m8260IvecToInum
    (
    VOIDFUNCPTR * vector      /* interrupt vector to attach to */
    )

DESCRIPTION

This routine finds out the interrupt number associated with the vector in vector.

vector types are defined in h/drv/intrClt/m8260Intr.h.

RETURNS

the interrupt number for the vector

SEE ALSO

sysLib, m8260Intr.h


wrScout : Routines

m82xxDpramLibInit( )

NAME

m82xxDpramLibInit( ) - init DPRAM memory allocation driver

SYNOPSIS

void m82xxDpramLibInit (void)

DESCRIPTION

This routine init the DPRAM memory allocation driver.

RETURNS

N/A

SEE ALSO

sysLib, m82xxDpramAlignedAddr( ), m82xxDpramAllocRange( ), m82xxDpramFindFreeEntry( ), m82xxDpramAllocateRange( ), m82xxDpramReleaseRenage( ), m82xxDpramMalloc( ), m82xxDpramAlignedMalloc( ), m82xxDpramFree( ), m82xxDpramFccMalloc( ), m82xxDpramFccFree( )


wrScout : Routines

m82xxDpramMalloc( )

NAME

m82xxDpramMalloc( ) - allocate memory from DPRAM main pool

SYNOPSIS

void * m82xxDpramMalloc
    (
    size_t length
    )

DESCRIPTION

This routine allocate memory from DPRAM main pool.

RETURNS

pointer to allocated memory

SEE ALSO

sysLib, m82xxDpramAlignedAddr( ), m82xxDpramAllocRange( ), m82xxDpramFindFreeEntry( ), m82xxDpramAllocateRange( ), m82xxDpramReleaseRenage( ), m82xxDpramLibInit( ), m82xxDpramAlignedMalloc( ), m82xxDpramFree( ), m82xxDpramFccMalloc( ), m82xxDpramFccFree( )


wrScout : Routines

m82xxDpramAlignedMalloc( )

NAME

m82xxDpramAlignedMalloc( ) - allocate aligned memory from DPRAM main pool

SYNOPSIS

void * m82xxDpramAlignedMalloc
    (
    size_t length,
    size_t alignment
    )

DESCRIPTION

This routine allocate aligned memory from DRPAM main pool.

RETURNS

pointer to allocated aligend memory

SEE ALSO

sysLib, m82xxDpramAlignedAddr( ), m82xxDpramAllocRange( ), m82xxDpramFindFreeEntry( ), m82xxDpramAllocateRange( ), m82xxDpramReleaseRenage( ), m82xxDpramLibInit( ), m82xxDpramMalloc( ), m82xxDpramFree( ), m82xxDpramFccMalloc( ), m82xxDpramFccFree( )


wrScout : Routines

m82xxDpramFree( )

NAME

m82xxDpramFree( ) - free allocated memory from DPRAM main pool

SYNOPSIS

void m82xxDpramFree
    (
    void * addr
    )

DESCRIPTION

This routine free allocated memory from DPRAM main pool.

RETURNS

N/A

SEE ALSO

sysLib, m82xxDpramAlignedAddr( ), m82xxDpramAllocRange( ), m82xxDpramFindFreeEntry( ), m82xxDpramAllocateRange( ), m82xxDpramReleaseRenage( ), m82xxDpramLibInit( ), m82xxDpramMalloc( ), m82xxDpramAlignedMalloc( ), m82xxDpramFccMalloc( ), m82xxDpramFccFree( )


wrScout : Routines

m82xxDpramFccMalloc( )

NAME

m82xxDpramFccMalloc( ) - allocate memory from DPRAM FCC special pool

SYNOPSIS

void * m82xxDpramFccMalloc
    (
    size_t length,
    size_t alignment
    )

DESCRIPTION

This routine allocate memory from DPRAM FCC special pool.

RETURNS

pointer to allocated memory

SEE ALSO

sysLib, m82xxDpramAlignedAddr( ), m82xxDpramAllocRange( ), m82xxDpramFindFreeEntry( ), m82xxDpramAllocateRange( ), m82xxDpramReleaseRenage( ), m82xxDpramLibInit( ), m82xxDpramMalloc( ), m82xxDpramAlignedMalloc( ), m82xxDpramFree( ), m82xxDpramFccFree( )


wrScout : Routines

m82xxDpramFccFree( )

NAME

m82xxDpramFccFree( ) - free allocated memory from DPRAM FCC special pool

SYNOPSIS

void m82xxDpramFccFree
    (
    void * addr
    )

DESCRIPTION

This routine free alocated memory from DPRAM FCC special pool.

RETURNS

pointer to allocated memory

SEE ALSO

sysLib, m82xxDpramAlignedAddr( ), m82xxDpramAllocRange( ), m82xxDpramFindFreeEntry( ), m82xxDpramAllocateRange( ), m82xxDpramReleaseRenage( ), m82xxDpramLibInit( ), m82xxDpramMalloc( ), m82xxDpramAlignedMalloc( ), m82xxDpramFree( ), m82xxDpramFccMalloc( )


wrScout : Routines

sysSerialHwInit( )

NAME

sysSerialHwInit( ) - initialize the BSP serial devices to a quiesent state

SYNOPSIS

void sysSerialHwInit (void)

DESCRIPTION

This routine initializes the BSP serial device descriptors and puts the devices in a quiesent state. It is called from sysHwInit( ) with interrupts locked.

RETURNS

N/A

SEE ALSO

sysLib, sysHwInit( )


wrScout : Routines

sysSerialHwInit2( )

NAME

sysSerialHwInit2( ) - connect BSP serial device interrupts

SYNOPSIS

void sysSerialHwInit2 (void)

DESCRIPTION

This routine connects the BSP serial device interrupts. It is called from sysHwInit2( ). Serial device interrupts could not be connected in sysSerialHwInit( ) because the kernel memory allocator was not initialized at that point, and intConnect( ) calls malloc( ).

RETURNS

N/A

SEE ALSO

sysLib, sysHwInit2( )


wrScout : Routines

sysSerialChanGet( )

NAME

sysSerialChanGet( ) - get the SIO_CHAN device associated with a serial channel

SYNOPSIS

SIO_CHAN * sysSerialChanGet
    (
    int channel               /* serial channel */
    )

DESCRIPTION

This routine gets the SIO_CHAN device associated with a specified serial channel.

RETURNS

A pointer to the SIO_CHAN structure for the channel, or ERROR if the channel is invalid.

SEE ALSO

sysLib


wrScout : Routines

sysSerialReset( )

NAME

sysSerialReset( ) - reset the serail device

SYNOPSIS

void sysSerialReset (void)

DESCRIPTION

This function calls sysSerialHwInit( ) to reset the serail device

RETURNS

N/A

SEE ALSO

sysLib


wrScout : Routines

m8260SioDevInit( )

NAME

m8260SioDevInit( ) - initialize the SCC

SYNOPSIS

void m8260SioDevInit
    (
    M8260_SCC_CHAN * pSccChan
    )

DESCRIPTION

This routine is called to initialize the chip to a quiescent state. Note that the sccNum field of M8260_SCC_CHAN must be less than or equal to the maximum number of SCC channels to configure as SIOs, as defined in ads8260.h

SEE ALSO

sysLib


wrScout : Routines

m8260SioResetChannel( )

NAME

m8260SioResetChannel( ) - initialize an SCC channel

SYNOPSIS

void m8260SioResetChannel
    (
    M8260_SCC_CHAN * pSccChan
    )

DESCRIPTION

This routines initializes an SCC channel. Initialized are:

       CPCR
       BRGC
       Baud rate
       Buffer Descriptors
       RBASE field in SCC Parameter RAM
       TBASE field in SCC Parameter RAM
       RFCR field in SCC Parameter RAM
       TFCR field in SCC Parameter RAM
       MRBLR field in SCC Parameter RAM
       
       SCC mode registers: GSMR_L, GSMR_H, AND PSMR
       transmit and receive interrupts are enabled in SCCM 

RETURNS: NA

SEE ALSO

sysLib


wrScout : Routines

m8260SioInt( )

NAME

m8260SioInt( ) - handle an SCC interrupt

SYNOPSIS

void m8260SioInt
    (
    M8260_SCC_CHAN * pSccChan
    )

DESCRIPTION

This routine is called to handle SCC interrupts.

RETURNS

NA

SEE ALSO

sysLib


wrScout : Routines

sysClkConnect( )

NAME

sysClkConnect( ) - connect a routine to the system clock interrupt

SYNOPSIS

STATUS sysClkConnect
    (
    FUNCPTR routine,          /* routine to connect */
    int     arg               /* argument for the routine */
    )

DESCRIPTION

This routine specifies the interrupt service routine to be called at each clock interrupt. Normally, it is called from usrRoot( ) in usrConfig.c to connect usrClock( ) to the system clock interrupt.

RETURNS

OK, or ERROR if the routine cannot be connected to the interrupt.

SEE ALSO

sysLib, intConnect( ), usrClock( ), sysClkEnable( )


wrScout : Routines

sysClkEnable( )

NAME

sysClkEnable( ) - turn on system clock interrupts

SYNOPSIS

void sysClkEnable (void)

DESCRIPTION

This routine enables system clock interrupts.

RETURNS

N/A

SEE ALSO

sysLib, sysClkConnect( ), sysClkDisable( ), sysClkRateSet( )


wrScout : Routines

sysClkDisable( )

NAME

sysClkDisable( ) - turn off system clock interrupts

SYNOPSIS

void sysClkDisable (void)

DESCRIPTION

This routine disables system clock interrupts.

RETURNS

N/A

SEE ALSO

sysLib, sysClkEnable( )


wrScout : Routines

sysClkRateGet( )

NAME

sysClkRateGet( ) - get the system clock rate

SYNOPSIS

int sysClkRateGet (void)

DESCRIPTION

This routine returns the system clock rate.

RETURNS

The number of ticks per second of the system clock.

SEE ALSO

sysLib, sysClkEnable( ), sysClkRateSet( )


wrScout : Routines

sysClkRateSet( )

NAME

sysClkRateSet( ) - set the system clock rate

SYNOPSIS

STATUS sysClkRateSet
    (
    int ticksPerSecond        /* number of clock interrupts per second */
    )

DESCRIPTION

This routine sets the interrupt rate of the system clock. It is called by usrRoot( ) in usrConfig.c.

RETURNS

OK, or ERROR if the tick rate is invalid or the timer cannot be set.

SEE ALSO

sysLib, sysClkEnable( ), sysClkRateGet( )


wrScout : Routines

sysAuxClkConnect( )

NAME

sysAuxClkConnect( ) - connect a routine to the auxiliary clock interrupt

SYNOPSIS

STATUS sysAuxClkConnect
    (
    FUNCPTR routine,          /* routine called at each aux. clock interrupt */
    int     arg               /* argument to auxiliary clock interrupt */
                              /* routine */ 
    )

DESCRIPTION

This routine specifies the interrupt service routine to be called at each auxiliary clock interrupt. It does not enable auxiliary clock interrupts.

RETURNS

OK, or ERROR if the routine cannot be connected to the interrupt.

SEE ALSO

sysLib, intConnect( ), sysAuxClkEnable( )


wrScout : Routines

sysAuxClkDisable( )

NAME

sysAuxClkDisable( ) - turn off auxiliary clock interrupts

SYNOPSIS

void sysAuxClkDisable (void)

DESCRIPTION

This routine disables auxiliary clock interrupts.

RETURNS

N/A

SEE ALSO

sysLib, sysAuxClkEnable( )


wrScout : Routines

sysAuxClkEnable( )

NAME

sysAuxClkEnable( ) - turn on auxiliary clock interrupts

SYNOPSIS

void sysAuxClkEnable (void)

DESCRIPTION

This routine enables auxiliary clock interrupts. The timer is used in "reference mode" i.e. a value is programmed into the reference register and an interrupt occurs when the timer reaches that value.

RETURNS

N/A

SEE ALSO

sysLib, sysAuxClkConnect( ), sysAuxClkDisable( ), sysAuxClkRateSet( )


wrScout : Routines

sysAuxClkRateGet( )

NAME

sysAuxClkRateGet( ) - get the auxiliary clock rate

SYNOPSIS

int sysAuxClkRateGet (void)

DESCRIPTION

This routine returns the interrupt rate of the auxiliary clock.

RETURNS

The number of ticks per second of the auxiliary clock.

SEE ALSO

sysLib, sysAuxClkEnable( ), sysAuxClkRateSet( )


wrScout : Routines

sysAuxClkRateSet( )

NAME

sysAuxClkRateSet( ) - set the auxiliary clock rate

SYNOPSIS

STATUS sysAuxClkRateSet
    (
    int ticksPerSecond        /* number of clock interrupts per second */
    )

DESCRIPTION

This routine sets the interrupt rate of the auxiliary clock. It does not enable auxiliary clock interrupts.

RETURNS

OK, or ERROR if the tick rate is invalid or the timer cannot be set.

SEE ALSO

sysLib, sysAuxClkEnable( ), sysAuxClkRateGet( )


wrScout : Routines

sysTimestampConnect( )

NAME

sysTimestampConnect( ) - connect a user routine to the timestamp timer interrupt

SYNOPSIS

STATUS sysTimestampConnect
    (
    FUNCPTR routine,          /* routine called at each timestamp timer */
                              /* interrupt */ 
    int     arg               /* argument with which to call routine */
    )

DESCRIPTION

This routine specifies the user interrupt routine to be called at each timestamp timer interrupt. It does not enable the timestamp timer itself.

RETURNS

OK, or ERROR if sysTimestampInt( ) interrupt handler is not used.

SEE ALSO

sysLib


wrScout : Routines

sysTimestampEnable( )

NAME

sysTimestampEnable( ) - initialize and enable the timestamp timer

SYNOPSIS

STATUS sysTimestampEnable (void)

DESCRIPTION

This routine connects interrupts, and enables the timer device

RETURNS

TRUE always

SEE ALSO

sysLib


wrScout : Routines

sysTimestampDisable( )

NAME

sysTimestampDisable( ) - turn off auxiliary clock interrupts

SYNOPSIS

STATUS sysTimestampDisable (void)

DESCRIPTION

This routine disables auxiliary clock interrupts.

RETURNS

OK, always

SEE ALSO

sysLib, sysTimestampEnable( )


wrScout : Routines

sysTimestampPeriod( )

NAME

sysTimestampPeriod( ) - get the period of a timestamp timer

SYNOPSIS

UINT32 sysTimestampPeriod (void)

DESCRIPTION

This routine gets the period of the timestamp timer, in ticks. The period, or terminal count, is the number of ticks to which the timestamp timer counts before rolling over and restarting the counting process.

RETURNS

The period of the timestamp timer in counter ticks.

SEE ALSO

sysLib


wrScout : Routines

sysTimestampFreq( )

NAME

sysTimestampFreq( ) - get a timestamp timer clock frequency

SYNOPSIS

UINT32 sysTimestampFreq (void)

DESCRIPTION

This routine gets the frequency of the timer clock, in ticks per second. The rate of the timestamp timer is set explicitly by the hardware and typically cannot be altered.

RETURNS

The timestamp timer clock frequency, in ticks per second.

SEE ALSO

sysLib


wrScout : Routines

sysTimestamp( )

NAME

sysTimestamp( ) - get a timestamp timer tick count

SYNOPSIS

UINT32 sysTimestamp (void)

DESCRIPTION

This routine returns the current value of the timestamp timer tick counter. The tick count can be converted to seconds by dividing it by the return of sysTimestampFreq( ).

This routine should be called with interrupts locked. If interrupts are not locked, sysTimestampLock( ) should be used instead.

RETURNS

The current timestamp timer tick count.

SEE ALSO

sysLib, sysTimestampFreq( ), sysTimestampLock( )


wrScout : Routines

sysTimestampLock( )

NAME

sysTimestampLock( ) - lock interrupts and get the timestamp timer tick count

SYNOPSIS

UINT32 sysTimestampLock (void)

DESCRIPTION

This routine locks interrupts when the tick counter must be stopped in order to read it or when two independent counters must be read. It then returns the current value of the timestamp timer tick counter.

The tick count can be converted to seconds by dividing it by the return of sysTimestampFreq( ).

If interrupts are already locked, sysTimestamp( ) should be used instead.

RETURNS

The current timestamp timer tick count.

SEE ALSO

sysLib, sysTimestampFreq( ), sysTimestamp( )


wrScout : Routines

sysNvRamGet( )

NAME

sysNvRamGet( ) - get the contents of non-volatile RAM

SYNOPSIS

STATUS sysNvRamGet
    (
    char * string,            /* where to copy non-volatile RAM */
    int    strLen,            /* maximum number of bytes to copy */
    int    offset             /* byte offset into non-volatile RAM */
    )

DESCRIPTION

This routine copies the contents of non-volatile memory into a specified string. The string is terminated with an EOS.

NOTE

This routine has no effect, since there is no non-volatile RAM.

RETURNS

ERROR, always.

SEE ALSO

sysLib, sysNvRamSet( )


wrScout : Routines

sysNvRamSet( )

NAME

sysNvRamSet( ) - write to non-volatile RAM

SYNOPSIS

STATUS sysNvRamSet
    (
    char * string,            /* string to be copied into non-volatile RAM */
    int    strLen,            /* maximum number of bytes to copy */
    int    offset             /* byte offset into non-volatile RAM */
    )

DESCRIPTION

This routine copies a specified string into non-volatile RAM.

NOTE

This routine has no effect, since there is no non-volatile RAM.

RETURNS

ERROR, always.

SEE ALSO

sysLib, sysNvRamGet( )


wrScout : Routines

sysCacheLock( )

NAME

sysCacheLock( ) - locks specified data/instruction region

SYNOPSIS

STATUS sysCacheLock
    (
    CACHE_TYPE cacheType,
    void *     adrs,
    UINT32     bytes
    )

DESCRIPTION

This routine locks the specified region into the cache, cacheType. The region to be locked is specified by the start address, adrs, and the size, bytes. The region -- the start address, and size -- must be aligned on a 32-byte boundary.

Multiple calls to this routine will silently unlock the specified cache to lock the new region.

RETURNS

OK or error if cache is locked, or if cache is not supported.

SEE ALSO

sysLib, sysCacheUnlock( )


wrScout : Routines

sysCacheUnlock( )

NAME

sysCacheUnlock( ) - Unlocks the previous locked cache

SYNOPSIS

STATUS sysCacheUnlock
    (
    CACHE_TYPE cacheType
    )

DESCRIPTION

This routines unlocks the specified cache, cacheType

RETURNS

OK or error if cache is not supported.

SEE ALSO

sysLib, sysCacheLock( )


wrScout : Routines

sysMotFccEndLoad( )

NAME

sysMotFccEndLoad( ) - load an istance of the motFccEnd driver

SYNOPSIS

END_OBJ * sysMotFccEndLoad
    (
    char * pParamStr,         /* ptr to initialization parameter string */
    void * unused             /* unused optional argument */
    )

DESCRIPTION

This routine loads the motFccEnd driver with proper parameters. It also reads the BCSR3 to find out which type of processor is being used, and sets up the load string accordingly.

The END device load string formed by this routine is in the following format. immrVal:fccNum:bdBase:bdSize:bufBase:bufSize:fifoTxBase: fifoRxBase:tbdNum:rbdNum:phyAddr:phyDefMode:pAnOrderTbl: userFlags:mBlkRatio:clusterRatio

immrVal
Internal memory address
fccNum
FCC number being used
bdBase
buffer descriptors base address
bdSize
buffer descriptors space size
bufBase
data buffers base address
bufSize
data buffers space size
fifoTxBase
tx buffer in internal memory
fifoRxBase
rx buffer in internal memory
tbdNum
number of TBDs or NONE
rbdNum
number of RBDs or NONE
phyAddr
address of a MII-compliant PHY device
phyDefMode
default operating mode of a MII-compliant PHY device
pAnOrderTbl
auto-negotiation order table for a MII-compliant PHY device or NONE
userFlags
User flages
mBlkRatio
Ratio between mBlk's and Rx BD's
clusterRatio
Ratio between Clusters and Rx BD's

This routine only loads and initializes one instance of the device. If the user wishes to use more than one motFccEnd devices, this routine should be changed.

RETURNS

pointer to END object or NULL.

SEE ALSO

sysLib, motFccEndLoad ()


wrScout : Routines

sysFccEnetEnable( )

NAME

sysFccEnetEnable( ) - enable the MII interface to the FCC controller

SYNOPSIS

STATUS sysFccEnetEnable
    (
    UINT32 immrVal,           /* base address of the on-chip RAM */
    UINT8  fccNum             /* FCC being used */
    )

DESCRIPTION

This routine is expected to perform any target specific functions required to enable the Ethernet device and to connect the MII interface to the FCC.

RETURNS

OK, or ERROR if the FCC controller cannot be enabled.

SEE ALSO

sysLib, sysFccEnetDisable( )


wrScout : Routines

sysFccEnetDisable( )

NAME

sysFccEnetDisable( ) - disable MII interface to the FCC controller

SYNOPSIS

STATUS sysFccEnetDisable
    (
    UINT32 immrVal,           /* base address of the on-chip RAM */
    UINT8  fccNum             /* FCC being used */
    )

DESCRIPTION

This routine is expected to perform any target specific functions required to disable the Ethernet device and the MII interface to the FCC controller. This involves restoring the default values for all the Port B and C signals.

RETURNS

OK, always.

SEE ALSO

sysLib, sysFccEnetEnable( )


wrScout : Routines

sysFccEnetAddrGet( )

NAME

sysFccEnetAddrGet( ) - get the hardware Ethernet address

SYNOPSIS

STATUS sysFccEnetAddrGet
    (
    int unit ,
    UINT8 *  addr
    )

DESCRIPTION

This routine provides the six byte Ethernet hardware address that will be used by each individual FCC device unit. This routine must copy the six byte address to the space provided by addr.

RETURNS

OK, or ERROR if the Ethernet address cannot be returned.

SEE ALSO

sysLib


wrScout : Routines

sysFccEnetCommand( )

NAME

sysFccEnetCommand( ) - issue a command to the Ethernet interface controller

SYNOPSIS

STATUS sysFccEnetCommand
    (
    UINT32 immrVal,           /* base address of the on-chip RAM */
    UINT8  fccNum,            /* FCC being used */
    UINT16 command
    )

DESCRIPTION

This routine issue a command to the Ethernet interface controller.

RETURNS

OK, or ERROR if the Ethernet controller could not be restarted.

SEE ALSO

sysLib


wrScout : Routines

sysFccMiiBitWr( )

NAME

sysFccMiiBitWr( ) - write one bit to the MII interface

SYNOPSIS

STATUS sysFccMiiBitWr
    (
    UINT32 immrVal,           /* base address of the on-chip RAM */
    UINT8  fccNum,            /* FCC being used */
    INT32  bitVal             /* the bit being written */
    )

DESCRIPTION

This routine writes the value in bitVal to the MDIO line of a MII interface. The MDC line is asserted for a while, and then negated. If bitVal is NONE, then the MDIO pin should be left in high-impedance state.

SEE ALSO

sysLib, sysFccMiiBitRd( )

RETURNS

OK, or ERROR.


wrScout : Routines

sysFccMiiBitRd( )

NAME

sysFccMiiBitRd( ) - read one bit from the MII interface

SYNOPSIS

STATUS sysFccMiiBitRd
    (
    UINT32 immrVal,           /* base address of the on-chip RAM */
    UINT8  fccNum,            /* FCC being used */
    INT8 * bitVal             /* the bit being read */
    )

DESCRIPTION

This routine reads one bit from the MDIO line of a MII interface. The MDC line is asserted for a while, and then negated.

SEE ALSO

sysLib, sysFccMiiBitWr( )

RETURNS

OK, or ERROR.


wrScout : Routines

sysMiiOptRegsHandle( )

NAME

sysMiiOptRegsHandle( ) - handle some MII optional registers

SYNOPSIS

STATUS sysMiiOptRegsHandle
    (
    PHY_INFO * pPhyInfo       /* PHY control structure pointer */
    )

DESCRIPTION

This routine handles some MII optional registers in the PHY described by pPhyInfo.

In the case of the Scout, the PHY that implements the physical layer for the FCC is an LXT970. The default values for some of its chip-specific registers seem to be uncompatible with 100Base-T operations. This routine is expected to perform any PHY-specific functions required to bring the PHY itself to a state where 100Base-T operations may be possible.

SEE ALSO

sysLib, miiLib, motFccEnd.

RETURNS

OK, or ERROR.


wrScout : Routines

sysCheckIfVware( )

NAME

sysCheckIfVware( ) - check if we were lunched by vWARE

SYNOPSIS

BOOL sysCheckIfVware (void)

DESCRIPTION

This routine check if we were lunched by vWARE

RETURNS

TRUE if yes, FALSE if no

SEE ALSO

sysLib, sysVwareBuildBootLine( ), sysVware2BuildBootLine( ), sysVware1BuildBootLine( )


wrScout : Routines

sysAltivecProbe( )

NAME

sysAltivecProbe( ) - Check if the CPU has ALTIVEC unit.

SYNOPSIS

int sysAltivecProbe (void)

DESCRIPTION

This routine returns OK it the CPU has an ALTIVEC unit in it. Presently it checks for 7400

RETURNS

OK - for 7400 Processor type
         ERROR - otherwise.

SEE ALSO

sysLib


wrScout : Routines

sysModel( )

NAME

sysModel( ) - return the model name of the CPU board

SYNOPSIS

char * sysModel (void)

DESCRIPTION

This routine returns the model name of the CPU board.

RETURNS

A pointer to the string.

SEE ALSO

sysLib


wrScout : Routines

sysBspRev( )

NAME

sysBspRev( ) - return the bsp version with the revision eg 1.2/x

SYNOPSIS

char * sysBspRev (void)

DESCRIPTION

This function returns a pointer to a bsp version with the revision. for eg. 1.2/x. BSP_REV defined in config.h is concatanated to BSP_VERSION and returned.

RETURNS

A pointer to the BSP version/revision string.

SEE ALSO

sysLib


wrScout : Routines

sysHwInit( )

NAME

sysHwInit( ) - initialize the system hardware

SYNOPSIS

void sysHwInit (void)

DESCRIPTION

This routine initializes various feature of the MPC8260 ADS board. It sets up the control registers, initializes various devices if they are present.

NOTE

This routine should not be called directly by the user.

RETURNS

NA

SEE ALSO

sysLib


wrScout : Routines

sysPhysMemTop( )

NAME

sysPhysMemTop( ) - get the address of the top of physical memory

SYNOPSIS

char * sysPhysMemTop (void)

DESCRIPTION

This routine returns the address of the first missing byte of memory, which indicates the top of memory.

RETURNS

The address of the top of physical memory.

SEE ALSO

sysLib, sysMemTop( )


wrScout : Routines

sysMemTop( )

NAME

sysMemTop( ) - get the address of the top of VxWorks memory

SYNOPSIS

char * sysMemTop (void)

DESCRIPTION

This routine returns a pointer to the first byte of memory not controlled or used by VxWorks.

The user can reserve memory space by defining the macro USER_RESERVED_MEM in config.h. This routine returns the address of the reserved memory area. The value of USER_RESERVED_MEM is in bytes.

RETURNS

The address of the top of VxWorks memory.

SEE ALSO

sysLib


wrScout : Routines

sysToMonitor( )

NAME

sysToMonitor( ) - transfer control to the ROM monitor

SYNOPSIS

STATUS sysToMonitor
    (
    int startType             /* parameter passed to ROM to tell it how */
                              /* to boot */ 
    )

DESCRIPTION

This routine transfers control to the ROM monitor. Normally, it is called only by reboot( )--which services ^X--and bus errors at interrupt level. However, in some circumstances, the user may wish to introduce a startType to enable special boot ROM facilities.

RETURNS

Does not return.

SEE ALSO

sysLib


wrScout : Routines

sysHwInit2( )

NAME

sysHwInit2( ) - additional system configuration and initialization

SYNOPSIS

void sysHwInit2 (void)

DESCRIPTION

This routine connects system interrupts and does any additional configuration necessary.

RETURNS

NA

SEE ALSO

sysLib


wrScout : Routines

sysProcNumGet( )

NAME

sysProcNumGet( ) - get the processor number

SYNOPSIS

int sysProcNumGet (void)

DESCRIPTION

This routine returns the processor number for the CPU board, which is set with sysProcNumSet( ).

RETURNS

The processor number for the CPU board.

SEE ALSO

sysLib, sysProcNumSet( )


wrScout : Routines

sysProcNumSet( )

NAME

sysProcNumSet( ) - set the processor number

SYNOPSIS

void sysProcNumSet
    (
    int procNum               /* processor number */
    )

DESCRIPTION

This routine sets the processor number for the CPU board. Processor numbers should be unique on a single backplane.

Not applicable for the busless 8260Ads.

RETURNS

NA

SEE ALSO

sysLib, sysProcNumGet( )


wrScout : Routines

vxImmrSet( )

NAME

vxImmrSet( ) - Set the IMMR to a specific value

SYNOPSIS

void vxImmrSet
    (
    UINT32 value
    )

DESCRIPTION

This routine sets the IMMR to a specific value

RETURNS

N/A

SEE ALSO

sysLib


wrScout : Routines

vxImmrGet( )

NAME

vxImmrGet( ) - return the current IMMR value

SYNOPSIS

UINT32 vxImmrGet (void)

DESCRIPTION

This routine returns the current IMMR value

RETURNS

current IMMR value

SEE ALSO

sysLib


wrScout : Routines

sysInputFreqGet( )

NAME

sysInputFreqGet( ) - determines the Input Oscillator clock frequency

SYNOPSIS

UINT32 sysInputFreqGet (void)

DESCRIPTION

This routine determines the Input Oscillator clock frequency

NOTE

From page 9-2 in Rev0 of 8260 book

RETURNS

Input frequency in HZ

SEE ALSO

sysLib


wrScout : Routines

sysBaudClkFreq( )

NAME

sysBaudClkFreq( ) - Obtains frequency of the BRG_CLK in HZ

SYNOPSIS

int sysBaudClkFreq (void)

DESCRIPTION

From page 9-5 in Rev. 0 MPC8260 PowerQUICC II User's Manual

    baud clock = 2*cpm_freq/2^2*(DFBRG+1) where DFBRG = 01
               = 2*cpm_freq/16

RETURNS

frequency of the BRG_CLK in HZ

SEE ALSO

sysLib


wrScout : Routines

sysCpuCheck( )

NAME

sysCpuCheck( ) - confirm the CPU type

SYNOPSIS

void sysCpuCheck (void)

DESCRIPTION

This routine validates the cpu type. If the wrong cpu type is discovered a message is printed using the serial channel in polled mode.

RETURNS

N/A.

SEE ALSO

sysLib