You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
515 lines
13 KiB
515 lines
13 KiB
/** |
|
****************************************************************************** |
|
* @file lcd_log.c |
|
* @author MCD Application Team |
|
* @version V1.0.1 |
|
* @date 18-November-2016 |
|
* @brief This file provides all the LCD Log firmware functions. |
|
* |
|
* The LCD Log module allows to automatically set a header and footer |
|
* on any application using the LCD display and allows to dump user, |
|
* debug and error messages by using the following macros: LCD_ErrLog(), |
|
* LCD_UsrLog() and LCD_DbgLog(). |
|
* |
|
* It supports also the scroll feature by embedding an internal software |
|
* cache for display. This feature allows to dump message sequentially |
|
* on the display even if the number of displayed lines is bigger than |
|
* the total number of line allowed by the display. |
|
* |
|
****************************************************************************** |
|
* @attention |
|
* |
|
* <h2><center>© COPYRIGHT(c) 2016 STMicroelectronics</center></h2> |
|
* |
|
* Redistribution and use in source and binary forms, with or without modification, |
|
* are permitted provided that the following conditions are met: |
|
* 1. Redistributions of source code must retain the above copyright notice, |
|
* this list of conditions and the following disclaimer. |
|
* 2. Redistributions in binary form must reproduce the above copyright notice, |
|
* this list of conditions and the following disclaimer in the documentation |
|
* and/or other materials provided with the distribution. |
|
* 3. Neither the name of STMicroelectronics nor the names of its contributors |
|
* may be used to endorse or promote products derived from this software |
|
* without specific prior written permission. |
|
* |
|
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" |
|
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
|
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE |
|
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE |
|
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL |
|
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR |
|
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER |
|
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, |
|
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
|
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
|
* |
|
****************************************************************************** |
|
*/ |
|
|
|
/* Includes ------------------------------------------------------------------*/ |
|
#include <stdio.h> |
|
#include "lcd_log.h" |
|
|
|
/** @addtogroup Utilities |
|
* @{ |
|
*/ |
|
|
|
/** @addtogroup STM32_EVAL |
|
* @{ |
|
*/ |
|
|
|
/** @addtogroup Common |
|
* @{ |
|
*/ |
|
|
|
/** @defgroup LCD_LOG |
|
* @brief LCD Log LCD_Application module |
|
* @{ |
|
*/ |
|
|
|
/** @defgroup LCD_LOG_Private_Types |
|
* @{ |
|
*/ |
|
/** |
|
* @} |
|
*/ |
|
|
|
|
|
/** @defgroup LCD_LOG_Private_Defines |
|
* @{ |
|
*/ |
|
|
|
/** |
|
* @} |
|
*/ |
|
|
|
/* Define the display window settings */ |
|
#define YWINDOW_MIN 4 |
|
|
|
/** @defgroup LCD_LOG_Private_Macros |
|
* @{ |
|
*/ |
|
/** |
|
* @} |
|
*/ |
|
|
|
|
|
/** @defgroup LCD_LOG_Private_Variables |
|
* @{ |
|
*/ |
|
|
|
LCD_LOG_line LCD_CacheBuffer [LCD_CACHE_DEPTH]; |
|
uint32_t LCD_LineColor; |
|
uint16_t LCD_CacheBuffer_xptr; |
|
uint16_t LCD_CacheBuffer_yptr_top; |
|
uint16_t LCD_CacheBuffer_yptr_bottom; |
|
|
|
uint16_t LCD_CacheBuffer_yptr_top_bak; |
|
uint16_t LCD_CacheBuffer_yptr_bottom_bak; |
|
|
|
FunctionalState LCD_CacheBuffer_yptr_invert; |
|
FunctionalState LCD_ScrollActive; |
|
FunctionalState LCD_Lock; |
|
FunctionalState LCD_Scrolled; |
|
uint16_t LCD_ScrollBackStep; |
|
|
|
/** |
|
* @} |
|
*/ |
|
|
|
|
|
/** @defgroup LCD_LOG_Private_FunctionPrototypes |
|
* @{ |
|
*/ |
|
|
|
/** |
|
* @} |
|
*/ |
|
|
|
|
|
/** @defgroup LCD_LOG_Private_Functions |
|
* @{ |
|
*/ |
|
|
|
|
|
/** |
|
* @brief Initializes the LCD Log module |
|
* @param None |
|
* @retval None |
|
*/ |
|
|
|
void LCD_LOG_Init ( void) |
|
{ |
|
/* Deinit LCD cache */ |
|
LCD_LOG_DeInit(); |
|
|
|
/* Clear the LCD */ |
|
BSP_LCD_Clear(LCD_LOG_BACKGROUND_COLOR); |
|
} |
|
|
|
/** |
|
* @brief DeInitializes the LCD Log module. |
|
* @param None |
|
* @retval None |
|
*/ |
|
void LCD_LOG_DeInit(void) |
|
{ |
|
LCD_LineColor = LCD_LOG_TEXT_COLOR; |
|
LCD_CacheBuffer_xptr = 0; |
|
LCD_CacheBuffer_yptr_top = 0; |
|
LCD_CacheBuffer_yptr_bottom = 0; |
|
|
|
LCD_CacheBuffer_yptr_top_bak = 0; |
|
LCD_CacheBuffer_yptr_bottom_bak = 0; |
|
|
|
LCD_CacheBuffer_yptr_invert= ENABLE; |
|
LCD_ScrollActive = DISABLE; |
|
LCD_Lock = DISABLE; |
|
LCD_Scrolled = DISABLE; |
|
LCD_ScrollBackStep = 0; |
|
} |
|
|
|
/** |
|
* @brief Display the application header on the LCD screen |
|
* @param header: pointer to the string to be displayed |
|
* @retval None |
|
*/ |
|
void LCD_LOG_SetHeader (uint8_t *header) |
|
{ |
|
/* Set the LCD Font */ |
|
BSP_LCD_SetFont (&LCD_LOG_HEADER_FONT); |
|
|
|
BSP_LCD_SetTextColor(LCD_LOG_SOLID_BACKGROUND_COLOR); |
|
BSP_LCD_FillRect(0, 0, BSP_LCD_GetXSize(), LCD_LOG_HEADER_FONT.Height * 3); |
|
|
|
/* Set the LCD Text Color */ |
|
BSP_LCD_SetTextColor(LCD_LOG_SOLID_TEXT_COLOR); |
|
BSP_LCD_SetBackColor(LCD_LOG_SOLID_BACKGROUND_COLOR); |
|
|
|
BSP_LCD_DisplayStringAt(0, LCD_LOG_HEADER_FONT.Height, header, CENTER_MODE); |
|
|
|
BSP_LCD_SetBackColor(LCD_LOG_BACKGROUND_COLOR); |
|
BSP_LCD_SetTextColor(LCD_LOG_TEXT_COLOR); |
|
BSP_LCD_SetFont (&LCD_LOG_TEXT_FONT); |
|
} |
|
|
|
/** |
|
* @brief Display the application footer on the LCD screen |
|
* @param footer: pointer to the string to be displayed |
|
* @retval None |
|
*/ |
|
void LCD_LOG_SetFooter(uint8_t *footer) |
|
{ |
|
/* Set the LCD Font */ |
|
BSP_LCD_SetFont (&LCD_LOG_FOOTER_FONT); |
|
|
|
BSP_LCD_SetTextColor(LCD_LOG_SOLID_BACKGROUND_COLOR); |
|
BSP_LCD_FillRect(0, BSP_LCD_GetYSize() - LCD_LOG_FOOTER_FONT.Height - 4, BSP_LCD_GetXSize(), LCD_LOG_FOOTER_FONT.Height + 4); |
|
|
|
/* Set the LCD Text Color */ |
|
BSP_LCD_SetTextColor(LCD_LOG_SOLID_TEXT_COLOR); |
|
BSP_LCD_SetBackColor(LCD_LOG_SOLID_BACKGROUND_COLOR); |
|
|
|
BSP_LCD_DisplayStringAt(0, BSP_LCD_GetYSize() - LCD_LOG_FOOTER_FONT.Height, footer, CENTER_MODE); |
|
|
|
BSP_LCD_SetBackColor(LCD_LOG_BACKGROUND_COLOR); |
|
BSP_LCD_SetTextColor(LCD_LOG_TEXT_COLOR); |
|
BSP_LCD_SetFont (&LCD_LOG_TEXT_FONT); |
|
} |
|
|
|
/** |
|
* @brief Clear the Text Zone |
|
* @param None |
|
* @retval None |
|
*/ |
|
void LCD_LOG_ClearTextZone(void) |
|
{ |
|
uint8_t i=0; |
|
|
|
for (i= 0 ; i < YWINDOW_SIZE; i++) |
|
{ |
|
BSP_LCD_ClearStringLine(i + YWINDOW_MIN); |
|
} |
|
|
|
LCD_LOG_DeInit(); |
|
} |
|
|
|
/** |
|
* @brief Redirect the printf to the LCD |
|
* @param c: character to be displayed |
|
* @param f: output file pointer |
|
* @retval None |
|
*/ |
|
LCD_LOG_PUTCHAR |
|
{ |
|
|
|
sFONT *cFont = BSP_LCD_GetFont(); |
|
uint32_t idx; |
|
|
|
if(LCD_Lock == DISABLE) |
|
{ |
|
if(LCD_ScrollActive == ENABLE) |
|
{ |
|
LCD_CacheBuffer_yptr_bottom = LCD_CacheBuffer_yptr_bottom_bak; |
|
LCD_CacheBuffer_yptr_top = LCD_CacheBuffer_yptr_top_bak; |
|
LCD_ScrollActive = DISABLE; |
|
LCD_Scrolled = DISABLE; |
|
LCD_ScrollBackStep = 0; |
|
|
|
} |
|
|
|
if(( LCD_CacheBuffer_xptr < (BSP_LCD_GetXSize()) /cFont->Width ) && ( ch != '\n')) |
|
{ |
|
LCD_CacheBuffer[LCD_CacheBuffer_yptr_bottom].line[LCD_CacheBuffer_xptr++] = (uint16_t)ch; |
|
} |
|
else |
|
{ |
|
if(LCD_CacheBuffer_yptr_top >= LCD_CacheBuffer_yptr_bottom) |
|
{ |
|
|
|
if(LCD_CacheBuffer_yptr_invert == DISABLE) |
|
{ |
|
LCD_CacheBuffer_yptr_top++; |
|
|
|
if(LCD_CacheBuffer_yptr_top == LCD_CACHE_DEPTH) |
|
{ |
|
LCD_CacheBuffer_yptr_top = 0; |
|
} |
|
} |
|
else |
|
{ |
|
LCD_CacheBuffer_yptr_invert= DISABLE; |
|
} |
|
} |
|
|
|
for(idx = LCD_CacheBuffer_xptr ; idx < (BSP_LCD_GetXSize()) /cFont->Width; idx++) |
|
{ |
|
LCD_CacheBuffer[LCD_CacheBuffer_yptr_bottom].line[LCD_CacheBuffer_xptr++] = ' '; |
|
} |
|
LCD_CacheBuffer[LCD_CacheBuffer_yptr_bottom].color = LCD_LineColor; |
|
|
|
LCD_CacheBuffer_xptr = 0; |
|
|
|
LCD_LOG_UpdateDisplay (); |
|
|
|
LCD_CacheBuffer_yptr_bottom ++; |
|
|
|
if (LCD_CacheBuffer_yptr_bottom == LCD_CACHE_DEPTH) |
|
{ |
|
LCD_CacheBuffer_yptr_bottom = 0; |
|
LCD_CacheBuffer_yptr_top = 1; |
|
LCD_CacheBuffer_yptr_invert = ENABLE; |
|
} |
|
|
|
if( ch != '\n') |
|
{ |
|
LCD_CacheBuffer[LCD_CacheBuffer_yptr_bottom].line[LCD_CacheBuffer_xptr++] = (uint16_t)ch; |
|
} |
|
|
|
} |
|
} |
|
return ch; |
|
} |
|
|
|
/** |
|
* @brief Update the text area display |
|
* @param None |
|
* @retval None |
|
*/ |
|
void LCD_LOG_UpdateDisplay (void) |
|
{ |
|
uint8_t cnt = 0 ; |
|
uint16_t length = 0 ; |
|
uint16_t ptr = 0, index = 0; |
|
|
|
if((LCD_CacheBuffer_yptr_bottom < (YWINDOW_SIZE -1)) && |
|
(LCD_CacheBuffer_yptr_bottom >= LCD_CacheBuffer_yptr_top)) |
|
{ |
|
BSP_LCD_SetTextColor(LCD_CacheBuffer[cnt + LCD_CacheBuffer_yptr_bottom].color); |
|
BSP_LCD_DisplayStringAtLine ((YWINDOW_MIN + LCD_CacheBuffer_yptr_bottom), |
|
(uint8_t *)(LCD_CacheBuffer[cnt + LCD_CacheBuffer_yptr_bottom].line)); |
|
} |
|
else |
|
{ |
|
|
|
if(LCD_CacheBuffer_yptr_bottom < LCD_CacheBuffer_yptr_top) |
|
{ |
|
/* Virtual length for rolling */ |
|
length = LCD_CACHE_DEPTH + LCD_CacheBuffer_yptr_bottom ; |
|
} |
|
else |
|
{ |
|
length = LCD_CacheBuffer_yptr_bottom; |
|
} |
|
|
|
ptr = length - YWINDOW_SIZE + 1; |
|
|
|
for (cnt = 0 ; cnt < YWINDOW_SIZE ; cnt ++) |
|
{ |
|
|
|
index = (cnt + ptr )% LCD_CACHE_DEPTH ; |
|
|
|
BSP_LCD_SetTextColor(LCD_CacheBuffer[index].color); |
|
BSP_LCD_DisplayStringAtLine ((cnt + YWINDOW_MIN), |
|
(uint8_t *)(LCD_CacheBuffer[index].line)); |
|
|
|
} |
|
} |
|
|
|
} |
|
|
|
#if( LCD_SCROLL_ENABLED == 1) |
|
/** |
|
* @brief Display previous text frame |
|
* @param None |
|
* @retval Status |
|
*/ |
|
ErrorStatus LCD_LOG_ScrollBack(void) |
|
{ |
|
|
|
if(LCD_ScrollActive == DISABLE) |
|
{ |
|
|
|
LCD_CacheBuffer_yptr_bottom_bak = LCD_CacheBuffer_yptr_bottom; |
|
LCD_CacheBuffer_yptr_top_bak = LCD_CacheBuffer_yptr_top; |
|
|
|
|
|
if(LCD_CacheBuffer_yptr_bottom > LCD_CacheBuffer_yptr_top) |
|
{ |
|
|
|
if ((LCD_CacheBuffer_yptr_bottom - LCD_CacheBuffer_yptr_top) <= YWINDOW_SIZE) |
|
{ |
|
LCD_Lock = DISABLE; |
|
return ERROR; |
|
} |
|
} |
|
LCD_ScrollActive = ENABLE; |
|
|
|
if((LCD_CacheBuffer_yptr_bottom > LCD_CacheBuffer_yptr_top)&& |
|
(LCD_Scrolled == DISABLE )) |
|
{ |
|
LCD_CacheBuffer_yptr_bottom--; |
|
LCD_Scrolled = ENABLE; |
|
} |
|
|
|
} |
|
|
|
if(LCD_ScrollActive == ENABLE) |
|
{ |
|
LCD_Lock = ENABLE; |
|
|
|
if(LCD_CacheBuffer_yptr_bottom > LCD_CacheBuffer_yptr_top) |
|
{ |
|
|
|
if((LCD_CacheBuffer_yptr_bottom - LCD_CacheBuffer_yptr_top) < YWINDOW_SIZE ) |
|
{ |
|
LCD_Lock = DISABLE; |
|
return ERROR; |
|
} |
|
|
|
LCD_CacheBuffer_yptr_bottom --; |
|
} |
|
else if(LCD_CacheBuffer_yptr_bottom <= LCD_CacheBuffer_yptr_top) |
|
{ |
|
|
|
if((LCD_CACHE_DEPTH - LCD_CacheBuffer_yptr_top + LCD_CacheBuffer_yptr_bottom) < YWINDOW_SIZE) |
|
{ |
|
LCD_Lock = DISABLE; |
|
return ERROR; |
|
} |
|
LCD_CacheBuffer_yptr_bottom --; |
|
|
|
if(LCD_CacheBuffer_yptr_bottom == 0xFFFF) |
|
{ |
|
LCD_CacheBuffer_yptr_bottom = LCD_CACHE_DEPTH - 2; |
|
} |
|
} |
|
LCD_ScrollBackStep++; |
|
LCD_LOG_UpdateDisplay(); |
|
LCD_Lock = DISABLE; |
|
} |
|
return SUCCESS; |
|
} |
|
|
|
/** |
|
* @brief Display next text frame |
|
* @param None |
|
* @retval Status |
|
*/ |
|
ErrorStatus LCD_LOG_ScrollForward(void) |
|
{ |
|
|
|
if(LCD_ScrollBackStep != 0) |
|
{ |
|
if(LCD_ScrollActive == DISABLE) |
|
{ |
|
|
|
LCD_CacheBuffer_yptr_bottom_bak = LCD_CacheBuffer_yptr_bottom; |
|
LCD_CacheBuffer_yptr_top_bak = LCD_CacheBuffer_yptr_top; |
|
|
|
if(LCD_CacheBuffer_yptr_bottom > LCD_CacheBuffer_yptr_top) |
|
{ |
|
|
|
if ((LCD_CacheBuffer_yptr_bottom - LCD_CacheBuffer_yptr_top) <= YWINDOW_SIZE) |
|
{ |
|
LCD_Lock = DISABLE; |
|
return ERROR; |
|
} |
|
} |
|
LCD_ScrollActive = ENABLE; |
|
|
|
if((LCD_CacheBuffer_yptr_bottom > LCD_CacheBuffer_yptr_top)&& |
|
(LCD_Scrolled == DISABLE )) |
|
{ |
|
LCD_CacheBuffer_yptr_bottom--; |
|
LCD_Scrolled = ENABLE; |
|
} |
|
|
|
} |
|
|
|
if(LCD_ScrollActive == ENABLE) |
|
{ |
|
LCD_Lock = ENABLE; |
|
LCD_ScrollBackStep--; |
|
|
|
if(++LCD_CacheBuffer_yptr_bottom == LCD_CACHE_DEPTH) |
|
{ |
|
LCD_CacheBuffer_yptr_bottom = 0; |
|
} |
|
|
|
LCD_LOG_UpdateDisplay(); |
|
LCD_Lock = DISABLE; |
|
|
|
} |
|
return SUCCESS; |
|
} |
|
else // LCD_ScrollBackStep == 0 |
|
{ |
|
LCD_Lock = DISABLE; |
|
return ERROR; |
|
} |
|
} |
|
#endif /* LCD_SCROLL_ENABLED */ |
|
|
|
/** |
|
* @} |
|
*/ |
|
|
|
/** |
|
* @} |
|
*/ |
|
|
|
/** |
|
* @} |
|
*/ |
|
|
|
/** |
|
* @} |
|
*/ |
|
|
|
/** |
|
* @} |
|
*/ |
|
|
|
|
|
/************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
|
|
|