[J-u-boot.git] / include / video.h

/*
 * Video uclass to support displays (see also vidconsole for text)
 *
 * Copyright (c) 2015 Google, Inc
 */

#ifndef _VIDEO_H_
#define _VIDEO_H_

#include <stdio_dev.h>

struct udevice;

/**
 * struct video_uc_plat - uclass platform data for a video device
 *
 * This holds information that the uclass needs to know about each device. It
 * is accessed using dev_get_uclass_plat(dev). See 'Theory of operation' at
 * the top of video-uclass.c for details on how this information is set.
 *
 * @align: Frame-buffer alignment, indicating the memory boundary the frame
 *	buffer should start on. If 0, 1MB is assumed
 * @size: Frame-buffer size, in bytes
 * @base: Base address of frame buffer, 0 if not yet known
 * @copy_base: Base address of a hardware copy of the frame buffer. See
 *	CONFIG_VIDEO_COPY.
 * @copy_size: Size of copy framebuffer, used if @size is 0
 * @hide_logo: Hide the logo (used for testing)
 */
struct video_uc_plat {
	uint align;
	uint size;
	ulong base;
	ulong copy_base;
	ulong copy_size;
	bool hide_logo;
};

enum video_polarity {
	VIDEO_ACTIVE_HIGH,	/* Pins are active high */
	VIDEO_ACTIVE_LOW,	/* Pins are active low */
};

/*
 * Bits per pixel selector. Each value n is such that the bits-per-pixel is
 * 2 ^ n
 */
enum video_log2_bpp {
	VIDEO_BPP1	= 0,
	VIDEO_BPP2,
	VIDEO_BPP4,
	VIDEO_BPP8,
	VIDEO_BPP16,
	VIDEO_BPP32,
};

/*
 * Convert enum video_log2_bpp to bytes and bits. Note we omit the outer
 * brackets to allow multiplication by fractional pixels.
 */
#define VNBYTES(bpix)	((1 << (bpix)) / 8)

#define VNBITS(bpix)	(1 << (bpix))

enum video_format {
	VIDEO_UNKNOWN,
	VIDEO_RGBA8888,
	VIDEO_X8B8G8R8,
	VIDEO_X8R8G8B8,
	VIDEO_X2R10G10B10,
};

/**
 * struct video_priv - Device information used by the video uclass
 *
 * @xsize:	Number of pixel columns (e.g. 1366)
 * @ysize:	Number of pixels rows (e.g.. 768)
 * @rot:	Display rotation (0=none, 1=90 degrees clockwise, etc.)
 * @bpix:	Encoded bits per pixel (enum video_log2_bpp)
 * @format:	Pixel format (enum video_format)
 * @vidconsole_drv_name:	Driver to use for the text console, NULL to
 *		select automatically
 * @font_size:	Font size in pixels (0 to use a default value)
 * @fb:		Frame buffer
 * @fb_size:	Frame buffer size
 * @copy_fb:	Copy of the frame buffer to keep up to date; see struct
 *		video_uc_plat
 * @line_length:	Length of each frame buffer line, in bytes. This can be
 *		set by the driver, but if not, the uclass will set it after
 *		probing
 * @colour_fg:	Foreground colour (pixel value)
 * @colour_bg:	Background colour (pixel value)
 * @flush_dcache:	true to enable flushing of the data cache after
 *		the LCD is updated
 * @fg_col_idx:	Foreground color code (bit 3 = bold, bit 0-2 = color)
 * @bg_col_idx:	Background color code (bit 3 = bold, bit 0-2 = color)
 */
struct video_priv {
	/* Things set up by the driver: */
	ushort xsize;
	ushort ysize;
	ushort rot;
	enum video_log2_bpp bpix;
	enum video_format format;
	const char *vidconsole_drv_name;
	int font_size;

	/*
	 * Things that are private to the uclass: don't use these in the
	 * driver
	 */
	void *fb;
	int fb_size;
	void *copy_fb;
	int line_length;
	u32 colour_fg;
	u32 colour_bg;
	bool flush_dcache;
	u8 fg_col_idx;
	u8 bg_col_idx;
};

/**
 * struct video_ops - structure for keeping video operations
 * @video_sync: Synchronize FB with device. Some device like SPI based LCD
 *		displays needs synchronization when data in an FB is available.
 *		For these devices implement video_sync hook to call a sync
 *		function. vid is pointer to video device udevice. Function
 *		should return 0 on success video_sync and error code otherwise
 */
struct video_ops {
	int (*video_sync)(struct udevice *vid);
};

#define video_get_ops(dev)        ((struct video_ops *)(dev)->driver->ops)

/**
 * struct video_handoff - video information passed from SPL
 *
 * This is used when video is set up by SPL, to provide the details to U-Boot
 * proper.
 *
 * @fb: Base address of frame buffer, 0 if not yet known
 * @size: Frame-buffer size, in bytes
 * @xsize:	Number of pixel columns (e.g. 1366)
 * @ysize:	Number of pixels rows (e.g.. 768)
 * @line_length:	Length of each frame buffer line, in bytes. This can be
 *		set by the driver, but if not, the uclass will set it after
 *		probing
 * @bpix:	Encoded bits per pixel (enum video_log2_bpp)
 */
struct video_handoff {
	u64 fb;
	u32 size;
	u16 xsize;
	u16 ysize;
	u32 line_length;
	u8 bpix;
};

/** enum colour_idx - the 16 colors supported by consoles */
enum colour_idx {
	VID_BLACK = 0,
	VID_RED,
	VID_GREEN,
	VID_BROWN,
	VID_BLUE,
	VID_MAGENTA,
	VID_CYAN,
	VID_LIGHT_GRAY,
	VID_GRAY,
	VID_LIGHT_RED,
	VID_LIGHT_GREEN,
	VID_YELLOW,
	VID_LIGHT_BLUE,
	VID_LIGHT_MAGENTA,
	VID_LIGHT_CYAN,
	VID_WHITE,

	VID_COLOUR_COUNT
};

/**
 * video_index_to_colour() - convert a color code to a pixel's internal
 * representation
 *
 * The caller has to guarantee that the color index is less than
 * VID_COLOR_COUNT.
 *
 * @priv	private data of the video device (UCLASS_VIDEO)
 * @idx		color index (e.g. VID_YELLOW)
 * Return:	color value
 */
u32 video_index_to_colour(struct video_priv *priv, enum colour_idx idx);

/**
 * video_reserve() - Reserve frame-buffer memory for video devices
 *
 * Note: This function is for internal use.
 *
 * This uses the uclass plat's @size and @align members to figure out
 * a size and position for each frame buffer as part of the pre-relocation
 * process of determining the post-relocation memory layout.
 *
 * gd->video_top is set to the initial value of *@addrp and gd->video_bottom
 * is set to the final value.
 *
 * @addrp:	On entry, the top of available memory. On exit, the new top,
 *		after allocating the required memory.
 * Return: 0
 */
int video_reserve(ulong *addrp);

/**
 * video_clear() - Clear a device's frame buffer to background colour.
 *
 * @dev:	Device to clear
 * Return: 0 on success
 */
int video_clear(struct udevice *dev);

/**
 * video_fill() - Fill a device's frame buffer to a colour.
 *
 * @dev:	Device to fill
 * @colour:	Colour to use, in the frame buffer's format
 * Return: 0 on success
 */
int video_fill(struct udevice *dev, u32 colour);

/**
 * video_fill_part() - Erase a region
 *
 * Erase a rectangle of the display within the given bounds.
 *
 * @dev:	Device to update
 * @xstart:	X start position in pixels from the left
 * @ystart:	Y start position in pixels from the top
 * @xend:	X end position in pixels from the left
 * @yend:	Y end position  in pixels from the top
 * @colour:	Value to write
 * Return: 0 if OK, -ENOSYS if the display depth is not supported
 */
int video_fill_part(struct udevice *dev, int xstart, int ystart, int xend,
		    int yend, u32 colour);

/**
 * video_sync() - Sync a device's frame buffer with its hardware
 *
 * @vid:	Device to sync
 * @force:	True to force a sync even if there was one recently (this is
 *		very expensive on sandbox)
 *
 * @return: 0 on success, error code otherwise
 *
 * Some frame buffers are cached or have a secondary frame buffer. This
 * function syncs these up so that the current contents of the U-Boot frame
 * buffer are displayed to the user.
 */
int video_sync(struct udevice *vid, bool force);

/**
 * video_sync_all() - Sync all devices' frame buffers with their hardware
 *
 * This calls video_sync() on all active video devices.
 */
void video_sync_all(void);

/**
 * video_bmp_get_info() - Get information about a bitmap image
 *
 * @bmp_image: Pointer to BMP image to check
 * @widthp: Returns width in pixels
 * @heightp: Returns height in pixels
 * @bpixp: Returns log2 of bits per pixel
 */
void video_bmp_get_info(void *bmp_image, ulong *widthp, ulong *heightp,
			uint *bpixp);

/**
 * video_bmp_display() - Display a BMP file
 *
 * @dev:	Device to display the bitmap on
 * @bmp_image:	Address of bitmap image to display
 * @x:		X position in pixels from the left
 * @y:		Y position in pixels from the top
 * @align:	true to adjust the coordinates to centre the image. If false
 *		the coordinates are used as is. If true:
 *
 *		- if a coordinate is 0x7fff then the image will be centred in
 *		  that direction
 *		- if a coordinate is -ve then it will be offset to the
 *		  left/top of the centre by that many pixels
 *		- if a coordinate is positive it will be used unchanged.
 * Return: 0 if OK, -ve on error
 */
int video_bmp_display(struct udevice *dev, ulong bmp_image, int x, int y,
		      bool align);

/**
 * video_get_xsize() - Get the width of the display in pixels
 *
 * @dev:	Device to check
 * Return: device frame buffer width in pixels
 */
int video_get_xsize(struct udevice *dev);

/**
 * video_get_ysize() - Get the height of the display in pixels
 *
 * @dev:	Device to check
 * Return: device frame buffer height in pixels
 */
int video_get_ysize(struct udevice *dev);

/**
 * Set whether we need to flush the dcache when changing the image. This
 * defaults to off.
 *
 * @param flush		non-zero to flush cache after update, 0 to skip
 */
void video_set_flush_dcache(struct udevice *dev, bool flush);

/**
 * Set default colors and attributes
 *
 * @dev:	video device
 * @invert	true to invert colours
 */
void video_set_default_colors(struct udevice *dev, bool invert);

/**
 * video_default_font_height() - Get the default font height
 *
 * @dev:	video device
 * Returns: Default font height in pixels, which depends on which console driver
 * is in use
 */
int video_default_font_height(struct udevice *dev);

#ifdef CONFIG_VIDEO_COPY
/**
 * vidconsole_sync_copy() - Sync back to the copy framebuffer
 *
 * This ensures that the copy framebuffer has the same data as the framebuffer
 * for a particular region. It should be called after the framebuffer is updated
 *
 * @from and @to can be in either order. The region between them is synced.
 *
 * @dev: Vidconsole device being updated
 * @from: Start/end address within the framebuffer (->fb)
 * @to: Other address within the frame buffer
 * Return: 0 if OK, -EFAULT if the start address is before the start of the
 *	frame buffer start
 */
int video_sync_copy(struct udevice *dev, void *from, void *to);

/**
 * video_sync_copy_all() - Sync the entire framebuffer to the copy
 *
 * @dev: Vidconsole device being updated
 * Return: 0 (always)
 */
int video_sync_copy_all(struct udevice *dev);
#else
static inline int video_sync_copy(struct udevice *dev, void *from, void *to)
{
	return 0;
}

static inline int video_sync_copy_all(struct udevice *dev)
{
	return 0;
}

#endif

/**
 * video_is_active() - Test if one video device it active
 *
 * Return: true if at least one video device is active, else false.
 */
bool video_is_active(void);

/**
 * video_get_u_boot_logo() - Get a pointer to the U-Boot logo
 *
 * Returns: Pointer to logo
 */
void *video_get_u_boot_logo(void);

/*
 * bmp_display() - Display BMP (bitmap) data located in memory
 *
 * @addr: address of the bmp data
 * @x: Position of bitmap from the left side, in pixels
 * @y: Position of bitmap from the top, in pixels
 */
int bmp_display(ulong addr, int x, int y);

/*
 * bmp_info() - Show information about bmp file
 *
 * @addr: address of bmp file
 * Returns: 0 if OK, else 1 if bmp image not found
 */
int bmp_info(ulong addr);

/*
 * video_reserve_from_bloblist()- Reserve frame-buffer memory for video devices
 * using blobs.
 *
 * @ho: video information passed from SPL
 * Returns: 0 (always)
 */
int video_reserve_from_bloblist(struct video_handoff *ho);

#endif
Commit	Line	Data
167c5898	1	/*
50800147	2	* Video uclass to support displays (see also vidconsole for text)
1acafc73 SG	3	*
1acafc73 SG	4	* Copyright (c) 2015 Google, Inc
1acafc73	5	*/
167c5898 WD	6
	7	#ifndef _VIDEO_H_
	8	#define _VIDEO_H_
	9
1acafc73 SG	10	#include <stdio_dev.h>
1acafc73 SG	11
b9dea62b SG	12	struct udevice;
b9dea62b SG	13
5a6cea37	14	/**
8a8d24bd	15	* struct video_uc_plat - uclass platform data for a video device
5a6cea37 SG	16	*
5a6cea37 SG	17	* This holds information that the uclass needs to know about each device. It
caa4daa2	18	* is accessed using dev_get_uclass_plat(dev). See 'Theory of operation' at
5a6cea37 SG	19	* the top of video-uclass.c for details on how this information is set.
	20	*
	21	* @align: Frame-buffer alignment, indicating the memory boundary the frame
	22	* buffer should start on. If 0, 1MB is assumed
	23	* @size: Frame-buffer size, in bytes
	24	* @base: Base address of frame buffer, 0 if not yet known
9beac5da SG	25	* @copy_base: Base address of a hardware copy of the frame buffer. See
9beac5da SG	26	* CONFIG_VIDEO_COPY.
315e3679	27	* @copy_size: Size of copy framebuffer, used if @size is 0
84e63abf	28	* @hide_logo: Hide the logo (used for testing)
5a6cea37	29	*/
8a8d24bd	30	struct video_uc_plat {
1acafc73 SG	31	uint align;
	32	uint size;
	33	ulong base;
9beac5da	34	ulong copy_base;
315e3679	35	ulong copy_size;
84e63abf	36	bool hide_logo;
1acafc73 SG	37	};
1acafc73 SG	38
21c561b7 SG	39	enum video_polarity {
	40	VIDEO_ACTIVE_HIGH, /* Pins are active high */
	41	VIDEO_ACTIVE_LOW, /* Pins are active low */
	42	};
	43
1acafc73 SG	44	/*
	45	* Bits per pixel selector. Each value n is such that the bits-per-pixel is
	46	* 2 ^ n
	47	*/
	48	enum video_log2_bpp {
	49	VIDEO_BPP1 = 0,
	50	VIDEO_BPP2,
	51	VIDEO_BPP4,
	52	VIDEO_BPP8,
	53	VIDEO_BPP16,
	54	VIDEO_BPP32,
	55	};
	56
	57	/*
	58	* Convert enum video_log2_bpp to bytes and bits. Note we omit the outer
	59	* brackets to allow multiplication by fractional pixels.
	60	*/
cc05d352	61	#define VNBYTES(bpix) ((1 << (bpix)) / 8)
1acafc73 SG	62
	63	#define VNBITS(bpix) (1 << (bpix))
	64
0efe41ca MK	65	enum video_format {
0efe41ca MK	66	VIDEO_UNKNOWN,
e9500ba9	67	VIDEO_RGBA8888,
0efe41ca MK	68	VIDEO_X8B8G8R8,
	69	VIDEO_X8R8G8B8,
	70	VIDEO_X2R10G10B10,
	71	};
	72
1acafc73 SG	73	/**
	74	* struct video_priv - Device information used by the video uclass
	75	*
	76	* @xsize: Number of pixel columns (e.g. 1366)
	77	* @ysize: Number of pixels rows (e.g.. 768)
8cdae1da	78	* @rot: Display rotation (0=none, 1=90 degrees clockwise, etc.)
8c466ed3	79	* @bpix: Encoded bits per pixel (enum video_log2_bpp)
0efe41ca	80	* @format: Pixel format (enum video_format)
826f35f9 SG	81	* @vidconsole_drv_name: Driver to use for the text console, NULL to
	82	* select automatically
	83	* @font_size: Font size in pixels (0 to use a default value)
1acafc73 SG	84	* @fb: Frame buffer
1acafc73 SG	85	* @fb_size: Frame buffer size
9beac5da	86	* @copy_fb: Copy of the frame buffer to keep up to date; see struct
8a8d24bd	87	* video_uc_plat
06696ebe SG	88	* @line_length: Length of each frame buffer line, in bytes. This can be
	89	* set by the driver, but if not, the uclass will set it after
	90	* probing
1acafc73 SG	91	* @colour_fg: Foreground colour (pixel value)
	92	* @colour_bg: Background colour (pixel value)
	93	* @flush_dcache: true to enable flushing of the data cache after
	94	* the LCD is updated
9ffa4d12	95	* @fg_col_idx: Foreground color code (bit 3 = bold, bit 0-2 = color)
eabb0725	96	* @bg_col_idx: Background color code (bit 3 = bold, bit 0-2 = color)
1acafc73 SG	97	*/
	98	struct video_priv {
	99	/* Things set up by the driver: */
	100	ushort xsize;
	101	ushort ysize;
	102	ushort rot;
	103	enum video_log2_bpp bpix;
0efe41ca	104	enum video_format format;
826f35f9 SG	105	const char *vidconsole_drv_name;
826f35f9 SG	106	int font_size;
1acafc73 SG	107
	108	/*
	109	* Things that are private to the uclass: don't use these in the
	110	* driver
	111	*/
	112	void *fb;
	113	int fb_size;
9beac5da	114	void *copy_fb;
1acafc73	115	int line_length;
5c30fbb8 HS	116	u32 colour_fg;
5c30fbb8 HS	117	u32 colour_bg;
1acafc73	118	bool flush_dcache;
9ffa4d12	119	u8 fg_col_idx;
eabb0725	120	u8 bg_col_idx;
1acafc73 SG	121	};
1acafc73 SG	122
9d69c2d9 MS	123	/**
	124	* struct video_ops - structure for keeping video operations
	125	* @video_sync: Synchronize FB with device. Some device like SPI based LCD
	126	* displays needs synchronization when data in an FB is available.
	127	* For these devices implement video_sync hook to call a sync
	128	* function. vid is pointer to video device udevice. Function
	129	* should return 0 on success video_sync and error code otherwise
	130	*/
1acafc73	131	struct video_ops {
9d69c2d9	132	int (video_sync)(struct udevice vid);
1acafc73 SG	133	};
	134
	135	#define video_get_ops(dev) ((struct video_ops *)(dev)->driver->ops)
	136
03fe79c0 SG	137	/**
	138	* struct video_handoff - video information passed from SPL
	139	*
	140	* This is used when video is set up by SPL, to provide the details to U-Boot
	141	* proper.
	142	*
	143	* @fb: Base address of frame buffer, 0 if not yet known
	144	* @size: Frame-buffer size, in bytes
	145	* @xsize: Number of pixel columns (e.g. 1366)
	146	* @ysize: Number of pixels rows (e.g.. 768)
	147	* @line_length: Length of each frame buffer line, in bytes. This can be
	148	* set by the driver, but if not, the uclass will set it after
	149	* probing
	150	* @bpix: Encoded bits per pixel (enum video_log2_bpp)
	151	*/
	152	struct video_handoff {
	153	u64 fb;
	154	u32 size;
	155	u16 xsize;
	156	u16 ysize;
	157	u32 line_length;
	158	u8 bpix;
	159	};
	160
a032e4b5 SG	161	/** enum colour_idx - the 16 colors supported by consoles */
	162	enum colour_idx {
	163	VID_BLACK = 0,
	164	VID_RED,
	165	VID_GREEN,
	166	VID_BROWN,
	167	VID_BLUE,
	168	VID_MAGENTA,
	169	VID_CYAN,
	170	VID_LIGHT_GRAY,
	171	VID_GRAY,
	172	VID_LIGHT_RED,
	173	VID_LIGHT_GREEN,
	174	VID_YELLOW,
	175	VID_LIGHT_BLUE,
	176	VID_LIGHT_MAGENTA,
	177	VID_LIGHT_CYAN,
	178	VID_WHITE,
	179
	180	VID_COLOUR_COUNT
	181	};
	182
	183	/**
	184	* video_index_to_colour() - convert a color code to a pixel's internal
	185	* representation
	186	*
	187	* The caller has to guarantee that the color index is less than
	188	* VID_COLOR_COUNT.
	189	*
7ea207db	190	* @priv private data of the video device (UCLASS_VIDEO)
2d6ee92c	191	* @idx color index (e.g. VID_YELLOW)
a032e4b5 SG	192	* Return: color value
a032e4b5 SG	193	*/
2d6ee92c	194	u32 video_index_to_colour(struct video_priv *priv, enum colour_idx idx);
a032e4b5	195
1acafc73 SG	196	/**
	197	* video_reserve() - Reserve frame-buffer memory for video devices
	198	*
	199	* Note: This function is for internal use.
	200	*
caa4daa2	201	* This uses the uclass plat's @size and @align members to figure out
1acafc73 SG	202	* a size and position for each frame buffer as part of the pre-relocation
	203	* process of determining the post-relocation memory layout.
	204	*
	205	* gd->video_top is set to the initial value of *@addrp and gd->video_bottom
	206	* is set to the final value.
	207	*
	208	* @addrp: On entry, the top of available memory. On exit, the new top,
	209	* after allocating the required memory.
185f812c	210	* Return: 0
1acafc73 SG	211	*/
	212	int video_reserve(ulong *addrp);
	213
a085aa1f	214	/**
50d562c0	215	* video_clear() - Clear a device's frame buffer to background colour.
a085aa1f RC	216	*
a085aa1f RC	217	* @dev: Device to clear
50d562c0	218	* Return: 0 on success
a085aa1f	219	*/
c6ebd011	220	int video_clear(struct udevice *dev);
a085aa1f	221
50d562c0 SG	222	/**
	223	* video_fill() - Fill a device's frame buffer to a colour.
	224	*
	225	* @dev: Device to fill
	226	* @colour: Colour to use, in the frame buffer's format
	227	* Return: 0 on success
	228	*/
	229	int video_fill(struct udevice *dev, u32 colour);
	230
0ab4f91a SG	231	/**
	232	* video_fill_part() - Erase a region
	233	*
	234	* Erase a rectangle of the display within the given bounds.
	235	*
	236	* @dev: Device to update
	237	* @xstart: X start position in pixels from the left
	238	* @ystart: Y start position in pixels from the top
	239	* @xend: X end position in pixels from the left
	240	* @yend: Y end position in pixels from the top
	241	* @colour: Value to write
	242	* Return: 0 if OK, -ENOSYS if the display depth is not supported
	243	*/
	244	int video_fill_part(struct udevice *dev, int xstart, int ystart, int xend,
	245	int yend, u32 colour);
	246
1acafc73 SG	247	/**
	248	* video_sync() - Sync a device's frame buffer with its hardware
	249	*
17da310a MS	250	* @vid: Device to sync
	251	* @force: True to force a sync even if there was one recently (this is
	252	* very expensive on sandbox)
	253	*
9d69c2d9	254	* @return: 0 on success, error code otherwise
9de731f2	255	*
1acafc73 SG	256	* Some frame buffers are cached or have a secondary frame buffer. This
	257	* function syncs these up so that the current contents of the U-Boot frame
	258	* buffer are displayed to the user.
1acafc73	259	*/
9de731f2	260	int video_sync(struct udevice *vid, bool force);
1acafc73 SG	261
1acafc73 SG	262	/**
0926de23	263	* video_sync_all() - Sync all devices' frame buffers with their hardware
1acafc73 SG	264	*
	265	* This calls video_sync() on all active video devices.
	266	*/
	267	void video_sync_all(void);
	268
e90322f8 SG	269	/**
	270	* video_bmp_get_info() - Get information about a bitmap image
	271	*
	272	* @bmp_image: Pointer to BMP image to check
	273	* @widthp: Returns width in pixels
	274	* @heightp: Returns height in pixels
	275	* @bpixp: Returns log2 of bits per pixel
	276	*/
	277	void video_bmp_get_info(void bmp_image, ulong widthp, ulong *heightp,
	278	uint *bpixp);
	279
1acafc73 SG	280	/**
	281	* video_bmp_display() - Display a BMP file
	282	*
	283	* @dev: Device to display the bitmap on
	284	* @bmp_image: Address of bitmap image to display
	285	* @x: X position in pixels from the left
	286	* @y: Y position in pixels from the top
	287	* @align: true to adjust the coordinates to centre the image. If false
	288	* the coordinates are used as is. If true:
	289	*
	290	* - if a coordinate is 0x7fff then the image will be centred in
	291	* that direction
	292	* - if a coordinate is -ve then it will be offset to the
	293	* left/top of the centre by that many pixels
5abd8bb0	294	* - if a coordinate is positive it will be used unchanged.
185f812c	295	* Return: 0 if OK, -ve on error
1acafc73 SG	296	*/
	297	int video_bmp_display(struct udevice *dev, ulong bmp_image, int x, int y,
	298	bool align);
	299
	300	/**
	301	* video_get_xsize() - Get the width of the display in pixels
	302	*
	303	* @dev: Device to check
185f812c	304	* Return: device frame buffer width in pixels
1acafc73 SG	305	*/
	306	int video_get_xsize(struct udevice *dev);
	307
	308	/**
	309	* video_get_ysize() - Get the height of the display in pixels
	310	*
	311	* @dev: Device to check
185f812c	312	* Return: device frame buffer height in pixels
1acafc73 SG	313	*/
	314	int video_get_ysize(struct udevice *dev);
	315
68dcdc99 SG	316	/**
	317	* Set whether we need to flush the dcache when changing the image. This
	318	* defaults to off.
	319	*
	320	* @param flush non-zero to flush cache after update, 0 to skip
	321	*/
	322	void video_set_flush_dcache(struct udevice *dev, bool flush);
	323
5c30fbb8 HS	324	/**
	325	* Set default colors and attributes
	326	*
b9f210a3 SG	327	* @dev: video device
b9f210a3 SG	328	* @invert true to invert colours
5c30fbb8	329	*/
b9f210a3	330	void video_set_default_colors(struct udevice *dev, bool invert);
5c30fbb8	331
c830e285 SG	332	/**
	333	* video_default_font_height() - Get the default font height
	334	*
	335	* @dev: video device
	336	* Returns: Default font height in pixels, which depends on which console driver
	337	* is in use
	338	*/
	339	int video_default_font_height(struct udevice *dev);
	340
9beac5da SG	341	#ifdef CONFIG_VIDEO_COPY
	342	/**
	343	* vidconsole_sync_copy() - Sync back to the copy framebuffer
	344	*
	345	* This ensures that the copy framebuffer has the same data as the framebuffer
	346	* for a particular region. It should be called after the framebuffer is updated
	347	*
	348	* @from and @to can be in either order. The region between them is synced.
	349	*
	350	* @dev: Vidconsole device being updated
	351	* @from: Start/end address within the framebuffer (->fb)
	352	* @to: Other address within the frame buffer
185f812c	353	* Return: 0 if OK, -EFAULT if the start address is before the start of the
9beac5da SG	354	* frame buffer start
	355	*/
	356	int video_sync_copy(struct udevice dev, void from, void *to);
7d70116f SG	357
	358	/**
	359	* video_sync_copy_all() - Sync the entire framebuffer to the copy
	360	*
	361	* @dev: Vidconsole device being updated
185f812c	362	* Return: 0 (always)
7d70116f SG	363	*/
7d70116f SG	364	int video_sync_copy_all(struct udevice *dev);
9beac5da SG	365	#else
	366	static inline int video_sync_copy(struct udevice dev, void from, void *to)
	367	{
	368	return 0;
	369	}
7d70116f SG	370
	371	static inline int video_sync_copy_all(struct udevice *dev)
	372	{
	373	return 0;
	374	}
	375
9beac5da SG	376	#endif
9beac5da SG	377
2e2e6d8c PD	378	/**
	379	* video_is_active() - Test if one video device it active
	380	*
185f812c	381	* Return: true if at least one video device is active, else false.
2e2e6d8c PD	382	*/
	383	bool video_is_active(void);
	384
0d389018 SG	385	/**
	386	* video_get_u_boot_logo() - Get a pointer to the U-Boot logo
	387	*
	388	* Returns: Pointer to logo
	389	*/
	390	void *video_get_u_boot_logo(void);
	391
f24404d8 SG	392	/*
	393	* bmp_display() - Display BMP (bitmap) data located in memory
	394	*
	395	* @addr: address of the bmp data
	396	* @x: Position of bitmap from the left side, in pixels
	397	* @y: Position of bitmap from the top, in pixels
	398	*/
	399	int bmp_display(ulong addr, int x, int y);
	400
58182b2d NJ	401	/*
	402	* bmp_info() - Show information about bmp file
	403	*
	404	* @addr: address of bmp file
	405	* Returns: 0 if OK, else 1 if bmp image not found
	406	*/
	407	int bmp_info(ulong addr);
	408
ccd21ee5 NJ	409	/*
	410	* video_reserve_from_bloblist()- Reserve frame-buffer memory for video devices
	411	* using blobs.
	412	*
	413	* @ho: video information passed from SPL
	414	* Returns: 0 (always)
	415	*/
	416	int video_reserve_from_bloblist(struct video_handoff *ho);
	417
167c5898	418	#endif