[linux-2.6-block.git] / drivers / gpu / drm / vmwgfx / vmwgfx_msg.c

// SPDX-License-Identifier: GPL-2.0 OR MIT
/*
 * Copyright 2016 VMware, Inc., Palo Alto, CA., USA
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the
 * "Software"), to deal in the Software without restriction, including
 * without limitation the rights to use, copy, modify, merge, publish,
 * distribute, sub license, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject to
 * the following conditions:
 *
 * The above copyright notice and this permission notice (including the
 * next paragraph) shall be included in all copies or substantial portions
 * of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL
 * THE COPYRIGHT HOLDERS, AUTHORS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM,
 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
 * USE OR OTHER DEALINGS IN THE SOFTWARE.
 *
 */


#include <linux/slab.h>
#include <linux/module.h>
#include <linux/kernel.h>
#include <linux/frame.h>
#include <asm/hypervisor.h>
#include <drm/drmP.h>
#include "vmwgfx_drv.h"
#include "vmwgfx_msg.h"


#define MESSAGE_STATUS_SUCCESS  0x0001
#define MESSAGE_STATUS_DORECV   0x0002
#define MESSAGE_STATUS_CPT      0x0010
#define MESSAGE_STATUS_HB       0x0080

#define RPCI_PROTOCOL_NUM       0x49435052
#define GUESTMSG_FLAG_COOKIE    0x80000000

#define RETRIES                 3

#define VMW_HYPERVISOR_MAGIC    0x564D5868
#define VMW_HYPERVISOR_PORT     0x5658
#define VMW_HYPERVISOR_HB_PORT  0x5659

#define VMW_PORT_CMD_MSG        30
#define VMW_PORT_CMD_HB_MSG     0
#define VMW_PORT_CMD_OPEN_CHANNEL  (MSG_TYPE_OPEN << 16 | VMW_PORT_CMD_MSG)
#define VMW_PORT_CMD_CLOSE_CHANNEL (MSG_TYPE_CLOSE << 16 | VMW_PORT_CMD_MSG)
#define VMW_PORT_CMD_SENDSIZE   (MSG_TYPE_SENDSIZE << 16 | VMW_PORT_CMD_MSG)
#define VMW_PORT_CMD_RECVSIZE   (MSG_TYPE_RECVSIZE << 16 | VMW_PORT_CMD_MSG)
#define VMW_PORT_CMD_RECVSTATUS (MSG_TYPE_RECVSTATUS << 16 | VMW_PORT_CMD_MSG)

#define HIGH_WORD(X) ((X & 0xFFFF0000) >> 16)

static u32 vmw_msg_enabled = 1;

enum rpc_msg_type {
	MSG_TYPE_OPEN,
	MSG_TYPE_SENDSIZE,
	MSG_TYPE_SENDPAYLOAD,
	MSG_TYPE_RECVSIZE,
	MSG_TYPE_RECVPAYLOAD,
	MSG_TYPE_RECVSTATUS,
	MSG_TYPE_CLOSE,
};

struct rpc_channel {
	u16 channel_id;
	u32 cookie_high;
	u32 cookie_low;
};


/**
 * vmw_open_channel
 *
 * @channel: RPC channel
 * @protocol:
 *
 * Returns: 0 on success
 */
static int vmw_open_channel(struct rpc_channel *channel, unsigned int protocol)
{
	unsigned long eax, ebx, ecx, edx, si = 0, di = 0;

	VMW_PORT(VMW_PORT_CMD_OPEN_CHANNEL,
		(protocol | GUESTMSG_FLAG_COOKIE), si, di,
		VMW_HYPERVISOR_PORT,
		VMW_HYPERVISOR_MAGIC,
		eax, ebx, ecx, edx, si, di);

	if ((HIGH_WORD(ecx) & MESSAGE_STATUS_SUCCESS) == 0)
		return -EINVAL;

	channel->channel_id  = HIGH_WORD(edx);
	channel->cookie_high = si;
	channel->cookie_low  = di;

	return 0;
}


/**
 * vmw_close_channel
 *
 * @channel: RPC channel
 *
 * Returns: 0 on success
 */
static int vmw_close_channel(struct rpc_channel *channel)
{
	unsigned long eax, ebx, ecx, edx, si, di;

	/* Set up additional parameters */
	si  = channel->cookie_high;
	di  = channel->cookie_low;

	VMW_PORT(VMW_PORT_CMD_CLOSE_CHANNEL,
		0, si, di,
		(VMW_HYPERVISOR_PORT | (channel->channel_id << 16)),
		VMW_HYPERVISOR_MAGIC,
		eax, ebx, ecx, edx, si, di);

	if ((HIGH_WORD(ecx) & MESSAGE_STATUS_SUCCESS) == 0)
		return -EINVAL;

	return 0;
}

/**
 * vmw_port_hb_out - Send the message payload either through the
 * high-bandwidth port if available, or through the backdoor otherwise.
 * @channel: The rpc channel.
 * @msg: NULL-terminated message.
 * @hb: Whether the high-bandwidth port is available.
 *
 * Return: The port status.
 */
static unsigned long vmw_port_hb_out(struct rpc_channel *channel,
				     const char *msg, bool hb)
{
	unsigned long si, di, eax, ebx, ecx, edx;
	unsigned long msg_len = strlen(msg);

	if (hb) {
		unsigned long bp = channel->cookie_high;

		si = (uintptr_t) msg;
		di = channel->cookie_low;

		VMW_PORT_HB_OUT(
			(MESSAGE_STATUS_SUCCESS << 16) | VMW_PORT_CMD_HB_MSG,
			msg_len, si, di,
			VMW_HYPERVISOR_HB_PORT | (channel->channel_id << 16),
			VMW_HYPERVISOR_MAGIC, bp,
			eax, ebx, ecx, edx, si, di);

		return ebx;
	}

	/* HB port not available. Send the message 4 bytes at a time. */
	ecx = MESSAGE_STATUS_SUCCESS << 16;
	while (msg_len && (HIGH_WORD(ecx) & MESSAGE_STATUS_SUCCESS)) {
		unsigned int bytes = min_t(size_t, msg_len, 4);
		unsigned long word = 0;

		memcpy(&word, msg, bytes);
		msg_len -= bytes;
		msg += bytes;
		si = channel->cookie_high;
		di = channel->cookie_low;

		VMW_PORT(VMW_PORT_CMD_MSG | (MSG_TYPE_SENDPAYLOAD << 16),
			 word, si, di,
			 VMW_HYPERVISOR_PORT | (channel->channel_id << 16),
			 VMW_HYPERVISOR_MAGIC,
			 eax, ebx, ecx, edx, si, di);
	}

	return ecx;
}

/**
 * vmw_port_hb_in - Receive the message payload either through the
 * high-bandwidth port if available, or through the backdoor otherwise.
 * @channel: The rpc channel.
 * @reply: Pointer to buffer holding reply.
 * @reply_len: Length of the reply.
 * @hb: Whether the high-bandwidth port is available.
 *
 * Return: The port status.
 */
static unsigned long vmw_port_hb_in(struct rpc_channel *channel, char *reply,
				    unsigned long reply_len, bool hb)
{
	unsigned long si, di, eax, ebx, ecx, edx;

	if (hb) {
		unsigned long bp = channel->cookie_low;

		si = channel->cookie_high;
		di = (uintptr_t) reply;

		VMW_PORT_HB_IN(
			(MESSAGE_STATUS_SUCCESS << 16) | VMW_PORT_CMD_HB_MSG,
			reply_len, si, di,
			VMW_HYPERVISOR_HB_PORT | (channel->channel_id << 16),
			VMW_HYPERVISOR_MAGIC, bp,
			eax, ebx, ecx, edx, si, di);

		return ebx;
	}

	/* HB port not available. Retrieve the message 4 bytes at a time. */
	ecx = MESSAGE_STATUS_SUCCESS << 16;
	while (reply_len) {
		unsigned int bytes = min_t(unsigned long, reply_len, 4);

		si = channel->cookie_high;
		di = channel->cookie_low;

		VMW_PORT(VMW_PORT_CMD_MSG | (MSG_TYPE_RECVPAYLOAD << 16),
			 MESSAGE_STATUS_SUCCESS, si, di,
			 VMW_HYPERVISOR_PORT | (channel->channel_id << 16),
			 VMW_HYPERVISOR_MAGIC,
			 eax, ebx, ecx, edx, si, di);

		if ((HIGH_WORD(ecx) & MESSAGE_STATUS_SUCCESS) == 0)
			break;

		memcpy(reply, &ebx, bytes);
		reply_len -= bytes;
		reply += bytes;
	}

	return ecx;
}


/**
 * vmw_send_msg: Sends a message to the host
 *
 * @channel: RPC channel
 * @logmsg: NULL terminated string
 *
 * Returns: 0 on success
 */
static int vmw_send_msg(struct rpc_channel *channel, const char *msg)
{
	unsigned long eax, ebx, ecx, edx, si, di;
	size_t msg_len = strlen(msg);
	int retries = 0;

	while (retries < RETRIES) {
		retries++;

		/* Set up additional parameters */
		si  = channel->cookie_high;
		di  = channel->cookie_low;

		VMW_PORT(VMW_PORT_CMD_SENDSIZE,
			msg_len, si, di,
			VMW_HYPERVISOR_PORT | (channel->channel_id << 16),
			VMW_HYPERVISOR_MAGIC,
			eax, ebx, ecx, edx, si, di);

		if ((HIGH_WORD(ecx) & MESSAGE_STATUS_SUCCESS) == 0) {
			/* Expected success. Give up. */
			return -EINVAL;
		}

		/* Send msg */
		ebx = vmw_port_hb_out(channel, msg,
				      !!(HIGH_WORD(ecx) & MESSAGE_STATUS_HB));

		if ((HIGH_WORD(ebx) & MESSAGE_STATUS_SUCCESS) != 0) {
			return 0;
		} else if ((HIGH_WORD(ebx) & MESSAGE_STATUS_CPT) != 0) {
			/* A checkpoint occurred. Retry. */
			continue;
		} else {
			break;
		}
	}

	return -EINVAL;
}
STACK_FRAME_NON_STANDARD(vmw_send_msg);


/**
 * vmw_recv_msg: Receives a message from the host
 *
 * Note:  It is the caller's responsibility to call kfree() on msg.
 *
 * @channel:  channel opened by vmw_open_channel
 * @msg:  [OUT] message received from the host
 * @msg_len: message length
 */
static int vmw_recv_msg(struct rpc_channel *channel, void **msg,
			size_t *msg_len)
{
	unsigned long eax, ebx, ecx, edx, si, di;
	char *reply;
	size_t reply_len;
	int retries = 0;


	*msg_len = 0;
	*msg = NULL;

	while (retries < RETRIES) {
		retries++;

		/* Set up additional parameters */
		si  = channel->cookie_high;
		di  = channel->cookie_low;

		VMW_PORT(VMW_PORT_CMD_RECVSIZE,
			0, si, di,
			(VMW_HYPERVISOR_PORT | (channel->channel_id << 16)),
			VMW_HYPERVISOR_MAGIC,
			eax, ebx, ecx, edx, si, di);

		if ((HIGH_WORD(ecx) & MESSAGE_STATUS_SUCCESS) == 0) {
			DRM_ERROR("Failed to get reply size for host message.\n");
			return -EINVAL;
		}

		/* No reply available.  This is okay. */
		if ((HIGH_WORD(ecx) & MESSAGE_STATUS_DORECV) == 0)
			return 0;

		reply_len = ebx;
		reply     = kzalloc(reply_len + 1, GFP_KERNEL);
		if (!reply) {
			DRM_ERROR("Cannot allocate memory for host message reply.\n");
			return -ENOMEM;
		}


		/* Receive buffer */
		ebx = vmw_port_hb_in(channel, reply, reply_len,
				     !!(HIGH_WORD(ecx) & MESSAGE_STATUS_HB));
		if ((HIGH_WORD(ebx) & MESSAGE_STATUS_SUCCESS) == 0) {
			kfree(reply);

			if ((HIGH_WORD(ebx) & MESSAGE_STATUS_CPT) != 0) {
				/* A checkpoint occurred. Retry. */
				continue;
			}

			return -EINVAL;
		}

		reply[reply_len] = '\0';


		/* Ack buffer */
		si  = channel->cookie_high;
		di  = channel->cookie_low;

		VMW_PORT(VMW_PORT_CMD_RECVSTATUS,
			MESSAGE_STATUS_SUCCESS, si, di,
			(VMW_HYPERVISOR_PORT | (channel->channel_id << 16)),
			VMW_HYPERVISOR_MAGIC,
			eax, ebx, ecx, edx, si, di);

		if ((HIGH_WORD(ecx) & MESSAGE_STATUS_SUCCESS) == 0) {
			kfree(reply);

			if ((HIGH_WORD(ecx) & MESSAGE_STATUS_CPT) != 0) {
				/* A checkpoint occurred. Retry. */
				continue;
			}

			return -EINVAL;
		}

		break;
	}

	if (retries == RETRIES) {
		kfree(reply);
		return -EINVAL;
	}

	*msg_len = reply_len;
	*msg     = reply;

	return 0;
}
STACK_FRAME_NON_STANDARD(vmw_recv_msg);


/**
 * vmw_host_get_guestinfo: Gets a GuestInfo parameter
 *
 * Gets the value of a  GuestInfo.* parameter.  The value returned will be in
 * a string, and it is up to the caller to post-process.
 *
 * @guest_info_param:  Parameter to get, e.g. GuestInfo.svga.gl3
 * @buffer: if NULL, *reply_len will contain reply size.
 * @length: size of the reply_buf.  Set to size of reply upon return
 *
 * Returns: 0 on success
 */
int vmw_host_get_guestinfo(const char *guest_info_param,
			   char *buffer, size_t *length)
{
	struct rpc_channel channel;
	char *msg, *reply = NULL;
	size_t reply_len = 0;

	if (!vmw_msg_enabled)
		return -ENODEV;

	if (!guest_info_param || !length)
		return -EINVAL;

	msg = kasprintf(GFP_KERNEL, "info-get %s", guest_info_param);
	if (!msg) {
		DRM_ERROR("Cannot allocate memory to get guest info \"%s\".",
			  guest_info_param);
		return -ENOMEM;
	}

	if (vmw_open_channel(&channel, RPCI_PROTOCOL_NUM))
		goto out_open;

	if (vmw_send_msg(&channel, msg) ||
	    vmw_recv_msg(&channel, (void *) &reply, &reply_len))
		goto out_msg;

	vmw_close_channel(&channel);
	if (buffer && reply && reply_len > 0) {
		/* Remove reply code, which are the first 2 characters of
		 * the reply
		 */
		reply_len = max(reply_len - 2, (size_t) 0);
		reply_len = min(reply_len, *length);

		if (reply_len > 0)
			memcpy(buffer, reply + 2, reply_len);
	}

	*length = reply_len;

	kfree(reply);
	kfree(msg);

	return 0;

out_msg:
	vmw_close_channel(&channel);
	kfree(reply);
out_open:
	*length = 0;
	kfree(msg);
	DRM_ERROR("Failed to get guest info \"%s\".", guest_info_param);

	return -EINVAL;
}


/**
 * vmw_host_log: Sends a log message to the host
 *
 * @log: NULL terminated string
 *
 * Returns: 0 on success
 */
int vmw_host_log(const char *log)
{
	struct rpc_channel channel;
	char *msg;
	int ret = 0;


	if (!vmw_msg_enabled)
		return -ENODEV;

	if (!log)
		return ret;

	msg = kasprintf(GFP_KERNEL, "log %s", log);
	if (!msg) {
		DRM_ERROR("Cannot allocate memory for host log message.\n");
		return -ENOMEM;
	}

	if (vmw_open_channel(&channel, RPCI_PROTOCOL_NUM))
		goto out_open;

	if (vmw_send_msg(&channel, msg))
		goto out_msg;

	vmw_close_channel(&channel);
	kfree(msg);

	return 0;

out_msg:
	vmw_close_channel(&channel);
out_open:
	kfree(msg);
	DRM_ERROR("Failed to send host log message.\n");

	return -EINVAL;
}
Commit	Line	Data
dff96888	1	// SPDX-License-Identifier: GPL-2.0 OR MIT
89da76fd	2	/*
dff96888	3	* Copyright 2016 VMware, Inc., Palo Alto, CA., USA
89da76fd SY	4	*
	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:
	12	*
	13	* The above copyright notice and this permission notice (including the
	14	* next paragraph) shall be included in all copies or substantial portions
	15	* of the Software.
	16	*
	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.
	24	*
	25	*/
	26
	27
	28	#include <linux/slab.h>
	29	#include <linux/module.h>
	30	#include <linux/kernel.h>
0b0d81e3	31	#include <linux/frame.h>
89da76fd	32	#include <asm/hypervisor.h>
008be682	33	#include <drm/drmP.h>
6ff67ae7	34	#include "vmwgfx_drv.h"
89da76fd SY	35	#include "vmwgfx_msg.h"
	36
	37
	38	#define MESSAGE_STATUS_SUCCESS 0x0001
	39	#define MESSAGE_STATUS_DORECV 0x0002
	40	#define MESSAGE_STATUS_CPT 0x0010
	41	#define MESSAGE_STATUS_HB 0x0080
	42
	43	#define RPCI_PROTOCOL_NUM 0x49435052
	44	#define GUESTMSG_FLAG_COOKIE 0x80000000
	45
	46	#define RETRIES 3
	47
	48	#define VMW_HYPERVISOR_MAGIC 0x564D5868
	49	#define VMW_HYPERVISOR_PORT 0x5658
	50	#define VMW_HYPERVISOR_HB_PORT 0x5659
	51
	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)
	59
	60	#define HIGH_WORD(X) ((X & 0xFFFF0000) >> 16)
	61
	62	static u32 vmw_msg_enabled = 1;
	63
	64	enum rpc_msg_type {
	65	MSG_TYPE_OPEN,
	66	MSG_TYPE_SENDSIZE,
	67	MSG_TYPE_SENDPAYLOAD,
	68	MSG_TYPE_RECVSIZE,
	69	MSG_TYPE_RECVPAYLOAD,
	70	MSG_TYPE_RECVSTATUS,
	71	MSG_TYPE_CLOSE,
	72	};
	73
	74	struct rpc_channel {
	75	u16 channel_id;
	76	u32 cookie_high;
	77	u32 cookie_low;
	78	};
	79
	80
	81
	82	/**
	83	* vmw_open_channel
	84	*
	85	* @channel: RPC channel
	86	* @protocol:
	87	*
	88	* Returns: 0 on success
	89	*/
	90	static int vmw_open_channel(struct rpc_channel *channel, unsigned int protocol)
	91	{
	92	unsigned long eax, ebx, ecx, edx, si = 0, di = 0;
	93
	94	VMW_PORT(VMW_PORT_CMD_OPEN_CHANNEL,
	95	(protocol \| GUESTMSG_FLAG_COOKIE), si, di,
	96	VMW_HYPERVISOR_PORT,
	97	VMW_HYPERVISOR_MAGIC,
	98	eax, ebx, ecx, edx, si, di);
99
100	if ((HIGH_WORD(ecx) & MESSAGE_STATUS_SUCCESS) == 0)
101	return -EINVAL;
102
103	channel->channel_id = HIGH_WORD(edx);
104	channel->cookie_high = si;
105	channel->cookie_low = di;
106
107	return 0;
108	}
109
110
111
112	/**
113	* vmw_close_channel
114	*
115	* @channel: RPC channel
116	*
117	* Returns: 0 on success
118	*/
119	static int vmw_close_channel(struct rpc_channel *channel)
120	{
121	unsigned long eax, ebx, ecx, edx, si, di;
122
123	/* Set up additional parameters */
124	si = channel->cookie_high;
125	di = channel->cookie_low;
126
127	VMW_PORT(VMW_PORT_CMD_CLOSE_CHANNEL,
128	0, si, di,
129	(VMW_HYPERVISOR_PORT \| (channel->channel_id << 16)),
130	VMW_HYPERVISOR_MAGIC,
131	eax, ebx, ecx, edx, si, di);
132
133	if ((HIGH_WORD(ecx) & MESSAGE_STATUS_SUCCESS) == 0)
134	return -EINVAL;
135
136	return 0;
137	}
138
cc0ba0d8 TH	139	/**
	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.
	145	*
	146	* Return: The port status.
	147	*/
	148	static unsigned long vmw_port_hb_out(struct rpc_channel *channel,
	149	const char *msg, bool hb)
	150	{
	151	unsigned long si, di, eax, ebx, ecx, edx;
	152	unsigned long msg_len = strlen(msg);
	153
	154	if (hb) {
	155	unsigned long bp = channel->cookie_high;
	156
	157	si = (uintptr_t) msg;
	158	di = channel->cookie_low;
	159
	160	VMW_PORT_HB_OUT(
	161	(MESSAGE_STATUS_SUCCESS << 16) \| VMW_PORT_CMD_HB_MSG,
	162	msg_len, si, di,
	163	VMW_HYPERVISOR_HB_PORT \| (channel->channel_id << 16),
	164	VMW_HYPERVISOR_MAGIC, bp,
	165	eax, ebx, ecx, edx, si, di);
	166
	167	return ebx;
	168	}
	169
	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;
	175
	176	memcpy(&word, msg, bytes);
	177	msg_len -= bytes;
	178	msg += bytes;
	179	si = channel->cookie_high;
	180	di = channel->cookie_low;
	181
	182	VMW_PORT(VMW_PORT_CMD_MSG \| (MSG_TYPE_SENDPAYLOAD << 16),
	183	word, si, di,
	184	VMW_HYPERVISOR_PORT \| (channel->channel_id << 16),
	185	VMW_HYPERVISOR_MAGIC,
	186	eax, ebx, ecx, edx, si, di);
	187	}
	188
	189	return ecx;
	190	}
	191
	192	/**
	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.
	199	*
	200	* Return: The port status.
	201	*/
	202	static unsigned long vmw_port_hb_in(struct rpc_channel channel, char reply,
203	unsigned long reply_len, bool hb)
204	{
205	unsigned long si, di, eax, ebx, ecx, edx;
206
207	if (hb) {
208	unsigned long bp = channel->cookie_low;
209
210	si = channel->cookie_high;
211	di = (uintptr_t) reply;
212
213	VMW_PORT_HB_IN(
214	(MESSAGE_STATUS_SUCCESS << 16) \| VMW_PORT_CMD_HB_MSG,
215	reply_len, si, di,
216	VMW_HYPERVISOR_HB_PORT \| (channel->channel_id << 16),
217	VMW_HYPERVISOR_MAGIC, bp,
218	eax, ebx, ecx, edx, si, di);
219
220	return ebx;
221	}
222
223	/* HB port not available. Retrieve the message 4 bytes at a time. */
224	ecx = MESSAGE_STATUS_SUCCESS << 16;
225	while (reply_len) {
226	unsigned int bytes = min_t(unsigned long, reply_len, 4);
227
228	si = channel->cookie_high;
229	di = channel->cookie_low;
230
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);
236
237	if ((HIGH_WORD(ecx) & MESSAGE_STATUS_SUCCESS) == 0)
238	break;
239
240	memcpy(reply, &ebx, bytes);
241	reply_len -= bytes;
242	reply += bytes;
243	}
244
245	return ecx;
246	}
89da76fd SY	247
	248
	249	/**
	250	* vmw_send_msg: Sends a message to the host
	251	*
	252	* @channel: RPC channel
	253	* @logmsg: NULL terminated string
	254	*
	255	* Returns: 0 on success
	256	*/
	257	static int vmw_send_msg(struct rpc_channel channel, const char msg)
	258	{
cc0ba0d8	259	unsigned long eax, ebx, ecx, edx, si, di;
89da76fd SY	260	size_t msg_len = strlen(msg);
	261	int retries = 0;
	262
89da76fd SY	263	while (retries < RETRIES) {
	264	retries++;
	265
	266	/* Set up additional parameters */
	267	si = channel->cookie_high;
	268	di = channel->cookie_low;
	269
	270	VMW_PORT(VMW_PORT_CMD_SENDSIZE,
	271	msg_len, si, di,
	272	VMW_HYPERVISOR_PORT \| (channel->channel_id << 16),
	273	VMW_HYPERVISOR_MAGIC,
	274	eax, ebx, ecx, edx, si, di);
	275
cc0ba0d8 TH	276	if ((HIGH_WORD(ecx) & MESSAGE_STATUS_SUCCESS) == 0) {
cc0ba0d8 TH	277	/* Expected success. Give up. */
89da76fd SY	278	return -EINVAL;
	279	}
	280
	281	/* Send msg */
cc0ba0d8 TH	282	ebx = vmw_port_hb_out(channel, msg,
cc0ba0d8 TH	283	!!(HIGH_WORD(ecx) & MESSAGE_STATUS_HB));
89da76fd SY	284
	285	if ((HIGH_WORD(ebx) & MESSAGE_STATUS_SUCCESS) != 0) {
	286	return 0;
	287	} else if ((HIGH_WORD(ebx) & MESSAGE_STATUS_CPT) != 0) {
	288	/* A checkpoint occurred. Retry. */
	289	continue;
	290	} else {
	291	break;
	292	}
	293	}
	294
	295	return -EINVAL;
	296	}
0b0d81e3	297	STACK_FRAME_NON_STANDARD(vmw_send_msg);
89da76fd SY	298
	299
	300	/**
	301	* vmw_recv_msg: Receives a message from the host
	302	*
	303	* Note: It is the caller's responsibility to call kfree() on msg.
	304	*
	305	* @channel: channel opened by vmw_open_channel
	306	* @msg: [OUT] message received from the host
	307	* @msg_len: message length
	308	*/
	309	static int vmw_recv_msg(struct rpc_channel channel, void *msg,
	310	size_t *msg_len)
	311	{
cc0ba0d8	312	unsigned long eax, ebx, ecx, edx, si, di;
89da76fd SY	313	char *reply;
	314	size_t reply_len;
	315	int retries = 0;
	316
	317
	318	*msg_len = 0;
	319	*msg = NULL;
	320
	321	while (retries < RETRIES) {
	322	retries++;
	323
	324	/* Set up additional parameters */
	325	si = channel->cookie_high;
	326	di = channel->cookie_low;
	327
	328	VMW_PORT(VMW_PORT_CMD_RECVSIZE,
	329	0, si, di,
	330	(VMW_HYPERVISOR_PORT \| (channel->channel_id << 16)),
	331	VMW_HYPERVISOR_MAGIC,
	332	eax, ebx, ecx, edx, si, di);
	333
cc0ba0d8	334	if ((HIGH_WORD(ecx) & MESSAGE_STATUS_SUCCESS) == 0) {
3fbeccf8	335	DRM_ERROR("Failed to get reply size for host message.\n");
89da76fd SY	336	return -EINVAL;
	337	}
	338
	339	/* No reply available. This is okay. */
	340	if ((HIGH_WORD(ecx) & MESSAGE_STATUS_DORECV) == 0)
	341	return 0;
	342
	343	reply_len = ebx;
	344	reply = kzalloc(reply_len + 1, GFP_KERNEL);
1a4adb05	345	if (!reply) {
3fbeccf8	346	DRM_ERROR("Cannot allocate memory for host message reply.\n");
89da76fd SY	347	return -ENOMEM;
	348	}
	349
	350
	351	/* Receive buffer */
cc0ba0d8 TH	352	ebx = vmw_port_hb_in(channel, reply, reply_len,
cc0ba0d8 TH	353	!!(HIGH_WORD(ecx) & MESSAGE_STATUS_HB));
89da76fd SY	354	if ((HIGH_WORD(ebx) & MESSAGE_STATUS_SUCCESS) == 0) {
	355	kfree(reply);
	356
	357	if ((HIGH_WORD(ebx) & MESSAGE_STATUS_CPT) != 0) {
	358	/* A checkpoint occurred. Retry. */
	359	continue;
	360	}
	361
	362	return -EINVAL;
	363	}
	364
	365	reply[reply_len] = '\0';
	366
	367
	368	/* Ack buffer */
	369	si = channel->cookie_high;
	370	di = channel->cookie_low;
	371
	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);
	377
	378	if ((HIGH_WORD(ecx) & MESSAGE_STATUS_SUCCESS) == 0) {
	379	kfree(reply);
	380
	381	if ((HIGH_WORD(ecx) & MESSAGE_STATUS_CPT) != 0) {
	382	/* A checkpoint occurred. Retry. */
	383	continue;
	384	}
	385
	386	return -EINVAL;
	387	}
	388
	389	break;
	390	}
	391
6b7c3b86 CIK	392	if (retries == RETRIES) {
6b7c3b86 CIK	393	kfree(reply);
a9cd9c04	394	return -EINVAL;
6b7c3b86	395	}
a9cd9c04	396
89da76fd SY	397	*msg_len = reply_len;
	398	*msg = reply;
	399
	400	return 0;
	401	}
0b0d81e3	402	STACK_FRAME_NON_STANDARD(vmw_recv_msg);
89da76fd SY	403
	404
	405	/**
	406	* vmw_host_get_guestinfo: Gets a GuestInfo parameter
	407	*
	408	* Gets the value of a GuestInfo.* parameter. The value returned will be in
	409	* a string, and it is up to the caller to post-process.
	410	*
	411	* @guest_info_param: Parameter to get, e.g. GuestInfo.svga.gl3
	412	* @buffer: if NULL, *reply_len will contain reply size.
	413	* @length: size of the reply_buf. Set to size of reply upon return
	414	*
	415	* Returns: 0 on success
	416	*/
	417	int vmw_host_get_guestinfo(const char *guest_info_param,
	418	char buffer, size_t length)
	419	{
	420	struct rpc_channel channel;
	421	char msg, reply = NULL;
6073a092	422	size_t reply_len = 0;
89da76fd SY	423
	424	if (!vmw_msg_enabled)
	425	return -ENODEV;
	426
	427	if (!guest_info_param \|\| !length)
	428	return -EINVAL;
	429
6073a092	430	msg = kasprintf(GFP_KERNEL, "info-get %s", guest_info_param);
1a4adb05	431	if (!msg) {
3fbeccf8 TH	432	DRM_ERROR("Cannot allocate memory to get guest info \"%s\".",
3fbeccf8 TH	433	guest_info_param);
89da76fd SY	434	return -ENOMEM;
	435	}
	436
f37230c0 TH	437	if (vmw_open_channel(&channel, RPCI_PROTOCOL_NUM))
f37230c0 TH	438	goto out_open;
89da76fd	439
f37230c0 TH	440	if (vmw_send_msg(&channel, msg) \|\|
	441	vmw_recv_msg(&channel, (void *) &reply, &reply_len))
	442	goto out_msg;
89da76fd	443
f37230c0	444	vmw_close_channel(&channel);
89da76fd SY	445	if (buffer && reply && reply_len > 0) {
	446	/* Remove reply code, which are the first 2 characters of
	447	* the reply
	448	*/
	449	reply_len = max(reply_len - 2, (size_t) 0);
	450	reply_len = min(reply_len, *length);
	451
	452	if (reply_len > 0)
	453	memcpy(buffer, reply + 2, reply_len);
	454	}
	455
	456	*length = reply_len;
	457
	458	kfree(reply);
	459	kfree(msg);
	460
f37230c0 TH	461	return 0;
	462
	463	out_msg:
	464	vmw_close_channel(&channel);
	465	kfree(reply);
	466	out_open:
	467	*length = 0;
	468	kfree(msg);
3fbeccf8	469	DRM_ERROR("Failed to get guest info \"%s\".", guest_info_param);
f37230c0 TH	470
f37230c0 TH	471	return -EINVAL;
89da76fd SY	472	}
	473
	474
	475
	476	/**
	477	* vmw_host_log: Sends a log message to the host
	478	*
	479	* @log: NULL terminated string
	480	*
	481	* Returns: 0 on success
	482	*/
	483	int vmw_host_log(const char *log)
	484	{
	485	struct rpc_channel channel;
	486	char *msg;
89da76fd SY	487	int ret = 0;
	488
	489
	490	if (!vmw_msg_enabled)
	491	return -ENODEV;
	492
	493	if (!log)
	494	return ret;
	495
6073a092	496	msg = kasprintf(GFP_KERNEL, "log %s", log);
1a4adb05	497	if (!msg) {
3fbeccf8	498	DRM_ERROR("Cannot allocate memory for host log message.\n");
89da76fd SY	499	return -ENOMEM;
	500	}
	501
f37230c0 TH	502	if (vmw_open_channel(&channel, RPCI_PROTOCOL_NUM))
f37230c0 TH	503	goto out_open;
89da76fd	504
f37230c0 TH	505	if (vmw_send_msg(&channel, msg))
f37230c0 TH	506	goto out_msg;
89da76fd	507
f37230c0	508	vmw_close_channel(&channel);
89da76fd SY	509	kfree(msg);
89da76fd SY	510
f37230c0 TH	511	return 0;
	512
	513	out_msg:
	514	vmw_close_channel(&channel);
	515	out_open:
	516	kfree(msg);
3fbeccf8	517	DRM_ERROR("Failed to send host log message.\n");
f37230c0 TH	518
f37230c0 TH	519	return -EINVAL;
89da76fd	520	}