Struct syncword_hit_t¶

What syncword_find found.More...

#include <syncword_core.h>

Public Attributes¶

Type	Name
uint32_t	errors
int	found
int	inverted
size_t	offset

Detailed Description¶

A record rather than an out-parameter and a status, because offset, polarity and distance are ONE answer: a receiver that took the offset without the polarity would hand its frame decoder bits it will silently misread. found is what the other three mean nothing without, which is why it is a field rather than a sentinel offset — the same choice frame_check_t makes with its checked.

Distinct from dp_syncword_hit_t, which the kernel fills through a pointer and leaves untouched on a miss: this one is a total answer, returned by value, and so has somewhere to put "no".

Public Attributes Documentation¶

variable errors¶

uint32_t syncword_hit_t::errors;

Hamming distance to the marker there

variable found¶

int syncword_hit_t::found;

A marker was found: 1 yes, 0 no

variable inverted¶

int syncword_hit_t::inverted;

The stream is complemented

variable offset¶

size_t syncword_hit_t::offset;

Bit index where the marker starts

The documentation for this class was generated from the following file native/inc/syncword/syncword_core.h