VxWorks BSP Reference : ads8260
sysLib [ads8260] - Motorola ads 8260 board system-dependent library
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
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
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
m8260SioDevInit( ) - initialize the SCC
m8260SioResetChannel( ) - initialize an SCC channel
m8260SioInt( ) - handle an SCC interrupt
sysNvRamGet( ) - get the contents of non-volatile RAM
sysNvRamSet( ) - write to non-volatile RAM
sysFlashGet( ) - get the contents of flash memory
sysFlashErase( ) - erase the contents of flash memory
sysFlashWrite( ) - write data to flash memory
sysFlashTypeGet( ) - determine the device type of on-board flash memory
sysFlashUpdate( ) - update the contents of the flash device
sysMotFccEndLoad( ) - load an istance of the motFccEnd driver
sysModel( ) - return the model name of the CPU board
sysBspRev( ) - return the bsp version with the revision eg 1.0/x
sysBaudClkFreq( ) - Obtains frequency of the BRG_CLK in HZ
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
sysLocalToBusAdrs( ) - convert a local address to a bus address
sysBusToLocalAdrs( ) - convert a bus address to a local address
sysBusTas( ) - test and set a location across the bus
sysBusClearTas( ) - test and clear
vxImmrGet( ) - return the current IMMR value
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
sysFlashLED( ) - flash one of the signal lamps
sysControlLED( ) - control one of the signal lamps
This library provides board-specific routines. The chip drivers included are:
VxWorks Programmer's Guide: Configuration
sysSerialHwInit( ) - initialize the BSP serial devices to a quiesent state
void sysSerialHwInit (void)
This routine initializes the BSP serial device descriptors and puts the devices in a quiesent state. It is called from sysHwInit( ) with interrupts locked.
Buffers and Buffer Descriptors for the two channels:
Address per SCC --------------------------- field size SCC1 SCC2 ------ ------- ----------- ----------- Receive Buffer Descriptor 8 bytes 0x0470_0000 0x0470_0100 Receive Buffer Status 2 bytes 0x0470_0000 0x0470_0100 Receive Buffer Length 2 bytes 0x0470_0002 0x0470_0102 Pointer to Receive Buffer 4 bytes 0x0470_0004 0x0470_0104 Receive Buffer 1 bytes 0x0470_0040 0x0470_0140 Transmit Buffer Descriptor 8 bytes 0x0470_0008 0x0470_0108 Transmit Buffer Status 2 bytes 0x0470_0008 0x0470_0108 Transmit Buffer Length 2 bytes 0x0470_000A 0x0470_010A Transmit to Receive Buffer 4 bytes 0x0470_000C 0x0470_010C Transmit Buffer 1 bytes 0x0470_0060 0x0470_0160
N/A
sysSerialHwInit2( ) - connect BSP serial device interrupts
void sysSerialHwInit2 (void)
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( ).
N/A
sysSerialChanGet( ) - get the SIO_CHAN device associated with a serial channel
SIO_CHAN * sysSerialChanGet ( int channel /* serial channel */ )
This routine gets the SIO_CHAN device associated with a specified serial channel.
A pointer to the SIO_CHAN structure for the channel, or ERROR if the channel is invalid.
sysSerialReset( ) - reset the serail device
void sysSerialReset (void)
This function calls sysSerialHwInit( ) to reset the serail device
N/A
m8260IntrInit( ) - initialize the interrupt manager for the PowerPC 8260
STATUS m8260IntrInit ()
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.
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.
OK always
m8260IntEnable( ) - enable the indicated interrupt
int m8260IntEnable ( int intNum /* interrupt level to enable */ )
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
0, always.
m8260IntDisable( ) - Disable one of the Level or IRQ interrupts into the SIU
int m8260IntDisable ( int intNum /* interrupt level to disable */ )
This routine will mask the bit in the SIMASK register corresponding to the requested interrupt level.
0, always.
m8260IvecToInum( ) - get the relevant interrupt number
int m8260IvecToInum ( VOIDFUNCPTR * vector /* interrupt vector to attach to */ )
This routine finds out the interrupt number associated with the vector in vector.
vector types are defined in h/drv/intrClt/m8260Intr.h.
the interrupt number for the vector
sysLib, m8260Intr.h
sysClkConnect( ) - connect a routine to the system clock interrupt
STATUS sysClkConnect ( FUNCPTR routine, /* routine to connect */ int arg /* argument for the routine */ )
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.
OK, or ERROR if the routine cannot be connected to the interrupt.
sysLib, intConnect( ), usrClock( ), sysClkEnable( )
sysClkEnable( ) - turn on system clock interrupts
void sysClkEnable (void)
This routine enables system clock interrupts.
N/A
sysLib, sysClkConnect( ), sysClkDisable( ), sysClkRateSet( )
sysClkDisable( ) - turn off system clock interrupts
void sysClkDisable (void)
This routine disables system clock interrupts.
N/A
sysLib, sysClkEnable( )
sysClkRateGet( ) - get the system clock rate
int sysClkRateGet (void)
This routine returns the system clock rate.
The number of ticks per second of the system clock.
sysLib, sysClkEnable( ), sysClkRateSet( )
sysClkRateSet( ) - set the system clock rate
STATUS sysClkRateSet ( int ticksPerSecond /* number of clock interrupts per second */ )
This routine sets the interrupt rate of the system clock. It is called by usrRoot( ) in usrConfig.c.
OK, or ERROR if the tick rate is invalid or the timer cannot be set.
sysLib, sysClkEnable( ), sysClkRateGet( )
sysAuxClkConnect( ) - connect a routine to the auxiliary clock interrupt
STATUS sysAuxClkConnect ( FUNCPTR routine, /* routine called at each aux. clock interrupt */ int arg /* argument to auxiliary clock interrupt */ /* routine */ )
This routine specifies the interrupt service routine to be called at each auxiliary clock interrupt. It does not enable auxiliary clock interrupts.
OK, or ERROR if the routine cannot be connected to the interrupt.
sysLib, intConnect( ), sysAuxClkEnable( )
sysAuxClkDisable( ) - turn off auxiliary clock interrupts
void sysAuxClkDisable (void)
This routine disables auxiliary clock interrupts.
N/A
sysAuxClkEnable( ) - turn on auxiliary clock interrupts
void sysAuxClkEnable (void)
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.
N/A
sysLib, sysAuxClkConnect( ), sysAuxClkDisable( ), sysAuxClkRateSet( )
sysAuxClkRateGet( ) - get the auxiliary clock rate
int sysAuxClkRateGet (void)
This routine returns the interrupt rate of the auxiliary clock.
The number of ticks per second of the auxiliary clock.
sysLib, sysAuxClkEnable( ), sysAuxClkRateSet( )
sysAuxClkRateSet( ) - set the auxiliary clock rate
STATUS sysAuxClkRateSet ( int ticksPerSecond /* number of clock interrupts per second */ )
This routine sets the interrupt rate of the auxiliary clock. It does not enable auxiliary clock interrupts.
OK, or ERROR if the tick rate is invalid or the timer cannot be set.
sysLib, sysAuxClkEnable( ), sysAuxClkRateGet( )
m8260SioDevInit( ) - initialize the SCC
void m8260SioDevInit ( M8260_SCC_CHAN * pSccChan )
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
m8260SioResetChannel( ) - initialize an SCC channel
void m8260SioResetChannel ( M8260_SCC_CHAN * pSccChan )
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
m8260SioInt( ) - handle an SCC interrupt
void m8260SioInt ( M8260_SCC_CHAN * pSccChan )
This routine is called to handle SCC interrupts.
NA
sysNvRamGet( ) - get the contents of non-volatile RAM
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 */ )
This routine copies the contents of non-volatile memory into a specified string. The string is terminated with an EOS.
This routine has no effect, since there is no non-volatile RAM.
ERROR, always.
sysLib, sysNvRamSet( )
sysNvRamSet( ) - write to non-volatile RAM
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 */ )
This routine copies a specified string into non-volatile RAM.
This routine has no effect, since there is no non-volatile RAM.
ERROR, always.
sysLib, sysNvRamGet( )
sysFlashGet( ) - get the contents of flash memory
STATUS sysFlashGet ( UCHAR * string, /* where to copy flash memory */ UINT32 strLen, /* maximum number of bytes to copy */ UINT32 offset /* byte offset into flash memory */ )
This routine copies the contents of flash memory into a specified string. The string is terminated with an EOS.
OK, or ERROR if access is outside the flash memory range.
sysLib, sysFlashSet( )
sysFlashErase( ) - erase the contents of flash memory
STATUS sysFlashErase ( UINT32 offset /* offset from flash base address */ )
This routine clears the contents of flash memory from the specified offset up to the top.
Flash 28F016 devices support block erase mode. This means each of the 32 64-KByte blocks is erased by writing a flash erase command to the device at any address within the target block, and verifying that the operation completed successfully.
OK, or ERROR if the contents of flash memory cannot be erased.
sysFlashWrite( ) - write data to flash memory
STATUS sysFlashWrite ( UINT32 * pFB, /* string to be copied; use value if NULL */ UINT32 size, /* size to program in bytes */ UINT32 offset, /* byte offset into flash memory */ UINT32 value /* value to program */ )
This routine copies specified data of a specified length, size, into a specified offset, offset, in the flash memory. Data is passed as a string, pFB, if not NULL. If NULL, data is taken as a repeated sequence of value. The parameter offset must be appropriately aligned for the width of the Flash devices in use.
Flash 28F016 devices are programmed by a sequence of operations:
- set up device to write
- perform write
- verify the write
OK, or ERROR if the write operation fails.
sysLib, sysFlashSet( )
sysFlashTypeGet( ) - determine the device type of on-board flash memory
UINT8 sysFlashTypeGet (void)
This routine uses the read identifier code command to determine the device type of * on-board flash memory. The returned value should be the one in drv/mem/flash28.h
An integer indicating the device type of on-board flash memory.
sysFlashUpdate( ) - update the contents of the flash device
STATUS sysFlashUpdate ( UCHAR * filename /* file to be copied into flash memory */ )
This code allows the user to overwrite the flash device with data from a file. It will copy data from "filename" to the flash device. It first erase the device, and it attempts to write data to the flash device via sysFlashWrite ().
The user should pass a binary bootrom file, for example to update the bootrom with a VxWorks BSP bootrom image:
% make bootrom make: `bootrom' is up to date. % elfToBin < bootrom > bootrom.bin -> sysUpdateFlash ("hostname:/tmp/bootrom.bin") The flash has been updated without error.
OK, or ERROR: if the file was not accessable, the file was too large to fit into the flash, the buffers cannot be allocated, sysFlashErase () or sysFlashWrite () returned error.
sysLib, sysFlashErase( ), sysFlashGet( ), sysFlashTypeGet( ), sysFlashWrite( )
sysMotFccEndLoad( ) - load an istance of the motFccEnd driver
END_OBJ * sysMotFccEndLoad ( char * pParamStr, /* ptr to initialization parameter string */ void * unused /* unused optional argument */ )
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
- 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
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.
pointer to END object or NULL.
sysLib, motFccEndLoad ()
sysModel( ) - return the model name of the CPU board
char * sysModel (void)
This routine returns the model name of the CPU board.
A pointer to the string.
sysBspRev( ) - return the bsp version with the revision eg 1.0/x
char * sysBspRev (void)
This function returns a pointer to a bsp version with the revision. for eg. 1.0/x. BSP_REV defined in config.h is concatanated to BSP_VERSION and returned.
A pointer to the BSP version/revision string.
sysBaudClkFreq( ) - Obtains frequency of the BRG_CLK in HZ
int sysBaudClkFreq (void)
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
frequency of the BRG_CLK in HZ
sysHwInit( ) - initialize the system hardware
void sysHwInit (void)
This routine initializes various feature of the MPC8260 ADS board. It sets up the control registers, initializes various devices if they are present.
This routine should not be called directly by the user.
NA
sysPhysMemTop( ) - get the address of the top of physical memory
char * sysPhysMemTop (void)
This routine returns the address of the first missing byte of memory, which indicates the top of memory.
The address of the top of physical memory.
sysMemTop( ) - get the address of the top of VxWorks memory
char * sysMemTop (void)
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.
The address of the top of VxWorks memory.
sysToMonitor( ) - transfer control to the ROM monitor
STATUS sysToMonitor ( int startType /* parameter passed to ROM to tell it how */ /* to boot */ )
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.
Does not return.
sysHwInit2( ) - additional system configuration and initialization
void sysHwInit2 (void)
This routine connects system interrupts and does any additional configuration necessary.
NA
sysProcNumGet( ) - get the processor number
int sysProcNumGet (void)
This routine returns the processor number for the CPU board, which is set with sysProcNumSet( ).
The processor number for the CPU board.
sysLib, sysProcNumSet( )
sysProcNumSet( ) - set the processor number
void sysProcNumSet ( int procNum /* processor number */ )
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.
NA
sysLib, sysProcNumGet( )
sysLocalToBusAdrs( ) - convert a local address to a bus address
STATUS sysLocalToBusAdrs ( int adrsSpace, /* bus address space where busAdrs resides */ char * localAdrs, /* local address to convert */ char * * pBusAdrs /* where to return bus address */ )
This routine gets the VMEbus address that accesses a specified local memory address.
Not applicable for the 8260Ads
ERROR, always.
sysBusToLocalAdrs( ) - convert a bus address to a local address
STATUS sysBusToLocalAdrs ( int adrsSpace, /* bus address space where busAdrs resides */ char * busAdrs, /* bus address to convert */ char * * pLocalAdrs /* where to return local address */ )
This routine gets the local address that accesses a specified VMEbus physical memory address.
Not applicable for the 8260Ads
ERROR, always.
sysBusTas( ) - test and set a location across the bus
BOOL sysBusTas ( char * adrs /* address to be tested-and-set */ )
This routine does an atomic test-and-set operation across the backplane.
Not applicable for the 8260Ads.
FALSE, always.
sysBusClearTas( ) - test and clear
void sysBusClearTas ( volatile char * address /* address to be tested-and-cleared */ )
This routine is a null function.
NA
vxImmrGet( ) - return the current IMMR value
UINT32 vxImmrGet (void)
This routine returns the current IMMR value
current IMMR value
sysFccEnetEnable( ) - enable the MII interface to the FCC controller
STATUS sysFccEnetEnable ( UINT32 immrVal, /* base address of the on-chip RAM */ UINT8 fccNum /* FCC being used */ )
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.
OK, or ERROR if the FCC controller cannot be enabled.
sysFccEnetDisable( ) - disable MII interface to the FCC controller
STATUS sysFccEnetDisable ( UINT32 immrVal, /* base address of the on-chip RAM */ UINT8 fccNum /* FCC being used */ )
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.
OK, always.
sysFccEnetAddrGet( ) - get the hardware Ethernet address
STATUS sysFccEnetAddrGet ( UINT32 immrVal, /* base address of the on-chip RAM */ UINT8 fccNum, /* FCC being used */ UCHAR * addr /* where to copy the Ethernet address */ )
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.
OK, or ERROR if the Ethernet address cannot be returned.
sysFccEnetCommand( ) - issue a command to the Ethernet interface controller
STATUS sysFccEnetCommand ( UINT32 immrVal, /* base address of the on-chip RAM */ UINT8 fccNum, /* FCC being used */ UINT16 command )
OK, or ERROR if the Ethernet controller could not be restarted.
sysFccMiiBitWr( ) - write one bit to the MII interface
STATUS sysFccMiiBitWr ( UINT32 immrVal, /* base address of the on-chip RAM */ UINT8 fccNum, /* FCC being used */ INT32 bitVal /* the bit being written */ )
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.
sysLib, sysFccMiiBitRd( )
OK, or ERROR.
sysFccMiiBitRd( ) - read one bit from the MII interface
STATUS sysFccMiiBitRd ( UINT32 immrVal, /* base address of the on-chip RAM */ UINT8 fccNum, /* FCC being used */ INT8 * bitVal /* the bit being read */ )
This routine reads one bit from the MDIO line of a MII interface. The MDC line is asserted for a while, and then negated.
sysLib, sysFccMiiBitWr( )
OK, or ERROR.
sysMiiOptRegsHandle( ) - handle some MII optional registers
STATUS sysMiiOptRegsHandle ( PHY_INFO * pPhyInfo /* PHY control structure pointer */ )
This routine handles some MII optional registers in the PHY described by pPhyInfo.
In the case of the ads8260, 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.
OK, or ERROR.
sysFlashLED( ) - flash one of the signal lamps
void sysFlashLED ( int LED /* bitmap of LED to flash */ )
This routine will flash the indicated signal lamp for about 1/4 second
NA
sysControlLED( ) - control one of the signal lamps
void sysControlLED ( int LED, /* bitmap of LED to control */ int on /* if TRUE turn LED ON; otherwise, turn LED OFF */ )
This routine will turn the indicated signal lamp on or off, as requested
NA