xref: /linux/drivers/gpu/drm/clients/drm_fbdev_client.c (revision cb8fef4b07f71da01843457b66e579ad248a625e)
1 // SPDX-License-Identifier: MIT
2 
3 #include <drm/clients/drm_fbdev_helper.h>
4 #include <drm/drm_client.h>
5 #include <drm/drm_crtc_helper.h>
6 #include <drm/drm_drv.h>
7 #include <drm/drm_fourcc.h>
8 #include <drm/drm_print.h>
9 
10 #include "drm_client_internal.h"
11 
12 /*
13  * struct drm_client_funcs
14  */
15 
16 static void drm_fbdev_client_free(struct drm_client_dev *client)
17 {
18 	struct drm_fb_helper *fb_helper = drm_fb_helper_from_client(client);
19 
20 	drm_fb_helper_unprepare(fb_helper);
21 	kfree(fb_helper);
22 }
23 
24 static void drm_fbdev_client_unregister(struct drm_client_dev *client)
25 {
26 	struct drm_fb_helper *fb_helper = drm_fb_helper_from_client(client);
27 
28 	if (fb_helper->info) {
29 		/*
30 		 * Fully probed framebuffer device
31 		 */
32 		drm_fb_helper_unregister_info(fb_helper);
33 	} else {
34 		/*
35 		 * Partially initialized client, no framebuffer device yet
36 		 */
37 		drm_client_release(&fb_helper->client);
38 	}
39 }
40 
41 static int drm_fbdev_client_restore(struct drm_client_dev *client, bool force)
42 {
43 	struct drm_fb_helper *fb_helper = drm_fb_helper_from_client(client);
44 
45 	/*
46 	 * The client is registered before the initial fbdev probe.
47 	 * If probing failed, the client remains registered but there
48 	 * is no valid fbdev framebuffer to restore.
49 	 */
50 	if (!fb_helper->info || !fb_helper->fb)
51 		return 0;
52 
53 	drm_fb_helper_restore_fbdev_mode_unlocked(fb_helper, force);
54 
55 	return 0;
56 }
57 
58 static void drm_fbdev_client_acquire_outputs(struct drm_client_dev *client)
59 {
60 	struct drm_fb_helper *fb_helper = drm_fb_helper_from_client(client);
61 
62 	if (fb_helper->info)
63 		fb_switch_outputs(fb_helper->info);
64 }
65 
66 static int drm_fbdev_client_hotplug(struct drm_client_dev *client)
67 {
68 	struct drm_fb_helper *fb_helper = drm_fb_helper_from_client(client);
69 	struct drm_device *dev = client->dev;
70 	int ret;
71 
72 	if (dev->fb_helper)
73 		return drm_fb_helper_hotplug_event(dev->fb_helper);
74 
75 	ret = drm_fb_helper_init(dev, fb_helper);
76 	if (ret)
77 		goto err_drm_err;
78 
79 	if (!drm_drv_uses_atomic_modeset(dev))
80 		drm_helper_disable_unused_functions(dev);
81 
82 	ret = drm_fb_helper_initial_config(fb_helper);
83 	if (ret)
84 		goto err_drm_fb_helper_fini;
85 
86 	return 0;
87 
88 err_drm_fb_helper_fini:
89 	drm_fb_helper_fini(fb_helper);
90 err_drm_err:
91 	drm_err(dev, "fbdev: Failed to setup emulation (ret=%d)\n", ret);
92 	return ret;
93 }
94 
95 static int drm_fbdev_client_suspend(struct drm_client_dev *client)
96 {
97 	struct drm_fb_helper *fb_helper = drm_fb_helper_from_client(client);
98 
99 	drm_fb_helper_set_suspend_unlocked(fb_helper, true);
100 
101 	return 0;
102 }
103 
104 static int drm_fbdev_client_resume(struct drm_client_dev *client)
105 {
106 	struct drm_fb_helper *fb_helper = drm_fb_helper_from_client(client);
107 
108 	drm_fb_helper_set_suspend_unlocked(fb_helper, false);
109 
110 	return 0;
111 }
112 
113 static const struct drm_client_funcs drm_fbdev_client_funcs = {
114 	.owner		 = THIS_MODULE,
115 	.free		 = drm_fbdev_client_free,
116 	.unregister	 = drm_fbdev_client_unregister,
117 	.restore	 = drm_fbdev_client_restore,
118 	.acquire_outputs = drm_fbdev_client_acquire_outputs,
119 	.hotplug	 = drm_fbdev_client_hotplug,
120 	.suspend	 = drm_fbdev_client_suspend,
121 	.resume		 = drm_fbdev_client_resume,
122 };
123 
124 /**
125  * drm_fbdev_client_setup() - Setup fbdev emulation
126  * @dev: DRM device
127  * @format: Preferred color format for the device. DRM_FORMAT_XRGB8888
128  *          is used if this is zero.
129  *
130  * This function sets up fbdev emulation. Restore, hotplug events and
131  * teardown are all taken care of. Drivers that do suspend/resume need
132  * to call drm_client_dev_suspend() and drm_client_dev_resume() by
133  * themselves. Simple drivers might use drm_mode_config_helper_suspend().
134  *
135  * This function is safe to call even when there are no connectors present.
136  * Setup will be retried on the next hotplug event.
137  *
138  * The fbdev client is destroyed by drm_dev_unregister().
139  *
140  * Returns:
141  * 0 on success, or a negative errno code otherwise.
142  */
143 int drm_fbdev_client_setup(struct drm_device *dev, const struct drm_format_info *format)
144 {
145 	struct drm_fb_helper *fb_helper;
146 	unsigned int color_mode;
147 	int ret;
148 
149 	/* TODO: Use format info throughout DRM */
150 	if (format) {
151 		unsigned int bpp = drm_format_info_bpp(format, 0);
152 
153 		switch (bpp) {
154 		case 16:
155 			color_mode = format->depth; // could also be 15
156 			break;
157 		default:
158 			color_mode = bpp;
159 		}
160 	} else {
161 		switch (dev->mode_config.preferred_depth) {
162 		case 0:
163 		case 24:
164 			color_mode = 32;
165 			break;
166 		default:
167 			color_mode = dev->mode_config.preferred_depth;
168 		}
169 	}
170 
171 	drm_WARN(dev, !dev->registered, "Device has not been registered.\n");
172 	drm_WARN(dev, dev->fb_helper, "fb_helper is already set!\n");
173 
174 	fb_helper = kzalloc_obj(*fb_helper);
175 	if (!fb_helper)
176 		return -ENOMEM;
177 	drm_fb_helper_prepare(dev, fb_helper, color_mode, NULL);
178 
179 	ret = drm_client_init(dev, &fb_helper->client, "fbdev", &drm_fbdev_client_funcs);
180 	if (ret) {
181 		drm_err(dev, "Failed to register client: %d\n", ret);
182 		goto err_drm_client_init;
183 	}
184 
185 	drm_client_register(&fb_helper->client);
186 
187 	return 0;
188 
189 err_drm_client_init:
190 	drm_fb_helper_unprepare(fb_helper);
191 	kfree(fb_helper);
192 	return ret;
193 }
194