Capture Subsystem

Collaboration diagram for Capture Subsystem:

Data Structures
struct	capture_generic

Functions
struct capture *	capture_init (uint32_t index)
int32_t	capture_deinit (struct capture *capture)
int32_t	capture_setCallback (struct capture *capture, bool(*callback)(struct capture *capture, uint32_t index, uint64_t time, void *data), void *data)
int32_t	capture_setPeriod (struct capture *capture, uint64_t us)
uint64_t	capture_getTime (struct capture *capture)
uint64_t	capture_getChannelTime (struct capture *capture)

Detailed Description

#include <capture.h>

This is the Capture Subsystem for controlling Capture of a SOC.

The most Capture Driver need a Timer! See TIMER Interface

Function Documentation

capture_deinit()

int32_t capture_deinit

(

struct capture *

capture

)

Deinit Capture

Parameters

capture

Capture instance

Returns

-1 on error 0 on ok

capture_getChannelTime()

uint64_t capture_getChannelTime

(

struct capture *

capture

)

Get Channel Time

Parameters

capture

Capture instance

Returns

Get Time

capture_getTime()

uint64_t capture_getTime

(

struct capture *

capture

)

Get Time see timer_getTime

Parameters

capture

Capture instance

Returns

Get Time

capture_init()

struct capture* capture_init

(

uint32_t

index

)

Init capture instances

Parameters

index

Index of PWM

Returns

Capture Instance NULL on Error

capture_setCallback()

int32_t capture_setCallback	(	struct capture *	capture,
		bool(*)(struct capture *capture, uint32_t index, uint64_t time, void *data)	callback,
		void *	data
	)

Set Capture Callback

Parameters

capture	Capture instance
callback	Callback
data	Data passed to Callback

Returns

-1 on error 0 on ok

capture_setPeriod()

int32_t capture_setPeriod	(	struct capture *	capture,
		uint64_t	us
	)

Set sampling period

Parameters

capture	Capture instance
us	Time

Returns

-1 on error 0 on ok