SUMT_private.c File Reference

Function definitions for routines common to all SUMT implementations. More...

#include <vxWorks.h>
#include <CTDB/SUMT_rt.h>
#include <PBS/SPIN.h>
#include <MSG/MSG_pubdefs.h>
#include <SUMT_private.h>
#include <mv2600.h>

Functions
void	SUMT_rtLegalize (unsigned short *regPair, unsigned short subAddr)
	Create a Summit legalization mask.
unsigned int	SUMT_reset (unsigned int regs)
	Soft reset Summit controller hardware.
unsigned int	SUMT_test (unsigned int regs)
	Perform Summit controller hardware built in test.
unsigned int	SUMT_regWrite (unsigned int addr, unsigned int offset, unsigned short data, unsigned short mask)
	Write to a Summit controller register.

---

Detailed Description

Function definitions for routines common to all SUMT implementations.

Author:

D.L. Wood

The definitions of particular functions may be conditional on the target type and board.

---

Function Documentation

unsigned int SUMT_regWrite	(	unsigned int	addr,
		unsigned int	offset,
		unsigned short	data,
		unsigned short	mask
	)

Write to a Summit controller register.

Writes a value to one of the Summit controller internal registers. This function performs a read back of the register to verify that the write was successful. Up to SUMT_REG_RETRY retries are allowed before declairing failure. A warning is signalled for every retry. This is related to a problem seen with the EM model SIB board running with a MCP750 CPU.

Parameters:

	addr	The base address of the Summit registers.
	offset	The offset to the register to write.
	data	The register data value.
	mask	A bitmask of the register's writable bits. Used for validation.

Returns:

A CTDB MSG code.

References SUMT_REG_RETRY, SUMT_WORD_READ, and SUMT_WORD_WRITE.

unsigned int SUMT_reset

(

unsigned int

regs

)

Soft reset Summit controller hardware.

Performs a software reset of the Summit controller chip.

Parameters:

regs

The base address of the Summit registers.

Returns:

A CTDB MSG code.

References SUMT_DELAY_RESET_SW, SUMT_MSG, SUMT_READY, SUMT_REG_CONTROL, SUMT_REG_STATUS, SUMT_REG_WRITE, SUMT_SRST, SUMT_WMASK_CONTROL, and SUMT_WORD_READ.

Referenced by SUMT_rtPollInit().

void SUMT_rtLegalize	(	unsigned short *	regPair,
		unsigned short	subAddr
	)

Create a Summit legalization mask.

Creates a bit mask for the Summit illegalization register values. The appropriate bit in one of the regPair words is cleared to allow the indicated subaddress to appear at the remote terminal.

Parameters:

	regPair	A pointer to a pair of 16-bit illegalization values.
	subAddr	The subaddress value to legalize.

Referenced by SUMT_rtPollConfigure().

unsigned int SUMT_test

(

unsigned int

regs

)

Perform Summit controller hardware built in test.

Performs a built in self test (BIT) of the Summit controller chip. A warning is issued if one of the tests reports failure. An error code is returned if both the Channel A and Channel B tests fail, the BIT procedure times out, or if the device does not return to ready status after running the BIT.

Parameters:

regs

The base address of the Summit registers.

Returns:

A CTDB MSG code.

References SUMT_BIT_BITF, SUMT_BIT_CHAF, SUMT_BIT_CHBF, SUMT_DELAY_BIT, SUMT_MSG, SUMT_READY, SUMT_REG_BIT_WORD, SUMT_REG_CONTROL, SUMT_REG_STATUS, SUMT_REG_WRITE, SUMT_SBIT, SUMT_WMASK_CONTROL, and SUMT_WORD_READ.

Referenced by SUMT_rtPollInit().