1/*	$NetBSD: fb_decoder.h,v 1.2 2021/12/18 23:45:31 riastradh Exp $	*/
2
3/*
4 * Copyright(c) 2011-2016 Intel Corporation. All rights reserved.
5 *
6 * Permission is hereby granted, free of charge, to any person obtaining a
7 * copy of this software and associated documentation files (the "Software"),
8 * to deal in the Software without restriction, including without limitation
9 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
10 * and/or sell copies of the Software, and to permit persons to whom the
11 * Software is furnished to do so, subject to the following conditions:
12 *
13 * The above copyright notice and this permission notice (including the next
14 * paragraph) shall be included in all copies or substantial portions of the
15 * Software.
16 *
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
20 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23 * SOFTWARE.
24 *
25 * Authors:
26 *    Kevin Tian <kevin.tian@intel.com>
27 *
28 * Contributors:
29 *    Bing Niu <bing.niu@intel.com>
30 *    Xu Han <xu.han@intel.com>
31 *    Ping Gao <ping.a.gao@intel.com>
32 *    Xiaoguang Chen <xiaoguang.chen@intel.com>
33 *    Yang Liu <yang2.liu@intel.com>
34 *    Tina Zhang <tina.zhang@intel.com>
35 *
36 */
37
38#ifndef _GVT_FB_DECODER_H_
39#define _GVT_FB_DECODER_H_
40
41#include <linux/types.h>
42
43#define _PLANE_CTL_FORMAT_SHIFT		24
44#define _PLANE_CTL_TILED_SHIFT		10
45#define _PIPE_V_SRCSZ_SHIFT		0
46#define _PIPE_V_SRCSZ_MASK		(0xfff << _PIPE_V_SRCSZ_SHIFT)
47#define _PIPE_H_SRCSZ_SHIFT		16
48#define _PIPE_H_SRCSZ_MASK		(0x1fff << _PIPE_H_SRCSZ_SHIFT)
49
50#define _PRI_PLANE_FMT_SHIFT		26
51#define _PRI_PLANE_STRIDE_MASK		(0x3ff << 6)
52#define _PRI_PLANE_X_OFF_SHIFT		0
53#define _PRI_PLANE_X_OFF_MASK		(0x1fff << _PRI_PLANE_X_OFF_SHIFT)
54#define _PRI_PLANE_Y_OFF_SHIFT		16
55#define _PRI_PLANE_Y_OFF_MASK		(0xfff << _PRI_PLANE_Y_OFF_SHIFT)
56
57#define _CURSOR_MODE			0x3f
58#define _CURSOR_ALPHA_FORCE_SHIFT	8
59#define _CURSOR_ALPHA_FORCE_MASK	(0x3 << _CURSOR_ALPHA_FORCE_SHIFT)
60#define _CURSOR_ALPHA_PLANE_SHIFT	10
61#define _CURSOR_ALPHA_PLANE_MASK	(0x3 << _CURSOR_ALPHA_PLANE_SHIFT)
62#define _CURSOR_POS_X_SHIFT		0
63#define _CURSOR_POS_X_MASK		(0x1fff << _CURSOR_POS_X_SHIFT)
64#define _CURSOR_SIGN_X_SHIFT		15
65#define _CURSOR_SIGN_X_MASK		(1 << _CURSOR_SIGN_X_SHIFT)
66#define _CURSOR_POS_Y_SHIFT		16
67#define _CURSOR_POS_Y_MASK		(0xfff << _CURSOR_POS_Y_SHIFT)
68#define _CURSOR_SIGN_Y_SHIFT		31
69#define _CURSOR_SIGN_Y_MASK		(1 << _CURSOR_SIGN_Y_SHIFT)
70
71#define _SPRITE_FMT_SHIFT		25
72#define _SPRITE_COLOR_ORDER_SHIFT	20
73#define _SPRITE_YUV_ORDER_SHIFT		16
74#define _SPRITE_STRIDE_SHIFT		6
75#define _SPRITE_STRIDE_MASK		(0x1ff << _SPRITE_STRIDE_SHIFT)
76#define _SPRITE_SIZE_WIDTH_SHIFT	0
77#define _SPRITE_SIZE_HEIGHT_SHIFT	16
78#define _SPRITE_SIZE_WIDTH_MASK		(0x1fff << _SPRITE_SIZE_WIDTH_SHIFT)
79#define _SPRITE_SIZE_HEIGHT_MASK	(0xfff << _SPRITE_SIZE_HEIGHT_SHIFT)
80#define _SPRITE_POS_X_SHIFT		0
81#define _SPRITE_POS_Y_SHIFT		16
82#define _SPRITE_POS_X_MASK		(0x1fff << _SPRITE_POS_X_SHIFT)
83#define _SPRITE_POS_Y_MASK		(0xfff << _SPRITE_POS_Y_SHIFT)
84#define _SPRITE_OFFSET_START_X_SHIFT	0
85#define _SPRITE_OFFSET_START_Y_SHIFT	16
86#define _SPRITE_OFFSET_START_X_MASK	(0x1fff << _SPRITE_OFFSET_START_X_SHIFT)
87#define _SPRITE_OFFSET_START_Y_MASK	(0xfff << _SPRITE_OFFSET_START_Y_SHIFT)
88
89enum GVT_FB_EVENT {
90	FB_MODE_SET_START = 1,
91	FB_MODE_SET_END,
92	FB_DISPLAY_FLIP,
93};
94
95enum DDI_PORT {
96	DDI_PORT_NONE	= 0,
97	DDI_PORT_B	= 1,
98	DDI_PORT_C	= 2,
99	DDI_PORT_D	= 3,
100	DDI_PORT_E	= 4
101};
102
103struct intel_gvt;
104
105/* color space conversion and gamma correction are not included */
106struct intel_vgpu_primary_plane_format {
107	u8	enabled;	/* plane is enabled */
108	u32	tiled;		/* tiling mode: linear, X-tiled, Y tiled, etc */
109	u8	bpp;		/* bits per pixel */
110	u32	hw_format;	/* format field in the PRI_CTL register */
111	u32	drm_format;	/* format in DRM definition */
112	u32	base;		/* framebuffer base in graphics memory */
113	u64     base_gpa;
114	u32	x_offset;	/* in pixels */
115	u32	y_offset;	/* in lines */
116	u32	width;		/* in pixels */
117	u32	height;		/* in lines */
118	u32	stride;		/* in bytes */
119};
120
121struct intel_vgpu_sprite_plane_format {
122	u8	enabled;	/* plane is enabled */
123	u8	tiled;		/* X-tiled */
124	u8	bpp;		/* bits per pixel */
125	u32	hw_format;	/* format field in the SPR_CTL register */
126	u32	drm_format;	/* format in DRM definition */
127	u32	base;		/* sprite base in graphics memory */
128	u64     base_gpa;
129	u32	x_pos;		/* in pixels */
130	u32	y_pos;		/* in lines */
131	u32	x_offset;	/* in pixels */
132	u32	y_offset;	/* in lines */
133	u32	width;		/* in pixels */
134	u32	height;		/* in lines */
135	u32	stride;		/* in bytes */
136};
137
138struct intel_vgpu_cursor_plane_format {
139	u8	enabled;
140	u8	mode;		/* cursor mode select */
141	u8	bpp;		/* bits per pixel */
142	u32	drm_format;	/* format in DRM definition */
143	u32	base;		/* cursor base in graphics memory */
144	u64     base_gpa;
145	u32	x_pos;		/* in pixels */
146	u32	y_pos;		/* in lines */
147	u8	x_sign;		/* X Position Sign */
148	u8	y_sign;		/* Y Position Sign */
149	u32	width;		/* in pixels */
150	u32	height;		/* in lines */
151	u32	x_hot;		/* in pixels */
152	u32	y_hot;		/* in pixels */
153};
154
155struct intel_vgpu_pipe_format {
156	struct intel_vgpu_primary_plane_format	primary;
157	struct intel_vgpu_sprite_plane_format	sprite;
158	struct intel_vgpu_cursor_plane_format	cursor;
159	enum DDI_PORT ddi_port;  /* the DDI port that pipe is connected to */
160};
161
162struct intel_vgpu_fb_format {
163	struct intel_vgpu_pipe_format	pipes[I915_MAX_PIPES];
164};
165
166int intel_vgpu_decode_primary_plane(struct intel_vgpu *vgpu,
167	struct intel_vgpu_primary_plane_format *plane);
168int intel_vgpu_decode_cursor_plane(struct intel_vgpu *vgpu,
169	struct intel_vgpu_cursor_plane_format *plane);
170int intel_vgpu_decode_sprite_plane(struct intel_vgpu *vgpu,
171	struct intel_vgpu_sprite_plane_format *plane);
172
173#endif
174