\section{aversive\_\-10-03-12/modules/encoding/hamming/hamming.h File Reference}
\label{hamming_8h}\index{aversive\_\-10-03-12/modules/encoding/hamming/hamming.h@{aversive\_\-10-03-12/modules/encoding/hamming/hamming.h}}
\subsection*{Functions}
\begin{CompactItemize}
\item 
void {\bf hamming\_\-do} (uint32\_\-t $\ast$frame)
\item 
uint8\_\-t {\bf hamming\_\-undo} (uint32\_\-t $\ast$frame)
\end{CompactItemize}


\subsection{Function Documentation}
\index{hamming.h@{hamming.h}!hamming\_\-do@{hamming\_\-do}}
\index{hamming\_\-do@{hamming\_\-do}!hamming.h@{hamming.h}}
\subsubsection[hamming\_\-do]{\setlength{\rightskip}{0pt plus 5cm}void hamming\_\-do (uint32\_\-t $\ast$ {\em frame})}\label{hamming_8h_ff94925b3bed87baf31985851bf0b227}


Encode the frame (the 24 LSB bits) into a 29 bits frame with hamming \doxyref{error}{p.}{structerror} correction bits. The 3 MSB bits are not used. 

Definition at line 299 of file hamming.c.

References hamming\_\-expand(), and hamming\_\-process().\index{hamming.h@{hamming.h}!hamming\_\-undo@{hamming\_\-undo}}
\index{hamming\_\-undo@{hamming\_\-undo}!hamming.h@{hamming.h}}
\subsubsection[hamming\_\-undo]{\setlength{\rightskip}{0pt plus 5cm}uint8\_\-t hamming\_\-undo (uint32\_\-t $\ast$ {\em frame})}\label{hamming_8h_22f7dc4171eaa1cd257006d82d314137}


Decode the 29 bits frame into a 24 bits one. If an \doxyref{error}{p.}{structerror} occurs, the function tries to correct it and returns a positive value. If there is no \doxyref{error}{p.}{structerror}, the function returns 0. 

Definition at line 306 of file hamming.c.

References hamming\_\-correct(), hamming\_\-shrink(), and hamming\_\-unprocess().