firm/bare_metal/lcd.h

   1 /**
   2  * @file lcd.h
   3  * @author Copyright(C) 2012 Shinichiro Nakamura
   4  * @brief BlueTank ACB-BF592 Application Sample Codes.
   5  */
   6
   7 /*
   8  * ===============================================================
   9  *  BlueTank
  10  * ===============================================================
  11  * Copyright (c) 2012 Shinichiro Nakamura
  12  *
  13  * Permission is hereby granted, free of charge, to any person
  14  * obtaining a copy of this software and associated documentation
  15  * files (the "Software"), to deal in the Software without
  16  * restriction, including without limitation the rights to use,
  17  * copy, modify, merge, publish, distribute, sublicense, and/or
  18  * sell copies of the Software, and to permit persons to whom the
  19  * Software is furnished to do so, subject to the following
  20  * conditions:
  21  *
  22  * The above copyright notice and this permission notice shall be
  23  * included in all copies or substantial portions of the Software.
  24  *
  25  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  26  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
  27  * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  28  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
  29  * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
  30  * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  31  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
  32  * OTHER DEALINGS IN THE SOFTWARE.
  33  * ===============================================================
  34  */
  35
  36 #ifndef _LCD_H_
  37 #define _LCD_H_
  38
  39 #include <stdbool.h>
  40 #include <stdint.h>
  41
  42 typedef enum {
  43     Left,
  44     Right
  45 } Direction;
  46
  47 typedef enum {
  48     UserFont1,
  49     UserFont2,
  50     UserFont3,
  51     UserFont4,
  52     UserFont5,
  53     UserFont6,
  54     UserFont7,
  55     UserFont8
  56 } UserFont;
  57
  58 #define LCD_FONT_WIDTH  (5)
  59 #define LCD_FONT_HEIGHT (8)
  60 #define LCD_FONT_CHARS  (8)
  61
  62 typedef struct {
  63     unsigned char data[LCD_FONT_HEIGHT];
  64 } Font;
  65
  66 typedef struct {
  67     Font fontlist[LCD_FONT_CHARS];
  68 } FontSet;
  69
  70 void lcd_init(void);
  71 void lcd_clear(void);
  72 void lcd_cursor_at_home(void);
  73 void lcd_entry_mode_set(bool increment, bool shifted);
  74 void lcd_display(bool display, bool cursor, bool blink);
  75 void lcd_cursor_shift(Direction dir);
  76 void lcd_display_shift(Direction dir);
  77 void lcd_goto(uint8_t x, uint8_t y);
  78 void lcd_putc(char c);
  79 void lcd_puts(char *str);
  80 void lcd_font_init(FontSet *fs);
  81 void lcd_font_set_pixel(
  82         FontSet *fs, UserFont index,
  83         const int x, const int y, const int on);
  84 void lcd_font_draw_line(
  85         FontSet *fs, UserFont index,
  86         int x1, int y1,
  87         int x2, int y2,
  88         int on);
  89 void lcd_font_setup_single(FontSet *fs, UserFont index);
  90 void lcd_font_setup_all(FontSet *fs);
  91
  92 #endif
  93