eclass/nvidia-driver.eclass

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