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

/*
 * Video uclass and legacy implementation
 *
 * Copyright (c) 2015 Google, Inc
 *
 * MPC823 Video Controller
 * =======================
 * (C) 2000 by Paolo Scaffardi ([email protected])
 * AIRVENT SAM s.p.a - RIMINI(ITALY)
 *
 */

#ifndef _VIDEO_H_
#define _VIDEO_H_

#ifdef CONFIG_DM_VIDEO

#include <stdio_dev.h>

struct udevice;

/**
 * struct video_uc_platdata - 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_platdata(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.
 */
struct video_uc_platdata {
	uint align;
	uint size;
	ulong base;
	ulong copy_base;
};

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))

/**
 * 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)
 * @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_platdata
 * @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
 * @cmap:	Colour map for 8-bit-per-pixel displays
 * @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;
	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;
	ushort *cmap;
	u8 fg_col_idx;
	u8 bg_col_idx;
};

/* Placeholder - there are no video operations at present */
struct video_ops {
};

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

/**
 * video_reserve() - Reserve frame-buffer memory for video devices
 *
 * Note: This function is for internal use.
 *
 * This uses the uclass platdata'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 color.
 *
 * @dev:	Device to clear
 * @return 0
 */
int video_clear(struct udevice *dev);

/**
 * video_sync() - Sync a device's frame buffer with its hardware
 *
 * 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.
 *
 * @dev:	Device to sync
 * @force:	True to force a sync even if there was one recently (this is
 *		very expensive on sandbox)
 */
void video_sync(struct udevice *vid, bool force);

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

/**
 * 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 unchnaged.
 * @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);

#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);
#else
static inline int video_sync_copy(struct udevice *dev, void *from, void *to)
{
	return 0;
}
#endif

#endif /* CONFIG_DM_VIDEO */

#ifndef CONFIG_DM_VIDEO

/* Video functions */

/**
 * Display a BMP format bitmap on the screen
 *
 * @param bmp_image	Address of BMP image
 * @param x		X position to draw image
 * @param y		Y position to draw image
 */
int video_display_bitmap(ulong bmp_image, int x, int y);

/**
 * Get the width of the screen in pixels
 *
 * @return width of screen in pixels
 */
int video_get_pixel_width(void);

/**
 * Get the height of the screen in pixels
 *
 * @return height of screen in pixels
 */
int video_get_pixel_height(void);

/**
 * Get the number of text lines/rows on the screen
 *
 * @return number of rows
 */
int video_get_screen_rows(void);

/**
 * Get the number of text columns on the screen
 *
 * @return number of columns
 */
int video_get_screen_columns(void);

/**
 * Set the position of the text cursor
 *
 * @param col	Column to place cursor (0 = left side)
 * @param row	Row to place cursor (0 = top line)
 */
void video_position_cursor(unsigned col, unsigned row);

/* Clear the display */
void video_clear(void);

#if defined(CONFIG_FORMIKE)
int kwh043st20_f01_spi_startup(unsigned int bus, unsigned int cs,
	unsigned int max_hz, unsigned int spi_mode);
#endif
#if defined(CONFIG_LG4573)
int lg4573_spi_startup(unsigned int bus, unsigned int cs,
	unsigned int max_hz, unsigned int spi_mode);
#endif

/*
 * video_get_info_str() - obtain a board string: type, speed, etc.
 *
 * This is called if CONFIG_CONSOLE_EXTRA_INFO is enabled.
 *
 * line_number:	location to place info string beside logo
 * info:	buffer for info string (empty if nothing to display on this
 * line)
 */
void video_get_info_str(int line_number, char *info);

#endif /* !CONFIG_DM_VIDEO */

#endif
Commit	Line	Data
167c5898	1	/*
1acafc73 SG	2	* Video uclass and legacy implementation
	3	*
	4	* Copyright (c) 2015 Google, Inc
	5	*
	6	* MPC823 Video Controller
	7	* =======================
	8	* (C) 2000 by Paolo Scaffardi ([email protected])
	9	* AIRVENT SAM s.p.a - RIMINI(ITALY)
	10	*
	11	*/
167c5898 WD	12
	13	#ifndef _VIDEO_H_
	14	#define _VIDEO_H_
	15
1acafc73 SG	16	#ifdef CONFIG_DM_VIDEO
	17
	18	#include <stdio_dev.h>
	19
b9dea62b SG	20	struct udevice;
b9dea62b SG	21
5a6cea37 SG	22	/**
	23	* struct video_uc_platdata - uclass platform data for a video device
	24	*
	25	* This holds information that the uclass needs to know about each device. It
	26	* is accessed using dev_get_uclass_platdata(dev). See 'Theory of operation' at
	27	* the top of video-uclass.c for details on how this information is set.
	28	*
	29	* @align: Frame-buffer alignment, indicating the memory boundary the frame
	30	* buffer should start on. If 0, 1MB is assumed
	31	* @size: Frame-buffer size, in bytes
	32	* @base: Base address of frame buffer, 0 if not yet known
9beac5da SG	33	* @copy_base: Base address of a hardware copy of the frame buffer. See
9beac5da SG	34	* CONFIG_VIDEO_COPY.
5a6cea37	35	*/
1acafc73 SG	36	struct video_uc_platdata {
	37	uint align;
	38	uint size;
	39	ulong base;
9beac5da	40	ulong copy_base;
1acafc73 SG	41	};
1acafc73 SG	42
21c561b7 SG	43	enum video_polarity {
	44	VIDEO_ACTIVE_HIGH, /* Pins are active high */
	45	VIDEO_ACTIVE_LOW, /* Pins are active low */
	46	};
	47
1acafc73 SG	48	/*
	49	* Bits per pixel selector. Each value n is such that the bits-per-pixel is
	50	* 2 ^ n
	51	*/
	52	enum video_log2_bpp {
	53	VIDEO_BPP1 = 0,
	54	VIDEO_BPP2,
	55	VIDEO_BPP4,
	56	VIDEO_BPP8,
	57	VIDEO_BPP16,
	58	VIDEO_BPP32,
	59	};
	60
	61	/*
	62	* Convert enum video_log2_bpp to bytes and bits. Note we omit the outer
	63	* brackets to allow multiplication by fractional pixels.
	64	*/
	65	#define VNBYTES(bpix) (1 << (bpix)) / 8
	66
	67	#define VNBITS(bpix) (1 << (bpix))
	68
	69	/**
	70	* struct video_priv - Device information used by the video uclass
	71	*
	72	* @xsize: Number of pixel columns (e.g. 1366)
	73	* @ysize: Number of pixels rows (e.g.. 768)
8cdae1da	74	* @rot: Display rotation (0=none, 1=90 degrees clockwise, etc.)
8c466ed3	75	* @bpix: Encoded bits per pixel (enum video_log2_bpp)
826f35f9 SG	76	* @vidconsole_drv_name: Driver to use for the text console, NULL to
	77	* select automatically
	78	* @font_size: Font size in pixels (0 to use a default value)
1acafc73 SG	79	* @fb: Frame buffer
1acafc73 SG	80	* @fb_size: Frame buffer size
9beac5da SG	81	* @copy_fb: Copy of the frame buffer to keep up to date; see struct
9beac5da SG	82	* video_uc_platdata
06696ebe SG	83	* @line_length: Length of each frame buffer line, in bytes. This can be
	84	* set by the driver, but if not, the uclass will set it after
	85	* probing
1acafc73 SG	86	* @colour_fg: Foreground colour (pixel value)
	87	* @colour_bg: Background colour (pixel value)
	88	* @flush_dcache: true to enable flushing of the data cache after
	89	* the LCD is updated
	90	* @cmap: Colour map for 8-bit-per-pixel displays
9ffa4d12	91	* @fg_col_idx: Foreground color code (bit 3 = bold, bit 0-2 = color)
eabb0725	92	* @bg_col_idx: Background color code (bit 3 = bold, bit 0-2 = color)
1acafc73 SG	93	*/
	94	struct video_priv {
	95	/* Things set up by the driver: */
	96	ushort xsize;
	97	ushort ysize;
	98	ushort rot;
	99	enum video_log2_bpp bpix;
826f35f9 SG	100	const char *vidconsole_drv_name;
826f35f9 SG	101	int font_size;
1acafc73 SG	102
	103	/*
	104	* Things that are private to the uclass: don't use these in the
	105	* driver
	106	*/
	107	void *fb;
	108	int fb_size;
9beac5da	109	void *copy_fb;
1acafc73	110	int line_length;
5c30fbb8 HS	111	u32 colour_fg;
5c30fbb8 HS	112	u32 colour_bg;
1acafc73 SG	113	bool flush_dcache;
1acafc73 SG	114	ushort *cmap;
9ffa4d12	115	u8 fg_col_idx;
eabb0725	116	u8 bg_col_idx;
1acafc73 SG	117	};
	118
	119	/* Placeholder - there are no video operations at present */
	120	struct video_ops {
	121	};
	122
	123	#define video_get_ops(dev) ((struct video_ops *)(dev)->driver->ops)
	124
	125	/**
	126	* video_reserve() - Reserve frame-buffer memory for video devices
	127	*
	128	* Note: This function is for internal use.
	129	*
	130	* This uses the uclass platdata's @size and @align members to figure out
	131	* a size and position for each frame buffer as part of the pre-relocation
	132	* process of determining the post-relocation memory layout.
	133	*
	134	* gd->video_top is set to the initial value of *@addrp and gd->video_bottom
	135	* is set to the final value.
	136	*
	137	* @addrp: On entry, the top of available memory. On exit, the new top,
	138	* after allocating the required memory.
	139	* @return 0
	140	*/
	141	int video_reserve(ulong *addrp);
	142
a085aa1f RC	143	/**
	144	* video_clear() - Clear a device's frame buffer to background color.
	145	*
	146	* @dev: Device to clear
c6ebd011	147	* @return 0
a085aa1f	148	*/
c6ebd011	149	int video_clear(struct udevice *dev);
a085aa1f	150
1acafc73 SG	151	/**
	152	* video_sync() - Sync a device's frame buffer with its hardware
	153	*
	154	* Some frame buffers are cached or have a secondary frame buffer. This
	155	* function syncs these up so that the current contents of the U-Boot frame
	156	* buffer are displayed to the user.
	157	*
	158	* @dev: Device to sync
55d39911 SG	159	* @force: True to force a sync even if there was one recently (this is
55d39911 SG	160	* very expensive on sandbox)
1acafc73	161	*/
55d39911	162	void video_sync(struct udevice *vid, bool force);
1acafc73 SG	163
	164	/**
	165	* video_sync_all() - Sync all devices' frame buffers with there hardware
	166	*
	167	* This calls video_sync() on all active video devices.
	168	*/
	169	void video_sync_all(void);
	170
	171	/**
	172	* video_bmp_display() - Display a BMP file
	173	*
	174	* @dev: Device to display the bitmap on
	175	* @bmp_image: Address of bitmap image to display
	176	* @x: X position in pixels from the left
	177	* @y: Y position in pixels from the top
	178	* @align: true to adjust the coordinates to centre the image. If false
	179	* the coordinates are used as is. If true:
	180	*
	181	* - if a coordinate is 0x7fff then the image will be centred in
	182	* that direction
	183	* - if a coordinate is -ve then it will be offset to the
	184	* left/top of the centre by that many pixels
	185	* - if a coordinate is positive it will be used unchnaged.
	186	* @return 0 if OK, -ve on error
	187	*/
	188	int video_bmp_display(struct udevice *dev, ulong bmp_image, int x, int y,
	189	bool align);
	190
	191	/**
	192	* video_get_xsize() - Get the width of the display in pixels
	193	*
	194	* @dev: Device to check
	195	* @return device frame buffer width in pixels
	196	*/
	197	int video_get_xsize(struct udevice *dev);
	198
	199	/**
	200	* video_get_ysize() - Get the height of the display in pixels
	201	*
	202	* @dev: Device to check
	203	* @return device frame buffer height in pixels
	204	*/
	205	int video_get_ysize(struct udevice *dev);
	206
68dcdc99 SG	207	/**
	208	* Set whether we need to flush the dcache when changing the image. This
	209	* defaults to off.
	210	*
	211	* @param flush non-zero to flush cache after update, 0 to skip
	212	*/
	213	void video_set_flush_dcache(struct udevice *dev, bool flush);
	214
5c30fbb8 HS	215	/**
	216	* Set default colors and attributes
	217	*
b9f210a3 SG	218	* @dev: video device
b9f210a3 SG	219	* @invert true to invert colours
5c30fbb8	220	*/
b9f210a3	221	void video_set_default_colors(struct udevice *dev, bool invert);
5c30fbb8	222
9beac5da SG	223	#ifdef CONFIG_VIDEO_COPY
	224	/**
	225	* vidconsole_sync_copy() - Sync back to the copy framebuffer
	226	*
	227	* This ensures that the copy framebuffer has the same data as the framebuffer
	228	* for a particular region. It should be called after the framebuffer is updated
	229	*
	230	* @from and @to can be in either order. The region between them is synced.
	231	*
	232	* @dev: Vidconsole device being updated
	233	* @from: Start/end address within the framebuffer (->fb)
	234	* @to: Other address within the frame buffer
	235	* @return 0 if OK, -EFAULT if the start address is before the start of the
	236	* frame buffer start
	237	*/
	238	int video_sync_copy(struct udevice dev, void from, void *to);
	239	#else
	240	static inline int video_sync_copy(struct udevice dev, void from, void *to)
	241	{
	242	return 0;
	243	}
	244	#endif
	245
1acafc73 SG	246	#endif /* CONFIG_DM_VIDEO */
	247
	248	#ifndef CONFIG_DM_VIDEO
	249
167c5898 WD	250	/* Video functions */
167c5898 WD	251
f674f7cf SR	252	/**
	253	* Display a BMP format bitmap on the screen
	254	*
	255	* @param bmp_image Address of BMP image
	256	* @param x X position to draw image
	257	* @param y Y position to draw image
	258	*/
	259	int video_display_bitmap(ulong bmp_image, int x, int y);
	260
	261	/**
	262	* Get the width of the screen in pixels
	263	*
	264	* @return width of screen in pixels
	265	*/
	266	int video_get_pixel_width(void);
	267
	268	/**
	269	* Get the height of the screen in pixels
	270	*
	271	* @return height of screen in pixels
	272	*/
	273	int video_get_pixel_height(void);
	274
	275	/**
	276	* Get the number of text lines/rows on the screen
	277	*
	278	* @return number of rows
	279	*/
	280	int video_get_screen_rows(void);
	281
	282	/**
	283	* Get the number of text columns on the screen
	284	*
	285	* @return number of columns
	286	*/
	287	int video_get_screen_columns(void);
	288
	289	/**
	290	* Set the position of the text cursor
	291	*
	292	* @param col Column to place cursor (0 = left side)
	293	* @param row Row to place cursor (0 = top line)
	294	*/
	295	void video_position_cursor(unsigned col, unsigned row);
	296
	297	/* Clear the display */
	298	void video_clear(void);
	299
b26354cf HS	300	#if defined(CONFIG_FORMIKE)
	301	int kwh043st20_f01_spi_startup(unsigned int bus, unsigned int cs,
	302	unsigned int max_hz, unsigned int spi_mode);
	303	#endif
fc1a79d9 HS	304	#if defined(CONFIG_LG4573)
	305	int lg4573_spi_startup(unsigned int bus, unsigned int cs,
	306	unsigned int max_hz, unsigned int spi_mode);
	307	#endif
1acafc73	308
0a6eac84 SG	309	/*
	310	* video_get_info_str() - obtain a board string: type, speed, etc.
	311	*
	312	* This is called if CONFIG_CONSOLE_EXTRA_INFO is enabled.
	313	*
	314	* line_number: location to place info string beside logo
	315	* info: buffer for info string (empty if nothing to display on this
	316	* line)
	317	*/
	318	void video_get_info_str(int line_number, char *info);
	319
8c466ed3	320	#endif /* !CONFIG_DM_VIDEO */
1acafc73	321
167c5898	322	#endif