staging: omap-thermal: style cleanup on omap-bandgap.c
[linux-2.6-block.git] / drivers / staging / omap-thermal / omap-bandgap.c
1 /*
2  * OMAP4 Bandgap temperature sensor driver
3  *
4  * Copyright (C) 2011-2012 Texas Instruments Incorporated - http://www.ti.com/
5  * Author: J Keerthy <j-keerthy@ti.com>
6  * Author: Moiz Sonasath <m-sonasath@ti.com>
7  * Couple of fixes, DT and MFD adaptation:
8  *   Eduardo Valentin <eduardo.valentin@ti.com>
9  *
10  * This program is free software; you can redistribute it and/or
11  * modify it under the terms of the GNU General Public License
12  * version 2 as published by the Free Software Foundation.
13  *
14  * This program is distributed in the hope that it will be useful, but
15  * WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
17  * General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software
21  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
22  * 02110-1301 USA
23  *
24  */
25
26 #include <linux/module.h>
27 #include <linux/export.h>
28 #include <linux/init.h>
29 #include <linux/kernel.h>
30 #include <linux/interrupt.h>
31 #include <linux/clk.h>
32 #include <linux/gpio.h>
33 #include <linux/platform_device.h>
34 #include <linux/err.h>
35 #include <linux/types.h>
36 #include <linux/mutex.h>
37 #include <linux/reboot.h>
38 #include <linux/of_device.h>
39 #include <linux/of_platform.h>
40 #include <linux/of_irq.h>
41 #include <linux/io.h>
42
43 #include "omap-bandgap.h"
44
45 static u32 omap_bandgap_readl(struct omap_bandgap *bg_ptr, u32 reg)
46 {
47         return readl(bg_ptr->base + reg);
48 }
49
50 static void omap_bandgap_writel(struct omap_bandgap *bg_ptr, u32 val, u32 reg)
51 {
52         writel(val, bg_ptr->base + reg);
53 }
54
55 static int omap_bandgap_power(struct omap_bandgap *bg_ptr, bool on)
56 {
57         struct temp_sensor_registers *tsr;
58         int i;
59         u32 ctrl;
60
61         if (!OMAP_BANDGAP_HAS(bg_ptr, POWER_SWITCH))
62                 return 0;
63
64         for (i = 0; i < bg_ptr->conf->sensor_count; i++) {
65                 tsr = bg_ptr->conf->sensors[i].registers;
66                 ctrl = omap_bandgap_readl(bg_ptr, tsr->temp_sensor_ctrl);
67                 ctrl &= ~tsr->bgap_tempsoff_mask;
68                 /* active on 0 */
69                 ctrl |= !on << __ffs(tsr->bgap_tempsoff_mask);
70
71                 /* write BGAP_TEMPSOFF should be reset to 0 */
72                 omap_bandgap_writel(bg_ptr, ctrl, tsr->temp_sensor_ctrl);
73         }
74
75         return 0;
76 }
77
78 static u32 omap_bandgap_read_temp(struct omap_bandgap *bg_ptr, int id)
79 {
80         struct temp_sensor_registers *tsr;
81         u32 temp, ctrl, reg;
82
83         tsr = bg_ptr->conf->sensors[id].registers;
84         reg = tsr->temp_sensor_ctrl;
85
86         if (OMAP_BANDGAP_HAS(bg_ptr, FREEZE_BIT)) {
87                 ctrl = omap_bandgap_readl(bg_ptr, tsr->bgap_mask_ctrl);
88                 ctrl |= tsr->mask_freeze_mask;
89                 omap_bandgap_writel(bg_ptr, ctrl, tsr->bgap_mask_ctrl);
90                 /*
91                  * In case we cannot read from cur_dtemp / dtemp_0,
92                  * then we read from the last valid temp read
93                  */
94                 reg = tsr->ctrl_dtemp_1;
95         }
96
97         /* read temperature */
98         temp = omap_bandgap_readl(bg_ptr, reg);
99         temp &= tsr->bgap_dtemp_mask;
100
101         if (OMAP_BANDGAP_HAS(bg_ptr, FREEZE_BIT)) {
102                 ctrl = omap_bandgap_readl(bg_ptr, tsr->bgap_mask_ctrl);
103                 ctrl &= ~tsr->mask_freeze_mask;
104                 omap_bandgap_writel(bg_ptr, ctrl, tsr->bgap_mask_ctrl);
105         }
106
107         return temp;
108 }
109
110 /* This is the Talert handler. Call it only if HAS(TALERT) is set */
111 static irqreturn_t talert_irq_handler(int irq, void *data)
112 {
113         struct omap_bandgap *bg_ptr = data;
114         struct temp_sensor_registers *tsr;
115         u32 t_hot = 0, t_cold = 0, ctrl;
116         int i;
117
118         bg_ptr = data;
119         /* Read the status of t_hot */
120         for (i = 0; i < bg_ptr->conf->sensor_count; i++) {
121                 tsr = bg_ptr->conf->sensors[i].registers;
122                 t_hot = omap_bandgap_readl(bg_ptr, tsr->bgap_status);
123                 t_hot &= tsr->status_hot_mask;
124
125                 /* Read the status of t_cold */
126                 t_cold = omap_bandgap_readl(bg_ptr, tsr->bgap_status);
127                 t_cold &= tsr->status_cold_mask;
128
129                 if (!t_cold && !t_hot)
130                         continue;
131
132                 ctrl = omap_bandgap_readl(bg_ptr, tsr->bgap_mask_ctrl);
133                 /*
134                  * One TALERT interrupt: Two sources
135                  * If the interrupt is due to t_hot then mask t_hot and
136                  * and unmask t_cold else mask t_cold and unmask t_hot
137                  */
138                 if (t_hot) {
139                         ctrl &= ~tsr->mask_hot_mask;
140                         ctrl |= tsr->mask_cold_mask;
141                 } else if (t_cold) {
142                         ctrl &= ~tsr->mask_cold_mask;
143                         ctrl |= tsr->mask_hot_mask;
144                 }
145
146                 omap_bandgap_writel(bg_ptr, ctrl, tsr->bgap_mask_ctrl);
147
148                 dev_dbg(bg_ptr->dev,
149                         "%s: IRQ from %s sensor: hotevent %d coldevent %d\n",
150                         __func__, bg_ptr->conf->sensors[i].domain,
151                         t_hot, t_cold);
152
153                 /* report temperature to whom may concern */
154                 if (bg_ptr->conf->report_temperature)
155                         bg_ptr->conf->report_temperature(bg_ptr, i);
156         }
157
158         return IRQ_HANDLED;
159 }
160
161 /* This is the Tshut handler. Call it only if HAS(TSHUT) is set */
162 static irqreturn_t omap_bandgap_tshut_irq_handler(int irq, void *data)
163 {
164         pr_emerg("%s: TSHUT temperature reached. Needs shut down...\n",
165                  __func__);
166
167         orderly_poweroff(true);
168
169         return IRQ_HANDLED;
170 }
171
172 static
173 int adc_to_temp_conversion(struct omap_bandgap *bg_ptr, int id, int adc_val,
174                            int *t)
175 {
176         struct temp_sensor_data *ts_data = bg_ptr->conf->sensors[id].ts_data;
177
178         /* look up for temperature in the table and return the temperature */
179         if (adc_val < ts_data->adc_start_val || adc_val > ts_data->adc_end_val)
180                 return -ERANGE;
181
182         *t = bg_ptr->conf->conv_table[adc_val - ts_data->adc_start_val];
183
184         return 0;
185 }
186
187 static int temp_to_adc_conversion(long temp, struct omap_bandgap *bg_ptr, int i,
188                                   int *adc)
189 {
190         struct temp_sensor_data *ts_data = bg_ptr->conf->sensors[i].ts_data;
191         const int *conv_table = bg_ptr->conf->conv_table;
192         int high, low, mid;
193
194         low = 0;
195         high = ts_data->adc_end_val - ts_data->adc_start_val;
196         mid = (high + low) / 2;
197
198         if (temp < conv_table[low] || temp > conv_table[high])
199                 return -EINVAL;
200
201         while (low < high) {
202                 if (temp < conv_table[mid])
203                         high = mid - 1;
204                 else
205                         low = mid + 1;
206                 mid = (low + high) / 2;
207         }
208
209         *adc = ts_data->adc_start_val + low;
210
211         return 0;
212 }
213
214 /* Talert masks. Call it only if HAS(TALERT) is set */
215 static int temp_sensor_unmask_interrupts(struct omap_bandgap *bg_ptr, int id,
216                                          u32 t_hot, u32 t_cold)
217 {
218         struct temp_sensor_registers *tsr;
219         u32 temp, reg_val;
220
221         /* Read the current on die temperature */
222         temp = omap_bandgap_read_temp(bg_ptr, id);
223
224         tsr = bg_ptr->conf->sensors[id].registers;
225         reg_val = omap_bandgap_readl(bg_ptr, tsr->bgap_mask_ctrl);
226
227         if (temp < t_hot)
228                 reg_val |= tsr->mask_hot_mask;
229         else
230                 reg_val &= ~tsr->mask_hot_mask;
231
232         if (t_cold < temp)
233                 reg_val |= tsr->mask_cold_mask;
234         else
235                 reg_val &= ~tsr->mask_cold_mask;
236         omap_bandgap_writel(bg_ptr, reg_val, tsr->bgap_mask_ctrl);
237
238         return 0;
239 }
240
241 static
242 int add_hyst(int adc_val, int hyst_val, struct omap_bandgap *bg_ptr, int i,
243              u32 *sum)
244 {
245         int temp, ret;
246
247         ret = adc_to_temp_conversion(bg_ptr, i, adc_val, &temp);
248         if (ret < 0)
249                 return ret;
250
251         temp += hyst_val;
252
253         return temp_to_adc_conversion(temp, bg_ptr, i, sum);
254 }
255
256 /* Talert Thot threshold. Call it only if HAS(TALERT) is set */
257 static
258 int temp_sensor_configure_thot(struct omap_bandgap *bg_ptr, int id, int t_hot)
259 {
260         struct temp_sensor_data *ts_data = bg_ptr->conf->sensors[id].ts_data;
261         struct temp_sensor_registers *tsr;
262         u32 thresh_val, reg_val;
263         int cold, err = 0;
264
265         tsr = bg_ptr->conf->sensors[id].registers;
266
267         /* obtain the T cold value */
268         thresh_val = omap_bandgap_readl(bg_ptr, tsr->bgap_threshold);
269         cold = (thresh_val & tsr->threshold_tcold_mask) >>
270             __ffs(tsr->threshold_tcold_mask);
271         if (t_hot <= cold) {
272                 /* change the t_cold to t_hot - 5000 millidegrees */
273                 err |= add_hyst(t_hot, -ts_data->hyst_val, bg_ptr, id, &cold);
274                 /* write the new t_cold value */
275                 reg_val = thresh_val & (~tsr->threshold_tcold_mask);
276                 reg_val |= cold << __ffs(tsr->threshold_tcold_mask);
277                 omap_bandgap_writel(bg_ptr, reg_val, tsr->bgap_threshold);
278                 thresh_val = reg_val;
279         }
280
281         /* write the new t_hot value */
282         reg_val = thresh_val & ~tsr->threshold_thot_mask;
283         reg_val |= (t_hot << __ffs(tsr->threshold_thot_mask));
284         omap_bandgap_writel(bg_ptr, reg_val, tsr->bgap_threshold);
285         if (err) {
286                 dev_err(bg_ptr->dev, "failed to reprogram thot threshold\n");
287                 return -EIO;
288         }
289
290         return temp_sensor_unmask_interrupts(bg_ptr, id, t_hot, cold);
291 }
292
293 /* Talert Thot and Tcold thresholds. Call it only if HAS(TALERT) is set */
294 static
295 int temp_sensor_init_talert_thresholds(struct omap_bandgap *bg_ptr, int id,
296                                        int t_hot, int t_cold)
297 {
298         struct temp_sensor_registers *tsr;
299         u32 reg_val, thresh_val;
300
301         tsr = bg_ptr->conf->sensors[id].registers;
302         thresh_val = omap_bandgap_readl(bg_ptr, tsr->bgap_threshold);
303
304         /* write the new t_cold value */
305         reg_val = thresh_val & ~tsr->threshold_tcold_mask;
306         reg_val |= (t_cold << __ffs(tsr->threshold_tcold_mask));
307         omap_bandgap_writel(bg_ptr, reg_val, tsr->bgap_threshold);
308
309         thresh_val = omap_bandgap_readl(bg_ptr, tsr->bgap_threshold);
310
311         /* write the new t_hot value */
312         reg_val = thresh_val & ~tsr->threshold_thot_mask;
313         reg_val |= (t_hot << __ffs(tsr->threshold_thot_mask));
314         omap_bandgap_writel(bg_ptr, reg_val, tsr->bgap_threshold);
315
316         reg_val = omap_bandgap_readl(bg_ptr, tsr->bgap_mask_ctrl);
317         reg_val |= tsr->mask_hot_mask;
318         reg_val |= tsr->mask_cold_mask;
319         omap_bandgap_writel(bg_ptr, reg_val, tsr->bgap_mask_ctrl);
320
321         return 0;
322 }
323
324 /* Talert Tcold threshold. Call it only if HAS(TALERT) is set */
325 static
326 int temp_sensor_configure_tcold(struct omap_bandgap *bg_ptr, int id,
327                                 int t_cold)
328 {
329         struct temp_sensor_data *ts_data = bg_ptr->conf->sensors[id].ts_data;
330         struct temp_sensor_registers *tsr;
331         u32 thresh_val, reg_val;
332         int hot, err = 0;
333
334         tsr = bg_ptr->conf->sensors[id].registers;
335         /* obtain the T cold value */
336         thresh_val = omap_bandgap_readl(bg_ptr, tsr->bgap_threshold);
337         hot = (thresh_val & tsr->threshold_thot_mask) >>
338             __ffs(tsr->threshold_thot_mask);
339
340         if (t_cold >= hot) {
341                 /* change the t_hot to t_cold + 5000 millidegrees */
342                 err |= add_hyst(t_cold, ts_data->hyst_val, bg_ptr, id, &hot);
343                 /* write the new t_hot value */
344                 reg_val = thresh_val & (~tsr->threshold_thot_mask);
345                 reg_val |= hot << __ffs(tsr->threshold_thot_mask);
346                 omap_bandgap_writel(bg_ptr, reg_val, tsr->bgap_threshold);
347                 thresh_val = reg_val;
348         }
349
350         /* write the new t_cold value */
351         reg_val = thresh_val & ~tsr->threshold_tcold_mask;
352         reg_val |= (t_cold << __ffs(tsr->threshold_tcold_mask));
353         omap_bandgap_writel(bg_ptr, reg_val, tsr->bgap_threshold);
354         if (err) {
355                 dev_err(bg_ptr->dev, "failed to reprogram tcold threshold\n");
356                 return -EIO;
357         }
358
359         return temp_sensor_unmask_interrupts(bg_ptr, id, hot, t_cold);
360 }
361
362 /* This is Tshut Thot config. Call it only if HAS(TSHUT_CONFIG) is set */
363 static int temp_sensor_configure_tshut_hot(struct omap_bandgap *bg_ptr,
364                                            int id, int tshut_hot)
365 {
366         struct temp_sensor_registers *tsr;
367         u32 reg_val;
368
369         tsr = bg_ptr->conf->sensors[id].registers;
370         reg_val = omap_bandgap_readl(bg_ptr, tsr->tshut_threshold);
371         reg_val &= ~tsr->tshut_hot_mask;
372         reg_val |= tshut_hot << __ffs(tsr->tshut_hot_mask);
373         omap_bandgap_writel(bg_ptr, reg_val, tsr->tshut_threshold);
374
375         return 0;
376 }
377
378 /* This is Tshut Tcold config. Call it only if HAS(TSHUT_CONFIG) is set */
379 static int temp_sensor_configure_tshut_cold(struct omap_bandgap *bg_ptr,
380                                             int id, int tshut_cold)
381 {
382         struct temp_sensor_registers *tsr;
383         u32 reg_val;
384
385         tsr = bg_ptr->conf->sensors[id].registers;
386         reg_val = omap_bandgap_readl(bg_ptr, tsr->tshut_threshold);
387         reg_val &= ~tsr->tshut_cold_mask;
388         reg_val |= tshut_cold << __ffs(tsr->tshut_cold_mask);
389         omap_bandgap_writel(bg_ptr, reg_val, tsr->tshut_threshold);
390
391         return 0;
392 }
393
394 /* This is counter config. Call it only if HAS(COUNTER) is set */
395 static int configure_temp_sensor_counter(struct omap_bandgap *bg_ptr, int id,
396                                          u32 counter)
397 {
398         struct temp_sensor_registers *tsr;
399         u32 val;
400
401         tsr = bg_ptr->conf->sensors[id].registers;
402         val = omap_bandgap_readl(bg_ptr, tsr->bgap_counter);
403         val &= ~tsr->counter_mask;
404         val |= counter << __ffs(tsr->counter_mask);
405         omap_bandgap_writel(bg_ptr, val, tsr->bgap_counter);
406
407         return 0;
408 }
409
410 #define bandgap_is_valid(b)                                             \
411                         (!IS_ERR_OR_NULL(b))
412 #define bandgap_is_valid_sensor_id(b, i)                                \
413                         ((i) >= 0 && (i) < (b)->conf->sensor_count)
414 static inline int omap_bandgap_validate(struct omap_bandgap *bg_ptr, int id)
415 {
416         if (!bandgap_is_valid(bg_ptr)) {
417                 pr_err("%s: invalid bandgap pointer\n", __func__);
418                 return -EINVAL;
419         }
420
421         if (!bandgap_is_valid_sensor_id(bg_ptr, id)) {
422                 dev_err(bg_ptr->dev, "%s: sensor id out of range (%d)\n",
423                         __func__, id);
424                 return -ERANGE;
425         }
426
427         return 0;
428 }
429
430 /* Exposed APIs */
431 /**
432  * omap_bandgap_read_thot() - reads sensor current thot
433  * @bg_ptr - pointer to bandgap instance
434  * @id - sensor id
435  * @thot - resulting current thot value
436  *
437  * returns 0 on success or the proper error code
438  */
439 int omap_bandgap_read_thot(struct omap_bandgap *bg_ptr, int id,
440                            int *thot)
441 {
442         struct temp_sensor_registers *tsr;
443         u32 temp;
444         int ret;
445
446         ret = omap_bandgap_validate(bg_ptr, id);
447         if (ret)
448                 return ret;
449
450         if (!OMAP_BANDGAP_HAS(bg_ptr, TALERT))
451                 return -ENOTSUPP;
452
453         tsr = bg_ptr->conf->sensors[id].registers;
454         temp = omap_bandgap_readl(bg_ptr, tsr->bgap_threshold);
455         temp = (temp & tsr->threshold_thot_mask) >>
456                 __ffs(tsr->threshold_thot_mask);
457         ret |= adc_to_temp_conversion(bg_ptr, id, temp, &temp);
458         if (ret) {
459                 dev_err(bg_ptr->dev, "failed to read thot\n");
460                 return -EIO;
461         }
462
463         *thot = temp;
464
465         return 0;
466 }
467
468 /**
469  * omap_bandgap_write_thot() - sets sensor current thot
470  * @bg_ptr - pointer to bandgap instance
471  * @id - sensor id
472  * @val - desired thot value
473  *
474  * returns 0 on success or the proper error code
475  */
476 int omap_bandgap_write_thot(struct omap_bandgap *bg_ptr, int id, int val)
477 {
478         struct temp_sensor_data *ts_data;
479         struct temp_sensor_registers *tsr;
480         u32 t_hot;
481         int ret;
482
483         ret = omap_bandgap_validate(bg_ptr, id);
484         if (ret)
485                 return ret;
486
487         if (!OMAP_BANDGAP_HAS(bg_ptr, TALERT))
488                 return -ENOTSUPP;
489
490         ts_data = bg_ptr->conf->sensors[id].ts_data;
491         tsr = bg_ptr->conf->sensors[id].registers;
492
493         if (val < ts_data->min_temp + ts_data->hyst_val)
494                 return -EINVAL;
495         ret = temp_to_adc_conversion(val, bg_ptr, id, &t_hot);
496         if (ret < 0)
497                 return ret;
498
499         mutex_lock(&bg_ptr->bg_mutex);
500         temp_sensor_configure_thot(bg_ptr, id, t_hot);
501         mutex_unlock(&bg_ptr->bg_mutex);
502
503         return 0;
504 }
505
506 /**
507  * omap_bandgap_read_tcold() - reads sensor current tcold
508  * @bg_ptr - pointer to bandgap instance
509  * @id - sensor id
510  * @tcold - resulting current tcold value
511  *
512  * returns 0 on success or the proper error code
513  */
514 int omap_bandgap_read_tcold(struct omap_bandgap *bg_ptr, int id,
515                             int *tcold)
516 {
517         struct temp_sensor_registers *tsr;
518         u32 temp;
519         int ret;
520
521         ret = omap_bandgap_validate(bg_ptr, id);
522         if (ret)
523                 return ret;
524
525         if (!OMAP_BANDGAP_HAS(bg_ptr, TALERT))
526                 return -ENOTSUPP;
527
528         tsr = bg_ptr->conf->sensors[id].registers;
529         temp = omap_bandgap_readl(bg_ptr, tsr->bgap_threshold);
530         temp = (temp & tsr->threshold_tcold_mask)
531             >> __ffs(tsr->threshold_tcold_mask);
532         ret |= adc_to_temp_conversion(bg_ptr, id, temp, &temp);
533         if (ret)
534                 return -EIO;
535
536         *tcold = temp;
537
538         return 0;
539 }
540
541 /**
542  * omap_bandgap_write_tcold() - sets the sensor tcold
543  * @bg_ptr - pointer to bandgap instance
544  * @id - sensor id
545  * @val - desired tcold value
546  *
547  * returns 0 on success or the proper error code
548  */
549 int omap_bandgap_write_tcold(struct omap_bandgap *bg_ptr, int id, int val)
550 {
551         struct temp_sensor_data *ts_data;
552         struct temp_sensor_registers *tsr;
553         u32 t_cold;
554         int ret;
555
556         ret = omap_bandgap_validate(bg_ptr, id);
557         if (ret)
558                 return ret;
559
560         if (!OMAP_BANDGAP_HAS(bg_ptr, TALERT))
561                 return -ENOTSUPP;
562
563         ts_data = bg_ptr->conf->sensors[id].ts_data;
564         tsr = bg_ptr->conf->sensors[id].registers;
565         if (val > ts_data->max_temp + ts_data->hyst_val)
566                 return -EINVAL;
567
568         ret = temp_to_adc_conversion(val, bg_ptr, id, &t_cold);
569         if (ret < 0)
570                 return ret;
571
572         mutex_lock(&bg_ptr->bg_mutex);
573         temp_sensor_configure_tcold(bg_ptr, id, t_cold);
574         mutex_unlock(&bg_ptr->bg_mutex);
575
576         return 0;
577 }
578
579 /**
580  * omap_bandgap_read_update_interval() - read the sensor update interval
581  * @bg_ptr - pointer to bandgap instance
582  * @id - sensor id
583  * @interval - resulting update interval in miliseconds
584  *
585  * returns 0 on success or the proper error code
586  */
587 int omap_bandgap_read_update_interval(struct omap_bandgap *bg_ptr, int id,
588                                          int *interval)
589 {
590         struct temp_sensor_registers *tsr;
591         u32 time;
592         int ret;
593
594         ret = omap_bandgap_validate(bg_ptr, id);
595         if (ret)
596                 return ret;
597
598         if (!OMAP_BANDGAP_HAS(bg_ptr, COUNTER))
599                 return -ENOTSUPP;
600
601         tsr = bg_ptr->conf->sensors[id].registers;
602         time = omap_bandgap_readl(bg_ptr, tsr->bgap_counter);
603         time = (time & tsr->counter_mask) >> __ffs(tsr->counter_mask);
604         time = time * 1000 / bg_ptr->clk_rate;
605
606         *interval = time;
607
608         return 0;
609 }
610
611 /**
612  * omap_bandgap_write_update_interval() - set the update interval
613  * @bg_ptr - pointer to bandgap instance
614  * @id - sensor id
615  * @interval - desired update interval in miliseconds
616  *
617  * returns 0 on success or the proper error code
618  */
619 int omap_bandgap_write_update_interval(struct omap_bandgap *bg_ptr,
620                                        int id, u32 interval)
621 {
622         int ret = omap_bandgap_validate(bg_ptr, id);
623         if (ret)
624                 return ret;
625
626         if (!OMAP_BANDGAP_HAS(bg_ptr, COUNTER))
627                 return -ENOTSUPP;
628
629         interval = interval * bg_ptr->clk_rate / 1000;
630         mutex_lock(&bg_ptr->bg_mutex);
631         configure_temp_sensor_counter(bg_ptr, id, interval);
632         mutex_unlock(&bg_ptr->bg_mutex);
633
634         return 0;
635 }
636
637 /**
638  * omap_bandgap_read_temperature() - report current temperature
639  * @bg_ptr - pointer to bandgap instance
640  * @id - sensor id
641  * @temperature - resulting temperature
642  *
643  * returns 0 on success or the proper error code
644  */
645 int omap_bandgap_read_temperature(struct omap_bandgap *bg_ptr, int id,
646                                   int *temperature)
647 {
648         struct temp_sensor_registers *tsr;
649         u32 temp;
650         int ret;
651
652         ret = omap_bandgap_validate(bg_ptr, id);
653         if (ret)
654                 return ret;
655
656         tsr = bg_ptr->conf->sensors[id].registers;
657         mutex_lock(&bg_ptr->bg_mutex);
658         temp = omap_bandgap_read_temp(bg_ptr, id);
659         mutex_unlock(&bg_ptr->bg_mutex);
660
661         ret |= adc_to_temp_conversion(bg_ptr, id, temp, &temp);
662         if (ret)
663                 return -EIO;
664
665         *temperature = temp;
666
667         return 0;
668 }
669
670 /**
671  * omap_bandgap_set_sensor_data() - helper function to store thermal
672  * framework related data.
673  * @bg_ptr - pointer to bandgap instance
674  * @id - sensor id
675  * @data - thermal framework related data to be stored
676  *
677  * returns 0 on success or the proper error code
678  */
679 int omap_bandgap_set_sensor_data(struct omap_bandgap *bg_ptr, int id,
680                                  void *data)
681 {
682         int ret = omap_bandgap_validate(bg_ptr, id);
683         if (ret)
684                 return ret;
685
686         bg_ptr->conf->sensors[id].data = data;
687
688         return 0;
689 }
690
691 /**
692  * omap_bandgap_get_sensor_data() - helper function to get thermal
693  * framework related data.
694  * @bg_ptr - pointer to bandgap instance
695  * @id - sensor id
696  *
697  * returns data stored by set function with sensor id on success or NULL
698  */
699 void *omap_bandgap_get_sensor_data(struct omap_bandgap *bg_ptr, int id)
700 {
701         int ret = omap_bandgap_validate(bg_ptr, id);
702         if (ret)
703                 return ERR_PTR(ret);
704
705         return bg_ptr->conf->sensors[id].data;
706 }
707
708 static int
709 omap_bandgap_force_single_read(struct omap_bandgap *bg_ptr, int id)
710 {
711         struct temp_sensor_registers *tsr;
712         u32 temp = 0, counter = 1000;
713
714         tsr = bg_ptr->conf->sensors[id].registers;
715         /* Select single conversion mode */
716         if (OMAP_BANDGAP_HAS(bg_ptr, MODE_CONFIG)) {
717                 temp = omap_bandgap_readl(bg_ptr, tsr->bgap_mode_ctrl);
718                 temp &= ~(1 << __ffs(tsr->mode_ctrl_mask));
719                 omap_bandgap_writel(bg_ptr, temp, tsr->bgap_mode_ctrl);
720         }
721
722         /* Start of Conversion = 1 */
723         temp = omap_bandgap_readl(bg_ptr, tsr->temp_sensor_ctrl);
724         temp |= 1 << __ffs(tsr->bgap_soc_mask);
725         omap_bandgap_writel(bg_ptr, temp, tsr->temp_sensor_ctrl);
726         /* Wait until DTEMP is updated */
727         temp = omap_bandgap_read_temp(bg_ptr, id);
728
729         while ((temp == 0) && --counter)
730                 temp = omap_bandgap_read_temp(bg_ptr, id);
731
732         /* Start of Conversion = 0 */
733         temp = omap_bandgap_readl(bg_ptr, tsr->temp_sensor_ctrl);
734         temp &= ~(1 << __ffs(tsr->bgap_soc_mask));
735         omap_bandgap_writel(bg_ptr, temp, tsr->temp_sensor_ctrl);
736
737         return 0;
738 }
739
740 /**
741  * enable_continuous_mode() - One time enabling of continuous conversion mode
742  * @bg_ptr - pointer to scm instance
743  *
744  * Call this function only if HAS(MODE_CONFIG) is set
745  */
746 static int enable_continuous_mode(struct omap_bandgap *bg_ptr)
747 {
748         struct temp_sensor_registers *tsr;
749         int i;
750         u32 val;
751
752         for (i = 0; i < bg_ptr->conf->sensor_count; i++) {
753                 /* Perform a single read just before enabling continuous */
754                 omap_bandgap_force_single_read(bg_ptr, i);
755                 tsr = bg_ptr->conf->sensors[i].registers;
756                 val = omap_bandgap_readl(bg_ptr, tsr->bgap_mode_ctrl);
757                 val |= 1 << __ffs(tsr->mode_ctrl_mask);
758                 omap_bandgap_writel(bg_ptr, val, tsr->bgap_mode_ctrl);
759         }
760
761         return 0;
762 }
763
764 static int omap_bandgap_tshut_init(struct omap_bandgap *bg_ptr,
765                                    struct platform_device *pdev)
766 {
767         int gpio_nr = bg_ptr->tshut_gpio;
768         int status;
769
770         /* Request for gpio_86 line */
771         status = gpio_request(gpio_nr, "tshut");
772         if (status < 0) {
773                 dev_err(bg_ptr->dev,
774                         "Could not request for TSHUT GPIO:%i\n", 86);
775                 return status;
776         }
777         status = gpio_direction_input(gpio_nr);
778         if (status) {
779                 dev_err(bg_ptr->dev,
780                         "Cannot set input TSHUT GPIO %d\n", gpio_nr);
781                 return status;
782         }
783
784         status = request_irq(gpio_to_irq(gpio_nr),
785                              omap_bandgap_tshut_irq_handler,
786                              IRQF_TRIGGER_RISING, "tshut",
787                              NULL);
788         if (status) {
789                 gpio_free(gpio_nr);
790                 dev_err(bg_ptr->dev, "request irq failed for TSHUT");
791         }
792
793         return 0;
794 }
795
796 /* Initialization of Talert. Call it only if HAS(TALERT) is set */
797 static int omap_bandgap_talert_init(struct omap_bandgap *bg_ptr,
798                                     struct platform_device *pdev)
799 {
800         int ret;
801
802         bg_ptr->irq = platform_get_irq(pdev, 0);
803         if (bg_ptr->irq < 0) {
804                 dev_err(&pdev->dev, "get_irq failed\n");
805                 return bg_ptr->irq;
806         }
807         ret = request_threaded_irq(bg_ptr->irq, NULL,
808                                    talert_irq_handler,
809                                    IRQF_TRIGGER_HIGH | IRQF_ONESHOT,
810                                    "talert", bg_ptr);
811         if (ret) {
812                 dev_err(&pdev->dev, "Request threaded irq failed.\n");
813                 return ret;
814         }
815
816         return 0;
817 }
818
819 static const struct of_device_id of_omap_bandgap_match[];
820 static struct omap_bandgap *omap_bandgap_build(struct platform_device *pdev)
821 {
822         struct device_node *node = pdev->dev.of_node;
823         const struct of_device_id *of_id;
824         struct omap_bandgap *bg_ptr;
825         struct resource *res;
826         u32 prop;
827         int i;
828
829         /* just for the sake */
830         if (!node) {
831                 dev_err(&pdev->dev, "no platform information available\n");
832                 return ERR_PTR(-EINVAL);
833         }
834
835         bg_ptr = devm_kzalloc(&pdev->dev, sizeof(struct omap_bandgap),
836                                     GFP_KERNEL);
837         if (!bg_ptr) {
838                 dev_err(&pdev->dev, "Unable to allocate mem for driver ref\n");
839                 return ERR_PTR(-ENOMEM);
840         }
841
842         of_id = of_match_device(of_omap_bandgap_match, &pdev->dev);
843         if (of_id)
844                 bg_ptr->conf = of_id->data;
845
846         i = 0;
847         do {
848                 void __iomem *chunk;
849
850                 res = platform_get_resource(pdev, IORESOURCE_MEM, i);
851                 if (!res)
852                         break;
853                 chunk = devm_ioremap_resource(&pdev->dev, res);
854                 if (i == 0)
855                         bg_ptr->base = chunk;
856                 if (IS_ERR(chunk))
857                         return ERR_CAST(chunk);
858
859                 i++;
860         } while (res);
861
862         if (OMAP_BANDGAP_HAS(bg_ptr, TSHUT)) {
863                 if (of_property_read_u32(node, "ti,tshut-gpio", &prop) < 0) {
864                         dev_err(&pdev->dev, "missing tshut gpio in device tree\n");
865                         return ERR_PTR(-EINVAL);
866                 }
867                 bg_ptr->tshut_gpio = prop;
868                 if (!gpio_is_valid(bg_ptr->tshut_gpio)) {
869                         dev_err(&pdev->dev, "invalid gpio for tshut (%d)\n",
870                                 bg_ptr->tshut_gpio);
871                         return ERR_PTR(-EINVAL);
872                 }
873         }
874
875         return bg_ptr;
876 }
877
878 static
879 int omap_bandgap_probe(struct platform_device *pdev)
880 {
881         struct omap_bandgap *bg_ptr;
882         int clk_rate, ret = 0, i;
883
884         bg_ptr = omap_bandgap_build(pdev);
885         if (IS_ERR_OR_NULL(bg_ptr)) {
886                 dev_err(&pdev->dev, "failed to fetch platform data\n");
887                 return PTR_ERR(bg_ptr);
888         }
889         bg_ptr->dev = &pdev->dev;
890
891         if (OMAP_BANDGAP_HAS(bg_ptr, TSHUT)) {
892                 ret = omap_bandgap_tshut_init(bg_ptr, pdev);
893                 if (ret) {
894                         dev_err(&pdev->dev,
895                                 "failed to initialize system tshut IRQ\n");
896                         return ret;
897                 }
898         }
899
900         bg_ptr->fclock = clk_get(NULL, bg_ptr->conf->fclock_name);
901         ret = IS_ERR_OR_NULL(bg_ptr->fclock);
902         if (ret) {
903                 dev_err(&pdev->dev, "failed to request fclock reference\n");
904                 goto free_irqs;
905         }
906
907         bg_ptr->div_clk = clk_get(NULL,  bg_ptr->conf->div_ck_name);
908         ret = IS_ERR_OR_NULL(bg_ptr->div_clk);
909         if (ret) {
910                 dev_err(&pdev->dev,
911                         "failed to request div_ts_ck clock ref\n");
912                 goto free_irqs;
913         }
914
915         for (i = 0; i < bg_ptr->conf->sensor_count; i++) {
916                 struct temp_sensor_registers *tsr;
917                 u32 val;
918
919                 tsr = bg_ptr->conf->sensors[i].registers;
920                 /*
921                  * check if the efuse has a non-zero value if not
922                  * it is an untrimmed sample and the temperatures
923                  * may not be accurate
924                  */
925                 val = omap_bandgap_readl(bg_ptr, tsr->bgap_efuse);
926                 if (ret || !val)
927                         dev_info(&pdev->dev,
928                                  "Non-trimmed BGAP, Temp not accurate\n");
929         }
930
931         clk_rate = clk_round_rate(bg_ptr->div_clk,
932                                   bg_ptr->conf->sensors[0].ts_data->max_freq);
933         if (clk_rate < bg_ptr->conf->sensors[0].ts_data->min_freq ||
934             clk_rate == 0xffffffff) {
935                 ret = -ENODEV;
936                 dev_err(&pdev->dev, "wrong clock rate (%d)\n", clk_rate);
937                 goto put_clks;
938         }
939
940         ret = clk_set_rate(bg_ptr->div_clk, clk_rate);
941         if (ret)
942                 dev_err(&pdev->dev, "Cannot re-set clock rate. Continuing\n");
943
944         bg_ptr->clk_rate = clk_rate;
945         if (OMAP_BANDGAP_HAS(bg_ptr, CLK_CTRL))
946                 clk_prepare_enable(bg_ptr->fclock);
947
948
949         mutex_init(&bg_ptr->bg_mutex);
950         bg_ptr->dev = &pdev->dev;
951         platform_set_drvdata(pdev, bg_ptr);
952
953         omap_bandgap_power(bg_ptr, true);
954
955         /* Set default counter to 1 for now */
956         if (OMAP_BANDGAP_HAS(bg_ptr, COUNTER))
957                 for (i = 0; i < bg_ptr->conf->sensor_count; i++)
958                         configure_temp_sensor_counter(bg_ptr, i, 1);
959
960         for (i = 0; i < bg_ptr->conf->sensor_count; i++) {
961                 struct temp_sensor_data *ts_data;
962
963                 ts_data = bg_ptr->conf->sensors[i].ts_data;
964
965                 if (OMAP_BANDGAP_HAS(bg_ptr, TALERT))
966                         temp_sensor_init_talert_thresholds(bg_ptr, i,
967                                                            ts_data->t_hot,
968                                                            ts_data->t_cold);
969                 if (OMAP_BANDGAP_HAS(bg_ptr, TSHUT_CONFIG)) {
970                         temp_sensor_configure_tshut_hot(bg_ptr, i,
971                                                         ts_data->tshut_hot);
972                         temp_sensor_configure_tshut_cold(bg_ptr, i,
973                                                          ts_data->tshut_cold);
974                 }
975         }
976
977         if (OMAP_BANDGAP_HAS(bg_ptr, MODE_CONFIG))
978                 enable_continuous_mode(bg_ptr);
979
980         /* Set .250 seconds time as default counter */
981         if (OMAP_BANDGAP_HAS(bg_ptr, COUNTER))
982                 for (i = 0; i < bg_ptr->conf->sensor_count; i++)
983                         configure_temp_sensor_counter(bg_ptr, i,
984                                                       bg_ptr->clk_rate / 4);
985
986         /* Every thing is good? Then expose the sensors */
987         for (i = 0; i < bg_ptr->conf->sensor_count; i++) {
988                 char *domain;
989
990                 if (bg_ptr->conf->sensors[i].register_cooling)
991                         bg_ptr->conf->sensors[i].register_cooling(bg_ptr, i);
992
993                 domain = bg_ptr->conf->sensors[i].domain;
994                 if (bg_ptr->conf->expose_sensor)
995                         bg_ptr->conf->expose_sensor(bg_ptr, i, domain);
996         }
997
998         /*
999          * Enable the Interrupts once everything is set. Otherwise irq handler
1000          * might be called as soon as it is enabled where as rest of framework
1001          * is still getting initialised.
1002          */
1003         if (OMAP_BANDGAP_HAS(bg_ptr, TALERT)) {
1004                 ret = omap_bandgap_talert_init(bg_ptr, pdev);
1005                 if (ret) {
1006                         dev_err(&pdev->dev, "failed to initialize Talert IRQ\n");
1007                         i = bg_ptr->conf->sensor_count;
1008                         goto disable_clk;
1009                 }
1010         }
1011
1012         return 0;
1013
1014 disable_clk:
1015         if (OMAP_BANDGAP_HAS(bg_ptr, CLK_CTRL))
1016                 clk_disable_unprepare(bg_ptr->fclock);
1017 put_clks:
1018         clk_put(bg_ptr->fclock);
1019         clk_put(bg_ptr->div_clk);
1020 free_irqs:
1021         if (OMAP_BANDGAP_HAS(bg_ptr, TSHUT)) {
1022                 free_irq(gpio_to_irq(bg_ptr->tshut_gpio), NULL);
1023                 gpio_free(bg_ptr->tshut_gpio);
1024         }
1025
1026         return ret;
1027 }
1028
1029 static
1030 int omap_bandgap_remove(struct platform_device *pdev)
1031 {
1032         struct omap_bandgap *bg_ptr = platform_get_drvdata(pdev);
1033         int i;
1034
1035         /* First thing is to remove sensor interfaces */
1036         for (i = 0; i < bg_ptr->conf->sensor_count; i++) {
1037                 if (bg_ptr->conf->sensors[i].register_cooling)
1038                         bg_ptr->conf->sensors[i].unregister_cooling(bg_ptr, i);
1039
1040                 if (bg_ptr->conf->remove_sensor)
1041                         bg_ptr->conf->remove_sensor(bg_ptr, i);
1042         }
1043
1044         omap_bandgap_power(bg_ptr, false);
1045
1046         if (OMAP_BANDGAP_HAS(bg_ptr, CLK_CTRL))
1047                 clk_disable_unprepare(bg_ptr->fclock);
1048         clk_put(bg_ptr->fclock);
1049         clk_put(bg_ptr->div_clk);
1050
1051         if (OMAP_BANDGAP_HAS(bg_ptr, TALERT))
1052                 free_irq(bg_ptr->irq, bg_ptr);
1053
1054         if (OMAP_BANDGAP_HAS(bg_ptr, TSHUT)) {
1055                 free_irq(gpio_to_irq(bg_ptr->tshut_gpio), NULL);
1056                 gpio_free(bg_ptr->tshut_gpio);
1057         }
1058
1059         return 0;
1060 }
1061
1062 #ifdef CONFIG_PM
1063 static int omap_bandgap_save_ctxt(struct omap_bandgap *bg_ptr)
1064 {
1065         int i;
1066
1067         for (i = 0; i < bg_ptr->conf->sensor_count; i++) {
1068                 struct temp_sensor_registers *tsr;
1069                 struct temp_sensor_regval *rval;
1070
1071                 rval = &bg_ptr->conf->sensors[i].regval;
1072                 tsr = bg_ptr->conf->sensors[i].registers;
1073
1074                 if (OMAP_BANDGAP_HAS(bg_ptr, MODE_CONFIG))
1075                         rval->bg_mode_ctrl = omap_bandgap_readl(bg_ptr,
1076                                                         tsr->bgap_mode_ctrl);
1077                 if (OMAP_BANDGAP_HAS(bg_ptr, COUNTER))
1078                         rval->bg_counter = omap_bandgap_readl(bg_ptr,
1079                                                         tsr->bgap_counter);
1080                 if (OMAP_BANDGAP_HAS(bg_ptr, TALERT)) {
1081                         rval->bg_threshold = omap_bandgap_readl(bg_ptr,
1082                                                         tsr->bgap_threshold);
1083                         rval->bg_ctrl = omap_bandgap_readl(bg_ptr,
1084                                                    tsr->bgap_mask_ctrl);
1085                 }
1086
1087                 if (OMAP_BANDGAP_HAS(bg_ptr, TSHUT_CONFIG))
1088                         rval->tshut_threshold = omap_bandgap_readl(bg_ptr,
1089                                                    tsr->tshut_threshold);
1090         }
1091
1092         return 0;
1093 }
1094
1095 static int omap_bandgap_restore_ctxt(struct omap_bandgap *bg_ptr)
1096 {
1097         int i;
1098
1099         for (i = 0; i < bg_ptr->conf->sensor_count; i++) {
1100                 struct temp_sensor_registers *tsr;
1101                 struct temp_sensor_regval *rval;
1102                 u32 val = 0;
1103
1104                 rval = &bg_ptr->conf->sensors[i].regval;
1105                 tsr = bg_ptr->conf->sensors[i].registers;
1106
1107                 if (OMAP_BANDGAP_HAS(bg_ptr, COUNTER))
1108                         val = omap_bandgap_readl(bg_ptr, tsr->bgap_counter);
1109
1110                 if (OMAP_BANDGAP_HAS(bg_ptr, TSHUT_CONFIG))
1111                         omap_bandgap_writel(bg_ptr, rval->tshut_threshold,
1112                                             tsr->tshut_threshold);
1113                 /* Force immediate temperature measurement and update
1114                  * of the DTEMP field
1115                  */
1116                 omap_bandgap_force_single_read(bg_ptr, i);
1117
1118                 if (OMAP_BANDGAP_HAS(bg_ptr, COUNTER))
1119                         omap_bandgap_writel(bg_ptr, rval->bg_counter,
1120                                             tsr->bgap_counter);
1121                 if (OMAP_BANDGAP_HAS(bg_ptr, MODE_CONFIG))
1122                         omap_bandgap_writel(bg_ptr, rval->bg_mode_ctrl,
1123                                             tsr->bgap_mode_ctrl);
1124                 if (OMAP_BANDGAP_HAS(bg_ptr, TALERT)) {
1125                         omap_bandgap_writel(bg_ptr, rval->bg_threshold,
1126                                             tsr->bgap_threshold);
1127                         omap_bandgap_writel(bg_ptr, rval->bg_ctrl,
1128                                             tsr->bgap_mask_ctrl);
1129                 }
1130         }
1131
1132         return 0;
1133 }
1134
1135 static int omap_bandgap_suspend(struct device *dev)
1136 {
1137         struct omap_bandgap *bg_ptr = dev_get_drvdata(dev);
1138         int err;
1139
1140         err = omap_bandgap_save_ctxt(bg_ptr);
1141         omap_bandgap_power(bg_ptr, false);
1142
1143         if (OMAP_BANDGAP_HAS(bg_ptr, CLK_CTRL))
1144                 clk_disable_unprepare(bg_ptr->fclock);
1145
1146         return err;
1147 }
1148
1149 static int omap_bandgap_resume(struct device *dev)
1150 {
1151         struct omap_bandgap *bg_ptr = dev_get_drvdata(dev);
1152
1153         if (OMAP_BANDGAP_HAS(bg_ptr, CLK_CTRL))
1154                 clk_prepare_enable(bg_ptr->fclock);
1155
1156         omap_bandgap_power(bg_ptr, true);
1157
1158         return omap_bandgap_restore_ctxt(bg_ptr);
1159 }
1160 static const struct dev_pm_ops omap_bandgap_dev_pm_ops = {
1161         SET_SYSTEM_SLEEP_PM_OPS(omap_bandgap_suspend,
1162                                 omap_bandgap_resume)
1163 };
1164
1165 #define DEV_PM_OPS      (&omap_bandgap_dev_pm_ops)
1166 #else
1167 #define DEV_PM_OPS      NULL
1168 #endif
1169
1170 static const struct of_device_id of_omap_bandgap_match[] = {
1171 #ifdef CONFIG_OMAP4_THERMAL
1172         {
1173                 .compatible = "ti,omap4430-bandgap",
1174                 .data = (void *)&omap4430_data,
1175         },
1176         {
1177                 .compatible = "ti,omap4460-bandgap",
1178                 .data = (void *)&omap4460_data,
1179         },
1180         {
1181                 .compatible = "ti,omap4470-bandgap",
1182                 .data = (void *)&omap4470_data,
1183         },
1184 #endif
1185 #ifdef CONFIG_OMAP5_THERMAL
1186         {
1187                 .compatible = "ti,omap5430-bandgap",
1188                 .data = (void *)&omap5430_data,
1189         },
1190 #endif
1191         /* Sentinel */
1192         { },
1193 };
1194 MODULE_DEVICE_TABLE(of, of_omap_bandgap_match);
1195
1196 static struct platform_driver omap_bandgap_sensor_driver = {
1197         .probe = omap_bandgap_probe,
1198         .remove = omap_bandgap_remove,
1199         .driver = {
1200                         .name = "omap-bandgap",
1201                         .pm = DEV_PM_OPS,
1202                         .of_match_table = of_omap_bandgap_match,
1203         },
1204 };
1205
1206 module_platform_driver(omap_bandgap_sensor_driver);
1207
1208 MODULE_DESCRIPTION("OMAP4+ bandgap temperature sensor driver");
1209 MODULE_LICENSE("GPL v2");
1210 MODULE_ALIAS("platform:omap-bandgap");
1211 MODULE_AUTHOR("Texas Instrument Inc.");