lcd_log.c File Reference

This file provides all the LCD Log firmware functions. More...

#include <stdio.h>
#include "lcd_log.h"

Go to the source code of this file.

Macros
#define	YWINDOW_MIN   4

Functions
void	LCD_LOG_Init (void)
	Initializes the LCD Log module. More...
void	LCD_LOG_DeInit (void)
	DeInitializes the LCD Log module. More...
void	LCD_LOG_SetHeader (uint8_t *header)
	Display the application header on the LCD screen. More...
void	LCD_LOG_SetFooter (uint8_t *footer)
	Display the application footer on the LCD screen. More...
void	LCD_LOG_ClearTextZone (void)
	Clear the Text Zone. More...
	if (LCD_Lock==DISABLE)
void	LCD_LOG_UpdateDisplay (void)
	Update the text area display. More...
ErrorStatus	LCD_LOG_ScrollBack (void)
	Display previous text frame. More...
ErrorStatus	LCD_LOG_ScrollForward (void)
	Display next text frame. More...

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
	LCD_LOG_PUTCHAR
	Redirect the printf to the LCD. More...
uint32_t	idx
return	ch

Detailed Description

This file provides all the LCD Log firmware functions.

Author

MCD Application Team

Version

V1.0.0

Date

18-February-2014 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

© COPYRIGHT(c) 2014 STMicroelectronics

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.

Definition in file lcd_log.c.