2 * vga_switcheroo.h - 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 #ifndef _LINUX_VGA_SWITCHEROO_H_
32 #define _LINUX_VGA_SWITCHEROO_H_
39 * enum vga_switcheroo_state - client power state
40 * @VGA_SWITCHEROO_OFF: off
41 * @VGA_SWITCHEROO_ON: on
42 * @VGA_SWITCHEROO_INIT: client has registered with vga_switcheroo but
43 * vga_switcheroo is not enabled, i.e. no second client or no handler
44 * has registered. Only used in vga_switcheroo_get_client_state() which
45 * in turn is only called from hda_intel.c
46 * @VGA_SWITCHEROO_NOT_FOUND: client has not registered with vga_switcheroo.
47 * Only used in vga_switcheroo_get_client_state() which in turn is only
48 * called from hda_intel.c
52 enum vga_switcheroo_state {
55 /* below are referred only from vga_switcheroo_get_client_state() */
57 VGA_SWITCHEROO_NOT_FOUND,
61 * enum vga_switcheroo_client_id - client identifier
62 * @VGA_SWITCHEROO_UNKNOWN_ID: initial identifier assigned to vga clients.
63 * Determining the id requires the handler, so GPUs are given their
64 * true id in a delayed fashion in vga_switcheroo_enable()
65 * @VGA_SWITCHEROO_IGD: integrated graphics device
66 * @VGA_SWITCHEROO_DIS: discrete graphics device
67 * @VGA_SWITCHEROO_MAX_CLIENTS: currently no more than two GPUs are supported
69 * Client identifier. Audio clients use the same identifier & 0x100.
71 enum vga_switcheroo_client_id {
72 VGA_SWITCHEROO_UNKNOWN_ID = -1,
75 VGA_SWITCHEROO_MAX_CLIENTS,
79 * struct vga_switcheroo_handler - handler callbacks
80 * @init: initialize handler.
81 * Optional. This gets called when vga_switcheroo is enabled, i.e. when
82 * two vga clients have registered. It allows the handler to perform
83 * some delayed initialization that depends on the existence of the
84 * vga clients. Currently only the radeon and amdgpu drivers use this.
85 * The return value is ignored
86 * @switchto: switch outputs to given client.
87 * Mandatory. For muxless machines this should be a no-op. Returning 0
88 * denotes success, anything else failure (in which case the switch is
90 * @power_state: cut or reinstate power of given client.
91 * Optional. The return value is ignored
92 * @get_client_id: determine if given pci device is integrated or discrete GPU.
95 * Handler callbacks. The multiplexer itself. The @switchto and @get_client_id
96 * methods are mandatory, all others may be set to NULL.
98 struct vga_switcheroo_handler {
100 int (*switchto)(enum vga_switcheroo_client_id id);
101 int (*power_state)(enum vga_switcheroo_client_id id,
102 enum vga_switcheroo_state state);
103 enum vga_switcheroo_client_id (*get_client_id)(struct pci_dev *pdev);
107 * struct vga_switcheroo_client_ops - client callbacks
108 * @set_gpu_state: do the equivalent of suspend/resume for the card.
109 * Mandatory. This should not cut power to the discrete GPU,
110 * which is the job of the handler
111 * @reprobe: poll outputs.
112 * Optional. This gets called after waking the GPU and switching
114 * @can_switch: check if the device is in a position to switch now.
115 * Mandatory. The client should return false if a user space process
116 * has one of its device files open
118 * Client callbacks. A client can be either a GPU or an audio device on a GPU.
119 * The @set_gpu_state and @can_switch methods are mandatory, @reprobe may be
120 * set to NULL. For audio clients, the @reprobe member is bogus.
122 struct vga_switcheroo_client_ops {
123 void (*set_gpu_state)(struct pci_dev *dev, enum vga_switcheroo_state);
124 void (*reprobe)(struct pci_dev *dev);
125 bool (*can_switch)(struct pci_dev *dev);
128 #if defined(CONFIG_VGA_SWITCHEROO)
129 void vga_switcheroo_unregister_client(struct pci_dev *dev);
130 int vga_switcheroo_register_client(struct pci_dev *dev,
131 const struct vga_switcheroo_client_ops *ops,
132 bool driver_power_control);
133 int vga_switcheroo_register_audio_client(struct pci_dev *pdev,
134 const struct vga_switcheroo_client_ops *ops,
135 enum vga_switcheroo_client_id id);
137 void vga_switcheroo_client_fb_set(struct pci_dev *dev,
138 struct fb_info *info);
140 int vga_switcheroo_register_handler(const struct vga_switcheroo_handler *handler);
141 void vga_switcheroo_unregister_handler(void);
143 int vga_switcheroo_process_delayed_switch(void);
145 enum vga_switcheroo_state vga_switcheroo_get_client_state(struct pci_dev *dev);
147 void vga_switcheroo_set_dynamic_switch(struct pci_dev *pdev, enum vga_switcheroo_state dynamic);
149 int vga_switcheroo_init_domain_pm_ops(struct device *dev, struct dev_pm_domain *domain);
150 void vga_switcheroo_fini_domain_pm_ops(struct device *dev);
151 int vga_switcheroo_init_domain_pm_optimus_hdmi_audio(struct device *dev, struct dev_pm_domain *domain);
154 static inline void vga_switcheroo_unregister_client(struct pci_dev *dev) {}
155 static inline int vga_switcheroo_register_client(struct pci_dev *dev,
156 const struct vga_switcheroo_client_ops *ops, bool driver_power_control) { return 0; }
157 static inline void vga_switcheroo_client_fb_set(struct pci_dev *dev, struct fb_info *info) {}
158 static inline int vga_switcheroo_register_handler(const struct vga_switcheroo_handler *handler) { return 0; }
159 static inline int vga_switcheroo_register_audio_client(struct pci_dev *pdev,
160 const struct vga_switcheroo_client_ops *ops,
161 enum vga_switcheroo_client_id id) { return 0; }
162 static inline void vga_switcheroo_unregister_handler(void) {}
163 static inline int vga_switcheroo_process_delayed_switch(void) { return 0; }
164 static inline enum vga_switcheroo_state vga_switcheroo_get_client_state(struct pci_dev *dev) { return VGA_SWITCHEROO_ON; }
166 static inline void vga_switcheroo_set_dynamic_switch(struct pci_dev *pdev, enum vga_switcheroo_state dynamic) {}
168 static inline int vga_switcheroo_init_domain_pm_ops(struct device *dev, struct dev_pm_domain *domain) { return -EINVAL; }
169 static inline void vga_switcheroo_fini_domain_pm_ops(struct device *dev) {}
170 static inline int vga_switcheroo_init_domain_pm_optimus_hdmi_audio(struct device *dev, struct dev_pm_domain *domain) { return -EINVAL; }
173 #endif /* _LINUX_VGA_SWITCHEROO_H_ */