VxWorks BSP Reference : mtx604
sysLib [mtx604] - Motorola MTXPlus board series system-dependent library
pciAutoConfigLibInit( ) - initialize PCI autoconfig library.
pciAutoCfg( ) - Automatically configure all nonexcluded PCI headers.
pciAutoCfgCtl( ) - set or get pciAutoConfigLib options.
pciAutoDevReset( ) - Quiesce a PCI device and reset all writeable status bits.
pciAutoBusNumberSet( ) - Set the primary, secondary, and subordinate bus number.
pciAutoFuncDisable( ) - Disable a specific PCI function.
pciAutoFuncEnable( ) - Perform final configuration and enable a function.
pciAutoGetNextClass( ) - find the next device of specific type from probe list.
pciAutoRegConfig( ) - Assign PCI space to a single PCI base address register.
pciAutoAddrAlign( ) - Align a PCI address and check boundary conditions.
pciAutoConfig( ) - Automatically configure all nonexcluded PCI headers. Obsolete.
pciConfigLibInit( ) - initialize the configuration access-method and addresses
pciFindDevice( ) - find the nth device with the given device & vendor ID
pciFindClass( ) - find the nth occurence of a device by PCI class code.
pciDevConfig( ) - configure a device on a PCI bus
pciConfigBdfPack( ) - pack parameters for the Configuration Address Register
pciConfigExtCapFind( ) - find extended capability in ECP linked list
pciConfigInByte( ) - read one byte from the PCI configuration space
pciConfigInWord( ) - read one word from the PCI configuration space
pciConfigInLong( ) - read one longword from the PCI configuration space
pciConfigOutByte( ) - write one byte to the PCI configuration space
pciConfigOutWord( ) - write one 16-bit word to the PCI configuration space
pciConfigOutLong( ) - write one longword to the PCI configuration space
pciConfigModifyLong( ) - Perform a masked longword register update
pciConfigModifyWord( ) - Perform a masked longword register update
pciConfigModifyByte( ) - Perform a masked longword register update
pciSpecialCycle( ) - generate a special cycle with a message
pciConfigForeachFunc( ) - check condition on specified bus
pciConfigReset( ) - disable cards for warm boot
sysPciAutoConfig( ) - PCI autoConfig support routine
pciDeviceShow( ) - print information about PCI devices
pciHeaderShow( ) - print a header of the specified PCI device
pciFindDeviceShow( ) - find a device by deviceId, then print an information.
pciFindClassShow( ) - find a device by 24-bit class code
pciConfigStatusWordShow( ) - show the decoded value of the status word
pciConfigCmdWordShow( ) - show the decoded value of the command word
pciConfigFuncShow( ) - show configuration details about a function
pciConfigTopoShow( ) - show PCI topology
sysDec21x40UpdateLoadStr( ) - Update the END load string after PCI Autoconfig
sysDec21x40EnetAddrGet( ) - gets the ethernet address from the ROM register
sysSerialHwInit( ) - initialize the BSP serial devices to a quiescent state
sysSerialHwInit2( ) - connect BSP serial device interrupts
sysSerialChanGet( ) - get the SIO_CHAN device associated with a serial channel
sysSerialReset( ) - reset all serial devices to a quiescent state
sysNvRamGet( ) - get the contents of non-volatile RAM
sysNvRamSet( ) - write to non-volatile RAM
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
sysScsiInit( ) - initialize an on-board SCSI port
inOrderExecute( ) - enforce in-order execution of PowerPC accesses
sysScsiConfig( ) - system SCSI configuration
sysScsiInByte( ) - BSP-specific byte input routine
sysScsiOutByte( ) - BSP-specific byte output routine
sysL2CacheInit( ) - initialize the L2 cache
sysL2CacheDisable( ) - disable the L2 cache(s)
sysL2CacheEnable( ) - enable the L2 cache(s)
ns8730xSuperIoInit( ) - Super I/O initialization
sysRavenInit( ) - initialize the Raven registers
sysRavenInitPciExt( ) - initialize the extended portion of the Raven PCI header
sysRavenErrClr( ) - Clear error conditions in Raven
sysMpicInit( ) - initialize the MPIC in the Raven
sysMpicIntHandler( ) - handle an interrupt received at the Mpic
sysIbcInit( ) - Initialize the IBC
sysIbcIntEnable( ) - enable a IBC interrupt level
sysIbcIntDisable( ) - disable a IBC interrupt level
sysIbcIntHandler( ) - handler of the sl82565 IBC interrupt.
sysZ8536Init( ) - initialize the Zilog Z8536 counter/timer
sysCioReset( ) - reset a specified Zilog Z8536 counter/timer
sysClkIntCIO( ) - Zilog Z8536 interrupt handler
sysAuxClkInit( ) - raven aux. clock initialization routine
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
sysModel( ) - return the model name of the CPU board
sysBspRev( ) - return the BSP version and revision number
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( ) - initialize additional system hardware
sysProcNumGet( ) - get the processor number
sysProcNumSet( ) - set the processor number
sysLanIntEnable( ) - enable the LAN interrupt
sysLanIntDisable( ) - disable the LAN interrupt
sysNvRead( ) - read one byte from NVRAM
sysNvWrite( ) - write one byte to NVRAM
sysCpuCheck( ) - confirm the CPU type
sysDebugMsg( ) - print a debug string to the console in polled mode.
sysDelay( ) - delay for approximately one millisecond
sysMsDelay( ) - delay for the specified amount of time (MS)
sysPciWriteFlush( ) - flush posted PCI writes from buffer
sysProbeErrClr( ) - clear errors associated with probing an address on a bus.
sysPciProbe( ) - probe a PCI bus address
sysBusProbe( ) - probe a bus address based on bus type.
sysDynEnetFind( ) - Find ethernet network device dynamically
sysPciInsertLong( ) - Insert field into PCI data long
sysPciInsertWord( ) - Insert field into PCI data word
sysPciInsertByte( ) - Insert field into PCI data byte
sysPciOutByteConfirm( ) - Byte out to PCI memory space and flush buffers.
sysPciOutWordConfirm( ) - Word out to PCI memory space and flush buffers.
sysPciOutLongConfirm( ) - Long word out to PCI memory space and flush buffers.
This library provides board-specific routines. The chip drivers included are:
i8250Sio.c - Intel 8250 UART driver
ppcDecTimer.c - PowerPC decrementer timer library (system clock)
ravenAuxClk.c - Motorola Raven timer driver for auxiliary clock.
ravenMpic.c - raven Mpic / W83C553 PIB/IBC Interrupt Controller
ravenPci.c - Raven PCI Bus bridge chip initialization
pciAutoConfigLib.c - PCI device auto-configuration library
pciConfigLib.c - PCI Configuration Space Access Library
pciConfigShow.c - Show routines of PCI bus library.
dec21x40End.o - 10baseT/100baseTX DEC 21x4x Ethernet driver
byteNvRam.c - byte-oriented generic non-volatile RAM library
ns8730xSuperIo.c - Super I/O chip initialization
ataDrv.o - ATA/EIDE interface driver
isaDma.c - I8237 ISA DMA transfer interface library
fdcDrv.c - driver for PS2 floppy device controller(FDC)
hawkI2c.c - Falcon/Hawk I2C support.
sysLib.h
VxWorks Programmer's Guide: Configuration
pciAutoConfigLibInit( ) - initialize PCI autoconfig library.
void * pciAutoConfigLibInit ( void * pArg /* reserved for future use */ )
pciAutoConfigLib initialization function.
not set
A cookie for use by subsequent pciAutoConfigLib function
calls.
pciAutoCfg( ) - Automatically configure all nonexcluded PCI headers.
STATUS pciAutoCfg ( void * pCookie /* cookie returned by pciAutoConfigLibInit() */ )
Top level function in the PCI configuration process.
pCookie = pciAutoConfigLibInit(NULL); pciAutoCfgCtl(pCookie, COMMAND, VALUE); ... pciAutoCfgCtl(pCookie, COMMAND, VALUE); pciAutoCfg(pCookie);For ease in converting from the old interface to the new one, a pciAutoCfgCtl( ) command PCI_PSYSTEM_STRUCT_COPY has been implemented. This can be used just like any other pciAutoCfgCtl( ) command, and it will initialize all the values in pSystem. If used, it should be the first call to pciAutoCfgCtl( ).For a description of the COMMANDs and VALUEs to pciAutoCfgCtl( ), see the pciAutoCfgCtl( ) documentation.
For all nonexcluded PCI functions on all PCI bridges, this routine will automatically configure the PCI configuration headers for PCI devices and subbridges. The fields that are programmed are:
1. Status register. 2. Command Register. 3. Latency timer. 4. Cache Line size. 5. Memory and/or I/O base address and limit registers. 6. Primary, secondary, subordinate bus number (for PCI-PCI bridges). 7. Expansion ROM disable. 8. Interrupt Line.
Probe PCI config space and create a list of available PCI functions. Call device exclusion function, if registered, to exclude/include device. Disable all devices before we initialize any. Allocate and assign PCI space to each device. Calculate and set interrupt line value. Initialize and enable each device.
N/A.
pciAutoCfgCtl( ) - set or get pciAutoConfigLib options.
STATUS pciAutoCfgCtl ( void * pCookie, /* system configuration information */ int cmd, /* command word */ void * pArg /* argument for the cmd */ )
pciAutoCfgCtl( ) can be considered analogous to ioctl( ) calls: the call takes arguments of (1) a pCookie, returned by pciAutoConfigLibInit( ). (2) A command, macros for which are defined in pciAutoConfigLib.h. And, (3) an argument, the type of which depends on the specific command, but will always fit in a pointer variable. Currently, only globally effective commands are implemented.
The commands available are:
- PCI_FBB_ENABLE - BOOL * pArg
- PCI_FBB_DISABLE - void
- PCI_FBB_UPDATE - BOOL * pArg
- PCI_FBB_STATUS_GET - BOOL * pArg
- Enable and disable the functions which check Fast Back To Back functionality. PCI_FBB_UPDATE is for use with dynamic/HA applications. It will first disable FBB on all functions, then enable FBB on all functions, if appropriate. In HA applications, it should be called any time a card is added or removed. The BOOL pointed to by pArg for PCI_FBB_ENABLE and PCI_FBB_UPDATE will be set to TRUE if all cards allow FBB functionality and FALSE if either any card does not allow FBB functionality or if FBB is disabled. The BOOL pointed to by pArg for PCI_FBB_STATUS_GET will be set to TRUE if PCI_FBB_ENABLE has been called and FBB is enabled, even if FBB is not activated on any card. It will be set to FALSE otherwise.
Note that in the current implementation, FBB will be enabled or disabled on the entire bus. If any device anywhere on the bus cannot support FBB, then it is not enabled, even if specific sub-busses could support it.
- PCI_MAX_LATENCY_FUNC_SET - FUNCPTR * pArg
- This routine will be called for each function present on the bus when discovery takes place. The routine must accept four arguments, specifying bus, device, function, and a user-supplied argument of type void *. See PCI_MAX_LATENCY_ARG_SET. The routine should return a UINT8 value, which will be put into the MAX_LAT field of the header structure. The user supplied routine must return a valid value each time it is called. There is no mechanism for any ERROR condition, but a default value can be returned in such a case. Default = NULL.
- PCI_MAX_LATENCY_ARG_SET - void * pArg
- When the routine specified in PCI_MAX_LATENCY_FUNC_SET is called, this will be passed to it as the fourth argument.
- PCI_MAX_LAT_ALL_SET - int pArg
- Specifies a constant max latency value for all cards, if no function has been specified with PCI_MAX_LATENCY_FUNC_SET..
- PCI_MAX_LAT_ALL_GET - UINT * pArg
- Retrieves the value of max latency for all cards, if no function has been specified with PCI_MAX_LATENCY_FUNC_SET. Otherwise, the integer pointed to by pArg is set to the value 0xffffffff.
- PCI_MSG_LOG_SET - FUNCPTR * pArg
- The argument specifies a routine will be called to print warning or error messages from pciAutoConfigLib if logMsg( ) has not been initialized at the time pciAutoConfigLib is used. The specified routine must accept arguments in the same format as logMsg( ), but it does not necessarily need to print the actual message. An example of this routine is presented below, which saves the message into a safe memory space and turns on an LED. This command is useful for BSPs which call pciAutoCfg( ) before message logging is enabled. Note that after logMsg( ) is configured, output will go to logMsg( ) even if this command has been called. Default = NULL.
/* sample PCI_MSG_LOG_SET function */ int pciLogMsg(char *fmt,int a1,int a2,int a3,int a4,int a5,int a6) { sysLedOn(4); return(sprintf(sysExcMsg,fmt,a1,a2,a3,a4,a5,a6)); }- PCI_MAX_BUS_GET - int * pArg
- During autoconfiguration, the library will maintain a counter with the highest numbered bus. This can be retrieved by
pciAutoCfgCtl(pCookie, PCI_MAX_BUS_GET, &maxBus)- PCI_CACHE_SIZE_SET - int pArg
- Sets the pci cache line size to the specified value. See CONFIGURATION SPACE PARAMETERS in the pciAutoConfigLib documentation for more details.
- PCI_CACHE_SIZE_GET - int * pArg
- Retrieves the value of the pci cache line size.
- PCI_AUTO_INT_ROUTE_SET - BOOL pArg
- Enables or disables automatic interrupt routing across bridges during the autoconfig process. See "INTERRUPT ROUTING ACROSS PCI-TO-PCI BRIDGES" in the pciAutoConfigLib documentation for more details.
- PCI_AUTO_INT_ROUTE_GET - BOOL * pArg
- Retrieves the status of automatic interrupt routing.
- PCI_MEM32_LOC_SET - UINT32 pArg
- Sets the base address of the PCI 32-bit memory space. Normally, this is given by the BSP constant PCI_MEM_ADRS.
- PCI_MEM32_SIZE_SET - UINT32 pArg
- Sets the maximum size to use for the PCI 32-bit memory space. Normally, this is given by the BSP constant PCI_MEM_SIZE.
- PCI_MEM32_SIZE_GET - UINT32 * pArg
- After autoconfiguration has been completed, this retrieves the actual amount of space which has been used for the PCI 32-bit memory space.
- PCI_MEMIO32_LOC_SET - UINT32 pArg
- Sets the base address of the PCI 32-bit non-prefetch memory space. Normally, this is given by the BSP constant PCI_MEMIO_ADRS.
- PCI_MEMIO32_SIZE_SET - UINT32 pArg
- Sets the maximum size to use for the PCI 32-bit non-prefetch memory space. Normally, this is given by the BSP constant PCI_MEMIO_SIZE.
- PCI_MEMIO32_SIZE_GET - UINT32 * pArg
- After autoconfiguration has been completed, this retrieves the actual amount of space which has been used for the PCI 32-bit non-prefetch memory space.
- PCI_IO32_LOC_SET - UINT32 pArg
- Sets the base address of the PCI 32-bit I/O space. Normally, this is given by the BSP constant PCI_IO_ADRS.
- PCI_IO32_SIZE_SET - UINT32 pArg
- Sets the maximum size to use for the PCI 32-bit I/O space. Normally, this is given by the BSP constant PCI_IO_SIZE.
- PCI_IO32_SIZE_GET - UINT32 * pArg
- After autoconfiguration has been completed, this retrieves the actual amount of space which has been used for the PCI 32-bit I/O space.
- PCI_IO16_LOC_SET - UINT32 pArg
- Sets the base address of the PCI 16-bit I/O space. Normally, this is given by the BSP constant PCI_ISA_IO_ADRS
- PCI_IO16_SIZE_SET - UINT32 pArg
- Sets the maximum size to use for the PCI 16-bit I/O space. Normally, this is given by the BSP constant PCI_ISA_IO_SIZE
- PCI_IO16_SIZE_GET - UINT32 * pArg
- After autoconfiguration has been completed, this retrieves the actual amount of space which has been used for the PCI 16-bit I/O space.
- PCI_INCLUDE_FUNC_SET - FUNCPTR * pArg
- The device inclusion routine is specified by assigning a function pointer with the PCI_INCLUDE_FUNC_SET pciAutoCfgCtl( ) command:
pciAutoCfgCtl(pSystem, PCI_INCLUDE_FUNC_SET,sysPciAutoconfigInclude);This optional user-supplied routine takes as input both the bus-device-function tuple, and a 32-bit quantity containing both the PCI vendorID and deviceID of the function. The function prototype for this function is shown below:STATUS sysPciAutoconfigInclude ( PCI_SYSTEM *pSys, PCI_LOC *pLoc, UINT devVend );This optional user-specified routine is called by PCI AutoConfig for each and every function encountered in the scan phase. The BSP developer may use any combination of the input data to ascertain whether a device is to be excluded from the autoconfig process. The exclusion routine then returns ERROR if a device is to be excluded, and OK if a device is to be included in the autoconfiguration process.Note that PCI-to-PCI Bridges may not be excluded, regardless of the value returned by the BSP device inclusion routine. The return value is ignored for PCI-to-PCI bridges.
The Bridge device will be always be configured with proper primary, secondary, and subordinate bus numbers in the device scanning phase and proper I/O and Memory aperture settings in the configuration phase of autoconfig regardless of the value returned by the BSP device inclusion routine.
- PCI_INT_ASSIGN_FUNC_SET - FUNCPTR * pArg
- The interrupt assignment routine is specified by assigning a function pointer with the PCI_INCLUDE_FUNC_SET pciAutoCfgCtl( ) command:
pciAutoCfgCtl(pCookie, PCI_INT_ASSIGN_FUNC_SET, sysPciAutoconfigIntrAssign);This optional user-specified routine takes as input both the bus-device-function tuple, and an 8-bit quantity containing the contents of the interrupt Pin register from the PCI configuration header of the device under consideration. The interrupt pin register specifies which of the four PCI Interrupt request lines available are connected. The function prototype for this function is shown below:UCHAR sysPciAutoconfigIntrAssign ( PCI_SYSTEM *pSys, PCI_LOC *pLoc, UCHAR pin );This routine may use any combination of these data to ascertain the interrupt level. This value is returned from the function, and will be programmed into the interrupt line register of the function's PCI configuration header. In this manner, device drivers may subsequently read this register in order to calculate the appropriate interrupt vector which to attach an interrupt service routine.
- PCI_BRIDGE_PRE_CONFIG_FUNC_SET - FUNCPTR * pArg
- The bridge pre-configuration pass initialization routine is provided so that the BSP Developer can initialize a bridge device prior to the configuration pass on the bus that the bridge implements. This routine is specified by calling pciAutoCfgCtl( ) with the PCI_BRIDGE_PRE_CONFIG_FUNC_SET command:
pciAutoCfgCtl(pCookie, PCI_BRIDGE_PRE_CONFIG_FUNC_SET, sysPciAutoconfigPreEnumBridgeInit);This optional user-specified routine takes as input both the bus-device-function tuple, and a 32-bit quantity containing both the PCI deviceID and vendorID of the device. The function prototype for this function is shown below:STATUS sysPciAutoconfigPreEnumBridgeInit ( PCI_SYSTEM *pSys, PCI_LOC *pLoc, UINT devVend );This routine may use any combination of these input data to ascertain any special initialization requirements of a particular type of bridge at a specified geographic location.
- PCI_BRIDGE_POST_CONFIG_FUNC_SET - FUNCPTR * pArg
- The bridge post-configuration pass initialization routine is provided so that the BSP Developer can initialize the bridge device after the bus that the bridge implements has been enumerated. This routine is specified by calling pciAutoCfgCtl( ) with the PCI_BRIDGE_POST_CONFIG_FUNC_SET command
pciAutoCfgCtl(pCookie, PCI_BRIDGE_POST_CONFIG_FUNC_SET, sysPciAutoconfigPostEnumBridgeInit);This optional user-specified routine takes as input both the bus-device-function tuple, and a 32-bit quantity containing both the PCI deviceID and vendorID of the device. The function prototype for this function is shown below:STATUS sysPciAutoconfigPostEnumBridgeInit ( PCI_SYSTEM *pSys, PCI_LOC *pLoc, UINT devVend );This routine may use any combination of these input data to ascertain any special initialization requirements of a particular type of bridge at a specified geographic location.
- PCI_ROLLCALL_FUNC_SET - FUNCPTR * pArg
- The specified routine will be configured as a roll call routine.
If a roll call routine has been configured, before any configuration is actually done, the roll call routine is called repeatedly until it returns TRUE. A return value of TRUE indicates that either (1) the specified number and type of devices named in the roll call list have been found during PCI bus enumeration or (2) the timeout has expired without finding all of the specified number and type of devices. In either case, it is assumed that all of the PCI devices which are going to appear on the busses have appeared and we can proceed with PCI bus configuration.
- PCI_TEMP_SPACE_SET - char * pArg
- This command is not currently implemented. It allows the user to set aside memory for use during pciAutoConfigLib execution, e.g. memory set aside using USER_RESERVED_MEM. After PCI configuration has been completed, the memory can be added to the system memory pool using memAddToPool( ).
- PCI_MINIMIZE_RESOURCES
- This command is not currently implemented. It specifies that pciAutoConfigLib minimize requirements for memory and I/O space.
- PCI_PSYSTEM_STRUCT_COPY - PCI_SYSTEM * pArg
- This command has been added for ease of converting from the old interface to the new one. This will set each value as specified in the pSystem structure. If the PCI_SYSTEM structure has already been filled, the pciAutoConfig(pSystem) call can be changed to:
void *pCookie; pCookie = pciAutoConfigLibInit(NULL); pciAutoCfgCtl(pCookie, PCI_PSYSTEM_STRUCT_COPY, (void *)pSystem); pciAutoCfgFunc(pCookie);The fields of the PCI_SYSTEM structure are defined below. For more information about each one, see the paragraphs above and the documentation for pciAutoConfigLib.
- pciMem32
- Specifies the 32-bit prefetchable memory pool base address.
- pciMem32Size
- Specifies the 32-bit prefetchable memory pool size.
- pciMemIo32
- Specifies the 32-bit non-prefetchable memory pool base address.
- pciMemIo32Size
- Specifies the 32-bit non-prefetchable memory pool size
- pciIo32
- Specifies the 32-bit I/O pool base address.
- pciIo32Size
- Specifies the 32-bit I/O pool size.
- pciIo16
- Specifies the 16-bit I/O pool base address.
- pciIo16Size
- Specifies the 16-bit I/O pool size.
- includeRtn
- Specifies the device inclusion routine.
- intAssignRtn
- Specifies the interrupt assignment routine.
- autoIntRouting
- Can be set to TRUE to configure pciAutoConfig( ) only to call the BSP interrupt routing routine for devices on bus number 0. Setting autoIntRoutine to FALSE will configure pciAutoConfig( ) to call the BSP interrupt routing routine for every device regardless of the bos on which the device resides.
- bridgePreInit
- Specifies the bridge initialization routine to call before initializing devices on the bus that the bridge implements.
- bridgePostInit
- Specifies the bridge initialization routine to call after initializing devices on the bus that the bridge implements.
EINVAL if pCookie is not NULL or cmd is not recognized
OK, or ERROR if the command or argument is invalid.
pciAutoDevReset( ) - Quiesce a PCI device and reset all writeable status bits.
STATUS pciAutoDevReset ( PCI_LOC * pPciLoc /* device to be reset */ )
This routine turns off a PCI device by disabling the Memory decoders, I/O decoders, and Bus Master capability. The routine also resets all writeable status bits in the status word that follows the command word sequentially in PCI config space by performing a longword access.
OK, always.
pciAutoBusNumberSet( ) - Set the primary, secondary, and subordinate bus number.
STATUS pciAutoBusNumberSet ( PCI_LOC * pPciLoc, /* device affected */ UINT primary, /* primary bus specification */ UINT secondary, /* secondary bus specification */ UINT subordinate /* subordinate bus specification */ )
This routine sets the primary, secondary, and subordinate bus numbers for a device that implements the Type 1 PCI Configuration Space Header.
This routine has external visibility to enable it to be used by BSP Developers for initialization of PCI Host Bridges that may implement registers similar to those found in the Type 1 Header.
OK, always.
pciAutoFuncDisable( ) - Disable a specific PCI function.
void pciAutoFuncDisable ( PCI_LOC * pPciFunc /* input: Pointer to PCI function struct */ )
This routine clears the I/O, mem, master, & ROM space enable bits for a single PCI function.
The PCI spec says that devices should normally clear these by default after reset but in actual practice, some PCI devices do not fully comply. This routine ensures that the devices have all been disabled before configuration is started.
N/A.
pciAutoFuncEnable( ) - Perform final configuration and enable a function.
void pciAutoFuncEnable ( PCI_SYSTEM * pSys, /* for backwards compatibility */ PCI_LOC * pFunc /* input: Pointer to PCI function structure */ )
Depending upon whether the device is included, this routine initializes a single PCI function as follows:
Initialize the cache line size register Initialize the PCI-PCI bridge latency timers Enable the master PCI bit for non-display devices Set the interrupt line value with the value from the BSP.
N/A.
pciAutoGetNextClass( ) - find the next device of specific type from probe list.
STATUS pciAutoGetNextClass ( PCI_SYSTEM * pSys, /* for backwards compatibility */ PCI_LOC * pPciFunc, /* output: Contains the BDF of the device found */ UINT * index, /* Zero-based device instance number */ UINT pciClass, /* class code field from the PCI header */ UINT mask /* mask is ANDed with the class field */ )
The function uses the probe list which was built during the probing process. Using configuration accesses, it searches for the occurrence of the device subject to the class and mask restrictions outlined below. Setting class to zero and mask to zero allows searching the entire set of devices found regardless of class.
TRUE if a device was found, else FALSE.
pciAutoRegConfig( ) - Assign PCI space to a single PCI base address register.
UINT pciAutoRegConfig ( PCI_SYSTEM * pSys, /* backwards compatibility */ PCI_LOC * pPciFunc, /* Pointer to function in device list */ UINT baseAddr, /* Offset of base PCI address */ UINT nSize, /* Size and alignment requirements */ UINT addrInfo /* PCI address type information */ )
This routine allocates and assigns PCI space (either memory or I/O) to a single PCI base address register.
Returns (1) if BAR supports mapping anywhere in 64-bit address space. Returns (0) otherwise.
pciAutoAddrAlign( ) - Align a PCI address and check boundary conditions.
STATUS pciAutoAddrAlign ( UINT32 base, /* base of available memory */ UINT32 limit, /* last addr of available memory */ UINT32 reqSize, /* required size */ UINT32 * pAlignedBase /* output: aligned address put here */ )
OK, or ERROR if available memory has been exceeded.
pciAutoConfig( ) - Automatically configure all nonexcluded PCI headers. Obsolete.
void pciAutoConfig ( PCI_SYSTEM * pSystem /* PCI system to configure */ )
This routine is obsolete. It is included for backward compatibility only. It is recommended that you use the pciAutoCfg( ) interface instead of this one.
Top level function in the PCI configuration process.
For all nonexcluded PCI functions on all PCI bridges, this routine will automatically configure the PCI configuration headers for PCI devices and subbridges. The fields that are programmed are:
*
1. Status register. 2. Command Register. 3. Latency timer. 4. Cache Line size. 5. Memory and/or I/O base address and limit registers. 6. Primary, secondary, subordinate bus number (for PCI-PCI bridges). 7. Expansion ROM disable. 8. Interrupt Line.
Probe PCI config space and create a list of available PCI functions. Call device exclusion function, if registered, to exclude/include device. Disable all devices before we initialize any. Allocate and assign PCI space to each device. Calculate and set interrupt line value. Initialize and enable each device.
N/A.
pciConfigLibInit( ) - initialize the configuration access-method and addresses
STATUS pciConfigLibInit ( int mechanism, /* configuration mechanism: 0, 1, 2 */ ULONG addr0, /* config-addr-reg / CSE-reg */ ULONG addr1, /* config-data-reg / Forward-reg */ ULONG addr2 /* none / Base-address */ )
This routine initializes the configuration access-method and addresses.
Configuration mechanism one utilizes two 32-bit IO ports located at addresses 0x0cf8 and 0x0cfc. These two ports are:
- P"
- 32-bit configuration address port, at 0x0cf8
- P"
- 32-bit configuration data port, at 0x0cfc
Accessing a PCI function's configuration port is two step process.
- P"
- Write the bus number, physical device number, function number and register number to the configuration address port.
- P"
- Perform an IO read from or an write to the configuration data port.
Configuration mechanism two uses following two single-byte IO ports.
- P"
- Configuration space enable, or CSE, register, at 0x0cf8
- P"
- Forward register, at 0x0cfa
To generate a PCI configuration transaction, the following actions are performed.
* Configuration mechanism zero is for non-PC/PowerPC environments where an area of address space produces PCI configuration transactions. No support for special cycles is included.
- -
- Write the target bus number into the forward register.
- -
- Write a one byte value to the CSE register at 0x0cf8. The bit pattern written to this register has three effects: disables the generation of special cycles; enables the generation of configuration transactions; specifies the target PCI functional device.
- -
- Perform a one, two or four byte IO read or write transaction within the IO range 0xc000 through 0xcfff.
OK, or ERROR if a mechanism is not 0, 1, or 2.
pciFindDevice( ) - find the nth device with the given device & vendor ID
STATUS pciFindDevice ( int vendorId, /* vendor ID */ int deviceId, /* device ID */ int index, /* desired instance of device */ int * pBusNo, /* bus number */ int * pDeviceNo, /* device number */ int * pFuncNo /* function number */ )
This routine finds the nth device with the given device & vendor ID.
OK, or ERROR if the deviceId and vendorId didn't match.
pciFindClass( ) - find the nth occurence of a device by PCI class code.
STATUS pciFindClass ( int classCode, /* 24-bit class code */ int index, /* desired instance of device */ int * pBusNo, /* bus number */ int * pDeviceNo, /* device number */ int * pFuncNo /* function number */ )
This routine finds the nth device with the given 24-bit PCI class code (class subclass prog_if).
The classcode arg of must be carfully constructed from class and sub-class macros.
Example : To find an ethernet class device, construct the classcode arg as follows:
((PCI_CLASS_NETWORK_CTLR << 16 | PCI_SUBCLASS_NET_ETHERNET << 8))
OK, or ERROR if the class didn't match.
pciDevConfig( ) - configure a device on a PCI bus
STATUS pciDevConfig ( int pciBusNo, /* PCI bus number */ int pciDevNo, /* PCI device number */ int pciFuncNo, /* PCI function number */ UINT32 devIoBaseAdrs, /* device IO base address */ UINT32 devMemBaseAdrs, /* device memory base address */ UINT32 command /* command to issue */ )
This routine configures a device that is on a Peripheral Component Interconnect (PCI) bus by writing to the configuration header of the selected device.
It first disables the device by clearing the command register in the configuration header. It then sets the I/O and/or memory space base address registers, the latency timer value and the cache line size. Finally, it re-enables the device by loading the command register with the specified command.
This routine is designed for Type 0 PCI Configuration Headers ONLY. It is NOT usable for configuring, for example, a PCI-to-PCI bridge.
OK always.
pciConfigBdfPack( ) - pack parameters for the Configuration Address Register
int pciConfigBdfPack ( int busNo, /* bus number */ int deviceNo, /* device number */ int funcNo /* function number */ )
This routine packs three parameters into one integer for accessing the Configuration Address Register
packed integer encoded version of bus, device, and function numbers.
pciConfigExtCapFind( ) - find extended capability in ECP linked list
STATUS pciConfigExtCapFind ( UINT8 extCapFindId, /* Extended capabilities ID to search for */ int bus, /* PCI bus number */ int device, /* PCI device number */ int function, /* PCI function number */ UINT8 * pOffset /* returned config space offset */ )
This routine searches for an extended capability in the linked list of capabilities in config space. If found, the offset of the first byte of the capability of interest in config space is returned via pOffset.
OK if Extended Capability found, ERROR otherwise
pciConfigInByte( ) - read one byte from the PCI configuration space
STATUS pciConfigInByte ( int busNo, /* bus number */ int deviceNo, /* device number */ int funcNo, /* function number */ int offset, /* offset into the configuration space */ UINT8 * pData /* data read from the offset */ )
This routine reads one byte from the PCI configuration space
OK, or ERROR if this library is not initialized
pciConfigInWord( ) - read one word from the PCI configuration space
STATUS pciConfigInWord ( int busNo, /* bus number */ int deviceNo, /* device number */ int funcNo, /* function number */ int offset, /* offset into the configuration space */ UINT16 * pData /* data read from the offset */ )
This routine reads one word from the PCI configuration space
OK, or ERROR if this library is not initialized
pciConfigInLong( ) - read one longword from the PCI configuration space
STATUS pciConfigInLong ( int busNo, /* bus number */ int deviceNo, /* device number */ int funcNo, /* function number */ int offset, /* offset into the configuration space */ UINT32 * pData /* data read from the offset */ )
This routine reads one longword from the PCI configuration space
OK, or ERROR if this library is not initialized
pciConfigOutByte( ) - write one byte to the PCI configuration space
STATUS pciConfigOutByte ( int busNo, /* bus number */ int deviceNo, /* device number */ int funcNo, /* function number */ int offset, /* offset into the configuration space */ UINT8 data /* data written to the offset */ )
This routine writes one byte to the PCI configuration space.
OK, or ERROR if this library is not initialized
pciConfigOutWord( ) - write one 16-bit word to the PCI configuration space
STATUS pciConfigOutWord ( int busNo, /* bus number */ int deviceNo, /* device number */ int funcNo, /* function number */ int offset, /* offset into the configuration space */ UINT16 data /* data written to the offset */ )
This routine writes one 16-bit word to the PCI configuration space.
OK, or ERROR if this library is not initialized
pciConfigOutLong( ) - write one longword to the PCI configuration space
STATUS pciConfigOutLong ( int busNo, /* bus number */ int deviceNo, /* device number */ int funcNo, /* function number */ int offset, /* offset into the configuration space */ UINT32 data /* data written to the offset */ )
This routine writes one longword to the PCI configuration space.
OK, or ERROR if this library is not initialized
pciConfigModifyLong( ) - Perform a masked longword register update
STATUS pciConfigModifyLong ( int busNo, /* bus number */ int deviceNo, /* device number */ int funcNo, /* function number */ int offset, /* offset into the configuration space */ UINT32 bitMask, /* Mask which defines field to alter */ UINT32 data /* data written to the offset */ )
This function writes a field into a PCI configuration header without altering any bits not present in the field. It does this by first doing a PCI configuration read (into a temporary location) of the PCI configuration header word which contains the field to be altered. It then alters the bits in the temporary location to match the desired value of the field. It then writes back the temporary location with a configuration write. All configuration accesses are long and the field to alter is specified by the "1" bits in the bitMask parameter.
Be careful to using pciConfigModifyLong for updating the Command and status register. The status bits must be written back as zeroes, else they will be cleared. Proper use involves including the status bits in the mask value, but setting their value to zero in the data value.
The following example will set the PCI_CMD_IO_ENABLE bit without clearing any status bits. The macro PCI_CMD_MASK includes all the status bits as part of the mask. The fact that PCI_CMD_MASTER doesn't include these bits, causes them to be written back as zeroes, therefore they aren't cleared.
pciConfigModifyLong (b,d,f,PCI_CFG_COMMAND, (PCI_CMD_MASK | PCI_CMD_IO_ENABLE), PCI_CMD_IO_ENABLE);Use of explicit longword read and write operations for dealing with any register containing "write 1 to clear" bits is sound policy.
OK if operation succeeds, ERROR if operation fails.
pciConfigModifyWord( ) - Perform a masked longword register update
STATUS pciConfigModifyWord ( int busNo, /* bus number */ int deviceNo, /* device number */ int funcNo, /* function number */ int offset, /* offset into the configuration space */ UINT16 bitMask, /* Mask which defines field to alter */ UINT16 data /* data written to the offset */ )
This function writes a field into a PCI configuration header without altering any bits not present in the field. It does this by first doing a PCI configuration read (into a temporary location) of the PCI configuration header word which contains the field to be altered. It then alters the bits in the temporary location to match the desired value of the field. It then writes back the temporary location with a configuration write. All configuration accesses are long and the field to alter is specified by the "1" bits in the bitMask parameter.
Do not use this routine to modify any register that contains write 1 to clear type of status bits in the same longword. This specifically applies to the command register. Modify byte operations could potentially be implemented as longword operations with bit shifting and masking. This could have the effect of clearing status bits in registers that aren't being updated. Use pciConfigInLong and pciConfigOutLong, or pciModifyLong, to read and update the entire longword.
OK if operation succeeds. ERROR if operation fails.
pciConfigModifyByte( ) - Perform a masked longword register update
STATUS pciConfigModifyByte ( int busNo, /* bus number */ int deviceNo, /* device number */ int funcNo, /* function number */ int offset, /* offset into the configuration space */ UINT8 bitMask, /* Mask which defines field to alter */ UINT8 data /* data written to the offset */ )
This function writes a field into a PCI configuration header without altering any bits not present in the field. It does this by first doing a PCI configuration read (into a temporary location) of the PCI configuration header word which contains the field to be altered. It then alters the bits in the temporary location to match the desired value of the field. It then writes back the temporary location with a configuration write. All configuration accesses are long and the field to alter is specified by the "1" bits in the bitMask parameter.
Do not use this routine to modify any register that contains write 1 to clear type of status bits in the same longword. This specifically applies to the command register. Modify byte operations could potentially be implemented as longword operations with bit shifting and masking. This could have the effect of clearing status bits in registers that aren't being updated. Use pciConfigInLong and pciConfigOutLong, or pciModifyLong, to read and update the entire longword.
OK if operation succeeds, ERROR if operation fails.
pciSpecialCycle( ) - generate a special cycle with a message
STATUS pciSpecialCycle ( int busNo, /* bus number */ UINT32 message /* data driven onto AD[31:0] */ )
This routine generates a special cycle with a message.
OK, or ERROR if this library is not initialized
pciConfigForeachFunc( ) - check condition on specified bus
STATUS pciConfigForeachFunc ( UINT8 bus, /* bus to start on */ BOOL recurse, /* if TRUE, do subordinate busses */ PCI_FOREACH_FUNC funcCheckRtn, /* routine to call for each PCI func */ void * pArg /* argument to funcCheckRtn */ )
pciConfigForeachFunc( ) discovers the PCI functions present on the bus and calls a specified C-function for each one. If the function returns ERROR, further processing stops.
pciConfigForeachFunc( ) does not affect any HOST<->PCI bridge on the system.
not set
OK normally, or ERROR if funcCheckRtn( ) doesn't return OK.
pciConfigReset( ) - disable cards for warm boot
STATUS pciConfigReset ( int startType /* for reboot hook, ignored */ )
pciConfigReset( ) goes through the list of PCI functions at the top-level bus and disables them, preventing them from writing to memory while the system is trying to reboot.
Not set
OK, always
sysPciAutoConfig( ) - PCI autoConfig support routine
void sysPciAutoConfig (void)
This routine instantiates the PCI_SYSTEM structure needed to configure the system. This consists of assigning address ranges to each category of PCI system resource: Prefetchable and Non-Prefetchable 32-bit Memory, and 16- and 32-bit I/O. Global values for the Cache Line Size and Maximum Latency are also specified. Finally, the four supplemental routines for device inclusion/exclusion, interrupt assignment, and pre- and post-enumeration bridge initialization are * specified.
N/A
pciDeviceShow( ) - print information about PCI devices
STATUS pciDeviceShow ( int busNo /* bus number */ )
This routine prints information about PCI devices There are two ways to find out an empty device.
- -
- check Master Abort bit after the access.
- -
- check whether the read value is 0xffff.
It uses the second method, since I didn't see the Master Abort bit of the host/PCI bridge changing.
OK, or ERROR if the library is not initialized.
pciHeaderShow( ) - print a header of the specified PCI device
STATUS pciHeaderShow ( int busNo, /* bus number */ int deviceNo, /* device number */ int funcNo /* function number */ )
This routine prints a header of the PCI device specified by busNo, deviceNo, and funcNo.
OK, or ERROR if this library is not initialized.
pciFindDeviceShow( ) - find a device by deviceId, then print an information.
STATUS pciFindDeviceShow ( int vendorId, /* vendor ID */ int deviceId, /* device ID */ int index /* desired instance of device */ )
This routine finds a device by deviceId, then print an information.
OK, or ERROR if this library is not initialized.
pciFindClassShow( ) - find a device by 24-bit class code
STATUS pciFindClassShow ( int classCode, /* 24-bit class code */ int index /* desired instance of device */ )
This routine finds a device by its 24-bit PCI class code, then prints its information.
OK, or ERROR if this library is not initialized.
pciConfigStatusWordShow( ) - show the decoded value of the status word
STATUS pciConfigStatusWordShow ( int bus, /* bus */ int device, /* device */ int function, /* function */ void * pArg /* ignored */ )
This routine reads the value of the status word for the specified bus,device,function and prints the value in a human-readable format.
OK, always.
pciConfigCmdWordShow( ) - show the decoded value of the command word
STATUS pciConfigCmdWordShow ( int bus, /* bus */ int device, /* device */ int function, /* function */ void * pArg /* ignored */ )
This routine reads the value of the command word for the specified bus,device,function and prints the value in a human-readable format.
OK, always.
pciConfigFuncShow( ) - show configuration details about a function
STATUS pciConfigFuncShow ( int bus, /* bus */ int device, /* device */ int function, /* function */ void * pArg /* ignored */ )
This routine reads various information from the specified bus,device,function, and prints the information in a human-readable format.
OK, always.
pciConfigTopoShow( ) - show PCI topology
void pciConfigTopoShow ()
This routine traverses the PCI bus and prints assorted information about every device found. The information is intended to present the topology of the PCI bus. In includes: (1) the device type, (2) the command and status words, (3) for PCI to PCI bridges the memory and I/O space configuration, and (4) the values of all implemented BARs.
N/A.
sysDec21x40UpdateLoadStr( ) - Update the END load string after PCI Autoconfig
void sysDec21x40UpdateLoadStr (void)
This routine is to be called from sysHwInit( ) before the END initialization takes place, but after the network adapter under consideration has been configured by a mechanism such as PCI autoconfig. This routine will scan for the ethernet device via a call to the "sysLib.c" routine sysDynEnetFind( ). If the enternet device is found, the device's configuration space is read, and the END load string is composed from this information. The endDevTbl entry is then updated with a pointer to the updated load string, which resides in statically allocated data local to this module.
Note that this routine assumes that the entry for the END device is the first entry in the in the END device table (endDevTbl[]).
N/A
sysDec21x40EnetAddrGet( ) - gets the ethernet address from the ROM register
STATUS sysDec21x40EnetAddrGet ( DEC21X40_DRV_CTRL * pDrvCtrl, char * enetAdrs /* pointer to the ethernet address */ )
This routine reads an ethernet address from the serial ROM. It supports legacy, ver 1/A, and 3.0 serial ROM formats.
OK on success, and ERROR if the ethernet address bytes cannot be read.
sysSerialHwInit( ) - initialize the BSP serial devices to a quiescent state
void sysSerialHwInit (void)
This routine initializes the BSP serial device descriptors and puts the devices in a quiescent state. It is called from sysHwInit( ) with interrupts locked. Polled mode serial operations are possible, but not interrupt mode operations which are enabled by sysSerialHwInit2( ).
N/A
sysLib, sysHwInit( ), sysSerialHwInit2( )
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 cannot be connected in sysSerialHwInit( ) because the kernel memory allocator is not initialized at that point, and intConnect( ) calls malloc( ).
N/A
sysLib, sysHwInit2( )
sysSerialChanGet( ) - get the SIO_CHAN device associated with a serial channel
SIO_CHAN * sysSerialChanGet ( int channel /* serial channel */ )
This routine returns a pointer to the SIO_CHAN device associated with a specified serial channel. It is called by usrRoot( ) to obtain pointers when creating the system serial devices, /tyCo/x. It is also used by the WDB agent to locate its serial channel.
A pointer to the SIO_CHAN structure for the channel, or ERROR if the channel is invalid.
sysSerialReset( ) - reset all serial devices to a quiescent state
void sysSerialReset (void)
This routine resets all serial devices to a quiescent state. It is called by sysToMonitor( ).
N/A
sysLib, sysToMonitor( )
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.
OK, or ERROR if access is outside the non-volatile RAM range.
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.
OK, or ERROR if access is outside the non-volatile RAM range.
sysLib, sysNvRamGet( )
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( )
sysScsiInit( ) - initialize an on-board SCSI port
STATUS sysScsiInit ()
This routine creates and initializes an NCR 53C8xx SCSI I/O processor (SIOP) structure(s), enabling use of the on-board SCSI port. It connects the proper interrupt service routine to the desired vector, and enables the interrupt at the desired level.
OK, or ERROR if the SIOP structure cannot be created, the controller cannot be initialized, valid values cannot be set up in the SIOP registers, or the interrupt service routine cannot be connected.
inOrderExecute( ) - enforce in-order execution of PowerPC accesses
void inOrderExecute ()
This routine enforces in-order execution of register accesses to the SCSI I/O processor (SIOP). It is invoked by the SCSI-2 driver, and is a wrapper to a PowerPC assembler instruction.
N/A.
sysScsiConfig( ) - system SCSI configuration
STATUS sysScsiConfig (void)
This routine is an example SCSI configuration routine.
Most of the code for this routine shows how to declare a SCSI peripheral configuration. This routine must be edited to reflect the actual configuration of the user's SCSI bus. This example can also be found in src/config/usrScsi.c.
For users just getting started, hardware configurations can be tested by defining SCSI_AUTO_CONFIG in config.h, which probes the bus and displays all devices found. No device should have the same SCSI bus ID as the VxWorks SCSI port (default = 7), or the same ID as any other device. Check for proper bus termination.
This routine includes three configuration examples that demonstrate configuration of a SCSI hard disk (any type), of an OMTI 3500 floppy disk, and of a tape drive (any type).
The hard disk is divided into two 32-megabyte partitions and a third partition with the remainder of the disk. The first partition is initialized as a dosFs device.
It is recommended that the first partition on a block device (BLK_DEV) be a dosFs device, if the intention is eventually to boot VxWorks from the device. This will simplify the task considerably.
The floppy, since it is a removable medium device, is allowed to have only a single partition, and dosFs is the file system of choice because it facilitates media compatibility with IBM PC machines.
While the hard disk configuration is fairly straightforward, the floppy setup in this example is more intricate. Note that the scsiPhysDevCreate( ) call is issued twice. The first time is merely to get a "handle" to pass to scsiModeSelect( ); the default media type is sometimes inappropriate (in the case of generic SCSI-to-floppy cards). After the hardware is correctly configured, the handle is discarded using scsiPhysDevDelete( ), after which a second call to scsiPhysDevCreate( ) correctly configures the peripheral. (Before the scsiModeSelect( ) call, the configuration information was incorrect.) Also note that following the scsiBlkDevCreate( ) call, correct values for sectorsPerTrack and nHeads must be set using scsiBlkDevInit( ). This is necessary for IBM PC compatibility.
Similarly, the tape configuration is more complex because certain device parameters must be turned off within VxWorks and the tape fixed block size must be defined, assuming that the tape supports fixed blocks.
The last parameter to the dosFsDevInit( ) call is a pointer to a DOS_VOL_CONFIG structure. If NULL is specified, dosFsDevInit( ) reads this information off the disk in the drive. The read may fail if no disk is present or if the disk has no valid dosFs directory. Should that happen, use dosFsMkfs( ) to create a new directory on a disk. This routine uses default parameters (see dosFsLib) that may not be suitable an application, in which case, use dosFsDevInit( ) with a pointer to a valid DOS_VOL_CONFIG structure that has been created and initialized by the user. If dosFsDevInit( ) is used, a call to diskInit( ) should be made to write a new directory on the disk, if the disk is blank or disposable.
The variable pSbdFloppy is global to allow the above calls to be made from the VxWorks shell, for example:
-> dosFsMkfs "/fd0/", pSbdFloppyIf a disk is new, use diskFormat( ) to format it.
sysScsiInByte( ) - BSP-specific byte input routine
UINT8 sysScsiInByte ( UINT32 adr /* address of where to read byte */ )
This routine reads one byte at the specified address in a BSP-specific manner. It is invoked by the SCSI-2 driver, and is a wrapper to a PowerPC assembler routine.
unsigned byte
sysScsiOutByte( ) - BSP-specific byte output routine
void sysScsiOutByte ( UINT32 adr, /* address of where to write byte */ UINT8 val /* value of byte to write */ )
This routine writes one byte at the specified address in a BSP-specific manner. It is invoked by the SCSI-2 driver, and is a wrapper to a PowerPC assembler routine.
N/A.
sysL2CacheInit( ) - initialize the L2 cache
STATUS sysL2CacheInit (void)
This routine initializes and enables L2 cache(s) support. It should be called at startup, before sysL2CacheEnable( ), to avoid invalidating the L2 tags.
OK, or ERROR if no caches are present or none are supported.
sysLib, sysL2CacheInit( ), sysL2CacheEnable( ), sysL2CacheDisable( )
sysL2CacheDisable( ) - disable the L2 cache(s)
void sysL2CacheDisable (void)
This routine disables the L2 cache(s) if either or both were previously initialized using sysL2CacheInit( ). Calling this routine invalidates the L2 tag bits.
N/A
sysLib, sysL2CacheInit( ), sysL2CacheEnable( ), sysL2CacheDisable( )
sysL2CacheEnable( ) - enable the L2 cache(s)
void sysL2CacheEnable (void)
This routine enables the L2 cache(s). It checks for the presence of either L2 cache and ensures that the cache(s) is(are) disabled.
N/A
sysLib, sysL2CacheInit( ), sysL2CacheEnable( ), sysL2CacheDisable( )
ns8730xSuperIoInit( ) - Super I/O initialization
STATUS ns8730xSuperIoInit (void)
This function performs the necessary initialization for the National Semiconductor chips pc87307 and pc87308.
OK or ERROR if chip base address not found.
sysRavenInit( ) - initialize the Raven registers
void sysRavenInit (void)
This function performs the first portion of the required initialization of the Raven registers, and sets up the CPU->PCI windows.
N/A
sysRavenInitPciExt( ) - initialize the extended portion of the Raven PCI header
STATUS sysRavenInitPciExt ( int busNo, /* bus number */ int deviceNo, /* device number */ int funcNo /* function number */ )
This routine initializes the extended portion of the PCI header for the Motorola Raven ISA Bridge Controller (IBC).
OK, or ERROR if...
sysRavenErrClr( ) - Clear error conditions in Raven
void sysRavenErrClr (void)
This routine clears any existing errors in the Motorola Raven PCI Host Bridge Controller.
N/A
sysMpicInit( ) - initialize the MPIC in the Raven
STATUS sysMpicInit (void)
This function initializes the Multi-Processor Interrupt Controller (MPIC) contained in the Raven chip.
It first initializes the system vector table, connects the MPIC interrupt handler to the PPC external interrupt and attaches the local MPIC routines for interrupt connecting, enabling and disabling to the corresponding system routine pointers.
It then initializes the MPIC registers, clears any pending MPIC interrupts, enables interrupt handling by the MPIC and enables external ISA interrupts (from the W83C553).
OK always
sysMpicIntHandler( ) - handle an interrupt received at the Mpic
void sysMpicIntHandler (void)
This routine will process interrupts received from PCI or ISA devices as these interrupts arrive via the MPIC. This routine supports MPIC interrupt nesting.
N/A
sysIbcInit( ) - Initialize the IBC
STATUS sysIbcInit (void)
This routine initializes the non-PCI Header configuration registers of the IBC within the W83C553 PIB. This is also compatible for the PBC within the VT82C586B PIPC.
OK always
sysIbcIntEnable( ) - enable a IBC interrupt level
void sysIbcIntEnable ( int intNum /* interrupt level to enable */ )
This routine enables a specified IBC interrupt level.
N/A
sysIbcIntDisable( ) - disable a IBC interrupt level
void sysIbcIntDisable ( int intNum /* interrupt level to disable */ )
This routine disables a specified IBC interrupt level.
N/A
sysIbcIntHandler( ) - handler of the sl82565 IBC interrupt.
void sysIbcIntHandler (void)
This routine handles interrupts originating from the W83C553 PIB ISA Bus Controller (IBC). This device implements the functional equivalent of two cascaded 8259 PICs.
This routine is entered with CPU external interrupts enabled.
Because the ISA bus is only accessible via the PCI bus, this driver first initiates a PCI interrupt acknowledge cycle to read the interrupt number (vector) coming from the IBC.
This routine then processes the interrupt by calling all interrupt service routines chained to the vector.
Finally, this routine re-arms the interrupt at the IBC by performing a IBC EOI.
N/A
sysZ8536Init( ) - initialize the Zilog Z8536 counter/timer
UINT sysZ8536Init (void)
This routine initializes the Zilog Z8536 ZCIO counter/timer for any and all of the system clock, auxiliary clock, and timestamp clock functions. It serves all counter/timer channels.
This routine should be called before any other routine in this module.
N/A.
sysCioReset( ) - reset a specified Zilog Z8536 counter/timer
void sysCioReset ( volatile UINT8 * pCio /* CIO to reset */ )
This routine resets the specified Zilog Z8536 ZCIO counter/timer.
N/A.
sysClkIntCIO( ) - Zilog Z8536 interrupt handler
void sysClkIntCIO (void)
This is the clock interrupt handler for the Zilog Z8536 ZCIO counter/timer driver. It supports the system clock, auxiliary clock, and the timestamp clock.
The BSP should connect this routine to the appropriate interrupt vector as a normal part of sysHwInit2( ).
N/A
sysLib, sysHwInit2( )
sysAuxClkInit( ) - raven aux. clock initialization routine
STATUS sysAuxClkInit (void)
This routine should be called before calling any other routine in this module.
OK, or ERROR.
sysAuxClkConnect( ) - connect a routine to the auxiliary clock interrupt
STATUS sysAuxClkConnect ( FUNCPTR routine, /* routine called at each aux clock interrupt */ int arg /* argument with which to call routine */ )
This routine specifies the interrupt service routine to be called at each auxiliary clock interrupt.
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.
N/A
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 is not supported, since the auxiliary clock always runs at the same rate as the system clock.
OK or ERROR.
sysLib, sysAuxClkEnable( ), sysAuxClkRateGet( )
sysModel( ) - return the model name of the CPU board
char * sysModel (void)
This routine returns the model name of the CPU board. The returned string depends on the board model and CPU version being used, for example, "Motorola MTX - MPC 604e".
A pointer to the string.
sysBspRev( ) - return the BSP version and revision number
char * sysBspRev (void)
This routine returns a pointer to a BSP version and revision number, for example, 1.1/0. BSP_REV is concatenated to BSP_VERSION and returned.
A pointer to the BSP version/revision string.
sysHwInit( ) - initialize the system hardware
void sysHwInit (void)
This routine initializes various features of the CPU board. It is called by usrInit( ) in usrConfig.c. This routine sets up the control registers and initializes various devices if they are present.
This routine should not be called directly by the user application. It cannot be used to initialize interrupt vectors.
N/A
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.
Normally, the user specifies the amount of physical memory with the macro LOCAL_MEM_SIZE in config.h. BSPs that support run-time memory sizing do so only if the macro LOCAL_MEM_AUTOSIZE is defined. If not defined, then LOCAL_MEM_SIZE is assumed to be, and must be, the true size of physical memory.
Do no adjust LOCAL_MEM_SIZE to reserve memory for application use. See sysMemTop( ) for more information on reserving 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 by 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( ) - initialize additional system hardware
void sysHwInit2 (void)
This routine connects system interrupt vectors and configures any required features not configured by sysHwInit( ).
N/A
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.
N/A
sysLib, sysProcNumGet( )
sysLanIntEnable( ) - enable the LAN interrupt
STATUS sysLanIntEnable ( int intLevel /* interrupt level to enable */ )
This routine enables interrupts at a specified level for the on-board LAN chip. LAN interrupts are controlled by the ISA Bridge Control (IBC) chip. The LANCE chip on this board is on the Peripheral Component Interconnect (PCI) bus. The PCI interrupts should be routed through the IBC to the processor. The LANCE chip asserts PCI IRQ0 which is routed to the IBC. The IBC must be programmed to generate an ISA IRQ10.
OK, or ERROR if network support not included.
sysLanIntDisable( ) - disable the LAN interrupt
STATUS sysLanIntDisable ( int intLevel /* interrupt level to enable */ )
This routine disables interrupts for the on-board LAN chip.
OK, or ERROR if network support not included.
sysNvRead( ) - read one byte from NVRAM
UCHAR sysNvRead ( ULONG offset /* NVRAM offset to read the byte from */ )
This routine reads a single byte from a specified offset in NVRAM.
The byte from the specified NVRAM offset.
sysNvWrite( ) - write one byte to NVRAM
void sysNvWrite ( ULONG offset, /* NVRAM offset to write the byte to */ UCHAR data /* datum byte */ )
This routine writes a single byte to a specified offset in NVRAM. The MVME2600 uses a 48T18 device w/fast write times, no wait.
N/A
sysCpuCheck( ) - confirm the CPU type
void sysCpuCheck (void)
This routine validates the cpu type. If the wrong cpu type is discovered a message is printed using the serial channel in polled mode.
N/A.
sysDebugMsg( ) - print a debug string to the console in polled mode.
void sysDebugMsg ( char * str, UINT32 recovery )
This routine prints a message to the system console in polled mode and optionally exits to the monitor.
N/A
sysDelay( ) - delay for approximately one millisecond
void sysDelay (void)
Delay for approximately one milli-second.
N/A
sysMsDelay( ) - delay for the specified amount of time (MS)
void sysMsDelay ( UINT delay /* length of time in MS to delay */ )
This routine will delay for the specified amount of time by counting decrementer ticks.
This routine is not dependent on a particular rollover value for the decrementer, it should work no matter what the rollover value is.
A small amount of count may be lost at the rollover point resulting in the sysMsDelay( ) causing a slightly longer delay than requested.
This routine will produce incorrect results if the delay time requested requires a count larger than 0xffffffff to hold the decrementer elapsed tick count. For a System Bus Speed of 67 MHZ this amounts to about 258 seconds.
N/A
sysPciWriteFlush( ) - flush posted PCI writes from buffer
STATUS sysPciWriteFlush (void)
This routine flushes the posted write buffer in the Raven and the Dec2155x if it is present.
OK if flush succeeded or ERROR if an error occured.
sysProbeErrClr( ) - clear errors associated with probing an address on a bus.
void sysProbeErrClr (void)
This routine clears the error flags and conditions in the DAR, DSISR, SRR0 and SRR1 PowerPC registers arising from probing addresses as well as the Raven MERST and PCI_CFG_STATUS registers and V_AMERR registers.
N/A
sysPciProbe( ) - probe a PCI bus address
STATUS sysPciProbe ( char * adrs, /* address to be probed */ int mode, /* VX_READ or VX_WRITE */ int length, /* 1, 2 or 4 byte probe */ char * pVal /* address of value to write OR address of */ /* location to place value read */ )
This routine probes an address on the PCI bus. The PCI bridge (Raven chip) must have a special setup to enable generation of Master Abort cycles on write probes and reception of Target Abort cycles on read probes. The Raven MPC must be configured to generate Machine Check interrupts on Master Abort or Target Abort cycles. The CPU must be configured to enable Machine Check exceptions. All probing is done with interrupts disabled.
OK or ERROR if address cannot be probed
sysBusProbe( ) - probe a bus address based on bus type.
STATUS sysBusProbe ( char * adrs, /* address to be probed */ int mode, /* VX_READ or VX_WRITE */ int length, /* 1, 2 or 4 byte probe */ char * pVal /* address of value to write OR address of */ /* location to place value read */ )
This routine is a function hook into vxMemProbe. It determines which bus, PCI or local is being probed based on the address to be probed. If the PCI bus is being probed, the sysPciProbe( ) routine is called to do the special PCI probing. If the local bus is being probed, the routine calls an architecture-specific probe routine.
ERROR if the probed address does not respond or causes a MMU fault. Returns OK if the probed address responds.
sysDynEnetFind( ) - Find ethernet network device dynamically
STATUS sysDynEnetFind ( UINT bus, /* input: bus number on which to look */ UINT device, /* input: device number to match */ UINT function, /* input: function number to match */ PCI_ID * pciId /* output: encoded identification structure */ )
This function dynamically finds the ethernet network device. The encoded identification structure, pciId is returned if the device is found. The constraints of the search require that the device found be on the PCI bus number which matches the bus, device and function input parameters.
OK if ethernet device is found, ERROR otherwise
sysPciInsertLong( ) - Insert field into PCI data long
void sysPciInsertLong ( UINT32 adrs, /* PCI address */ UINT32 bitMask, /* Mask which defines field to alter */ UINT32 data /* data written to the offset */ )
This function writes a field into a PCI data long without altering any bits not present in the field. It does this by first doing a PCI long read (into a temporary location) of the PCI data long which contains the field to be altered. It then alters the bits in the temporary location to match the desired value of the field. It then writes back the temporary location with a PCI long write. All PCI accesses are byte and the field to alter is specified by the "1" bits in the bitMask parameter.
N/A
sysPciInsertWord( ) - Insert field into PCI data word
void sysPciInsertWord ( UINT32 adrs, /* PCI address */ UINT16 bitMask, /* Mask which defines field to alter */ UINT16 data /* data written to the offset */ )
This function writes a field into a PCI data word without altering any bits not present in the field. It does this by first doing a PCI word read (into a temporary location) of the PCI data word which contains the field to be altered. It then alters the bits in the temporary location to match the desired value of the field. It then writes back the temporary location with a PCI word write. All PCI accesses are word and the field to alter is specified by the "1" bits in the bitMask parameter.
N/A
sysPciInsertByte( ) - Insert field into PCI data byte
void sysPciInsertByte ( UINT32 adrs, /* PCI address */ UINT8 bitMask, /* Mask which defines field to alter */ UINT8 data /* data written to the offset */ )
This function writes a field into a PCI data byte without altering any bits not present in the field. It does this by first doing a PCI byte read (into a temporary location) of the PCI data byte which contains the field to be altered. It then alters the bits in the temporary location to match the desired value of the field. It then writes back the temporary location with a PCI byte write. All PCI accesses are byte and the field to alter is specified by the "1" bits in the bitMask parameter.
N/A
sysPciOutByteConfirm( ) - Byte out to PCI memory space and flush buffers.
void sysPciOutByteConfirm ( UINT32 adrs, /* PCI address */ UINT8 data /* data to be written */ )
This function outputs a byte to PCI memory space and then flushes the PCI write posting buffers by reading from the target address. Since the PCI spec requires the completion of posted writes before the completion of delayed reads, when the read completes, the write posting buffers have been flushed.
If the write is performed through a PCI-to-PCI bridge to a shared location that is subject to unprotected access by multiple simultaneous processors, there is the possibility that the bridge will deliver a delayed read completion to a PCI bus master which was not the original initiator of the delayed read. When this occurs, it appears as if a PCI delayed read had passed a posted write, which would violate PCI transaction ordering rules. If this is a concern, an additional read must be performed outside of this routine to guarantee that the confirming read performed in this routine was not aliased.
N/A
sysPciOutWordConfirm( ) - Word out to PCI memory space and flush buffers.
void sysPciOutWordConfirm ( UINT32 adrs, /* PCI address */ UINT16 data /* data to be written */ )
This function outputs a word to PCI memory space and then flushes the PCI write posting buffers by reading from the target address. Since the PCI spec requires the completion of posted writes before the completion of delayed reads, when the read completes, the write posting buffers have been flushed.
If the write is performed through a PCI-to-PCI bridge to a shared location that is subject to unprotected access by multiple simultaneous processors, there is the possibility that the bridge will deliver a delayed read completion to a PCI bus master which was not the original initiator of the delayed read. When this occurs, it appears as if a PCI delayed read had passed a posted write, which would violate PCI transaction ordering rules. If this is a concern, an additional read must be performed outside of this routine to guarantee that the confirming read performed in this routine was not aliased.
N/A
sysPciOutLongConfirm( ) - Long word out to PCI memory space and flush buffers.
void sysPciOutLongConfirm ( UINT32 adrs, /* PCI address */ UINT32 data /* data to be written */ )
This function outputs a long word to PCI memory space and then flushes the PCI write posting buffers by reading from the target address. Since the PCI spec requires the completion of posted writes before the completion of delayed reads, when the read completes, the write posting buffers have been flushed.
If the write is performed through a PCI-to-PCI bridge to a shared location that is subject to unprotected access by multiple simultaneous processors, there is the possibility that the bridge will deliver a delayed read completion to a PCI bus master which was not the original initiator of the delayed read. When this occurs, it appears as if a PCI delayed read had passed a posted write, which would violate PCI transaction ordering rules. If this is a concern, an additional read must be performed outside of this routine to guarantee that the confirming read performed in this routine was not aliased.
N/A