ra8_gpt_state_t Struct Reference

Per-channel runtime state (callback, configured flag). More...

Data Fields
ra8_gpt_event_fn_t	fn
	Registered callback.
void *	ctx
	Callback context.
bool	configured
	True after ra8_gpt_init.

Detailed Description

Per-channel runtime state (callback, configured flag).

See the matching header declaration for the full contract; this site adds no behaviour beyond what the public API documents.

Parameters

[in]

period_counts

See header declaration for direction and constraints.

Returns

ra8_err_t error code (or void if the signature returns void).

Return values

k_ra8_ok	Success path.
k_ra8_err_invalid_arg	Caller violated a precondition.

Precondition

Driver state has been initialized by the matching *_init.

Caller has validated all pointer parameters.

Postcondition

Side effects are limited to those documented in the header.

No global state is modified on the error path.

Note

Thread safety: see the header declaration.

Since

0.1.0

Parameters

[in]	out_counts	See header declaration for direction and constraints.
[in]	count	See header declaration for direction and constraints.
[in]	on_complete	See header declaration for direction and constraints.
[in]	ctx	See header declaration for direction and constraints.
[in]	out_dma_channel	See header declaration for direction and constraints.
[in]	periods	See header declaration for direction and constraints.
[in]	cfg	See header declaration for direction and constraints.

Definition at line 260 of file ra8_gpt.c.

Field Documentation

configured

bool ra8_gpt_state_t::configured

True after ra8_gpt_init.

Definition at line 263 of file ra8_gpt.c.

ctx

void* ra8_gpt_state_t::ctx

Callback context.

Definition at line 262 of file ra8_gpt.c.

fn

ra8_gpt_event_fn_t ra8_gpt_state_t::fn

Registered callback.

Definition at line 261 of file ra8_gpt.c.

---

The documentation for this struct was generated from the following file:

• libs/ra8_hal/src/ra8_gpt.c