Carmel (MAXREFDES18#) Code Documentation  V01.00
High Accuracy Analog Current/Voltage Output
 All Data Structures Files Functions Variables Macros Pages
MAXREFDES18.h File Reference
#include "xgpio.h"
#include "xgpio_l.h"
#include "xparameters.h"
#include "xuartlite.h"
#include "xspi_l.h"
#include "xspi.h"
#include "xiic_l.h"
#include "utilities.h"
#include <string.h>
#include <stdio.h>
#include "platform.h"
#include "math.h"

Go to the source code of this file.

Data Structures

struct  maximOLEDDisplay
 

Macros

#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)
 
#define PMOD_TYPE_UART   0
 value which specifies UART in maximProduct structure
 
#define PMOD_TYPE_SPI   1
 value which specifies SPI in maximProduct structure
 
#define PMOD_TYPE_GPIO   2
 value which specifies GPIO in maximProduct structure
 
#define PMOD_TYPE_I2C   3
 value which specifies I2C in maximProduct structure
 
#define PMOD_PORT_TYPE_UART   0x00
 value to switch UART controller into a Pmod port in max_configure_PMOD_port
 
#define PMOD_PORT_TYPE_SPI   0x01
 value to switch SPI controller into a Pmod port in max_configure_PMOD_port
 
#define PMOD_PORT_TYPE_GPIO   0x02
 value to switch GPIO controller into a Pmod port in max_configure_PMOD_port
 
#define PMOD_PORT_TYPE_I2C   0x03
 value to switch I2C controller into a Pmod port in max_configure_PMOD_port
 
#define BIT_BANG_SPI_CLK   0x08
 bit mask for SPI CLK used in max_GPIO_bit_bang_SPI_write
 
#define BIT_BANG_SPI_CLRB   0x04
 bit mask for SPI /CLR used in max_GPIO_bit_bang_SPI_write
 
#define BIT_BANG_SPI_MISO   0x04
 bit mask for SPI MISO used in max_GPIO_bit_bang_SPI_write
 
#define BIT_BANG_SPI_MOSI   0x02
 bit mask for SPI MOSI used in max_GPIO_bit_bang_SPI_write
 
#define BIT_BANG_SPI_SSB   0x01
 bit mask for SPI SS used in max_GPIO_bit_bang_SPI_write
 
#define INPUT_STRING_MAX_SIZE   16
 

Variables

XGpio g_xGpioPmodPortA
 
XGpio g_xGpioPmodPortB
 
XGpio g_xGpioPmodPortC
 
XGpio g_xGpioPmodPortD
 
XGpio g_xGpioPmodPortMuxIO
 
char g_sInputString [INPUT_STRING_MAX_SIZE]
 
int g_nActivePMODPort
 
u32 g_unActivePeripheralAddressI2C
 
u32 g_unActivePeripheralAddressSPI
 
u32 g_unActivePeripheralAddressUart
 
XGpio * g_pActiveGPIOPort
 
struct maximOLEDDisplay g_structureOLED
 
char g_tempString [32]
 
unsigned char g_auchPortType [4]
 

Detailed Description


      Project: Carmel (MAXREFDES18#)
     Filename: MAXREFDES18.h
  Description: This module contains the Main application for the
               Avnet ZedBoard implementation of the MAXREFDES18
               example program.

Revision History:
08-19-13 Rev 01.00 MG 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 MAXREFDES18.h.

Macro Definition Documentation

#define ABOUT_ONE_SECOND   74067512

approx 1 second delay when used as argument with function delay(numberCyclesToDelay)

Definition at line 80 of file MAXREFDES18.h.

#define BIT_BANG_SPI_CLK   0x08

bit mask for SPI CLK used in max_GPIO_bit_bang_SPI_write

Definition at line 94 of file MAXREFDES18.h.

#define BIT_BANG_SPI_CLRB   0x04

bit mask for SPI /CLR used in max_GPIO_bit_bang_SPI_write

Definition at line 95 of file MAXREFDES18.h.

#define BIT_BANG_SPI_MISO   0x04

bit mask for SPI MISO used in max_GPIO_bit_bang_SPI_write

Definition at line 96 of file MAXREFDES18.h.

#define BIT_BANG_SPI_MOSI   0x02

bit mask for SPI MOSI used in max_GPIO_bit_bang_SPI_write

Definition at line 97 of file MAXREFDES18.h.

#define BIT_BANG_SPI_SSB   0x01

bit mask for SPI SS used in max_GPIO_bit_bang_SPI_write

Definition at line 98 of file MAXREFDES18.h.

#define DEFAULT_HYPERTERMINAL_UART_ADDRESS   XPAR_PS7_UART_1_BASEADDR

Definition at line 78 of file MAXREFDES18.h.

#define DEFAULT_HYPERTERMINAL_UART_ID   XPAR_PS7_UART_1_DEVICE_ID

macro used to abstract Physical Port of Hyperterminal UART

Definition at line 77 of file MAXREFDES18.h.

#define INPUT_STRING_MAX_SIZE   16

Definition at line 109 of file MAXREFDES18.h.

#define PMOD_PORT_TYPE_GPIO   0x02

value to switch GPIO controller into a Pmod port in max_configure_PMOD_port

Definition at line 91 of file MAXREFDES18.h.

#define PMOD_PORT_TYPE_I2C   0x03

value to switch I2C controller into a Pmod port in max_configure_PMOD_port

Definition at line 92 of file MAXREFDES18.h.

#define PMOD_PORT_TYPE_SPI   0x01

value to switch SPI controller into a Pmod port in max_configure_PMOD_port

Definition at line 90 of file MAXREFDES18.h.

#define PMOD_PORT_TYPE_UART   0x00

value to switch UART controller into a Pmod port in max_configure_PMOD_port

Definition at line 89 of file MAXREFDES18.h.

#define PMOD_TYPE_GPIO   2

value which specifies GPIO in maximProduct structure

Definition at line 86 of file MAXREFDES18.h.

#define PMOD_TYPE_I2C   3

value which specifies I2C in maximProduct structure

Definition at line 87 of file MAXREFDES18.h.

#define PMOD_TYPE_SPI   1

value which specifies SPI in maximProduct structure

Definition at line 85 of file MAXREFDES18.h.

#define PMOD_TYPE_UART   0

value which specifies UART in maximProduct structure

Definition at line 84 of file MAXREFDES18.h.

Variable Documentation

unsigned char g_auchPortType[4]

Definition at line 103 of file MAXREFDES18.c.

int g_nActivePMODPort

Definition at line 100 of file MAXREFDES18.c.

XGpio* g_pActiveGPIOPort

Definition at line 102 of file MAXREFDES18.c.

char g_sInputString[INPUT_STRING_MAX_SIZE]

Definition at line 89 of file MAXREFDES18.c.

struct maximOLEDDisplay g_structureOLED

Definition at line 96 of file MAXREFDES18.c.

char g_tempString[32]

Definition at line 97 of file MAXREFDES18.c.

u32 g_unActivePeripheralAddressI2C
u32 g_unActivePeripheralAddressSPI

Definition at line 101 of file MAXREFDES18.c.

u32 g_unActivePeripheralAddressUart
XGpio g_xGpioPmodPortA

Definition at line 90 of file MAXREFDES18.c.

XGpio g_xGpioPmodPortB

Definition at line 91 of file MAXREFDES18.c.

XGpio g_xGpioPmodPortC

Definition at line 92 of file MAXREFDES18.c.

XGpio g_xGpioPmodPortD

Definition at line 93 of file MAXREFDES18.c.

XGpio g_xGpioPmodPortMuxIO

Definition at line 94 of file MAXREFDES18.c.