MAXREFDES71# Code Documentation
V01.00
MAXREFDES71# 2-Channel Analog Input/Analog Output
|
#include "xparameters.h"
#include "xbasic_types.h"
#include "stdio.h"
#include "xgpio.h"
#include "xgpio_l.h"
#include "MAXREFDES71.h"
Go to the source code of this file.
Functions | |
void | delay (int nStopValue) |
Loop for nStopValue iterations to provide a delay. | |
void | led_knight_rider (XGpio *pLED_GPIO, int nNumberOfTimes) |
Blink a row of LEDs nNumberOfTimes times. | |
int | number_raised_to_power (int nBase, int nExponent) |
Raise nBase to the nExponent power (operates with integers only). | |
void | print_asterisks (int nQuantity) |
Print nQuantity of asterisks to the default Hyperterminal UART. | |
u8 | getUartByte (u32 nUartAddress) |
Get a byte from either the full UART in the Zynq PS, or a Xilinx UartLite. | |
void | sendUartByte (u32 unUartAddress, u8 uchByte) |
Send a byte to the UART. Either directs to the full UART in the Zynq PS, or a Xilinx UartLite. | |
u8 | checkUartEmpty (u32 unUartAddress) |
Check if either Uart is empty. Either directs to the full UART in the Zynq PS, or a Xilinx UartLite. | |
void | initializeOLED (u8 *pFont) |
Initializes the OLED display. | |
void | sendOLEDSPI (u8 uchDataToWrite) |
Bit bang routine for Zedboard SPI OLED interface. | |
void | clearOLEDBuffer (u8 *pauchBuffer) |
Clears the OLED display buffer. | |
void | displayOLEDBuffer (u8 *pauchBuffer) |
Copies the display buffer into the OLED display. | |
void | putCharOLED (int x, int y, char chCharacter) |
Places a single ASCII character into the OLED display buffer. | |
void | printfToBufferOLED (int x, int y, char *chString) |
Printf-like function to copy an ASCII string into the OLED display buffer. | |
void | printfToOLED (int x, int y, char *chString) |
Printf-like function to copy an ASCII string into the OLED display buffer. | |
void | flipAndCopyDisplayBuffer (u8 *pauchSourceBuffer, u8 *pauchDestinationBuffer) |
Copies the pixels from the source display buffer, into the destination buffer, flipping their location 180 degrees. | |
Variables | |
struct maximDateTime * | t |
Project: Maxim Plug-in Peripheral Modules Filename: utilities.h Description: This module contains a collection of general utility functions which are not specific to any particular module.
Revision History:
4-13-12 Rev 1.0 Seth Messimer Initial Release
7-20-12 Rev 1.4 Nathan Young Additional functions
This code follows the following naming conventions.
char chPmodValue char (array) sPmodString[16] float fPmodValue int nPmodValue int (array) anPmodValue[16] u16 uPmodValue u8 uchPmodValue u8 (array) auchPmodBuffer[16] unsigned int unPmodValue int * punPmodValue
Definition in file utilities.h.
u8 checkUartEmpty | ( | u32 | unUartAddress | ) |
Check if either Uart is empty. Either directs to the full UART in the Zynq PS, or a Xilinx UartLite.
[in] | unUartAddress. | 32 bit UART address |
True | if empty (false if not) |
Definition at line 215 of file utilities.c.
void clearOLEDBuffer | ( | u8 * | pauchBuffer | ) |
Clears the OLED display buffer.
[in] | *pauchBuffer | - pointer to an u8 array used for the OLED pixel buffer |
None |
Definition at line 415 of file utilities.c.
void delay | ( | int | nStopValue | ) |
Loop for nStopValue iterations to provide a delay.
[in] | nStopValue | - number of iterations to loop |
None |
Definition at line 75 of file utilities.c.
void displayOLEDBuffer | ( | u8 * | pauchBuffer | ) |
Copies the display buffer into the OLED display.
[in] | *pauchBuffer | - pointer to an u8 array used for the OLED pixel buffer |
None |
Definition at line 432 of file utilities.c.
void flipAndCopyDisplayBuffer | ( | u8 * | pauchSourceBuffer, |
u8 * | pauchDestinationBuffer | ||
) |
Copies the pixels from the source display buffer, into the destination buffer, flipping their location 180 degrees.
[in] | *pauchSourceBuffer | - pointer to an u8 buffer used as the source display buffer |
[in] | *pauchDestinationBuffer | - pointer to an u8 buffer used as the destination display buffer |
None |
Definition at line 586 of file utilities.c.
u8 getUartByte | ( | u32 | nUartAddress | ) |
Get a byte from either the full UART in the Zynq PS, or a Xilinx UartLite.
[in] | unUartAddress. | 32 bit UART address |
Returns | the next byte from the Uart Rx FIFO |
Definition at line 174 of file utilities.c.
void initializeOLED | ( | u8 * | pFont | ) |
Initializes the OLED display.
[in] | *pFont | - pointer to an u8 array containing the ASCII display font |
None |
Definition at line 252 of file utilities.c.
void led_knight_rider | ( | XGpio * | pLED_GPIO, |
int | nNumberOfTimes | ||
) |
Blink a row of LEDs nNumberOfTimes times.
[in] | *pLED_GPIO | - address of the GPIO peripheral driving the LEDs in MicroBlaze memory map |
None |
Definition at line 96 of file utilities.c.
int number_raised_to_power | ( | int | nBase, |
int | nExponent | ||
) |
Raise nBase to the nExponent power (operates with integers only).
[in] | nBase | - base |
[in] | nExponent | - exponent |
Base^Exponent |
Definition at line 131 of file utilities.c.
void print_asterisks | ( | int | nQuantity | ) |
Print nQuantity of asterisks to the default Hyperterminal UART.
[in] | nQuantity | - number of asterisks to print |
None |
Definition at line 160 of file utilities.c.
void printfToBufferOLED | ( | int | x, |
int | y, | ||
char * | chString | ||
) |
Printf-like function to copy an ASCII string into the OLED display buffer.
[in] | x | - The starting position of string within the 16x4 character display |
[in] | y | - The starting position of string within the 16x4 character display |
[in] | *chString | - pointer to an null terminated character string. Should be generated with sprintf (or similar). |
None |
Definition at line 527 of file utilities.c.
void printfToOLED | ( | int | x, |
int | y, | ||
char * | chString | ||
) |
Printf-like function to copy an ASCII string into the OLED display buffer.
[in] | x | - The starting position of string within the 16x4 character display |
[in] | y | - The starting position of string within the 16x4 character display |
[in] | *chString | - pointer to an null terminated character string. Should be generated with sprintf (or similar). |
None |
Definition at line 567 of file utilities.c.
void putCharOLED | ( | int | x, |
int | y, | ||
char | chCharacter | ||
) |
Places a single ASCII character into the OLED display buffer.
[in] | x | - The x position of the character location |
[in] | y | - The y position of the character location |
[in] | chCharacter | - ASCII character to be printed (ex: 0x41 = 'A') |
None |
Definition at line 495 of file utilities.c.
void sendOLEDSPI | ( | u8 | uchDataToWrite | ) |
Bit bang routine for Zedboard SPI OLED interface.
[in] | uchDataToWrite | - u8 value to be written to OLED SPI |
None |
Definition at line 382 of file utilities.c.
void sendUartByte | ( | u32 | unUartAddress, |
u8 | uchByte | ||
) |
Send a byte to the UART. Either directs to the full UART in the Zynq PS, or a Xilinx UartLite.
[in] | unUartAddress. | 32 bit UART address |
[in] | uchByte. | The byte to be sent to the UART |
None |
Definition at line 195 of file utilities.c.
struct maximDateTime* t |
Definition at line 76 of file utilities.h.