1 /*
2  * Copyright (C) 2009 Red Hat <mjg@redhat.com>
3  *
4  * Permission is hereby granted, free of charge, to any person obtaining
5  * a copy of this software and associated documentation files (the
6  * "Software"), to deal in the Software without restriction, including
7  * without limitation the rights to use, copy, modify, merge, publish,
8  * distribute, sublicense, and/or sell copies of the Software, and to
9  * permit persons to whom the Software is furnished to do so, subject to
10  * the following conditions:
11  *
12  * The above copyright notice and this permission notice (including the
13  * next paragraph) shall be included in all copies or substantial
14  * portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
19  * IN NO EVENT SHALL THE COPYRIGHT OWNER(S) AND/OR ITS SUPPLIERS BE
20  * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
21  * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
22  * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
23  *
24  */
25 
26 /*
27  * Authors:
28  *  Matthew Garrett <mjg@redhat.com>
29  *
30  * Register locations derived from NVClock by Roderick Colenbrander
31  */
32 
33 #include <linux/apple-gmux.h>
34 #include <linux/backlight.h>
35 #include <linux/idr.h>
36 
37 #include "nouveau_drv.h"
38 #include "nouveau_reg.h"
39 #include "nouveau_encoder.h"
40 #include "nouveau_connector.h"
41 #include "nouveau_acpi.h"
42 
43 static struct ida bl_ida;
44 #define BL_NAME_SIZE 15 // 12 for name + 2 for digits + 1 for '\0'
45 
46 static bool
47 nouveau_get_backlight_name(char backlight_name[BL_NAME_SIZE],
48 			   struct nouveau_backlight *bl)
49 {
50 	const int nb = ida_alloc_max(&bl_ida, 99, GFP_KERNEL);
51 
52 	if (nb < 0)
53 		return false;
54 	if (nb > 0)
55 		snprintf(backlight_name, BL_NAME_SIZE, "nv_backlight%d", nb);
56 	else
57 		snprintf(backlight_name, BL_NAME_SIZE, "nv_backlight");
58 	bl->id = nb;
59 	return true;
60 }
61 
62 static int
63 nv40_get_intensity(struct backlight_device *bd)
64 {
65 	struct nouveau_encoder *nv_encoder = bl_get_data(bd);
66 	struct nouveau_drm *drm = nouveau_drm(nv_encoder->base.base.dev);
67 	struct nvif_object *device = &drm->client.device.object;
68 	int val = (nvif_rd32(device, NV40_PMC_BACKLIGHT) &
69 		   NV40_PMC_BACKLIGHT_MASK) >> 16;
70 
71 	return val;
72 }
73 
74 static int
75 nv40_set_intensity(struct backlight_device *bd)
76 {
77 	struct nouveau_encoder *nv_encoder = bl_get_data(bd);
78 	struct nouveau_drm *drm = nouveau_drm(nv_encoder->base.base.dev);
79 	struct nvif_object *device = &drm->client.device.object;
80 	int val = bd->props.brightness;
81 	int reg = nvif_rd32(device, NV40_PMC_BACKLIGHT);
82 
83 	nvif_wr32(device, NV40_PMC_BACKLIGHT,
84 		  (val << 16) | (reg & ~NV40_PMC_BACKLIGHT_MASK));
85 
86 	return 0;
87 }
88 
89 static const struct backlight_ops nv40_bl_ops = {
90 	.options = BL_CORE_SUSPENDRESUME,
91 	.get_brightness = nv40_get_intensity,
92 	.update_status = nv40_set_intensity,
93 };
94 
95 static int
96 nv40_backlight_init(struct nouveau_encoder *encoder,
97 		    struct backlight_properties *props,
98 		    const struct backlight_ops **ops)
99 {
100 	struct nouveau_drm *drm = nouveau_drm(encoder->base.base.dev);
101 	struct nvif_object *device = &drm->client.device.object;
102 
103 	if (!(nvif_rd32(device, NV40_PMC_BACKLIGHT) & NV40_PMC_BACKLIGHT_MASK))
104 		return -ENODEV;
105 
106 	props->max_brightness = 31;
107 	*ops = &nv40_bl_ops;
108 	return 0;
109 }
110 
111 static int
112 nv50_get_intensity(struct backlight_device *bd)
113 {
114 	struct nouveau_encoder *nv_encoder = bl_get_data(bd);
115 	struct nouveau_drm *drm = nouveau_drm(nv_encoder->base.base.dev);
116 	struct nvif_object *device = &drm->client.device.object;
117 	int or = ffs(nv_encoder->dcb->or) - 1;
118 	u32 div = 1025;
119 	u32 val;
120 
121 	val  = nvif_rd32(device, NV50_PDISP_SOR_PWM_CTL(or));
122 	val &= NV50_PDISP_SOR_PWM_CTL_VAL;
123 	return ((val * 100) + (div / 2)) / div;
124 }
125 
126 static int
127 nv50_set_intensity(struct backlight_device *bd)
128 {
129 	struct nouveau_encoder *nv_encoder = bl_get_data(bd);
130 	struct nouveau_drm *drm = nouveau_drm(nv_encoder->base.base.dev);
131 	struct nvif_object *device = &drm->client.device.object;
132 	int or = ffs(nv_encoder->dcb->or) - 1;
133 	u32 div = 1025;
134 	u32 val = (bd->props.brightness * div) / 100;
135 
136 	nvif_wr32(device, NV50_PDISP_SOR_PWM_CTL(or),
137 		  NV50_PDISP_SOR_PWM_CTL_NEW | val);
138 	return 0;
139 }
140 
141 static const struct backlight_ops nv50_bl_ops = {
142 	.options = BL_CORE_SUSPENDRESUME,
143 	.get_brightness = nv50_get_intensity,
144 	.update_status = nv50_set_intensity,
145 };
146 
147 /*
148  * eDP brightness callbacks need to happen under lock, since we need to
149  * enable/disable the backlight ourselves for modesets
150  */
151 static int
152 nv50_edp_get_brightness(struct backlight_device *bd)
153 {
154 	struct drm_connector *connector = dev_get_drvdata(bd->dev.parent);
155 	struct drm_device *dev = connector->dev;
156 	struct drm_crtc *crtc;
157 	struct drm_modeset_acquire_ctx ctx;
158 	int ret = 0;
159 
160 	drm_modeset_acquire_init(&ctx, 0);
161 
162 retry:
163 	ret = drm_modeset_lock(&dev->mode_config.connection_mutex, &ctx);
164 	if (ret == -EDEADLK)
165 		goto deadlock;
166 	else if (ret < 0)
167 		goto out;
168 
169 	crtc = connector->state->crtc;
170 	if (!crtc)
171 		goto out;
172 
173 	ret = drm_modeset_lock(&crtc->mutex, &ctx);
174 	if (ret == -EDEADLK)
175 		goto deadlock;
176 	else if (ret < 0)
177 		goto out;
178 
179 	if (!crtc->state->active)
180 		goto out;
181 
182 	ret = bd->props.brightness;
183 out:
184 	drm_modeset_drop_locks(&ctx);
185 	drm_modeset_acquire_fini(&ctx);
186 	return ret;
187 deadlock:
188 	drm_modeset_backoff(&ctx);
189 	goto retry;
190 }
191 
192 static int
193 nv50_edp_set_brightness(struct backlight_device *bd)
194 {
195 	struct drm_connector *connector = dev_get_drvdata(bd->dev.parent);
196 	struct nouveau_connector *nv_connector = nouveau_connector(connector);
197 	struct drm_device *dev = connector->dev;
198 	struct drm_crtc *crtc;
199 	struct drm_dp_aux *aux = &nv_connector->aux;
200 	struct nouveau_backlight *nv_bl = nv_connector->backlight;
201 	struct drm_modeset_acquire_ctx ctx;
202 	int ret = 0;
203 
204 	drm_modeset_acquire_init(&ctx, 0);
205 retry:
206 	ret = drm_modeset_lock(&dev->mode_config.connection_mutex, &ctx);
207 	if (ret == -EDEADLK)
208 		goto deadlock;
209 	else if (ret < 0)
210 		goto out;
211 
212 	crtc = connector->state->crtc;
213 	if (!crtc)
214 		goto out;
215 
216 	ret = drm_modeset_lock(&crtc->mutex, &ctx);
217 	if (ret == -EDEADLK)
218 		goto deadlock;
219 	else if (ret < 0)
220 		goto out;
221 
222 	if (crtc->state->active)
223 		ret = drm_edp_backlight_set_level(aux, &nv_bl->edp_info, bd->props.brightness);
224 
225 out:
226 	drm_modeset_drop_locks(&ctx);
227 	drm_modeset_acquire_fini(&ctx);
228 	return ret;
229 deadlock:
230 	drm_modeset_backoff(&ctx);
231 	goto retry;
232 }
233 
234 static const struct backlight_ops nv50_edp_bl_ops = {
235 	.get_brightness = nv50_edp_get_brightness,
236 	.update_status = nv50_edp_set_brightness,
237 };
238 
239 static int
240 nva3_get_intensity(struct backlight_device *bd)
241 {
242 	struct nouveau_encoder *nv_encoder = bl_get_data(bd);
243 	struct nouveau_drm *drm = nouveau_drm(nv_encoder->base.base.dev);
244 	struct nvif_object *device = &drm->client.device.object;
245 	int or = ffs(nv_encoder->dcb->or) - 1;
246 	u32 div, val;
247 
248 	div  = nvif_rd32(device, NV50_PDISP_SOR_PWM_DIV(or));
249 	val  = nvif_rd32(device, NV50_PDISP_SOR_PWM_CTL(or));
250 	val &= NVA3_PDISP_SOR_PWM_CTL_VAL;
251 	if (div && div >= val)
252 		return ((val * 100) + (div / 2)) / div;
253 
254 	return 100;
255 }
256 
257 static int
258 nva3_set_intensity(struct backlight_device *bd)
259 {
260 	struct nouveau_encoder *nv_encoder = bl_get_data(bd);
261 	struct nouveau_drm *drm = nouveau_drm(nv_encoder->base.base.dev);
262 	struct nvif_object *device = &drm->client.device.object;
263 	int or = ffs(nv_encoder->dcb->or) - 1;
264 	u32 div, val;
265 
266 	div = nvif_rd32(device, NV50_PDISP_SOR_PWM_DIV(or));
267 
268 	val = backlight_get_brightness(bd);
269 	if (val)
270 		val = (val * div) / 100;
271 
272 	if (div) {
273 		nvif_wr32(device, NV50_PDISP_SOR_PWM_CTL(or),
274 			  val |
275 			  NV50_PDISP_SOR_PWM_CTL_NEW |
276 			  NVA3_PDISP_SOR_PWM_CTL_UNK);
277 		return 0;
278 	}
279 
280 	return -EINVAL;
281 }
282 
283 static const struct backlight_ops nva3_bl_ops = {
284 	.options = BL_CORE_SUSPENDRESUME,
285 	.get_brightness = nva3_get_intensity,
286 	.update_status = nva3_set_intensity,
287 };
288 
289 /* FIXME: perform backlight probing for eDP _before_ this, this only gets called after connector
290  * registration which happens after the initial modeset
291  */
292 static int
293 nv50_backlight_init(struct nouveau_backlight *bl,
294 		    struct nouveau_connector *nv_conn,
295 		    struct nouveau_encoder *nv_encoder,
296 		    struct backlight_properties *props,
297 		    const struct backlight_ops **ops)
298 {
299 	struct nouveau_drm *drm = nouveau_drm(nv_encoder->base.base.dev);
300 	struct nvif_object *device = &drm->client.device.object;
301 
302 	if (!nvif_rd32(device, NV50_PDISP_SOR_PWM_CTL(ffs(nv_encoder->dcb->or) - 1)) ||
303 	    nv_conn->base.status != connector_status_connected)
304 		return -ENODEV;
305 
306 	if (nv_conn->type == DCB_CONNECTOR_eDP) {
307 		int ret;
308 		u16 current_level;
309 		u8 edp_dpcd[EDP_DISPLAY_CTL_CAP_SIZE];
310 		u8 current_mode;
311 
312 		ret = drm_dp_dpcd_read(&nv_conn->aux, DP_EDP_DPCD_REV, edp_dpcd,
313 				       EDP_DISPLAY_CTL_CAP_SIZE);
314 		if (ret < 0)
315 			return ret;
316 
317 		/* TODO: Add support for hybrid PWM/DPCD panels */
318 		if (drm_edp_backlight_supported(edp_dpcd) &&
319 		    (edp_dpcd[1] & DP_EDP_BACKLIGHT_AUX_ENABLE_CAP) &&
320 		    (edp_dpcd[2] & DP_EDP_BACKLIGHT_BRIGHTNESS_AUX_SET_CAP)) {
321 			NV_DEBUG(drm, "DPCD backlight controls supported on %s\n",
322 				 nv_conn->base.name);
323 
324 			ret = drm_edp_backlight_init(&nv_conn->aux, &bl->edp_info, 0, edp_dpcd,
325 						     &current_level, &current_mode);
326 			if (ret < 0)
327 				return ret;
328 
329 			ret = drm_edp_backlight_enable(&nv_conn->aux, &bl->edp_info, current_level);
330 			if (ret < 0) {
331 				NV_ERROR(drm, "Failed to enable backlight on %s: %d\n",
332 					 nv_conn->base.name, ret);
333 				return ret;
334 			}
335 
336 			*ops = &nv50_edp_bl_ops;
337 			props->brightness = current_level;
338 			props->max_brightness = bl->edp_info.max;
339 			bl->uses_dpcd = true;
340 			return 0;
341 		}
342 	}
343 
344 	if (drm->client.device.info.chipset <= 0xa0 ||
345 	    drm->client.device.info.chipset == 0xaa ||
346 	    drm->client.device.info.chipset == 0xac)
347 		*ops = &nv50_bl_ops;
348 	else
349 		*ops = &nva3_bl_ops;
350 
351 	props->max_brightness = 100;
352 
353 	return 0;
354 }
355 
356 int
357 nouveau_backlight_init(struct drm_connector *connector)
358 {
359 	struct nouveau_drm *drm = nouveau_drm(connector->dev);
360 	struct nouveau_backlight *bl;
361 	struct nouveau_encoder *nv_encoder = NULL;
362 	struct nvif_device *device = &drm->client.device;
363 	char backlight_name[BL_NAME_SIZE];
364 	struct backlight_properties props = {0};
365 	const struct backlight_ops *ops;
366 	int ret;
367 
368 	if (apple_gmux_present()) {
369 		NV_INFO_ONCE(drm, "Apple GMUX detected: not registering Nouveau backlight interface\n");
370 		return 0;
371 	}
372 
373 	if (connector->connector_type == DRM_MODE_CONNECTOR_LVDS)
374 		nv_encoder = find_encoder(connector, DCB_OUTPUT_LVDS);
375 	else if (connector->connector_type == DRM_MODE_CONNECTOR_eDP)
376 		nv_encoder = find_encoder(connector, DCB_OUTPUT_DP);
377 	else
378 		return 0;
379 
380 	if (!nv_encoder)
381 		return 0;
382 
383 	bl = kzalloc(sizeof(*bl), GFP_KERNEL);
384 	if (!bl)
385 		return -ENOMEM;
386 
387 	switch (device->info.family) {
388 	case NV_DEVICE_INFO_V0_CURIE:
389 		ret = nv40_backlight_init(nv_encoder, &props, &ops);
390 		break;
391 	case NV_DEVICE_INFO_V0_TESLA:
392 	case NV_DEVICE_INFO_V0_FERMI:
393 	case NV_DEVICE_INFO_V0_KEPLER:
394 	case NV_DEVICE_INFO_V0_MAXWELL:
395 	case NV_DEVICE_INFO_V0_PASCAL:
396 	case NV_DEVICE_INFO_V0_VOLTA:
397 	case NV_DEVICE_INFO_V0_TURING:
398 	case NV_DEVICE_INFO_V0_AMPERE: //XXX: not confirmed
399 		ret = nv50_backlight_init(bl, nouveau_connector(connector),
400 					  nv_encoder, &props, &ops);
401 		break;
402 	default:
403 		ret = 0;
404 		goto fail_alloc;
405 	}
406 
407 	if (ret) {
408 		if (ret == -ENODEV)
409 			ret = 0;
410 		goto fail_alloc;
411 	}
412 
413 	if (!nouveau_acpi_video_backlight_use_native()) {
414 		NV_INFO(drm, "Skipping nv_backlight registration\n");
415 		goto fail_alloc;
416 	}
417 
418 	if (!nouveau_get_backlight_name(backlight_name, bl)) {
419 		NV_ERROR(drm, "Failed to retrieve a unique name for the backlight interface\n");
420 		goto fail_alloc;
421 	}
422 
423 	props.type = BACKLIGHT_RAW;
424 	bl->dev = backlight_device_register(backlight_name, connector->kdev,
425 					    nv_encoder, ops, &props);
426 	if (IS_ERR(bl->dev)) {
427 		if (bl->id >= 0)
428 			ida_free(&bl_ida, bl->id);
429 		ret = PTR_ERR(bl->dev);
430 		goto fail_alloc;
431 	}
432 
433 	nouveau_connector(connector)->backlight = bl;
434 	if (!bl->dev->props.brightness)
435 		bl->dev->props.brightness =
436 			bl->dev->ops->get_brightness(bl->dev);
437 	backlight_update_status(bl->dev);
438 
439 	return 0;
440 
441 fail_alloc:
442 	kfree(bl);
443 	/*
444 	 * If we get here we have an internal panel, but no nv_backlight,
445 	 * try registering an ACPI video backlight device instead.
446 	 */
447 	if (ret == 0)
448 		nouveau_acpi_video_register_backlight();
449 
450 	return ret;
451 }
452 
453 void
454 nouveau_backlight_fini(struct drm_connector *connector)
455 {
456 	struct nouveau_connector *nv_conn = nouveau_connector(connector);
457 	struct nouveau_backlight *bl = nv_conn->backlight;
458 
459 	if (!bl)
460 		return;
461 
462 	if (bl->id >= 0)
463 		ida_free(&bl_ida, bl->id);
464 
465 	backlight_device_unregister(bl->dev);
466 	nv_conn->backlight = NULL;
467 	kfree(bl);
468 }
469 
470 void
471 nouveau_backlight_ctor(void)
472 {
473 	ida_init(&bl_ida);
474 }
475 
476 void
477 nouveau_backlight_dtor(void)
478 {
479 	ida_destroy(&bl_ida);
480 }
481