Carmel (MAXREFDES18#) Code Documentation  V01.00
High Accuracy Analog Current/Voltage Output
 All Data Structures Files Functions Variables Macros Pages
utilities.h
Go to the documentation of this file.
1 
29 /*
30  * Copyright (C) 2012 Maxim Integrated Products, Inc., All Rights Reserved.
31  *
32  * Permission is hereby granted, free of charge, to any person obtaining a
33  * copy of this software and associated documentation files (the "Software"),
34  * to deal in the Software without restriction, including without limitation
35  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
36  * and/or sell copies of the Software, and to permit persons to whom the
37  * Software is furnished to do so, subject to the following conditions:
38  *
39  * The above copyright notice and this permission notice shall be included
40  * in all copies or substantial portions of the Software.
41  *
42  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
43  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
44  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
45  * IN NO EVENT SHALL MAXIM INTEGRATED PRODUCTS BE LIABLE FOR ANY CLAIM, DAMAGES
46  * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
47  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
48  * OTHER DEALINGS IN THE SOFTWARE.
49  *
50  * Except as contained in this notice, the name of Maxim Integrated Products
51  * shall not be used except as stated in the Maxim Integrated Products
52  * Branding Policy.
53  *
54  * The mere transfer of this software does not imply any licenses
55  * of trade secrets, proprietary technology, copyrights, patents,
56  * trademarks, maskwork rights, or any other form of intellectual
57  * property whatsoever. Maxim Integrated Products retains all ownership rights.
58  *
59  ***************************************************************************/
60 
61 #ifndef UTILITIES_H_
62 #define UTILITIES_H_
63 #include "xbasic_types.h"
64 #include "xspi_l.h"
65 #include "stdio.h"
66 #include "xiic_l.h"
67 #include "xuartlite_i.h"
68 #include "xparameters.h"
69 #include "xgpio.h"
70 #include "xgpio_l.h"
71 #include "MAXREFDES18.h"
72 #endif /* UTILITIES_H_ */
73 
74 #pragma once
75 
76 void sendUartByte(u32 unUartAddress, u8 uchByte);
77 u8 checkUartEmpty(u32 unUartAddress);
78 u8 getUartByte(u32 nUartAddress);
79 void print_asterisks(int nQuantity);
80 int SpiRW(u32 unPeripheralAddressSPI, unsigned int unCPHA, unsigned int unCPOL,
81  u8* auchWriteBuf, u8* auchReadBuf, int unNumBytes, u8 uchCsActiveHigh, u32 unSpiSS);
82 void delay(int nStopValue);
83 void led_knight_rider(XGpio *pLED_GPIO, int nNumberOfTimes);
84 void max_set_PMOD_port(int nPortNumber, u8 uchPortType);
85 void max_configure_PMOD_port(u8 uchPmodPortA, u8 uchPmodPortB, u8 uchPmodPortC, u8 uchPmodPortD);
86 int number_raised_to_power(int nBase, int nExponent);
87 int receive_byte_with_timeout(u32 unUartAddress, int nTimeoutInTenthsOfSeconds, u8 *uchRxData);
88 
89 int GetLine( char* sInputString, unsigned int unMaxSize );
90 void sendOLEDSPI(u8 uchDataToWrite);
91 void initializeOLED(u8 *pFont);
92 void clearOLEDBuffer(u8 *pauchBuffer);
93 void displayOLEDBuffer(u8 *pauchBuffer);
94 void putCharOLED(int x, int y, char chCharacter);
95 void printfToBufferOLED(int x, int y,char *chString);
96 void printfToOLED(int x, int y,char *chString);
97 void flipAndCopyDisplayBuffer(u8 *pauchSourceBuffer, u8 *pauchDestinationBuffer);