glcd.h

Go to the documentation of this file.

/*
        Copyright (c) 2012, Andy Gock

        All rights reserved.

        Redistribution and use in source and binary forms, with or without
        modification, are permitted provided that the following conditions are met:
                * Redistributions of source code must retain the above copyright
                  notice, this list of conditions and the following disclaimer.
                * 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.
                * Neither the name of Andy Gock 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 ANDY GOCK 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.
*/

#ifndef _GLCD_H
#define _GLCD_H

#if defined(GLCD_DEVICE_AVR8)
        #include <avr/pgmspace.h>
        #include <avr/io.h>
        #include <avr/interrupt.h>
        #include "devices/AVR8.h"
        
        #if !defined(GLCD_USE_AVR_DELAY)
                extern void delay_ms(uint32_t ms);
        #else
                /* Use AVR __delay_ms() function */
                #include <util/delay.h>
                #define delay_ms(t) _delay_ms(t)
        #endif
        
#elif defined(GLCD_DEVICE_LPC111X)
        #include <LPC11xx.h>
        #include "devices/LPC111x.h"
        extern void delay_ms(uint32_t ms);
        #define PROGMEM
        
#elif defined(GLCD_DEVICE_LPC11UXX)
        #include <LPC11Uxx.h>
        #include "devices/LPC11Uxx.h"
        extern void delay_ms(uint32_t ms);
        #define PROGMEM

#elif defined(GLCD_DEVICE_STM32F0XX)
        #include <stm32f0xx.h>
        #include <stm32f0xx_gpio.h>
        #include "devices/inc/STM32F0xx.h"
        extern void delay_ms(uint32_t ms);
        #define PROGMEM
        
#else
        #error "Device not supported"

#endif

#if defined(GLCD_CONTROLLER_PCD8544)
        #include "controllers/PCD8544.h"
        
#elif defined(GLCD_CONTROLLER_ST7565R)
        #include "controllers/ST7565R.h"        
        
#elif defined(GLCD_CONTROLLER_NT75451)
        #include "controllers/NT75451.h"
                
#else
        #error "Controller not supported"
        
#endif

#define swap(a, b) { uint8_t t = a; a = b; b = t; }

#include <stdint.h>
#include "glcd_devices.h"
#include "glcd_controllers.h"
#include "glcd_graphics.h"
#include "glcd_graphs.h"
#include "glcd_text_tiny.h"
#include "glcd_text.h"
#include "unit_tests.h"

#define BLACK 1
#define WHITE 0

/* Set to custom value, or leave at 0 for automatic assignment. */ 

#define GLCD_LCD_WIDTH  0

#define GLCD_LCD_HEIGHT 0

/* Automatic assignment of width and height, if required. */
#if !GLCD_LCD_WIDTH && !GLCD_LCD_HEIGHT
        #undef GLCD_LCD_WIDTH
        #undef GLCD_LCD_HEIGHT
        #if defined(GLCD_CONTROLLER_PCD8544)
                #define GLCD_LCD_WIDTH 84
                #define GLCD_LCD_HEIGHT 48
        #elif defined(GLCD_CONTROLLER_ST7565R) || defined(GLCD_CONTROLLER_NT75451)
                #define GLCD_LCD_WIDTH 128
                #define GLCD_LCD_HEIGHT 64
        #else
                #define GLCD_LCD_WIDTH 128
                #define GLCD_LCD_HEIGHT 64
        #endif
#endif

/*
 * GLCD_NUMBER_OF_BANKS is typically GLCD_LCD_HEIGHT/8
 * Don't adjust these below unless required.
 */
#define GLCD_NUMBER_OF_BANKS (GLCD_LCD_WIDTH / 8)
#define GLCD_NUMBER_OF_COLS  GLCD_LCD_WIDTH

#if !defined(GLCD_RESET_TIME)

#define GLCD_RESET_TIME 1
#endif

typedef struct {
        uint8_t x_min;
        uint8_t y_min;
        uint8_t x_max;
        uint8_t y_max;
} glcd_BoundingBox_t;

/* Global variables used for GLCD library */
extern uint8_t glcd_buffer[GLCD_LCD_WIDTH * GLCD_LCD_HEIGHT / 8];
extern glcd_BoundingBox_t glcd_bbox;
extern uint8_t *glcd_buffer_selected;
extern glcd_BoundingBox_t *glcd_bbox_selected;

void glcd_update_bbox(uint8_t xmin, uint8_t ymin, uint8_t xmax, uint8_t ymax);

void glcd_reset_bbox(void);

void glcd_bbox_reset(void);

void glcd_bbox_refresh(void);
        
void glcd_clear(void);

void glcd_clear_buffer(void);

void glcd_select_screen(uint8_t *buffer, glcd_BoundingBox_t *bbox);

void glcd_scroll(int8_t x, int8_t y);

void glcd_scroll_line(void);

enum font_table_type { STANG, MIKRO };

typedef struct {
        const char *font_table;
        uint8_t width;
        uint8_t height;
        char start_char;
        char end_char;
        enum font_table_type table_type;
} glcd_FontConfig_t;

extern uint8_t *glcd_buffer_selected;
extern glcd_BoundingBox_t *glcd_bbox_selected;
extern glcd_FontConfig_t font_current;

#endif