/*!
 * @defgroup UART
 * @brief Asynchronous serial communication
 <table>
<caption id="UARTpins">UART pins on the MSPM0G3507</caption>
<tr><th>Pin  <th>Description
<tr><td>PA10 <td>UART0 Tx to XDS Rx
<tr><td>PA11 <td>UART0 Rx from XDS Tx
</table>
 * @{*/
/**
 * @file      UART.h
 * @brief     Initialize UART0
 * @details   UART0 initialization. 115200 baud,
 * 1 start, 8 data bits, 1 stop, no parity.<br>

 * @version   ECE319K v1.0
 * @author    Daniel Valvano and Jonathan Valvano
 * @copyright Copyright 2023 by Jonathan W. Valvano, valvano@mail.utexas.edu,
 * @warning   AS-IS
 * @note      For more information see  http://users.ece.utexas.edu/~valvano/
 * @date      August 13, 2023
 <table>
<caption id="UARTpins2">UART pins on the MSPM0G3507</caption>
<tr><th>Pin  <th>Description
<tr><td>PA10 <td>UART0 Tx to XDS Rx
<tr><td>PA11 <td>UART0 Rx from XDS Tx
</table>
  ******************************************************************************/

#ifndef __UART_H__
#define __UART_H__
// standard ASCII symbols
/**
 * \brief CR is carriage return
 */
#define CR   0x0D
/**
 * \brief LF is line feed
 */
#define LF   0x0A
/**
 * \brief BS is back space
 */
#define BS   0x08
/**
 * \brief ESC is escape character
 */
#define ESC  0x1B
/**
 * \brief SP is space
 */
#define SP   0x20
/**
 * \brief DEL is delete
 */
#define DEL  0x7F
/* 
 * Derived from uart_rw_multibyte_fifo_poll_LP_MSPM0G3507_nortos_ticlang
 */
 

/**
 * initialize 0 for 115200 baud rate.
 * - PA10 = UART0 Tx to XDS Rx
 * - PA11 = UART0 Rx from XDS Tx
 *
 * There are two implementations:
 * - UART_Init in <b>UARTbusywait.c</b> implements busy-wait synchronization
 * - UART_Init in <b>UARTints.c</b> implements interrupt synchronization
 *
 * @param none
 * @return none
 * @brief  Initialize UART0
*/
void UART_Init(void);

/**
 * Wait for new serial port input
 * @param none
 * @return char ASCII code for key typed
 * @brief input from UART0
 */
char UART_InChar(void);


/**
 * Output 8-bit to serial port
 * @param data is an 8-bit ASCII character to be transferred
 * @return none
 * @brief output character to UART0
 */
void UART_OutChar(char data);


/**
 * Output String with NULL termination
 * @param pt is pointer to a NULL-terminated string to be transferred
 * @return none
 * @brief output string to UART0
 */
void UART_OutString(char *pt);


/**
 * InUDec accepts ASCII input in unsigned decimal format
 * and converts to a 32-bit unsigned number
 * valid range is 0 to 4294967295 (2^32-1)
 * @param none
 * @return 32-bit unsigned number
 * @note If you enter a number above 4294967295, it will return an incorrect value
 * Backspace will remove last digit typed
 * @brief input a number from UART0
 */
uint32_t UART_InUDec(void);

/**
 * Output a 32-bit number in unsigned decimal format
 * @param n 32-bit number to be transferred
 * @return none
 * @note Variable format 1-10 digits with no space before or after
 * @brief output a number to UART0
 */
void UART_OutUDec(uint32_t n);

/**
 * Output a 32-bit number in signed decimal format
 * @param n 32-bit number to be transferred
 * @return none
 * @note Variable format 1-10 digits with no space before or after
 * @brief output a signed number to UART0
 */
void UART_OutSDec(int32_t n);

/**
 * Accepts ASCII input in unsigned hexadecimal (base 16) format
 * No '$' or '0x' need be entered, just the 1 to 8 hex digits
 * It will convert lower case a-f to uppercase A-F
 * and converts to a 16 bit unsigned number
 * value range is 0 to FFFFFFFF
 * If you enter a number above FFFFFFFF, it will return an incorrect value
 * Backspace will remove last digit typed 
 * @param none
 * @return 32-bit unsigned number
 * @brief input a hex number from UART0
 */
uint32_t UART_InUHex(void);

/**
 * Output a 32-bit number in unsigned hexadecimal format
 * @param number 32-bit number to be transferred
 * @return none
 * @note Variable format 1 to 8 digits with no space before or after
 * @brief output a hex number to UART0
 */
void UART_OutUHex(uint32_t number);

/**
 * Accepts ASCII characters from the serial port
 *    and adds them to a string until <enter> is typed
 *    or until max length of the string is reached.
 * It echoes each character as it is inputted.
 * If a backspace is inputted, the string is modified
 *     and the backspace is echoed
 *  terminates the string with a null character
 * Calls UART_InChar
 * @param bufPt is a pointer to empty buffer, 
 * @param max is the size of the buffer
 * @return none
 * @note Modified by Agustinus Darmawan + Mingjie Qiu --
 * @brief input a string from UART0
 */
 void UART_InString(char *bufPt, uint16_t max);

/**
 * Initialize the UART for 115,200 baud rate (assuming 48 MHz bus clock),
 * 8 bit word length, no parity bits, one stop bit.
 * Calls UART_Init()
 * @param none
 * @return none
 * @brief Initialize UART0 to use printf
 */
void UART_InitPrintf(void);


// initialize UART1 for 115200 baud rate
void UART1_Init(void);

//------------UART1_InChar------------
// Wait for new serial port input
// Input: none
// Output: ASCII code for key typed
char UART1_InChar(void);
//------------UART1_OutChar------------
// Output 8-bit to serial port
// Input: letter is an 8-bit ASCII character to be transferred
// Output: none
void UART1_OutChar(char data);

#endif // __UART_H__
/** @}*/