implement new mechanism for smooth transition from DEVICE to CLIENT
[platform/core/uifw/libtdm.git] / src / tdm_backend.c
1 /**************************************************************************
2  *
3  * libtdm
4  *
5  * Copyright 2015 Samsung Electronics co., Ltd. All Rights Reserved.
6  *
7  * Contact: Eunchul Kim <chulspro.kim@samsung.com>,
8  *          JinYoung Jeon <jy0.jeon@samsung.com>,
9  *          Taeheon Kim <th908.kim@samsung.com>,
10  *          YoungJun Cho <yj44.cho@samsung.com>,
11  *          SooChan Lim <sc1.lim@samsung.com>,
12  *          Boram Park <sc1.lim@samsung.com>
13  *
14  * Permission is hereby granted, free of charge, to any person obtaining a
15  * copy of this software and associated documentation files (the
16  * "Software"), to deal in the Software without restriction, including
17  * without limitation the rights to use, copy, modify, merge, publish,
18  * distribute, sub license, and/or sell copies of the Software, and to
19  * permit persons to whom the Software is furnished to do so, subject to
20  * the following conditions:
21  *
22  * The above copyright notice and this permission notice (including the
23  * next paragraph) shall be included in all copies or substantial portions
24  * of the Software.
25  *
26  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
27  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
28  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
29  * IN NO EVENT SHALL PRECISION INSIGHT AND/OR ITS SUPPLIERS BE LIABLE FOR
30  * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
31  * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
32  * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
33  *
34 **************************************************************************/
35
36 #ifdef HAVE_CONFIG_H
37 #include "config.h"
38 #endif
39
40 #include "tdm.h"
41 #include "tdm_backend.h"
42 #include "tdm_private.h"
43
44 #define BACKEND_FUNC_ENTRY() \
45         tdm_private_display *private_display; \
46         TDM_RETURN_VAL_IF_FAIL(dpy != NULL, TDM_ERROR_INVALID_PARAMETER); \
47         private_display = (tdm_private_display*)dpy;
48
49 static int
50 _check_abi_version(tdm_backend_module *module, int abimaj, int abimin)
51 {
52         int major = TDM_BACKEND_GET_ABI_MAJOR(module->abi_version);
53         int minor = TDM_BACKEND_GET_ABI_MINOR(module->abi_version);
54
55         if (major < abimaj) goto failed;
56         if (major > abimaj) return 0;
57         if (minor < abimin) goto failed;
58         return 0;
59 failed:
60         TDM_ERR("The ABI version(%d.%d) of '%s' is less than %d.%d",
61                         major, minor, module->name ? module->name : "unknown",
62                         abimaj, abimin);
63         return -1;
64 }
65
66 EXTERN tdm_error
67 tdm_backend_register_func_display(tdm_display *dpy,
68                                                                   tdm_func_display *func_display)
69 {
70         tdm_backend_module *module;
71
72         TDM_RETURN_VAL_IF_FAIL(TDM_MUTEX_IS_LOCKED(), TDM_ERROR_OPERATION_FAILED);
73
74         BACKEND_FUNC_ENTRY();
75
76         TDM_RETURN_VAL_IF_FAIL(func_display != NULL, TDM_ERROR_INVALID_PARAMETER);
77
78         /* the ABI version of backend module should be more than 1.1 */
79         module = private_display->module_data;
80         if (_check_abi_version(module, 1, 1) < 0)
81                 return TDM_ERROR_BAD_MODULE;
82
83         private_display->func_display = *func_display;
84
85         return TDM_ERROR_NONE;
86 }
87
88 EXTERN tdm_error
89 tdm_backend_register_func_output(tdm_display *dpy, tdm_func_output *func_output)
90 {
91         tdm_backend_module *module;
92
93         TDM_RETURN_VAL_IF_FAIL(TDM_MUTEX_IS_LOCKED(), TDM_ERROR_OPERATION_FAILED);
94
95         BACKEND_FUNC_ENTRY();
96
97         TDM_RETURN_VAL_IF_FAIL(func_output != NULL, TDM_ERROR_INVALID_PARAMETER);
98
99         /* the ABI version of backend module should be more than 1.1 */
100         module = private_display->module_data;
101         if (_check_abi_version(module, 1, 1) < 0)
102                 return TDM_ERROR_BAD_MODULE;
103
104         private_display->func_output = *func_output;
105
106         return TDM_ERROR_NONE;
107 }
108
109 EXTERN tdm_error
110 tdm_backend_register_func_layer(tdm_display *dpy, tdm_func_layer *func_layer)
111 {
112         tdm_backend_module *module;
113
114         TDM_RETURN_VAL_IF_FAIL(TDM_MUTEX_IS_LOCKED(), TDM_ERROR_OPERATION_FAILED);
115
116         BACKEND_FUNC_ENTRY();
117
118         TDM_RETURN_VAL_IF_FAIL(func_layer != NULL, TDM_ERROR_INVALID_PARAMETER);
119
120         /* the ABI version of backend module should be more than 1.1 */
121         module = private_display->module_data;
122         if (_check_abi_version(module, 1, 1) < 0)
123                 return TDM_ERROR_BAD_MODULE;
124
125         private_display->func_layer = *func_layer;
126
127         return TDM_ERROR_NONE;
128 }
129
130 EXTERN tdm_error
131 tdm_backend_register_func_hwc_window(tdm_display *dpy, tdm_func_hwc_window *func_hwc_window)
132 {
133         tdm_backend_module *module;
134
135         TDM_RETURN_VAL_IF_FAIL(TDM_MUTEX_IS_LOCKED(), TDM_ERROR_OPERATION_FAILED);
136
137         BACKEND_FUNC_ENTRY();
138
139         TDM_RETURN_VAL_IF_FAIL(func_hwc_window != NULL, TDM_ERROR_INVALID_PARAMETER);
140
141         module = private_display->module_data;
142         /* FIX ME:
143                    Temporarily, we set the version of hwc window to 1.1 for the development.
144                    Originally the hwc window version is 2.0. */
145         if (_check_abi_version(module, 1, 1) < 0)
146                 return TDM_ERROR_BAD_MODULE;
147
148         private_display->func_hwc_window = *func_hwc_window;
149
150         return TDM_ERROR_NONE;
151 }
152
153 EXTERN tdm_error
154 tdm_backend_register_func_pp(tdm_display *dpy, tdm_func_pp *func_pp)
155 {
156         TDM_RETURN_VAL_IF_FAIL(TDM_MUTEX_IS_LOCKED(), TDM_ERROR_OPERATION_FAILED);
157
158         BACKEND_FUNC_ENTRY();
159
160         if (!func_pp)
161                 return TDM_ERROR_NONE;
162
163         private_display->capabilities |= TDM_DISPLAY_CAPABILITY_PP;
164         private_display->func_pp = *func_pp;
165
166         return TDM_ERROR_NONE;
167 }
168
169 EXTERN tdm_error
170 tdm_backend_register_func_capture(tdm_display *dpy,
171                                                                   tdm_func_capture *func_capture)
172 {
173         TDM_RETURN_VAL_IF_FAIL(TDM_MUTEX_IS_LOCKED(), TDM_ERROR_OPERATION_FAILED);
174
175         BACKEND_FUNC_ENTRY();
176
177         if (!func_capture)
178                 return TDM_ERROR_NONE;
179
180         private_display->capabilities |= TDM_DISPLAY_CAPABILITY_CAPTURE;
181         private_display->func_capture = *func_capture;
182
183         return TDM_ERROR_NONE;
184 }
185
186 /* backend operates itself types */
187 static tdm_private_output*
188 _look_for_frontend_hwc_output(tdm_output *backend_output)
189 {
190         tdm_private_output *frontend_output = NULL, *o = NULL;
191         tdm_private_display *dpy;
192
193         dpy = tdm_display_init(NULL);
194         TDM_RETURN_VAL_IF_FAIL(dpy != NULL, NULL);
195
196         LIST_FOR_EACH_ENTRY(o, &dpy->output_list, link) {
197                 if (!(o->caps.capabilities & TDM_OUTPUT_CAPABILITY_HWC))
198                         continue;
199
200                 if (o->output_backend == backend_output) {
201                         frontend_output = o;
202                         break;
203                 }
204         }
205
206         tdm_display_deinit(dpy);
207
208         return frontend_output;
209 }
210
211 EXTERN tdm_error
212 tdm_backend_trigger_need_validate_event(tdm_output *output)
213 {
214         tdm_private_output *private_output;
215         uint64_t value;
216         int res;
217
218         private_output = _look_for_frontend_hwc_output(output);
219         TDM_RETURN_VAL_IF_FAIL(private_output != NULL, TDM_ERROR_INVALID_PARAMETER);
220
221         value = 1;
222
223         /* do not lock the global display lock here */
224
225         res = write(private_output->need_validate.event_fd, &value, sizeof(value));
226         if (res < 0)
227                 return TDM_ERROR_OPERATION_FAILED;
228
229         return TDM_ERROR_NONE;
230 }