[processor-sdk/performance-audio-sr.git] / psdk_cust / libarch_k2g_1_0_1_0 / docs / doxygen / latex / db / d68 / lib__memmgt_8h.tex
diff --git a/psdk_cust/libarch_k2g_1_0_1_0/docs/doxygen/latex/db/d68/lib__memmgt_8h.tex b/psdk_cust/libarch_k2g_1_0_1_0/docs/doxygen/latex/db/d68/lib__memmgt_8h.tex
--- /dev/null
@@ -0,0 +1,70 @@
+\hypertarget{lib__memmgt_8h}{\section{src/lib\-\_\-memmgt.h File Reference}
+\label{lib__memmgt_8h}\index{src/lib\-\_\-memmgt.\-h@{src/lib\-\_\-memmgt.\-h}}
+}
+{\ttfamily \#include $<$stdlib.\-h$>$}\\*
+\subsection*{Data Structures}
+\begin{DoxyCompactItemize}
+\item
+struct \hyperlink{structlib__memdscr__str}{lib\-\_\-memdscr\-\_\-str}
+\begin{DoxyCompactList}\small\item\em Memory descriptor structure. \end{DoxyCompactList}\end{DoxyCompactItemize}
+\subsection*{Macros}
+\begin{DoxyCompactItemize}
+\item
+\#define \hyperlink{group__libarch__memmgt_gacfa30c2c1e697da904265b91b9c60d2f}{L\-I\-B\-\_\-\-M\-E\-M\-M\-G\-T\-\_\-\-S\-U\-C\-C\-E\-S\-S}~(0)
+\item
+\#define \hyperlink{group__libarch__memmgt_ga21728661e7141fcfd212ca8286a7947b}{L\-I\-B\-\_\-\-M\-E\-M\-M\-G\-T\-\_\-\-E\-R\-R\-O\-R}~(-\/1)
+\end{DoxyCompactItemize}
+\subsection*{Typedefs}
+\begin{DoxyCompactItemize}
+\item
+typedef struct \hyperlink{structlib__memdscr__str}{lib\-\_\-memdscr\-\_\-str} \hyperlink{group__libarch__memmgt_ga933f44304562f9591104d57b7868ebc3}{lib\-\_\-memdscr\-\_\-t}
+\begin{DoxyCompactList}\small\item\em Memory descriptor structure. \end{DoxyCompactList}\end{DoxyCompactItemize}
+\subsection*{Enumerations}
+\begin{DoxyCompactItemize}
+\item
+enum \{ \\*
+\hyperlink{group__libarch__memmgt_gga06fc87d81c62e9abb8790b6e5713c55ba98a90dd78f7e0d087e7d9c66505011c7}{L\-I\-B\-\_\-\-S\-M\-E\-M\-\_\-\-V\-F\-A\-S\-T} = 0,
+\hyperlink{group__libarch__memmgt_gga06fc87d81c62e9abb8790b6e5713c55ba0554f0354c84251e347c0ee79ffe046d}{L\-I\-B\-\_\-\-S\-M\-E\-M\-\_\-\-F\-A\-S\-T},
+\hyperlink{group__libarch__memmgt_gga06fc87d81c62e9abb8790b6e5713c55bab6e0c7570cd8f2ada826e36d607d8abb}{L\-I\-B\-\_\-\-S\-M\-E\-M\-\_\-\-M\-E\-D},
+\hyperlink{group__libarch__memmgt_gga06fc87d81c62e9abb8790b6e5713c55badc4290cb2bdcc915f3156f39ce3ea361}{L\-I\-B\-\_\-\-S\-M\-E\-M\-\_\-\-S\-L\-O\-W},
+\\*
+\hyperlink{group__libarch__memmgt_gga06fc87d81c62e9abb8790b6e5713c55ba5e2798bb86ffcd081fbd1a7fad3571a2}{L\-I\-B\-\_\-\-P\-M\-E\-M\-\_\-\-M\-E\-D},
+\hyperlink{group__libarch__memmgt_gga06fc87d81c62e9abb8790b6e5713c55ba106f7b37f3b11574158123d265359eeb}{L\-I\-B\-\_\-\-P\-M\-E\-M\-\_\-\-S\-L\-O\-W},
+\hyperlink{group__libarch__memmgt_gga06fc87d81c62e9abb8790b6e5713c55ba1cb4f966271cb92f79ba8229136f3a70}{L\-I\-B\-\_\-\-M\-E\-M\-T\-Y\-P\-E\-\_\-\-N}
+ \}
+\begin{DoxyCompactList}\small\item\em Memory types in terms of speed and volatility. \end{DoxyCompactList}\end{DoxyCompactItemize}
+\subsection*{Functions}
+\begin{DoxyCompactItemize}
+\item
+int \hyperlink{group__libarch__memmgt_gaeeb7c8294fcd4640e4eaf7a741397032}{lib\-\_\-smem\-\_\-vinit} (void $\ast$handle, void $\ast$base, size\-\_\-t size)
+\begin{DoxyCompactList}\small\item\em Function lib\-\_\-smem\-\_\-vinit performs necessary initialization for the very fast scratch heap memory allocation. \end{DoxyCompactList}\item
+int \hyperlink{group__libarch__memmgt_gadd591cf0185afae77c89e62a35af6395}{lib\-\_\-smem\-\_\-finit} (void $\ast$handle, void $\ast$base, size\-\_\-t size)
+\begin{DoxyCompactList}\small\item\em Function lib\-\_\-smem\-\_\-finit performs necessary initialization for the fast scratch heap memory allocation. \end{DoxyCompactList}\item
+int \hyperlink{group__libarch__memmgt_ga991a1c6d4b40f4b4750c7fd1f8aa73f6}{lib\-\_\-smem\-\_\-minit} (void $\ast$handle, void $\ast$base, size\-\_\-t size)
+\begin{DoxyCompactList}\small\item\em Function lib\-\_\-smem\-\_\-minit performs necessary initialization for the medium speed scratch heap memory allocation. \end{DoxyCompactList}\item
+int \hyperlink{group__libarch__memmgt_ga1dd9ae589bdfe68ced145885ea4c4789}{lib\-\_\-smem\-\_\-sinit} (void $\ast$handle, void $\ast$base, size\-\_\-t size)
+\begin{DoxyCompactList}\small\item\em Function lib\-\_\-smem\-\_\-sinit performs necessary initialization for the slow scratch heap memory allocation. \end{DoxyCompactList}\item
+void $\ast$ \hyperlink{group__libarch__memmgt_ga24093174e441c683650863236dcb9806}{lib\-\_\-smem\-\_\-valloc} (void $\ast$handle, size\-\_\-t size, size\-\_\-t align)
+\begin{DoxyCompactList}\small\item\em Function lib\-\_\-smem\-\_\-valloc allocates a memory block from the very fast scratch heap. It will also align the allocated memory block as requested. \end{DoxyCompactList}\item
+void $\ast$ \hyperlink{group__libarch__memmgt_ga51d763b1f89ef58e83cb9e4bc7546ba8}{lib\-\_\-smem\-\_\-falloc} (void $\ast$handle, size\-\_\-t size, size\-\_\-t align)
+\begin{DoxyCompactList}\small\item\em Function lib\-\_\-smem\-\_\-falloc allocates a memory block from the fast scratch heap. It will also align the address of the allocated memory block as requested. \end{DoxyCompactList}\item
+void $\ast$ \hyperlink{group__libarch__memmgt_gaac0047f2fe5ce1dfad45fc0333d906dc}{lib\-\_\-smem\-\_\-malloc} (void $\ast$handle, size\-\_\-t size, size\-\_\-t align)
+\begin{DoxyCompactList}\small\item\em Function lib\-\_\-smem\-\_\-malloc allocates a memory block from the medium speed scratch heap. It will also align the address of the allocated memory block as requested. \end{DoxyCompactList}\item
+void $\ast$ \hyperlink{group__libarch__memmgt_ga08b73e8bf61fb50e20e08f7df4de636b}{lib\-\_\-smem\-\_\-salloc} (void $\ast$handle, size\-\_\-t size, size\-\_\-t align)
+\begin{DoxyCompactList}\small\item\em Function lib\-\_\-smem\-\_\-salloc allocates a memory block from the slow scratch heap. It will also align the address of the allocated memory block as requested. \end{DoxyCompactList}\item
+int \hyperlink{group__libarch__memmgt_ga65c30f7a20c6e359df9d73db0c9078c1}{lib\-\_\-smem\-\_\-vreset} (void $\ast$handle)
+\begin{DoxyCompactList}\small\item\em Function lib\-\_\-smem\-\_\-vreset resets the very fast scratch heap and destroys all allocated memory blocks in it. \end{DoxyCompactList}\item
+int \hyperlink{group__libarch__memmgt_ga18470bba549f0d9c4a6d98a1f615b8c2}{lib\-\_\-smem\-\_\-freset} (void $\ast$handle)
+\begin{DoxyCompactList}\small\item\em Function lib\-\_\-smem\-\_\-freset resets the fast scratch heap and destroys all allocated memory blocks in it. \end{DoxyCompactList}\item
+int \hyperlink{group__libarch__memmgt_ga38dbf46a5af66e691ba20ffb61f9932e}{lib\-\_\-smem\-\_\-mreset} (void $\ast$handle)
+\begin{DoxyCompactList}\small\item\em Function lib\-\_\-smem\-\_\-mreset resets the medium speed scratch heap and destroys all allocated memory blocks in it. \end{DoxyCompactList}\item
+int \hyperlink{group__libarch__memmgt_gaa3fb30e824c80ec62d4e7847f292108f}{lib\-\_\-smem\-\_\-sreset} (void $\ast$handle)
+\begin{DoxyCompactList}\small\item\em Function lib\-\_\-smem\-\_\-mreset resets the slow scratch heap and destroys all allocated memory blocks in it. \end{DoxyCompactList}\item
+static void $\ast$ \hyperlink{group__libarch__memmgt_gaeae499cb566d6411b938107d3ffeb144}{lib\-\_\-pmem\-\_\-malloc} (void $\ast$handle, size\-\_\-t size, size\-\_\-t align)
+\begin{DoxyCompactList}\small\item\em Function lib\-\_\-pmem\-\_\-malloc allocates a memory block from the medium speed permanent heap. It will also align the address of the allocated memory block as requested. \end{DoxyCompactList}\item
+static void $\ast$ \hyperlink{group__libarch__memmgt_ga306a1aa220281f0b6d79b12928bfeff8}{lib\-\_\-pmem\-\_\-salloc} (void $\ast$handle, size\-\_\-t size, size\-\_\-t align)
+\begin{DoxyCompactList}\small\item\em Function lib\-\_\-pmem\-\_\-salloc allocates a memory block from the slow permanent heap. It will also align the address of the allocated memory block as requested. \end{DoxyCompactList}\item
+static void \hyperlink{group__libarch__memmgt_gafeda2ec3f28d9ebb87a8adcecbb0f414}{lib\-\_\-pmem\-\_\-mfree} (void $\ast$handle, void $\ast$mem\-\_\-ptr)
+\begin{DoxyCompactList}\small\item\em Refer to \hyperlink{lib__memmgt_8h}{lib\-\_\-memmgt.\-h} for detailed documentation. \end{DoxyCompactList}\item
+static void \hyperlink{group__libarch__memmgt_gab12e1d41b3d71633c9ab2d8818510f63}{lib\-\_\-pmem\-\_\-sfree} (void $\ast$handle, void $\ast$mem\-\_\-ptr)
+\begin{DoxyCompactList}\small\item\em Refer to \hyperlink{lib__memmgt_8h}{lib\-\_\-memmgt.\-h} for detailed documentation. \end{DoxyCompactList}\end{DoxyCompactItemize}