MTB CAT1 Peripheral driver library

General Description

Data Structures

struct  cy_stc_tcpwm_motif_hlut_t
 Hall look up table data. More...
 
struct  cy_stc_tcpwm_motif_mlut_t
 Multi Channel Look Up table configuration. More...
 
struct  cy_stc_hall_output_config_t
 User to make sure that all events are not routed to the same node. More...
 
struct  cy_stc_multi_channel_output_config_t
 MOTIF Multi channel output configuration structure. More...
 
struct  cy_stc_tcpwm_motif_hall_sensor_config_t
 MOTIF configuration structure. More...
 
struct  cy_stc_quaddec_output_config_t
 MOTIF Quadrature mode output configuration structure. More...
 
struct  cy_stc_tcpwm_motif_quaddec_config_t
 Quadrature decoder configuration structure. More...
 
struct  cy_stc_tcpwm_motif_mcp_config_t
 Multi Channel mode configuration structure. More...
 
struct  cy_stc_tcpwm_motif_mcp_quaddec_config_t
 Multi Channel mode and quaddec configuration structure. More...
 

Enumerations

enum  cy_en_motif_mode_t {
  CY_MOTIF_HALL_SENSOR_MODE = 0UL,
  CY_MOTIF_QUAD_DECODER_MODE = 1UL,
  CY_MOTIF_STANDALONE_MULTICHANNEL_MODE = 2UL,
  CY_MOTIF_SAMC_QD_MODE = 3UL
}
 Enumeration values for Motif mode Configuration. More...
 
enum  cy_en_position_decoder_mode_t {
  CY_MOTIF_PD_QUAD_MODE = 0UL,
  CY_MOTIF_PD_DIRECTION_COUNT_MODE = 1UL
}
 Enumeration values for quadrature mode Configuration. More...
 
enum  cy_en_mcp_mode_t {
  CY_MULTI_CHANNEL_PATTERN_UPDATE_BYHW = 0UL,
  CY_MULTI_CHANNEL_PATTERN_UPDATE_BYSW = 1UL
}
 Enumeration values for Multi Channel Pattern Update Configuration. More...
 
enum  cy_en_hall_input_event_selection_t {
  CY_WHE_OR_MODULE_PIN = 0UL,
  CY_WRONG_HALL_EVENT = 1UL,
  CY_MODULE_PIN = 2UL
}
 Enumeration values for Motif HALL event Configuration. More...
 
enum  cy_en_trigger_edge_selection_t {
  CY_SAMPLING_TRIGGER_RISING_EDGE = 0UL,
  CY_SAMPLING_TRIGGER_FALLING_EDGE = 1UL
}
 Enumeration values for Motif Sampling Trigger Configuration. More...
 
enum  cy_en_low_pass_filter_config_t {
  CY_LOWPASS_FILTER_DISABLED = 0UL,
  CY_LOWPASS_OF_1CLOCK_CYCLE = 1UL,
  CY_LOWPASS_OF_2CLOCK_CYCLE = 2UL,
  CY_LOWPASS_OF_4CLOCK_CYCLE = 3UL,
  CY_LOWPASS_OF_8CLOCK_CYCLE = 4UL,
  CY_LOWPASS_OF_16CLOCK_CYCLE = 5UL,
  CY_LOWPASS_OF_32CLOCK_CYCLE = 6UL,
  CY_LOWPASS_OF_64CLOCK_CYCLE = 7UL,
  CY_LOWPASS_OF_128CLOCK_CYCLE = 8UL,
  CY_LOWPASS_OF_256CLOCK_CYCLE = 9UL,
  CY_LOWPASS_OF_512CLOCK_CYCLE = 10UL,
  CY_LOWPASS_OF_1024CLOCK_CYCLE = 11UL
}
 Enumeration values for Motif Low Pass Filter Configuration. More...
 
enum  cy_en_motif_suspend_config_t {
  CY_MOTIF_SUSPEND_REQUEST_IGNORED = 0UL,
  CY_MOTIF_MODULE_STOP = 1UL,
  CY_MOTIF_SUSPEND_NEXT_INDEX = 2UL,
  CY_MOTIF_SUSPEND_NEXT_PHASE = 3UL,
  CY_MOTIF_MODULE_STOP_RESET = 4UL,
  CY_MOTIF_SUSPEND_SYNCH = 5UL
}
 Motif Suspend Configuration. More...
 
enum  cy_en_hall_sensor_event_output_node_t {
  CY_IGNORE_HALL_SENSOR_EVENT = 0UL,
  CY_FWD_HALL_SENSOR_EVENT_TO_OUT0 = 1UL,
  CY_FWD_HALL_SENSOR_EVENT_TO_OUT1 = 2UL,
  CY_FWD_HALL_SENSOR_EVENT_TO_OUT2 = 3UL,
  CY_FWD_HALL_SENSOR_EVENT_TO_OUT3 = 4UL,
  CY_FWD_HALL_SENSOR_EVENT_TO_OUT4 = 5UL,
  CY_FWD_HALL_SENSOR_EVENT_TO_OUT5 = 6UL,
  CY_FWD_HALL_SENSOR_EVENT_TO_OUT6 = 7UL
}
 HALL Sensor output event node selection. More...
 
enum  cy_en_multi_channel_event_output_node_t {
  CY_IGNORE_MULTI_CHANNEL_EVENT = 0UL,
  CY_FWD_MULTI_CHANNEL_EVENT_TO_OUT0 = 1UL,
  CY_FWD_MULTI_CHANNEL_EVENT_TO_OUT1 = 2UL,
  CY_FWD_MULTI_CHANNEL_EVENT_TO_OUT2 = 3UL,
  CY_FWD_MULTI_CHANNEL_EVENT_TO_OUT3 = 4UL,
  CY_FWD_MULTI_CHANNEL_EVENT_TO_OUT4 = 5UL,
  CY_FWD_MULTI_CHANNEL_EVENT_TO_OUT5 = 6UL,
  CY_FWD_MULTI_CHANNEL_EVENT_TO_OUT6 = 7UL
}
 Multi channel pattern output event node selection. More...
 
enum  cy_en_quaddec_index_occurrence_t {
  CY_QUADDEC_NO_INDEX_MARKER_GENERATION = 0UL,
  CY_QUADDEC_FIRST_INDEX_OCCURRENCE_GENERATION = 1UL,
  CY_QUADDEC_ALL_INDEX_OCCURRENCE_GENERATION = 2UL
}
 Quaddec index marker generation. More...
 
enum  cy_en_tcpwm_edge_config_t {
  CY_TCPWM_DETECT_ON_BOTH_EDGE = 0UL,
  CY_TCPWM_DETECT_ON_RISING_EDGE = 1UL,
  CY_TCPWM_DETECT_ON_FALLING_EDGE = 2UL,
  CY_TCPWM_IGNORE_EDGE = 3UL
}
 Quaddec Phase edge mode. More...
 
enum  cy_en_quaddec_signal_selector_t {
  CY_QUADDEC_DISABLED = 0UL,
  CY_QUADDEC_POSI0 = 1UL,
  CY_QUADDEC_POSI1 = 2UL,
  CY_QUADDEC_POSI2 = 3UL
}
 Quaddec clock and index selector. More...
 
enum  cy_en_quaddec_event_output_node_t {
  CY_IGNORE_QUADDEC_EVENT = 0UL,
  CY_FWD_QUADDEC_EVENT_TO_OUT0 = 1UL,
  CY_FWD_QUADDEC_EVENT_TO_OUT1 = 2UL,
  CY_FWD_QUADDEC_EVENT_TO_OUT2 = 3UL,
  CY_FWD_QUADDEC_EVENT_TO_OUT3 = 4UL,
  CY_FWD_QUADDEC_EVENT_TO_OUT4 = 5UL,
  CY_FWD_QUADDEC_EVENT_TO_OUT5 = 6UL,
  CY_FWD_QUADDEC_EVENT_TO_OUT6 = 7UL
}
 Quaddec event output node selector. More...
 
enum  cy_en_low_pass_filter_number_t {
  CY_LOW_PASS_FILTER_0 = 0UL,
  CY_LOW_PASS_FILTER_1 = 1UL,
  CY_LOW_PASS_FILTER_2 = 2UL
}
 Low pass filter numbers. More...
 

Enumeration Type Documentation

◆ cy_en_motif_mode_t

Enumeration values for Motif mode Configuration.

Enumerator
CY_MOTIF_HALL_SENSOR_MODE 

MOTIF mode is set to HALL Sensor.

CY_MOTIF_QUAD_DECODER_MODE 

MOTIF mode is set to Quadrature decoder.

CY_MOTIF_STANDALONE_MULTICHANNEL_MODE 

MOTIF mode is set to stand alone multi channel.

CY_MOTIF_SAMC_QD_MODE 

MOTIF mode is set to stand alone multi channel and quadrature decoder.

◆ cy_en_position_decoder_mode_t

Enumeration values for quadrature mode Configuration.

Enumerator
CY_MOTIF_PD_QUAD_MODE 

Position decoder in quadrature decoder mode.

CY_MOTIF_PD_DIRECTION_COUNT_MODE 

Position decoder in direction count mode.

◆ cy_en_mcp_mode_t

Enumeration values for Multi Channel Pattern Update Configuration.

Enumerator
CY_MULTI_CHANNEL_PATTERN_UPDATE_BYHW 

Multichannel pattern updated by Hardware.

CY_MULTI_CHANNEL_PATTERN_UPDATE_BYSW 

Multichannel pattern updated by software.

multi channel patter will be updated only when has set MCMS register MNPS filed

◆ cy_en_hall_input_event_selection_t

Enumeration values for Motif HALL event Configuration.

Enumerator
CY_WHE_OR_MODULE_PIN 

OR between Wrong hall event and the module pin is the source for fault or correct event.

CY_WRONG_HALL_EVENT 

Wrong hall event is the source for fault or correct event.

CY_MODULE_PIN 

the module pin is the source for fault or correct event

◆ cy_en_trigger_edge_selection_t

Enumeration values for Motif Sampling Trigger Configuration.

Enumerator
CY_SAMPLING_TRIGGER_RISING_EDGE 

Rising edge is used of the selected MOTIFx.HSD signal to trigger a sample of the Hall inputs.

CY_SAMPLING_TRIGGER_FALLING_EDGE 

Falling edge is used of the selected MOTIFx.HSD signal to trigger a sample of the Hall inputs.

◆ cy_en_low_pass_filter_config_t

Enumeration values for Motif Low Pass Filter Configuration.

Enumerator
CY_LOWPASS_FILTER_DISABLED 

Low pass filter is disabled.

CY_LOWPASS_OF_1CLOCK_CYCLE 

Low pass of one clock cycle.

CY_LOWPASS_OF_2CLOCK_CYCLE 

Low pass of two clock cycle.

CY_LOWPASS_OF_4CLOCK_CYCLE 

Low pass of four clock cycle.

CY_LOWPASS_OF_8CLOCK_CYCLE 

Low pass of eight clock cycle.

CY_LOWPASS_OF_16CLOCK_CYCLE 

Low pass of sixteen clock cycle.

CY_LOWPASS_OF_32CLOCK_CYCLE 

Low pass of thirty two clock cycle.

CY_LOWPASS_OF_64CLOCK_CYCLE 

Low pass of sixty four clock cycle.

CY_LOWPASS_OF_128CLOCK_CYCLE 

Low pass of one twenty eight clock cycle.

CY_LOWPASS_OF_256CLOCK_CYCLE 

Low pass of two fifty six clock cycle.

CY_LOWPASS_OF_512CLOCK_CYCLE 

Low pass of five twelve clock cycle.

CY_LOWPASS_OF_1024CLOCK_CYCLE 

Low pass of one thousand twenty four clock cycle.

◆ cy_en_motif_suspend_config_t

Motif Suspend Configuration.

Enumerator
CY_MOTIF_SUSPEND_REQUEST_IGNORED 

Motif suspend request is ignored.

motif module continues to run as configured.

CY_MOTIF_MODULE_STOP 

Motif module is stopped immediately.

CY_MOTIF_SUSPEND_NEXT_INDEX 

Motif suspend in the next index for quad mode and quad with stand alone mode.

other modes stop immediately

CY_MOTIF_SUSPEND_NEXT_PHASE 

Motif suspend in the next phase for quad mode and quad with stand alone mode.

other modes stop immediately

CY_MOTIF_MODULE_STOP_RESET 

Motif module is stopped immediately.

Multi channel pattern is to the reset value

CY_MOTIF_SUSPEND_SYNCH 

Suspend with sync of pwm signal.

Multi channel pattern is to the reset value. quad mode stop immediately

◆ cy_en_hall_sensor_event_output_node_t

HALL Sensor output event node selection.

Enumerator
CY_IGNORE_HALL_SENSOR_EVENT 

Ignore hall sensor event.

CY_FWD_HALL_SENSOR_EVENT_TO_OUT0 

Forward hall sensor event to out0.

CY_FWD_HALL_SENSOR_EVENT_TO_OUT1 

Forward hall sensor event to out1.

CY_FWD_HALL_SENSOR_EVENT_TO_OUT2 

Forward hall sensor event to out2.

CY_FWD_HALL_SENSOR_EVENT_TO_OUT3 

Forward hall sensor event to out3.

CY_FWD_HALL_SENSOR_EVENT_TO_OUT4 

Forward hall sensor event to out4.

CY_FWD_HALL_SENSOR_EVENT_TO_OUT5 

Forward hall sensor event to out5.

CY_FWD_HALL_SENSOR_EVENT_TO_OUT6 

Forward hall sensor event to out6.

◆ cy_en_multi_channel_event_output_node_t

Multi channel pattern output event node selection.

Enumerator
CY_IGNORE_MULTI_CHANNEL_EVENT 

Ignore multi channel event.

CY_FWD_MULTI_CHANNEL_EVENT_TO_OUT0 

Forward multi channel event to out0.

CY_FWD_MULTI_CHANNEL_EVENT_TO_OUT1 

Forward multi channel event to out1.

CY_FWD_MULTI_CHANNEL_EVENT_TO_OUT2 

Forward multi channel event to out2.

CY_FWD_MULTI_CHANNEL_EVENT_TO_OUT3 

Forward multi channel event to out3.

CY_FWD_MULTI_CHANNEL_EVENT_TO_OUT4 

Forward multi channel event to out4.

CY_FWD_MULTI_CHANNEL_EVENT_TO_OUT5 

Forward multi channel event to out5.

CY_FWD_MULTI_CHANNEL_EVENT_TO_OUT6 

Forward multi channel event to out6.

◆ cy_en_quaddec_index_occurrence_t

Quaddec index marker generation.

Enumerator
CY_QUADDEC_NO_INDEX_MARKER_GENERATION 

No index marker generation.

CY_QUADDEC_FIRST_INDEX_OCCURRENCE_GENERATION 

First Index occurrence.

CY_QUADDEC_ALL_INDEX_OCCURRENCE_GENERATION 

First Index occurrence.

◆ cy_en_tcpwm_edge_config_t

Quaddec Phase edge mode.

Enumerator
CY_TCPWM_DETECT_ON_BOTH_EDGE 

Clock decoded on both rising edge and falling edge.

CY_TCPWM_DETECT_ON_RISING_EDGE 

Clock decoded on rising edge.

CY_TCPWM_DETECT_ON_FALLING_EDGE 

Clock decoded on falling edge.

CY_TCPWM_IGNORE_EDGE 

Clock is not decoded.

◆ cy_en_quaddec_signal_selector_t

Quaddec clock and index selector.

Enumerator
CY_QUADDEC_DISABLED 

Clock signal is not used in quaddec mode or direction count mode.

CY_QUADDEC_POSI0 

Clock signal POSI0 is used in quaddec mode or direction count mode.

CY_QUADDEC_POSI1 

Clock signal POSI1 is used in quaddec mode or direction count mode.

CY_QUADDEC_POSI2 

Clock signal POSI2 is used in quaddec mode or direction count mode.

◆ cy_en_quaddec_event_output_node_t

Quaddec event output node selector.

Enumerator
CY_IGNORE_QUADDEC_EVENT 

Ignore quaddec event.

CY_FWD_QUADDEC_EVENT_TO_OUT0 

Forward quaddec event to out0.

CY_FWD_QUADDEC_EVENT_TO_OUT1 

Forward quaddec event to out1.

CY_FWD_QUADDEC_EVENT_TO_OUT2 

Forward quaddec event to out2.

CY_FWD_QUADDEC_EVENT_TO_OUT3 

Forward quaddec event to out3.

CY_FWD_QUADDEC_EVENT_TO_OUT4 

Forward quaddec event to out4.

CY_FWD_QUADDEC_EVENT_TO_OUT5 

Forward quaddec event to out5.

CY_FWD_QUADDEC_EVENT_TO_OUT6 

Forward quaddec event to out6.

◆ cy_en_low_pass_filter_number_t

Low pass filter numbers.

Enumerator
CY_LOW_PASS_FILTER_0 

Low pass filter 0.

CY_LOW_PASS_FILTER_1 

Low pass filter 1.

CY_LOW_PASS_FILTER_2 

Low pass filter 2.