1 ===================== 1 =====================
2 Kernel driver nouveau 2 Kernel driver nouveau
3 ===================== 3 =====================
4 4
5 Supported chips: 5 Supported chips:
6 6
7 * NV43+ 7 * NV43+
8 8
9 Authors: Martin Peres (mupuf) <martin.peres@fre 9 Authors: Martin Peres (mupuf) <martin.peres@free.fr>
10 10
11 Description 11 Description
12 ----------- 12 -----------
13 13
14 This driver allows to read the GPU core temper 14 This driver allows to read the GPU core temperature, drive the GPU fan and
15 set temperature alarms. 15 set temperature alarms.
16 16
17 Currently, due to the absence of in-kernel API 17 Currently, due to the absence of in-kernel API to access HWMON drivers, Nouveau
18 cannot access any of the i2c external monitori 18 cannot access any of the i2c external monitoring chips it may find. If you
19 have one of those, temperature and/or fan mana 19 have one of those, temperature and/or fan management through Nouveau's HWMON
20 interface is likely not to work. This document 20 interface is likely not to work. This document may then not cover your situation
21 entirely. 21 entirely.
22 22
23 Temperature management 23 Temperature management
24 ---------------------- 24 ----------------------
25 25
26 Temperature is exposed under as a read-only HW 26 Temperature is exposed under as a read-only HWMON attribute temp1_input.
27 27
28 In order to protect the GPU from overheating, 28 In order to protect the GPU from overheating, Nouveau supports 4 configurable
29 temperature thresholds: 29 temperature thresholds:
30 30
31 * Fan_boost: 31 * Fan_boost:
32 Fan speed is set to 100% when reaching 32 Fan speed is set to 100% when reaching this temperature;
33 * Downclock: 33 * Downclock:
34 The GPU will be downclocked to reduce 34 The GPU will be downclocked to reduce its power dissipation;
35 * Critical: 35 * Critical:
36 The GPU is put on hold to further lowe 36 The GPU is put on hold to further lower power dissipation;
37 * Shutdown: 37 * Shutdown:
38 Shut the computer down to protect your 38 Shut the computer down to protect your GPU.
39 39
40 WARNING: 40 WARNING:
41 Some of these thresholds may not be us 41 Some of these thresholds may not be used by Nouveau depending
42 on your chipset. 42 on your chipset.
43 43
44 The default value for these thresholds comes f 44 The default value for these thresholds comes from the GPU's vbios. These
45 thresholds can be configured thanks to the fol 45 thresholds can be configured thanks to the following HWMON attributes:
46 46
47 * Fan_boost: temp1_auto_point1_temp and temp1 47 * Fan_boost: temp1_auto_point1_temp and temp1_auto_point1_temp_hyst;
48 * Downclock: temp1_max and temp1_max_hyst; 48 * Downclock: temp1_max and temp1_max_hyst;
49 * Critical: temp1_crit and temp1_crit_hyst; 49 * Critical: temp1_crit and temp1_crit_hyst;
50 * Shutdown: temp1_emergency and temp1_emergen 50 * Shutdown: temp1_emergency and temp1_emergency_hyst.
51 51
52 NOTE: Remember that the values are stored as m 52 NOTE: Remember that the values are stored as milli degrees Celsius. Don't forget
53 to multiply! 53 to multiply!
54 54
55 Fan management 55 Fan management
56 -------------- 56 --------------
57 57
58 Not all cards have a drivable fan. If you do, 58 Not all cards have a drivable fan. If you do, then the following HWMON
59 attributes should be available: 59 attributes should be available:
60 60
61 * pwm1_enable: 61 * pwm1_enable:
62 Current fan management mode (NONE, MAN 62 Current fan management mode (NONE, MANUAL or AUTO);
63 * pwm1: 63 * pwm1:
64 Current PWM value (power percentage); 64 Current PWM value (power percentage);
65 * pwm1_min: 65 * pwm1_min:
66 The minimum PWM speed allowed; 66 The minimum PWM speed allowed;
67 * pwm1_max: 67 * pwm1_max:
68 The maximum PWM speed allowed (bypasse 68 The maximum PWM speed allowed (bypassed when hitting Fan_boost);
69 69
70 You may also have the following attribute: 70 You may also have the following attribute:
71 71
72 * fan1_input: 72 * fan1_input:
73 Speed in RPM of your fan. 73 Speed in RPM of your fan.
74 74
75 Your fan can be driven in different modes: 75 Your fan can be driven in different modes:
76 76
77 * 0: The fan is left untouched; 77 * 0: The fan is left untouched;
78 * 1: The fan can be driven in manual (use pwm 78 * 1: The fan can be driven in manual (use pwm1 to change the speed);
79 * 2; The fan is driven automatically dependin 79 * 2; The fan is driven automatically depending on the temperature.
80 80
81 NOTE: 81 NOTE:
82 Be sure to use the manual mode if you want t 82 Be sure to use the manual mode if you want to drive the fan speed manually
83 83
84 NOTE2: 84 NOTE2:
85 When operating in manual mode outside the vb 85 When operating in manual mode outside the vbios-defined
86 [PWM_min, PWM_max] range, the reported fan s 86 [PWM_min, PWM_max] range, the reported fan speed (RPM) may not be accurate
87 depending on your hardware. 87 depending on your hardware.
88 88
89 Bug reports 89 Bug reports
90 ----------- 90 -----------
91 91
92 Thermal management on Nouveau is new and may n 92 Thermal management on Nouveau is new and may not work on all cards. If you have
93 inquiries, please ping mupuf on IRC (#nouveau, 93 inquiries, please ping mupuf on IRC (#nouveau, OFTC).
94 94
95 Bug reports should be filled on Freedesktop's 95 Bug reports should be filled on Freedesktop's bug tracker. Please follow
96 https://nouveau.freedesktop.org/wiki/Bugs 96 https://nouveau.freedesktop.org/wiki/Bugs
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.