hd44780.h

Go to the documentation of this file.

/*
 * Copyright (C) 2017 HAW Hamburg
 *
 * This file is subject to the terms and conditions of the GNU Lesser
 * General Public License v2.1. See the file LICENSE in the top level
 * directory for more details.
 */
 
#ifndef HD44780_H
#define HD44780_H
 
#include <stdint.h>
 
#include "periph/gpio.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define HD44780_MAX_COLS        (40U)
 
#define HD44780_MAX_ROWS        (4U)
 
#define HD44780_MAX_PINS        (8U)
 
#define HD44780_CGRAM_SIZE      (8U)
 
typedef struct {
    uint8_t cols;                   
    uint8_t rows;                   
    gpio_t rs;                      
    gpio_t rw;                      
    gpio_t enable;                  
    gpio_t data[HD44780_MAX_PINS];  
} hd44780_params_t;
 
typedef struct {
    hd44780_params_t p;             
    uint8_t flag;                   
    uint8_t ctrl;                   
    uint8_t mode;                   
    uint8_t roff[HD44780_MAX_ROWS]; 
} hd44780_t;
 
typedef enum {
    HD44780_OFF,                    
    HD44780_ON                      
} hd44780_state_t;
 
int hd44780_init(hd44780_t *dev, const hd44780_params_t *params);
 
void hd44780_clear(const hd44780_t *dev);
 
void hd44780_home(const hd44780_t *dev);
 
void hd44780_set_cursor(const hd44780_t *dev, uint8_t col, uint8_t row);
 
void hd44780_display(hd44780_t *dev, hd44780_state_t state);
 
void hd44780_cursor(hd44780_t *dev, hd44780_state_t state);
 
void hd44780_blink(hd44780_t *dev, hd44780_state_t state);
 
void hd44780_scroll_left(const hd44780_t *dev);
 
void hd44780_scroll_right(const hd44780_t *dev);
 
void hd44780_left2right(hd44780_t *dev);
 
void hd44780_right2left(hd44780_t *dev);
 
void hd44780_autoscroll(hd44780_t *dev, hd44780_state_t state);
 
void hd44780_create_char(const hd44780_t *dev, uint8_t location, uint8_t charmap[]);
 
void hd44780_write(const hd44780_t *dev, uint8_t value);
 
void hd44780_print(const hd44780_t *dev, const char *data);
 
#ifdef __cplusplus
}
#endif
 
#endif /* HD44780_H */