u-boot/drivers/video/vidconsole_internal.h
Simon Glass 37db20d0a6 video: Support showing a cursor
Add rudimentary support for displaying a cursor on a vidconsole. This
helps the user to see where text is being entered.

The implementation so far is very simple: the cursor is just a vertical
bar of fixed width and cannot be erased. To erase the cursor, the text
must be redrawn over it.

This is good enough for expo but will need enhancement to be useful for
the command-line console. For example, it could save and restore the
area behind the cursor.

For now, enable this only for expo, to reduce code size.

Signed-off-by: Simon Glass <sjg@chromium.org>
2023-10-11 15:43:55 -04:00

144 lines
5.2 KiB
C

/* SPDX-License-Identifier: GPL-2.0+ */
/*
* Copyright (c) 2015 Google, Inc
* (C) Copyright 2015
* Bernecker & Rainer Industrieelektronik GmbH - http://www.br-automation.com
* (C) Copyright 2023 Dzmitry Sankouski <dsankouski@gmail.com>
*/
#define FLIPPED_DIRECTION 1
#define NORMAL_DIRECTION 0
/**
* struct console_simple_priv - Private data for this driver
*
* @video_fontdata font graphical representation data
*/
struct console_simple_priv {
struct video_fontdata *fontdata;
};
/**
* Checks if bits per pixel supported.
*
* @param bpix framebuffer bits per pixel.
*
* @returns 0, if supported, or else -ENOSYS.
*/
int check_bpix_support(int bpix);
/**
* Fill 1 pixel in framebuffer, and go to next one.
*
* @param dstp a pointer to pointer to framebuffer.
* @param value value to write to framebuffer.
* @param pbytes framebuffer bytes per pixel.
* @param step framebuffer pointer increment. Usually is equal to pbytes,
* and may be negative to control filling direction.
*/
void fill_pixel_and_goto_next(void **dstp, u32 value, int pbytes, int step);
/**
* Fills 1 character in framebuffer vertically. Vertically means we're filling char font data rows
* across the lines.
*
* @param pfont a pointer to character font data.
* @param line a pointer to pointer to framebuffer. It's a point for upper left char corner
* @param vid_priv driver private data.
* @fontdata font graphical representation data
* @param direction controls character orientation. Can be normal or flipped.
* When normal: When flipped:
*|-----------------------------------------------|
*| line stepping | |
*| | | stepping -> |
*| * | | * * * |
*| * * v | * |
*| * | * |
*| * | * * ^ |
*| * * * | * | |
*| | | |
*| stepping -> | line stepping |
*|---!!we're starting from upper left char corner|
*|-----------------------------------------------|
*
* @returns 0, if success, or else error code.
*/
int fill_char_vertically(uchar *pfont, void **line, struct video_priv *vid_priv,
struct video_fontdata *fontdata, bool direction);
/**
* Fills 1 character in framebuffer horizontally.
* Horizontally means we're filling char font data columns across the lines.
*
* @param pfont a pointer to character font data.
* @param line a pointer to pointer to framebuffer. It's a point for upper left char corner
* @param vid_priv driver private data.
* @fontdata font graphical representation data
* @param direction controls character orientation. Can be normal or flipped.
* When normal: When flipped:
*|-----------------------------------------------|
*| * | line stepping |
*| ^ * * * * * | | |
*| | * * | v * * |
*| | | * * * * * |
*| line stepping | * |
*| | |
*| stepping -> | <- stepping |
*|---!!we're starting from upper left char corner|
*|-----------------------------------------------|
*
* @returns 0, if success, or else error code.
*/
int fill_char_horizontally(uchar *pfont, void **line, struct video_priv *vid_priv,
struct video_fontdata *fontdata, bool direction);
/**
* draw_cursor_vertically() - Draw a simple vertical cursor
*
* @line: pointer to framebuffer buffer: upper left cursor corner
* @vid_priv: driver private data
* @height: height of the cursor in pixels
* @param direction controls cursor orientation. Can be normal or flipped.
* When normal: When flipped:
*|-----------------------------------------------|
*| * | line stepping |
*| ^ * * * * * | | |
*| | * * | v * * |
*| | | * * * * * |
*| line stepping | * |
*| | |
*| stepping -> | <<- stepping |
*|---!!we're starting from upper left char corner|
*|-----------------------------------------------|
*
* Return: 0, if success, or else error code.
*/
int draw_cursor_vertically(void **line, struct video_priv *vid_priv,
uint height, bool direction);
/**
* console probe function.
*
* @param dev a pointer to device.
*
* @returns 0, if success, or else error code.
*/
int console_probe(struct udevice *dev);
/**
* Internal function to be used in as ops.
* See details in video_console.h get_font_size function
**/
const char *console_simple_get_font_size(struct udevice *dev, uint *sizep);
/**
* Internal function to be used in as ops.
* See details in video_console.h get_font function
**/
int console_simple_get_font(struct udevice *dev, int seq, struct vidfont_info *info);
/**
* Internal function to be used in as ops.
* See details in video_console.h select_font function
**/
int console_simple_select_font(struct udevice *dev, const char *name, uint size);