1 // SPDX-License-Identifier: GPL-2.0 OR MIT
3 * Copyright 2016 VMware, Inc., Palo Alto, CA., USA
5 * Permission is hereby granted, free of charge, to any person obtaining a
6 * copy of this software and associated documentation files (the
7 * "Software"), to deal in the Software without restriction, including
8 * without limitation the rights to use, copy, modify, merge, publish,
9 * distribute, sub license, and/or sell copies of the Software, and to
10 * permit persons to whom the Software is furnished to do so, subject to
11 * the following conditions:
13 * The above copyright notice and this permission notice (including the
14 * next paragraph) shall be included in all copies or substantial portions
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 NON-INFRINGEMENT. IN NO EVENT SHALL
20 * THE COPYRIGHT HOLDERS, AUTHORS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM,
21 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
22 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
23 * USE OR OTHER DEALINGS IN THE SOFTWARE.
28 #include <linux/slab.h>
29 #include <linux/module.h>
30 #include <linux/kernel.h>
31 #include <linux/frame.h>
32 #include <asm/hypervisor.h>
34 #include "vmwgfx_drv.h"
35 #include "vmwgfx_msg.h"
38 #define MESSAGE_STATUS_SUCCESS 0x0001
39 #define MESSAGE_STATUS_DORECV 0x0002
40 #define MESSAGE_STATUS_CPT 0x0010
41 #define MESSAGE_STATUS_HB 0x0080
43 #define RPCI_PROTOCOL_NUM 0x49435052
44 #define GUESTMSG_FLAG_COOKIE 0x80000000
48 #define VMW_HYPERVISOR_MAGIC 0x564D5868
49 #define VMW_HYPERVISOR_PORT 0x5658
50 #define VMW_HYPERVISOR_HB_PORT 0x5659
52 #define VMW_PORT_CMD_MSG 30
53 #define VMW_PORT_CMD_HB_MSG 0
54 #define VMW_PORT_CMD_OPEN_CHANNEL (MSG_TYPE_OPEN << 16 | VMW_PORT_CMD_MSG)
55 #define VMW_PORT_CMD_CLOSE_CHANNEL (MSG_TYPE_CLOSE << 16 | VMW_PORT_CMD_MSG)
56 #define VMW_PORT_CMD_SENDSIZE (MSG_TYPE_SENDSIZE << 16 | VMW_PORT_CMD_MSG)
57 #define VMW_PORT_CMD_RECVSIZE (MSG_TYPE_RECVSIZE << 16 | VMW_PORT_CMD_MSG)
58 #define VMW_PORT_CMD_RECVSTATUS (MSG_TYPE_RECVSTATUS << 16 | VMW_PORT_CMD_MSG)
60 #define HIGH_WORD(X) ((X & 0xFFFF0000) >> 16)
62 static u32 vmw_msg_enabled = 1;
85 * @channel: RPC channel
88 * Returns: 0 on success
90 static int vmw_open_channel(struct rpc_channel *channel, unsigned int protocol)
92 unsigned long eax, ebx, ecx, edx, si = 0, di = 0;
94 VMW_PORT(VMW_PORT_CMD_OPEN_CHANNEL,
95 (protocol | GUESTMSG_FLAG_COOKIE), si, di,
98 eax, ebx, ecx, edx, si, di);
100 if ((HIGH_WORD(ecx) & MESSAGE_STATUS_SUCCESS) == 0)
103 channel->channel_id = HIGH_WORD(edx);
104 channel->cookie_high = si;
105 channel->cookie_low = di;
115 * @channel: RPC channel
117 * Returns: 0 on success
119 static int vmw_close_channel(struct rpc_channel *channel)
121 unsigned long eax, ebx, ecx, edx, si, di;
123 /* Set up additional parameters */
124 si = channel->cookie_high;
125 di = channel->cookie_low;
127 VMW_PORT(VMW_PORT_CMD_CLOSE_CHANNEL,
129 (VMW_HYPERVISOR_PORT | (channel->channel_id << 16)),
130 VMW_HYPERVISOR_MAGIC,
131 eax, ebx, ecx, edx, si, di);
133 if ((HIGH_WORD(ecx) & MESSAGE_STATUS_SUCCESS) == 0)
140 * vmw_port_hb_out - Send the message payload either through the
141 * high-bandwidth port if available, or through the backdoor otherwise.
142 * @channel: The rpc channel.
143 * @msg: NULL-terminated message.
144 * @hb: Whether the high-bandwidth port is available.
146 * Return: The port status.
148 static unsigned long vmw_port_hb_out(struct rpc_channel *channel,
149 const char *msg, bool hb)
151 unsigned long si, di, eax, ebx, ecx, edx;
152 unsigned long msg_len = strlen(msg);
155 unsigned long bp = channel->cookie_high;
157 si = (uintptr_t) msg;
158 di = channel->cookie_low;
161 (MESSAGE_STATUS_SUCCESS << 16) | VMW_PORT_CMD_HB_MSG,
163 VMW_HYPERVISOR_HB_PORT | (channel->channel_id << 16),
164 VMW_HYPERVISOR_MAGIC, bp,
165 eax, ebx, ecx, edx, si, di);
170 /* HB port not available. Send the message 4 bytes at a time. */
171 ecx = MESSAGE_STATUS_SUCCESS << 16;
172 while (msg_len && (HIGH_WORD(ecx) & MESSAGE_STATUS_SUCCESS)) {
173 unsigned int bytes = min_t(size_t, msg_len, 4);
174 unsigned long word = 0;
176 memcpy(&word, msg, bytes);
179 si = channel->cookie_high;
180 di = channel->cookie_low;
182 VMW_PORT(VMW_PORT_CMD_MSG | (MSG_TYPE_SENDPAYLOAD << 16),
184 VMW_HYPERVISOR_PORT | (channel->channel_id << 16),
185 VMW_HYPERVISOR_MAGIC,
186 eax, ebx, ecx, edx, si, di);
193 * vmw_port_hb_in - Receive the message payload either through the
194 * high-bandwidth port if available, or through the backdoor otherwise.
195 * @channel: The rpc channel.
196 * @reply: Pointer to buffer holding reply.
197 * @reply_len: Length of the reply.
198 * @hb: Whether the high-bandwidth port is available.
200 * Return: The port status.
202 static unsigned long vmw_port_hb_in(struct rpc_channel *channel, char *reply,
203 unsigned long reply_len, bool hb)
205 unsigned long si, di, eax, ebx, ecx, edx;
208 unsigned long bp = channel->cookie_low;
210 si = channel->cookie_high;
211 di = (uintptr_t) reply;
214 (MESSAGE_STATUS_SUCCESS << 16) | VMW_PORT_CMD_HB_MSG,
216 VMW_HYPERVISOR_HB_PORT | (channel->channel_id << 16),
217 VMW_HYPERVISOR_MAGIC, bp,
218 eax, ebx, ecx, edx, si, di);
223 /* HB port not available. Retrieve the message 4 bytes at a time. */
224 ecx = MESSAGE_STATUS_SUCCESS << 16;
226 unsigned int bytes = min_t(unsigned long, reply_len, 4);
228 si = channel->cookie_high;
229 di = channel->cookie_low;
231 VMW_PORT(VMW_PORT_CMD_MSG | (MSG_TYPE_RECVPAYLOAD << 16),
232 MESSAGE_STATUS_SUCCESS, si, di,
233 VMW_HYPERVISOR_PORT | (channel->channel_id << 16),
234 VMW_HYPERVISOR_MAGIC,
235 eax, ebx, ecx, edx, si, di);
237 if ((HIGH_WORD(ecx) & MESSAGE_STATUS_SUCCESS) == 0)
240 memcpy(reply, &ebx, bytes);
250 * vmw_send_msg: Sends a message to the host
252 * @channel: RPC channel
253 * @logmsg: NULL terminated string
255 * Returns: 0 on success
257 static int vmw_send_msg(struct rpc_channel *channel, const char *msg)
259 unsigned long eax, ebx, ecx, edx, si, di;
260 size_t msg_len = strlen(msg);
263 while (retries < RETRIES) {
266 /* Set up additional parameters */
267 si = channel->cookie_high;
268 di = channel->cookie_low;
270 VMW_PORT(VMW_PORT_CMD_SENDSIZE,
272 VMW_HYPERVISOR_PORT | (channel->channel_id << 16),
273 VMW_HYPERVISOR_MAGIC,
274 eax, ebx, ecx, edx, si, di);
276 if ((HIGH_WORD(ecx) & MESSAGE_STATUS_SUCCESS) == 0) {
277 /* Expected success. Give up. */
282 ebx = vmw_port_hb_out(channel, msg,
283 !!(HIGH_WORD(ecx) & MESSAGE_STATUS_HB));
285 if ((HIGH_WORD(ebx) & MESSAGE_STATUS_SUCCESS) != 0) {
287 } else if ((HIGH_WORD(ebx) & MESSAGE_STATUS_CPT) != 0) {
288 /* A checkpoint occurred. Retry. */
297 STACK_FRAME_NON_STANDARD(vmw_send_msg);
301 * vmw_recv_msg: Receives a message from the host
303 * Note: It is the caller's responsibility to call kfree() on msg.
305 * @channel: channel opened by vmw_open_channel
306 * @msg: [OUT] message received from the host
307 * @msg_len: message length
309 static int vmw_recv_msg(struct rpc_channel *channel, void **msg,
312 unsigned long eax, ebx, ecx, edx, si, di;
321 while (retries < RETRIES) {
324 /* Set up additional parameters */
325 si = channel->cookie_high;
326 di = channel->cookie_low;
328 VMW_PORT(VMW_PORT_CMD_RECVSIZE,
330 (VMW_HYPERVISOR_PORT | (channel->channel_id << 16)),
331 VMW_HYPERVISOR_MAGIC,
332 eax, ebx, ecx, edx, si, di);
334 if ((HIGH_WORD(ecx) & MESSAGE_STATUS_SUCCESS) == 0) {
335 DRM_ERROR("Failed to get reply size for host message.\n");
339 /* No reply available. This is okay. */
340 if ((HIGH_WORD(ecx) & MESSAGE_STATUS_DORECV) == 0)
344 reply = kzalloc(reply_len + 1, GFP_KERNEL);
346 DRM_ERROR("Cannot allocate memory for host message reply.\n");
352 ebx = vmw_port_hb_in(channel, reply, reply_len,
353 !!(HIGH_WORD(ecx) & MESSAGE_STATUS_HB));
354 if ((HIGH_WORD(ebx) & MESSAGE_STATUS_SUCCESS) == 0) {
357 if ((HIGH_WORD(ebx) & MESSAGE_STATUS_CPT) != 0) {
358 /* A checkpoint occurred. Retry. */
365 reply[reply_len] = '\0';
369 si = channel->cookie_high;
370 di = channel->cookie_low;
372 VMW_PORT(VMW_PORT_CMD_RECVSTATUS,
373 MESSAGE_STATUS_SUCCESS, si, di,
374 (VMW_HYPERVISOR_PORT | (channel->channel_id << 16)),
375 VMW_HYPERVISOR_MAGIC,
376 eax, ebx, ecx, edx, si, di);
378 if ((HIGH_WORD(ecx) & MESSAGE_STATUS_SUCCESS) == 0) {
381 if ((HIGH_WORD(ecx) & MESSAGE_STATUS_CPT) != 0) {
382 /* A checkpoint occurred. Retry. */
392 if (retries == RETRIES)
395 *msg_len = reply_len;
400 STACK_FRAME_NON_STANDARD(vmw_recv_msg);
404 * vmw_host_get_guestinfo: Gets a GuestInfo parameter
406 * Gets the value of a GuestInfo.* parameter. The value returned will be in
407 * a string, and it is up to the caller to post-process.
409 * @guest_info_param: Parameter to get, e.g. GuestInfo.svga.gl3
410 * @buffer: if NULL, *reply_len will contain reply size.
411 * @length: size of the reply_buf. Set to size of reply upon return
413 * Returns: 0 on success
415 int vmw_host_get_guestinfo(const char *guest_info_param,
416 char *buffer, size_t *length)
418 struct rpc_channel channel;
419 char *msg, *reply = NULL;
420 size_t reply_len = 0;
422 if (!vmw_msg_enabled)
425 if (!guest_info_param || !length)
428 msg = kasprintf(GFP_KERNEL, "info-get %s", guest_info_param);
430 DRM_ERROR("Cannot allocate memory to get guest info \"%s\".",
435 if (vmw_open_channel(&channel, RPCI_PROTOCOL_NUM))
438 if (vmw_send_msg(&channel, msg) ||
439 vmw_recv_msg(&channel, (void *) &reply, &reply_len))
442 vmw_close_channel(&channel);
443 if (buffer && reply && reply_len > 0) {
444 /* Remove reply code, which are the first 2 characters of
447 reply_len = max(reply_len - 2, (size_t) 0);
448 reply_len = min(reply_len, *length);
451 memcpy(buffer, reply + 2, reply_len);
462 vmw_close_channel(&channel);
467 DRM_ERROR("Failed to get guest info \"%s\".", guest_info_param);
475 * vmw_host_log: Sends a log message to the host
477 * @log: NULL terminated string
479 * Returns: 0 on success
481 int vmw_host_log(const char *log)
483 struct rpc_channel channel;
488 if (!vmw_msg_enabled)
494 msg = kasprintf(GFP_KERNEL, "log %s", log);
496 DRM_ERROR("Cannot allocate memory for host log message.\n");
500 if (vmw_open_channel(&channel, RPCI_PROTOCOL_NUM))
503 if (vmw_send_msg(&channel, msg))
506 vmw_close_channel(&channel);
512 vmw_close_channel(&channel);
515 DRM_ERROR("Failed to send host log message.\n");