[processor-sdk/performance-audio-sr.git] / psdk_cust / libarch_k2g_1_0_1_0 / docs / doxygen / latex / da / dec / structlib__memdscr__str.tex
diff --git a/psdk_cust/libarch_k2g_1_0_1_0/docs/doxygen/latex/da/dec/structlib__memdscr__str.tex b/psdk_cust/libarch_k2g_1_0_1_0/docs/doxygen/latex/da/dec/structlib__memdscr__str.tex
--- /dev/null
@@ -0,0 +1,56 @@
+\hypertarget{structlib__memdscr__str}{\section{lib\-\_\-memdscr\-\_\-str Struct Reference}
+\label{structlib__memdscr__str}\index{lib\-\_\-memdscr\-\_\-str@{lib\-\_\-memdscr\-\_\-str}}
+}
+
+
+Memory descriptor structure.
+
+
+
+
+{\ttfamily \#include $<$lib\-\_\-memmgt.\-h$>$}
+
+\subsection*{Data Fields}
+\begin{DoxyCompactItemize}
+\item
+void $\ast$ \hyperlink{structlib__memdscr__str_a95021f2dac50fa28470ebcd4c9c8b14c}{base}
+\item
+size\-\_\-t \hyperlink{structlib__memdscr__str_a34437a2f1655d8adaedb8b6f99baf5d1}{size}
+\item
+size\-\_\-t \hyperlink{structlib__memdscr__str_adf173931ba35fc1b2fa93b8911e2ca09}{used}
+\end{DoxyCompactItemize}
+
+
+\subsection{Detailed Description}
+Memory descriptor structure.
+
+\begin{DoxyRemark}{Remarks}
+The user M\-U\-S\-T define an array of memory descriptors and pass the address of the array to the heap initialization and allocation routines. For example, the memory descriptor array may be defined as\-: \begin{DoxyVerb} lib_memdscr_t libxyz_smem_med;
+ lib_memdscr_t libxyz_smem_fast;
+ lib_memdscr_t libxyz_smem_vfast;
+
+ lib_memdscr_t * libxyz_memdscr_tab[LIB_MEMTYPE_N] = {
+ &libxyz_smem_vfast,
+ &libxyz_smem_fast,
+ &libxyz_smem_med,
+ NULL // scratch slow memory is not used by libxyz
+ };\end{DoxyVerb}
+
+\end{DoxyRemark}
+
+
+\subsection{Field Documentation}
+\hypertarget{structlib__memdscr__str_a95021f2dac50fa28470ebcd4c9c8b14c}{\index{lib\-\_\-memdscr\-\_\-str@{lib\-\_\-memdscr\-\_\-str}!base@{base}}
+\index{base@{base}!lib_memdscr_str@{lib\-\_\-memdscr\-\_\-str}}
+\subsubsection[{base}]{\setlength{\rightskip}{0pt plus 5cm}void$\ast$ lib\-\_\-memdscr\-\_\-str\-::base}}\label{structlib__memdscr__str_a95021f2dac50fa28470ebcd4c9c8b14c}
+base address of the heap \hypertarget{structlib__memdscr__str_a34437a2f1655d8adaedb8b6f99baf5d1}{\index{lib\-\_\-memdscr\-\_\-str@{lib\-\_\-memdscr\-\_\-str}!size@{size}}
+\index{size@{size}!lib_memdscr_str@{lib\-\_\-memdscr\-\_\-str}}
+\subsubsection[{size}]{\setlength{\rightskip}{0pt plus 5cm}size\-\_\-t lib\-\_\-memdscr\-\_\-str\-::size}}\label{structlib__memdscr__str_a34437a2f1655d8adaedb8b6f99baf5d1}
+heap size in number of bytes \hypertarget{structlib__memdscr__str_adf173931ba35fc1b2fa93b8911e2ca09}{\index{lib\-\_\-memdscr\-\_\-str@{lib\-\_\-memdscr\-\_\-str}!used@{used}}
+\index{used@{used}!lib_memdscr_str@{lib\-\_\-memdscr\-\_\-str}}
+\subsubsection[{used}]{\setlength{\rightskip}{0pt plus 5cm}size\-\_\-t lib\-\_\-memdscr\-\_\-str\-::used}}\label{structlib__memdscr__str_adf173931ba35fc1b2fa93b8911e2ca09}
+used size in number of bytes
+
+The documentation for this struct was generated from the following file\-:\begin{DoxyCompactItemize}
+\item
+src/\hyperlink{lib__memmgt_8h}{lib\-\_\-memmgt.\-h}\end{DoxyCompactItemize}