]> git.proxmox.com Git - mirror_ubuntu-jammy-kernel.git/blame - drivers/misc/ics932s401.c
Merge branch 'next' into for-linus
[mirror_ubuntu-jammy-kernel.git] / drivers / misc / ics932s401.c
CommitLineData
a412ae3f
DW
1/*
2 * A driver for the Integrated Circuits ICS932S401
3 * Copyright (C) 2008 IBM
4 *
5407e051 5 * Author: Darrick J. Wong <darrick.wong@oracle.com>
a412ae3f
DW
6 *
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20 */
21
22#include <linux/module.h>
23#include <linux/jiffies.h>
24#include <linux/i2c.h>
25#include <linux/err.h>
26#include <linux/mutex.h>
27#include <linux/delay.h>
28#include <linux/log2.h>
5a0e3ad6 29#include <linux/slab.h>
a412ae3f
DW
30
31/* Addresses to scan */
32static const unsigned short normal_i2c[] = { 0x69, I2C_CLIENT_END };
33
a412ae3f
DW
34/* ICS932S401 registers */
35#define ICS932S401_REG_CFG2 0x01
1e3ae175 36#define ICS932S401_CFG1_SPREAD 0x01
a412ae3f
DW
37#define ICS932S401_REG_CFG7 0x06
38#define ICS932S401_FS_MASK 0x07
39#define ICS932S401_REG_VENDOR_REV 0x07
40#define ICS932S401_VENDOR 1
41#define ICS932S401_VENDOR_MASK 0x0F
42#define ICS932S401_REV 4
43#define ICS932S401_REV_SHIFT 4
44#define ICS932S401_REG_DEVICE 0x09
45#define ICS932S401_DEVICE 11
46#define ICS932S401_REG_CTRL 0x0A
47#define ICS932S401_MN_ENABLED 0x80
48#define ICS932S401_CPU_ALT 0x04
49#define ICS932S401_SRC_ALT 0x08
50#define ICS932S401_REG_CPU_M_CTRL 0x0B
51#define ICS932S401_M_MASK 0x3F
52#define ICS932S401_REG_CPU_N_CTRL 0x0C
53#define ICS932S401_REG_CPU_SPREAD1 0x0D
54#define ICS932S401_REG_CPU_SPREAD2 0x0E
55#define ICS932S401_SPREAD_MASK 0x7FFF
56#define ICS932S401_REG_SRC_M_CTRL 0x0F
57#define ICS932S401_REG_SRC_N_CTRL 0x10
58#define ICS932S401_REG_SRC_SPREAD1 0x11
59#define ICS932S401_REG_SRC_SPREAD2 0x12
60#define ICS932S401_REG_CPU_DIVISOR 0x13
1e3ae175 61#define ICS932S401_CPU_DIVISOR_SHIFT 4
a412ae3f
DW
62#define ICS932S401_REG_PCISRC_DIVISOR 0x14
63#define ICS932S401_SRC_DIVISOR_MASK 0x0F
64#define ICS932S401_PCI_DIVISOR_SHIFT 4
65
66/* Base clock is 14.318MHz */
67#define BASE_CLOCK 14318
68
69#define NUM_REGS 21
70#define NUM_MIRRORED_REGS 15
71
72static int regs_to_copy[NUM_MIRRORED_REGS] = {
73 ICS932S401_REG_CFG2,
74 ICS932S401_REG_CFG7,
75 ICS932S401_REG_VENDOR_REV,
76 ICS932S401_REG_DEVICE,
77 ICS932S401_REG_CTRL,
78 ICS932S401_REG_CPU_M_CTRL,
79 ICS932S401_REG_CPU_N_CTRL,
80 ICS932S401_REG_CPU_SPREAD1,
81 ICS932S401_REG_CPU_SPREAD2,
82 ICS932S401_REG_SRC_M_CTRL,
83 ICS932S401_REG_SRC_N_CTRL,
84 ICS932S401_REG_SRC_SPREAD1,
85 ICS932S401_REG_SRC_SPREAD2,
86 ICS932S401_REG_CPU_DIVISOR,
87 ICS932S401_REG_PCISRC_DIVISOR,
88};
89
90/* How often do we reread sensors values? (In jiffies) */
91#define SENSOR_REFRESH_INTERVAL (2 * HZ)
92
93/* How often do we reread sensor limit values? (In jiffies) */
94#define LIMIT_REFRESH_INTERVAL (60 * HZ)
95
96struct ics932s401_data {
97 struct attribute_group attrs;
98 struct mutex lock;
99 char sensors_valid;
100 unsigned long sensors_last_updated; /* In jiffies */
101
102 u8 regs[NUM_REGS];
103};
104
105static int ics932s401_probe(struct i2c_client *client,
106 const struct i2c_device_id *id);
310ec792 107static int ics932s401_detect(struct i2c_client *client,
a412ae3f
DW
108 struct i2c_board_info *info);
109static int ics932s401_remove(struct i2c_client *client);
110
111static const struct i2c_device_id ics932s401_id[] = {
1f86df49 112 { "ics932s401", 0 },
a412ae3f
DW
113 { }
114};
115MODULE_DEVICE_TABLE(i2c, ics932s401_id);
116
117static struct i2c_driver ics932s401_driver = {
118 .class = I2C_CLASS_HWMON,
119 .driver = {
120 .name = "ics932s401",
121 },
122 .probe = ics932s401_probe,
123 .remove = ics932s401_remove,
124 .id_table = ics932s401_id,
125 .detect = ics932s401_detect,
c3813d6a 126 .address_list = normal_i2c,
a412ae3f
DW
127};
128
129static struct ics932s401_data *ics932s401_update_device(struct device *dev)
130{
131 struct i2c_client *client = to_i2c_client(dev);
132 struct ics932s401_data *data = i2c_get_clientdata(client);
133 unsigned long local_jiffies = jiffies;
134 int i, temp;
135
136 mutex_lock(&data->lock);
137 if (time_before(local_jiffies, data->sensors_last_updated +
138 SENSOR_REFRESH_INTERVAL)
139 && data->sensors_valid)
140 goto out;
141
142 /*
143 * Each register must be read as a word and then right shifted 8 bits.
144 * Not really sure why this is; setting the "byte count programming"
145 * register to 1 does not fix this problem.
146 */
147 for (i = 0; i < NUM_MIRRORED_REGS; i++) {
148 temp = i2c_smbus_read_word_data(client, regs_to_copy[i]);
b05ae01f
AP
149 if (temp < 0)
150 data->regs[regs_to_copy[i]] = 0;
a412ae3f
DW
151 data->regs[regs_to_copy[i]] = temp >> 8;
152 }
153
154 data->sensors_last_updated = local_jiffies;
155 data->sensors_valid = 1;
156
157out:
158 mutex_unlock(&data->lock);
159 return data;
160}
161
162static ssize_t show_spread_enabled(struct device *dev,
163 struct device_attribute *devattr,
164 char *buf)
165{
166 struct ics932s401_data *data = ics932s401_update_device(dev);
167
168 if (data->regs[ICS932S401_REG_CFG2] & ICS932S401_CFG1_SPREAD)
169 return sprintf(buf, "1\n");
170
171 return sprintf(buf, "0\n");
172}
173
174/* bit to cpu khz map */
175static const int fs_speeds[] = {
176 266666,
177 133333,
178 200000,
179 166666,
180 333333,
181 100000,
182 400000,
183 0,
184};
185
186/* clock divisor map */
187static const int divisors[] = {2, 3, 5, 15, 4, 6, 10, 30, 8, 12, 20, 60, 16,
188 24, 40, 120};
189
190/* Calculate CPU frequency from the M/N registers. */
191static int calculate_cpu_freq(struct ics932s401_data *data)
192{
193 int m, n, freq;
194
195 m = data->regs[ICS932S401_REG_CPU_M_CTRL] & ICS932S401_M_MASK;
196 n = data->regs[ICS932S401_REG_CPU_N_CTRL];
197
198 /* Pull in bits 8 & 9 from the M register */
199 n |= ((int)data->regs[ICS932S401_REG_CPU_M_CTRL] & 0x80) << 1;
200 n |= ((int)data->regs[ICS932S401_REG_CPU_M_CTRL] & 0x40) << 3;
201
202 freq = BASE_CLOCK * (n + 8) / (m + 2);
203 freq /= divisors[data->regs[ICS932S401_REG_CPU_DIVISOR] >>
204 ICS932S401_CPU_DIVISOR_SHIFT];
205
206 return freq;
207}
208
209static ssize_t show_cpu_clock(struct device *dev,
210 struct device_attribute *devattr,
211 char *buf)
212{
213 struct ics932s401_data *data = ics932s401_update_device(dev);
214
215 return sprintf(buf, "%d\n", calculate_cpu_freq(data));
216}
217
218static ssize_t show_cpu_clock_sel(struct device *dev,
219 struct device_attribute *devattr,
220 char *buf)
221{
222 struct ics932s401_data *data = ics932s401_update_device(dev);
223 int freq;
224
225 if (data->regs[ICS932S401_REG_CTRL] & ICS932S401_MN_ENABLED)
226 freq = calculate_cpu_freq(data);
227 else {
228 /* Freq is neatly wrapped up for us */
229 int fid = data->regs[ICS932S401_REG_CFG7] & ICS932S401_FS_MASK;
67d0833f 230
a412ae3f
DW
231 freq = fs_speeds[fid];
232 if (data->regs[ICS932S401_REG_CTRL] & ICS932S401_CPU_ALT) {
233 switch (freq) {
234 case 166666:
235 freq = 160000;
236 break;
237 case 333333:
238 freq = 320000;
239 break;
240 }
241 }
242 }
243
244 return sprintf(buf, "%d\n", freq);
245}
246
247/* Calculate SRC frequency from the M/N registers. */
248static int calculate_src_freq(struct ics932s401_data *data)
249{
250 int m, n, freq;
251
252 m = data->regs[ICS932S401_REG_SRC_M_CTRL] & ICS932S401_M_MASK;
253 n = data->regs[ICS932S401_REG_SRC_N_CTRL];
254
255 /* Pull in bits 8 & 9 from the M register */
256 n |= ((int)data->regs[ICS932S401_REG_SRC_M_CTRL] & 0x80) << 1;
257 n |= ((int)data->regs[ICS932S401_REG_SRC_M_CTRL] & 0x40) << 3;
258
259 freq = BASE_CLOCK * (n + 8) / (m + 2);
260 freq /= divisors[data->regs[ICS932S401_REG_PCISRC_DIVISOR] &
261 ICS932S401_SRC_DIVISOR_MASK];
262
263 return freq;
264}
265
266static ssize_t show_src_clock(struct device *dev,
267 struct device_attribute *devattr,
268 char *buf)
269{
270 struct ics932s401_data *data = ics932s401_update_device(dev);
271
272 return sprintf(buf, "%d\n", calculate_src_freq(data));
273}
274
275static ssize_t show_src_clock_sel(struct device *dev,
276 struct device_attribute *devattr,
277 char *buf)
278{
279 struct ics932s401_data *data = ics932s401_update_device(dev);
280 int freq;
281
282 if (data->regs[ICS932S401_REG_CTRL] & ICS932S401_MN_ENABLED)
283 freq = calculate_src_freq(data);
284 else
285 /* Freq is neatly wrapped up for us */
286 if (data->regs[ICS932S401_REG_CTRL] & ICS932S401_CPU_ALT &&
287 data->regs[ICS932S401_REG_CTRL] & ICS932S401_SRC_ALT)
288 freq = 96000;
289 else
290 freq = 100000;
291
292 return sprintf(buf, "%d\n", freq);
293}
294
295/* Calculate PCI frequency from the SRC M/N registers. */
296static int calculate_pci_freq(struct ics932s401_data *data)
297{
298 int m, n, freq;
299
300 m = data->regs[ICS932S401_REG_SRC_M_CTRL] & ICS932S401_M_MASK;
301 n = data->regs[ICS932S401_REG_SRC_N_CTRL];
302
303 /* Pull in bits 8 & 9 from the M register */
304 n |= ((int)data->regs[ICS932S401_REG_SRC_M_CTRL] & 0x80) << 1;
305 n |= ((int)data->regs[ICS932S401_REG_SRC_M_CTRL] & 0x40) << 3;
306
307 freq = BASE_CLOCK * (n + 8) / (m + 2);
308 freq /= divisors[data->regs[ICS932S401_REG_PCISRC_DIVISOR] >>
309 ICS932S401_PCI_DIVISOR_SHIFT];
310
311 return freq;
312}
313
314static ssize_t show_pci_clock(struct device *dev,
315 struct device_attribute *devattr,
316 char *buf)
317{
318 struct ics932s401_data *data = ics932s401_update_device(dev);
319
320 return sprintf(buf, "%d\n", calculate_pci_freq(data));
321}
322
323static ssize_t show_pci_clock_sel(struct device *dev,
324 struct device_attribute *devattr,
325 char *buf)
326{
327 struct ics932s401_data *data = ics932s401_update_device(dev);
328 int freq;
329
330 if (data->regs[ICS932S401_REG_CTRL] & ICS932S401_MN_ENABLED)
331 freq = calculate_pci_freq(data);
332 else
333 freq = 33333;
334
335 return sprintf(buf, "%d\n", freq);
336}
337
338static ssize_t show_value(struct device *dev,
339 struct device_attribute *devattr,
340 char *buf);
341
342static ssize_t show_spread(struct device *dev,
343 struct device_attribute *devattr,
344 char *buf);
345
346static DEVICE_ATTR(spread_enabled, S_IRUGO, show_spread_enabled, NULL);
347static DEVICE_ATTR(cpu_clock_selection, S_IRUGO, show_cpu_clock_sel, NULL);
348static DEVICE_ATTR(cpu_clock, S_IRUGO, show_cpu_clock, NULL);
349static DEVICE_ATTR(src_clock_selection, S_IRUGO, show_src_clock_sel, NULL);
350static DEVICE_ATTR(src_clock, S_IRUGO, show_src_clock, NULL);
351static DEVICE_ATTR(pci_clock_selection, S_IRUGO, show_pci_clock_sel, NULL);
352static DEVICE_ATTR(pci_clock, S_IRUGO, show_pci_clock, NULL);
353static DEVICE_ATTR(usb_clock, S_IRUGO, show_value, NULL);
354static DEVICE_ATTR(ref_clock, S_IRUGO, show_value, NULL);
355static DEVICE_ATTR(cpu_spread, S_IRUGO, show_spread, NULL);
356static DEVICE_ATTR(src_spread, S_IRUGO, show_spread, NULL);
357
3288de12 358static struct attribute *ics932s401_attr[] = {
a412ae3f
DW
359 &dev_attr_spread_enabled.attr,
360 &dev_attr_cpu_clock_selection.attr,
361 &dev_attr_cpu_clock.attr,
362 &dev_attr_src_clock_selection.attr,
363 &dev_attr_src_clock.attr,
364 &dev_attr_pci_clock_selection.attr,
365 &dev_attr_pci_clock.attr,
366 &dev_attr_usb_clock.attr,
367 &dev_attr_ref_clock.attr,
368 &dev_attr_cpu_spread.attr,
369 &dev_attr_src_spread.attr,
370 NULL
371};
372
373static ssize_t show_value(struct device *dev,
374 struct device_attribute *devattr,
375 char *buf)
376{
377 int x;
378
379 if (devattr == &dev_attr_usb_clock)
380 x = 48000;
381 else if (devattr == &dev_attr_ref_clock)
382 x = BASE_CLOCK;
383 else
384 BUG();
385
386 return sprintf(buf, "%d\n", x);
387}
388
389static ssize_t show_spread(struct device *dev,
390 struct device_attribute *devattr,
391 char *buf)
392{
393 struct ics932s401_data *data = ics932s401_update_device(dev);
394 int reg;
395 unsigned long val;
396
397 if (!(data->regs[ICS932S401_REG_CFG2] & ICS932S401_CFG1_SPREAD))
398 return sprintf(buf, "0%%\n");
399
400 if (devattr == &dev_attr_src_spread)
401 reg = ICS932S401_REG_SRC_SPREAD1;
402 else if (devattr == &dev_attr_cpu_spread)
403 reg = ICS932S401_REG_CPU_SPREAD1;
404 else
405 BUG();
406
407 val = data->regs[reg] | (data->regs[reg + 1] << 8);
408 val &= ICS932S401_SPREAD_MASK;
409
410 /* Scale 0..2^14 to -0.5. */
411 val = 500000 * val / 16384;
412 return sprintf(buf, "-0.%lu%%\n", val);
413}
414
415/* Return 0 if detection is successful, -ENODEV otherwise */
310ec792 416static int ics932s401_detect(struct i2c_client *client,
a412ae3f
DW
417 struct i2c_board_info *info)
418{
419 struct i2c_adapter *adapter = client->adapter;
c2e90e9b 420 int vendor, device, revision;
a412ae3f
DW
421
422 if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_BYTE_DATA))
423 return -ENODEV;
424
c2e90e9b
JD
425 vendor = i2c_smbus_read_word_data(client, ICS932S401_REG_VENDOR_REV);
426 vendor >>= 8;
427 revision = vendor >> ICS932S401_REV_SHIFT;
428 vendor &= ICS932S401_VENDOR_MASK;
429 if (vendor != ICS932S401_VENDOR)
430 return -ENODEV;
431
432 device = i2c_smbus_read_word_data(client, ICS932S401_REG_DEVICE);
433 device >>= 8;
434 if (device != ICS932S401_DEVICE)
435 return -ENODEV;
436
437 if (revision != ICS932S401_REV)
438 dev_info(&adapter->dev, "Unknown revision %d\n", revision);
a412ae3f
DW
439
440 strlcpy(info->type, "ics932s401", I2C_NAME_SIZE);
441
442 return 0;
443}
444
445static int ics932s401_probe(struct i2c_client *client,
446 const struct i2c_device_id *id)
447{
448 struct ics932s401_data *data;
449 int err;
450
451 data = kzalloc(sizeof(struct ics932s401_data), GFP_KERNEL);
452 if (!data) {
453 err = -ENOMEM;
454 goto exit;
455 }
456
457 i2c_set_clientdata(client, data);
458 mutex_init(&data->lock);
459
460 dev_info(&client->dev, "%s chip found\n", client->name);
461
462 /* Register sysfs hooks */
463 data->attrs.attrs = ics932s401_attr;
464 err = sysfs_create_group(&client->dev.kobj, &data->attrs);
465 if (err)
466 goto exit_free;
467
468 return 0;
469
470exit_free:
471 kfree(data);
472exit:
473 return err;
474}
475
476static int ics932s401_remove(struct i2c_client *client)
477{
478 struct ics932s401_data *data = i2c_get_clientdata(client);
479
480 sysfs_remove_group(&client->dev.kobj, &data->attrs);
481 kfree(data);
482 return 0;
483}
484
a64fe2ed 485module_i2c_driver(ics932s401_driver);
a412ae3f 486
5407e051 487MODULE_AUTHOR("Darrick J. Wong <darrick.wong@oracle.com>");
a412ae3f
DW
488MODULE_DESCRIPTION("ICS932S401 driver");
489MODULE_LICENSE("GPL");
490
a412ae3f
DW
491/* IBM IntelliStation Z30 */
492MODULE_ALIAS("dmi:bvnIBM:*:rn9228:*");
493MODULE_ALIAS("dmi:bvnIBM:*:rn9232:*");
494
495/* IBM x3650/x3550 */
496MODULE_ALIAS("dmi:bvnIBM:*:pnIBMSystemx3650*");
497MODULE_ALIAS("dmi:bvnIBM:*:pnIBMSystemx3550*");