Merge tag 'for-5.11-tag' of git://git.kernel.org/pub/scm/linux/kernel/git/kdave/linux

[linux-2.6-microblaze.git] / drivers / auxdisplay / charlcd.h

diff --git a/drivers/auxdisplay/charlcd.h b/drivers/auxdisplay/charlcd.h
index 00911ad..eed8006 100644 (file)
--- a/drivers/auxdisplay/charlcd.h
+++ b/drivers/auxdisplay/charlcd.h
@@ -9,31 +9,91 @@
 #ifndef _CHARLCD_H
 #define _CHARLCD_H
 
+#define LCD_FLAG_B             0x0004  /* Blink on */
+#define LCD_FLAG_C             0x0008  /* Cursor on */
+#define LCD_FLAG_D             0x0010  /* Display on */
+#define LCD_FLAG_F             0x0020  /* Large font mode */
+#define LCD_FLAG_N             0x0040  /* 2-rows mode */
+#define LCD_FLAG_L             0x0080  /* Backlight enabled */
+
+enum charlcd_onoff {
+       CHARLCD_OFF = 0,
+       CHARLCD_ON,
+};
+
+enum charlcd_shift_dir {
+       CHARLCD_SHIFT_LEFT,
+       CHARLCD_SHIFT_RIGHT,
+};
+
+enum charlcd_fontsize {
+       CHARLCD_FONTSIZE_SMALL,
+       CHARLCD_FONTSIZE_LARGE,
+};
+
+enum charlcd_lines {
+       CHARLCD_LINES_1,
+       CHARLCD_LINES_2,
+};
+
 struct charlcd {
        const struct charlcd_ops *ops;
        const unsigned char *char_conv; /* Optional */
 
-       int ifwidth;                    /* 4-bit or 8-bit (default) */
        int height;
        int width;
-       int bwidth;                     /* Default set by charlcd_alloc() */
-       int hwidth;                     /* Default set by charlcd_alloc() */
 
-       void *drvdata;                  /* Set by charlcd_alloc() */
+       /* Contains the LCD X and Y offset */
+       struct {
+               unsigned long x;
+               unsigned long y;
+       } addr;
+
+       void *drvdata;
 };
 
+/**
+ * struct charlcd_ops - Functions used by charlcd. Drivers have to implement
+ * these.
+ * @backlight: Turn backlight on or off. Optional.
+ * @print: Print one character to the display at current cursor position.
+ * The buffered cursor position is advanced by charlcd. The cursor should not
+ * wrap to the next line at the end of a line.
+ * @gotoxy: Set cursor to x, y. The x and y values to set the cursor to are
+ * previously set in addr.x and addr.y by charlcd.
+ * @home: Set cursor to 0, 0. The values in addr.x and addr.y are set to 0, 0 by
+ * charlcd prior to calling this function.
+ * @clear_display: Clear the whole display and set the cursor to 0, 0. The
+ * values in addr.x and addr.y are set to 0, 0 by charlcd after to calling this
+ * function.
+ * @init_display: Initialize the display.
+ * @shift_cursor: Shift cursor left or right one position.
+ * @shift_display: Shift whole display content left or right.
+ * @display: Turn display on or off.
+ * @cursor: Turn cursor on or off.
+ * @blink: Turn cursor blink on or off.
+ * @lines: One or two lines.
+ * @redefine_char: Redefine the actual pixel matrix of character.
+ */
 struct charlcd_ops {
-       /* Required */
-       void (*write_cmd)(struct charlcd *lcd, int cmd);
-       void (*write_data)(struct charlcd *lcd, int data);
-
-       /* Optional */
-       void (*write_cmd_raw4)(struct charlcd *lcd, int cmd);   /* 4-bit only */
-       void (*clear_fast)(struct charlcd *lcd);
-       void (*backlight)(struct charlcd *lcd, int on);
+       void (*backlight)(struct charlcd *lcd, enum charlcd_onoff on);
+       int (*print)(struct charlcd *lcd, int c);
+       int (*gotoxy)(struct charlcd *lcd, unsigned int x, unsigned int y);
+       int (*home)(struct charlcd *lcd);
+       int (*clear_display)(struct charlcd *lcd);
+       int (*init_display)(struct charlcd *lcd);
+       int (*shift_cursor)(struct charlcd *lcd, enum charlcd_shift_dir dir);
+       int (*shift_display)(struct charlcd *lcd, enum charlcd_shift_dir dir);
+       int (*display)(struct charlcd *lcd, enum charlcd_onoff on);
+       int (*cursor)(struct charlcd *lcd, enum charlcd_onoff on);
+       int (*blink)(struct charlcd *lcd, enum charlcd_onoff on);
+       int (*fontsize)(struct charlcd *lcd, enum charlcd_fontsize size);
+       int (*lines)(struct charlcd *lcd, enum charlcd_lines lines);
+       int (*redefine_char)(struct charlcd *lcd, char *esc);
 };
 
-struct charlcd *charlcd_alloc(unsigned int drvdata_size);
+void charlcd_backlight(struct charlcd *lcd, enum charlcd_onoff on);
+struct charlcd *charlcd_alloc(void);
 void charlcd_free(struct charlcd *lcd);
 
 int charlcd_register(struct charlcd *lcd);