2 * vga_switcheroo.c - Support for laptop with dual GPU using one set of outputs
4 * Copyright (c) 2010 Red Hat Inc.
5 * Author : Dave Airlie <airlied@redhat.com>
7 * Copyright (c) 2015 Lukas Wunner <lukas@wunner.de>
9 * Permission is hereby granted, free of charge, to any person obtaining a
10 * copy of this software and associated documentation files (the "Software"),
11 * to deal in the Software without restriction, including without limitation
12 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
13 * and/or sell copies of the Software, and to permit persons to whom the
14 * Software is furnished to do so, subject to the following conditions:
16 * The above copyright notice and this permission notice (including the next
17 * paragraph) shall be included in all copies or substantial portions of the
20 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
21 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
22 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
23 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
24 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
25 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
31 #define pr_fmt(fmt) "vga_switcheroo: " fmt
33 #include <linux/console.h>
34 #include <linux/debugfs.h>
37 #include <linux/module.h>
38 #include <linux/pci.h>
39 #include <linux/pm_runtime.h>
40 #include <linux/seq_file.h>
41 #include <linux/uaccess.h>
42 #include <linux/vgaarb.h>
43 #include <linux/vga_switcheroo.h>
48 * vga_switcheroo is the Linux subsystem for laptop hybrid graphics.
49 * These come in two flavors:
51 * * muxed: Dual GPUs with a multiplexer chip to switch outputs between GPUs.
52 * * muxless: Dual GPUs but only one of them is connected to outputs.
53 * The other one is merely used to offload rendering, its results
54 * are copied over PCIe into the framebuffer. On Linux this is
55 * supported with DRI PRIME.
57 * Hybrid graphics started to appear in the late Naughties and were initially
58 * all muxed. Newer laptops moved to a muxless architecture for cost reasons.
59 * A notable exception is the MacBook Pro which continues to use a mux.
60 * Muxes come with varying capabilities: Some switch only the panel, others
61 * can also switch external displays. Some switch all display pins at once
62 * while others can switch just the DDC lines. (To allow EDID probing
63 * for the inactive GPU.) Also, muxes are often used to cut power to the
64 * discrete GPU while it is not used.
66 * DRM drivers register GPUs with vga_switcheroo, these are heretoforth called
67 * clients. The mux is called the handler. Muxless machines also register a
68 * handler to control the power state of the discrete GPU, its ->switchto
69 * callback is a no-op for obvious reasons. The discrete GPU is often equipped
70 * with an HDA controller for the HDMI/DP audio signal, this will also
71 * register as a client so that vga_switcheroo can take care of the correct
72 * suspend/resume order when changing the discrete GPU's power state. In total
73 * there can thus be up to three clients: Two vga clients (GPUs) and one audio
74 * client (on the discrete GPU). The code is mostly prepared to support
75 * machines with more than two GPUs should they become available.
76 * The GPU to which the outputs are currently switched is called the
77 * active client in vga_switcheroo parlance. The GPU not in use is the
82 * struct vga_switcheroo_client - registered client
83 * @pdev: client pci device
84 * @fb_info: framebuffer to which console is remapped on switching
85 * @pwr_state: current power state
86 * @ops: client callbacks
87 * @id: client identifier. Determining the id requires the handler,
88 * so gpus are initially assigned VGA_SWITCHEROO_UNKNOWN_ID
89 * and later given their true id in vga_switcheroo_enable()
90 * @active: whether the outputs are currently switched to this client
91 * @driver_power_control: whether power state is controlled by the driver's
92 * runtime pm. If true, writing ON and OFF to the vga_switcheroo debugfs
93 * interface is a no-op so as not to interfere with runtime pm
96 * Registered client. A client can be either a GPU or an audio device on a GPU.
97 * For audio clients, the @fb_info, @active and @driver_power_control members
100 struct vga_switcheroo_client {
101 struct pci_dev *pdev;
102 struct fb_info *fb_info;
103 enum vga_switcheroo_state pwr_state;
104 const struct vga_switcheroo_client_ops *ops;
105 enum vga_switcheroo_client_id id;
107 bool driver_power_control;
108 struct list_head list;
112 * protects access to struct vgasr_priv
114 static DEFINE_MUTEX(vgasr_mutex);
117 * struct vgasr_priv - vga_switcheroo private data
118 * @active: whether vga_switcheroo is enabled.
119 * Prerequisite is the registration of two GPUs and a handler
120 * @delayed_switch_active: whether a delayed switch is pending
121 * @delayed_client_id: client to which a delayed switch is pending
122 * @debugfs_root: directory for vga_switcheroo debugfs interface
123 * @switch_file: file for vga_switcheroo debugfs interface
124 * @registered_clients: number of registered GPUs
125 * (counting only vga clients, not audio clients)
126 * @clients: list of registered clients
127 * @handler: registered handler
129 * vga_switcheroo private data. Currently only one vga_switcheroo instance
130 * per system is supported.
134 bool delayed_switch_active;
135 enum vga_switcheroo_client_id delayed_client_id;
137 struct dentry *debugfs_root;
138 struct dentry *switch_file;
140 int registered_clients;
141 struct list_head clients;
143 struct vga_switcheroo_handler *handler;
146 #define ID_BIT_AUDIO 0x100
147 #define client_is_audio(c) ((c)->id & ID_BIT_AUDIO)
148 #define client_is_vga(c) ((c)->id == VGA_SWITCHEROO_UNKNOWN_ID || \
150 #define client_id(c) ((c)->id & ~ID_BIT_AUDIO)
152 static int vga_switcheroo_debugfs_init(struct vgasr_priv *priv);
153 static void vga_switcheroo_debugfs_fini(struct vgasr_priv *priv);
155 /* only one switcheroo per system */
156 static struct vgasr_priv vgasr_priv = {
157 .clients = LIST_HEAD_INIT(vgasr_priv.clients),
160 static bool vga_switcheroo_ready(void)
162 /* we're ready if we get two clients + handler */
163 return !vgasr_priv.active &&
164 vgasr_priv.registered_clients == 2 && vgasr_priv.handler;
167 static void vga_switcheroo_enable(void)
170 struct vga_switcheroo_client *client;
172 /* call the handler to init */
173 if (vgasr_priv.handler->init)
174 vgasr_priv.handler->init();
176 list_for_each_entry(client, &vgasr_priv.clients, list) {
177 if (client->id != VGA_SWITCHEROO_UNKNOWN_ID)
179 ret = vgasr_priv.handler->get_client_id(client->pdev);
185 vga_switcheroo_debugfs_init(&vgasr_priv);
186 vgasr_priv.active = true;
190 * vga_switcheroo_register_handler() - register handler
191 * @handler: handler callbacks
193 * Register handler. Enable vga_switcheroo if two vga clients have already
196 * Return: 0 on success, -EINVAL if a handler was already registered.
198 int vga_switcheroo_register_handler(struct vga_switcheroo_handler *handler)
200 mutex_lock(&vgasr_mutex);
201 if (vgasr_priv.handler) {
202 mutex_unlock(&vgasr_mutex);
206 vgasr_priv.handler = handler;
207 if (vga_switcheroo_ready()) {
208 pr_info("enabled\n");
209 vga_switcheroo_enable();
211 mutex_unlock(&vgasr_mutex);
214 EXPORT_SYMBOL(vga_switcheroo_register_handler);
217 * vga_switcheroo_unregister_handler() - unregister handler
219 * Unregister handler. Disable vga_switcheroo.
221 void vga_switcheroo_unregister_handler(void)
223 mutex_lock(&vgasr_mutex);
224 vgasr_priv.handler = NULL;
225 if (vgasr_priv.active) {
226 pr_info("disabled\n");
227 vga_switcheroo_debugfs_fini(&vgasr_priv);
228 vgasr_priv.active = false;
230 mutex_unlock(&vgasr_mutex);
232 EXPORT_SYMBOL(vga_switcheroo_unregister_handler);
234 static int register_client(struct pci_dev *pdev,
235 const struct vga_switcheroo_client_ops *ops,
236 enum vga_switcheroo_client_id id, bool active,
237 bool driver_power_control)
239 struct vga_switcheroo_client *client;
241 client = kzalloc(sizeof(*client), GFP_KERNEL);
245 client->pwr_state = VGA_SWITCHEROO_ON;
249 client->active = active;
250 client->driver_power_control = driver_power_control;
252 mutex_lock(&vgasr_mutex);
253 list_add_tail(&client->list, &vgasr_priv.clients);
254 if (client_is_vga(client))
255 vgasr_priv.registered_clients++;
257 if (vga_switcheroo_ready()) {
258 pr_info("enabled\n");
259 vga_switcheroo_enable();
261 mutex_unlock(&vgasr_mutex);
266 * vga_switcheroo_register_client - register vga client
267 * @pdev: client pci device
268 * @ops: client callbacks
269 * @driver_power_control: whether power state is controlled by the driver's
272 * Register vga client (GPU). Enable vga_switcheroo if another GPU and a
273 * handler have already registered. The power state of the client is assumed
276 * Return: 0 on success, -ENOMEM on memory allocation error.
278 int vga_switcheroo_register_client(struct pci_dev *pdev,
279 const struct vga_switcheroo_client_ops *ops,
280 bool driver_power_control)
282 return register_client(pdev, ops, VGA_SWITCHEROO_UNKNOWN_ID,
283 pdev == vga_default_device(),
284 driver_power_control);
286 EXPORT_SYMBOL(vga_switcheroo_register_client);
289 * vga_switcheroo_register_audio_client - register audio client
290 * @pdev: client pci device
291 * @ops: client callbacks
292 * @id: client identifier
294 * Register audio client (audio device on a GPU). The power state of the
295 * client is assumed to be ON.
297 * Return: 0 on success, -ENOMEM on memory allocation error.
299 int vga_switcheroo_register_audio_client(struct pci_dev *pdev,
300 const struct vga_switcheroo_client_ops *ops,
301 enum vga_switcheroo_client_id id)
303 return register_client(pdev, ops, id | ID_BIT_AUDIO, false, false);
305 EXPORT_SYMBOL(vga_switcheroo_register_audio_client);
307 static struct vga_switcheroo_client *
308 find_client_from_pci(struct list_head *head, struct pci_dev *pdev)
310 struct vga_switcheroo_client *client;
312 list_for_each_entry(client, head, list)
313 if (client->pdev == pdev)
318 static struct vga_switcheroo_client *
319 find_client_from_id(struct list_head *head,
320 enum vga_switcheroo_client_id client_id)
322 struct vga_switcheroo_client *client;
324 list_for_each_entry(client, head, list)
325 if (client->id == client_id)
330 static struct vga_switcheroo_client *
331 find_active_client(struct list_head *head)
333 struct vga_switcheroo_client *client;
335 list_for_each_entry(client, head, list)
342 * vga_switcheroo_get_client_state() - obtain power state of a given client
343 * @pdev: client pci device
345 * Obtain power state of a given client as seen from vga_switcheroo.
346 * The function is only called from hda_intel.c.
348 * Return: Power state.
350 enum vga_switcheroo_state vga_switcheroo_get_client_state(struct pci_dev *pdev)
352 struct vga_switcheroo_client *client;
353 enum vga_switcheroo_state ret;
355 mutex_lock(&vgasr_mutex);
356 client = find_client_from_pci(&vgasr_priv.clients, pdev);
358 ret = VGA_SWITCHEROO_NOT_FOUND;
359 else if (!vgasr_priv.active)
360 ret = VGA_SWITCHEROO_INIT;
362 ret = client->pwr_state;
363 mutex_unlock(&vgasr_mutex);
366 EXPORT_SYMBOL(vga_switcheroo_get_client_state);
369 * vga_switcheroo_unregister_client() - unregister client
370 * @pdev: client pci device
372 * Unregister client. Disable vga_switcheroo if this is a vga client (GPU).
374 void vga_switcheroo_unregister_client(struct pci_dev *pdev)
376 struct vga_switcheroo_client *client;
378 mutex_lock(&vgasr_mutex);
379 client = find_client_from_pci(&vgasr_priv.clients, pdev);
381 if (client_is_vga(client))
382 vgasr_priv.registered_clients--;
383 list_del(&client->list);
386 if (vgasr_priv.active && vgasr_priv.registered_clients < 2) {
387 pr_info("disabled\n");
388 vga_switcheroo_debugfs_fini(&vgasr_priv);
389 vgasr_priv.active = false;
391 mutex_unlock(&vgasr_mutex);
393 EXPORT_SYMBOL(vga_switcheroo_unregister_client);
396 * vga_switcheroo_client_fb_set() - set framebuffer of a given client
397 * @pdev: client pci device
400 * Set framebuffer of a given client. The console will be remapped to this
403 void vga_switcheroo_client_fb_set(struct pci_dev *pdev,
404 struct fb_info *info)
406 struct vga_switcheroo_client *client;
408 mutex_lock(&vgasr_mutex);
409 client = find_client_from_pci(&vgasr_priv.clients, pdev);
411 client->fb_info = info;
412 mutex_unlock(&vgasr_mutex);
414 EXPORT_SYMBOL(vga_switcheroo_client_fb_set);
417 * DOC: Manual switching and manual power control
419 * In this mode of use, the file /sys/kernel/debug/vgaswitcheroo/switch
420 * can be read to retrieve the current vga_switcheroo state and commands
421 * can be written to it to change the state. The file appears as soon as
422 * two GPU drivers and one handler have registered with vga_switcheroo.
423 * The following commands are understood:
425 * * OFF: Power off the device not in use.
426 * * ON: Power on the device not in use.
427 * * IGD: Switch to the integrated graphics device.
428 * Power on the integrated GPU if necessary, power off the discrete GPU.
429 * Prerequisite is that no user space processes (e.g. Xorg, alsactl)
430 * have opened device files of the GPUs or the audio client. If the
431 * switch fails, the user may invoke lsof(8) or fuser(1) on /dev/dri/
432 * and /dev/snd/controlC1 to identify processes blocking the switch.
433 * * DIS: Switch to the discrete graphics device.
434 * * DIGD: Delayed switch to the integrated graphics device.
435 * This will perform the switch once the last user space process has
436 * closed the device files of the GPUs and the audio client.
437 * * DDIS: Delayed switch to the discrete graphics device.
438 * * MIGD: Mux-only switch to the integrated graphics device.
439 * Does not remap console or change the power state of either gpu.
440 * If the integrated GPU is currently off, the screen will turn black.
441 * If it is on, the screen will show whatever happens to be in VRAM.
442 * Either way, the user has to blindly enter the command to switch back.
443 * * MDIS: Mux-only switch to the discrete graphics device.
445 * For GPUs whose power state is controlled by the driver's runtime pm,
446 * the ON and OFF commands are a no-op (see next section).
448 * For muxless machines, the IGD/DIS, DIGD/DDIS and MIGD/MDIS commands
449 * should not be used.
452 static int vga_switcheroo_show(struct seq_file *m, void *v)
454 struct vga_switcheroo_client *client;
457 mutex_lock(&vgasr_mutex);
458 list_for_each_entry(client, &vgasr_priv.clients, list) {
459 seq_printf(m, "%d:%s%s:%c:%s%s:%s\n", i,
460 client_id(client) == VGA_SWITCHEROO_DIS ? "DIS" :
462 client_is_vga(client) ? "" : "-Audio",
463 client->active ? '+' : ' ',
464 client->driver_power_control ? "Dyn" : "",
465 client->pwr_state ? "Pwr" : "Off",
466 pci_name(client->pdev));
469 mutex_unlock(&vgasr_mutex);
473 static int vga_switcheroo_debugfs_open(struct inode *inode, struct file *file)
475 return single_open(file, vga_switcheroo_show, NULL);
478 static int vga_switchon(struct vga_switcheroo_client *client)
480 if (client->driver_power_control)
482 if (vgasr_priv.handler->power_state)
483 vgasr_priv.handler->power_state(client->id, VGA_SWITCHEROO_ON);
484 /* call the driver callback to turn on device */
485 client->ops->set_gpu_state(client->pdev, VGA_SWITCHEROO_ON);
486 client->pwr_state = VGA_SWITCHEROO_ON;
490 static int vga_switchoff(struct vga_switcheroo_client *client)
492 if (client->driver_power_control)
494 /* call the driver callback to turn off device */
495 client->ops->set_gpu_state(client->pdev, VGA_SWITCHEROO_OFF);
496 if (vgasr_priv.handler->power_state)
497 vgasr_priv.handler->power_state(client->id, VGA_SWITCHEROO_OFF);
498 client->pwr_state = VGA_SWITCHEROO_OFF;
502 static void set_audio_state(enum vga_switcheroo_client_id id,
503 enum vga_switcheroo_state state)
505 struct vga_switcheroo_client *client;
507 client = find_client_from_id(&vgasr_priv.clients, id | ID_BIT_AUDIO);
508 if (client && client->pwr_state != state) {
509 client->ops->set_gpu_state(client->pdev, state);
510 client->pwr_state = state;
514 /* stage one happens before delay */
515 static int vga_switchto_stage1(struct vga_switcheroo_client *new_client)
517 struct vga_switcheroo_client *active;
519 active = find_active_client(&vgasr_priv.clients);
523 if (new_client->pwr_state == VGA_SWITCHEROO_OFF)
524 vga_switchon(new_client);
526 vga_set_default_device(new_client->pdev);
531 static int vga_switchto_stage2(struct vga_switcheroo_client *new_client)
534 struct vga_switcheroo_client *active;
536 active = find_active_client(&vgasr_priv.clients);
540 active->active = false;
542 set_audio_state(active->id, VGA_SWITCHEROO_OFF);
544 if (new_client->fb_info) {
545 struct fb_event event;
548 event.info = new_client->fb_info;
549 fb_notifier_call_chain(FB_EVENT_REMAP_ALL_CONSOLE, &event);
553 ret = vgasr_priv.handler->switchto(new_client->id);
557 if (new_client->ops->reprobe)
558 new_client->ops->reprobe(new_client->pdev);
560 if (active->pwr_state == VGA_SWITCHEROO_ON)
561 vga_switchoff(active);
563 set_audio_state(new_client->id, VGA_SWITCHEROO_ON);
565 new_client->active = true;
569 static bool check_can_switch(void)
571 struct vga_switcheroo_client *client;
573 list_for_each_entry(client, &vgasr_priv.clients, list) {
574 if (!client->ops->can_switch(client->pdev)) {
575 pr_err("client %x refused switch\n", client->id);
583 vga_switcheroo_debugfs_write(struct file *filp, const char __user *ubuf,
584 size_t cnt, loff_t *ppos)
588 bool delay = false, can_switch;
589 bool just_mux = false;
590 enum vga_switcheroo_client_id client_id = VGA_SWITCHEROO_UNKNOWN_ID;
591 struct vga_switcheroo_client *client = NULL;
596 if (copy_from_user(usercmd, ubuf, cnt))
599 mutex_lock(&vgasr_mutex);
601 if (!vgasr_priv.active) {
606 /* pwr off the device not in use */
607 if (strncmp(usercmd, "OFF", 3) == 0) {
608 list_for_each_entry(client, &vgasr_priv.clients, list) {
609 if (client->active || client_is_audio(client))
611 if (client->driver_power_control)
613 set_audio_state(client->id, VGA_SWITCHEROO_OFF);
614 if (client->pwr_state == VGA_SWITCHEROO_ON)
615 vga_switchoff(client);
619 /* pwr on the device not in use */
620 if (strncmp(usercmd, "ON", 2) == 0) {
621 list_for_each_entry(client, &vgasr_priv.clients, list) {
622 if (client->active || client_is_audio(client))
624 if (client->driver_power_control)
626 if (client->pwr_state == VGA_SWITCHEROO_OFF)
627 vga_switchon(client);
628 set_audio_state(client->id, VGA_SWITCHEROO_ON);
633 /* request a delayed switch - test can we switch now */
634 if (strncmp(usercmd, "DIGD", 4) == 0) {
635 client_id = VGA_SWITCHEROO_IGD;
639 if (strncmp(usercmd, "DDIS", 4) == 0) {
640 client_id = VGA_SWITCHEROO_DIS;
644 if (strncmp(usercmd, "IGD", 3) == 0)
645 client_id = VGA_SWITCHEROO_IGD;
647 if (strncmp(usercmd, "DIS", 3) == 0)
648 client_id = VGA_SWITCHEROO_DIS;
650 if (strncmp(usercmd, "MIGD", 4) == 0) {
652 client_id = VGA_SWITCHEROO_IGD;
654 if (strncmp(usercmd, "MDIS", 4) == 0) {
656 client_id = VGA_SWITCHEROO_DIS;
659 if (client_id == VGA_SWITCHEROO_UNKNOWN_ID)
661 client = find_client_from_id(&vgasr_priv.clients, client_id);
665 vgasr_priv.delayed_switch_active = false;
668 ret = vgasr_priv.handler->switchto(client_id);
675 /* okay we want a switch - test if devices are willing to switch */
676 can_switch = check_can_switch();
678 if (can_switch == false && delay == false)
682 ret = vga_switchto_stage1(client);
684 pr_err("switching failed stage 1 %d\n", ret);
686 ret = vga_switchto_stage2(client);
688 pr_err("switching failed stage 2 %d\n", ret);
691 pr_info("setting delayed switch to client %d\n", client->id);
692 vgasr_priv.delayed_switch_active = true;
693 vgasr_priv.delayed_client_id = client_id;
695 ret = vga_switchto_stage1(client);
697 pr_err("delayed switching stage 1 failed %d\n", ret);
701 mutex_unlock(&vgasr_mutex);
705 static const struct file_operations vga_switcheroo_debugfs_fops = {
706 .owner = THIS_MODULE,
707 .open = vga_switcheroo_debugfs_open,
708 .write = vga_switcheroo_debugfs_write,
711 .release = single_release,
714 static void vga_switcheroo_debugfs_fini(struct vgasr_priv *priv)
716 debugfs_remove(priv->switch_file);
717 priv->switch_file = NULL;
719 debugfs_remove(priv->debugfs_root);
720 priv->debugfs_root = NULL;
723 static int vga_switcheroo_debugfs_init(struct vgasr_priv *priv)
725 static const char mp[] = "/sys/kernel/debug";
727 /* already initialised */
728 if (priv->debugfs_root)
730 priv->debugfs_root = debugfs_create_dir("vgaswitcheroo", NULL);
732 if (!priv->debugfs_root) {
733 pr_err("Cannot create %s/vgaswitcheroo\n", mp);
737 priv->switch_file = debugfs_create_file("switch", 0644,
738 priv->debugfs_root, NULL,
739 &vga_switcheroo_debugfs_fops);
740 if (!priv->switch_file) {
741 pr_err("cannot create %s/vgaswitcheroo/switch\n", mp);
746 vga_switcheroo_debugfs_fini(priv);
751 * vga_switcheroo_process_delayed_switch() - helper for delayed switching
753 * Process a delayed switch if one is pending. DRM drivers should call this
754 * from their ->lastclose callback.
756 * Return: 0 on success. -EINVAL if no delayed switch is pending, if the client
757 * has unregistered in the meantime or if there are other clients blocking the
758 * switch. If the actual switch fails, an error is reported and 0 is returned.
760 int vga_switcheroo_process_delayed_switch(void)
762 struct vga_switcheroo_client *client;
766 mutex_lock(&vgasr_mutex);
767 if (!vgasr_priv.delayed_switch_active)
770 pr_info("processing delayed switch to %d\n",
771 vgasr_priv.delayed_client_id);
773 client = find_client_from_id(&vgasr_priv.clients,
774 vgasr_priv.delayed_client_id);
775 if (!client || !check_can_switch())
778 ret = vga_switchto_stage2(client);
780 pr_err("delayed switching failed stage 2 %d\n", ret);
782 vgasr_priv.delayed_switch_active = false;
785 mutex_unlock(&vgasr_mutex);
788 EXPORT_SYMBOL(vga_switcheroo_process_delayed_switch);
791 * DOC: Driver power control
793 * In this mode of use, the discrete GPU automatically powers up and down at
794 * the discretion of the driver's runtime pm. On muxed machines, the user may
795 * still influence the muxer state by way of the debugfs interface, however
796 * the ON and OFF commands become a no-op for the discrete GPU.
798 * This mode is the default on Nvidia HybridPower/Optimus and ATI PowerXpress.
799 * Specifying nouveau.runpm=0, radeon.runpm=0 or amdgpu.runpm=0 on the kernel
800 * command line disables it.
802 * When the driver decides to power up or down, it notifies vga_switcheroo
803 * thereof so that it can (a) power the audio device on the GPU up or down,
804 * and (b) update its internal power state representation for the device.
805 * This is achieved by vga_switcheroo_set_dynamic_switch().
807 * After the GPU has been suspended, the handler needs to be called to cut
808 * power to the GPU. Likewise it needs to reinstate power before the GPU
809 * can resume. This is achieved by vga_switcheroo_init_domain_pm_ops(),
810 * which augments the GPU's suspend/resume functions by the requisite
811 * calls to the handler.
813 * When the audio device resumes, the GPU needs to be woken. This is achieved
814 * by vga_switcheroo_init_domain_pm_optimus_hdmi_audio(), which augments the
815 * audio device's resume function.
817 * On muxed machines, if the mux is initially switched to the discrete GPU,
818 * the user ends up with a black screen when the GPU powers down after boot.
819 * As a workaround, the mux is forced to the integrated GPU on runtime suspend,
820 * cf. https://bugs.freedesktop.org/show_bug.cgi?id=75917
823 static void vga_switcheroo_power_switch(struct pci_dev *pdev,
824 enum vga_switcheroo_state state)
826 struct vga_switcheroo_client *client;
828 if (!vgasr_priv.handler->power_state)
831 client = find_client_from_pci(&vgasr_priv.clients, pdev);
835 if (!client->driver_power_control)
838 vgasr_priv.handler->power_state(client->id, state);
842 * vga_switcheroo_set_dynamic_switch() - helper for driver power control
843 * @pdev: client pci device
844 * @dynamic: new power state
846 * Helper for GPUs whose power state is controlled by the driver's runtime pm.
847 * When the driver decides to power up or down, it notifies vga_switcheroo
848 * thereof using this helper so that it can (a) power the audio device on
849 * the GPU up or down, and (b) update its internal power state representation
852 void vga_switcheroo_set_dynamic_switch(struct pci_dev *pdev,
853 enum vga_switcheroo_state dynamic)
855 struct vga_switcheroo_client *client;
857 mutex_lock(&vgasr_mutex);
858 client = find_client_from_pci(&vgasr_priv.clients, pdev);
859 if (!client || !client->driver_power_control) {
860 mutex_unlock(&vgasr_mutex);
864 client->pwr_state = dynamic;
865 set_audio_state(client->id, dynamic);
866 mutex_unlock(&vgasr_mutex);
868 EXPORT_SYMBOL(vga_switcheroo_set_dynamic_switch);
870 /* switcheroo power domain */
871 static int vga_switcheroo_runtime_suspend(struct device *dev)
873 struct pci_dev *pdev = to_pci_dev(dev);
876 ret = dev->bus->pm->runtime_suspend(dev);
879 mutex_lock(&vgasr_mutex);
880 if (vgasr_priv.handler->switchto)
881 vgasr_priv.handler->switchto(VGA_SWITCHEROO_IGD);
882 vga_switcheroo_power_switch(pdev, VGA_SWITCHEROO_OFF);
883 mutex_unlock(&vgasr_mutex);
887 static int vga_switcheroo_runtime_resume(struct device *dev)
889 struct pci_dev *pdev = to_pci_dev(dev);
892 mutex_lock(&vgasr_mutex);
893 vga_switcheroo_power_switch(pdev, VGA_SWITCHEROO_ON);
894 mutex_unlock(&vgasr_mutex);
895 ret = dev->bus->pm->runtime_resume(dev);
903 * vga_switcheroo_init_domain_pm_ops() - helper for driver power control
904 * @dev: vga client device
905 * @domain: power domain
907 * Helper for GPUs whose power state is controlled by the driver's runtime pm.
908 * After the GPU has been suspended, the handler needs to be called to cut
909 * power to the GPU. Likewise it needs to reinstate power before the GPU
910 * can resume. To this end, this helper augments the suspend/resume functions
911 * by the requisite calls to the handler. It needs only be called on platforms
912 * where the power switch is separate to the device being powered down.
914 int vga_switcheroo_init_domain_pm_ops(struct device *dev,
915 struct dev_pm_domain *domain)
917 /* copy over all the bus versions */
918 if (dev->bus && dev->bus->pm) {
919 domain->ops = *dev->bus->pm;
920 domain->ops.runtime_suspend = vga_switcheroo_runtime_suspend;
921 domain->ops.runtime_resume = vga_switcheroo_runtime_resume;
923 dev->pm_domain = domain;
926 dev->pm_domain = NULL;
929 EXPORT_SYMBOL(vga_switcheroo_init_domain_pm_ops);
931 void vga_switcheroo_fini_domain_pm_ops(struct device *dev)
933 dev->pm_domain = NULL;
935 EXPORT_SYMBOL(vga_switcheroo_fini_domain_pm_ops);
937 static int vga_switcheroo_runtime_resume_hdmi_audio(struct device *dev)
939 struct pci_dev *pdev = to_pci_dev(dev);
940 struct vga_switcheroo_client *client;
941 struct device *video_dev = NULL;
944 /* we need to check if we have to switch back on the video
945 device so the audio device can come back */
946 mutex_lock(&vgasr_mutex);
947 list_for_each_entry(client, &vgasr_priv.clients, list) {
948 if (PCI_SLOT(client->pdev->devfn) == PCI_SLOT(pdev->devfn) &&
949 client_is_vga(client)) {
950 video_dev = &client->pdev->dev;
954 mutex_unlock(&vgasr_mutex);
957 ret = pm_runtime_get_sync(video_dev);
961 ret = dev->bus->pm->runtime_resume(dev);
963 /* put the reference for the gpu */
965 pm_runtime_mark_last_busy(video_dev);
966 pm_runtime_put_autosuspend(video_dev);
972 * vga_switcheroo_init_domain_pm_optimus_hdmi_audio() - helper for driver
974 * @dev: audio client device
975 * @domain: power domain
977 * Helper for GPUs whose power state is controlled by the driver's runtime pm.
978 * When the audio device resumes, the GPU needs to be woken. This helper
979 * augments the audio device's resume function to do that.
981 * Return: 0 on success, -EINVAL if no power management operations are
982 * defined for this device.
985 vga_switcheroo_init_domain_pm_optimus_hdmi_audio(struct device *dev,
986 struct dev_pm_domain *domain)
988 /* copy over all the bus versions */
989 if (dev->bus && dev->bus->pm) {
990 domain->ops = *dev->bus->pm;
991 domain->ops.runtime_resume =
992 vga_switcheroo_runtime_resume_hdmi_audio;
994 dev->pm_domain = domain;
997 dev->pm_domain = NULL;
1000 EXPORT_SYMBOL(vga_switcheroo_init_domain_pm_optimus_hdmi_audio);