1 // SPDX-License-Identifier: GPL-2.0-only
3 * Copyright (c) 2012, Microsoft Corporation.
6 * Haiyang Zhang <haiyangz@microsoft.com>
10 * Hyper-V Synthetic Video Frame Buffer Driver
12 * This is the driver for the Hyper-V Synthetic Video, which supports
13 * screen resolution up to Full HD 1920x1080 with 32 bit color on Windows
14 * Server 2012, and 1600x1200 with 16 bit color on Windows Server 2008 R2
17 * It also solves the double mouse cursor issue of the emulated video mode.
19 * The default screen resolution is 1152x864, which may be changed by a
21 * video=hyperv_fb:<width>x<height>
22 * For example: video=hyperv_fb:1280x1024
24 * Portrait orientation is also supported:
25 * For example: video=hyperv_fb:864x1152
27 * When a Windows 10 RS5+ host is used, the virtual machine screen
28 * resolution is obtained from the host. The "video=hyperv_fb" option is
29 * not needed, but still can be used to overwrite what the host specifies.
30 * The VM resolution on the host could be set by executing the powershell
31 * "set-vmvideo" command. For example
32 * set-vmvideo -vmname name -horizontalresolution:1920 \
33 * -verticalresolution:1200 -resolutiontype single
35 * Gen 1 VMs also support direct using VM's physical memory for framebuffer.
36 * It could improve the efficiency and performance for framebuffer and VM.
37 * This requires to allocate contiguous physical memory from Linux kernel's
38 * CMA memory allocator. To enable this, supply a kernel parameter to give
39 * enough memory space to CMA allocator for framebuffer. For example:
41 * This gives 130MB memory to CMA allocator that can be allocated to
42 * framebuffer. For reference, 8K resolution (7680x4320) takes about
46 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
48 #include <linux/module.h>
49 #include <linux/kernel.h>
50 #include <linux/vmalloc.h>
51 #include <linux/init.h>
52 #include <linux/completion.h>
54 #include <linux/pci.h>
55 #include <linux/panic_notifier.h>
56 #include <linux/efi.h>
57 #include <linux/console.h>
59 #include <linux/hyperv.h>
62 /* Hyper-V Synthetic Video Protocol definitions and structures */
63 #define MAX_VMBUS_PKT_SIZE 0x4000
65 #define SYNTHVID_VERSION(major, minor) ((minor) << 16 | (major))
66 #define SYNTHVID_VERSION_WIN7 SYNTHVID_VERSION(3, 0)
67 #define SYNTHVID_VERSION_WIN8 SYNTHVID_VERSION(3, 2)
68 #define SYNTHVID_VERSION_WIN10 SYNTHVID_VERSION(3, 5)
70 #define SYNTHVID_VER_GET_MAJOR(ver) (ver & 0x0000ffff)
71 #define SYNTHVID_VER_GET_MINOR(ver) ((ver & 0xffff0000) >> 16)
73 #define SYNTHVID_DEPTH_WIN7 16
74 #define SYNTHVID_DEPTH_WIN8 32
76 #define SYNTHVID_FB_SIZE_WIN7 (4 * 1024 * 1024)
77 #define SYNTHVID_WIDTH_MAX_WIN7 1600
78 #define SYNTHVID_HEIGHT_MAX_WIN7 1200
80 #define SYNTHVID_FB_SIZE_WIN8 (8 * 1024 * 1024)
82 #define PCI_VENDOR_ID_MICROSOFT 0x1414
83 #define PCI_DEVICE_ID_HYPERV_VIDEO 0x5353
94 u32 size; /* size of message after this field */
98 enum synthvid_msg_type {
100 SYNTHVID_VERSION_REQUEST = 1,
101 SYNTHVID_VERSION_RESPONSE = 2,
102 SYNTHVID_VRAM_LOCATION = 3,
103 SYNTHVID_VRAM_LOCATION_ACK = 4,
104 SYNTHVID_SITUATION_UPDATE = 5,
105 SYNTHVID_SITUATION_UPDATE_ACK = 6,
106 SYNTHVID_POINTER_POSITION = 7,
107 SYNTHVID_POINTER_SHAPE = 8,
108 SYNTHVID_FEATURE_CHANGE = 9,
110 SYNTHVID_RESOLUTION_REQUEST = 13,
111 SYNTHVID_RESOLUTION_RESPONSE = 14,
116 #define SYNTHVID_EDID_BLOCK_SIZE 128
117 #define SYNTHVID_MAX_RESOLUTION_COUNT 64
119 struct hvd_screen_info {
124 struct synthvid_msg_hdr {
126 u32 size; /* size of this header + payload after this field*/
129 struct synthvid_version_req {
133 struct synthvid_version_resp {
136 u8 max_video_outputs;
139 struct synthvid_supported_resolution_req {
140 u8 maximum_resolution_count;
143 struct synthvid_supported_resolution_resp {
144 u8 edid_block[SYNTHVID_EDID_BLOCK_SIZE];
146 u8 default_resolution_index;
148 struct hvd_screen_info
149 supported_resolution[SYNTHVID_MAX_RESOLUTION_COUNT];
152 struct synthvid_vram_location {
154 u8 is_vram_gpa_specified;
158 struct synthvid_vram_location_ack {
162 struct video_output_situation {
171 struct synthvid_situation_update {
173 u8 video_output_count;
174 struct video_output_situation video_output[1];
177 struct synthvid_situation_update_ack {
181 struct synthvid_pointer_position {
189 #define CURSOR_MAX_X 96
190 #define CURSOR_MAX_Y 96
191 #define CURSOR_ARGB_PIXEL_SIZE 4
192 #define CURSOR_MAX_SIZE (CURSOR_MAX_X * CURSOR_MAX_Y * CURSOR_ARGB_PIXEL_SIZE)
193 #define CURSOR_COMPLETE (-1)
195 struct synthvid_pointer_shape {
198 u32 width; /* CURSOR_MAX_X at most */
199 u32 height; /* CURSOR_MAX_Y at most */
200 u32 hot_x; /* hotspot relative to upper-left of pointer image */
205 struct synthvid_feature_change {
207 u8 is_ptr_pos_needed;
208 u8 is_ptr_shape_needed;
213 s32 x1, y1; /* top left corner */
214 s32 x2, y2; /* bottom right corner, exclusive */
217 struct synthvid_dirt {
223 struct synthvid_msg {
224 struct pipe_msg_hdr pipe_hdr;
225 struct synthvid_msg_hdr vid_hdr;
227 struct synthvid_version_req ver_req;
228 struct synthvid_version_resp ver_resp;
229 struct synthvid_vram_location vram;
230 struct synthvid_vram_location_ack vram_ack;
231 struct synthvid_situation_update situ;
232 struct synthvid_situation_update_ack situ_ack;
233 struct synthvid_pointer_position ptr_pos;
234 struct synthvid_pointer_shape ptr_shape;
235 struct synthvid_feature_change feature_chg;
236 struct synthvid_dirt dirt;
237 struct synthvid_supported_resolution_req resolution_req;
238 struct synthvid_supported_resolution_resp resolution_resp;
243 /* FB driver definitions and structures */
244 #define HVFB_WIDTH 1152 /* default screen width */
245 #define HVFB_HEIGHT 864 /* default screen height */
246 #define HVFB_WIDTH_MIN 640
247 #define HVFB_HEIGHT_MIN 480
249 #define RING_BUFSIZE (256 * 1024)
250 #define VSP_TIMEOUT (10 * HZ)
251 #define HVFB_UPDATE_DELAY (HZ / 20)
252 #define HVFB_ONDEMAND_THROTTLE (HZ / 20)
255 struct fb_info *info;
256 struct resource *mem;
257 bool fb_ready; /* fb device is ready */
258 struct completion wait;
259 u32 synthvid_version;
261 struct delayed_work dwork;
263 bool update_saved; /* The value of 'update' before hibernation */
265 u32 pseudo_palette[16];
266 u8 init_buf[MAX_VMBUS_PKT_SIZE];
267 u8 recv_buf[MAX_VMBUS_PKT_SIZE];
269 /* If true, the VSC notifies the VSP on every framebuffer change */
272 /* If true, need to copy from deferred IO mem to framebuffer mem */
275 struct notifier_block hvfb_panic_nb;
277 /* Memory for deferred IO and frame buffer itself */
278 unsigned char *dio_vp;
279 unsigned char *mmio_vp;
282 /* Dirty rectangle, protected by delayed_refresh_lock */
284 bool delayed_refresh;
285 spinlock_t delayed_refresh_lock;
288 static uint screen_width = HVFB_WIDTH;
289 static uint screen_height = HVFB_HEIGHT;
290 static uint screen_width_max = HVFB_WIDTH;
291 static uint screen_height_max = HVFB_HEIGHT;
292 static uint screen_depth;
293 static uint screen_fb_size;
294 static uint dio_fb_size; /* FB size for deferred IO */
296 /* Send message to Hyper-V host */
297 static inline int synthvid_send(struct hv_device *hdev,
298 struct synthvid_msg *msg)
300 static atomic64_t request_id = ATOMIC64_INIT(0);
303 msg->pipe_hdr.type = PIPE_MSG_DATA;
304 msg->pipe_hdr.size = msg->vid_hdr.size;
306 ret = vmbus_sendpacket(hdev->channel, msg,
307 msg->vid_hdr.size + sizeof(struct pipe_msg_hdr),
308 atomic64_inc_return(&request_id),
309 VM_PKT_DATA_INBAND, 0);
312 pr_err_ratelimited("Unable to send packet via vmbus; error %d\n", ret);
318 /* Send screen resolution info to host */
319 static int synthvid_send_situ(struct hv_device *hdev)
321 struct fb_info *info = hv_get_drvdata(hdev);
322 struct synthvid_msg msg;
327 memset(&msg, 0, sizeof(struct synthvid_msg));
329 msg.vid_hdr.type = SYNTHVID_SITUATION_UPDATE;
330 msg.vid_hdr.size = sizeof(struct synthvid_msg_hdr) +
331 sizeof(struct synthvid_situation_update);
332 msg.situ.user_ctx = 0;
333 msg.situ.video_output_count = 1;
334 msg.situ.video_output[0].active = 1;
335 msg.situ.video_output[0].vram_offset = 0;
336 msg.situ.video_output[0].depth_bits = info->var.bits_per_pixel;
337 msg.situ.video_output[0].width_pixels = info->var.xres;
338 msg.situ.video_output[0].height_pixels = info->var.yres;
339 msg.situ.video_output[0].pitch_bytes = info->fix.line_length;
341 synthvid_send(hdev, &msg);
346 /* Send mouse pointer info to host */
347 static int synthvid_send_ptr(struct hv_device *hdev)
349 struct synthvid_msg msg;
351 memset(&msg, 0, sizeof(struct synthvid_msg));
352 msg.vid_hdr.type = SYNTHVID_POINTER_POSITION;
353 msg.vid_hdr.size = sizeof(struct synthvid_msg_hdr) +
354 sizeof(struct synthvid_pointer_position);
355 msg.ptr_pos.is_visible = 1;
356 msg.ptr_pos.video_output = 0;
357 msg.ptr_pos.image_x = 0;
358 msg.ptr_pos.image_y = 0;
359 synthvid_send(hdev, &msg);
361 memset(&msg, 0, sizeof(struct synthvid_msg));
362 msg.vid_hdr.type = SYNTHVID_POINTER_SHAPE;
363 msg.vid_hdr.size = sizeof(struct synthvid_msg_hdr) +
364 sizeof(struct synthvid_pointer_shape);
365 msg.ptr_shape.part_idx = CURSOR_COMPLETE;
366 msg.ptr_shape.is_argb = 1;
367 msg.ptr_shape.width = 1;
368 msg.ptr_shape.height = 1;
369 msg.ptr_shape.hot_x = 0;
370 msg.ptr_shape.hot_y = 0;
371 msg.ptr_shape.data[0] = 0;
372 msg.ptr_shape.data[1] = 1;
373 msg.ptr_shape.data[2] = 1;
374 msg.ptr_shape.data[3] = 1;
375 synthvid_send(hdev, &msg);
380 /* Send updated screen area (dirty rectangle) location to host */
382 synthvid_update(struct fb_info *info, int x1, int y1, int x2, int y2)
384 struct hv_device *hdev = device_to_hv_device(info->device);
385 struct synthvid_msg msg;
387 memset(&msg, 0, sizeof(struct synthvid_msg));
393 msg.vid_hdr.type = SYNTHVID_DIRT;
394 msg.vid_hdr.size = sizeof(struct synthvid_msg_hdr) +
395 sizeof(struct synthvid_dirt);
396 msg.dirt.video_output = 0;
397 msg.dirt.dirt_count = 1;
398 msg.dirt.rect[0].x1 = (x1 > x2) ? 0 : x1;
399 msg.dirt.rect[0].y1 = (y1 > y2) ? 0 : y1;
400 msg.dirt.rect[0].x2 =
401 (x2 < x1 || x2 > info->var.xres) ? info->var.xres : x2;
402 msg.dirt.rect[0].y2 =
403 (y2 < y1 || y2 > info->var.yres) ? info->var.yres : y2;
405 synthvid_send(hdev, &msg);
410 static void hvfb_docopy(struct hvfb_par *par,
411 unsigned long offset,
414 if (!par || !par->mmio_vp || !par->dio_vp || !par->fb_ready ||
415 size == 0 || offset >= dio_fb_size)
418 if (offset + size > dio_fb_size)
419 size = dio_fb_size - offset;
421 memcpy(par->mmio_vp + offset, par->dio_vp + offset, size);
424 /* Deferred IO callback */
425 static void synthvid_deferred_io(struct fb_info *p,
426 struct list_head *pagelist)
428 struct hvfb_par *par = p->par;
430 unsigned long start, end;
431 int y1, y2, miny, maxy;
437 * Merge dirty pages. It is possible that last page cross
438 * over the end of frame buffer row yres. This is taken care of
439 * in synthvid_update function by clamping the y2
442 list_for_each_entry(page, pagelist, lru) {
443 start = page->index << PAGE_SHIFT;
444 end = start + PAGE_SIZE - 1;
445 y1 = start / p->fix.line_length;
446 y2 = end / p->fix.line_length;
447 miny = min_t(int, miny, y1);
448 maxy = max_t(int, maxy, y2);
450 /* Copy from dio space to mmio address */
451 if (par->fb_ready && par->need_docopy)
452 hvfb_docopy(par, start, PAGE_SIZE);
455 if (par->fb_ready && par->update)
456 synthvid_update(p, 0, miny, p->var.xres, maxy + 1);
459 static struct fb_deferred_io synthvid_defio = {
461 .deferred_io = synthvid_deferred_io,
465 * Actions on received messages from host:
466 * Complete the wait event.
467 * Or, reply with screen and cursor info.
469 static void synthvid_recv_sub(struct hv_device *hdev)
471 struct fb_info *info = hv_get_drvdata(hdev);
472 struct hvfb_par *par;
473 struct synthvid_msg *msg;
479 msg = (struct synthvid_msg *)par->recv_buf;
481 /* Complete the wait event */
482 if (msg->vid_hdr.type == SYNTHVID_VERSION_RESPONSE ||
483 msg->vid_hdr.type == SYNTHVID_RESOLUTION_RESPONSE ||
484 msg->vid_hdr.type == SYNTHVID_VRAM_LOCATION_ACK) {
485 memcpy(par->init_buf, msg, MAX_VMBUS_PKT_SIZE);
486 complete(&par->wait);
490 /* Reply with screen and cursor info */
491 if (msg->vid_hdr.type == SYNTHVID_FEATURE_CHANGE) {
493 synthvid_send_ptr(hdev);
494 synthvid_send_situ(hdev);
497 par->update = msg->feature_chg.is_dirt_needed;
499 schedule_delayed_work(&par->dwork, HVFB_UPDATE_DELAY);
503 /* Receive callback for messages from the host */
504 static void synthvid_receive(void *ctx)
506 struct hv_device *hdev = ctx;
507 struct fb_info *info = hv_get_drvdata(hdev);
508 struct hvfb_par *par;
509 struct synthvid_msg *recv_buf;
518 recv_buf = (struct synthvid_msg *)par->recv_buf;
521 ret = vmbus_recvpacket(hdev->channel, recv_buf,
523 &bytes_recvd, &req_id);
524 if (bytes_recvd > 0 &&
525 recv_buf->pipe_hdr.type == PIPE_MSG_DATA)
526 synthvid_recv_sub(hdev);
527 } while (bytes_recvd > 0 && ret == 0);
530 /* Check if the ver1 version is equal or greater than ver2 */
531 static inline bool synthvid_ver_ge(u32 ver1, u32 ver2)
533 if (SYNTHVID_VER_GET_MAJOR(ver1) > SYNTHVID_VER_GET_MAJOR(ver2) ||
534 (SYNTHVID_VER_GET_MAJOR(ver1) == SYNTHVID_VER_GET_MAJOR(ver2) &&
535 SYNTHVID_VER_GET_MINOR(ver1) >= SYNTHVID_VER_GET_MINOR(ver2)))
541 /* Check synthetic video protocol version with the host */
542 static int synthvid_negotiate_ver(struct hv_device *hdev, u32 ver)
544 struct fb_info *info = hv_get_drvdata(hdev);
545 struct hvfb_par *par = info->par;
546 struct synthvid_msg *msg = (struct synthvid_msg *)par->init_buf;
550 memset(msg, 0, sizeof(struct synthvid_msg));
551 msg->vid_hdr.type = SYNTHVID_VERSION_REQUEST;
552 msg->vid_hdr.size = sizeof(struct synthvid_msg_hdr) +
553 sizeof(struct synthvid_version_req);
554 msg->ver_req.version = ver;
555 synthvid_send(hdev, msg);
557 t = wait_for_completion_timeout(&par->wait, VSP_TIMEOUT);
559 pr_err("Time out on waiting version response\n");
563 if (!msg->ver_resp.is_accepted) {
568 par->synthvid_version = ver;
569 pr_info("Synthvid Version major %d, minor %d\n",
570 SYNTHVID_VER_GET_MAJOR(ver), SYNTHVID_VER_GET_MINOR(ver));
576 /* Get current resolution from the host */
577 static int synthvid_get_supported_resolution(struct hv_device *hdev)
579 struct fb_info *info = hv_get_drvdata(hdev);
580 struct hvfb_par *par = info->par;
581 struct synthvid_msg *msg = (struct synthvid_msg *)par->init_buf;
587 memset(msg, 0, sizeof(struct synthvid_msg));
588 msg->vid_hdr.type = SYNTHVID_RESOLUTION_REQUEST;
589 msg->vid_hdr.size = sizeof(struct synthvid_msg_hdr) +
590 sizeof(struct synthvid_supported_resolution_req);
592 msg->resolution_req.maximum_resolution_count =
593 SYNTHVID_MAX_RESOLUTION_COUNT;
594 synthvid_send(hdev, msg);
596 t = wait_for_completion_timeout(&par->wait, VSP_TIMEOUT);
598 pr_err("Time out on waiting resolution response\n");
603 if (msg->resolution_resp.resolution_count == 0) {
604 pr_err("No supported resolutions\n");
609 index = msg->resolution_resp.default_resolution_index;
610 if (index >= msg->resolution_resp.resolution_count) {
611 pr_err("Invalid resolution index: %d\n", index);
616 for (i = 0; i < msg->resolution_resp.resolution_count; i++) {
617 screen_width_max = max_t(unsigned int, screen_width_max,
618 msg->resolution_resp.supported_resolution[i].width);
619 screen_height_max = max_t(unsigned int, screen_height_max,
620 msg->resolution_resp.supported_resolution[i].height);
624 msg->resolution_resp.supported_resolution[index].width;
626 msg->resolution_resp.supported_resolution[index].height;
632 /* Connect to VSP (Virtual Service Provider) on host */
633 static int synthvid_connect_vsp(struct hv_device *hdev)
635 struct fb_info *info = hv_get_drvdata(hdev);
636 struct hvfb_par *par = info->par;
639 ret = vmbus_open(hdev->channel, RING_BUFSIZE, RING_BUFSIZE,
640 NULL, 0, synthvid_receive, hdev);
642 pr_err("Unable to open vmbus channel\n");
646 /* Negotiate the protocol version with host */
647 switch (vmbus_proto_version) {
649 case VERSION_WIN10_V5:
650 ret = synthvid_negotiate_ver(hdev, SYNTHVID_VERSION_WIN10);
656 ret = synthvid_negotiate_ver(hdev, SYNTHVID_VERSION_WIN8);
662 ret = synthvid_negotiate_ver(hdev, SYNTHVID_VERSION_WIN7);
665 ret = synthvid_negotiate_ver(hdev, SYNTHVID_VERSION_WIN10);
670 pr_err("Synthetic video device version not accepted\n");
674 if (par->synthvid_version == SYNTHVID_VERSION_WIN7)
675 screen_depth = SYNTHVID_DEPTH_WIN7;
677 screen_depth = SYNTHVID_DEPTH_WIN8;
679 if (synthvid_ver_ge(par->synthvid_version, SYNTHVID_VERSION_WIN10)) {
680 ret = synthvid_get_supported_resolution(hdev);
682 pr_info("Failed to get supported resolution from host, use default\n");
685 screen_fb_size = hdev->channel->offermsg.offer.
686 mmio_megabytes * 1024 * 1024;
691 vmbus_close(hdev->channel);
695 /* Send VRAM and Situation messages to the host */
696 static int synthvid_send_config(struct hv_device *hdev)
698 struct fb_info *info = hv_get_drvdata(hdev);
699 struct hvfb_par *par = info->par;
700 struct synthvid_msg *msg = (struct synthvid_msg *)par->init_buf;
704 /* Send VRAM location */
705 memset(msg, 0, sizeof(struct synthvid_msg));
706 msg->vid_hdr.type = SYNTHVID_VRAM_LOCATION;
707 msg->vid_hdr.size = sizeof(struct synthvid_msg_hdr) +
708 sizeof(struct synthvid_vram_location);
709 msg->vram.user_ctx = msg->vram.vram_gpa = par->mmio_pp;
710 msg->vram.is_vram_gpa_specified = 1;
711 synthvid_send(hdev, msg);
713 t = wait_for_completion_timeout(&par->wait, VSP_TIMEOUT);
715 pr_err("Time out on waiting vram location ack\n");
719 if (msg->vram_ack.user_ctx != par->mmio_pp) {
720 pr_err("Unable to set VRAM location\n");
725 /* Send pointer and situation update */
726 synthvid_send_ptr(hdev);
727 synthvid_send_situ(hdev);
735 * Delayed work callback:
736 * It is scheduled to call whenever update request is received and it has
737 * not been called in last HVFB_ONDEMAND_THROTTLE time interval.
739 static void hvfb_update_work(struct work_struct *w)
741 struct hvfb_par *par = container_of(w, struct hvfb_par, dwork.work);
742 struct fb_info *info = par->info;
747 spin_lock_irqsave(&par->delayed_refresh_lock, flags);
748 /* Reset the request flag */
749 par->delayed_refresh = false;
751 /* Store the dirty rectangle to local variables */
757 /* Clear dirty rectangle */
758 par->x1 = par->y1 = INT_MAX;
759 par->x2 = par->y2 = 0;
761 spin_unlock_irqrestore(&par->delayed_refresh_lock, flags);
763 if (x1 > info->var.xres || x2 > info->var.xres ||
764 y1 > info->var.yres || y2 > info->var.yres || x2 <= x1)
767 /* Copy the dirty rectangle to frame buffer memory */
768 if (par->need_docopy)
769 for (j = y1; j < y2; j++)
771 j * info->fix.line_length +
772 (x1 * screen_depth / 8),
773 (x2 - x1) * screen_depth / 8);
776 if (par->fb_ready && par->update)
777 synthvid_update(info, x1, y1, x2, y2);
781 * Control the on-demand refresh frequency. It schedules a delayed
782 * screen update if it has not yet.
784 static void hvfb_ondemand_refresh_throttle(struct hvfb_par *par,
785 int x1, int y1, int w, int h)
791 spin_lock_irqsave(&par->delayed_refresh_lock, flags);
793 /* Merge dirty rectangle */
794 par->x1 = min_t(int, par->x1, x1);
795 par->y1 = min_t(int, par->y1, y1);
796 par->x2 = max_t(int, par->x2, x2);
797 par->y2 = max_t(int, par->y2, y2);
799 /* Schedule a delayed screen update if not yet */
800 if (par->delayed_refresh == false) {
801 schedule_delayed_work(&par->dwork,
802 HVFB_ONDEMAND_THROTTLE);
803 par->delayed_refresh = true;
806 spin_unlock_irqrestore(&par->delayed_refresh_lock, flags);
809 static int hvfb_on_panic(struct notifier_block *nb,
810 unsigned long e, void *p)
812 struct hvfb_par *par;
813 struct fb_info *info;
815 par = container_of(nb, struct hvfb_par, hvfb_panic_nb);
816 par->synchronous_fb = true;
818 if (par->need_docopy)
819 hvfb_docopy(par, 0, dio_fb_size);
820 synthvid_update(info, 0, 0, INT_MAX, INT_MAX);
825 /* Framebuffer operation handlers */
827 static int hvfb_check_var(struct fb_var_screeninfo *var, struct fb_info *info)
829 if (var->xres < HVFB_WIDTH_MIN || var->yres < HVFB_HEIGHT_MIN ||
830 var->xres > screen_width || var->yres > screen_height ||
831 var->bits_per_pixel != screen_depth)
834 var->xres_virtual = var->xres;
835 var->yres_virtual = var->yres;
840 static int hvfb_set_par(struct fb_info *info)
842 struct hv_device *hdev = device_to_hv_device(info->device);
844 return synthvid_send_situ(hdev);
848 static inline u32 chan_to_field(u32 chan, struct fb_bitfield *bf)
850 return ((chan & 0xffff) >> (16 - bf->length)) << bf->offset;
853 static int hvfb_setcolreg(unsigned regno, unsigned red, unsigned green,
854 unsigned blue, unsigned transp, struct fb_info *info)
856 u32 *pal = info->pseudo_palette;
861 pal[regno] = chan_to_field(red, &info->var.red)
862 | chan_to_field(green, &info->var.green)
863 | chan_to_field(blue, &info->var.blue)
864 | chan_to_field(transp, &info->var.transp);
869 static int hvfb_blank(int blank, struct fb_info *info)
871 return 1; /* get fb_blank to set the colormap to all black */
874 static void hvfb_cfb_fillrect(struct fb_info *p,
875 const struct fb_fillrect *rect)
877 struct hvfb_par *par = p->par;
879 cfb_fillrect(p, rect);
880 if (par->synchronous_fb)
881 synthvid_update(p, 0, 0, INT_MAX, INT_MAX);
883 hvfb_ondemand_refresh_throttle(par, rect->dx, rect->dy,
884 rect->width, rect->height);
887 static void hvfb_cfb_copyarea(struct fb_info *p,
888 const struct fb_copyarea *area)
890 struct hvfb_par *par = p->par;
892 cfb_copyarea(p, area);
893 if (par->synchronous_fb)
894 synthvid_update(p, 0, 0, INT_MAX, INT_MAX);
896 hvfb_ondemand_refresh_throttle(par, area->dx, area->dy,
897 area->width, area->height);
900 static void hvfb_cfb_imageblit(struct fb_info *p,
901 const struct fb_image *image)
903 struct hvfb_par *par = p->par;
905 cfb_imageblit(p, image);
906 if (par->synchronous_fb)
907 synthvid_update(p, 0, 0, INT_MAX, INT_MAX);
909 hvfb_ondemand_refresh_throttle(par, image->dx, image->dy,
910 image->width, image->height);
913 static const struct fb_ops hvfb_ops = {
914 .owner = THIS_MODULE,
915 .fb_check_var = hvfb_check_var,
916 .fb_set_par = hvfb_set_par,
917 .fb_setcolreg = hvfb_setcolreg,
918 .fb_fillrect = hvfb_cfb_fillrect,
919 .fb_copyarea = hvfb_cfb_copyarea,
920 .fb_imageblit = hvfb_cfb_imageblit,
921 .fb_blank = hvfb_blank,
925 /* Get options from kernel paramenter "video=" */
926 static void hvfb_get_option(struct fb_info *info)
928 struct hvfb_par *par = info->par;
929 char *opt = NULL, *p;
932 if (fb_get_options(KBUILD_MODNAME, &opt) || !opt || !*opt)
935 p = strsep(&opt, "x");
936 if (!*p || kstrtouint(p, 0, &x) ||
937 !opt || !*opt || kstrtouint(opt, 0, &y)) {
938 pr_err("Screen option is invalid: skipped\n");
942 if (x < HVFB_WIDTH_MIN || y < HVFB_HEIGHT_MIN ||
943 (synthvid_ver_ge(par->synthvid_version, SYNTHVID_VERSION_WIN10) &&
944 (x > screen_width_max || y > screen_height_max)) ||
945 (par->synthvid_version == SYNTHVID_VERSION_WIN8 &&
946 x * y * screen_depth / 8 > SYNTHVID_FB_SIZE_WIN8) ||
947 (par->synthvid_version == SYNTHVID_VERSION_WIN7 &&
948 (x > SYNTHVID_WIDTH_MAX_WIN7 || y > SYNTHVID_HEIGHT_MAX_WIN7))) {
949 pr_err("Screen resolution option is out of range: skipped\n");
959 * Allocate enough contiguous physical memory.
960 * Return physical address if succeeded or -1 if failed.
962 static phys_addr_t hvfb_get_phymem(struct hv_device *hdev,
963 unsigned int request_size)
965 struct page *page = NULL;
966 dma_addr_t dma_handle;
968 phys_addr_t paddr = 0;
969 unsigned int order = get_order(request_size);
971 if (request_size == 0)
974 if (order < MAX_ORDER) {
975 /* Call alloc_pages if the size is less than 2^MAX_ORDER */
976 page = alloc_pages(GFP_KERNEL | __GFP_ZERO, order);
980 paddr = (page_to_pfn(page) << PAGE_SHIFT);
982 /* Allocate from CMA */
983 hdev->device.coherent_dma_mask = DMA_BIT_MASK(64);
985 vmem = dma_alloc_coherent(&hdev->device,
986 round_up(request_size, PAGE_SIZE),
988 GFP_KERNEL | __GFP_NOWARN);
993 paddr = virt_to_phys(vmem);
999 /* Release contiguous physical memory */
1000 static void hvfb_release_phymem(struct hv_device *hdev,
1001 phys_addr_t paddr, unsigned int size)
1003 unsigned int order = get_order(size);
1005 if (order < MAX_ORDER)
1006 __free_pages(pfn_to_page(paddr >> PAGE_SHIFT), order);
1008 dma_free_coherent(&hdev->device,
1009 round_up(size, PAGE_SIZE),
1010 phys_to_virt(paddr),
1015 /* Get framebuffer memory from Hyper-V video pci space */
1016 static int hvfb_getmem(struct hv_device *hdev, struct fb_info *info)
1018 struct hvfb_par *par = info->par;
1019 struct pci_dev *pdev = NULL;
1020 void __iomem *fb_virt;
1021 int gen2vm = efi_enabled(EFI_BOOT);
1022 resource_size_t pot_start, pot_end;
1026 info->apertures = alloc_apertures(1);
1027 if (!info->apertures)
1031 pdev = pci_get_device(PCI_VENDOR_ID_MICROSOFT,
1032 PCI_DEVICE_ID_HYPERV_VIDEO, NULL);
1034 pr_err("Unable to find PCI Hyper-V video\n");
1038 info->apertures->ranges[0].base = pci_resource_start(pdev, 0);
1039 info->apertures->ranges[0].size = pci_resource_len(pdev, 0);
1042 * For Gen 1 VM, we can directly use the contiguous memory
1043 * from VM. If we succeed, deferred IO happens directly
1044 * on this allocated framebuffer memory, avoiding extra
1047 paddr = hvfb_get_phymem(hdev, screen_fb_size);
1048 if (paddr != (phys_addr_t) -1) {
1049 par->mmio_pp = paddr;
1050 par->mmio_vp = par->dio_vp = __va(paddr);
1052 info->fix.smem_start = paddr;
1053 info->fix.smem_len = screen_fb_size;
1054 info->screen_base = par->mmio_vp;
1055 info->screen_size = screen_fb_size;
1057 par->need_docopy = false;
1060 pr_info("Unable to allocate enough contiguous physical memory on Gen 1 VM. Using MMIO instead.\n");
1062 info->apertures->ranges[0].base = screen_info.lfb_base;
1063 info->apertures->ranges[0].size = screen_info.lfb_size;
1067 * Cannot use the contiguous physical memory.
1068 * Allocate mmio space for framebuffer.
1071 screen_width * screen_height * screen_depth / 8;
1077 if (!(pci_resource_flags(pdev, 0) & IORESOURCE_MEM) ||
1078 pci_resource_len(pdev, 0) < screen_fb_size) {
1079 pr_err("Resource not available or (0x%lx < 0x%lx)\n",
1080 (unsigned long) pci_resource_len(pdev, 0),
1081 (unsigned long) screen_fb_size);
1085 pot_end = pci_resource_end(pdev, 0);
1086 pot_start = pot_end - screen_fb_size + 1;
1089 ret = vmbus_allocate_mmio(&par->mem, hdev, pot_start, pot_end,
1090 screen_fb_size, 0x100000, true);
1092 pr_err("Unable to allocate framebuffer memory\n");
1097 * Map the VRAM cacheable for performance. This is also required for
1098 * VM Connect to display properly for ARM64 Linux VM, as the host also
1099 * maps the VRAM cacheable.
1101 fb_virt = ioremap_cache(par->mem->start, screen_fb_size);
1105 /* Allocate memory for deferred IO */
1106 par->dio_vp = vzalloc(round_up(dio_fb_size, PAGE_SIZE));
1107 if (par->dio_vp == NULL)
1110 /* Physical address of FB device */
1111 par->mmio_pp = par->mem->start;
1112 /* Virtual address of FB device */
1113 par->mmio_vp = (unsigned char *) fb_virt;
1115 info->fix.smem_start = par->mem->start;
1116 info->fix.smem_len = dio_fb_size;
1117 info->screen_base = par->dio_vp;
1118 info->screen_size = dio_fb_size;
1121 remove_conflicting_framebuffers(info->apertures,
1122 KBUILD_MODNAME, false);
1125 /* framebuffer is reallocated, clear screen_info to avoid misuse from kexec */
1126 screen_info.lfb_size = 0;
1127 screen_info.lfb_base = 0;
1128 screen_info.orig_video_isVGA = 0;
1138 vmbus_free_mmio(par->mem->start, screen_fb_size);
1147 /* Release the framebuffer */
1148 static void hvfb_putmem(struct hv_device *hdev, struct fb_info *info)
1150 struct hvfb_par *par = info->par;
1152 if (par->need_docopy) {
1154 iounmap(info->screen_base);
1155 vmbus_free_mmio(par->mem->start, screen_fb_size);
1157 hvfb_release_phymem(hdev, info->fix.smem_start,
1165 static int hvfb_probe(struct hv_device *hdev,
1166 const struct hv_vmbus_device_id *dev_id)
1168 struct fb_info *info;
1169 struct hvfb_par *par;
1172 info = framebuffer_alloc(sizeof(struct hvfb_par), &hdev->device);
1178 par->fb_ready = false;
1179 par->need_docopy = true;
1180 init_completion(&par->wait);
1181 INIT_DELAYED_WORK(&par->dwork, hvfb_update_work);
1183 par->delayed_refresh = false;
1184 spin_lock_init(&par->delayed_refresh_lock);
1185 par->x1 = par->y1 = INT_MAX;
1186 par->x2 = par->y2 = 0;
1188 /* Connect to VSP */
1189 hv_set_drvdata(hdev, info);
1190 ret = synthvid_connect_vsp(hdev);
1192 pr_err("Unable to connect to VSP\n");
1196 hvfb_get_option(info);
1197 pr_info("Screen resolution: %dx%d, Color depth: %d\n",
1198 screen_width, screen_height, screen_depth);
1200 ret = hvfb_getmem(hdev, info);
1202 pr_err("No memory for framebuffer\n");
1206 /* Set up fb_info */
1207 info->flags = FBINFO_DEFAULT;
1209 info->var.xres_virtual = info->var.xres = screen_width;
1210 info->var.yres_virtual = info->var.yres = screen_height;
1211 info->var.bits_per_pixel = screen_depth;
1213 if (info->var.bits_per_pixel == 16) {
1214 info->var.red = (struct fb_bitfield){11, 5, 0};
1215 info->var.green = (struct fb_bitfield){5, 6, 0};
1216 info->var.blue = (struct fb_bitfield){0, 5, 0};
1217 info->var.transp = (struct fb_bitfield){0, 0, 0};
1219 info->var.red = (struct fb_bitfield){16, 8, 0};
1220 info->var.green = (struct fb_bitfield){8, 8, 0};
1221 info->var.blue = (struct fb_bitfield){0, 8, 0};
1222 info->var.transp = (struct fb_bitfield){24, 8, 0};
1225 info->var.activate = FB_ACTIVATE_NOW;
1226 info->var.height = -1;
1227 info->var.width = -1;
1228 info->var.vmode = FB_VMODE_NONINTERLACED;
1230 strcpy(info->fix.id, KBUILD_MODNAME);
1231 info->fix.type = FB_TYPE_PACKED_PIXELS;
1232 info->fix.visual = FB_VISUAL_TRUECOLOR;
1233 info->fix.line_length = screen_width * screen_depth / 8;
1234 info->fix.accel = FB_ACCEL_NONE;
1236 info->fbops = &hvfb_ops;
1237 info->pseudo_palette = par->pseudo_palette;
1239 /* Initialize deferred IO */
1240 info->fbdefio = &synthvid_defio;
1241 fb_deferred_io_init(info);
1243 /* Send config to host */
1244 ret = synthvid_send_config(hdev);
1248 ret = register_framebuffer(info);
1250 pr_err("Unable to register framebuffer\n");
1254 par->fb_ready = true;
1256 par->synchronous_fb = false;
1257 par->hvfb_panic_nb.notifier_call = hvfb_on_panic;
1258 atomic_notifier_chain_register(&panic_notifier_list,
1259 &par->hvfb_panic_nb);
1264 fb_deferred_io_cleanup(info);
1265 hvfb_putmem(hdev, info);
1267 vmbus_close(hdev->channel);
1269 cancel_delayed_work_sync(&par->dwork);
1270 hv_set_drvdata(hdev, NULL);
1271 framebuffer_release(info);
1276 static int hvfb_remove(struct hv_device *hdev)
1278 struct fb_info *info = hv_get_drvdata(hdev);
1279 struct hvfb_par *par = info->par;
1281 atomic_notifier_chain_unregister(&panic_notifier_list,
1282 &par->hvfb_panic_nb);
1284 par->update = false;
1285 par->fb_ready = false;
1287 fb_deferred_io_cleanup(info);
1289 unregister_framebuffer(info);
1290 cancel_delayed_work_sync(&par->dwork);
1292 vmbus_close(hdev->channel);
1293 hv_set_drvdata(hdev, NULL);
1295 hvfb_putmem(hdev, info);
1296 framebuffer_release(info);
1301 static int hvfb_suspend(struct hv_device *hdev)
1303 struct fb_info *info = hv_get_drvdata(hdev);
1304 struct hvfb_par *par = info->par;
1308 /* 1 means do suspend */
1309 fb_set_suspend(info, 1);
1311 cancel_delayed_work_sync(&par->dwork);
1312 cancel_delayed_work_sync(&info->deferred_work);
1314 par->update_saved = par->update;
1315 par->update = false;
1316 par->fb_ready = false;
1318 vmbus_close(hdev->channel);
1325 static int hvfb_resume(struct hv_device *hdev)
1327 struct fb_info *info = hv_get_drvdata(hdev);
1328 struct hvfb_par *par = info->par;
1333 ret = synthvid_connect_vsp(hdev);
1337 ret = synthvid_send_config(hdev);
1339 vmbus_close(hdev->channel);
1343 par->fb_ready = true;
1344 par->update = par->update_saved;
1346 schedule_delayed_work(&info->deferred_work, info->fbdefio->delay);
1347 schedule_delayed_work(&par->dwork, HVFB_UPDATE_DELAY);
1349 /* 0 means do resume */
1350 fb_set_suspend(info, 0);
1359 static const struct pci_device_id pci_stub_id_table[] = {
1361 .vendor = PCI_VENDOR_ID_MICROSOFT,
1362 .device = PCI_DEVICE_ID_HYPERV_VIDEO,
1364 { /* end of list */ }
1367 static const struct hv_vmbus_device_id id_table[] = {
1368 /* Synthetic Video Device GUID */
1373 MODULE_DEVICE_TABLE(pci, pci_stub_id_table);
1374 MODULE_DEVICE_TABLE(vmbus, id_table);
1376 static struct hv_driver hvfb_drv = {
1377 .name = KBUILD_MODNAME,
1378 .id_table = id_table,
1379 .probe = hvfb_probe,
1380 .remove = hvfb_remove,
1381 .suspend = hvfb_suspend,
1382 .resume = hvfb_resume,
1384 .probe_type = PROBE_PREFER_ASYNCHRONOUS,
1388 static int hvfb_pci_stub_probe(struct pci_dev *pdev,
1389 const struct pci_device_id *ent)
1394 static void hvfb_pci_stub_remove(struct pci_dev *pdev)
1398 static struct pci_driver hvfb_pci_stub_driver = {
1399 .name = KBUILD_MODNAME,
1400 .id_table = pci_stub_id_table,
1401 .probe = hvfb_pci_stub_probe,
1402 .remove = hvfb_pci_stub_remove,
1404 .probe_type = PROBE_PREFER_ASYNCHRONOUS,
1408 static int __init hvfb_drv_init(void)
1412 ret = vmbus_driver_register(&hvfb_drv);
1416 ret = pci_register_driver(&hvfb_pci_stub_driver);
1418 vmbus_driver_unregister(&hvfb_drv);
1425 static void __exit hvfb_drv_exit(void)
1427 pci_unregister_driver(&hvfb_pci_stub_driver);
1428 vmbus_driver_unregister(&hvfb_drv);
1431 module_init(hvfb_drv_init);
1432 module_exit(hvfb_drv_exit);
1434 MODULE_LICENSE("GPL");
1435 MODULE_DESCRIPTION("Microsoft Hyper-V Synthetic Video Frame Buffer Driver");