moel@16: /*
moel@16:  
moel@344:   This Source Code Form is subject to the terms of the Mozilla Public
moel@344:   License, v. 2.0. If a copy of the MPL was not distributed with this
moel@344:   file, You can obtain one at http://mozilla.org/MPL/2.0/.
moel@16:  
moel@344:   Copyright (C) 2009-2012 Michael Möller <mmoeller@openhardwaremonitor.org>
moel@344: 	
moel@16: */
moel@16: 
moel@166: using System.Globalization;
moel@16: using System.Text;
moel@16: 
moel@16: namespace OpenHardwareMonitor.Hardware.LPC {
moel@165:   internal class IT87XX : ISuperIO {
moel@130:        
moel@195:     private readonly ushort address;
moel@195:     private readonly Chip chip;
moel@195:     private readonly byte version;
moel@16: 
moel@228:     private readonly ushort gpioAddress;
moel@228:     private readonly int gpioCount;
moel@228: 
moel@78:     private readonly ushort addressReg;
moel@78:     private readonly ushort dataReg;
moel@78: 
moel@195:     private readonly float?[] voltages = new float?[0];
moel@195:     private readonly float?[] temperatures = new float?[0];
moel@195:     private readonly float?[] fans = new float?[0];
moel@323:     private readonly float?[] controls = new float?[0];
moel@170: 
moel@170:     private readonly float voltageGain;
moel@272:     private readonly bool has16bitFanCounter;
moel@16:    
moel@16:     // Consts
moel@16:     private const byte ITE_VENDOR_ID = 0x90;
moel@16:        
moel@16:     // Environment Controller
moel@16:     private const byte ADDRESS_REGISTER_OFFSET = 0x05;
moel@16:     private const byte DATA_REGISTER_OFFSET = 0x06;
moel@16: 
moel@16:     // Environment Controller Registers    
moel@16:     private const byte CONFIGURATION_REGISTER = 0x00;
moel@16:     private const byte TEMPERATURE_BASE_REG = 0x29;
moel@16:     private const byte VENDOR_ID_REGISTER = 0x58;
moel@272:     private const byte FAN_TACHOMETER_DIVISOR_REGISTER = 0x0B;
moel@195:     private readonly byte[] FAN_TACHOMETER_REG = 
moel@16:       new byte[] { 0x0d, 0x0e, 0x0f, 0x80, 0x82 };
moel@195:     private readonly byte[] FAN_TACHOMETER_EXT_REG =
moel@16:       new byte[] { 0x18, 0x19, 0x1a, 0x81, 0x83 };
moel@78:     private const byte VOLTAGE_BASE_REG = 0x20;
moel@78: 
moel@78:     private byte ReadByte(byte register, out bool valid) {
moel@236:       Ring0.WriteIoPort(addressReg, register);
moel@236:       byte value = Ring0.ReadIoPort(dataReg);
moel@236:       valid = register == Ring0.ReadIoPort(addressReg);
moel@78:       return value;
moel@228:     }
moel@16: 
moel@247:     private bool WriteByte(byte register, byte value) {
moel@247:       Ring0.WriteIoPort(addressReg, register);
moel@247:       Ring0.WriteIoPort(dataReg, value);
moel@272:       return register == Ring0.ReadIoPort(addressReg); 
moel@320:     }
moel@247: 
moel@228:     public byte? ReadGPIO(int index) {
moel@228:       if (index >= gpioCount)
moel@228:         return null;
moel@228: 
moel@236:       return Ring0.ReadIoPort((ushort)(gpioAddress + index));
moel@228:     }
moel@228: 
moel@228:     public void WriteGPIO(int index, byte value) {
moel@228:       if (index >= gpioCount)
moel@228:         return;
moel@228: 
moel@236:       Ring0.WriteIoPort((ushort)(gpioAddress + index), value);
moel@341:     } 
moel@228: 
moel@323:     public void SetControl(int index, byte? value) { }   
moel@323: 
moel@228:     public IT87XX(Chip chip, ushort address, ushort gpioAddress, byte version) {
moel@272: 
moel@16:       this.address = address;
moel@130:       this.chip = chip;
moel@145:       this.version = version;
moel@78:       this.addressReg = (ushort)(address + ADDRESS_REGISTER_OFFSET);
moel@78:       this.dataReg = (ushort)(address + DATA_REGISTER_OFFSET);
moel@228:       this.gpioAddress = gpioAddress;
moel@228: 
moel@16:       // Check vendor id
moel@78:       bool valid;
moel@78:       byte vendorId = ReadByte(VENDOR_ID_REGISTER, out valid);       
moel@78:       if (!valid || vendorId != ITE_VENDOR_ID)
moel@16:         return;
moel@16: 
moel@16:       // Bit 0x10 of the configuration register should always be 1
moel@78:       if ((ReadByte(CONFIGURATION_REGISTER, out valid) & 0x10) == 0)
moel@78:         return;
moel@78:       if (!valid)
moel@16:         return;
moel@16: 
moel@130:       voltages = new float?[9];
moel@130:       temperatures = new float?[3];
moel@353:       fans = new float?[chip == Chip.IT8705F ? 3 : 5];
moel@170: 
moel@320:       // IT8721F, IT8728F and IT8772E use a 12mV resultion ADC, all others 16mV
moel@341:       if (chip == Chip.IT8721F || chip == Chip.IT8728F || chip == Chip.IT8771E 
moel@341:         || chip == Chip.IT8772E) 
moel@319:       {
moel@170:         voltageGain = 0.012f;
moel@170:       } else {
moel@272:         voltageGain = 0.016f;        
moel@272:       }
moel@272: 
moel@353:       // older IT8705F and IT8721F revisions do not have 16-bit fan counters
moel@353:       if ((chip == Chip.IT8705F && version < 3) || 
moel@353:           (chip == Chip.IT8712F && version < 8)) 
moel@353:       {
moel@272:         has16bitFanCounter = false;
moel@272:       } else {
moel@272:         has16bitFanCounter = true;
moel@170:       }
moel@228: 
moel@228:       // Set the number of GPIO sets
moel@228:       switch (chip) {
moel@228:         case Chip.IT8712F:
moel@228:         case Chip.IT8716F:
moel@228:         case Chip.IT8718F:
moel@228:         case Chip.IT8726F:
moel@228:           gpioCount = 5;
moel@228:           break;
moel@228:         case Chip.IT8720F:
moel@228:         case Chip.IT8721F:
moel@228:           gpioCount = 8;
moel@228:           break;
moel@353:         case Chip.IT8705F: 
moel@277:         case Chip.IT8728F:
moel@341:         case Chip.IT8771E:
moel@319:         case Chip.IT8772E:
moel@277:           gpioCount = 0;
moel@277:           break;
moel@228:       }
moel@16:     }
moel@16: 
moel@130:     public Chip Chip { get { return chip; } }
moel@130:     public float?[] Voltages { get { return voltages; } }
moel@130:     public float?[] Temperatures { get { return temperatures; } }
moel@130:     public float?[] Fans { get { return fans; } }
moel@323:     public float?[] Controls { get { return controls; } }
moel@16: 
moel@130:     public string GetReport() {
moel@16:       StringBuilder r = new StringBuilder();
moel@16: 
moel@31:       r.AppendLine("LPC " + this.GetType().Name);
moel@16:       r.AppendLine();
moel@16:       r.Append("Chip ID: 0x"); r.AppendLine(chip.ToString("X"));
moel@166:       r.Append("Chip Version: 0x"); r.AppendLine(
moel@166:         version.ToString("X", CultureInfo.InvariantCulture));
moel@166:       r.Append("Base Address: 0x"); r.AppendLine(
moel@166:         address.ToString("X4", CultureInfo.InvariantCulture));
moel@228:       r.Append("GPIO Address: 0x"); r.AppendLine(
moel@228:         gpioAddress.ToString("X4", CultureInfo.InvariantCulture));
moel@16:       r.AppendLine();
moel@162: 
moel@236:       if (!Ring0.WaitIsaBusMutex(100))
moel@162:         return r.ToString();
moel@162: 
moel@16:       r.AppendLine("Environment Controller Registers");
moel@16:       r.AppendLine();
moel@16:       r.AppendLine("      00 01 02 03 04 05 06 07 08 09 0A 0B 0C 0D 0E 0F");
moel@16:       r.AppendLine();
moel@16:       for (int i = 0; i <= 0xA; i++) {
moel@166:         r.Append(" "); 
moel@166:         r.Append((i << 4).ToString("X2", CultureInfo.InvariantCulture)); 
moel@166:         r.Append("  ");
moel@16:         for (int j = 0; j <= 0xF; j++) {
moel@16:           r.Append(" ");
moel@78:           bool valid;
moel@78:           byte value = ReadByte((byte)((i << 4) | j), out valid);
moel@195:           r.Append(
moel@195:             valid ? value.ToString("X2", CultureInfo.InvariantCulture) : "??");
moel@16:         }
moel@16:         r.AppendLine();
moel@16:       }
moel@16:       r.AppendLine();
moel@16: 
moel@228:       r.AppendLine("GPIO Registers");
moel@228:       r.AppendLine();
moel@228:       for (int i = 0; i < gpioCount; i++) {
moel@228:         r.Append(" ");
moel@228:         r.Append(ReadGPIO(i).Value.ToString("X2",
moel@228:           CultureInfo.InvariantCulture));
moel@228:       }
moel@228:       r.AppendLine();
moel@228:       r.AppendLine();
moel@228: 
moel@236:       Ring0.ReleaseIsaBusMutex();
moel@162: 
moel@16:       return r.ToString();
moel@16:     }
moel@16: 
moel@130:     public void Update() {
moel@236:       if (!Ring0.WaitIsaBusMutex(10))
moel@162:         return;
moel@16: 
moel@130:       for (int i = 0; i < voltages.Length; i++) {
moel@78:         bool valid;
moel@170:         
moel@170:         float value = 
moel@170:           voltageGain * ReadByte((byte)(VOLTAGE_BASE_REG + i), out valid);   
moel@170: 
moel@130:         if (!valid)
moel@130:           continue;
moel@130:         if (value > 0)
moel@130:           voltages[i] = value;  
moel@130:         else
moel@130:           voltages[i] = null;
moel@130:       }
moel@130: 
moel@130:       for (int i = 0; i < temperatures.Length; i++) {
moel@130:         bool valid;
moel@130:         sbyte value = (sbyte)ReadByte(
moel@130:           (byte)(TEMPERATURE_BASE_REG + i), out valid);
moel@78:         if (!valid)
moel@78:           continue;
moel@78: 
moel@130:         if (value < sbyte.MaxValue && value > 0)
moel@130:           temperatures[i] = value;
moel@130:         else
moel@130:           temperatures[i] = null;       
moel@16:       }
moel@16: 
moel@272:       if (has16bitFanCounter) {
moel@272:         for (int i = 0; i < fans.Length; i++) {
moel@272:           bool valid;
moel@272:           int value = ReadByte(FAN_TACHOMETER_REG[i], out valid);
moel@272:           if (!valid)
moel@272:             continue;
moel@272:           value |= ReadByte(FAN_TACHOMETER_EXT_REG[i], out valid) << 8;
moel@272:           if (!valid)
moel@272:             continue;
moel@16: 
moel@272:           if (value > 0x3f) {
moel@272:             fans[i] = (value < 0xffff) ? 1.35e6f / (value * 2) : 0;
moel@272:           } else {
moel@272:             fans[i] = null;
moel@272:           }
moel@272:         }
moel@272:       } else {
moel@272:         for (int i = 0; i < fans.Length; i++) {
moel@272:           bool valid;
moel@272:           int value = ReadByte(FAN_TACHOMETER_REG[i], out valid);
moel@272:           if (!valid)
moel@272:             continue;
moel@272: 
moel@272:           int divisor = 2;
moel@272:           if (i < 2) {
moel@272:             int divisors = ReadByte(FAN_TACHOMETER_DIVISOR_REGISTER, out valid);
moel@272:             if (!valid)
moel@272:               continue;
moel@272:             divisor = 1 << ((divisors >> (3 * i)) & 0x7);
moel@272:           }
moel@272: 
moel@272:           if (value > 0) {
moel@272:             fans[i] = (value < 0xff) ? 1.35e6f / (value * divisor) : 0;
moel@272:           } else {
moel@272:             fans[i] = null;
moel@272:           }
moel@16:         }
moel@162:       }
moel@162: 
moel@236:       Ring0.ReleaseIsaBusMutex();
moel@126:     }
moel@130:   } 
moel@16: }