display.h

Go to the documentation of this file.

/***************************************************************************/
#ifndef DISPLAY_H
#define DISPLAY_H
 
/******************************************************************************/
/***************************** Include Files **********************************/
/******************************************************************************/
#include <stdint.h>
#include "no_os_gpio.h"
#include "no_os_spi.h"
 
/******************************************************************************/
/*************************** Types Declarations *******************************/
/******************************************************************************/
struct display_dev {
    uint8_t                    cols_nb;
    uint8_t                    rows_nb;
    const struct display_controller_ops *controller_ops;
    void                       *extra;
};
 
struct display_init_param {
    uint8_t                    cols_nb;
    uint8_t                    rows_nb;
    const struct display_controller_ops *controller_ops;
    void                       *extra;
};
 
struct display_controller_ops {
    int32_t (*init)(struct display_dev *);
    int32_t (*display_on_off)(struct display_dev *, uint8_t);
    int32_t (*move_cursor)(struct display_dev *, uint8_t, uint8_t);
    int32_t (*print_char)(struct display_dev *, uint8_t, uint8_t,
                  uint8_t);
    int32_t (*remove)(struct display_dev *);
};
 
/******************************************************************************/
/************************ Functions Declarations ******************************/
/******************************************************************************/
 
int32_t display_init(struct display_dev **device,
             const struct display_init_param *param);
 
/* Frees the resources allocated by display_init(). */
int32_t display_remove(struct display_dev *device);
 
int32_t display_on(struct display_dev *device);
 
int32_t display_off(struct display_dev *device);
 
int32_t display_move_cursor(struct display_dev *device, uint8_t row,
                uint8_t column);
 
int32_t display_clear(struct display_dev *device);
 
int32_t display_print_string(struct display_dev *device, char *msg,
                 uint8_t row, uint8_t column);
 
int32_t display_print_char(struct display_dev *device, char chr,
               uint8_t row, uint8_t column);
 
#endif