1 // SPDX-License-Identifier: GPL-2.0-only
2 /* envctrl.c: Temperature and Fan monitoring on Machines providing it.
4 * Copyright (C) 1998 Eddie C. Dost (ecd@skynet.be)
5 * Copyright (C) 2000 Vinh Truong (vinh.truong@eng.sun.com)
6 * VT - The implementation is to support Sun Microelectronics (SME) platform
7 * environment monitoring. SME platforms use pcf8584 as the i2c bus
8 * controller to access pcf8591 (8-bit A/D and D/A converter) and
9 * pcf8571 (256 x 8-bit static low-voltage RAM with I2C-bus interface).
10 * At board level, it follows SME Firmware I2C Specification. Reference:
11 * http://www-eu2.semiconductors.com/pip/PCF8584P
12 * http://www-eu2.semiconductors.com/pip/PCF8574AP
13 * http://www-eu2.semiconductors.com/pip/PCF8591P
15 * EB - Added support for CP1500 Global Address and PS/Voltage monitoring.
16 * Eric Brower <ebrower@usa.net>
18 * DB - Audit every copy_to_user in envctrl_read.
19 * Daniele Bellucci <bellucda@tiscali.it>
22 #include <linux/module.h>
23 #include <linux/kthread.h>
24 #include <linux/delay.h>
25 #include <linux/ioport.h>
26 #include <linux/miscdevice.h>
27 #include <linux/kmod.h>
28 #include <linux/reboot.h>
29 #include <linux/slab.h>
31 #include <linux/of_device.h>
33 #include <linux/uaccess.h>
34 #include <asm/envctrl.h>
37 #define DRIVER_NAME "envctrl"
38 #define PFX DRIVER_NAME ": "
40 #define ENVCTRL_MINOR 162
42 #define PCF8584_ADDRESS 0x55
44 #define CONTROL_PIN 0x80
45 #define CONTROL_ES0 0x40
46 #define CONTROL_ES1 0x20
47 #define CONTROL_ES2 0x10
48 #define CONTROL_ENI 0x08
49 #define CONTROL_STA 0x04
50 #define CONTROL_STO 0x02
51 #define CONTROL_ACK 0x01
53 #define STATUS_PIN 0x80
54 #define STATUS_STS 0x20
55 #define STATUS_BER 0x10
56 #define STATUS_LRB 0x08
57 #define STATUS_AD0 0x08
58 #define STATUS_AAB 0x04
59 #define STATUS_LAB 0x02
60 #define STATUS_BB 0x01
65 #define BUS_CLK_90 0x00
66 #define BUS_CLK_45 0x01
67 #define BUS_CLK_11 0x02
68 #define BUS_CLK_1_5 0x03
76 #define OBD_SEND_START 0xc5 /* value to generate I2c_bus START condition */
77 #define OBD_SEND_STOP 0xc3 /* value to generate I2c_bus STOP condition */
79 /* Monitor type of i2c child device.
80 * Firmware definitions.
82 #define PCF8584_MAX_CHANNELS 8
83 #define PCF8584_GLOBALADDR_TYPE 6 /* global address monitor */
84 #define PCF8584_FANSTAT_TYPE 3 /* fan status monitor */
85 #define PCF8584_VOLTAGE_TYPE 2 /* voltage monitor */
86 #define PCF8584_TEMP_TYPE 1 /* temperature monitor*/
88 /* Monitor type of i2c child device.
91 #define ENVCTRL_NOMON 0
92 #define ENVCTRL_CPUTEMP_MON 1 /* cpu temperature monitor */
93 #define ENVCTRL_CPUVOLTAGE_MON 2 /* voltage monitor */
94 #define ENVCTRL_FANSTAT_MON 3 /* fan status monitor */
95 #define ENVCTRL_ETHERTEMP_MON 4 /* ethernet temperature */
97 #define ENVCTRL_VOLTAGESTAT_MON 5 /* voltage status monitor */
98 #define ENVCTRL_MTHRBDTEMP_MON 6 /* motherboard temperature */
99 #define ENVCTRL_SCSITEMP_MON 7 /* scsi temperature */
100 #define ENVCTRL_GLOBALADDR_MON 8 /* global address */
102 /* Child device type.
103 * Driver definitions.
105 #define I2C_ADC 0 /* pcf8591 */
106 #define I2C_GPIO 1 /* pcf8571 */
108 /* Data read from child device may need to decode
109 * through a data table and a scale.
110 * Translation type as defined by firmware.
112 #define ENVCTRL_TRANSLATE_NO 0
113 #define ENVCTRL_TRANSLATE_PARTIAL 1
114 #define ENVCTRL_TRANSLATE_COMBINED 2
115 #define ENVCTRL_TRANSLATE_FULL 3 /* table[data] */
116 #define ENVCTRL_TRANSLATE_SCALE 4 /* table[data]/scale */
118 /* Driver miscellaneous definitions. */
119 #define ENVCTRL_MAX_CPU 4
120 #define CHANNEL_DESC_SZ 256
122 /* Mask values for combined GlobalAddress/PowerStatus node */
123 #define ENVCTRL_GLOBALADDR_ADDR_MASK 0x1F
124 #define ENVCTRL_GLOBALADDR_PSTAT_MASK 0x60
126 /* Node 0x70 ignored on CompactPCI CP1400/1500 platforms
127 * (see envctrl_init_i2c_child)
129 #define ENVCTRL_CPCI_IGNORED_NODE 0x70
131 #define PCF8584_DATA 0x00
132 #define PCF8584_CSR 0x01
134 /* Each child device can be monitored by up to PCF8584_MAX_CHANNELS.
135 * Property of a port or channel as defined by the firmware.
137 struct pcf8584_channel {
138 unsigned char chnl_no;
139 unsigned char io_direction;
144 /* Each child device may have one or more tables of bytes to help decode
145 * data. Table property as defined by the firmware.
147 struct pcf8584_tblprop {
150 unsigned int offset; /* offset from the beginning of the table */
156 /* Either ADC or GPIO. */
157 unsigned char i2ctype;
159 struct pcf8584_channel chnl_array[PCF8584_MAX_CHANNELS];
162 unsigned int total_chnls; /* Number of monitor channels. */
163 unsigned char fan_mask; /* Byte mask for fan status channels. */
164 unsigned char voltage_mask; /* Byte mask for voltage status channels. */
165 struct pcf8584_tblprop tblprop_array[PCF8584_MAX_CHANNELS];
167 /* Properties of all monitor channels. */
168 unsigned int total_tbls; /* Number of monitor tables. */
169 char *tables; /* Pointer to table(s). */
170 char chnls_desc[CHANNEL_DESC_SZ]; /* Channel description. */
171 char mon_type[PCF8584_MAX_CHANNELS];
174 static void __iomem *i2c;
175 static struct i2c_child_t i2c_childlist[ENVCTRL_MAX_CPU*2];
176 static unsigned char chnls_mask[] = { 0x01, 0x02, 0x04, 0x08, 0x10, 0x20, 0x40, 0x80 };
177 static unsigned int warning_temperature = 0;
178 static unsigned int shutdown_temperature = 0;
179 static char read_cpu;
181 /* Forward declarations. */
182 static struct i2c_child_t *envctrl_get_i2c_child(unsigned char);
184 /* Function Description: Test the PIN bit (Pending Interrupt Not)
185 * to test when serial transmission is completed .
188 static void envtrl_i2c_test_pin(void)
192 while (--limit > 0) {
193 if (!(readb(i2c + PCF8584_CSR) & STATUS_PIN))
199 printk(KERN_INFO PFX "Pin status will not clear.\n");
202 /* Function Description: Test busy bit.
205 static void envctrl_i2c_test_bb(void)
209 while (--limit > 0) {
210 /* Busy bit 0 means busy. */
211 if (readb(i2c + PCF8584_CSR) & STATUS_BB)
217 printk(KERN_INFO PFX "Busy bit will not clear.\n");
220 /* Function Description: Send the address for a read access.
221 * Return : 0 if not acknowledged, otherwise acknowledged.
223 static int envctrl_i2c_read_addr(unsigned char addr)
225 envctrl_i2c_test_bb();
228 writeb(addr + 1, i2c + PCF8584_DATA);
230 envctrl_i2c_test_bb();
232 writeb(OBD_SEND_START, i2c + PCF8584_CSR);
235 envtrl_i2c_test_pin();
237 /* CSR 0 means acknowledged. */
238 if (!(readb(i2c + PCF8584_CSR) & STATUS_LRB)) {
239 return readb(i2c + PCF8584_DATA);
241 writeb(OBD_SEND_STOP, i2c + PCF8584_CSR);
246 /* Function Description: Send the address for write mode.
249 static void envctrl_i2c_write_addr(unsigned char addr)
251 envctrl_i2c_test_bb();
252 writeb(addr, i2c + PCF8584_DATA);
254 /* Generate Start condition. */
255 writeb(OBD_SEND_START, i2c + PCF8584_CSR);
258 /* Function Description: Read 1 byte of data from addr
259 * set by envctrl_i2c_read_addr()
260 * Return : Data from address set by envctrl_i2c_read_addr().
262 static unsigned char envctrl_i2c_read_data(void)
264 envtrl_i2c_test_pin();
265 writeb(CONTROL_ES0, i2c + PCF8584_CSR); /* Send neg ack. */
266 return readb(i2c + PCF8584_DATA);
269 /* Function Description: Instruct the device which port to read data from.
272 static void envctrl_i2c_write_data(unsigned char port)
274 envtrl_i2c_test_pin();
275 writeb(port, i2c + PCF8584_DATA);
278 /* Function Description: Generate Stop condition after last byte is sent.
281 static void envctrl_i2c_stop(void)
283 envtrl_i2c_test_pin();
284 writeb(OBD_SEND_STOP, i2c + PCF8584_CSR);
287 /* Function Description: Read adc device.
288 * Return : Data at address and port.
290 static unsigned char envctrl_i2c_read_8591(unsigned char addr, unsigned char port)
293 envctrl_i2c_write_addr(addr);
295 /* Setup port to read. */
296 envctrl_i2c_write_data(port);
300 envctrl_i2c_read_addr(addr);
302 /* Do a single byte read and send stop. */
303 envctrl_i2c_read_data();
306 return readb(i2c + PCF8584_DATA);
309 /* Function Description: Read gpio device.
310 * Return : Data at address.
312 static unsigned char envctrl_i2c_read_8574(unsigned char addr)
316 envctrl_i2c_read_addr(addr);
318 /* Do a single byte read and send stop. */
319 rd = envctrl_i2c_read_data();
324 /* Function Description: Decode data read from an adc device using firmware
326 * Return: Number of read bytes. Data is stored in bufdata in ascii format.
328 static int envctrl_i2c_data_translate(unsigned char data, int translate_type,
329 int scale, char *tbl, char *bufdata)
333 switch (translate_type) {
334 case ENVCTRL_TRANSLATE_NO:
335 /* No decode necessary. */
340 case ENVCTRL_TRANSLATE_FULL:
341 /* Decode this way: data = table[data]. */
343 bufdata[0] = tbl[data];
346 case ENVCTRL_TRANSLATE_SCALE:
347 /* Decode this way: data = table[data]/scale */
348 sprintf(bufdata,"%d ", (tbl[data] * 10) / (scale));
349 len = strlen(bufdata);
350 bufdata[len - 1] = bufdata[len - 2];
351 bufdata[len - 2] = '.';
361 /* Function Description: Read cpu-related data such as cpu temperature, voltage.
362 * Return: Number of read bytes. Data is stored in bufdata in ascii format.
364 static int envctrl_read_cpu_info(int cpu, struct i2c_child_t *pchild,
365 char mon_type, unsigned char *bufdata)
371 /* Find the right monitor type and channel. */
372 for (i = 0; i < PCF8584_MAX_CHANNELS; i++) {
373 if (pchild->mon_type[i] == mon_type) {
383 /* Read data from address and port. */
384 data = envctrl_i2c_read_8591((unsigned char)pchild->addr,
385 (unsigned char)pchild->chnl_array[i].chnl_no);
387 /* Find decoding table. */
388 tbl = pchild->tables + pchild->tblprop_array[i].offset;
390 return envctrl_i2c_data_translate(data, pchild->tblprop_array[i].type,
391 pchild->tblprop_array[i].scale,
395 /* Function Description: Read noncpu-related data such as motherboard
397 * Return: Number of read bytes. Data is stored in bufdata in ascii format.
399 static int envctrl_read_noncpu_info(struct i2c_child_t *pchild,
400 char mon_type, unsigned char *bufdata)
406 for (i = 0; i < PCF8584_MAX_CHANNELS; i++) {
407 if (pchild->mon_type[i] == mon_type)
411 if (i >= PCF8584_MAX_CHANNELS)
414 /* Read data from address and port. */
415 data = envctrl_i2c_read_8591((unsigned char)pchild->addr,
416 (unsigned char)pchild->chnl_array[i].chnl_no);
418 /* Find decoding table. */
419 tbl = pchild->tables + pchild->tblprop_array[i].offset;
421 return envctrl_i2c_data_translate(data, pchild->tblprop_array[i].type,
422 pchild->tblprop_array[i].scale,
426 /* Function Description: Read fan status.
427 * Return : Always 1 byte. Status stored in bufdata.
429 static int envctrl_i2c_fan_status(struct i2c_child_t *pchild,
433 unsigned char tmp, ret = 0;
436 tmp = data & pchild->fan_mask;
438 if (tmp == pchild->fan_mask) {
439 /* All bits are on. All fans are functioning. */
440 ret = ENVCTRL_ALL_FANS_GOOD;
441 } else if (tmp == 0) {
442 /* No bits are on. No fans are functioning. */
443 ret = ENVCTRL_ALL_FANS_BAD;
445 /* Go through all channels, mark 'on' the matched bits.
446 * Notice that fan_mask may have discontiguous bits but
447 * return mask are always contiguous. For example if we
448 * monitor 4 fans at channels 0,1,2,4, the return mask
449 * should be 00010000 if only fan at channel 4 is working.
451 for (i = 0; i < PCF8584_MAX_CHANNELS;i++) {
452 if (pchild->fan_mask & chnls_mask[i]) {
453 if (!(chnls_mask[i] & tmp))
454 ret |= chnls_mask[j];
465 /* Function Description: Read global addressing line.
466 * Return : Always 1 byte. Status stored in bufdata.
468 static int envctrl_i2c_globaladdr(struct i2c_child_t *pchild,
472 /* Translatation table is not necessary, as global
473 * addr is the integer value of the GA# bits.
475 * NOTE: MSB is documented as zero, but I see it as '1' always....
477 * -----------------------------------------------
478 * | 0 | FAL | DEG | GA4 | GA3 | GA2 | GA1 | GA0 |
479 * -----------------------------------------------
480 * GA0 - GA4 integer value of Global Address (backplane slot#)
481 * DEG 0 = cPCI Power supply output is starting to degrade
482 * 1 = cPCI Power supply output is OK
483 * FAL 0 = cPCI Power supply has failed
484 * 1 = cPCI Power supply output is OK
486 bufdata[0] = (data & ENVCTRL_GLOBALADDR_ADDR_MASK);
490 /* Function Description: Read standard voltage and power supply status.
491 * Return : Always 1 byte. Status stored in bufdata.
493 static unsigned char envctrl_i2c_voltage_status(struct i2c_child_t *pchild,
497 unsigned char tmp, ret = 0;
500 tmp = data & pchild->voltage_mask;
502 /* Two channels are used to monitor voltage and power supply. */
503 if (tmp == pchild->voltage_mask) {
504 /* All bits are on. Voltage and power supply are okay. */
505 ret = ENVCTRL_VOLTAGE_POWERSUPPLY_GOOD;
506 } else if (tmp == 0) {
507 /* All bits are off. Voltage and power supply are bad */
508 ret = ENVCTRL_VOLTAGE_POWERSUPPLY_BAD;
510 /* Either voltage or power supply has problem. */
511 for (i = 0; i < PCF8584_MAX_CHANNELS; i++) {
512 if (pchild->voltage_mask & chnls_mask[i]) {
515 /* Break out when there is a mismatch. */
516 if (!(chnls_mask[i] & tmp))
521 /* Make a wish that hardware will always use the
522 * first channel for voltage and the second for
526 ret = ENVCTRL_VOLTAGE_BAD;
528 ret = ENVCTRL_POWERSUPPLY_BAD;
535 /* Function Description: Read a byte from /dev/envctrl. Mapped to user read().
536 * Return: Number of read bytes. 0 for error.
539 envctrl_read(struct file *file, char __user *buf, size_t count, loff_t *ppos)
541 struct i2c_child_t *pchild;
542 unsigned char data[10];
545 /* Get the type of read as decided in ioctl() call.
546 * Find the appropriate i2c child.
547 * Get the data and put back to the user buffer.
550 switch ((int)(long)file->private_data) {
551 case ENVCTRL_RD_WARNING_TEMPERATURE:
552 if (warning_temperature == 0)
555 data[0] = (unsigned char)(warning_temperature);
557 if (copy_to_user(buf, data, ret))
561 case ENVCTRL_RD_SHUTDOWN_TEMPERATURE:
562 if (shutdown_temperature == 0)
565 data[0] = (unsigned char)(shutdown_temperature);
567 if (copy_to_user(buf, data, ret))
571 case ENVCTRL_RD_MTHRBD_TEMPERATURE:
572 if (!(pchild = envctrl_get_i2c_child(ENVCTRL_MTHRBDTEMP_MON)))
574 ret = envctrl_read_noncpu_info(pchild, ENVCTRL_MTHRBDTEMP_MON, data);
575 if (copy_to_user(buf, data, ret))
579 case ENVCTRL_RD_CPU_TEMPERATURE:
580 if (!(pchild = envctrl_get_i2c_child(ENVCTRL_CPUTEMP_MON)))
582 ret = envctrl_read_cpu_info(read_cpu, pchild, ENVCTRL_CPUTEMP_MON, data);
584 /* Reset cpu to the default cpu0. */
585 if (copy_to_user(buf, data, ret))
589 case ENVCTRL_RD_CPU_VOLTAGE:
590 if (!(pchild = envctrl_get_i2c_child(ENVCTRL_CPUVOLTAGE_MON)))
592 ret = envctrl_read_cpu_info(read_cpu, pchild, ENVCTRL_CPUVOLTAGE_MON, data);
594 /* Reset cpu to the default cpu0. */
595 if (copy_to_user(buf, data, ret))
599 case ENVCTRL_RD_SCSI_TEMPERATURE:
600 if (!(pchild = envctrl_get_i2c_child(ENVCTRL_SCSITEMP_MON)))
602 ret = envctrl_read_noncpu_info(pchild, ENVCTRL_SCSITEMP_MON, data);
603 if (copy_to_user(buf, data, ret))
607 case ENVCTRL_RD_ETHERNET_TEMPERATURE:
608 if (!(pchild = envctrl_get_i2c_child(ENVCTRL_ETHERTEMP_MON)))
610 ret = envctrl_read_noncpu_info(pchild, ENVCTRL_ETHERTEMP_MON, data);
611 if (copy_to_user(buf, data, ret))
615 case ENVCTRL_RD_FAN_STATUS:
616 if (!(pchild = envctrl_get_i2c_child(ENVCTRL_FANSTAT_MON)))
618 data[0] = envctrl_i2c_read_8574(pchild->addr);
619 ret = envctrl_i2c_fan_status(pchild,data[0], data);
620 if (copy_to_user(buf, data, ret))
624 case ENVCTRL_RD_GLOBALADDRESS:
625 if (!(pchild = envctrl_get_i2c_child(ENVCTRL_GLOBALADDR_MON)))
627 data[0] = envctrl_i2c_read_8574(pchild->addr);
628 ret = envctrl_i2c_globaladdr(pchild, data[0], data);
629 if (copy_to_user(buf, data, ret))
633 case ENVCTRL_RD_VOLTAGE_STATUS:
634 if (!(pchild = envctrl_get_i2c_child(ENVCTRL_VOLTAGESTAT_MON)))
635 /* If voltage monitor not present, check for CPCI equivalent */
636 if (!(pchild = envctrl_get_i2c_child(ENVCTRL_GLOBALADDR_MON)))
638 data[0] = envctrl_i2c_read_8574(pchild->addr);
639 ret = envctrl_i2c_voltage_status(pchild, data[0], data);
640 if (copy_to_user(buf, data, ret))
652 /* Function Description: Command what to read. Mapped to user ioctl().
653 * Return: Gives 0 for implemented commands, -EINVAL otherwise.
656 envctrl_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
658 char __user *infobuf;
661 case ENVCTRL_RD_WARNING_TEMPERATURE:
662 case ENVCTRL_RD_SHUTDOWN_TEMPERATURE:
663 case ENVCTRL_RD_MTHRBD_TEMPERATURE:
664 case ENVCTRL_RD_FAN_STATUS:
665 case ENVCTRL_RD_VOLTAGE_STATUS:
666 case ENVCTRL_RD_ETHERNET_TEMPERATURE:
667 case ENVCTRL_RD_SCSI_TEMPERATURE:
668 case ENVCTRL_RD_GLOBALADDRESS:
669 file->private_data = (void *)(long)cmd;
672 case ENVCTRL_RD_CPU_TEMPERATURE:
673 case ENVCTRL_RD_CPU_VOLTAGE:
674 /* Check to see if application passes in any cpu number,
675 * the default is cpu0.
677 infobuf = (char __user *) arg;
678 if (infobuf == NULL) {
681 get_user(read_cpu, infobuf);
684 /* Save the command for use when reading. */
685 file->private_data = (void *)(long)cmd;
695 /* Function Description: open device. Mapped to user open().
699 envctrl_open(struct inode *inode, struct file *file)
701 file->private_data = NULL;
705 /* Function Description: Open device. Mapped to user close().
709 envctrl_release(struct inode *inode, struct file *file)
714 static const struct file_operations envctrl_fops = {
715 .owner = THIS_MODULE,
716 .read = envctrl_read,
717 .unlocked_ioctl = envctrl_ioctl,
719 .compat_ioctl = envctrl_ioctl,
721 .open = envctrl_open,
722 .release = envctrl_release,
723 .llseek = noop_llseek,
726 static struct miscdevice envctrl_dev = {
732 /* Function Description: Set monitor type based on firmware description.
735 static void envctrl_set_mon(struct i2c_child_t *pchild,
736 const char *chnl_desc,
739 /* Firmware only has temperature type. It does not distinguish
740 * different kinds of temperatures. We use channel description
741 * to disinguish them.
743 if (!(strcmp(chnl_desc,"temp,cpu")) ||
744 !(strcmp(chnl_desc,"temp,cpu0")) ||
745 !(strcmp(chnl_desc,"temp,cpu1")) ||
746 !(strcmp(chnl_desc,"temp,cpu2")) ||
747 !(strcmp(chnl_desc,"temp,cpu3")))
748 pchild->mon_type[chnl_no] = ENVCTRL_CPUTEMP_MON;
750 if (!(strcmp(chnl_desc,"vddcore,cpu0")) ||
751 !(strcmp(chnl_desc,"vddcore,cpu1")) ||
752 !(strcmp(chnl_desc,"vddcore,cpu2")) ||
753 !(strcmp(chnl_desc,"vddcore,cpu3")))
754 pchild->mon_type[chnl_no] = ENVCTRL_CPUVOLTAGE_MON;
756 if (!(strcmp(chnl_desc,"temp,motherboard")))
757 pchild->mon_type[chnl_no] = ENVCTRL_MTHRBDTEMP_MON;
759 if (!(strcmp(chnl_desc,"temp,scsi")))
760 pchild->mon_type[chnl_no] = ENVCTRL_SCSITEMP_MON;
762 if (!(strcmp(chnl_desc,"temp,ethernet")))
763 pchild->mon_type[chnl_no] = ENVCTRL_ETHERTEMP_MON;
766 /* Function Description: Initialize monitor channel with channel desc,
767 * decoding tables, monitor type, optional properties.
770 static void envctrl_init_adc(struct i2c_child_t *pchild, struct device_node *dp)
774 const unsigned int *pval;
776 /* Firmware describe channels into a stream separated by a '\0'. */
777 pos = of_get_property(dp, "channels-description", &len);
780 int l = strlen(pos) + 1;
781 envctrl_set_mon(pchild, pos, i++);
786 /* Get optional properties. */
787 pval = of_get_property(dp, "warning-temp", NULL);
789 warning_temperature = *pval;
791 pval = of_get_property(dp, "shutdown-temp", NULL);
793 shutdown_temperature = *pval;
796 /* Function Description: Initialize child device monitoring fan status.
799 static void envctrl_init_fanstat(struct i2c_child_t *pchild)
803 /* Go through all channels and set up the mask. */
804 for (i = 0; i < pchild->total_chnls; i++)
805 pchild->fan_mask |= chnls_mask[(pchild->chnl_array[i]).chnl_no];
807 /* We only need to know if this child has fan status monitored.
808 * We don't care which channels since we have the mask already.
810 pchild->mon_type[0] = ENVCTRL_FANSTAT_MON;
813 /* Function Description: Initialize child device for global addressing line.
816 static void envctrl_init_globaladdr(struct i2c_child_t *pchild)
820 /* Voltage/PowerSupply monitoring is piggybacked
821 * with Global Address on CompactPCI. See comments
822 * within envctrl_i2c_globaladdr for bit assignments.
824 * The mask is created here by assigning mask bits to each
825 * bit position that represents PCF8584_VOLTAGE_TYPE data.
826 * Channel numbers are not consecutive within the globaladdr
827 * node (why?), so we use the actual counter value as chnls_mask
828 * index instead of the chnl_array[x].chnl_no value.
830 * NOTE: This loop could be replaced with a constant representing
831 * a mask of bits 5&6 (ENVCTRL_GLOBALADDR_PSTAT_MASK).
833 for (i = 0; i < pchild->total_chnls; i++) {
834 if (PCF8584_VOLTAGE_TYPE == pchild->chnl_array[i].type) {
835 pchild->voltage_mask |= chnls_mask[i];
839 /* We only need to know if this child has global addressing
840 * line monitored. We don't care which channels since we know
841 * the mask already (ENVCTRL_GLOBALADDR_ADDR_MASK).
843 pchild->mon_type[0] = ENVCTRL_GLOBALADDR_MON;
846 /* Initialize child device monitoring voltage status. */
847 static void envctrl_init_voltage_status(struct i2c_child_t *pchild)
851 /* Go through all channels and set up the mask. */
852 for (i = 0; i < pchild->total_chnls; i++)
853 pchild->voltage_mask |= chnls_mask[(pchild->chnl_array[i]).chnl_no];
855 /* We only need to know if this child has voltage status monitored.
856 * We don't care which channels since we have the mask already.
858 pchild->mon_type[0] = ENVCTRL_VOLTAGESTAT_MON;
861 /* Function Description: Initialize i2c child device.
864 static void envctrl_init_i2c_child(struct device_node *dp,
865 struct i2c_child_t *pchild)
867 int len, i, tbls_size = 0;
870 /* Get device address. */
871 pval = of_get_property(dp, "reg", &len);
872 memcpy(&pchild->addr, pval, len);
874 /* Get tables property. Read firmware temperature tables. */
875 pval = of_get_property(dp, "translation", &len);
876 if (pval && len > 0) {
877 memcpy(pchild->tblprop_array, pval, len);
878 pchild->total_tbls = len / sizeof(struct pcf8584_tblprop);
879 for (i = 0; i < pchild->total_tbls; i++) {
880 if ((pchild->tblprop_array[i].size + pchild->tblprop_array[i].offset) > tbls_size) {
881 tbls_size = pchild->tblprop_array[i].size + pchild->tblprop_array[i].offset;
885 pchild->tables = kmalloc(tbls_size, GFP_KERNEL);
886 if (pchild->tables == NULL){
887 printk(KERN_ERR PFX "Failed to allocate table.\n");
890 pval = of_get_property(dp, "tables", &len);
891 if (!pval || len <= 0) {
892 printk(KERN_ERR PFX "Failed to get table.\n");
895 memcpy(pchild->tables, pval, len);
898 /* SPARCengine ASM Reference Manual (ref. SMI doc 805-7581-04)
899 * sections 2.5, 3.5, 4.5 state node 0x70 for CP1400/1500 is
900 * "For Factory Use Only."
902 * We ignore the node on these platforms by assigning the
903 * 'NULL' monitor type.
905 if (ENVCTRL_CPCI_IGNORED_NODE == pchild->addr) {
906 struct device_node *root_node;
909 root_node = of_find_node_by_path("/");
910 if (of_node_name_eq(root_node, "SUNW,UltraSPARC-IIi-cEngine")) {
911 for (len = 0; len < PCF8584_MAX_CHANNELS; ++len) {
912 pchild->mon_type[len] = ENVCTRL_NOMON;
914 of_node_put(root_node);
917 of_node_put(root_node);
920 /* Get the monitor channels. */
921 pval = of_get_property(dp, "channels-in-use", &len);
922 memcpy(pchild->chnl_array, pval, len);
923 pchild->total_chnls = len / sizeof(struct pcf8584_channel);
925 for (i = 0; i < pchild->total_chnls; i++) {
926 switch (pchild->chnl_array[i].type) {
927 case PCF8584_TEMP_TYPE:
928 envctrl_init_adc(pchild, dp);
931 case PCF8584_GLOBALADDR_TYPE:
932 envctrl_init_globaladdr(pchild);
933 i = pchild->total_chnls;
936 case PCF8584_FANSTAT_TYPE:
937 envctrl_init_fanstat(pchild);
938 i = pchild->total_chnls;
941 case PCF8584_VOLTAGE_TYPE:
942 if (pchild->i2ctype == I2C_ADC) {
943 envctrl_init_adc(pchild,dp);
945 envctrl_init_voltage_status(pchild);
947 i = pchild->total_chnls;
956 /* Function Description: Search the child device list for a device.
957 * Return : The i2c child if found. NULL otherwise.
959 static struct i2c_child_t *envctrl_get_i2c_child(unsigned char mon_type)
963 for (i = 0; i < ENVCTRL_MAX_CPU*2; i++) {
964 for (j = 0; j < PCF8584_MAX_CHANNELS; j++) {
965 if (i2c_childlist[i].mon_type[j] == mon_type) {
966 return (struct i2c_child_t *)(&(i2c_childlist[i]));
973 static void envctrl_do_shutdown(void)
975 static int inprog = 0;
981 printk(KERN_CRIT "kenvctrld: WARNING: Shutting down the system now.\n");
982 orderly_poweroff(true);
985 static struct task_struct *kenvctrld_task;
987 static int kenvctrld(void *__unused)
992 struct i2c_child_t *cputemp;
994 if (NULL == (cputemp = envctrl_get_i2c_child(ENVCTRL_CPUTEMP_MON))) {
996 "kenvctrld unable to monitor CPU temp-- exiting\n");
1000 poll_interval = 5000; /* TODO env_mon_interval */
1002 printk(KERN_INFO PFX "%s starting...\n", current->comm);
1004 msleep_interruptible(poll_interval);
1006 if (kthread_should_stop())
1009 for (whichcpu = 0; whichcpu < ENVCTRL_MAX_CPU; ++whichcpu) {
1010 if (0 < envctrl_read_cpu_info(whichcpu, cputemp,
1011 ENVCTRL_CPUTEMP_MON,
1013 if (tempbuf[0] >= shutdown_temperature) {
1015 "%s: WARNING: CPU%i temperature %i C meets or exceeds "\
1016 "shutdown threshold %i C\n",
1017 current->comm, whichcpu,
1018 tempbuf[0], shutdown_temperature);
1019 envctrl_do_shutdown();
1024 printk(KERN_INFO PFX "%s exiting...\n", current->comm);
1028 static int envctrl_probe(struct platform_device *op)
1030 struct device_node *dp;
1036 i2c = of_ioremap(&op->resource[0], 0, 0x2, DRIVER_NAME);
1041 dp = op->dev.of_node->child;
1043 if (of_node_name_eq(dp, "gpio")) {
1044 i2c_childlist[index].i2ctype = I2C_GPIO;
1045 envctrl_init_i2c_child(dp, &(i2c_childlist[index++]));
1046 } else if (of_node_name_eq(dp, "adc")) {
1047 i2c_childlist[index].i2ctype = I2C_ADC;
1048 envctrl_init_i2c_child(dp, &(i2c_childlist[index++]));
1054 /* Set device address. */
1055 writeb(CONTROL_PIN, i2c + PCF8584_CSR);
1056 writeb(PCF8584_ADDRESS, i2c + PCF8584_DATA);
1058 /* Set system clock and SCL frequencies. */
1059 writeb(CONTROL_PIN | CONTROL_ES1, i2c + PCF8584_CSR);
1060 writeb(CLK_4_43 | BUS_CLK_90, i2c + PCF8584_DATA);
1062 /* Enable serial interface. */
1063 writeb(CONTROL_PIN | CONTROL_ES0 | CONTROL_ACK, i2c + PCF8584_CSR);
1066 /* Register the device as a minor miscellaneous device. */
1067 err = misc_register(&envctrl_dev);
1069 printk(KERN_ERR PFX "Unable to get misc minor %d\n",
1074 /* Note above traversal routine post-incremented 'i' to accommodate
1075 * a next child device, so we decrement before reverse-traversal of
1078 printk(KERN_INFO PFX "Initialized ");
1079 for (--index; index >= 0; --index) {
1080 printk("[%s 0x%lx]%s",
1081 (I2C_ADC == i2c_childlist[index].i2ctype) ? "adc" :
1082 ((I2C_GPIO == i2c_childlist[index].i2ctype) ? "gpio" : "unknown"),
1083 i2c_childlist[index].addr, (0 == index) ? "\n" : " ");
1086 kenvctrld_task = kthread_run(kenvctrld, NULL, "kenvctrld");
1087 if (IS_ERR(kenvctrld_task)) {
1088 err = PTR_ERR(kenvctrld_task);
1089 goto out_deregister;
1095 misc_deregister(&envctrl_dev);
1097 of_iounmap(&op->resource[0], i2c, 0x2);
1098 for (index = 0; index < ENVCTRL_MAX_CPU * 2; index++)
1099 kfree(i2c_childlist[index].tables);
1104 static int envctrl_remove(struct platform_device *op)
1108 kthread_stop(kenvctrld_task);
1110 of_iounmap(&op->resource[0], i2c, 0x2);
1111 misc_deregister(&envctrl_dev);
1113 for (index = 0; index < ENVCTRL_MAX_CPU * 2; index++)
1114 kfree(i2c_childlist[index].tables);
1119 static const struct of_device_id envctrl_match[] = {
1122 .compatible = "i2cpcf,8584",
1126 MODULE_DEVICE_TABLE(of, envctrl_match);
1128 static struct platform_driver envctrl_driver = {
1130 .name = DRIVER_NAME,
1131 .of_match_table = envctrl_match,
1133 .probe = envctrl_probe,
1134 .remove = envctrl_remove,
1137 module_platform_driver(envctrl_driver);
1139 MODULE_LICENSE("GPL");