Merge branch 'v3.10/topic/misc' into linux-linaro-lsk
[firefly-linux-kernel-4.4.55.git] / drivers / gpu / drm / nouveau / core / subdev / therm / fan.c
1 /*
2  * Copyright 2012 Red Hat Inc.
3  *
4  * Permission is hereby granted, free of charge, to any person obtaining a
5  * copy of this software and associated documentation files (the "Software"),
6  * to deal in the Software without restriction, including without limitation
7  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8  * and/or sell copies of the Software, and to permit persons to whom the
9  * Software is furnished to do so, subject to the following conditions:
10  *
11  * The above copyright notice and this permission notice shall be included in
12  * all copies or substantial portions of the Software.
13  *
14  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
17  * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
18  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
19  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
20  * OTHER DEALINGS IN THE SOFTWARE.
21  *
22  * Authors: Ben Skeggs
23  *          Martin Peres
24  */
25
26 #include "priv.h"
27
28 #include <core/object.h>
29 #include <core/device.h>
30
31 #include <subdev/gpio.h>
32 #include <subdev/timer.h>
33
34 static int
35 nouveau_fan_update(struct nouveau_fan *fan, bool immediate, int target)
36 {
37         struct nouveau_therm *therm = fan->parent;
38         struct nouveau_therm_priv *priv = (void *)therm;
39         struct nouveau_timer *ptimer = nouveau_timer(priv);
40         unsigned long flags;
41         int ret = 0;
42         int duty;
43
44         /* update target fan speed, restricting to allowed range */
45         spin_lock_irqsave(&fan->lock, flags);
46         if (target < 0)
47                 target = fan->percent;
48         target = max_t(u8, target, fan->bios.min_duty);
49         target = min_t(u8, target, fan->bios.max_duty);
50         if (fan->percent != target) {
51                 nv_debug(therm, "FAN target: %d\n", target);
52                 fan->percent = target;
53         }
54
55         /* check that we're not already at the target duty cycle */
56         duty = fan->get(therm);
57         if (duty == target) {
58                 spin_unlock_irqrestore(&fan->lock, flags);
59                 return 0;
60         }
61
62         /* smooth out the fanspeed increase/decrease */
63         if (!immediate && duty >= 0) {
64                 /* the constant "3" is a rough approximation taken from
65                  * nvidia's behaviour.
66                  * it is meant to bump the fan speed more incrementally
67                  */
68                 if (duty < target)
69                         duty = min(duty + 3, target);
70                 else if (duty > target)
71                         duty = max(duty - 3, target);
72         } else {
73                 duty = target;
74         }
75
76         nv_debug(therm, "FAN update: %d\n", duty);
77         ret = fan->set(therm, duty);
78         if (ret) {
79                 spin_unlock_irqrestore(&fan->lock, flags);
80                 return ret;
81         }
82
83         /* fan speed updated, drop the fan lock before grabbing the
84          * alarm-scheduling lock and risking a deadlock
85          */
86         spin_unlock_irqrestore(&fan->lock, flags);
87
88         /* schedule next fan update, if not at target speed already */
89         if (list_empty(&fan->alarm.head) && target != duty) {
90                 u16 bump_period = fan->bios.bump_period;
91                 u16 slow_down_period = fan->bios.slow_down_period;
92                 u64 delay;
93
94                 if (duty > target)
95                         delay = slow_down_period;
96                 else if (duty == target)
97                         delay = min(bump_period, slow_down_period) ;
98                 else
99                         delay = bump_period;
100
101                 ptimer->alarm(ptimer, delay * 1000 * 1000, &fan->alarm);
102         }
103
104         return ret;
105 }
106
107 static void
108 nouveau_fan_alarm(struct nouveau_alarm *alarm)
109 {
110         struct nouveau_fan *fan = container_of(alarm, struct nouveau_fan, alarm);
111         nouveau_fan_update(fan, false, -1);
112 }
113
114 int
115 nouveau_therm_fan_get(struct nouveau_therm *therm)
116 {
117         struct nouveau_therm_priv *priv = (void *)therm;
118         return priv->fan->get(therm);
119 }
120
121 int
122 nouveau_therm_fan_set(struct nouveau_therm *therm, bool immediate, int percent)
123 {
124         struct nouveau_therm_priv *priv = (void *)therm;
125         return nouveau_fan_update(priv->fan, immediate, percent);
126 }
127
128 int
129 nouveau_therm_fan_sense(struct nouveau_therm *therm)
130 {
131         struct nouveau_therm_priv *priv = (void *)therm;
132         struct nouveau_timer *ptimer = nouveau_timer(therm);
133         struct nouveau_gpio *gpio = nouveau_gpio(therm);
134         u32 cycles, cur, prev;
135         u64 start, end, tach;
136
137         if (priv->fan->tach.func == DCB_GPIO_UNUSED)
138                 return -ENODEV;
139
140         /* Time a complete rotation and extrapolate to RPM:
141          * When the fan spins, it changes the value of GPIO FAN_SENSE.
142          * We get 4 changes (0 -> 1 -> 0 -> 1) per complete rotation.
143          */
144         start = ptimer->read(ptimer);
145         prev = gpio->get(gpio, 0, priv->fan->tach.func, priv->fan->tach.line);
146         cycles = 0;
147         do {
148                 usleep_range(500, 1000); /* supports 0 < rpm < 7500 */
149
150                 cur = gpio->get(gpio, 0, priv->fan->tach.func, priv->fan->tach.line);
151                 if (prev != cur) {
152                         if (!start)
153                                 start = ptimer->read(ptimer);
154                         cycles++;
155                         prev = cur;
156                 }
157         } while (cycles < 5 && ptimer->read(ptimer) - start < 250000000);
158         end = ptimer->read(ptimer);
159
160         if (cycles == 5) {
161                 tach = (u64)60000000000ULL;
162                 do_div(tach, (end - start));
163                 return tach;
164         } else
165                 return 0;
166 }
167
168 int
169 nouveau_therm_fan_user_get(struct nouveau_therm *therm)
170 {
171         return nouveau_therm_fan_get(therm);
172 }
173
174 int
175 nouveau_therm_fan_user_set(struct nouveau_therm *therm, int percent)
176 {
177         struct nouveau_therm_priv *priv = (void *)therm;
178
179         if (priv->mode != NOUVEAU_THERM_CTRL_MANUAL)
180                 return -EINVAL;
181
182         return nouveau_therm_fan_set(therm, true, percent);
183 }
184
185 static void
186 nouveau_therm_fan_set_defaults(struct nouveau_therm *therm)
187 {
188         struct nouveau_therm_priv *priv = (void *)therm;
189
190         priv->fan->bios.pwm_freq = 0;
191         priv->fan->bios.min_duty = 0;
192         priv->fan->bios.max_duty = 100;
193         priv->fan->bios.bump_period = 500;
194         priv->fan->bios.slow_down_period = 2000;
195         priv->fan->bios.linear_min_temp = 40;
196         priv->fan->bios.linear_max_temp = 85;
197 }
198
199 static void
200 nouveau_therm_fan_safety_checks(struct nouveau_therm *therm)
201 {
202         struct nouveau_therm_priv *priv = (void *)therm;
203
204         if (priv->fan->bios.min_duty > 100)
205                 priv->fan->bios.min_duty = 100;
206         if (priv->fan->bios.max_duty > 100)
207                 priv->fan->bios.max_duty = 100;
208
209         if (priv->fan->bios.min_duty > priv->fan->bios.max_duty)
210                 priv->fan->bios.min_duty = priv->fan->bios.max_duty;
211 }
212
213 int
214 nouveau_therm_fan_ctor(struct nouveau_therm *therm)
215 {
216         struct nouveau_therm_priv *priv = (void *)therm;
217         struct nouveau_gpio *gpio = nouveau_gpio(therm);
218         struct nouveau_bios *bios = nouveau_bios(therm);
219         struct dcb_gpio_func func;
220         int ret;
221
222         /* attempt to locate a drivable fan, and determine control method */
223         ret = gpio->find(gpio, 0, DCB_GPIO_FAN, 0xff, &func);
224         if (ret == 0) {
225                 if (func.log[0] & DCB_GPIO_LOG_DIR_IN) {
226                         nv_debug(therm, "GPIO_FAN is in input mode\n");
227                         ret = -EINVAL;
228                 } else {
229                         ret = nouveau_fanpwm_create(therm, &func);
230                         if (ret != 0)
231                                 ret = nouveau_fantog_create(therm, &func);
232                 }
233         }
234
235         /* no controllable fan found, create a dummy fan module */
236         if (ret != 0) {
237                 ret = nouveau_fannil_create(therm);
238                 if (ret)
239                         return ret;
240         }
241
242         nv_info(therm, "FAN control: %s\n", priv->fan->type);
243
244         /* attempt to detect a tachometer connection */
245         ret = gpio->find(gpio, 0, DCB_GPIO_FAN_SENSE, 0xff, &priv->fan->tach);
246         if (ret)
247                 priv->fan->tach.func = DCB_GPIO_UNUSED;
248
249         /* initialise fan bump/slow update handling */
250         priv->fan->parent = therm;
251         nouveau_alarm_init(&priv->fan->alarm, nouveau_fan_alarm);
252         spin_lock_init(&priv->fan->lock);
253
254         /* other random init... */
255         nouveau_therm_fan_set_defaults(therm);
256         nvbios_perf_fan_parse(bios, &priv->fan->perf);
257         if (nvbios_therm_fan_parse(bios, &priv->fan->bios))
258                 nv_error(therm, "parsing the thermal table failed\n");
259         nouveau_therm_fan_safety_checks(therm);
260         return 0;
261 }