\hypertarget{menu_8c}{\section{src/menu.c File Reference}
\label{menu_8c}\index{src/menu.\-c@{src/menu.\-c}}
}
{\ttfamily \#include $<$stdio.\-h$>$}\\*
{\ttfamily \#include \char`\"{}platform.\-h\char`\"{}}\\*
{\ttfamily \#include \char`\"{}xparameters.\-h\char`\"{}}\\*
{\ttfamily \#include \char`\"{}utilities.\-h\char`\"{}}\\*
{\ttfamily \#include \char`\"{}string.\-h\char`\"{}}\\*
{\ttfamily \#include \char`\"{}M\-A\-X\-R\-E\-F\-D\-E\-S14.\-h\char`\"{}}\\*
{\ttfamily \#include \char`\"{}maxim\-Device\-Specific\-Utilities.\-h\char`\"{}}\\*
{\ttfamily \#include \char`\"{}menu.\-h\char`\"{}}\\*
\subsection*{Functions}
\begin{DoxyCompactItemize}
\item 
void \hyperlink{menu_8c_a29e53ae8071b00ff792315adce493063}{menu\-\_\-cls} ()
\begin{DoxyCompactList}\small\item\em Function to clear the screen via Hyperterminal. \end{DoxyCompactList}\item 
void \hyperlink{menu_8c_a673dc8829021474b363dda1c22b3befb}{menu\-\_\-print\-\_\-maxim\-\_\-banner} ()
\begin{DoxyCompactList}\small\item\em Print standard Maxim banner at top of Hyperterminal screen. \end{DoxyCompactList}\item 
void \hyperlink{menu_8c_ad333a097be5c6a864b2815c7a6b1cbcd}{menu\-\_\-print\-\_\-maxim\-\_\-banner\-\_\-big} ()
\begin{DoxyCompactList}\small\item\em Print large Maxim banner at top of Hyperterminal screen. \end{DoxyCompactList}\item 
void \hyperlink{menu_8c_ace23e6e1a7ab7a924f1f1d09dd8a13fd}{menu\-\_\-print\-\_\-prompt} ()
\begin{DoxyCompactList}\small\item\em Print a standard prompt for keyboard input \char`\"{}  $>$ \char`\"{}. \end{DoxyCompactList}\item 
void \hyperlink{menu_8c_afcaf94d0582d364f00d7d99477dccbbc}{menu\-\_\-print\-\_\-line} ()
\begin{DoxyCompactList}\small\item\em Print one line of dashes across the screen via Hyperterminal. \end{DoxyCompactList}\item 
u8 \hyperlink{menu_8c_ae6cba4813d96b75e16e93865d412e247}{menu\-\_\-retrieve\-\_\-keypress} (u32 n\-Uart\-Address)
\begin{DoxyCompactList}\small\item\em Get a single keypress via Hyperterminal. \end{DoxyCompactList}\item 
void \hyperlink{menu_8c_afe3de25ca491e4977109e99d31daa4fe}{menu\-\_\-print\-\_\-main\-\_\-menu} ()
\begin{DoxyCompactList}\small\item\em Print the main menu listing choice of module to test. \end{DoxyCompactList}\item 
void \hyperlink{menu_8c_ad793bfdc9d57cb3259ab526b0a0075dc}{menu\-\_\-read\-\_\-reg} ()
\begin{DoxyCompactList}\small\item\em Print a menu listing read modes. \end{DoxyCompactList}\end{DoxyCompactItemize}


\subsection{Detailed Description}


 \begin{DoxyVerb}      Project: Sonoma (MAXREFDES14#)
     Filename: menu.c
  Description: This module contains all the functions used to
               generate the menus and menu options used to run the
               MAXREFDES14# example firmware.
\end{DoxyVerb}


Revision History\-: \par
 05-\/31-\/13 Rev 01.\-00 G\-L Initial Release 



This code follows the following naming conventions\-:

\par
 char ch\-Pmod\-Value \par
 char (array) s\-Pmod\-String\mbox{[}16\mbox{]} \par
 float f\-Pmod\-Value \par
 int n\-Pmod\-Value \par
 int (array) an\-Pmod\-Value\mbox{[}16\mbox{]} \par
 u16 u\-Pmod\-Value \par
 u16 (array) au\-Pmod\-Value\mbox{[}16\mbox{]} \par
 u8 uch\-Pmod\-Value \par
 u8 (array) auch\-Pmod\-Buffer\mbox{[}16\mbox{]} \par
 unsigned int un\-Pmod\-Value \par
 int $\ast$ pun\-Pmod\-Value 



Definition in file \hyperlink{menu_8c_source}{menu.\-c}.



\subsection{Function Documentation}
\hypertarget{menu_8c_a29e53ae8071b00ff792315adce493063}{\index{menu.\-c@{menu.\-c}!menu\-\_\-cls@{menu\-\_\-cls}}
\index{menu\-\_\-cls@{menu\-\_\-cls}!menu.c@{menu.\-c}}
\subsubsection[{menu\-\_\-cls}]{\setlength{\rightskip}{0pt plus 5cm}void menu\-\_\-cls (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)}}\label{menu_8c_a29e53ae8071b00ff792315adce493063}


Function to clear the screen via Hyperterminal. 


\begin{DoxyParams}{Parameters}
{\em None} & \\
\hline
\end{DoxyParams}

\begin{DoxyRetVals}{Return values}
{\em None} & \\
\hline
\end{DoxyRetVals}


Definition at line 70 of file menu.\-c.

\hypertarget{menu_8c_afcaf94d0582d364f00d7d99477dccbbc}{\index{menu.\-c@{menu.\-c}!menu\-\_\-print\-\_\-line@{menu\-\_\-print\-\_\-line}}
\index{menu\-\_\-print\-\_\-line@{menu\-\_\-print\-\_\-line}!menu.c@{menu.\-c}}
\subsubsection[{menu\-\_\-print\-\_\-line}]{\setlength{\rightskip}{0pt plus 5cm}void menu\-\_\-print\-\_\-line (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)}}\label{menu_8c_afcaf94d0582d364f00d7d99477dccbbc}


Print one line of dashes across the screen via Hyperterminal. 


\begin{DoxyParams}{Parameters}
{\em None} & \\
\hline
\end{DoxyParams}

\begin{DoxyRetVals}{Return values}
{\em None} & \\
\hline
\end{DoxyRetVals}


Definition at line 155 of file menu.\-c.

\hypertarget{menu_8c_afe3de25ca491e4977109e99d31daa4fe}{\index{menu.\-c@{menu.\-c}!menu\-\_\-print\-\_\-main\-\_\-menu@{menu\-\_\-print\-\_\-main\-\_\-menu}}
\index{menu\-\_\-print\-\_\-main\-\_\-menu@{menu\-\_\-print\-\_\-main\-\_\-menu}!menu.c@{menu.\-c}}
\subsubsection[{menu\-\_\-print\-\_\-main\-\_\-menu}]{\setlength{\rightskip}{0pt plus 5cm}void menu\-\_\-print\-\_\-main\-\_\-menu (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)}}\label{menu_8c_afe3de25ca491e4977109e99d31daa4fe}


Print the main menu listing choice of module to test. 

\begin{DoxyParagraph}{Details.}

\end{DoxyParagraph}

\begin{DoxyRetVals}{Return values}
{\em None} & \\
\hline
\end{DoxyRetVals}


Definition at line 189 of file menu.\-c.

\hypertarget{menu_8c_a673dc8829021474b363dda1c22b3befb}{\index{menu.\-c@{menu.\-c}!menu\-\_\-print\-\_\-maxim\-\_\-banner@{menu\-\_\-print\-\_\-maxim\-\_\-banner}}
\index{menu\-\_\-print\-\_\-maxim\-\_\-banner@{menu\-\_\-print\-\_\-maxim\-\_\-banner}!menu.c@{menu.\-c}}
\subsubsection[{menu\-\_\-print\-\_\-maxim\-\_\-banner}]{\setlength{\rightskip}{0pt plus 5cm}void menu\-\_\-print\-\_\-maxim\-\_\-banner (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)}}\label{menu_8c_a673dc8829021474b363dda1c22b3befb}


Print standard Maxim banner at top of Hyperterminal screen. 


\begin{DoxyParams}{Parameters}
{\em None} & \\
\hline
\end{DoxyParams}

\begin{DoxyRetVals}{Return values}
{\em None} & \\
\hline
\end{DoxyRetVals}


Definition at line 84 of file menu.\-c.

\hypertarget{menu_8c_ad333a097be5c6a864b2815c7a6b1cbcd}{\index{menu.\-c@{menu.\-c}!menu\-\_\-print\-\_\-maxim\-\_\-banner\-\_\-big@{menu\-\_\-print\-\_\-maxim\-\_\-banner\-\_\-big}}
\index{menu\-\_\-print\-\_\-maxim\-\_\-banner\-\_\-big@{menu\-\_\-print\-\_\-maxim\-\_\-banner\-\_\-big}!menu.c@{menu.\-c}}
\subsubsection[{menu\-\_\-print\-\_\-maxim\-\_\-banner\-\_\-big}]{\setlength{\rightskip}{0pt plus 5cm}void menu\-\_\-print\-\_\-maxim\-\_\-banner\-\_\-big (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)}}\label{menu_8c_ad333a097be5c6a864b2815c7a6b1cbcd}


Print large Maxim banner at top of Hyperterminal screen. 


\begin{DoxyParams}{Parameters}
{\em None} & \\
\hline
\end{DoxyParams}

\begin{DoxyRetVals}{Return values}
{\em None} & \\
\hline
\end{DoxyRetVals}


Definition at line 108 of file menu.\-c.

\hypertarget{menu_8c_ace23e6e1a7ab7a924f1f1d09dd8a13fd}{\index{menu.\-c@{menu.\-c}!menu\-\_\-print\-\_\-prompt@{menu\-\_\-print\-\_\-prompt}}
\index{menu\-\_\-print\-\_\-prompt@{menu\-\_\-print\-\_\-prompt}!menu.c@{menu.\-c}}
\subsubsection[{menu\-\_\-print\-\_\-prompt}]{\setlength{\rightskip}{0pt plus 5cm}void menu\-\_\-print\-\_\-prompt (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)}}\label{menu_8c_ace23e6e1a7ab7a924f1f1d09dd8a13fd}


Print a standard prompt for keyboard input \char`\"{}  $>$ \char`\"{}. 


\begin{DoxyParams}{Parameters}
{\em None} & \\
\hline
\end{DoxyParams}

\begin{DoxyRetVals}{Return values}
{\em None} & \\
\hline
\end{DoxyRetVals}


Definition at line 141 of file menu.\-c.

\hypertarget{menu_8c_ad793bfdc9d57cb3259ab526b0a0075dc}{\index{menu.\-c@{menu.\-c}!menu\-\_\-read\-\_\-reg@{menu\-\_\-read\-\_\-reg}}
\index{menu\-\_\-read\-\_\-reg@{menu\-\_\-read\-\_\-reg}!menu.c@{menu.\-c}}
\subsubsection[{menu\-\_\-read\-\_\-reg}]{\setlength{\rightskip}{0pt plus 5cm}void menu\-\_\-read\-\_\-reg (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)}}\label{menu_8c_ad793bfdc9d57cb3259ab526b0a0075dc}


Print a menu listing read modes. 

\begin{DoxyParagraph}{Details}

\end{DoxyParagraph}

\begin{DoxyRetVals}{Return values}
{\em None} & \\
\hline
\end{DoxyRetVals}


Definition at line 207 of file menu.\-c.

\hypertarget{menu_8c_ae6cba4813d96b75e16e93865d412e247}{\index{menu.\-c@{menu.\-c}!menu\-\_\-retrieve\-\_\-keypress@{menu\-\_\-retrieve\-\_\-keypress}}
\index{menu\-\_\-retrieve\-\_\-keypress@{menu\-\_\-retrieve\-\_\-keypress}!menu.c@{menu.\-c}}
\subsubsection[{menu\-\_\-retrieve\-\_\-keypress}]{\setlength{\rightskip}{0pt plus 5cm}u8 menu\-\_\-retrieve\-\_\-keypress (
\begin{DoxyParamCaption}
\item[{u32}]{n\-Uart\-Address}
\end{DoxyParamCaption}
)}}\label{menu_8c_ae6cba4813d96b75e16e93865d412e247}


Get a single keypress via Hyperterminal. 

\begin{DoxyParagraph}{Details}
Returns ascii character corresponding to keypress with some preprocessing. \par
 Lower case \char`\"{}a\char`\"{}-\/\char`\"{}z\char`\"{} converted to uppercase \char`\"{}\-A\char`\"{}-\/\char`\"{}\-Z\char`\"{}
\end{DoxyParagraph}

\begin{DoxyParams}[1]{Parameters}
\mbox{\tt in}  & {\em n\-Uart\-Address} & -\/ address of the U\-A\-R\-T peripheral in Micro\-Blaze memory map\\
\hline
\end{DoxyParams}

\begin{DoxyRetVals}{Return values}
{\em Character,partially} & decoded. \\
\hline
\end{DoxyRetVals}


Definition at line 167 of file menu.\-c.

