Cleanup, apply standards to debug_frmwrk.c

Although this is an external contribution, clean up anyway to stop seeing it in global searches for typical flaws.
This commit is contained in:
Scott Lahteine 2017-10-25 02:35:43 -05:00
parent 55653dce63
commit 203f2923a1

View file

@ -1,6 +1,6 @@
/********************************************************************** /**********************************************************************
* $Id$ debug_frmwrk.c 2010-05-21 * $Id$ debug_frmwrk.c 2010-05-21
*//** *
* @file debug_frmwrk.c * @file debug_frmwrk.c
* @brief Contains some utilities that used for debugging through UART * @brief Contains some utilities that used for debugging through UART
* @version 2.0 * @version 2.0
@ -37,12 +37,13 @@
* otherwise the default FW library configuration file must be included instead * otherwise the default FW library configuration file must be included instead
*/ */
#ifdef __BUILD_WITH_EXAMPLE__ #ifdef __BUILD_WITH_EXAMPLE__
#include "lpc17xx_libcfg.h" #include "lpc17xx_libcfg.h"
#else #else
#include "lpc17xx_libcfg_default.h" #include "lpc17xx_libcfg_default.h"
#endif /* __BUILD_WITH_EXAMPLE__ */ #endif
#ifdef _DBGFWK #ifdef _DBGFWK
/* Debug framework */ /* Debug framework */
static Bool debug_frmwrk_initialized = FALSE; static Bool debug_frmwrk_initialized = FALSE;
@ -64,20 +65,17 @@ uint8_t (*_db_get_char)(LPC_UART_TypeDef *UARTx) = UARTGetChar;
* @param[in] ch Character to put * @param[in] ch Character to put
* @return None * @return None
**********************************************************************/ **********************************************************************/
void UARTPutChar (LPC_UART_TypeDef *UARTx, uint8_t ch) void UARTPutChar(LPC_UART_TypeDef *UARTx, uint8_t ch) {
{
if (debug_frmwrk_initialized) if (debug_frmwrk_initialized)
UART_Send(UARTx, &ch, 1, BLOCKING); UART_Send(UARTx, &ch, 1, BLOCKING);
} }
/*********************************************************************//** /*********************************************************************//**
* @brief Get a character to UART port * @brief Get a character to UART port
* @param[in] UARTx Pointer to UART peripheral * @param[in] UARTx Pointer to UART peripheral
* @return character value that returned * @return character value that returned
**********************************************************************/ **********************************************************************/
uint8_t UARTGetChar (LPC_UART_TypeDef *UARTx) uint8_t UARTGetChar(LPC_UART_TypeDef *UARTx) {
{
uint8_t tmp = 0; uint8_t tmp = 0;
if (debug_frmwrk_initialized) if (debug_frmwrk_initialized)
@ -86,57 +84,44 @@ uint8_t UARTGetChar (LPC_UART_TypeDef *UARTx)
return(tmp); return(tmp);
} }
/*********************************************************************//** /*********************************************************************//**
* @brief Puts a string to UART port * @brief Puts a string to UART port
* @param[in] UARTx Pointer to UART peripheral * @param[in] UARTx Pointer to UART peripheral
* @param[in] str string to put * @param[in] str string to put
* @return None * @return None
**********************************************************************/ **********************************************************************/
void UARTPuts(LPC_UART_TypeDef *UARTx, const void *str) void UARTPuts(LPC_UART_TypeDef *UARTx, const void *str) {
{ if (!debug_frmwrk_initialized) return;
uint8_t *s = (uint8_t *) str;
if (!debug_frmwrk_initialized) uint8_t *s = (uint8_t*)str;
return; while (*s) UARTPutChar(UARTx, *s++);
while (*s)
{
UARTPutChar(UARTx, *s++);
}
} }
/*********************************************************************//** /*********************************************************************//**
* @brief Puts a string to UART port and print new line * @brief Puts a string to UART port and print new line
* @param[in] UARTx Pointer to UART peripheral * @param[in] UARTx Pointer to UART peripheral
* @param[in] str String to put * @param[in] str String to put
* @return None * @return None
**********************************************************************/ **********************************************************************/
void UARTPuts_(LPC_UART_TypeDef *UARTx, const void *str) void UARTPuts_(LPC_UART_TypeDef *UARTx, const void *str) {
{ if (!debug_frmwrk_initialized) return;
if (!debug_frmwrk_initialized)
return;
UARTPuts (UARTx, str); UARTPuts (UARTx, str);
UARTPuts (UARTx, "\n\r"); UARTPuts (UARTx, "\n\r");
} }
/*********************************************************************//** /*********************************************************************//**
* @brief Puts a decimal number to UART port * @brief Puts a decimal number to UART port
* @param[in] UARTx Pointer to UART peripheral * @param[in] UARTx Pointer to UART peripheral
* @param[in] decnum Decimal number (8-bit long) * @param[in] decnum Decimal number (8-bit long)
* @return None * @return None
**********************************************************************/ **********************************************************************/
void UARTPutDec(LPC_UART_TypeDef *UARTx, uint8_t decnum) void UARTPutDec(LPC_UART_TypeDef *UARTx, uint8_t decnum) {
{ if (!debug_frmwrk_initialized) return;
if (!debug_frmwrk_initialized)
return;
uint8_t c1=decnum%10; uint8_t c1 = decnum%10;
uint8_t c2=(decnum/10)%10; uint8_t c2 = (decnum / 10) % 10;
uint8_t c3=(decnum/100)%10; uint8_t c3 = (decnum / 100) % 10;
UARTPutChar(UARTx, '0'+c3); UARTPutChar(UARTx, '0'+c3);
UARTPutChar(UARTx, '0'+c2); UARTPutChar(UARTx, '0'+c2);
UARTPutChar(UARTx, '0'+c1); UARTPutChar(UARTx, '0'+c1);
@ -148,16 +133,14 @@ void UARTPutDec(LPC_UART_TypeDef *UARTx, uint8_t decnum)
* @param[in] decnum Decimal number (8-bit long) * @param[in] decnum Decimal number (8-bit long)
* @return None * @return None
**********************************************************************/ **********************************************************************/
void UARTPutDec16(LPC_UART_TypeDef *UARTx, uint16_t decnum) void UARTPutDec16(LPC_UART_TypeDef *UARTx, uint16_t decnum) {
{ if (!debug_frmwrk_initialized) return;
if (!debug_frmwrk_initialized)
return;
uint8_t c1=decnum%10; uint8_t c1 = decnum%10;
uint8_t c2=(decnum/10)%10; uint8_t c2 = (decnum / 10) % 10;
uint8_t c3=(decnum/100)%10; uint8_t c3 = (decnum / 100) % 10;
uint8_t c4=(decnum/1000)%10; uint8_t c4 = (decnum / 1000) % 10;
uint8_t c5=(decnum/10000)%10; uint8_t c5 = (decnum / 10000) % 10;
UARTPutChar(UARTx, '0'+c5); UARTPutChar(UARTx, '0'+c5);
UARTPutChar(UARTx, '0'+c4); UARTPutChar(UARTx, '0'+c4);
UARTPutChar(UARTx, '0'+c3); UARTPutChar(UARTx, '0'+c3);
@ -171,31 +154,29 @@ void UARTPutDec16(LPC_UART_TypeDef *UARTx, uint16_t decnum)
* @param[in] decnum Decimal number (8-bit long) * @param[in] decnum Decimal number (8-bit long)
* @return None * @return None
**********************************************************************/ **********************************************************************/
void UARTPutDec32(LPC_UART_TypeDef *UARTx, uint32_t decnum) void UARTPutDec32(LPC_UART_TypeDef *UARTx, uint32_t decnum) {
{ if (!debug_frmwrk_initialized) return;
if (!debug_frmwrk_initialized)
return;
uint8_t c1=decnum%10; const uint8_t c1 = decnum % 10,
uint8_t c2=(decnum/10)%10; c2 = (decnum / 10) % 10,
uint8_t c3=(decnum/100)%10; c3 = (decnum / 100) % 10,
uint8_t c4=(decnum/1000)%10; c4 = (decnum / 1000) % 10,
uint8_t c5=(decnum/10000)%10; c5 = (decnum / 10000) % 10,
uint8_t c6=(decnum/100000)%10; c6 = (decnum / 100000) % 10,
uint8_t c7=(decnum/1000000)%10; c7 = (decnum / 1000000) % 10,
uint8_t c8=(decnum/10000000)%10; c8 = (decnum / 10000000) % 10,
uint8_t c9=(decnum/100000000)%10; c9 = (decnum / 100000000) % 10,
uint8_t c10=(decnum/1000000000)%10; c10 = (decnum / 1000000000) % 10;
UARTPutChar(UARTx, '0'+c10); UARTPutChar(UARTx, '0' + c10);
UARTPutChar(UARTx, '0'+c9); UARTPutChar(UARTx, '0' + c9);
UARTPutChar(UARTx, '0'+c8); UARTPutChar(UARTx, '0' + c8);
UARTPutChar(UARTx, '0'+c7); UARTPutChar(UARTx, '0' + c7);
UARTPutChar(UARTx, '0'+c6); UARTPutChar(UARTx, '0' + c6);
UARTPutChar(UARTx, '0'+c5); UARTPutChar(UARTx, '0' + c5);
UARTPutChar(UARTx, '0'+c4); UARTPutChar(UARTx, '0' + c4);
UARTPutChar(UARTx, '0'+c3); UARTPutChar(UARTx, '0' + c3);
UARTPutChar(UARTx, '0'+c2); UARTPutChar(UARTx, '0' + c2);
UARTPutChar(UARTx, '0'+c1); UARTPutChar(UARTx, '0' + c1);
} }
/*********************************************************************//** /*********************************************************************//**
@ -204,39 +185,30 @@ void UARTPutDec32(LPC_UART_TypeDef *UARTx, uint32_t decnum)
* @param[in] hexnum Hex number (8-bit long) * @param[in] hexnum Hex number (8-bit long)
* @return None * @return None
**********************************************************************/ **********************************************************************/
void UARTPutHex (LPC_UART_TypeDef *UARTx, uint8_t hexnum) void UARTPutHex(LPC_UART_TypeDef *UARTx, uint8_t hexnum) {
{ if (!debug_frmwrk_initialized) return;
uint8_t nibble, i;
if (!debug_frmwrk_initialized)
return;
UARTPuts(UARTx, "0x"); UARTPuts(UARTx, "0x");
i = 1; uint8_t nibble, i = 1;
do { do {
nibble = (hexnum >> (4*i)) & 0x0F; nibble = (hexnum >> (4 * i)) & 0x0F;
UARTPutChar(UARTx, (nibble > 9) ? ('A' + nibble - 10) : ('0' + nibble)); UARTPutChar(UARTx, (nibble > 9) ? ('A' + nibble - 10) : ('0' + nibble));
} while (i--); } while (i--);
} }
/*********************************************************************//** /*********************************************************************//**
* @brief Puts a hex number to UART port * @brief Puts a hex number to UART port
* @param[in] UARTx Pointer to UART peripheral * @param[in] UARTx Pointer to UART peripheral
* @param[in] hexnum Hex number (16-bit long) * @param[in] hexnum Hex number (16-bit long)
* @return None * @return None
**********************************************************************/ **********************************************************************/
void UARTPutHex16 (LPC_UART_TypeDef *UARTx, uint16_t hexnum) void UARTPutHex16(LPC_UART_TypeDef *UARTx, uint16_t hexnum) {
{ if (!debug_frmwrk_initialized) return;
uint8_t nibble, i;
if (!debug_frmwrk_initialized)
return;
UARTPuts(UARTx, "0x"); UARTPuts(UARTx, "0x");
i = 3; uint8_t nibble, i = 3;
do { do {
nibble = (hexnum >> (4*i)) & 0x0F; nibble = (hexnum >> (4 * i)) & 0x0F;
UARTPutChar(UARTx, (nibble > 9) ? ('A' + nibble - 10) : ('0' + nibble)); UARTPutChar(UARTx, (nibble > 9) ? ('A' + nibble - 10) : ('0' + nibble));
} while (i--); } while (i--);
} }
@ -247,29 +219,24 @@ void UARTPutHex16 (LPC_UART_TypeDef *UARTx, uint16_t hexnum)
* @param[in] hexnum Hex number (32-bit long) * @param[in] hexnum Hex number (32-bit long)
* @return None * @return None
**********************************************************************/ **********************************************************************/
void UARTPutHex32 (LPC_UART_TypeDef *UARTx, uint32_t hexnum) void UARTPutHex32(LPC_UART_TypeDef *UARTx, uint32_t hexnum) {
{ if (!debug_frmwrk_initialized) return;
uint8_t nibble, i;
if (!debug_frmwrk_initialized)
return;
UARTPuts(UARTx, "0x"); UARTPuts(UARTx, "0x");
i = 7; uint8_t nibble, i = 7;
do { do {
nibble = (hexnum >> (4*i)) & 0x0F; nibble = (hexnum >> (4 * i)) & 0x0F;
UARTPutChar(UARTx, (nibble > 9) ? ('A' + nibble - 10) : ('0' + nibble)); UARTPutChar(UARTx, (nibble > 9) ? ('A' + nibble - 10) : ('0' + nibble));
} while (i--); } while (i--);
} }
///*********************************************************************//** /*********************************************************************//**
// * @brief print function that supports format as same as printf() * @brief print function that supports format as same as printf()
// * function of <stdio.h> library * function of <stdio.h> library
// * @param[in] None * @param[in] None
// * @return None * @return None
// **********************************************************************/ **********************************************************************/
//void _printf (const char *format, ...) //void _printf (const char *format, ...) {
//{
// static char buffer[512 + 1]; // static char buffer[512 + 1];
// va_list vArgs; // va_list vArgs;
// char *tmp; // char *tmp;
@ -285,12 +252,11 @@ void UARTPutHex32 (LPC_UART_TypeDef *UARTx, uint32_t hexnum)
* @param[in] None * @param[in] None
* @return None * @return None
**********************************************************************/ **********************************************************************/
void debug_frmwrk_init(void) void debug_frmwrk_init(void) {
{
UART_CFG_Type UARTConfigStruct; UART_CFG_Type UARTConfigStruct;
PINSEL_CFG_Type PinCfg; PINSEL_CFG_Type PinCfg;
#if (USED_UART_DEBUG_PORT==0) #if (USED_UART_DEBUG_PORT==0)
/* /*
* Initialize UART0 pin connect * Initialize UART0 pin connect
*/ */
@ -303,7 +269,7 @@ void debug_frmwrk_init(void)
PinCfg.Pinnum = 3; PinCfg.Pinnum = 3;
PINSEL_ConfigPin(&PinCfg); PINSEL_ConfigPin(&PinCfg);
#elif (USED_UART_DEBUG_PORT==1) #elif (USED_UART_DEBUG_PORT==1)
/* /*
* Initialize UART1 pin connect * Initialize UART1 pin connect
*/ */
@ -315,7 +281,7 @@ void debug_frmwrk_init(void)
PINSEL_ConfigPin(&PinCfg); PINSEL_ConfigPin(&PinCfg);
PinCfg.Pinnum = 16; PinCfg.Pinnum = 16;
PINSEL_ConfigPin(&PinCfg); PINSEL_ConfigPin(&PinCfg);
#endif #endif
/* Initialize UART Configuration parameter structure to default state: /* Initialize UART Configuration parameter structure to default state:
* Baudrate = 9600bps * Baudrate = 9600bps
@ -336,7 +302,5 @@ void debug_frmwrk_init(void)
debug_frmwrk_initialized = TRUE; debug_frmwrk_initialized = TRUE;
} }
#endif /*_DBGFWK */
#endif // _DBGFWK
/* --------------------------------- End Of File ------------------------------ */