1 /*
2  * Copyright 2013 Ilia Mirkin
3  *
4  * Permission is hereby granted, free of charge, to any person obtaining a
5  * copy of this software and associated documentation files (the "Software"),
6  * to deal in the Software without restriction, including without limitation
7  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8  * and/or sell copies of the Software, and to permit persons to whom the
9  * Software is furnished to do so, subject to the following conditions:
10  *
11  * The above copyright notice and this permission notice shall be included in
12  * all copies or substantial portions of the Software.
13  *
14  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
17  * THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
18  * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF
19  * OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
20  * SOFTWARE.
21  *
22  * Implementation based on the pre-KMS implementation in xf86-video-nouveau,
23  * written by Arthur Huillet.
24  */
25 
26 #include <drm/drmP.h>
27 #include <drm/drm_crtc.h>
28 #include <drm/drm_fourcc.h>
29 
30 #include "nouveau_drv.h"
31 
32 #include "nouveau_bo.h"
33 #include "nouveau_connector.h"
34 #include "nouveau_display.h"
35 #include "nvreg.h"
36 #include "disp.h"
37 
38 struct nouveau_plane {
39 	struct drm_plane base;
40 	bool flip;
41 	struct nouveau_bo *cur;
42 
43 	struct {
44 		struct drm_property *colorkey;
45 		struct drm_property *contrast;
46 		struct drm_property *brightness;
47 		struct drm_property *hue;
48 		struct drm_property *saturation;
49 	} props;
50 
51 	int colorkey;
52 	int contrast;
53 	int brightness;
54 	int hue;
55 	int saturation;
56 	enum drm_color_encoding color_encoding;
57 
58 	void (*set_params)(struct nouveau_plane *);
59 };
60 
61 static uint32_t formats[] = {
62 	DRM_FORMAT_YUYV,
63 	DRM_FORMAT_UYVY,
64 	DRM_FORMAT_NV12,
65 	DRM_FORMAT_NV21,
66 };
67 
68 /* Sine can be approximated with
69  * http://en.wikipedia.org/wiki/Bhaskara_I's_sine_approximation_formula
70  * sin(x degrees) ~= 4 x (180 - x) / (40500 - x (180 - x) )
71  * Note that this only works for the range [0, 180].
72  * Also note that sin(x) == -sin(x - 180)
73  */
74 static inline int
75 sin_mul(int degrees, int factor)
76 {
77 	if (degrees > 180) {
78 		degrees -= 180;
79 		factor *= -1;
80 	}
81 	return factor * 4 * degrees * (180 - degrees) /
82 		(40500 - degrees * (180 - degrees));
83 }
84 
85 /* cos(x) = sin(x + 90) */
86 static inline int
87 cos_mul(int degrees, int factor)
88 {
89 	return sin_mul((degrees + 90) % 360, factor);
90 }
91 
92 static int
93 verify_scaling(const struct drm_framebuffer *fb, uint8_t shift,
94                uint32_t src_x, uint32_t src_y, uint32_t src_w, uint32_t src_h,
95                uint32_t crtc_w, uint32_t crtc_h)
96 {
97 	if (crtc_w < (src_w >> shift) || crtc_h < (src_h >> shift)) {
98 		DRM_DEBUG_KMS("Unsuitable framebuffer scaling: %dx%d -> %dx%d\n",
99 			      src_w, src_h, crtc_w, crtc_h);
100 		return -ERANGE;
101 	}
102 
103 	if (src_x != 0 || src_y != 0) {
104 		DRM_DEBUG_KMS("Unsuitable framebuffer offset: %d,%d\n",
105                               src_x, src_y);
106 		return -ERANGE;
107 	}
108 
109 	return 0;
110 }
111 
112 static int
113 nv10_update_plane(struct drm_plane *plane, struct drm_crtc *crtc,
114 		  struct drm_framebuffer *fb, int crtc_x, int crtc_y,
115 		  unsigned int crtc_w, unsigned int crtc_h,
116 		  uint32_t src_x, uint32_t src_y,
117 		  uint32_t src_w, uint32_t src_h,
118 		  struct drm_modeset_acquire_ctx *ctx)
119 {
120 	struct nouveau_drm *drm = nouveau_drm(plane->dev);
121 	struct nvif_object *dev = &drm->client.device.object;
122 	struct nouveau_plane *nv_plane =
123 		container_of(plane, struct nouveau_plane, base);
124 	struct nouveau_framebuffer *nv_fb = nouveau_framebuffer(fb);
125 	struct nouveau_crtc *nv_crtc = nouveau_crtc(crtc);
126 	struct nouveau_bo *cur = nv_plane->cur;
127 	bool flip = nv_plane->flip;
128 	int soff = NV_PCRTC0_SIZE * nv_crtc->index;
129 	int soff2 = NV_PCRTC0_SIZE * !nv_crtc->index;
130 	unsigned shift = drm->client.device.info.chipset >= 0x30 ? 1 : 3;
131 	unsigned format = 0;
132 	int ret;
133 
134 	/* Source parameters given in 16.16 fixed point, ignore fractional. */
135 	src_x >>= 16;
136 	src_y >>= 16;
137 	src_w >>= 16;
138 	src_h >>= 16;
139 
140 	ret = verify_scaling(fb, shift, 0, 0, src_w, src_h, crtc_w, crtc_h);
141 	if (ret)
142 		return ret;
143 
144 	ret = nouveau_bo_pin(nv_fb->nvbo, TTM_PL_FLAG_VRAM, false);
145 	if (ret)
146 		return ret;
147 
148 	nv_plane->cur = nv_fb->nvbo;
149 
150 	nvif_mask(dev, NV_PCRTC_ENGINE_CTRL + soff, NV_CRTC_FSEL_OVERLAY, NV_CRTC_FSEL_OVERLAY);
151 	nvif_mask(dev, NV_PCRTC_ENGINE_CTRL + soff2, NV_CRTC_FSEL_OVERLAY, 0);
152 
153 	nvif_wr32(dev, NV_PVIDEO_BASE(flip), 0);
154 	nvif_wr32(dev, NV_PVIDEO_OFFSET_BUFF(flip), nv_fb->nvbo->bo.offset);
155 	nvif_wr32(dev, NV_PVIDEO_SIZE_IN(flip), src_h << 16 | src_w);
156 	nvif_wr32(dev, NV_PVIDEO_POINT_IN(flip), src_y << 16 | src_x);
157 	nvif_wr32(dev, NV_PVIDEO_DS_DX(flip), (src_w << 20) / crtc_w);
158 	nvif_wr32(dev, NV_PVIDEO_DT_DY(flip), (src_h << 20) / crtc_h);
159 	nvif_wr32(dev, NV_PVIDEO_POINT_OUT(flip), crtc_y << 16 | crtc_x);
160 	nvif_wr32(dev, NV_PVIDEO_SIZE_OUT(flip), crtc_h << 16 | crtc_w);
161 
162 	if (fb->format->format == DRM_FORMAT_YUYV ||
163 	    fb->format->format == DRM_FORMAT_NV12)
164 		format |= NV_PVIDEO_FORMAT_COLOR_LE_CR8YB8CB8YA8;
165 	if (fb->format->format == DRM_FORMAT_NV12 ||
166 	    fb->format->format == DRM_FORMAT_NV21)
167 		format |= NV_PVIDEO_FORMAT_PLANAR;
168 	if (nv_plane->color_encoding == DRM_COLOR_YCBCR_BT709)
169 		format |= NV_PVIDEO_FORMAT_MATRIX_ITURBT709;
170 	if (nv_plane->colorkey & (1 << 24))
171 		format |= NV_PVIDEO_FORMAT_DISPLAY_COLOR_KEY;
172 
173 	if (format & NV_PVIDEO_FORMAT_PLANAR) {
174 		nvif_wr32(dev, NV_PVIDEO_UVPLANE_BASE(flip), 0);
175 		nvif_wr32(dev, NV_PVIDEO_UVPLANE_OFFSET_BUFF(flip),
176 			nv_fb->nvbo->bo.offset + fb->offsets[1]);
177 	}
178 	nvif_wr32(dev, NV_PVIDEO_FORMAT(flip), format | fb->pitches[0]);
179 	nvif_wr32(dev, NV_PVIDEO_STOP, 0);
180 	/* TODO: wait for vblank? */
181 	nvif_wr32(dev, NV_PVIDEO_BUFFER, flip ? 0x10 : 0x1);
182 	nv_plane->flip = !flip;
183 
184 	if (cur)
185 		nouveau_bo_unpin(cur);
186 
187 	return 0;
188 }
189 
190 static int
191 nv10_disable_plane(struct drm_plane *plane,
192 		   struct drm_modeset_acquire_ctx *ctx)
193 {
194 	struct nvif_object *dev = &nouveau_drm(plane->dev)->client.device.object;
195 	struct nouveau_plane *nv_plane =
196 		container_of(plane, struct nouveau_plane, base);
197 
198 	nvif_wr32(dev, NV_PVIDEO_STOP, 1);
199 	if (nv_plane->cur) {
200 		nouveau_bo_unpin(nv_plane->cur);
201 		nv_plane->cur = NULL;
202 	}
203 
204 	return 0;
205 }
206 
207 static void
208 nv_destroy_plane(struct drm_plane *plane)
209 {
210 	drm_plane_force_disable(plane);
211 	drm_plane_cleanup(plane);
212 	kfree(plane);
213 }
214 
215 static void
216 nv10_set_params(struct nouveau_plane *plane)
217 {
218 	struct nvif_object *dev = &nouveau_drm(plane->base.dev)->client.device.object;
219 	u32 luma = (plane->brightness - 512) << 16 | plane->contrast;
220 	u32 chroma = ((sin_mul(plane->hue, plane->saturation) & 0xffff) << 16) |
221 		(cos_mul(plane->hue, plane->saturation) & 0xffff);
222 	u32 format = 0;
223 
224 	nvif_wr32(dev, NV_PVIDEO_LUMINANCE(0), luma);
225 	nvif_wr32(dev, NV_PVIDEO_LUMINANCE(1), luma);
226 	nvif_wr32(dev, NV_PVIDEO_CHROMINANCE(0), chroma);
227 	nvif_wr32(dev, NV_PVIDEO_CHROMINANCE(1), chroma);
228 	nvif_wr32(dev, NV_PVIDEO_COLOR_KEY, plane->colorkey & 0xffffff);
229 
230 	if (plane->cur) {
231 		if (plane->color_encoding == DRM_COLOR_YCBCR_BT709)
232 			format |= NV_PVIDEO_FORMAT_MATRIX_ITURBT709;
233 		if (plane->colorkey & (1 << 24))
234 			format |= NV_PVIDEO_FORMAT_DISPLAY_COLOR_KEY;
235 		nvif_mask(dev, NV_PVIDEO_FORMAT(plane->flip),
236 			NV_PVIDEO_FORMAT_MATRIX_ITURBT709 |
237 			NV_PVIDEO_FORMAT_DISPLAY_COLOR_KEY,
238 			format);
239 	}
240 }
241 
242 static int
243 nv_set_property(struct drm_plane *plane,
244 		struct drm_property *property,
245 		uint64_t value)
246 {
247 	struct nouveau_plane *nv_plane =
248 		container_of(plane, struct nouveau_plane, base);
249 
250 	if (property == nv_plane->props.colorkey)
251 		nv_plane->colorkey = value;
252 	else if (property == nv_plane->props.contrast)
253 		nv_plane->contrast = value;
254 	else if (property == nv_plane->props.brightness)
255 		nv_plane->brightness = value;
256 	else if (property == nv_plane->props.hue)
257 		nv_plane->hue = value;
258 	else if (property == nv_plane->props.saturation)
259 		nv_plane->saturation = value;
260 	else if (property == nv_plane->base.color_encoding_property)
261 		nv_plane->color_encoding = value;
262 	else
263 		return -EINVAL;
264 
265 	if (nv_plane->set_params)
266 		nv_plane->set_params(nv_plane);
267 	return 0;
268 }
269 
270 static const struct drm_plane_funcs nv10_plane_funcs = {
271 	.update_plane = nv10_update_plane,
272 	.disable_plane = nv10_disable_plane,
273 	.set_property = nv_set_property,
274 	.destroy = nv_destroy_plane,
275 };
276 
277 static void
278 nv10_overlay_init(struct drm_device *device)
279 {
280 	struct nouveau_drm *drm = nouveau_drm(device);
281 	struct nouveau_plane *plane = kzalloc(sizeof(struct nouveau_plane), GFP_KERNEL);
282 	unsigned int num_formats = ARRAY_SIZE(formats);
283 	int ret;
284 
285 	if (!plane)
286 		return;
287 
288 	switch (drm->client.device.info.chipset) {
289 	case 0x10:
290 	case 0x11:
291 	case 0x15:
292 	case 0x1a:
293 	case 0x20:
294 		num_formats = 2;
295 		break;
296 	}
297 
298 	ret = drm_plane_init(device, &plane->base, 3 /* both crtc's */,
299 			     &nv10_plane_funcs,
300 			     formats, num_formats, false);
301 	if (ret)
302 		goto err;
303 
304 	/* Set up the plane properties */
305 	plane->props.colorkey = drm_property_create_range(
306 			device, 0, "colorkey", 0, 0x01ffffff);
307 	plane->props.contrast = drm_property_create_range(
308 			device, 0, "contrast", 0, 8192 - 1);
309 	plane->props.brightness = drm_property_create_range(
310 			device, 0, "brightness", 0, 1024);
311 	plane->props.hue = drm_property_create_range(
312 			device, 0, "hue", 0, 359);
313 	plane->props.saturation = drm_property_create_range(
314 			device, 0, "saturation", 0, 8192 - 1);
315 	if (!plane->props.colorkey ||
316 	    !plane->props.contrast ||
317 	    !plane->props.brightness ||
318 	    !plane->props.hue ||
319 	    !plane->props.saturation)
320 		goto cleanup;
321 
322 	plane->colorkey = 0;
323 	drm_object_attach_property(&plane->base.base,
324 				   plane->props.colorkey, plane->colorkey);
325 
326 	plane->contrast = 0x1000;
327 	drm_object_attach_property(&plane->base.base,
328 				   plane->props.contrast, plane->contrast);
329 
330 	plane->brightness = 512;
331 	drm_object_attach_property(&plane->base.base,
332 				   plane->props.brightness, plane->brightness);
333 
334 	plane->hue = 0;
335 	drm_object_attach_property(&plane->base.base,
336 				   plane->props.hue, plane->hue);
337 
338 	plane->saturation = 0x1000;
339 	drm_object_attach_property(&plane->base.base,
340 				   plane->props.saturation, plane->saturation);
341 
342 	plane->color_encoding = DRM_COLOR_YCBCR_BT601;
343 	drm_plane_create_color_properties(&plane->base,
344 					  BIT(DRM_COLOR_YCBCR_BT601) |
345 					  BIT(DRM_COLOR_YCBCR_BT709),
346 					  BIT(DRM_COLOR_YCBCR_LIMITED_RANGE),
347 					  DRM_COLOR_YCBCR_BT601,
348 					  DRM_COLOR_YCBCR_LIMITED_RANGE);
349 
350 	plane->set_params = nv10_set_params;
351 	nv10_set_params(plane);
352 	drm_plane_force_disable(&plane->base);
353 	return;
354 cleanup:
355 	drm_plane_cleanup(&plane->base);
356 err:
357 	kfree(plane);
358 	NV_ERROR(drm, "Failed to create plane\n");
359 }
360 
361 static int
362 nv04_update_plane(struct drm_plane *plane, struct drm_crtc *crtc,
363 		  struct drm_framebuffer *fb, int crtc_x, int crtc_y,
364 		  unsigned int crtc_w, unsigned int crtc_h,
365 		  uint32_t src_x, uint32_t src_y,
366 		  uint32_t src_w, uint32_t src_h,
367 		  struct drm_modeset_acquire_ctx *ctx)
368 {
369 	struct nvif_object *dev = &nouveau_drm(plane->dev)->client.device.object;
370 	struct nouveau_plane *nv_plane =
371 		container_of(plane, struct nouveau_plane, base);
372 	struct nouveau_framebuffer *nv_fb = nouveau_framebuffer(fb);
373 	struct nouveau_bo *cur = nv_plane->cur;
374 	uint32_t overlay = 1;
375 	int brightness = (nv_plane->brightness - 512) * 62 / 512;
376 	int ret, i;
377 
378 	/* Source parameters given in 16.16 fixed point, ignore fractional. */
379 	src_x >>= 16;
380 	src_y >>= 16;
381 	src_w >>= 16;
382 	src_h >>= 16;
383 
384 	ret = verify_scaling(fb, 0, src_x, src_y, src_w, src_h, crtc_w, crtc_h);
385 	if (ret)
386 		return ret;
387 
388 	ret = nouveau_bo_pin(nv_fb->nvbo, TTM_PL_FLAG_VRAM, false);
389 	if (ret)
390 		return ret;
391 
392 	nv_plane->cur = nv_fb->nvbo;
393 
394 	nvif_wr32(dev, NV_PVIDEO_OE_STATE, 0);
395 	nvif_wr32(dev, NV_PVIDEO_SU_STATE, 0);
396 	nvif_wr32(dev, NV_PVIDEO_RM_STATE, 0);
397 
398 	for (i = 0; i < 2; i++) {
399 		nvif_wr32(dev, NV_PVIDEO_BUFF0_START_ADDRESS + 4 * i,
400 			  nv_fb->nvbo->bo.offset);
401 		nvif_wr32(dev, NV_PVIDEO_BUFF0_PITCH_LENGTH + 4 * i,
402 			  fb->pitches[0]);
403 		nvif_wr32(dev, NV_PVIDEO_BUFF0_OFFSET + 4 * i, 0);
404 	}
405 	nvif_wr32(dev, NV_PVIDEO_WINDOW_START, crtc_y << 16 | crtc_x);
406 	nvif_wr32(dev, NV_PVIDEO_WINDOW_SIZE, crtc_h << 16 | crtc_w);
407 	nvif_wr32(dev, NV_PVIDEO_STEP_SIZE,
408 		(uint32_t)(((src_h - 1) << 11) / (crtc_h - 1)) << 16 | (uint32_t)(((src_w - 1) << 11) / (crtc_w - 1)));
409 
410 	/* It should be possible to convert hue/contrast to this */
411 	nvif_wr32(dev, NV_PVIDEO_RED_CSC_OFFSET, 0x69 - brightness);
412 	nvif_wr32(dev, NV_PVIDEO_GREEN_CSC_OFFSET, 0x3e + brightness);
413 	nvif_wr32(dev, NV_PVIDEO_BLUE_CSC_OFFSET, 0x89 - brightness);
414 	nvif_wr32(dev, NV_PVIDEO_CSC_ADJUST, 0);
415 
416 	nvif_wr32(dev, NV_PVIDEO_CONTROL_Y, 0x001); /* (BLUR_ON, LINE_HALF) */
417 	nvif_wr32(dev, NV_PVIDEO_CONTROL_X, 0x111); /* (WEIGHT_HEAVY, SHARPENING_ON, SMOOTHING_ON) */
418 
419 	nvif_wr32(dev, NV_PVIDEO_FIFO_BURST_LENGTH, 0x03);
420 	nvif_wr32(dev, NV_PVIDEO_FIFO_THRES_SIZE, 0x38);
421 
422 	nvif_wr32(dev, NV_PVIDEO_KEY, nv_plane->colorkey);
423 
424 	if (nv_plane->colorkey & (1 << 24))
425 		overlay |= 0x10;
426 	if (fb->format->format == DRM_FORMAT_YUYV)
427 		overlay |= 0x100;
428 
429 	nvif_wr32(dev, NV_PVIDEO_OVERLAY, overlay);
430 
431 	nvif_wr32(dev, NV_PVIDEO_SU_STATE, nvif_rd32(dev, NV_PVIDEO_SU_STATE) ^ (1 << 16));
432 
433 	if (cur)
434 		nouveau_bo_unpin(cur);
435 
436 	return 0;
437 }
438 
439 static int
440 nv04_disable_plane(struct drm_plane *plane,
441 		   struct drm_modeset_acquire_ctx *ctx)
442 {
443 	struct nvif_object *dev = &nouveau_drm(plane->dev)->client.device.object;
444 	struct nouveau_plane *nv_plane =
445 		container_of(plane, struct nouveau_plane, base);
446 
447 	nvif_mask(dev, NV_PVIDEO_OVERLAY, 1, 0);
448 	nvif_wr32(dev, NV_PVIDEO_OE_STATE, 0);
449 	nvif_wr32(dev, NV_PVIDEO_SU_STATE, 0);
450 	nvif_wr32(dev, NV_PVIDEO_RM_STATE, 0);
451 	if (nv_plane->cur) {
452 		nouveau_bo_unpin(nv_plane->cur);
453 		nv_plane->cur = NULL;
454 	}
455 
456 	return 0;
457 }
458 
459 static const struct drm_plane_funcs nv04_plane_funcs = {
460 	.update_plane = nv04_update_plane,
461 	.disable_plane = nv04_disable_plane,
462 	.set_property = nv_set_property,
463 	.destroy = nv_destroy_plane,
464 };
465 
466 static void
467 nv04_overlay_init(struct drm_device *device)
468 {
469 	struct nouveau_drm *drm = nouveau_drm(device);
470 	struct nouveau_plane *plane = kzalloc(sizeof(struct nouveau_plane), GFP_KERNEL);
471 	int ret;
472 
473 	if (!plane)
474 		return;
475 
476 	ret = drm_plane_init(device, &plane->base, 1 /* single crtc */,
477 			     &nv04_plane_funcs,
478 			     formats, 2, false);
479 	if (ret)
480 		goto err;
481 
482 	/* Set up the plane properties */
483 	plane->props.colorkey = drm_property_create_range(
484 			device, 0, "colorkey", 0, 0x01ffffff);
485 	plane->props.brightness = drm_property_create_range(
486 			device, 0, "brightness", 0, 1024);
487 	if (!plane->props.colorkey ||
488 	    !plane->props.brightness)
489 		goto cleanup;
490 
491 	plane->colorkey = 0;
492 	drm_object_attach_property(&plane->base.base,
493 				   plane->props.colorkey, plane->colorkey);
494 
495 	plane->brightness = 512;
496 	drm_object_attach_property(&plane->base.base,
497 				   plane->props.brightness, plane->brightness);
498 
499 	drm_plane_force_disable(&plane->base);
500 	return;
501 cleanup:
502 	drm_plane_cleanup(&plane->base);
503 err:
504 	kfree(plane);
505 	NV_ERROR(drm, "Failed to create plane\n");
506 }
507 
508 void
509 nouveau_overlay_init(struct drm_device *device)
510 {
511 	struct nvif_device *dev = &nouveau_drm(device)->client.device;
512 	if (dev->info.chipset < 0x10)
513 		nv04_overlay_init(device);
514 	else if (dev->info.chipset <= 0x40)
515 		nv10_overlay_init(device);
516 }
517