eclass/nvidia-driver.eclass

   1 # Copyright 1999-2014 Gentoo Foundation
   2 # Distributed under the terms of the GNU General Public License v2
   3 # $Id$
   4
   5 # @ECLASS: nvidia-driver.eclass
   6 # @MAINTAINER:
   7 # Tony Vroon <chainsaw@gentoo.org>
   8 # Jeroen Roovers <jer@gentoo.org>
   9 # @AUTHOR:
  10 # Original author: Doug Goldstein <cardoe@gentoo.org>
  11 # @BLURB: Provide useful messages for nvidia-drivers based on currently installed Nvidia card
  12 # @DESCRIPTION:
  13 # Provide useful messages for nvidia-drivers based on currently installed Nvidia
  14 # card. It inherits versionator.
  15
  16 inherit readme.gentoo versionator
  17
  18 DEPEND="sys-apps/pciutils"
  19
  20 # Variables for readme.gentoo.eclass:
  21 DISABLE_AUTOFORMATTING="yes"
  22 DOC_CONTENTS="You must be in the video group to use the NVIDIA device
  23 For more info, read the docs at
  24 http://www.gentoo.org/doc/en/nvidia-guide.xml#doc_chap3_sect6
  25
  26 This ebuild installs a kernel module and X driver. Both must
  27 match explicitly in their version. This means, if you restart
  28 X, you must modprobe -r nvidia before starting it back up
  29
  30 To use the NVIDIA GLX, run \"eselect opengl set nvidia\"
  31
  32 To use the NVIDIA CUDA/OpenCL, run \"eselect opencl set nvidia\"
  33
  34 NVIDIA has requested that any bug reports submitted have the
  35 output of nvidia-bug-report.sh included.
  36 "
  37
  38 # the data below is derived from
  39 # http://us.download.nvidia.com/XFree86/Linux-x86_64/319.12/README/supportedchips.html
  40
  41 drv_71xx="
  42         0020 0028 0029 002c 002d 00a0 0100 0101 0103 0150 0151 0152 0153
  43 "
  44
  45 drv_96xx="
  46         0110 0111 0112 0113 0170 0171 0172 0173 0174 0175 0176 0177 0178 0179 017a
  47         017c 017d 0181 0182 0183 0185 0188 018a 018b 018c 01a0 01f0 0200 0201 0202
  48         0203 0250 0251 0253 0258 0259 025b 0280 0281 0282 0286 0288 0289 028c
  49 "
  50
  51 drv_173x="
  52         00fa 00fb 00fc 00fd 00fe 0301 0302 0308 0309 0311 0312 0314 031a 031b 031c
  53         0320 0321 0322 0323 0324 0325 0326 0327 0328 032a 032b 032c 032d 0330 0331
  54         0332 0333 0334 0338 033f 0341 0342 0343 0344 0347 0348 034c 034e
  55 "
  56
  57 drv_304x="
  58         0040 0041 0042 0043 0044 0045 0046 0047 0048 004e 0090 0091 0092 0093 0095
  59         0098 0099 009d 00c0 00c1 00c2 00c3 00c8 00c9 00cc 00cd 00ce 00f1 00f2 00f3
  60         00f4 00f5 00f6 00f8 00f9 0140 0141 0142 0143 0144 0145 0146 0147 0148 0149
  61         014a 014c 014d 014e 014f 0160 0161 0162 0163 0164 0165 0166 0167 0168 0169
  62         016a 01d0 01d1 01d2 01d3 01d6 01d7 01d8 01da 01db 01dc 01dd 01de 01df 0211
  63         0212 0215 0218 0221 0222 0240 0241 0242 0244 0245 0247 0290 0291 0292 0293
  64         0294 0295 0297 0298 0299 029a 029b 029c 029d 029e 029f 02e0 02e1 02e2 02e3
  65         02e4 038b 0390 0391 0392 0393 0394 0395 0397 0398 0399 039c 039e 03d0 03d1
  66         03d2 03d5 03d6 0531 0533 053a 053b 053e 07e0 07e1 07e2 07e3 07e5
  67 "
  68
  69 drv_340x="
  70         0191 0193 0194 0197 019d 019e 0400 0401 0402 0403 0404 0405 0406 0407 0408
  71         0409 040a 040b 040c 040d 040e 040f 0410 0420 0421 0422 0423 0424 0425 0426
  72         0427 0428 0429 042a 042b 042c 042d 042e 042f 05e0 05e1 05e2 05e3 05e6 05e7
  73         05e7 05e7 05e7 05e7 05e7 05ea 05eb 05ed 05f8 05f9 05fd 05fe 05ff 0600 0601
  74         0602 0603 0604 0605 0606 0607 0608 0609 0609 060a 060b 060c 060d 060f 0610
  75         0611 0612 0613 0614 0615 0617 0618 0619 061a 061b 061c 061d 061e 061f 0621
  76         0622 0623 0625 0626 0627 0628 062a 062b 062c 062d 062e 062e 0630 0631 0632
  77         0635 0637 0638 063a 0640 0641 0643 0644 0645 0646 0647 0648 0649 0649 064a
  78         064b 064c 0651 0652 0652 0653 0654 0654 0654 0655 0656 0658 0659 065a 065b
  79         065c 06e0 06e1 06e2 06e3 06e4 06e5 06e6 06e7 06e8 06e8 06e9 06ea 06eb 06ec
  80         06ef 06f1 06f8 06f9 06f9 06fa 06fb 06fd 06ff 06ff 0840 0844 0845 0846 0847
  81         0848 0849 084a 084b 084c 084d 084f 0860 0861 0862 0863 0864 0865 0866 0866
  82         0867 0868 0869 086a 086c 086d 086e 086f 0870 0871 0872 0872 0873 0873 0874
  83         0876 087a 087d 087e 087f 08a0 08a2 08a3 08a4 08a5 0a20 0a22 0a23 0a26 0a27
  84         0a28 0a29 0a2a 0a2b 0a2c 0a2d 0a32 0a34 0a35 0a38 0a3c 0a60 0a62 0a63 0a64
  85         0a65 0a66 0a67 0a68 0a69 0a6a 0a6c 0a6e 0a6e 0a6f 0a70 0a70 0a70 0a71 0a72
  86         0a73 0a73 0a73 0a74 0a74 0a75 0a75 0a76 0a78 0a7a 0a7a 0a7a 0a7a 0a7a 0a7a
  87         0a7a 0a7a 0a7a 0a7a 0a7a 0a7c 0ca0 0ca2 0ca3 0ca4 0ca5 0ca7 0ca8 0ca9 0cac
  88         0caf 0cb0 0cb1 0cbc 10c0 10c3 10c5 10d8
  89 "
  90
  91 mask_71xx=">=x11-drivers/nvidia-drivers-72.0.0"
  92 mask_96xx=">=x11-drivers/nvidia-drivers-97.0.0"
  93 mask_173x=">=x11-drivers/nvidia-drivers-177.0.0"
  94 mask_304x=">=x11-drivers/nvidia-drivers-305.0.0"
  95 mask_340x=">=x11-drivers/nvidia-drivers-341.0.0"
  96
  97 # @FUNCTION: nvidia-driver-get-card
  98 # @DESCRIPTION:
  99 # Retrieve the PCI device ID for each Nvidia video card you have
 100 nvidia-driver-get-card() {
 101         local NVIDIA_CARD=$(
 102                 [ -x /usr/sbin/lspci ] && /usr/sbin/lspci -d 10de: -n \
 103                         | awk -F'[: ]' '/ 0300: /{print $6}'
 104         )
 105
 106         if [ -n "${NVIDIA_CARD}" ]; then
 107                 echo "${NVIDIA_CARD}"
 108         else
 109                 echo 0000
 110         fi
 111 }
 112
 113 nvidia-driver-get-mask() {
 114         local NVIDIA_CARDS="$(nvidia-driver-get-card)"
 115         local card drv
 116
 117         for card in ${NVIDIA_CARDS}; do
 118                 for drv in ${drv_71xx}; do
 119                         if [ "x${card}" = "x${drv}" ]; then
 120                                 echo "${mask_71xx}"
 121                                 return 0
 122                         fi
 123                 done
 124
 125                 for drv in ${drv_96xx}; do
 126                         if [ "x${card}" = "x${drv}" ]; then
 127                                 echo "${mask_96xx}"
 128                                 return 0
 129                         fi
 130                 done
 131
 132                 for drv in ${drv_173x}; do
 133                         if [ "x${card}" = "x${drv}" ]; then
 134                                 echo "${mask_173x}"
 135                                 return 0
 136                         fi
 137                 done
 138
 139                 for drv in ${drv_304x}; do
 140                         if [ "x${card}" = "x${drv}" ]; then
 141                                 echo "${mask_304x}"
 142                                 return 0
 143                         fi
 144                 done
 145
 146                 for drv in ${drv_340x}; do
 147                         if [ "x${card}" = "x${drv}" ]; then
 148                                 echo "${mask_340x}"
 149                                 return 0
 150                         fi
 151                 done
 152         done
 153
 154         echo ''
 155         return 1
 156 }
 157
 158 # @FUNCTION: nvidia-driver-check-warning
 159 # @DESCRIPTION:
 160 # Prints out a warning if the driver does not work w/ the installed video card
 161 nvidia-driver-check-warning() {
 162         local NVIDIA_MASK="$(nvidia-driver-get-mask)"
 163
 164         if [ -n "${NVIDIA_MASK}" ]; then
 165                 version_compare "${NVIDIA_MASK##*-}" "${PV}"
 166                 if [ x"${?}" = x1 ]; then
 167                         ewarn "***** WARNING *****"
 168                         ewarn
 169                         ewarn "You are currently installing a version of nvidia-drivers that is"
 170                         ewarn "known not to work with a video card you have installed on your"
 171                         ewarn "system. If this is intentional, please ignore this. If it is not"
 172                         ewarn "please perform the following steps:"
 173                         ewarn
 174                         ewarn "Add the following mask entry to /etc/portage/package.mask by"
 175                         if [ -d "${ROOT}/etc/portage/package.mask" ]; then
 176                                 ewarn "echo \"${NVIDIA_MASK}\" > /etc/portage/package.mask/nvidia-drivers"
 177                         else
 178                                 ewarn "echo \"${NVIDIA_MASK}\" >> /etc/portage/package.mask"
 179                         fi
 180                         ewarn
 181                         ewarn "Failure to perform the steps above could result in a non-working"
 182                         ewarn "X setup."
 183                         ewarn
 184                         ewarn "For more information please read:"
 185                         ewarn "http://www.nvidia.com/object/IO_32667.html"
 186                 fi
 187         fi
 188 }