timerutil_8h.tex

在DM6446上实现了编码和解码功能

\hypertarget{timerutil_8h}{
\subsection{timerutil.h File Reference}
\label{timerutil_8h}\index{timerutil.h@{timerutil.h}}
}


\subsubsection{Detailed Description}
This interface enables easy benchmarking on Linux. It returns microseconds as unit, but does not in any way guarantee this precision in the resulting numbers. 

The maximum timespan measurable (delta or total) depends on the number of bits of an unsigned long on your system (X), and is 2$^\wedge$X us. With 32-bit unsigned longs this means 2$^\wedge$32 us which is almost 72 minutes.



\footnotesize\begin{verbatim}
 * ============================================================================
 * Copyright (c) Texas Instruments Inc 2007
 *
 * Use of this software is controlled by the terms and conditions found in the
 * license agreement under which this software has been supplied or provided.
 * ============================================================================
 * \end{verbatim}
\normalsize
 

Definition in file \hyperlink{timerutil_8h-source}{timerutil.h}.

{\tt \#include $<$sys/time.h$>$}\par


Include dependency graph for timerutil.h:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=94pt]{timerutil_8h__incl}
\end{center}
\end{figure}
\subsubsection*{Data Structures}
\begin{CompactItemize}
\item 
struct \hyperlink{struct_timer_util_obj_struct}{Timer\-Util\-Obj\-Struct}
\begin{CompactList}\small\item\em Object that stores the state of the timer. Needs to be declared by the application and passed to the timerutil API calls. \item\end{CompactList}\end{CompactItemize}
\subsubsection*{Defines}
\begin{CompactItemize}
\item 
\#define \hyperlink{timerutil_8h_981cbf7bf7785e892f20170f8f62b6ab}{TIMERUTIL\_\-FAILURE}~-1
\begin{CompactList}\small\item\em Indicates that a timer util API call completed successfully. \item\end{CompactList}\item 
\#define \hyperlink{timerutil_8h_7a203dc3eab9729d638e677938abb753}{TIMERUTIL\_\-SUCCESS}~0
\begin{CompactList}\small\item\em Indicates that a timer util API call failed. \item\end{CompactList}\end{CompactItemize}
\subsubsection*{Typedefs}
\begin{CompactItemize}
\item 
typedef \hyperlink{struct_timer_util_obj_struct}{Timer\-Util\-Obj\-Struct} \hyperlink{timerutil_8h_c18b7f3b88d6f4e0abdfaf3738d135c6}{Timer\-Util\-Obj}
\begin{CompactList}\small\item\em Object that stores the state of the timer. Needs to be declared by the application and passed to the timerutil API calls. \item\end{CompactList}\item 
typedef \hyperlink{struct_timer_util_obj_struct}{Timer\-Util\-Obj} $\ast$ \hyperlink{timerutil_8h_908e8c5b17e702295e072f2dbcdaef3c}{Timer\-Util\-Handle}
\begin{CompactList}\small\item\em Pointer to a timer state object. \item\end{CompactList}\end{CompactItemize}
\subsubsection*{Functions}
\begin{CompactItemize}
\item 
static int \hyperlink{timerutil_8h_0b5c8f0a721f3535acd490b694830963}{Timer\-Util\_\-reset} (\hyperlink{struct_timer_util_obj_struct}{Timer\-Util\-Handle} h\-Timer)
\begin{CompactList}\small\item\em Resets the state of the timer. Must be called before other timer util API calls. \item\end{CompactList}\item 
static int \hyperlink{timerutil_8h_d101067f00bf64b27eddcac4987328e8}{Timer\-Util\_\-delta} (\hyperlink{struct_timer_util_obj_struct}{Timer\-Util\-Handle} h\-Timer, unsigned long $\ast$delta\-Ptr)
\begin{CompactList}\small\item\em Calculates the delta in microseconds between now and the last time delta was called (or when reset was called if that is more recent) on this timer object. \item\end{CompactList}\item 
static int \hyperlink{timerutil_8h_6447826bcc117e11d35af1ac146f8c88}{Timer\-Util\_\-total} (\hyperlink{struct_timer_util_obj_struct}{Timer\-Util\-Handle} h\-Timer, unsigned long $\ast$total\-Ptr)
\begin{CompactList}\small\item\em Calculates the delta in microseconds between now and the last time reset was called on this timer object. \item\end{CompactList}\end{CompactItemize}


\subsubsection{Define Documentation}
\hypertarget{timerutil_8h_981cbf7bf7785e892f20170f8f62b6ab}{
\index{timerutil.h@{timerutil.h}!TIMERUTIL_FAILURE@{TIMERUTIL\_\-FAILURE}}
\index{TIMERUTIL_FAILURE@{TIMERUTIL\_\-FAILURE}!timerutil.h@{timerutil.h}}
\paragraph[TIMERUTIL\_\-FAILURE]{\setlength{\rightskip}{0pt plus 5cm}\#define TIMERUTIL\_\-FAILURE~-1}\hfill}
\label{timerutil_8h_981cbf7bf7785e892f20170f8f62b6ab}


Indicates that a timer util API call completed successfully. 



Definition at line 45 of file timerutil.h.

Referenced by Timer\-Util\_\-delta(), Timer\-Util\_\-reset(), and Timer\-Util\_\-total().\hypertarget{timerutil_8h_7a203dc3eab9729d638e677938abb753}{
\index{timerutil.h@{timerutil.h}!TIMERUTIL_SUCCESS@{TIMERUTIL\_\-SUCCESS}}
\index{TIMERUTIL_SUCCESS@{TIMERUTIL\_\-SUCCESS}!timerutil.h@{timerutil.h}}
\paragraph[TIMERUTIL\_\-SUCCESS]{\setlength{\rightskip}{0pt plus 5cm}\#define TIMERUTIL\_\-SUCCESS~0}\hfill}
\label{timerutil_8h_7a203dc3eab9729d638e677938abb753}


Indicates that a timer util API call failed. 



Definition at line 50 of file timerutil.h.

Referenced by Timer\-Util\_\-delta(), Timer\-Util\_\-reset(), and Timer\-Util\_\-total().

\subsubsection{Typedef Documentation}
\hypertarget{timerutil_8h_c18b7f3b88d6f4e0abdfaf3738d135c6}{
\index{timerutil.h@{timerutil.h}!TimerUtilObj@{TimerUtilObj}}
\index{TimerUtilObj@{TimerUtilObj}!timerutil.h@{timerutil.h}}
\paragraph[TimerUtilObj]{\setlength{\rightskip}{0pt plus 5cm}typedef struct \hyperlink{struct_timer_util_obj_struct}{Timer\-Util\-Obj\-Struct}  \hyperlink{struct_timer_util_obj_struct}{Timer\-Util\-Obj}}\hfill}
\label{timerutil_8h_c18b7f3b88d6f4e0abdfaf3738d135c6}


Object that stores the state of the timer. Needs to be declared by the application and passed to the timerutil API calls. 

\hypertarget{timerutil_8h_908e8c5b17e702295e072f2dbcdaef3c}{
\index{timerutil.h@{timerutil.h}!TimerUtilHandle@{TimerUtilHandle}}
\index{TimerUtilHandle@{TimerUtilHandle}!timerutil.h@{timerutil.h}}
\paragraph[TimerUtilHandle]{\setlength{\rightskip}{0pt plus 5cm}typedef \hyperlink{struct_timer_util_obj_struct}{Timer\-Util\-Obj}$\ast$ \hyperlink{struct_timer_util_obj_struct}{Timer\-Util\-Handle}}\hfill}
\label{timerutil_8h_908e8c5b17e702295e072f2dbcdaef3c}


Pointer to a timer state object. 



Definition at line 40 of file timerutil.h.

\subsubsection{Function Documentation}
\hypertarget{timerutil_8h_0b5c8f0a721f3535acd490b694830963}{
\index{timerutil.h@{timerutil.h}!TimerUtil_reset@{TimerUtil\_\-reset}}
\index{TimerUtil_reset@{TimerUtil\_\-reset}!timerutil.h@{timerutil.h}}
\paragraph[TimerUtil\_\-reset]{\setlength{\rightskip}{0pt plus 5cm}static int Timer\-Util\_\-reset (\hyperlink{struct_timer_util_obj_struct}{Timer\-Util\-Handle} {\em h\-Timer})\hspace{0.3cm}{\tt  \mbox{[}inline, static\mbox{]}}}\hfill}
\label{timerutil_8h_0b5c8f0a721f3535acd490b694830963}


Resets the state of the timer. Must be called before other timer util API calls. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em h\-Timer}]Handle of the timer to reset. \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]TIMERUTIL\_\-SUCCESS for success and TIMERUTIL\_\-FAILURE for failure. \end{Desc}


Definition at line 58 of file timerutil.h.

References Timer\-Util\-Obj\-Struct::original, Timer\-Util\-Obj\-Struct::previous, TIMERUTIL\_\-FAILURE, and TIMERUTIL\_\-SUCCESS.\hypertarget{timerutil_8h_d101067f00bf64b27eddcac4987328e8}{
\index{timerutil.h@{timerutil.h}!TimerUtil_delta@{TimerUtil\_\-delta}}
\index{TimerUtil_delta@{TimerUtil\_\-delta}!timerutil.h@{timerutil.h}}
\paragraph[TimerUtil\_\-delta]{\setlength{\rightskip}{0pt plus 5cm}static int Timer\-Util\_\-delta (\hyperlink{struct_timer_util_obj_struct}{Timer\-Util\-Handle} {\em h\-Timer}, unsigned long $\ast$ {\em delta\-Ptr})\hspace{0.3cm}{\tt  \mbox{[}inline, static\mbox{]}}}\hfill}
\label{timerutil_8h_d101067f00bf64b27eddcac4987328e8}


Calculates the delta in microseconds between now and the last time delta was called (or when reset was called if that is more recent) on this timer object. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em h\-Timer}]Handle of the timer to calculate a delta on. \item[{\em delta\-Ptr}]Pointer to where the resulting value will be stored if the operation was successful. \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]TIMERUTIL\_\-SUCCESS for success and TIMERUTIL\_\-FAILURE for failure. \end{Desc}


Definition at line 81 of file timerutil.h.

References Timer\-Util\-Obj\-Struct::previous, TIMERUTIL\_\-FAILURE, and TIMERUTIL\_\-SUCCESS.\hypertarget{timerutil_8h_6447826bcc117e11d35af1ac146f8c88}{
\index{timerutil.h@{timerutil.h}!TimerUtil_total@{TimerUtil\_\-total}}
\index{TimerUtil_total@{TimerUtil\_\-total}!timerutil.h@{timerutil.h}}
\paragraph[TimerUtil\_\-total]{\setlength{\rightskip}{0pt plus 5cm}static int Timer\-Util\_\-total (\hyperlink{struct_timer_util_obj_struct}{Timer\-Util\-Handle} {\em h\-Timer}, unsigned long $\ast$ {\em total\-Ptr})\hspace{0.3cm}{\tt  \mbox{[}inline, static\mbox{]}}}\hfill}
\label{timerutil_8h_6447826bcc117e11d35af1ac146f8c88}


Calculates the delta in microseconds between now and the last time reset was called on this timer object. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em h\-Timer}]Handle of the timer to calculate a delta on. \item[{\em total\-Ptr}]Pointer to where the resulting value will be stored if the operation was successful. \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]TIMERUTIL\_\-SUCCESS for success and TIMERUTIL\_\-FAILURE for failure. \end{Desc}


Definition at line 110 of file timerutil.h.

References Timer\-Util\-Obj\-Struct::original, TIMERUTIL\_\-FAILURE, and TIMERUTIL\_\-SUCCESS.