Petaluma (MAXREFDES30#) Code Documentation  V01.00
16-Bit, 8-Ch, +/-10V input, Simultaneous-Sampling Analog Front End
 All Data Structures Files Functions Variables Macros Pages
Macros | Functions
menu.h File Reference
#include "xbasic_types.h"
#include "stdio.h"
#include "MAXREFDES30.h"

Go to the source code of this file.

Macros

#define MAIN_MENU   0
 // Menu state machine state
 
#define WAIT_KEYPRESS   1
 // Menu state machine state
 
#define MENU_SAMPLE_SPEED   2
 // Menu state machine state
 
#define MENU_SAMPLE_SIZE   3
 // Menu state machine state
 
#define START_CONTINUOUS_SAMPLING   4
 // Menu state machine state
 
#define START_BLOCK_SAMPLING   5
 // Menu state machine state
 
#define MENU_CHANNEL   6
 
#define BASE_FUNCTION_STATE   10
 // Menu state machine state
 
#define KEYPRESS_ARROW_UP   240
 Assign up-arrow an extended ascii code which won't be used elsewhere.
 
#define KEYPRESS_ARROW_DOWN   241
 Assign up-arrow an extended ascii code which won't be used elsewhere.
 
#define KEYPRESS_ARROW_LEFT   242
 Assign up-arrow an extended ascii code which won't be used elsewhere.
 
#define KEYPRESS_ARROW_RIGHT   243
 Assign up-arrow an extended ascii code which won't be used elsewhere.
 
#define KEYPRESS_END   244
 Assign up-arrow an extended ascii code which won't be used elsewhere.
 

Functions

void menu_cls ()
 Function to clear the screen via Hyperterminal.
 
void menu_print_maxim_banner ()
 Print standard Maxim banner at top of Hyperterminal screen.
 
void menu_print_maxim_banner_big ()
 Print large Maxim banner at top of Hyperterminal screen.
 
void menu_print_prompt ()
 Print a standard prompt for keyboard input " > ".
 
u8 menu_retrieve_keypress (u32 nUartAddress)
 Get a single keypress via Hyperterminal.
 
void menu_print_main_menu ()
 Print the main menu listing choice of module to test.
 
void menu_print_channel_menu ()
 
void menu_print_sample_rate_menu ()
 Print a menu listing sample speed choices.
 
void menu_print_sample_size_menu ()
 Print a menu listing sample size choices.
 

Detailed Description

      Project: Petaluma (MAXREFDES30#)
     Filename: menu.h
  Description: This module contains all the functions used to
               generate the menus and menu options used to run the
               MAXREFDES30# example firmware.

Revision History:
09-20-13 Rev 01.00 GL Initial Release

This code follows the following naming conventions:


char chPmodValue
char (array) sPmodString[16]
float fPmodValue
int nPmodValue
int (array) anPmodValue[16]
u16 uPmodValue
u16 (array) auPmodValue[16]
u8 uchPmodValue
u8 (array) auchPmodBuffer[16]
unsigned int unPmodValue
int * punPmodValue

Definition in file menu.h.

Macro Definition Documentation

#define BASE_FUNCTION_STATE   10

// Menu state machine state

Definition at line 75 of file menu.h.

#define KEYPRESS_ARROW_DOWN   241

Assign up-arrow an extended ascii code which won't be used elsewhere.

Definition at line 78 of file menu.h.

#define KEYPRESS_ARROW_LEFT   242

Assign up-arrow an extended ascii code which won't be used elsewhere.

Definition at line 79 of file menu.h.

#define KEYPRESS_ARROW_RIGHT   243

Assign up-arrow an extended ascii code which won't be used elsewhere.

Definition at line 80 of file menu.h.

#define KEYPRESS_ARROW_UP   240

Assign up-arrow an extended ascii code which won't be used elsewhere.

Definition at line 77 of file menu.h.

#define KEYPRESS_END   244

Assign up-arrow an extended ascii code which won't be used elsewhere.

Definition at line 81 of file menu.h.

#define MAIN_MENU   0

// Menu state machine state

Definition at line 68 of file menu.h.

#define MENU_CHANNEL   6

Definition at line 74 of file menu.h.

#define MENU_SAMPLE_SIZE   3

// Menu state machine state

Definition at line 71 of file menu.h.

#define MENU_SAMPLE_SPEED   2

// Menu state machine state

Definition at line 70 of file menu.h.

#define START_BLOCK_SAMPLING   5

// Menu state machine state

Definition at line 73 of file menu.h.

#define START_CONTINUOUS_SAMPLING   4

// Menu state machine state

Definition at line 72 of file menu.h.

#define WAIT_KEYPRESS   1

// Menu state machine state

Definition at line 69 of file menu.h.

Function Documentation

void menu_cls ( )

Function to clear the screen via Hyperterminal.

Parameters
None
Return values
None

Definition at line 70 of file menu.c.

void menu_print_channel_menu ( )

Definition at line 229 of file menu.c.

void menu_print_main_menu ( )

Print the main menu listing choice of module to test.

Details.
Return values
None

Definition at line 212 of file menu.c.

void menu_print_maxim_banner ( )

Print standard Maxim banner at top of Hyperterminal screen.

Parameters
None
Return values
None

Definition at line 84 of file menu.c.

void menu_print_maxim_banner_big ( )

Print large Maxim banner at top of Hyperterminal screen.

Parameters
None
Return values
None

Definition at line 108 of file menu.c.

void menu_print_prompt ( )

Print a standard prompt for keyboard input " > ".

Parameters
None
Return values
None

Definition at line 141 of file menu.c.

void menu_print_sample_rate_menu ( )

Print a menu listing sample speed choices.

Details
Return values
None

Definition at line 247 of file menu.c.

void menu_print_sample_size_menu ( )

Print a menu listing sample size choices.

Details
Return values
None

Definition at line 268 of file menu.c.

u8 menu_retrieve_keypress ( u32  nUartAddress)

Get a single keypress via Hyperterminal.

Details
Returns ascii character corresponding to keypress with some preprocessing.
Escape sequences (Arrow keys and END) are mapped to decimal 240-244 (see defines)
Characters "0"-"9" converted to numbers 0-9
Lower case "a"-"z" converted to uppercase "A"-"Z"
Parameters
[in]nUartAddress- address of the UART peripheral in MicroBlaze memory map
Return values
Character,partiallydecoded.

Definition at line 168 of file menu.c.