Differences between revisions 1 and 71 (spanning 70 versions)
Revision 1 as of 2012-01-17 13:57:21
Size: 5868
Editor: PeterWu
Comment:
Revision 71 as of 2020-07-13 09:06:50
Size: 11065
Comment: As of version 0~20150328-11 of the Primus package, primusrun should also handle Vulkan applications, so we shouldn't need to be as strict on using pvkrun here
Deletions are marked like this. Additions are marked like this.
Line 1: Line 1:
#language en
~-[[DebianWiki/EditorGuide#translation|Translation(s)]]: English - [[fr/Bumblebee|Français]] - [[it/Bumblebee|Italiano]] - [[es/Bumblebee|español]] - [[ru/Bumblebee|Русский]] - [[pt_BR/Bumblebee|Brasileiro]]-~
----
Line 2: Line 5:
Bumblebee aims to provide support for NVIDIA Optimus laptops for GNU/Linux
distributions. Using Bumblebee, you can use your NVIDIA card for rendering
graphics which will be displayed using the Intel card.
Line 6: Line 6:
The instructions on this page have been made for Debian 6 Squeeze. Debian 5
Lenny is not supported.
Bumblebee aims to provide support for [[https://developer.nvidia.com/optimus|NVIDIA Optimus]] laptops for GNU/Linux distributions. Using Bumblebee, you can use your NVIDIA card for rendering graphics which will be displayed using the Intel card.
Line 9: Line 8:
== Requirements == The instructions on this page apply to all Debian versions that are currently supported, however modern hardware will accordingly require a modern release of the NVIDIA graphics drivers. If you're using a particularly recent card, please make sure the driver version you're using supports it. A list of the versions available in Debian and the supported devices for each of them can be found on the [[NvidiaGraphicsDrivers]] page.
Line 11: Line 10:
 * source tarball from https://github.com/Bumblebee-Project/Bumblebee/downloads
 * Build dependencies: {{{
sudo apt-get install build-essential pkg-config help2man libx11-dev libbsd-dev
}}}
 * [[http://sourceforge.net/projects/virtualgl/files/VirtualGL/|Virtual GL]]
 * A video driver (nouveau or nvidia, see below)
 * [[https://github.com/Bumblebee-Project/bbswitch|bbswitch]] (kernel module for Power Management, see below)
Bumblebee packages are available directly from the Debian repositories, see the sections for installing on [[#debian10|Debian 10 or older]], or [[#debian11|Debian 11 and newer]], depending on your need.
Line 19: Line 12:
=== bbswitch ===
It's recommended to install this kernel module using DKMS such that it survives
kernel upgrades. The [[https://launchpad.net/~bumblebee/+archive/testing/+packages?field.name_filter=bbswitch|bbswitch-dkms package from Ubuntu]]
is compatible with Debian and can also be used.
Though not recommended since official packages are available, historical instructions for compiling from source can be found at [[Bumblebee/ManualInstall]].
Line 24: Line 14:
=== Driver choice === <<TableOfContents(3)>>
Line 26: Line 16:
NVIDIA Optimus graphics card are very recent, the [[http://packages.debian.org/xserver-xorg-video-nouveau|nouveau]]
package supplied with Squeeze is very old. For nouveau, kernel 3.1 and up is recommended
because of the firmware. If you're using Squeeze, the easiest way is to use
the NVIDIA proprietary driver.
<<Anchor(debian10)>>
== Debian 10 and older ==
=== Installation ===
For users who would like to use the free and open-source "Nouveau" driver:
Line 31: Line 21:
==== NVIDIA blob ====
To install the nvidia proprietary driver, you will have to install the
[[http://packages.debian.org/nvidia-glx|nvidia-glx]] and
[[http://packages.debian.org/nvidia-kernel-dkms]] packages. If using Squeeze, the
backports repository [[https://wiki.debian.org/Backports|needs to be enabled]].
Make sure APT has ''non-free'' and ''contrib'' sources (consult the [[DebianMan:5/sources.list|sources.list(5)]] man page for help on doing this).

After refreshing the package lists using `sudo apt-get update`, install the NVIDIA drivers with: {{{
sudo apt-get install -t squeeze-backports nvidia-glx linux-headers-$(uname -r) nvidia-kernel-dkms
}}}
(remove {{{-t squeeze-backports}}} if you are not using Squeeze)

The following command is '''very''' important, if you skip it you will loose
3D acceleration. Restore Mesa as the default GL library since the primary
display is running on the Intel graphics card: {{{
sudo update-alternatives --set glx /usr/lib/mesa-diverted
{{{
sudo apt install bumblebee primus
Line 49: Line 25:
== Installation == For users who would like to use the proprietary driver (make sure the contrib and non-free components are enabled in your [[SourcesList]] file):
Line 51: Line 27:
=== Compiling ===
Configure the source tree, it can be as simple as {{{./configure}}} if you
use nouveau and want to install Bumblebee to {{{/usr}}} with the configuration
directory at {{{/usr/local/etc/bumblebee}}}.

If you use the proprietary nvidia driver, set the correct driver paths:
Line 58: Line 28:
./configure CONF_DRIVER_MODULE_NVIDIA=nvidia-current \
  CONF_LDPATH_NVIDIA=/usr/lib/nvidia:/usr/lib32/nvidia \
  CONF_MODPATH_NVIDIA=/usr/lib/nvidia,/usr/lib/xorg/modules
sudo apt install bumblebee-nvidia primus
Line 63: Line 31:
Append {{{--sysconfdir=/etc}}} if you wish to have configuration files available
at {{{/etc/bumblebee}}}.
Users running a 64-bit system who want to take advantage of Bumblebee with the Primus backend when running 32-bit applications will also want to install DebianPkg:primus-libs-ia32. This requires [[Multiarch/HOWTO|Multiarch]] support to be enabled. Similarly, if 32-bit OpenGL support is required (e.g., for running 32-bit Microsoft Windows games under [[Wine]]), install the DebianPkg:nvidia-driver-libs-i386 package.
Line 66: Line 33:
Continue with building and installing files. '''Warning:''' If your internal graphics card is an Intel chipset, you may wish to uninstall the DebianPkg:xserver-xorg-video-intel package as the driver it supplies is not actively developed. Use of this driver is actively discouraged if your hardware is new enough (roughly 2007 or newer) as it may introduce other issues.
=== Usage ===
To run your application with the discrete NVIDIA card, the syntax would be:
Line 68: Line 37:
make
sudo make install
optirun [options] <application> [application-parameters]
Line 72: Line 40:
=== Startup script ===
To make the bumblebee daemon (bumblebeed) start on boot, install an
init script: {{{
sudo install -m755 scripts/sysvinit/bumblebeed /etc/init.d/
sudo update-rc.d bumblebeed defaults
For example:
{{{
optirun glxgears -info
Line 79: Line 45:
=== Groups ===
For security reasons, the use of Bumblebee is restricted to a
certain group. By default, this group is {{{bumblebee}}}, which
must be created: {{{
sudo groupadd
For a list of options for `optirun` open the manual page with `man optirun` or run:
{{{
optirun --help
}}}
----
<<Anchor(debian11)>>
== Debian 11 and newer ==

{{{#!wiki important
Debian 11 (Bullseye) is currently unreleased and in development. These instructions apply for anyone using it as the current testing branch or anyone using Debian Sid/Unstable.

These instructions may not always be up-to-date or even functional at all. They also may change at any time.
Line 86: Line 59:
Users who are allowed to use Bumblebee must be added (replace `$USER`
accordingly): {{{
sudo usermod -a -G bumblebee $USER
=== Installation ===
For users who would like to use the free and open-source "Nouveau" driver:
{{{
sudo apt install bumblebee primus
Line 90: Line 64:
Group settings are re-read after login so re-login to get started.
Line 92: Line 65:
== Usage ==
To run your application with the discrete NVIDIA card run in the terminal:
 $ `optirun [options] <application> [application-parameters]`
For users who would like to use the proprietary driver (make sure the contrib and non-free components are enabled in your [[SourcesList]] file):
{{{
sudo apt install bumblebee-nvidia primus-nvidia primus-vk-nvidia
}}}
Line 96: Line 70:
Example:
 $ `optirun firefox`
For users who need accelerated 32-bit application support on a 64-bit system with the proprietary driver ([[Multiarch/HOWTO|Multiarch]] required):
{{{
sudo apt install primus-libs:i386 libprimus-vk1:i386 nvidia-primus-vk-wrapper:i386 nvidia-driver-libs-i386
}}}
Line 99: Line 75:
For a list of options for `optirun` run:
 $ `optirun --help`
=== Usage ===
While the {{{optirun}}} command that was used in Debian 10 and older versions is still available, much better performance can be found by using the new {{{primusrun}}} command. This uses the same syntax as before, i.e.:
{{{
primusrun [options] <application> [application-parameters]
}}}
Which would look something like:
{{{
primusrun glxgears -info
}}}
Line 102: Line 85:
Debian 11 also introduces Vulkan support for Bumblebee, however it requires using the proprietary driver due to Nouveau's current lack of support for the Vulkan API. {{{primusrun}}} should also work for Vulkan applications, however if you run into any issues, you may try explicitly using the {{{pvkrun}}} command instead.
----
== Using Bumblebee with Steam ==
The proprietary [[Steam]] gaming storefront and distribution software also supports using Bumblebee with surprising ease. If you want to run the entire client (including games launched through it) with Bumblebee then you can simply run the client with {{{optirun}}} or {{{primusrun}}} (depending on your Debian version).

If you want to apply this on a game-specific basis, you'll have to set the game's launch options from its "Properties" menu in the Steam client.

For games on Debian 10 and older, the field should be set to:
{{{
optirun %command%
}}}

For games on Debian 11 and newer, the field should be set to:
{{{
primusrun %command%
}}}
----
== Post-installation ==

In some cases, you may need to add your user to the {{{bumblebee}}} group in order to use optirun, i.e.

{{{
adduser $USER bumblebee
}}}

where $USER corresponds to your username. Do also note that this command must be run as root. Don't forget to log out and log back in for this to take effect.

If you have {{{sudo}}} configured for your current user, i.e. your user is a member of the {{{sudo}}} group, this step is not needed (the bumblebee package postinst script takes care of adding sudo users to the bumblebee group automatically). This is likely to be the reason why Bumblebee works out of the box in Ubuntu, but not in Debian, with the same initial setup, i.e. Ubuntu has sudo installed by default; Debian does not configure sudo if you set a root password during installation using the non-live installer. To clarify, sudo is not needed to use bumblebee; it simply makes adding your user to the bumblebee group unnecessary.
----
Line 103: Line 115:
Line 105: Line 118:
bbswitch is packaged in Debian and is automatically installed when choosing to install bumblebee through the repositories.
Line 106: Line 121:
----
== IRC ==
Line 107: Line 124:
== IRC ==
If you have any questions, feel free to join [[http://webchat.freenode.net/?channels=#bumblebee|#bumblebee]] on Freenode.
If you have any questions, feel free to join [[https://webchat.freenode.net/?channels=bumblebee|#bumblebee]] on Freenode.
----
== Reporting bugs/problems ==
Line 110: Line 128:
== Reporting bugs/problems ==
First of all: If you have any problem, please read the article [[https://github.com/Bumblebee-Project/Bumblebee/wiki/Troubleshooting|Troubleshooting]]. If your issue is not solved, you can join the [[http://webchat.freenode.net/?channels=#bumblebee|#bumblebee]] IRC channel to ask for help (recommended). See also
https://github.com/Bumblebee-Project/Bumblebee/wiki/Reporting-Issues
First of all: If you have any problem, please read the article [[https://github.com/Bumblebee-Project/Bumblebee/wiki/Troubleshooting|Troubleshooting]]. If your issue is not solved, you can join the [[https://webchat.freenode.net/?channels=bumblebee|#bumblebee]] IRC channel to ask for help (recommended). See also
[[https://github.com/Bumblebee-Project/Bumblebee/wiki/Reporting-Issues|how to report issues]].
Line 114: Line 131:
When asked to create a bugreport, run the `sudo bumblebee-bugreport` command in a terminal When asked to create a bug report, run the `sudo bumblebee-bugreport` command in a terminal.
Line 116: Line 133:
== Uninstall ==
If you're unsatisfied with Bumblebee, you can remove it by running {{{sudo make uninstall}}} from the source directory.
=== Common issues ===
Line 119: Line 135:
== Social Media ==
Follow us on: [[http://www.facebook.com/pages/Bumblebee-Project/292915584089408|Facebook]] and [[https://twitter.com/#!/Team_Bumblebee|Twitter]].
- If optirun returns the following error:
Line 122: Line 137:
{{{[ERROR]Cannot access secondary GPU - error: Could not load GPU driver}}}

You must edit /etc/bumblebee/bumblebee.conf using your preferred editor as root, and change "!KernelDriver=nvidia" to "!KernelDriver=nvidia-current", then restart the bumblebee daemon, i.e.

{{{
systemctl restart bumblebeed
}}}

(Refer to Debian Bug DebianBug:717687 for a brief explanation.)

- If optirun returns the following error:

{{{[ERROR]Cannot access secondary GPU - error: [XORG] (EE) No devices detected}}}

You may have to set the BusID manually, in /etc/bumblebee/xorg.conf.nvidia. To get the BusID, run `lspci | egrep 'VGA|3D'` in a terminal. Refer to the comments in that file for further instructions.

- If optirun returns the following error (DebianBug:756522):

{{{[ERROR]Cannot access secondary GPU - error: [XORG] (EE) /dev/dri/card0: failed to set DRM interface version 1.4: Permission denied}}}

You have to append the following section to {{{/etc/bumblebee/xorg.conf.nvidia}}}:

{{{
Section "Screen"
    Identifier "Default Screen"
    Device "DiscreteNvidia"
EndSection
}}}

You might also try downgrading libdrm from 2.4.58 to 2.4.56. That might fix the {{{Permission denied}}} errors in Jessie.

- If optirun errors out and {{{dmesg}}} reports that your GPU has "fallen off the bus" on Linux >= 3.10, either stick with an older [[https://snapshot.debian.org/package/linux/|kernel version (<= 3.9)]], or add {{{rcutree.rcu_idle_gp_delay=1}}} to your grub command line (in /etc/default/grub, then run {{{update-grub}}} and {{{reboot}}}) as a workaround.

This is a known problem upstream and suspected to be an issue with the proprietary nvidia driver. Refer to Bumblebee github [[https://github.com/Bumblebee-Project/Bumblebee/issues/455#issuecomment-22497464|issue #455]].

- If optirun returns the following error: {{{[ERROR]Cannot access secondary GPU - error: Could not enable discrete graphics card}}} and dmesg states: {{{Refused to change power state, currently in D3}}}, you have probably issue with ACPI (encountered on Dell laptops). One solution is to prevent nvidia card to go to failed sleep state. Set {{{PMMethod=none}}} in {{{/etc/bumblebee/bumblebee.conf}}}. To keep the powersaving capabilities, you can try to tweak kernel parameters as noted below for Dell XPS 15 in bumblebee github link and here [[https://github.com/Bumblebee-Project/bbswitch/issues/140|issue #140]].

- If your laptop locks up during boot when starting the graphical display you may need to add a kernel parameter to set {{{acpi_osi="!Windows 2015"}}} or some variant. This is a known ACPI problem with 2017 Dell XPS 15 and others. Refer to Bumblebee github [[https://github.com/Bumblebee-Project/Bumblebee/issues/764#issuecomment-234494238|issue #764]].

- If your laptop freezes during boot in Debian Buster while starting the graphical display, you may try a workaround where you force the Bumblebee service to start after the display manager [[https://github.com/Bumblebee-Project/Bumblebee/issues/1036|issue #1036]]
----
Line 123: Line 179:
 * https://wiki.ubuntu.com/Bumblebee
* UbuntuWiki:Bumblebee
Line 125: Line 182:
 * http://wiki.debian.org/NvidiaGraphicsDrivers  * NvidiaGraphicsDrivers
 * https://bumblebee-project.org/

Translation(s): English - Français - Italiano - español - Русский - Brasileiro


Bumblebee Project

Bumblebee aims to provide support for NVIDIA Optimus laptops for GNU/Linux distributions. Using Bumblebee, you can use your NVIDIA card for rendering graphics which will be displayed using the Intel card.

The instructions on this page apply to all Debian versions that are currently supported, however modern hardware will accordingly require a modern release of the NVIDIA graphics drivers. If you're using a particularly recent card, please make sure the driver version you're using supports it. A list of the versions available in Debian and the supported devices for each of them can be found on the NvidiaGraphicsDrivers page.

Bumblebee packages are available directly from the Debian repositories, see the sections for installing on Debian 10 or older, or Debian 11 and newer, depending on your need.

Though not recommended since official packages are available, historical instructions for compiling from source can be found at Bumblebee/ManualInstall.

Debian 10 and older

Installation

For users who would like to use the free and open-source "Nouveau" driver:

sudo apt install bumblebee primus

For users who would like to use the proprietary driver (make sure the contrib and non-free components are enabled in your SourcesList file):

sudo apt install bumblebee-nvidia primus

Users running a 64-bit system who want to take advantage of Bumblebee with the Primus backend when running 32-bit applications will also want to install primus-libs-ia32. This requires Multiarch support to be enabled. Similarly, if 32-bit OpenGL support is required (e.g., for running 32-bit Microsoft Windows games under Wine), install the nvidia-driver-libs-i386 package.

Warning: If your internal graphics card is an Intel chipset, you may wish to uninstall the xserver-xorg-video-intel package as the driver it supplies is not actively developed. Use of this driver is actively discouraged if your hardware is new enough (roughly 2007 or newer) as it may introduce other issues.

Usage

To run your application with the discrete NVIDIA card, the syntax would be:

optirun [options] <application> [application-parameters]

For example:

optirun glxgears -info

For a list of options for optirun open the manual page with man optirun or run:

optirun --help


Debian 11 and newer

Debian 11 (Bullseye) is currently unreleased and in development. These instructions apply for anyone using it as the current testing branch or anyone using Debian Sid/Unstable.

These instructions may not always be up-to-date or even functional at all. They also may change at any time.

Installation

For users who would like to use the free and open-source "Nouveau" driver:

sudo apt install bumblebee primus

For users who would like to use the proprietary driver (make sure the contrib and non-free components are enabled in your SourcesList file):

sudo apt install bumblebee-nvidia primus-nvidia primus-vk-nvidia

For users who need accelerated 32-bit application support on a 64-bit system with the proprietary driver (Multiarch required):

sudo apt install primus-libs:i386 libprimus-vk1:i386 nvidia-primus-vk-wrapper:i386 nvidia-driver-libs-i386

Usage

While the optirun command that was used in Debian 10 and older versions is still available, much better performance can be found by using the new primusrun command. This uses the same syntax as before, i.e.:

primusrun [options] <application> [application-parameters]

Which would look something like:

primusrun glxgears -info

Debian 11 also introduces Vulkan support for Bumblebee, however it requires using the proprietary driver due to Nouveau's current lack of support for the Vulkan API. primusrun should also work for Vulkan applications, however if you run into any issues, you may try explicitly using the pvkrun command instead.


Using Bumblebee with Steam

The proprietary Steam gaming storefront and distribution software also supports using Bumblebee with surprising ease. If you want to run the entire client (including games launched through it) with Bumblebee then you can simply run the client with optirun or primusrun (depending on your Debian version).

If you want to apply this on a game-specific basis, you'll have to set the game's launch options from its "Properties" menu in the Steam client.

For games on Debian 10 and older, the field should be set to:

optirun %command%

For games on Debian 11 and newer, the field should be set to:

primusrun %command%


Post-installation

In some cases, you may need to add your user to the bumblebee group in order to use optirun, i.e.

adduser $USER bumblebee

where $USER corresponds to your username. Do also note that this command must be run as root. Don't forget to log out and log back in for this to take effect.

If you have sudo configured for your current user, i.e. your user is a member of the sudo group, this step is not needed (the bumblebee package postinst script takes care of adding sudo users to the bumblebee group automatically). This is likely to be the reason why Bumblebee works out of the box in Ubuntu, but not in Debian, with the same initial setup, i.e. Ubuntu has sudo installed by default; Debian does not configure sudo if you set a root password during installation using the non-live installer. To clarify, sudo is not needed to use bumblebee; it simply makes adding your user to the bumblebee group unnecessary.


Power Management

A primary goal of this project is to not only enable use of the discrete GPU for rendering, but also to enable smart power management of the dGPU when it's not in use. We're using either bbswitch (a module) or vga_switcheroo (kernel module, experimental) to do this in Bumblebee.

bbswitch is packaged in Debian and is automatically installed when choosing to install bumblebee through the repositories.

Since Bumblebee 3.0, this feature is enabled by default, using bbswitch. This allow automatic power management, without any configuration needs. If Power Management doesn't work on your laptop, please go to this Power Management (PM) page and help to improve Bumblebee.


IRC

If you have any questions, feel free to join #bumblebee on Freenode.


Reporting bugs/problems

First of all: If you have any problem, please read the article Troubleshooting. If your issue is not solved, you can join the #bumblebee IRC channel to ask for help (recommended). See also how to report issues.

When asked to create a bug report, run the sudo bumblebee-bugreport command in a terminal.

Common issues

- If optirun returns the following error:

[ERROR]Cannot access secondary GPU - error: Could not load GPU driver

You must edit /etc/bumblebee/bumblebee.conf using your preferred editor as root, and change "KernelDriver=nvidia" to "KernelDriver=nvidia-current", then restart the bumblebee daemon, i.e.

systemctl restart bumblebeed

(Refer to Debian Bug 717687 for a brief explanation.)

- If optirun returns the following error:

[ERROR]Cannot access secondary GPU - error: [XORG] (EE) No devices detected

You may have to set the BusID manually, in /etc/bumblebee/xorg.conf.nvidia. To get the BusID, run lspci | egrep 'VGA|3D' in a terminal. Refer to the comments in that file for further instructions.

- If optirun returns the following error (756522):

[ERROR]Cannot access secondary GPU - error: [XORG] (EE) /dev/dri/card0: failed to set DRM interface version 1.4: Permission denied

You have to append the following section to /etc/bumblebee/xorg.conf.nvidia:

Section "Screen"
    Identifier "Default Screen"
    Device "DiscreteNvidia"
EndSection

You might also try downgrading libdrm from 2.4.58 to 2.4.56. That might fix the Permission denied errors in Jessie.

- If optirun errors out and dmesg reports that your GPU has "fallen off the bus" on Linux >= 3.10, either stick with an older kernel version (<= 3.9), or add rcutree.rcu_idle_gp_delay=1 to your grub command line (in /etc/default/grub, then run update-grub and reboot) as a workaround.

This is a known problem upstream and suspected to be an issue with the proprietary nvidia driver. Refer to Bumblebee github issue #455.

- If optirun returns the following error: [ERROR]Cannot access secondary GPU - error: Could not enable discrete graphics card and dmesg states: Refused to change power state, currently in D3, you have probably issue with ACPI (encountered on Dell laptops). One solution is to prevent nvidia card to go to failed sleep state. Set PMMethod=none in /etc/bumblebee/bumblebee.conf. To keep the powersaving capabilities, you can try to tweak kernel parameters as noted below for Dell XPS 15 in bumblebee github link and here issue #140.

- If your laptop locks up during boot when starting the graphical display you may need to add a kernel parameter to set acpi_osi="!Windows 2015" or some variant. This is a known ACPI problem with 2017 Dell XPS 15 and others. Refer to Bumblebee github issue #764.

- If your laptop freezes during boot in Debian Buster while starting the graphical display, you may try a workaround where you force the Bumblebee service to start after the display manager issue #1036


References


CategoryHardware