QDEC

Modules
	QDEC_Registers

Enumerations
enum	mxc_qdec_counter_mode_t
enum	mxc_qdec_swap_t
enum	mxc_qdec_filter_t
enum	mxc_qdec_sticky_t
enum	mxc_qdec_clkdiv_t
enum	mxc_qdec_rst_on_t
enum	mxc_qdec_function_t

Functions
int	MXC_QDEC_Init (mxc_qdec_req_t *req)
int	MXC_QDEC_Shutdown (void)
void	MXC_QDEC_EnableInt (uint32_t flags)
void	MXC_QDEC_DisableInt (uint32_t flags)
int	MXC_QDEC_GetFlags (void)
void	MXC_QDEC_ClearFlags (uint32_t flags)
void	MXC_QDEC_SetMaxCount (uint32_t maxCount)
int	MXC_QDEC_GetMaxCount (void)
void	MXC_QDEC_SetInitial (uint32_t initial)
int	MXC_QDEC_GetInitial (void)
void	MXC_QDEC_SetCompare (uint32_t compare)
int	MXC_QDEC_GetCompare (void)
int	MXC_QDEC_GetIndex (void)
int	MXC_QDEC_GetCapture (void)
int	MXC_QDEC_Handler (void)
int	MXC_QDEC_GetPosition (void)
int	MXC_QDEC_GetDirection (void)

Detailed Description

Enumeration Type Documentation

mxc_qdec_clkdiv_t

enum mxc_qdec_clkdiv_t

Enumeration type for QDEC clock divider.

Enumerator
MXC_QDEC_CLKDIV_1	QDEC Scale by 1.
MXC_QDEC_CLKDIV_2	QDEC Scale by 1/2.
MXC_QDEC_CLKDIV_4	QDEC Scale by 1/4.
MXC_QDEC_CLKDIV_8	QDEC Scale by 1/8.
MXC_QDEC_CLKDIV_16	QDEC Scale by 1/16.
MXC_QDEC_CLKDIV_32	QDEC Scale by 1/32.
MXC_QDEC_CLKDIV_64	QDEC Scale by 1/64.
MXC_QDEC_CLKDIV_128	QDEC Scale by 1/128.

mxc_qdec_counter_mode_t

enum mxc_qdec_counter_mode_t

Enumeration type for the QDEC Counter Modes.

Enumerator
MXC_QDEC_X1_MODE	Select Channel 0.
MXC_QDEC_X2_MODE	Select Channel 1.
MXC_QDEC_x4_MODE	Select Channel 2.

mxc_qdec_filter_t

enum mxc_qdec_filter_t

Enumeration type for QDEC Filtering.

Enumerator
MXC_QDEC_FILTER_1_SAMPLE	QDEC Pulse active for one clock cycle.
MXC_QDEC_FILTER_2_SAMPLES	QDEC Pulse active for one clock cycle.
MXC_QDEC_FILTER_3_SAMPLES	QDEC Pulse active for one clock cycle.
MXC_QDEC_FILTER_4_SAMPLES	QDEC Pulse active for one clock cycle.

mxc_qdec_sticky_t

enum mxc_qdec_sticky_t

Enumeration type for QDEC Sticky Condition.

Enumerator
MXC_QDEC_STICKY_PULSE	QDEC Pulse active for one clock cycle.
MXC_QDEC_STICKY_MIRROR	QDEC Mirror state.

mxc_qdec_swap_t

enum mxc_qdec_swap_t

Enumeration type for QDEC Phase Swap.

Enumerator
MXC_QDEC_SWAP_CW_A_LEADS_B	QDEC Clockwise QEA leads QEB.
MXC_QDEC_SWAP_CW_B_LEADS_A	QDEC Clockwise QEB leads QEA.

Function Documentation

MXC_QDEC_ClearFlags()

void MXC_QDEC_ClearFlags

(

uint32_t

flags

)

Clear interrupt flags.

Parameters

flags

mask of flags to clear

MXC_QDEC_DisableInt()

void MXC_QDEC_DisableInt

(

uint32_t

flags

)

Disable specific QDEC interrupts.

Parameters

flags

mask of interrupt flags to enables

MXC_QDEC_EnableInt()

void MXC_QDEC_EnableInt

(

uint32_t

flags

)

Enable specific QDEC interrupts.

Parameters

flags

mask of interrupt flags to enables

MXC_QDEC_GetCapture()

int MXC_QDEC_GetCapture

(

void

)

Retrieves capture value.

Returns

capture value latched from position register

MXC_QDEC_GetCompare()

int MXC_QDEC_GetCompare

(

void

)

Retrieves Compare value.

Returns

value in compare register

MXC_QDEC_GetDirection()

int MXC_QDEC_GetDirection

(

void

)

Gets the direction (Clockwise/Counter-Clockwise) of the QDEC.

Returns

see Error Codes for a list of return codes.

MXC_QDEC_GetFlags()

int MXC_QDEC_GetFlags

(

void

)

Retrieves current interrupt flag status.

Returns

active flags

MXC_QDEC_GetIndex()

int MXC_QDEC_GetIndex

(

void

)

Retrieves Index value.

Returns

value in index register

MXC_QDEC_GetInitial()

int MXC_QDEC_GetInitial

(

void

)

Retrieves Initial position value.

Returns

minimum position value

MXC_QDEC_GetMaxCount()

int MXC_QDEC_GetMaxCount

(

void

)

Retrieves Maximum position value.

Returns

maximum position value

MXC_QDEC_GetPosition()

int MXC_QDEC_GetPosition

(

void

)

Gets the current position of the QDEC.

Returns

see Error Codes for a list of return codes.

MXC_QDEC_Handler()

int MXC_QDEC_Handler

(

void

)

Call this function from the QDEC ISR when using Async API functions.

Returns

Success/Fail, see Error Codes for a list of return codes.

MXC_QDEC_Init()

int MXC_QDEC_Init

(

mxc_qdec_req_t *

req

)

Performs the QDEC startup procedure.

Returns

Success/Fail, see Error Codes for a list of return codes.

MXC_QDEC_SetCompare()

void MXC_QDEC_SetCompare

(

uint32_t

compare

)

Sets the Compare value for the QDEC.

Parameters

compare

register value

MXC_QDEC_SetInitial()

void MXC_QDEC_SetInitial

(

uint32_t

initial

)

Sets the Initial (Minimum) Poisiton Count for the QDEC.

Parameters

minimum

position value

MXC_QDEC_SetMaxCount()

void MXC_QDEC_SetMaxCount

(

uint32_t

maxCount

)

Sets the Maximum Poisiton Count for the QDEC.

Parameters

maximum

position value

MXC_QDEC_Shutdown()

int MXC_QDEC_Shutdown

(

void

)

Shuts down the QDEC.

Returns

Success/Fail, see Error Codes for a list of return codes.