Input Capture Interface

Interface for sampling input signals for pulse width. More...

Data Structures
struct	input_capture_callback_args_t
struct	input_capture_capture_t
struct	input_capture_info_t
struct	input_capture_cfg_t
struct	input_capture_api_t
struct	input_capture_instance_t

Macros
#define	info_capture_info_t   input_capture_info_t

Typedefs
typedef void	input_capture_ctrl_t

Enumerations
enum	input_capture_mode_t { INPUT_CAPTURE_MODE_PULSE_WIDTH, INPUT_CAPTURE_MODE_PERIOD, INPUT_CAPTURE_MODE_PULSE_COUNT }
enum	input_capture_signal_edge_t { INPUT_CAPTURE_SIGNAL_EDGE_RISING, INPUT_CAPTURE_SIGNAL_EDGE_FALLING }
enum	input_capture_signal_level_t { INPUT_CAPTURE_SIGNAL_LEVEL_NONE, INPUT_CAPTURE_SIGNAL_LEVEL_LOW, INPUT_CAPTURE_SIGNAL_LEVEL_HIGH }
enum	input_capture_repetition_t { INPUT_CAPTURE_REPETITION_PERIODIC, INPUT_CAPTURE_REPETITION_ONE_SHOT }
enum	input_capture_event_t { INPUT_CAPTURE_EVENT_MEASUREMENT, INPUT_CAPTURE_EVENT_OVERFLOW }
enum	input_capture_status_t { INPUT_CAPTURE_STATUS_IDLE, INPUT_CAPTURE_STATUS_CAPTURING }
enum	input_capture_variant_t { INPUT_CAPTURE_VARIANT_32_BIT, INPUT_CAPTURE_VARIANT_16_BIT }

Detailed Description

Interface for sampling input signals for pulse width.

Summary

The input capture interface provides for sampling of input signals to determine the width of a pulse (from one edge to the opposite edge). An interrupt can be triggered after each measurement is captured.

Implemented by:

• GPT Input Capture
• AGT Input Capture

See also: Timer Interface

Related SSP architecture topics:

• SSP Interfaces
• SSP Predefined Layers
• Using SSP Modules

Macro Definition Documentation

info_capture_info_t

#define info_capture_info_t   input_capture_info_t

Mapping of deprecated info_capture_info_t.

Typedef Documentation

input_capture_ctrl_t

typedef void input_capture_ctrl_t

Input capture control block. Allocate an instance specific control block to pass into the input capture API calls.

Implemented as

• gpt_input_capture_instance_ctrl_t
• agt_input_capture_instance_ctrl_t

Enumeration Type Documentation

input_capture_event_t

enum input_capture_event_t

Events that can trigger a callback function

Enumerator
INPUT_CAPTURE_EVENT_MEASUREMENT	A capture measurement has been captured.
INPUT_CAPTURE_EVENT_OVERFLOW	A capture measurement overflowed the counter.

input_capture_mode_t

enum input_capture_mode_t

Input capture operational modes

Enumerator
INPUT_CAPTURE_MODE_PULSE_WIDTH	Measure a signal pulse width.
INPUT_CAPTURE_MODE_PERIOD	Measure a signal Cycle period.
INPUT_CAPTURE_MODE_PULSE_COUNT	Measure a signal event count.

input_capture_repetition_t

enum input_capture_repetition_t

Specifies either a one-time or continuous measurements

Enumerator
INPUT_CAPTURE_REPETITION_PERIODIC	Capture continuous measurements, until explicitly stopped or disabled.
INPUT_CAPTURE_REPETITION_ONE_SHOT	Capture a single measurement, then interrupts are disabled.

input_capture_signal_edge_t

enum input_capture_signal_edge_t

Input capture signal edge trigger

Enumerator
INPUT_CAPTURE_SIGNAL_EDGE_RISING	The capture begins at the rising edge.
INPUT_CAPTURE_SIGNAL_EDGE_FALLING	The capture begins at the falling edge.

input_capture_signal_level_t

enum input_capture_signal_level_t

Input capture signal level, primarily used for the enable signal

Enumerator
INPUT_CAPTURE_SIGNAL_LEVEL_NONE	Use this if signal_level is not applicable to a particular measurement.
INPUT_CAPTURE_SIGNAL_LEVEL_LOW	The capture is enabled at the low level.
INPUT_CAPTURE_SIGNAL_LEVEL_HIGH	The capture is enabled at the high level.

input_capture_status_t

enum input_capture_status_t

Input capture status.

Enumerator
INPUT_CAPTURE_STATUS_IDLE	The input capture timer is idle.
INPUT_CAPTURE_STATUS_CAPTURING	A capture measurement is in progress.

input_capture_variant_t

enum input_capture_variant_t

Input capture timer variant types.

Enumerator
INPUT_CAPTURE_VARIANT_32_BIT	32-bit timer
INPUT_CAPTURE_VARIANT_16_BIT	16-bit timer