Pulse Train Engine

Data Structures
struct	mxc_pt_cfg_t

Enumerations
enum	mxc_clk_scale_t

Functions
void	MXC_PT_Init (mxc_clk_scale_t clk_scale)
void	MXC_PT_Shutdown (uint32_t pts)
int	MXC_PT_Config (mxc_pt_cfg_t *cfg)
int	MXC_PT_SqrWaveConfig (unsigned channel, uint32_t freq)
void	MXC_PT_Start (unsigned pts)
void	MXC_PT_Stop (unsigned pts)
uint32_t	MXC_PT_IsActive (uint32_t pts)
void	MXC_PT_SetPattern (unsigned pts, uint32_t pattern)
void	MXC_PT_EnableStopInt (uint32_t pts)
void	MXC_PT_DisableStopInt (uint32_t pts)
uint32_t	MXC_PT_GetStopFlags (void)
void	MXC_PT_ClearStopFlags (uint32_t flags)
void	MXC_PT_EnableRestart (unsigned start, unsigned stop, uint8_t restartIndex)
void	MXC_PT_DisableRestart (unsigned channel, uint8_t restartIndex)
void	MXC_PT_Resync (uint32_t pts)
void	MXC_PT_EnableReadyInt (uint32_t pts)
void	MXC_PT_DisableReadyInt (uint32_t pts)
uint32_t	MXC_PT_GetReadyFlags (void)
void	MXC_PT_ClearReadyFlags (uint32_t flags)

Detailed Description

This is the high level API for the pulse train engine.

---

Data Structure Documentation

mxc_pt_cfg_t

struct mxc_pt_cfg_t

Structure type for pulse train mode configuration.

Note

Do not use for square wave

Data Fields
unsigned	channel
uint32_t	bps
uint32_t	pattern
uint8_t	ptLength
uint16_t	loop
uint16_t	loopDelay

Field Documentation

bps

uint32_t bps

pulse train bit rate

channel

unsigned channel

PT Channel to use

loop

uint16_t loop

Number of times to repeat the train, 0 = continuous

loopDelay

uint16_t loopDelay

Delay between loops specified in bits Example: loopDelay = 4, delays time = time it takes to shift out 4 bits

pattern

uint32_t pattern

Output pattern to shift out, starts at LSB

ptLength

uint8_t ptLength

Number of bits in pulse train, 0 = 32bits, 1 = non valid , 2 = 2 bits, ...

Enumeration Type Documentation

mxc_clk_scale_t

enum mxc_clk_scale_t

Enumeration type for the system clock scale types

Function Documentation

MXC_PT_ClearReadyFlags()

void MXC_PT_ClearReadyFlags

(

uint32_t

flags

)

Clears the pulse train's Ready interrupt flag.

Parameters

flags

bits to clear, see MXC_PT_READY_INTFL_Register Register for details.

MXC_PT_ClearStopFlags()

void MXC_PT_ClearStopFlags

(

uint32_t

flags

)

Clears the pulse train's Stop interrupt flag.

Note

This is an explicit version of MXC_PT_ClearStopFlags()

Parameters

flags

bits to clear, see MXC_PT_STOP_INTFL_Register Register for details.

MXC_PT_Config()

int MXC_PT_Config

(

mxc_pt_cfg_t *

cfg

)

Configures the pulse train in the specified mode.

The parameters in the config structure must be set before calling this function. This function should be used for configuring pulse train mode only.

Note

The pulse train cannot be running when this function is called.

Parameters

cfg	Pointer to pulse train configuration.

Returns

E_NO_ERROR if everything is successful, error if unsuccessful.

MXC_PT_DisableReadyInt()

void MXC_PT_DisableReadyInt

(

uint32_t

pts

)

Disable Ready interrupts for the pulse trains selected.

Parameters

pts	Bit mask of what pulse trains to disable. Set the bit position of each pulse train to disable it. Bit0->pt0, Bit1->pt1... etc, 1 will disable the interrupt, 0 to leave a PT channel in its current state.

MXC_PT_DisableRestart()

void MXC_PT_DisableRestart	(	unsigned	channel,
		uint8_t	restartIndex
	)

Disable the restart for the specified pulse train.

Parameters

channel	Pulse train channel
restartIndex	selects which restart trigger to disable (0 or 1)

MXC_PT_DisableStopInt()

void MXC_PT_DisableStopInt

(

uint32_t

pts

)

Disable Stop interrupts for the pulse trains selected.

Note

This is an explicit version of MXC_PT_DisableInt()

Parameters

pts	Bit mask of what pulse trains to disable. Set the bit position of each pulse train to disable it. Bit0->pt0, Bit1->pt1... etc, 1 will disable the interrupt, 0 to leave a PT channel in its current state.

MXC_PT_EnableReadyInt()

void MXC_PT_EnableReadyInt

(

uint32_t

pts

)

Enable Ready interrupts for the pulse trains selected.

Parameters

pts	Bit mask of which pulse trains to enable. Set the bit position of each pulse train to enable it. Bit0->pt0, Bit1->pt1... etc, 1 will enable the interrupt, 0 to leave a PT channel in its current state.

MXC_PT_EnableRestart()

void MXC_PT_EnableRestart	(	unsigned	start,
		unsigned	stop,
		uint8_t	restartIndex
	)

Setup and enables a pulse train to restart after another pulse train has exited its loop. Each pulse train can have up to two restart triggers.

Parameters

start	Pulse train channel to start.
stop	Pulse train channel to stop.
restartIndex	selects which restart trigger to set (0 or 1).

MXC_PT_EnableStopInt()

void MXC_PT_EnableStopInt

(

uint32_t

pts

)

Enable Stop interrupts for the pulse trains selected.

Note

This is just an explicit version of MXC_PT_EnableInt()

Parameters

pts	Bit mask of which pulse trains to enable. Set the bit position of each pulse train to enable it. Bit0->pt0, Bit1->pt1... etc, 1 will enable the interrupt, 0 to leave a PT channel in its current state.

MXC_PT_GetReadyFlags()

uint32_t MXC_PT_GetReadyFlags

(

void

)

Gets the pulse trains's Ready interrupt flags.

Returns

The Pulse Train Interrupt Flags, MXC_PT_READY_INTFL_Register Register for details.

MXC_PT_GetStopFlags()

uint32_t MXC_PT_GetStopFlags

(

void

)

Gets the pulse trains's Stop interrupt flags.

Note

This is an explicit version of MXC_PT_GetStopFlags()

Returns

The Pulse Train Interrupt Flags, MXC_PT_STOP_INTFL_Register Register for details.

MXC_PT_Init()

void MXC_PT_Init

(

mxc_clk_scale_t

clk_scale

)

This function initializes the pulse trains to a known stopped state and sets the global PT clock scale.

Parameters

clk_scale

Scale the system clock for the global PT clock.

MXC_PT_IsActive()

uint32_t MXC_PT_IsActive

(

uint32_t

pts

)

Determines if the pulse trains selected are running.

Parameters

pts	Set the bits of pulse trains to check Bit0->pt0, Bit1->pt1... etc.

Returns

0 All pulse trains are off.

>0 At least one pulse train is on.

MXC_PT_Resync()

void MXC_PT_Resync

(

uint32_t

pts

)

Resynchronize individual pulse trains together. Resync will stop those resync_pts; others will be still running.

Parameters

pts	Pulse train modules that need to be re-synced by bit number. Bit0->pt0, Bit1->pt1... etc.

MXC_PT_SetPattern()

void MXC_PT_SetPattern	(	unsigned	pts,
		uint32_t	pattern
	)

Sets the pattern of the pulse train.

Parameters

pts	Pulse train pts to operate on.
pattern	Output pattern.

MXC_PT_Shutdown()

void MXC_PT_Shutdown

(

uint32_t

pts

)

Shutdown the pulse train channel/channels.

Shutdown pulse train and if all pluse trains are shut down then turn off pulse train clock.

Note

Shutdown pulse train channel/channels and delete config.

Parameters

pts	Pulse train channel to operate on.

MXC_PT_SqrWaveConfig()

int MXC_PT_SqrWaveConfig	(	unsigned	channel,
		uint32_t	freq
	)

Configures the pulse train in the square wave mode.

This function should be used for configuring square wave mode only.

Note

The pulse train cannot be running when this function is called

Parameters

channel	Pulse train channel to operate on
freq	square wave output frequency in Hz

Returns

E_NO_ERROR if everything is successful, error if unsuccessful.

MXC_PT_Start()

void MXC_PT_Start

(

unsigned

pts

)

Starts the pulse trains specified.

Parameters

pts	Pulse train pts to operate on.

MXC_PT_Stop()

void MXC_PT_Stop

(

unsigned

pts

)

Stops pulse trains.

Parameters

pts	Pulse train pts to stop.