/** \file MAXREFDES14.h ******************************************************
 *
 *             Project: Sonoma (MAXREFDES14#)
 *            Filename: MAXREFDES14.h
 *         Description: This module contains the Main application for the
 *                      Digilent ZedBoard implementation of the
 *                      MAXREFDES14 example program.
 *
 *
 *    Revision History:
 *\n                    05-31-13    Rev 01.00    GL    Initial Release
 *
 *  --------------------------------------------------------------------
 *
 *  This code follows the following naming conventions:
 *
 *\n    char                    chPmodValue
 *\n    char (array)            sPmodString[16]
 *\n    float                   fPmodValue
 *\n    int                     nPmodValue
 *\n    int (array)             anPmodValue[16]
 *\n    u16                     uPmodValue
 *\n    u16 (array)             auPmodValue[16]
 *\n    u8                      uchPmodValue
 *\n    u8 (array)              auchPmodBuffer[16]
 *\n    unsigned int            unPmodValue
 *\n    int *                   punPmodValue
 *
 *  ------------------------------------------------------------------------- */
/*
 * Copyright (C) 2012 Maxim Integrated Products, Inc., All Rights Reserved.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included
 * in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY,  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 * IN NO EVENT SHALL MAXIM INTEGRATED PRODUCTS BE LIABLE FOR ANY CLAIM, DAMAGES
 * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 * OTHER DEALINGS IN THE SOFTWARE.
 *
 * Except as contained in this notice, the name of Maxim Integrated Products
 * shall not be used except as stated in the Maxim Integrated Products
 * Branding Policy.
 *
 * The mere transfer of this software does not imply any licenses
 * of trade secrets, proprietary technology, copyrights, patents,
 * trademarks, maskwork rights, or any other form of intellectual
 * property whatsoever. Maxim Integrated Products retains all ownership rights.
 *
 ***************************************************************************/

#ifndef MAXREFDES14_H_
#define MAXREFDES14_H_

#include "xparameters.h"	/* EDK generated parameters */
#include "stdio.h"

#include "xgpio.h"
#include "xgpio_l.h"
#include "utilities.h"
#include <string.h>
#include <stdio.h>
#include "platform.h"
#include "math.h"

#define DEFAULT_HYPERTERMINAL_UART_ID XPAR_PS7_UART_1_DEVICE_ID  //!< macro used to abstract Physical Port of Hyperterminal UART
#define DEFAULT_HYPERTERMINAL_UART_ADDRESS XPAR_PS7_UART_1_BASEADDR

#define ABOUT_ONE_SECOND 74067512      //!< approx 1 second delay when used as argument with function delay(numberCyclesToDelay)
// Update this if uBlaze/Zynq CPU core frequency is changed, or if the external memory timing changes.
// Although emprirically tested to 1.0000003 seconds, it is not meant to be used for precise timing purposes

#define INPUT_STRING_MAX_SIZE 16

struct maximDateTime                  //!< Structure to hold time, date, day of week
{
	u8 uchHour;
	u8 uchMinute;
	u8 uchSecond;
	u8 uchMonth;
	u8 uchDate;
	u8 uchYear;
	u8 uchDow;
};

struct maximOLEDDisplay
{
	XGpio xgpioPort;
	u8 portStatus;
	u8 writeBuffer[512];
	u8 flippedBuffer[512];
	u8 *font;
};
extern XGpio g_xGpioLed;
extern u8 g_uchAtoDConverterChannel;
extern u32 g_unSampleSize;
extern int g_nSampleRate;
extern char g_sInputString[ INPUT_STRING_MAX_SIZE ];	//This string will hold user input from terminal.
extern struct maximOLEDDisplay g_structureOLED;
extern char g_tempString[32];

#endif /* MAXREFDES14_H_ */
