1 /* SPDX-License-Identifier: GPL-2.0 */
3 * Copyright (c) 2015, The Linux Foundation. All rights reserved.
6 #ifndef __QCOM_TSENS_H__
7 #define __QCOM_TSENS_H__
9 #define ONE_PT_CALIB 0x1
10 #define ONE_PT_CALIB2 0x2
11 #define TWO_PT_CALIB 0x3
12 #define CAL_DEGC_PT1 30
13 #define CAL_DEGC_PT2 120
14 #define SLOPE_FACTOR 1000
15 #define SLOPE_DEFAULT 3200
16 #define TIMEOUT_US 100
17 #define THRESHOLD_MAX_ADC_CODE 0x3ff
18 #define THRESHOLD_MIN_ADC_CODE 0x0
20 #include <linux/interrupt.h>
21 #include <linux/thermal.h>
22 #include <linux/regmap.h>
23 #include <linux/slab.h>
27 /* IP version numbers in ascending order */
42 * struct tsens_sensor - data for each sensor connected to the tsens device
43 * @priv: tsens device instance that this sensor is connected to
44 * @tzd: pointer to the thermal zone that this sensor is in
45 * @offset: offset of temperature adjustment curve
46 * @hw_id: HW ID can be used in case of platform-specific IDs
47 * @slope: slope of temperature adjustment curve
48 * @status: 8960-specific variable to track 8960 and 8660 status register offset
51 struct tsens_priv *priv;
52 struct thermal_zone_device *tzd;
60 * struct tsens_ops - operations as supported by the tsens device
61 * @init: Function to initialize the tsens device
62 * @calibrate: Function to calibrate the tsens device
63 * @get_temp: Function which returns the temp in millidegC
64 * @enable: Function to enable (clocks/power) tsens device
65 * @disable: Function to disable the tsens device
66 * @suspend: Function to suspend the tsens device
67 * @resume: Function to resume the tsens device
68 * @get_trend: Function to get the thermal/temp trend
71 /* mandatory callbacks */
72 int (*init)(struct tsens_priv *priv);
73 int (*calibrate)(struct tsens_priv *priv);
74 int (*get_temp)(const struct tsens_sensor *s, int *temp);
75 /* optional callbacks */
76 int (*enable)(struct tsens_priv *priv, int i);
77 void (*disable)(struct tsens_priv *priv);
78 int (*suspend)(struct tsens_priv *priv);
79 int (*resume)(struct tsens_priv *priv);
80 int (*get_trend)(struct tsens_sensor *s, enum thermal_trend *trend);
83 #define REG_FIELD_FOR_EACH_SENSOR11(_name, _offset, _startbit, _stopbit) \
84 [_name##_##0] = REG_FIELD(_offset, _startbit, _stopbit), \
85 [_name##_##1] = REG_FIELD(_offset + 4, _startbit, _stopbit), \
86 [_name##_##2] = REG_FIELD(_offset + 8, _startbit, _stopbit), \
87 [_name##_##3] = REG_FIELD(_offset + 12, _startbit, _stopbit), \
88 [_name##_##4] = REG_FIELD(_offset + 16, _startbit, _stopbit), \
89 [_name##_##5] = REG_FIELD(_offset + 20, _startbit, _stopbit), \
90 [_name##_##6] = REG_FIELD(_offset + 24, _startbit, _stopbit), \
91 [_name##_##7] = REG_FIELD(_offset + 28, _startbit, _stopbit), \
92 [_name##_##8] = REG_FIELD(_offset + 32, _startbit, _stopbit), \
93 [_name##_##9] = REG_FIELD(_offset + 36, _startbit, _stopbit), \
94 [_name##_##10] = REG_FIELD(_offset + 40, _startbit, _stopbit)
96 #define REG_FIELD_FOR_EACH_SENSOR16(_name, _offset, _startbit, _stopbit) \
97 [_name##_##0] = REG_FIELD(_offset, _startbit, _stopbit), \
98 [_name##_##1] = REG_FIELD(_offset + 4, _startbit, _stopbit), \
99 [_name##_##2] = REG_FIELD(_offset + 8, _startbit, _stopbit), \
100 [_name##_##3] = REG_FIELD(_offset + 12, _startbit, _stopbit), \
101 [_name##_##4] = REG_FIELD(_offset + 16, _startbit, _stopbit), \
102 [_name##_##5] = REG_FIELD(_offset + 20, _startbit, _stopbit), \
103 [_name##_##6] = REG_FIELD(_offset + 24, _startbit, _stopbit), \
104 [_name##_##7] = REG_FIELD(_offset + 28, _startbit, _stopbit), \
105 [_name##_##8] = REG_FIELD(_offset + 32, _startbit, _stopbit), \
106 [_name##_##9] = REG_FIELD(_offset + 36, _startbit, _stopbit), \
107 [_name##_##10] = REG_FIELD(_offset + 40, _startbit, _stopbit), \
108 [_name##_##11] = REG_FIELD(_offset + 44, _startbit, _stopbit), \
109 [_name##_##12] = REG_FIELD(_offset + 48, _startbit, _stopbit), \
110 [_name##_##13] = REG_FIELD(_offset + 52, _startbit, _stopbit), \
111 [_name##_##14] = REG_FIELD(_offset + 56, _startbit, _stopbit), \
112 [_name##_##15] = REG_FIELD(_offset + 60, _startbit, _stopbit)
114 #define REG_FIELD_SPLIT_BITS_0_15(_name, _offset) \
115 [_name##_##0] = REG_FIELD(_offset, 0, 0), \
116 [_name##_##1] = REG_FIELD(_offset, 1, 1), \
117 [_name##_##2] = REG_FIELD(_offset, 2, 2), \
118 [_name##_##3] = REG_FIELD(_offset, 3, 3), \
119 [_name##_##4] = REG_FIELD(_offset, 4, 4), \
120 [_name##_##5] = REG_FIELD(_offset, 5, 5), \
121 [_name##_##6] = REG_FIELD(_offset, 6, 6), \
122 [_name##_##7] = REG_FIELD(_offset, 7, 7), \
123 [_name##_##8] = REG_FIELD(_offset, 8, 8), \
124 [_name##_##9] = REG_FIELD(_offset, 9, 9), \
125 [_name##_##10] = REG_FIELD(_offset, 10, 10), \
126 [_name##_##11] = REG_FIELD(_offset, 11, 11), \
127 [_name##_##12] = REG_FIELD(_offset, 12, 12), \
128 [_name##_##13] = REG_FIELD(_offset, 13, 13), \
129 [_name##_##14] = REG_FIELD(_offset, 14, 14), \
130 [_name##_##15] = REG_FIELD(_offset, 15, 15)
132 #define REG_FIELD_SPLIT_BITS_16_31(_name, _offset) \
133 [_name##_##0] = REG_FIELD(_offset, 16, 16), \
134 [_name##_##1] = REG_FIELD(_offset, 17, 17), \
135 [_name##_##2] = REG_FIELD(_offset, 18, 18), \
136 [_name##_##3] = REG_FIELD(_offset, 19, 19), \
137 [_name##_##4] = REG_FIELD(_offset, 20, 20), \
138 [_name##_##5] = REG_FIELD(_offset, 21, 21), \
139 [_name##_##6] = REG_FIELD(_offset, 22, 22), \
140 [_name##_##7] = REG_FIELD(_offset, 23, 23), \
141 [_name##_##8] = REG_FIELD(_offset, 24, 24), \
142 [_name##_##9] = REG_FIELD(_offset, 25, 25), \
143 [_name##_##10] = REG_FIELD(_offset, 26, 26), \
144 [_name##_##11] = REG_FIELD(_offset, 27, 27), \
145 [_name##_##12] = REG_FIELD(_offset, 28, 28), \
146 [_name##_##13] = REG_FIELD(_offset, 29, 29), \
147 [_name##_##14] = REG_FIELD(_offset, 30, 30), \
148 [_name##_##15] = REG_FIELD(_offset, 31, 31)
151 * reg_field IDs to use as an index into an array
152 * If you change the order of the entries, check the devm_regmap_field_alloc()
153 * calls in init_common()
156 /* ----- SROT ------ */
167 /* ----- TM ------ */
170 /* INTERRUPT ENABLE */
171 INT_EN, /* v2+ has separate enables for crit, upper and lower irq */
173 LAST_TEMP_0, /* Last temperature reading */
189 VALID_0, /* VALID reading or not */
205 LOWER_STATUS_0, /* LOWER threshold violated */
221 LOW_INT_STATUS_0, /* LOWER interrupt status */
237 LOW_INT_CLEAR_0, /* LOWER interrupt clear */
253 LOW_INT_MASK_0, /* LOWER interrupt mask */
269 LOW_THRESH_0, /* LOWER threshold values */
285 UPPER_STATUS_0, /* UPPER threshold violated */
301 UP_INT_STATUS_0, /* UPPER interrupt status */
317 UP_INT_CLEAR_0, /* UPPER interrupt clear */
333 UP_INT_MASK_0, /* UPPER interrupt mask */
349 UP_THRESH_0, /* UPPER threshold values */
365 CRITICAL_STATUS_0, /* CRITICAL threshold violated */
381 CRIT_INT_STATUS_0, /* CRITICAL interrupt status */
397 CRIT_INT_CLEAR_0, /* CRITICAL interrupt clear */
413 CRIT_INT_MASK_0, /* CRITICAL interrupt mask */
429 CRIT_THRESH_0, /* CRITICAL threshold values */
452 /* CYCLE COMPLETION MONITOR */
457 MIN_STATUS_0, /* MIN threshold violated */
473 MAX_STATUS_0, /* MAX threshold violated */
495 * struct tsens_features - Features supported by the IP
496 * @ver_major: Major number of IP version
497 * @crit_int: does the IP support critical interrupts?
498 * @adc: do the sensors only output adc code (instead of temperature)?
499 * @srot_split: does the IP neatly splits the register space into SROT and TM,
500 * with SROT only being available to secure boot firmware?
501 * @has_watchdog: does this IP support watchdog functionality?
502 * @max_sensors: maximum sensors supported by this version of the IP
504 struct tsens_features {
505 unsigned int ver_major;
506 unsigned int crit_int:1;
508 unsigned int srot_split:1;
509 unsigned int has_watchdog:1;
510 unsigned int max_sensors;
514 * struct tsens_plat_data - tsens compile-time platform data
515 * @num_sensors: Number of sensors supported by platform
516 * @ops: operations the tsens instance supports
517 * @hw_ids: Subset of sensors ids supported by platform, if not the first n
518 * @feat: features of the IP
519 * @fields: bitfield locations
521 struct tsens_plat_data {
522 const u32 num_sensors;
523 const struct tsens_ops *ops;
524 unsigned int *hw_ids;
525 struct tsens_features *feat;
526 const struct reg_field *fields;
530 * struct tsens_context - Registers to be saved/restored across a context loss
531 * @threshold: Threshold register value
532 * @control: Control register value
534 struct tsens_context {
540 * struct tsens_priv - private data for each instance of the tsens IP
541 * @dev: pointer to struct device
542 * @num_sensors: number of sensors enabled on this device
543 * @tm_map: pointer to TM register address space
544 * @srot_map: pointer to SROT register address space
545 * @tm_offset: deal with old device trees that don't address TM and SROT
546 * address space separately
547 * @ul_lock: lock while processing upper/lower threshold interrupts
548 * @crit_lock: lock while processing critical threshold interrupts
549 * @rf: array of regmap_fields used to store value of the field
550 * @ctx: registers to be saved and restored during suspend/resume
551 * @feat: features of the IP
552 * @fields: bitfield locations
553 * @ops: pointer to list of callbacks supported by this device
554 * @debug_root: pointer to debugfs dentry for all tsens
555 * @debug: pointer to debugfs dentry for tsens controller
556 * @sensor: list of sensors attached to this device
561 struct regmap *tm_map;
562 struct regmap *srot_map;
565 /* lock for upper/lower threshold interrupts */
568 struct regmap_field *rf[MAX_REGFIELDS];
569 struct tsens_context ctx;
570 struct tsens_features *feat;
571 const struct reg_field *fields;
572 const struct tsens_ops *ops;
574 struct dentry *debug_root;
575 struct dentry *debug;
577 struct tsens_sensor sensor[];
580 char *qfprom_read(struct device *dev, const char *cname);
581 void compute_intercept_slope(struct tsens_priv *priv, u32 *pt1, u32 *pt2, u32 mode);
582 int init_common(struct tsens_priv *priv);
583 int get_temp_tsens_valid(const struct tsens_sensor *s, int *temp);
584 int get_temp_common(const struct tsens_sensor *s, int *temp);
587 extern struct tsens_plat_data data_8960;
589 /* TSENS v0.1 targets */
590 extern struct tsens_plat_data data_8916, data_8939, data_8974, data_9607;
592 /* TSENS v1 targets */
593 extern struct tsens_plat_data data_tsens_v1, data_8976;
595 /* TSENS v2 targets */
596 extern struct tsens_plat_data data_8996, data_tsens_v2;
598 #endif /* __QCOM_TSENS_H__ */