[people/ms/u-boot.git] / include / video.h

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

#ifndef _VIDEO_H_
#define _VIDEO_H_

#ifdef CONFIG_DM_VIDEO

#include <stdio_dev.h>

struct video_uc_platdata {
	uint align;
	uint size;
	ulong base;
};

/*
 * 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
 * @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
 * @line_length:	Length of each frame buffer line, in bytes
 * @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
 */
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;
	int line_length;
	int colour_fg;
	int colour_bg;
	bool flush_dcache;
	ushort *cmap;
};

/* 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_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
 */
void video_sync(struct udevice *vid);

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

#endif /* CONFIG_DM_VIDEO */

#ifndef CONFIG_DM_VIDEO

/* Video functions */

struct stdio_dev;

int	video_init(void *videobase);
void	video_putc(struct stdio_dev *dev, const char c);
void	video_puts(struct stdio_dev *dev, const char *s);

/**
 * 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

#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 (arsenio@tin.it)
	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
	20	struct video_uc_platdata {
	21	uint align;
	22	uint size;
	23	ulong base;
	24	};
	25
	26	/*
	27	* Bits per pixel selector. Each value n is such that the bits-per-pixel is
	28	* 2 ^ n
	29	*/
	30	enum video_log2_bpp {
	31	VIDEO_BPP1 = 0,
	32	VIDEO_BPP2,
	33	VIDEO_BPP4,
	34	VIDEO_BPP8,
	35	VIDEO_BPP16,
	36	VIDEO_BPP32,
	37	};
	38
	39	/*
	40	* Convert enum video_log2_bpp to bytes and bits. Note we omit the outer
	41	* brackets to allow multiplication by fractional pixels.
	42	*/
	43	#define VNBYTES(bpix) (1 << (bpix)) / 8
	44
	45	#define VNBITS(bpix) (1 << (bpix))
	46
	47	/**
	48	* struct video_priv - Device information used by the video uclass
	49	*
	50	* @xsize: Number of pixel columns (e.g. 1366)
	51	* @ysize: Number of pixels rows (e.g.. 768)
8cdae1da	52	* @rot: Display rotation (0=none, 1=90 degrees clockwise, etc.)
1acafc73	53	* @bpix: Encoded bits per pixel
826f35f9 SG	54	* @vidconsole_drv_name: Driver to use for the text console, NULL to
	55	* select automatically
	56	* @font_size: Font size in pixels (0 to use a default value)
1acafc73 SG	57	* @fb: Frame buffer
	58	* @fb_size: Frame buffer size
	59	* @line_length: Length of each frame buffer line, in bytes
	60	* @colour_fg: Foreground colour (pixel value)
	61	* @colour_bg: Background colour (pixel value)
	62	* @flush_dcache: true to enable flushing of the data cache after
	63	* the LCD is updated
	64	* @cmap: Colour map for 8-bit-per-pixel displays
	65	*/
	66	struct video_priv {
	67	/* Things set up by the driver: */
	68	ushort xsize;
	69	ushort ysize;
	70	ushort rot;
	71	enum video_log2_bpp bpix;
826f35f9 SG	72	const char *vidconsole_drv_name;
826f35f9 SG	73	int font_size;
1acafc73 SG	74
	75	/*
	76	* Things that are private to the uclass: don't use these in the
	77	* driver
	78	*/
	79	void *fb;
	80	int fb_size;
	81	int line_length;
	82	int colour_fg;
	83	int colour_bg;
	84	bool flush_dcache;
	85	ushort *cmap;
	86	};
	87
	88	/* Placeholder - there are no video operations at present */
	89	struct video_ops {
	90	};
	91
	92	#define video_get_ops(dev) ((struct video_ops *)(dev)->driver->ops)
	93
	94	/**
	95	* video_reserve() - Reserve frame-buffer memory for video devices
	96	*
	97	* Note: This function is for internal use.
	98	*
	99	* This uses the uclass platdata's @size and @align members to figure out
	100	* a size and position for each frame buffer as part of the pre-relocation
	101	* process of determining the post-relocation memory layout.
	102	*
	103	* gd->video_top is set to the initial value of *@addrp and gd->video_bottom
	104	* is set to the final value.
	105	*
	106	* @addrp: On entry, the top of available memory. On exit, the new top,
	107	* after allocating the required memory.
	108	* @return 0
	109	*/
	110	int video_reserve(ulong *addrp);
	111
	112	/**
	113	* video_sync() - Sync a device's frame buffer with its hardware
	114	*
	115	* Some frame buffers are cached or have a secondary frame buffer. This
	116	* function syncs these up so that the current contents of the U-Boot frame
	117	* buffer are displayed to the user.
	118	*
	119	* @dev: Device to sync
	120	*/
	121	void video_sync(struct udevice *vid);
	122
	123	/**
	124	* video_sync_all() - Sync all devices' frame buffers with there hardware
	125	*
	126	* This calls video_sync() on all active video devices.
	127	*/
	128	void video_sync_all(void);
	129
	130	/**
	131	* video_bmp_display() - Display a BMP file
	132	*
	133	* @dev: Device to display the bitmap on
	134	* @bmp_image: Address of bitmap image to display
	135	* @x: X position in pixels from the left
	136	* @y: Y position in pixels from the top
	137	* @align: true to adjust the coordinates to centre the image. If false
138	* the coordinates are used as is. If true:
139	*
140	* - if a coordinate is 0x7fff then the image will be centred in
141	* that direction
142	* - if a coordinate is -ve then it will be offset to the
143	* left/top of the centre by that many pixels
144	* - if a coordinate is positive it will be used unchnaged.
145	* @return 0 if OK, -ve on error
146	*/
147	int video_bmp_display(struct udevice *dev, ulong bmp_image, int x, int y,
148	bool align);
149
150	/**
151	* video_get_xsize() - Get the width of the display in pixels
152	*
153	* @dev: Device to check
154	* @return device frame buffer width in pixels
155	*/
156	int video_get_xsize(struct udevice *dev);
157
158	/**
159	* video_get_ysize() - Get the height of the display in pixels
160	*
161	* @dev: Device to check
162	* @return device frame buffer height in pixels
163	*/
164	int video_get_ysize(struct udevice *dev);
165
68dcdc99 SG	166	/**
	167	* Set whether we need to flush the dcache when changing the image. This
	168	* defaults to off.
	169	*
	170	* @param flush non-zero to flush cache after update, 0 to skip
	171	*/
	172	void video_set_flush_dcache(struct udevice *dev, bool flush);
	173
1acafc73 SG	174	#endif /* CONFIG_DM_VIDEO */
	175
	176	#ifndef CONFIG_DM_VIDEO
	177
167c5898 WD	178	/* Video functions */
167c5898 WD	179
709ea543 SG	180	struct stdio_dev;
	181
	182	int video_init(void *videobase);
	183	void video_putc(struct stdio_dev *dev, const char c);
	184	void video_puts(struct stdio_dev dev, const char s);
167c5898	185
f674f7cf SR	186	/**
	187	* Display a BMP format bitmap on the screen
	188	*
	189	* @param bmp_image Address of BMP image
	190	* @param x X position to draw image
	191	* @param y Y position to draw image
	192	*/
	193	int video_display_bitmap(ulong bmp_image, int x, int y);
	194
	195	/**
	196	* Get the width of the screen in pixels
	197	*
	198	* @return width of screen in pixels
	199	*/
	200	int video_get_pixel_width(void);
	201
	202	/**
	203	* Get the height of the screen in pixels
	204	*
	205	* @return height of screen in pixels
	206	*/
	207	int video_get_pixel_height(void);
	208
	209	/**
	210	* Get the number of text lines/rows on the screen
	211	*
	212	* @return number of rows
	213	*/
	214	int video_get_screen_rows(void);
	215
	216	/**
	217	* Get the number of text columns on the screen
	218	*
	219	* @return number of columns
	220	*/
	221	int video_get_screen_columns(void);
	222
	223	/**
	224	* Set the position of the text cursor
	225	*
	226	* @param col Column to place cursor (0 = left side)
	227	* @param row Row to place cursor (0 = top line)
	228	*/
	229	void video_position_cursor(unsigned col, unsigned row);
	230
	231	/* Clear the display */
	232	void video_clear(void);
	233
b26354cf HS	234	#if defined(CONFIG_FORMIKE)
	235	int kwh043st20_f01_spi_startup(unsigned int bus, unsigned int cs,
	236	unsigned int max_hz, unsigned int spi_mode);
	237	#endif
fc1a79d9 HS	238	#if defined(CONFIG_LG4573)
	239	int lg4573_spi_startup(unsigned int bus, unsigned int cs,
	240	unsigned int max_hz, unsigned int spi_mode);
	241	#endif
1acafc73 SG	242
	243	#endif /* CONFIG_DM_VIDEO */
	244
167c5898	245	#endif