1434 lines · 35.2 KB · C
RawDownload
// SPDX-License-Identifier: GPL-2.0-only/* * Copyright (c) 2012, Microsoft Corporation. * * Author: *   Haiyang Zhang <haiyangz@microsoft.com> */ /* * Hyper-V Synthetic Video Frame Buffer Driver * * This is the driver for the Hyper-V Synthetic Video, which supports * screen resolution up to Full HD 1920x1080 with 32 bit color on Windows * Server 2012, and 1600x1200 with 16 bit color on Windows Server 2008 R2 * or earlier. * * It also solves the double mouse cursor issue of the emulated video mode. * * The default screen resolution is 1152x864, which may be changed by a * kernel parameter: *     video=hyperv_fb:<width>x<height> *     For example: video=hyperv_fb:1280x1024 * * Portrait orientation is also supported: *     For example: video=hyperv_fb:864x1152 * * When a Windows 10 RS5+ host is used, the virtual machine screen * resolution is obtained from the host. The "video=hyperv_fb" option is * not needed, but still can be used to overwrite what the host specifies. * The VM resolution on the host could be set by executing the powershell * "set-vmvideo" command. For example *     set-vmvideo -vmname name -horizontalresolution:1920 \ * -verticalresolution:1200 -resolutiontype single * * Gen 1 VMs also support direct using VM's physical memory for framebuffer. * It could improve the efficiency and performance for framebuffer and VM. * This requires to allocate contiguous physical memory from Linux kernel's * CMA memory allocator. To enable this, supply a kernel parameter to give * enough memory space to CMA allocator for framebuffer. For example: *    cma=130m * This gives 130MB memory to CMA allocator that can be allocated to * framebuffer. For reference, 8K resolution (7680x4320) takes about * 127MB memory. */ #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt #include <linux/module.h>#include <linux/kernel.h>#include <linux/vmalloc.h>#include <linux/init.h>#include <linux/completion.h>#include <linux/fb.h>#include <linux/pci.h>#include <linux/efi.h>#include <linux/console.h> #include <linux/hyperv.h>  /* Hyper-V Synthetic Video Protocol definitions and structures */#define MAX_VMBUS_PKT_SIZE 0x4000 #define SYNTHVID_VERSION(major, minor) ((minor) << 16 | (major))#define SYNTHVID_VERSION_WIN7 SYNTHVID_VERSION(3, 0)#define SYNTHVID_VERSION_WIN8 SYNTHVID_VERSION(3, 2)#define SYNTHVID_VERSION_WIN10 SYNTHVID_VERSION(3, 5) #define SYNTHVID_VER_GET_MAJOR(ver) (ver & 0x0000ffff)#define SYNTHVID_VER_GET_MINOR(ver) ((ver & 0xffff0000) >> 16) #define SYNTHVID_DEPTH_WIN7 16#define SYNTHVID_DEPTH_WIN8 32 #define SYNTHVID_FB_SIZE_WIN7 (4 * 1024 * 1024)#define SYNTHVID_WIDTH_MAX_WIN7 1600#define SYNTHVID_HEIGHT_MAX_WIN7 1200 #define SYNTHVID_FB_SIZE_WIN8 (8 * 1024 * 1024) #define PCI_VENDOR_ID_MICROSOFT 0x1414#define PCI_DEVICE_ID_HYPERV_VIDEO 0x5353  enum pipe_msg_type {	PIPE_MSG_INVALID,	PIPE_MSG_DATA,	PIPE_MSG_MAX}; struct pipe_msg_hdr {	u32 type;	u32 size; /* size of message after this field */} __packed;  enum synthvid_msg_type {	SYNTHVID_ERROR			= 0,	SYNTHVID_VERSION_REQUEST	= 1,	SYNTHVID_VERSION_RESPONSE	= 2,	SYNTHVID_VRAM_LOCATION		= 3,	SYNTHVID_VRAM_LOCATION_ACK	= 4,	SYNTHVID_SITUATION_UPDATE	= 5,	SYNTHVID_SITUATION_UPDATE_ACK	= 6,	SYNTHVID_POINTER_POSITION	= 7,	SYNTHVID_POINTER_SHAPE		= 8,	SYNTHVID_FEATURE_CHANGE		= 9,	SYNTHVID_DIRT			= 10,	SYNTHVID_RESOLUTION_REQUEST	= 13,	SYNTHVID_RESOLUTION_RESPONSE	= 14, 	SYNTHVID_MAX			= 15}; #define		SYNTHVID_EDID_BLOCK_SIZE	128#define		SYNTHVID_MAX_RESOLUTION_COUNT	64 struct hvd_screen_info {	u16 width;	u16 height;} __packed; struct synthvid_msg_hdr {	u32 type;	u32 size;  /* size of this header + payload after this field*/} __packed; struct synthvid_version_req {	u32 version;} __packed; struct synthvid_version_resp {	u32 version;	u8 is_accepted;	u8 max_video_outputs;} __packed; struct synthvid_supported_resolution_req {	u8 maximum_resolution_count;} __packed; struct synthvid_supported_resolution_resp {	u8 edid_block[SYNTHVID_EDID_BLOCK_SIZE];	u8 resolution_count;	u8 default_resolution_index;	u8 is_standard;	struct hvd_screen_info		supported_resolution[SYNTHVID_MAX_RESOLUTION_COUNT];} __packed; struct synthvid_vram_location {	u64 user_ctx;	u8 is_vram_gpa_specified;	u64 vram_gpa;} __packed; struct synthvid_vram_location_ack {	u64 user_ctx;} __packed; struct video_output_situation {	u8 active;	u32 vram_offset;	u8 depth_bits;	u32 width_pixels;	u32 height_pixels;	u32 pitch_bytes;} __packed; struct synthvid_situation_update {	u64 user_ctx;	u8 video_output_count;	struct video_output_situation video_output[1];} __packed; struct synthvid_situation_update_ack {	u64 user_ctx;} __packed; struct synthvid_pointer_position {	u8 is_visible;	u8 video_output;	s32 image_x;	s32 image_y;} __packed;  #define CURSOR_MAX_X 96#define CURSOR_MAX_Y 96#define CURSOR_ARGB_PIXEL_SIZE 4#define CURSOR_MAX_SIZE (CURSOR_MAX_X * CURSOR_MAX_Y * CURSOR_ARGB_PIXEL_SIZE)#define CURSOR_COMPLETE (-1) struct synthvid_pointer_shape {	u8 part_idx;	u8 is_argb;	u32 width; /* CURSOR_MAX_X at most */	u32 height; /* CURSOR_MAX_Y at most */	u32 hot_x; /* hotspot relative to upper-left of pointer image */	u32 hot_y;	u8 data[4];} __packed; struct synthvid_feature_change {	u8 is_dirt_needed;	u8 is_ptr_pos_needed;	u8 is_ptr_shape_needed;	u8 is_situ_needed;} __packed; struct rect {	s32 x1, y1; /* top left corner */	s32 x2, y2; /* bottom right corner, exclusive */} __packed; struct synthvid_dirt {	u8 video_output;	u8 dirt_count;	struct rect rect[1];} __packed; struct synthvid_msg {	struct pipe_msg_hdr pipe_hdr;	struct synthvid_msg_hdr vid_hdr;	union {		struct synthvid_version_req ver_req;		struct synthvid_version_resp ver_resp;		struct synthvid_vram_location vram;		struct synthvid_vram_location_ack vram_ack;		struct synthvid_situation_update situ;		struct synthvid_situation_update_ack situ_ack;		struct synthvid_pointer_position ptr_pos;		struct synthvid_pointer_shape ptr_shape;		struct synthvid_feature_change feature_chg;		struct synthvid_dirt dirt;		struct synthvid_supported_resolution_req resolution_req;		struct synthvid_supported_resolution_resp resolution_resp;	};} __packed;  /* FB driver definitions and structures */#define HVFB_WIDTH 1152 /* default screen width */#define HVFB_HEIGHT 864 /* default screen height */#define HVFB_WIDTH_MIN 640#define HVFB_HEIGHT_MIN 480 #define RING_BUFSIZE (256 * 1024)#define VSP_TIMEOUT (10 * HZ)#define HVFB_UPDATE_DELAY (HZ / 20)#define HVFB_ONDEMAND_THROTTLE (HZ / 20) struct hvfb_par {	struct fb_info *info;	struct resource *mem;	bool fb_ready; /* fb device is ready */	struct completion wait;	u32 synthvid_version; 	struct delayed_work dwork;	bool update;	bool update_saved; /* The value of 'update' before hibernation */ 	u32 pseudo_palette[16];	u8 init_buf[MAX_VMBUS_PKT_SIZE];	u8 recv_buf[MAX_VMBUS_PKT_SIZE]; 	/* If true, the VSC notifies the VSP on every framebuffer change */	bool synchronous_fb; 	/* If true, need to copy from deferred IO mem to framebuffer mem */	bool need_docopy; 	struct notifier_block hvfb_panic_nb; 	/* Memory for deferred IO and frame buffer itself */	unsigned char *dio_vp;	unsigned char *mmio_vp;	phys_addr_t mmio_pp; 	/* Dirty rectangle, protected by delayed_refresh_lock */	int x1, y1, x2, y2;	bool delayed_refresh;	spinlock_t delayed_refresh_lock;}; static uint screen_width = HVFB_WIDTH;static uint screen_height = HVFB_HEIGHT;static uint screen_width_max = HVFB_WIDTH;static uint screen_height_max = HVFB_HEIGHT;static uint screen_depth;static uint screen_fb_size;static uint dio_fb_size; /* FB size for deferred IO */ /* Send message to Hyper-V host */static inline int synthvid_send(struct hv_device *hdev,				struct synthvid_msg *msg){	static atomic64_t request_id = ATOMIC64_INIT(0);	int ret; 	msg->pipe_hdr.type = PIPE_MSG_DATA;	msg->pipe_hdr.size = msg->vid_hdr.size; 	ret = vmbus_sendpacket(hdev->channel, msg,			       msg->vid_hdr.size + sizeof(struct pipe_msg_hdr),			       atomic64_inc_return(&request_id),			       VM_PKT_DATA_INBAND, 0); 	if (ret)		pr_err_ratelimited("Unable to send packet via vmbus; error %d\n", ret); 	return ret;}  /* Send screen resolution info to host */static int synthvid_send_situ(struct hv_device *hdev){	struct fb_info *info = hv_get_drvdata(hdev);	struct synthvid_msg msg; 	if (!info)		return -ENODEV; 	memset(&msg, 0, sizeof(struct synthvid_msg)); 	msg.vid_hdr.type = SYNTHVID_SITUATION_UPDATE;	msg.vid_hdr.size = sizeof(struct synthvid_msg_hdr) +		sizeof(struct synthvid_situation_update);	msg.situ.user_ctx = 0;	msg.situ.video_output_count = 1;	msg.situ.video_output[0].active = 1;	msg.situ.video_output[0].vram_offset = 0;	msg.situ.video_output[0].depth_bits = info->var.bits_per_pixel;	msg.situ.video_output[0].width_pixels = info->var.xres;	msg.situ.video_output[0].height_pixels = info->var.yres;	msg.situ.video_output[0].pitch_bytes = info->fix.line_length; 	synthvid_send(hdev, &msg); 	return 0;} /* Send mouse pointer info to host */static int synthvid_send_ptr(struct hv_device *hdev){	struct synthvid_msg msg; 	memset(&msg, 0, sizeof(struct synthvid_msg));	msg.vid_hdr.type = SYNTHVID_POINTER_POSITION;	msg.vid_hdr.size = sizeof(struct synthvid_msg_hdr) +		sizeof(struct synthvid_pointer_position);	msg.ptr_pos.is_visible = 1;	msg.ptr_pos.video_output = 0;	msg.ptr_pos.image_x = 0;	msg.ptr_pos.image_y = 0;	synthvid_send(hdev, &msg); 	memset(&msg, 0, sizeof(struct synthvid_msg));	msg.vid_hdr.type = SYNTHVID_POINTER_SHAPE;	msg.vid_hdr.size = sizeof(struct synthvid_msg_hdr) +		sizeof(struct synthvid_pointer_shape);	msg.ptr_shape.part_idx = CURSOR_COMPLETE;	msg.ptr_shape.is_argb = 1;	msg.ptr_shape.width = 1;	msg.ptr_shape.height = 1;	msg.ptr_shape.hot_x = 0;	msg.ptr_shape.hot_y = 0;	msg.ptr_shape.data[0] = 0;	msg.ptr_shape.data[1] = 1;	msg.ptr_shape.data[2] = 1;	msg.ptr_shape.data[3] = 1;	synthvid_send(hdev, &msg); 	return 0;} /* Send updated screen area (dirty rectangle) location to host */static intsynthvid_update(struct fb_info *info, int x1, int y1, int x2, int y2){	struct hv_device *hdev = device_to_hv_device(info->device);	struct synthvid_msg msg; 	memset(&msg, 0, sizeof(struct synthvid_msg));	if (x2 == INT_MAX)		x2 = info->var.xres;	if (y2 == INT_MAX)		y2 = info->var.yres; 	msg.vid_hdr.type = SYNTHVID_DIRT;	msg.vid_hdr.size = sizeof(struct synthvid_msg_hdr) +		sizeof(struct synthvid_dirt);	msg.dirt.video_output = 0;	msg.dirt.dirt_count = 1;	msg.dirt.rect[0].x1 = (x1 > x2) ? 0 : x1;	msg.dirt.rect[0].y1 = (y1 > y2) ? 0 : y1;	msg.dirt.rect[0].x2 =		(x2 < x1 || x2 > info->var.xres) ? info->var.xres : x2;	msg.dirt.rect[0].y2 =		(y2 < y1 || y2 > info->var.yres) ? info->var.yres : y2; 	synthvid_send(hdev, &msg); 	return 0;} static void hvfb_docopy(struct hvfb_par *par,			unsigned long offset,			unsigned long size){	if (!par || !par->mmio_vp || !par->dio_vp || !par->fb_ready ||	    size == 0 || offset >= dio_fb_size)		return; 	if (offset + size > dio_fb_size)		size = dio_fb_size - offset; 	memcpy(par->mmio_vp + offset, par->dio_vp + offset, size);} /* Deferred IO callback */static void synthvid_deferred_io(struct fb_info *p,				 struct list_head *pagelist){	struct hvfb_par *par = p->par;	struct page *page;	unsigned long start, end;	int y1, y2, miny, maxy; 	miny = INT_MAX;	maxy = 0; 	/*	 * Merge dirty pages. It is possible that last page cross	 * over the end of frame buffer row yres. This is taken care of	 * in synthvid_update function by clamping the y2	 * value to yres.	 */	list_for_each_entry(page, pagelist, lru) {		start = page->index << PAGE_SHIFT;		end = start + PAGE_SIZE - 1;		y1 = start / p->fix.line_length;		y2 = end / p->fix.line_length;		miny = min_t(int, miny, y1);		maxy = max_t(int, maxy, y2); 		/* Copy from dio space to mmio address */		if (par->fb_ready && par->need_docopy)			hvfb_docopy(par, start, PAGE_SIZE);	} 	if (par->fb_ready && par->update)		synthvid_update(p, 0, miny, p->var.xres, maxy + 1);} static struct fb_deferred_io synthvid_defio = {	.delay		= HZ / 20,	.deferred_io	= synthvid_deferred_io,}; /* * Actions on received messages from host: * Complete the wait event. * Or, reply with screen and cursor info. */static void synthvid_recv_sub(struct hv_device *hdev){	struct fb_info *info = hv_get_drvdata(hdev);	struct hvfb_par *par;	struct synthvid_msg *msg; 	if (!info)		return; 	par = info->par;	msg = (struct synthvid_msg *)par->recv_buf; 	/* Complete the wait event */	if (msg->vid_hdr.type == SYNTHVID_VERSION_RESPONSE ||	    msg->vid_hdr.type == SYNTHVID_RESOLUTION_RESPONSE ||	    msg->vid_hdr.type == SYNTHVID_VRAM_LOCATION_ACK) {		memcpy(par->init_buf, msg, MAX_VMBUS_PKT_SIZE);		complete(&par->wait);		return;	} 	/* Reply with screen and cursor info */	if (msg->vid_hdr.type == SYNTHVID_FEATURE_CHANGE) {		if (par->fb_ready) {			synthvid_send_ptr(hdev);			synthvid_send_situ(hdev);		} 		par->update = msg->feature_chg.is_dirt_needed;		if (par->update)			schedule_delayed_work(&par->dwork, HVFB_UPDATE_DELAY);	}}

Lines 1–500 of 1434.