1 // SPDX-License-Identifier: GPL-2.0-only
3 * Copyright (c) 2012, Microsoft Corporation.
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/aperture.h>
49 #include <linux/module.h>
50 #include <linux/kernel.h>
51 #include <linux/vmalloc.h>
52 #include <linux/init.h>
53 #include <linux/completion.h>
55 #include <linux/pci.h>
56 #include <linux/panic_notifier.h>
57 #include <linux/efi.h>
58 #include <linux/console.h>
60 #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 /* Support for VERSION_WIN7 is removed. #define is retained for reference. */
67 #define SYNTHVID_VERSION_WIN7 SYNTHVID_VERSION(3, 0)
68 #define SYNTHVID_VERSION_WIN8 SYNTHVID_VERSION(3, 2)
69 #define SYNTHVID_VERSION_WIN10 SYNTHVID_VERSION(3, 5)
71 #define SYNTHVID_VER_GET_MAJOR(ver) (ver & 0x0000ffff)
72 #define SYNTHVID_VER_GET_MINOR(ver) ((ver & 0xffff0000) >> 16)
74 #define SYNTHVID_DEPTH_WIN8 32
75 #define SYNTHVID_FB_SIZE_WIN8 (8 * 1024 * 1024)
85 u32 size; /* size of message after this field */
89 enum synthvid_msg_type {
91 SYNTHVID_VERSION_REQUEST = 1,
92 SYNTHVID_VERSION_RESPONSE = 2,
93 SYNTHVID_VRAM_LOCATION = 3,
94 SYNTHVID_VRAM_LOCATION_ACK = 4,
95 SYNTHVID_SITUATION_UPDATE = 5,
96 SYNTHVID_SITUATION_UPDATE_ACK = 6,
97 SYNTHVID_POINTER_POSITION = 7,
98 SYNTHVID_POINTER_SHAPE = 8,
99 SYNTHVID_FEATURE_CHANGE = 9,
101 SYNTHVID_RESOLUTION_REQUEST = 13,
102 SYNTHVID_RESOLUTION_RESPONSE = 14,
107 #define SYNTHVID_EDID_BLOCK_SIZE 128
108 #define SYNTHVID_MAX_RESOLUTION_COUNT 64
110 struct hvd_screen_info {
115 struct synthvid_msg_hdr {
117 u32 size; /* size of this header + payload after this field*/
120 struct synthvid_version_req {
124 struct synthvid_version_resp {
127 u8 max_video_outputs;
130 struct synthvid_supported_resolution_req {
131 u8 maximum_resolution_count;
134 struct synthvid_supported_resolution_resp {
135 u8 edid_block[SYNTHVID_EDID_BLOCK_SIZE];
137 u8 default_resolution_index;
139 struct hvd_screen_info
140 supported_resolution[SYNTHVID_MAX_RESOLUTION_COUNT];
143 struct synthvid_vram_location {
145 u8 is_vram_gpa_specified;
149 struct synthvid_vram_location_ack {
153 struct video_output_situation {
162 struct synthvid_situation_update {
164 u8 video_output_count;
165 struct video_output_situation video_output[1];
168 struct synthvid_situation_update_ack {
172 struct synthvid_pointer_position {
180 #define CURSOR_MAX_X 96
181 #define CURSOR_MAX_Y 96
182 #define CURSOR_ARGB_PIXEL_SIZE 4
183 #define CURSOR_MAX_SIZE (CURSOR_MAX_X * CURSOR_MAX_Y * CURSOR_ARGB_PIXEL_SIZE)
184 #define CURSOR_COMPLETE (-1)
186 struct synthvid_pointer_shape {
189 u32 width; /* CURSOR_MAX_X at most */
190 u32 height; /* CURSOR_MAX_Y at most */
191 u32 hot_x; /* hotspot relative to upper-left of pointer image */
196 struct synthvid_feature_change {
198 u8 is_ptr_pos_needed;
199 u8 is_ptr_shape_needed;
204 s32 x1, y1; /* top left corner */
205 s32 x2, y2; /* bottom right corner, exclusive */
208 struct synthvid_dirt {
214 struct synthvid_msg {
215 struct pipe_msg_hdr pipe_hdr;
216 struct synthvid_msg_hdr vid_hdr;
218 struct synthvid_version_req ver_req;
219 struct synthvid_version_resp ver_resp;
220 struct synthvid_vram_location vram;
221 struct synthvid_vram_location_ack vram_ack;
222 struct synthvid_situation_update situ;
223 struct synthvid_situation_update_ack situ_ack;
224 struct synthvid_pointer_position ptr_pos;
225 struct synthvid_pointer_shape ptr_shape;
226 struct synthvid_feature_change feature_chg;
227 struct synthvid_dirt dirt;
228 struct synthvid_supported_resolution_req resolution_req;
229 struct synthvid_supported_resolution_resp resolution_resp;
234 /* FB driver definitions and structures */
235 #define HVFB_WIDTH 1152 /* default screen width */
236 #define HVFB_HEIGHT 864 /* default screen height */
237 #define HVFB_WIDTH_MIN 640
238 #define HVFB_HEIGHT_MIN 480
240 #define RING_BUFSIZE (256 * 1024)
241 #define VSP_TIMEOUT (10 * HZ)
242 #define HVFB_UPDATE_DELAY (HZ / 20)
243 #define HVFB_ONDEMAND_THROTTLE (HZ / 20)
246 struct fb_info *info;
247 struct resource *mem;
248 bool fb_ready; /* fb device is ready */
249 struct completion wait;
250 u32 synthvid_version;
252 struct delayed_work dwork;
254 bool update_saved; /* The value of 'update' before hibernation */
256 u32 pseudo_palette[16];
257 u8 init_buf[MAX_VMBUS_PKT_SIZE];
258 u8 recv_buf[MAX_VMBUS_PKT_SIZE];
260 /* If true, the VSC notifies the VSP on every framebuffer change */
263 /* If true, need to copy from deferred IO mem to framebuffer mem */
266 struct notifier_block hvfb_panic_nb;
268 /* Memory for deferred IO and frame buffer itself */
269 unsigned char *dio_vp;
270 unsigned char *mmio_vp;
273 /* Dirty rectangle, protected by delayed_refresh_lock */
275 bool delayed_refresh;
276 spinlock_t delayed_refresh_lock;
279 static uint screen_width = HVFB_WIDTH;
280 static uint screen_height = HVFB_HEIGHT;
281 static uint screen_depth;
282 static uint screen_fb_size;
283 static uint dio_fb_size; /* FB size for deferred IO */
285 /* Send message to Hyper-V host */
286 static inline int synthvid_send(struct hv_device *hdev,
287 struct synthvid_msg *msg)
289 static atomic64_t request_id = ATOMIC64_INIT(0);
292 msg->pipe_hdr.type = PIPE_MSG_DATA;
293 msg->pipe_hdr.size = msg->vid_hdr.size;
295 ret = vmbus_sendpacket(hdev->channel, msg,
296 msg->vid_hdr.size + sizeof(struct pipe_msg_hdr),
297 atomic64_inc_return(&request_id),
298 VM_PKT_DATA_INBAND, 0);
301 pr_err_ratelimited("Unable to send packet via vmbus; error %d\n", ret);
307 /* Send screen resolution info to host */
308 static int synthvid_send_situ(struct hv_device *hdev)
310 struct fb_info *info = hv_get_drvdata(hdev);
311 struct synthvid_msg msg;
316 memset(&msg, 0, sizeof(struct synthvid_msg));
318 msg.vid_hdr.type = SYNTHVID_SITUATION_UPDATE;
319 msg.vid_hdr.size = sizeof(struct synthvid_msg_hdr) +
320 sizeof(struct synthvid_situation_update);
321 msg.situ.user_ctx = 0;
322 msg.situ.video_output_count = 1;
323 msg.situ.video_output[0].active = 1;
324 msg.situ.video_output[0].vram_offset = 0;
325 msg.situ.video_output[0].depth_bits = info->var.bits_per_pixel;
326 msg.situ.video_output[0].width_pixels = info->var.xres;
327 msg.situ.video_output[0].height_pixels = info->var.yres;
328 msg.situ.video_output[0].pitch_bytes = info->fix.line_length;
330 synthvid_send(hdev, &msg);
335 /* Send mouse pointer info to host */
336 static int synthvid_send_ptr(struct hv_device *hdev)
338 struct synthvid_msg msg;
340 memset(&msg, 0, sizeof(struct synthvid_msg));
341 msg.vid_hdr.type = SYNTHVID_POINTER_POSITION;
342 msg.vid_hdr.size = sizeof(struct synthvid_msg_hdr) +
343 sizeof(struct synthvid_pointer_position);
344 msg.ptr_pos.is_visible = 1;
345 msg.ptr_pos.video_output = 0;
346 msg.ptr_pos.image_x = 0;
347 msg.ptr_pos.image_y = 0;
348 synthvid_send(hdev, &msg);
350 memset(&msg, 0, sizeof(struct synthvid_msg));
351 msg.vid_hdr.type = SYNTHVID_POINTER_SHAPE;
352 msg.vid_hdr.size = sizeof(struct synthvid_msg_hdr) +
353 sizeof(struct synthvid_pointer_shape);
354 msg.ptr_shape.part_idx = CURSOR_COMPLETE;
355 msg.ptr_shape.is_argb = 1;
356 msg.ptr_shape.width = 1;
357 msg.ptr_shape.height = 1;
358 msg.ptr_shape.hot_x = 0;
359 msg.ptr_shape.hot_y = 0;
360 msg.ptr_shape.data[0] = 0;
361 msg.ptr_shape.data[1] = 1;
362 msg.ptr_shape.data[2] = 1;
363 msg.ptr_shape.data[3] = 1;
364 synthvid_send(hdev, &msg);
369 /* Send updated screen area (dirty rectangle) location to host */
371 synthvid_update(struct fb_info *info, int x1, int y1, int x2, int y2)
373 struct hv_device *hdev = device_to_hv_device(info->device);
374 struct synthvid_msg msg;
376 memset(&msg, 0, sizeof(struct synthvid_msg));
382 msg.vid_hdr.type = SYNTHVID_DIRT;
383 msg.vid_hdr.size = sizeof(struct synthvid_msg_hdr) +
384 sizeof(struct synthvid_dirt);
385 msg.dirt.video_output = 0;
386 msg.dirt.dirt_count = 1;
387 msg.dirt.rect[0].x1 = (x1 > x2) ? 0 : x1;
388 msg.dirt.rect[0].y1 = (y1 > y2) ? 0 : y1;
389 msg.dirt.rect[0].x2 =
390 (x2 < x1 || x2 > info->var.xres) ? info->var.xres : x2;
391 msg.dirt.rect[0].y2 =
392 (y2 < y1 || y2 > info->var.yres) ? info->var.yres : y2;
394 synthvid_send(hdev, &msg);
399 static void hvfb_docopy(struct hvfb_par *par,
400 unsigned long offset,
403 if (!par || !par->mmio_vp || !par->dio_vp || !par->fb_ready ||
404 size == 0 || offset >= dio_fb_size)
407 if (offset + size > dio_fb_size)
408 size = dio_fb_size - offset;
410 memcpy(par->mmio_vp + offset, par->dio_vp + offset, size);
413 /* Deferred IO callback */
414 static void synthvid_deferred_io(struct fb_info *p, struct list_head *pagereflist)
416 struct hvfb_par *par = p->par;
417 struct fb_deferred_io_pageref *pageref;
418 unsigned long start, end;
419 int y1, y2, miny, maxy;
425 * Merge dirty pages. It is possible that last page cross
426 * over the end of frame buffer row yres. This is taken care of
427 * in synthvid_update function by clamping the y2
430 list_for_each_entry(pageref, pagereflist, list) {
431 start = pageref->offset;
432 end = start + PAGE_SIZE - 1;
433 y1 = start / p->fix.line_length;
434 y2 = end / p->fix.line_length;
435 miny = min_t(int, miny, y1);
436 maxy = max_t(int, maxy, y2);
438 /* Copy from dio space to mmio address */
439 if (par->fb_ready && par->need_docopy)
440 hvfb_docopy(par, start, PAGE_SIZE);
443 if (par->fb_ready && par->update)
444 synthvid_update(p, 0, miny, p->var.xres, maxy + 1);
447 static struct fb_deferred_io synthvid_defio = {
449 .deferred_io = synthvid_deferred_io,
453 * Actions on received messages from host:
454 * Complete the wait event.
455 * Or, reply with screen and cursor info.
457 static void synthvid_recv_sub(struct hv_device *hdev)
459 struct fb_info *info = hv_get_drvdata(hdev);
460 struct hvfb_par *par;
461 struct synthvid_msg *msg;
467 msg = (struct synthvid_msg *)par->recv_buf;
469 /* Complete the wait event */
470 if (msg->vid_hdr.type == SYNTHVID_VERSION_RESPONSE ||
471 msg->vid_hdr.type == SYNTHVID_RESOLUTION_RESPONSE ||
472 msg->vid_hdr.type == SYNTHVID_VRAM_LOCATION_ACK) {
473 memcpy(par->init_buf, msg, MAX_VMBUS_PKT_SIZE);
474 complete(&par->wait);
478 /* Reply with screen and cursor info */
479 if (msg->vid_hdr.type == SYNTHVID_FEATURE_CHANGE) {
481 synthvid_send_ptr(hdev);
482 synthvid_send_situ(hdev);
485 par->update = msg->feature_chg.is_dirt_needed;
487 schedule_delayed_work(&par->dwork, HVFB_UPDATE_DELAY);
491 /* Receive callback for messages from the host */
492 static void synthvid_receive(void *ctx)
494 struct hv_device *hdev = ctx;
495 struct fb_info *info = hv_get_drvdata(hdev);
496 struct hvfb_par *par;
497 struct synthvid_msg *recv_buf;
506 recv_buf = (struct synthvid_msg *)par->recv_buf;
509 ret = vmbus_recvpacket(hdev->channel, recv_buf,
511 &bytes_recvd, &req_id);
512 if (bytes_recvd > 0 &&
513 recv_buf->pipe_hdr.type == PIPE_MSG_DATA)
514 synthvid_recv_sub(hdev);
515 } while (bytes_recvd > 0 && ret == 0);
518 /* Check if the ver1 version is equal or greater than ver2 */
519 static inline bool synthvid_ver_ge(u32 ver1, u32 ver2)
521 if (SYNTHVID_VER_GET_MAJOR(ver1) > SYNTHVID_VER_GET_MAJOR(ver2) ||
522 (SYNTHVID_VER_GET_MAJOR(ver1) == SYNTHVID_VER_GET_MAJOR(ver2) &&
523 SYNTHVID_VER_GET_MINOR(ver1) >= SYNTHVID_VER_GET_MINOR(ver2)))
529 /* Check synthetic video protocol version with the host */
530 static int synthvid_negotiate_ver(struct hv_device *hdev, u32 ver)
532 struct fb_info *info = hv_get_drvdata(hdev);
533 struct hvfb_par *par = info->par;
534 struct synthvid_msg *msg = (struct synthvid_msg *)par->init_buf;
538 memset(msg, 0, sizeof(struct synthvid_msg));
539 msg->vid_hdr.type = SYNTHVID_VERSION_REQUEST;
540 msg->vid_hdr.size = sizeof(struct synthvid_msg_hdr) +
541 sizeof(struct synthvid_version_req);
542 msg->ver_req.version = ver;
543 synthvid_send(hdev, msg);
545 t = wait_for_completion_timeout(&par->wait, VSP_TIMEOUT);
547 pr_err("Time out on waiting version response\n");
551 if (!msg->ver_resp.is_accepted) {
556 par->synthvid_version = ver;
557 pr_info("Synthvid Version major %d, minor %d\n",
558 SYNTHVID_VER_GET_MAJOR(ver), SYNTHVID_VER_GET_MINOR(ver));
564 /* Get current resolution from the host */
565 static int synthvid_get_supported_resolution(struct hv_device *hdev)
567 struct fb_info *info = hv_get_drvdata(hdev);
568 struct hvfb_par *par = info->par;
569 struct synthvid_msg *msg = (struct synthvid_msg *)par->init_buf;
574 memset(msg, 0, sizeof(struct synthvid_msg));
575 msg->vid_hdr.type = SYNTHVID_RESOLUTION_REQUEST;
576 msg->vid_hdr.size = sizeof(struct synthvid_msg_hdr) +
577 sizeof(struct synthvid_supported_resolution_req);
579 msg->resolution_req.maximum_resolution_count =
580 SYNTHVID_MAX_RESOLUTION_COUNT;
581 synthvid_send(hdev, msg);
583 t = wait_for_completion_timeout(&par->wait, VSP_TIMEOUT);
585 pr_err("Time out on waiting resolution response\n");
590 if (msg->resolution_resp.resolution_count == 0) {
591 pr_err("No supported resolutions\n");
596 index = msg->resolution_resp.default_resolution_index;
597 if (index >= msg->resolution_resp.resolution_count) {
598 pr_err("Invalid resolution index: %d\n", index);
604 msg->resolution_resp.supported_resolution[index].width;
606 msg->resolution_resp.supported_resolution[index].height;
612 /* Connect to VSP (Virtual Service Provider) on host */
613 static int synthvid_connect_vsp(struct hv_device *hdev)
615 struct fb_info *info = hv_get_drvdata(hdev);
616 struct hvfb_par *par = info->par;
619 ret = vmbus_open(hdev->channel, RING_BUFSIZE, RING_BUFSIZE,
620 NULL, 0, synthvid_receive, hdev);
622 pr_err("Unable to open vmbus channel\n");
626 /* Negotiate the protocol version with host */
627 switch (vmbus_proto_version) {
629 case VERSION_WIN10_V5:
630 ret = synthvid_negotiate_ver(hdev, SYNTHVID_VERSION_WIN10);
636 ret = synthvid_negotiate_ver(hdev, SYNTHVID_VERSION_WIN8);
639 ret = synthvid_negotiate_ver(hdev, SYNTHVID_VERSION_WIN10);
644 pr_err("Synthetic video device version not accepted\n");
648 screen_depth = SYNTHVID_DEPTH_WIN8;
649 if (synthvid_ver_ge(par->synthvid_version, SYNTHVID_VERSION_WIN10)) {
650 ret = synthvid_get_supported_resolution(hdev);
652 pr_info("Failed to get supported resolution from host, use default\n");
655 screen_fb_size = hdev->channel->offermsg.offer.
656 mmio_megabytes * 1024 * 1024;
661 vmbus_close(hdev->channel);
665 /* Send VRAM and Situation messages to the host */
666 static int synthvid_send_config(struct hv_device *hdev)
668 struct fb_info *info = hv_get_drvdata(hdev);
669 struct hvfb_par *par = info->par;
670 struct synthvid_msg *msg = (struct synthvid_msg *)par->init_buf;
674 /* Send VRAM location */
675 memset(msg, 0, sizeof(struct synthvid_msg));
676 msg->vid_hdr.type = SYNTHVID_VRAM_LOCATION;
677 msg->vid_hdr.size = sizeof(struct synthvid_msg_hdr) +
678 sizeof(struct synthvid_vram_location);
679 msg->vram.user_ctx = msg->vram.vram_gpa = par->mmio_pp;
680 msg->vram.is_vram_gpa_specified = 1;
681 synthvid_send(hdev, msg);
683 t = wait_for_completion_timeout(&par->wait, VSP_TIMEOUT);
685 pr_err("Time out on waiting vram location ack\n");
689 if (msg->vram_ack.user_ctx != par->mmio_pp) {
690 pr_err("Unable to set VRAM location\n");
695 /* Send pointer and situation update */
696 synthvid_send_ptr(hdev);
697 synthvid_send_situ(hdev);
705 * Delayed work callback:
706 * It is scheduled to call whenever update request is received and it has
707 * not been called in last HVFB_ONDEMAND_THROTTLE time interval.
709 static void hvfb_update_work(struct work_struct *w)
711 struct hvfb_par *par = container_of(w, struct hvfb_par, dwork.work);
712 struct fb_info *info = par->info;
717 spin_lock_irqsave(&par->delayed_refresh_lock, flags);
718 /* Reset the request flag */
719 par->delayed_refresh = false;
721 /* Store the dirty rectangle to local variables */
727 /* Clear dirty rectangle */
728 par->x1 = par->y1 = INT_MAX;
729 par->x2 = par->y2 = 0;
731 spin_unlock_irqrestore(&par->delayed_refresh_lock, flags);
733 if (x1 > info->var.xres || x2 > info->var.xres ||
734 y1 > info->var.yres || y2 > info->var.yres || x2 <= x1)
737 /* Copy the dirty rectangle to frame buffer memory */
738 if (par->need_docopy)
739 for (j = y1; j < y2; j++)
741 j * info->fix.line_length +
742 (x1 * screen_depth / 8),
743 (x2 - x1) * screen_depth / 8);
746 if (par->fb_ready && par->update)
747 synthvid_update(info, x1, y1, x2, y2);
751 * Control the on-demand refresh frequency. It schedules a delayed
752 * screen update if it has not yet.
754 static void hvfb_ondemand_refresh_throttle(struct hvfb_par *par,
755 int x1, int y1, int w, int h)
761 spin_lock_irqsave(&par->delayed_refresh_lock, flags);
763 /* Merge dirty rectangle */
764 par->x1 = min_t(int, par->x1, x1);
765 par->y1 = min_t(int, par->y1, y1);
766 par->x2 = max_t(int, par->x2, x2);
767 par->y2 = max_t(int, par->y2, y2);
769 /* Schedule a delayed screen update if not yet */
770 if (par->delayed_refresh == false) {
771 schedule_delayed_work(&par->dwork,
772 HVFB_ONDEMAND_THROTTLE);
773 par->delayed_refresh = true;
776 spin_unlock_irqrestore(&par->delayed_refresh_lock, flags);
779 static int hvfb_on_panic(struct notifier_block *nb,
780 unsigned long e, void *p)
782 struct hv_device *hdev;
783 struct hvfb_par *par;
784 struct fb_info *info;
786 par = container_of(nb, struct hvfb_par, hvfb_panic_nb);
788 hdev = device_to_hv_device(info->device);
790 if (hv_ringbuffer_spinlock_busy(hdev->channel))
793 par->synchronous_fb = true;
794 if (par->need_docopy)
795 hvfb_docopy(par, 0, dio_fb_size);
796 synthvid_update(info, 0, 0, INT_MAX, INT_MAX);
801 /* Framebuffer operation handlers */
803 static int hvfb_check_var(struct fb_var_screeninfo *var, struct fb_info *info)
805 if (var->xres < HVFB_WIDTH_MIN || var->yres < HVFB_HEIGHT_MIN ||
806 var->xres > screen_width || var->yres > screen_height ||
807 var->bits_per_pixel != screen_depth)
810 var->xres_virtual = var->xres;
811 var->yres_virtual = var->yres;
816 static int hvfb_set_par(struct fb_info *info)
818 struct hv_device *hdev = device_to_hv_device(info->device);
820 return synthvid_send_situ(hdev);
824 static inline u32 chan_to_field(u32 chan, struct fb_bitfield *bf)
826 return ((chan & 0xffff) >> (16 - bf->length)) << bf->offset;
829 static int hvfb_setcolreg(unsigned regno, unsigned red, unsigned green,
830 unsigned blue, unsigned transp, struct fb_info *info)
832 u32 *pal = info->pseudo_palette;
837 pal[regno] = chan_to_field(red, &info->var.red)
838 | chan_to_field(green, &info->var.green)
839 | chan_to_field(blue, &info->var.blue)
840 | chan_to_field(transp, &info->var.transp);
845 static int hvfb_blank(int blank, struct fb_info *info)
847 return 1; /* get fb_blank to set the colormap to all black */
850 static void hvfb_cfb_fillrect(struct fb_info *p,
851 const struct fb_fillrect *rect)
853 struct hvfb_par *par = p->par;
855 cfb_fillrect(p, rect);
856 if (par->synchronous_fb)
857 synthvid_update(p, 0, 0, INT_MAX, INT_MAX);
859 hvfb_ondemand_refresh_throttle(par, rect->dx, rect->dy,
860 rect->width, rect->height);
863 static void hvfb_cfb_copyarea(struct fb_info *p,
864 const struct fb_copyarea *area)
866 struct hvfb_par *par = p->par;
868 cfb_copyarea(p, area);
869 if (par->synchronous_fb)
870 synthvid_update(p, 0, 0, INT_MAX, INT_MAX);
872 hvfb_ondemand_refresh_throttle(par, area->dx, area->dy,
873 area->width, area->height);
876 static void hvfb_cfb_imageblit(struct fb_info *p,
877 const struct fb_image *image)
879 struct hvfb_par *par = p->par;
881 cfb_imageblit(p, image);
882 if (par->synchronous_fb)
883 synthvid_update(p, 0, 0, INT_MAX, INT_MAX);
885 hvfb_ondemand_refresh_throttle(par, image->dx, image->dy,
886 image->width, image->height);
889 static const struct fb_ops hvfb_ops = {
890 .owner = THIS_MODULE,
891 .fb_check_var = hvfb_check_var,
892 .fb_set_par = hvfb_set_par,
893 .fb_setcolreg = hvfb_setcolreg,
894 .fb_fillrect = hvfb_cfb_fillrect,
895 .fb_copyarea = hvfb_cfb_copyarea,
896 .fb_imageblit = hvfb_cfb_imageblit,
897 .fb_blank = hvfb_blank,
898 .fb_mmap = fb_deferred_io_mmap,
902 /* Get options from kernel paramenter "video=" */
903 static void hvfb_get_option(struct fb_info *info)
905 struct hvfb_par *par = info->par;
906 char *opt = NULL, *p;
909 if (fb_get_options(KBUILD_MODNAME, &opt) || !opt || !*opt)
912 p = strsep(&opt, "x");
913 if (!*p || kstrtouint(p, 0, &x) ||
914 !opt || !*opt || kstrtouint(opt, 0, &y)) {
915 pr_err("Screen option is invalid: skipped\n");
919 if (x < HVFB_WIDTH_MIN || y < HVFB_HEIGHT_MIN ||
920 (synthvid_ver_ge(par->synthvid_version, SYNTHVID_VERSION_WIN10) &&
921 (x * y * screen_depth / 8 > screen_fb_size)) ||
922 (par->synthvid_version == SYNTHVID_VERSION_WIN8 &&
923 x * y * screen_depth / 8 > SYNTHVID_FB_SIZE_WIN8)) {
924 pr_err("Screen resolution option is out of range: skipped\n");
934 * Allocate enough contiguous physical memory.
935 * Return physical address if succeeded or -1 if failed.
937 static phys_addr_t hvfb_get_phymem(struct hv_device *hdev,
938 unsigned int request_size)
940 struct page *page = NULL;
941 dma_addr_t dma_handle;
943 phys_addr_t paddr = 0;
944 unsigned int order = get_order(request_size);
946 if (request_size == 0)
949 if (order < MAX_ORDER) {
950 /* Call alloc_pages if the size is less than 2^MAX_ORDER */
951 page = alloc_pages(GFP_KERNEL | __GFP_ZERO, order);
955 paddr = (page_to_pfn(page) << PAGE_SHIFT);
957 /* Allocate from CMA */
958 hdev->device.coherent_dma_mask = DMA_BIT_MASK(64);
960 vmem = dma_alloc_coherent(&hdev->device,
961 round_up(request_size, PAGE_SIZE),
963 GFP_KERNEL | __GFP_NOWARN);
968 paddr = virt_to_phys(vmem);
974 /* Release contiguous physical memory */
975 static void hvfb_release_phymem(struct hv_device *hdev,
976 phys_addr_t paddr, unsigned int size)
978 unsigned int order = get_order(size);
980 if (order < MAX_ORDER)
981 __free_pages(pfn_to_page(paddr >> PAGE_SHIFT), order);
983 dma_free_coherent(&hdev->device,
984 round_up(size, PAGE_SIZE),
990 /* Get framebuffer memory from Hyper-V video pci space */
991 static int hvfb_getmem(struct hv_device *hdev, struct fb_info *info)
993 struct hvfb_par *par = info->par;
994 struct pci_dev *pdev = NULL;
995 void __iomem *fb_virt;
996 int gen2vm = efi_enabled(EFI_BOOT);
1000 info->apertures = alloc_apertures(1);
1001 if (!info->apertures)
1005 pdev = pci_get_device(PCI_VENDOR_ID_MICROSOFT,
1006 PCI_DEVICE_ID_HYPERV_VIDEO, NULL);
1008 pr_err("Unable to find PCI Hyper-V video\n");
1012 info->apertures->ranges[0].base = pci_resource_start(pdev, 0);
1013 info->apertures->ranges[0].size = pci_resource_len(pdev, 0);
1016 * For Gen 1 VM, we can directly use the contiguous memory
1017 * from VM. If we succeed, deferred IO happens directly
1018 * on this allocated framebuffer memory, avoiding extra
1021 paddr = hvfb_get_phymem(hdev, screen_fb_size);
1022 if (paddr != (phys_addr_t) -1) {
1023 par->mmio_pp = paddr;
1024 par->mmio_vp = par->dio_vp = __va(paddr);
1026 info->fix.smem_start = paddr;
1027 info->fix.smem_len = screen_fb_size;
1028 info->screen_base = par->mmio_vp;
1029 info->screen_size = screen_fb_size;
1031 par->need_docopy = false;
1034 pr_info("Unable to allocate enough contiguous physical memory on Gen 1 VM. Using MMIO instead.\n");
1036 info->apertures->ranges[0].base = screen_info.lfb_base;
1037 info->apertures->ranges[0].size = screen_info.lfb_size;
1041 * Cannot use the contiguous physical memory.
1042 * Allocate mmio space for framebuffer.
1045 screen_width * screen_height * screen_depth / 8;
1047 ret = vmbus_allocate_mmio(&par->mem, hdev, 0, -1,
1048 screen_fb_size, 0x100000, true);
1050 pr_err("Unable to allocate framebuffer memory\n");
1055 * Map the VRAM cacheable for performance. This is also required for
1056 * VM Connect to display properly for ARM64 Linux VM, as the host also
1057 * maps the VRAM cacheable.
1059 fb_virt = ioremap_cache(par->mem->start, screen_fb_size);
1063 /* Allocate memory for deferred IO */
1064 par->dio_vp = vzalloc(round_up(dio_fb_size, PAGE_SIZE));
1065 if (par->dio_vp == NULL)
1068 /* Physical address of FB device */
1069 par->mmio_pp = par->mem->start;
1070 /* Virtual address of FB device */
1071 par->mmio_vp = (unsigned char *) fb_virt;
1073 info->fix.smem_start = par->mem->start;
1074 info->fix.smem_len = dio_fb_size;
1075 info->screen_base = par->dio_vp;
1076 info->screen_size = dio_fb_size;
1079 aperture_remove_conflicting_devices(info->apertures->ranges[0].base,
1080 info->apertures->ranges[0].size,
1081 false, KBUILD_MODNAME);
1084 /* framebuffer is reallocated, clear screen_info to avoid misuse from kexec */
1085 screen_info.lfb_size = 0;
1086 screen_info.lfb_base = 0;
1087 screen_info.orig_video_isVGA = 0;
1097 vmbus_free_mmio(par->mem->start, screen_fb_size);
1106 /* Release the framebuffer */
1107 static void hvfb_putmem(struct hv_device *hdev, struct fb_info *info)
1109 struct hvfb_par *par = info->par;
1111 if (par->need_docopy) {
1113 iounmap(info->screen_base);
1114 vmbus_free_mmio(par->mem->start, screen_fb_size);
1116 hvfb_release_phymem(hdev, info->fix.smem_start,
1124 static int hvfb_probe(struct hv_device *hdev,
1125 const struct hv_vmbus_device_id *dev_id)
1127 struct fb_info *info;
1128 struct hvfb_par *par;
1131 info = framebuffer_alloc(sizeof(struct hvfb_par), &hdev->device);
1137 par->fb_ready = false;
1138 par->need_docopy = true;
1139 init_completion(&par->wait);
1140 INIT_DELAYED_WORK(&par->dwork, hvfb_update_work);
1142 par->delayed_refresh = false;
1143 spin_lock_init(&par->delayed_refresh_lock);
1144 par->x1 = par->y1 = INT_MAX;
1145 par->x2 = par->y2 = 0;
1147 /* Connect to VSP */
1148 hv_set_drvdata(hdev, info);
1149 ret = synthvid_connect_vsp(hdev);
1151 pr_err("Unable to connect to VSP\n");
1155 hvfb_get_option(info);
1156 pr_info("Screen resolution: %dx%d, Color depth: %d, Frame buffer size: %d\n",
1157 screen_width, screen_height, screen_depth, screen_fb_size);
1159 ret = hvfb_getmem(hdev, info);
1161 pr_err("No memory for framebuffer\n");
1165 /* Set up fb_info */
1166 info->flags = FBINFO_DEFAULT;
1168 info->var.xres_virtual = info->var.xres = screen_width;
1169 info->var.yres_virtual = info->var.yres = screen_height;
1170 info->var.bits_per_pixel = screen_depth;
1172 if (info->var.bits_per_pixel == 16) {
1173 info->var.red = (struct fb_bitfield){11, 5, 0};
1174 info->var.green = (struct fb_bitfield){5, 6, 0};
1175 info->var.blue = (struct fb_bitfield){0, 5, 0};
1176 info->var.transp = (struct fb_bitfield){0, 0, 0};
1178 info->var.red = (struct fb_bitfield){16, 8, 0};
1179 info->var.green = (struct fb_bitfield){8, 8, 0};
1180 info->var.blue = (struct fb_bitfield){0, 8, 0};
1181 info->var.transp = (struct fb_bitfield){24, 8, 0};
1184 info->var.activate = FB_ACTIVATE_NOW;
1185 info->var.height = -1;
1186 info->var.width = -1;
1187 info->var.vmode = FB_VMODE_NONINTERLACED;
1189 strcpy(info->fix.id, KBUILD_MODNAME);
1190 info->fix.type = FB_TYPE_PACKED_PIXELS;
1191 info->fix.visual = FB_VISUAL_TRUECOLOR;
1192 info->fix.line_length = screen_width * screen_depth / 8;
1193 info->fix.accel = FB_ACCEL_NONE;
1195 info->fbops = &hvfb_ops;
1196 info->pseudo_palette = par->pseudo_palette;
1198 /* Initialize deferred IO */
1199 info->fbdefio = &synthvid_defio;
1200 fb_deferred_io_init(info);
1202 /* Send config to host */
1203 ret = synthvid_send_config(hdev);
1207 ret = register_framebuffer(info);
1209 pr_err("Unable to register framebuffer\n");
1213 par->fb_ready = true;
1215 par->synchronous_fb = false;
1218 * We need to be sure this panic notifier runs _before_ the
1219 * vmbus disconnect, so order it by priority. It must execute
1220 * before the function hv_panic_vmbus_unload() [drivers/hv/vmbus_drv.c],
1221 * which is almost at the end of list, with priority = INT_MIN + 1.
1223 par->hvfb_panic_nb.notifier_call = hvfb_on_panic;
1224 par->hvfb_panic_nb.priority = INT_MIN + 10,
1225 atomic_notifier_chain_register(&panic_notifier_list,
1226 &par->hvfb_panic_nb);
1231 fb_deferred_io_cleanup(info);
1232 hvfb_putmem(hdev, info);
1234 vmbus_close(hdev->channel);
1236 cancel_delayed_work_sync(&par->dwork);
1237 hv_set_drvdata(hdev, NULL);
1238 framebuffer_release(info);
1243 static int hvfb_remove(struct hv_device *hdev)
1245 struct fb_info *info = hv_get_drvdata(hdev);
1246 struct hvfb_par *par = info->par;
1248 atomic_notifier_chain_unregister(&panic_notifier_list,
1249 &par->hvfb_panic_nb);
1251 par->update = false;
1252 par->fb_ready = false;
1254 fb_deferred_io_cleanup(info);
1256 unregister_framebuffer(info);
1257 cancel_delayed_work_sync(&par->dwork);
1259 vmbus_close(hdev->channel);
1260 hv_set_drvdata(hdev, NULL);
1262 hvfb_putmem(hdev, info);
1263 framebuffer_release(info);
1268 static int hvfb_suspend(struct hv_device *hdev)
1270 struct fb_info *info = hv_get_drvdata(hdev);
1271 struct hvfb_par *par = info->par;
1275 /* 1 means do suspend */
1276 fb_set_suspend(info, 1);
1278 cancel_delayed_work_sync(&par->dwork);
1279 cancel_delayed_work_sync(&info->deferred_work);
1281 par->update_saved = par->update;
1282 par->update = false;
1283 par->fb_ready = false;
1285 vmbus_close(hdev->channel);
1292 static int hvfb_resume(struct hv_device *hdev)
1294 struct fb_info *info = hv_get_drvdata(hdev);
1295 struct hvfb_par *par = info->par;
1300 ret = synthvid_connect_vsp(hdev);
1304 ret = synthvid_send_config(hdev);
1306 vmbus_close(hdev->channel);
1310 par->fb_ready = true;
1311 par->update = par->update_saved;
1313 schedule_delayed_work(&info->deferred_work, info->fbdefio->delay);
1314 schedule_delayed_work(&par->dwork, HVFB_UPDATE_DELAY);
1316 /* 0 means do resume */
1317 fb_set_suspend(info, 0);
1326 static const struct pci_device_id pci_stub_id_table[] = {
1328 .vendor = PCI_VENDOR_ID_MICROSOFT,
1329 .device = PCI_DEVICE_ID_HYPERV_VIDEO,
1331 { /* end of list */ }
1334 static const struct hv_vmbus_device_id id_table[] = {
1335 /* Synthetic Video Device GUID */
1340 MODULE_DEVICE_TABLE(pci, pci_stub_id_table);
1341 MODULE_DEVICE_TABLE(vmbus, id_table);
1343 static struct hv_driver hvfb_drv = {
1344 .name = KBUILD_MODNAME,
1345 .id_table = id_table,
1346 .probe = hvfb_probe,
1347 .remove = hvfb_remove,
1348 .suspend = hvfb_suspend,
1349 .resume = hvfb_resume,
1351 .probe_type = PROBE_PREFER_ASYNCHRONOUS,
1355 static int hvfb_pci_stub_probe(struct pci_dev *pdev,
1356 const struct pci_device_id *ent)
1361 static void hvfb_pci_stub_remove(struct pci_dev *pdev)
1365 static struct pci_driver hvfb_pci_stub_driver = {
1366 .name = KBUILD_MODNAME,
1367 .id_table = pci_stub_id_table,
1368 .probe = hvfb_pci_stub_probe,
1369 .remove = hvfb_pci_stub_remove,
1371 .probe_type = PROBE_PREFER_ASYNCHRONOUS,
1375 static int __init hvfb_drv_init(void)
1379 if (fb_modesetting_disabled("hyper_fb"))
1382 ret = vmbus_driver_register(&hvfb_drv);
1386 ret = pci_register_driver(&hvfb_pci_stub_driver);
1388 vmbus_driver_unregister(&hvfb_drv);
1395 static void __exit hvfb_drv_exit(void)
1397 pci_unregister_driver(&hvfb_pci_stub_driver);
1398 vmbus_driver_unregister(&hvfb_drv);
1401 module_init(hvfb_drv_init);
1402 module_exit(hvfb_drv_exit);
1404 MODULE_LICENSE("GPL");
1405 MODULE_DESCRIPTION("Microsoft Hyper-V Synthetic Video Frame Buffer Driver");