Sonoma (MAXREFDES14#) Code Documentation V01.00 Isolated EMP (Energy Measurement Processor)

- Main Page
- Data Structures
- Files

- File List
- Globals

All Data Structures Files Functions Variables Macros Pages
Data Structures | Macros | Variables
MAXREFDES14.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"`

Go to the source code of this file.

## Data Structures
struct | maximProduct
| < Structure holding info on each module for menus More...
struct | maximDateTime
| < Structure to hold time, date, day of week More...

## Macros
#define | DEFAULT_HYPERTERMINAL_UART_ID XPAR_USB_UART_DEVICE_ID
| macro used to abstract Physical Port of Hyperterminal UART
#define | DEFAULT_HYPERTERMINAL_UART_ADDRESS XPAR_USB_UART_BASEADDR
#define | ABOUT_ONE_SECOND 3508380
| 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 | RE_B 0x00000001
| bit mask for RS-485 /RE used in menu_MAX14840
#define | DI 0x00000002
| bit mask for RS-485 DI used in menu_MAX14840
#define | RO 0x00000004
| bit mask for RS-485 RO used in menu_MAX14840
#define | DE 0x00000008
| bit mask for RS-485 DE used in menu_MAX14840
#define | INPUT_STRING_MAX_SIZE 16

## Variables
XGpio | g_xGpioPmodPortA
XGpio | g_xGpioPmodPortB
char | g_sInputString [INPUT_STRING_MAX_SIZE]

## Macro Definition Documentation

#define ABOUT_ONE_SECOND 3508380

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

Definition at line 78 of file MAXREFDES14.h.

#define BIT_BANG_SPI_CLK 0x08

bit mask for SPI CLK used in max_GPIO_bit_bang_SPI_write

Definition at line 92 of file MAXREFDES14.h.

#define BIT_BANG_SPI_CLRB 0x04

bit mask for SPI /CLR used in max_GPIO_bit_bang_SPI_write

Definition at line 93 of file MAXREFDES14.h.

#define BIT_BANG_SPI_MISO 0x04

bit mask for SPI MISO used in max_GPIO_bit_bang_SPI_write

Definition at line 94 of file MAXREFDES14.h.

#define BIT_BANG_SPI_MOSI 0x02

bit mask for SPI MOSI used in max_GPIO_bit_bang_SPI_write

Definition at line 95 of file MAXREFDES14.h.

#define BIT_BANG_SPI_SSB 0x01

bit mask for SPI SS used in max_GPIO_bit_bang_SPI_write

Definition at line 96 of file MAXREFDES14.h.

#define DE 0x00000008

bit mask for RS-485 DE used in menu_MAX14840

Definition at line 101 of file MAXREFDES14.h.

#define DEFAULT_HYPERTERMINAL_UART_ADDRESS XPAR_USB_UART_BASEADDR

Definition at line 76 of file MAXREFDES14.h.

#define DEFAULT_HYPERTERMINAL_UART_ID XPAR_USB_UART_DEVICE_ID

macro used to abstract Physical Port of Hyperterminal UART

Definition at line 75 of file MAXREFDES14.h.

#define DI 0x00000002

bit mask for RS-485 DI used in menu_MAX14840

Definition at line 99 of file MAXREFDES14.h.

#define INPUT_STRING_MAX_SIZE 16

Definition at line 124 of file MAXREFDES14.h.

#define PMOD_PORT_TYPE_GPIO 0x02

value to switch GPIO controller into a Pmod port in max_configure_PMOD_port

Definition at line 89 of file MAXREFDES14.h.

#define PMOD_PORT_TYPE_I2C 0x03

value to switch I2C controller into a Pmod port in max_configure_PMOD_port

Definition at line 90 of file MAXREFDES14.h.

#define PMOD_PORT_TYPE_SPI 0x01

value to switch SPI controller into a Pmod port in max_configure_PMOD_port

Definition at line 88 of file MAXREFDES14.h.

#define PMOD_PORT_TYPE_UART 0x00

value to switch UART controller into a Pmod port in max_configure_PMOD_port

Definition at line 87 of file MAXREFDES14.h.

#define PMOD_TYPE_GPIO 2

value which specifies GPIO in maximProduct structure

Definition at line 84 of file MAXREFDES14.h.

#define PMOD_TYPE_I2C 3

value which specifies I2C in maximProduct structure

Definition at line 85 of file MAXREFDES14.h.

#define PMOD_TYPE_SPI 1

value which specifies SPI in maximProduct structure

Definition at line 83 of file MAXREFDES14.h.

#define PMOD_TYPE_UART 0

value which specifies UART in maximProduct structure

Definition at line 82 of file MAXREFDES14.h.

#define RE_B 0x00000001

bit mask for RS-485 /RE used in menu_MAX14840

Definition at line 98 of file MAXREFDES14.h.

#define RO 0x00000004

bit mask for RS-485 RO used in menu_MAX14840

Definition at line 100 of file MAXREFDES14.h.

## Variable Documentation

char g_sInputString[INPUT_STRING_MAX_SIZE]

Definition at line 89 of file MAXREFDES14.c.

XGpio g_xGpioPmodPortA

Definition at line 90 of file MAXREFDES14.c.

XGpio g_xGpioPmodPortB

Definition at line 91 of file MAXREFDES14.c.