moel@34: /*
moel@34:   
moel@34:   Version: MPL 1.1/GPL 2.0/LGPL 2.1
moel@34: 
moel@34:   The contents of this file are subject to the Mozilla Public License Version
moel@34:   1.1 (the "License"); you may not use this file except in compliance with
moel@34:   the License. You may obtain a copy of the License at
moel@34:  
moel@34:   http://www.mozilla.org/MPL/
moel@34: 
moel@34:   Software distributed under the License is distributed on an "AS IS" basis,
moel@34:   WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
moel@34:   for the specific language governing rights and limitations under the License.
moel@34: 
moel@34:   The Original Code is the Open Hardware Monitor code.
moel@34: 
moel@34:   The Initial Developer of the Original Code is 
moel@34:   Michael Möller <m.moeller@gmx.ch>.
moel@323:   Portions created by the Initial Developer are Copyright (C) 2009-2011
moel@34:   the Initial Developer. All Rights Reserved.
moel@34: 
moel@34:   Contributor(s):
moel@34: 
moel@34:   Alternatively, the contents of this file may be used under the terms of
moel@34:   either the GNU General Public License Version 2 or later (the "GPL"), or
moel@34:   the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
moel@34:   in which case the provisions of the GPL or the LGPL are applicable instead
moel@34:   of those above. If you wish to allow use of your version of this file only
moel@34:   under the terms of either the GPL or the LGPL, and not to allow others to
moel@34:   use your version of this file under the terms of the MPL, indicate your
moel@34:   decision by deleting the provisions above and replace them with the notice
moel@34:   and other provisions required by the GPL or the LGPL. If you do not delete
moel@34:   the provisions above, a recipient may use your version of this file under
moel@34:   the terms of any one of the MPL, the GPL or the LGPL.
moel@34:  
moel@34: */
moel@34: 
moel@34: using System;
moel@166: using System.Globalization;
moel@34: using System.Text;
moel@34: 
moel@34: namespace OpenHardwareMonitor.Hardware.LPC {
moel@165:   internal class W836XX : ISuperIO {
moel@34: 
moel@195:     private readonly ushort address;
moel@195:     private readonly byte revision;
moel@34: 
moel@195:     private readonly Chip chip;
moel@34: 
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@34: 
moel@195:     private readonly bool[] peciTemperature = new bool[0];
moel@195:     private readonly byte[] voltageRegister = new byte[0];
moel@195:     private readonly byte[] voltageBank = new byte[0];
moel@195:     private readonly float voltageGain = 0.008f;
moel@34: 
moel@34:     // Consts 
moel@34:     private const ushort WINBOND_VENDOR_ID = 0x5CA3;
moel@34:     private const byte HIGH_BYTE = 0x80;
moel@34: 
moel@34:     // Hardware Monitor
moel@34:     private const byte ADDRESS_REGISTER_OFFSET = 0x05;
moel@34:     private const byte DATA_REGISTER_OFFSET = 0x06;
moel@34: 
moel@34:     // Hardware Monitor Registers
moel@130:     private const byte VOLTAGE_VBAT_REG = 0x51;
moel@54:     private const byte BANK_SELECT_REGISTER = 0x4E;
moel@34:     private const byte VENDOR_ID_REGISTER = 0x4F;
moel@56:     private const byte TEMPERATURE_SOURCE_SELECT_REG = 0x49;
moel@56: 
moel@195:     private readonly byte[] TEMPERATURE_REG = new byte[] { 0x50, 0x50, 0x27 };
moel@195:     private readonly byte[] TEMPERATURE_BANK = new byte[] { 1, 2, 0 };
moel@34: 
moel@195:     private readonly byte[] FAN_TACHO_REG = 
moel@195:       new byte[] { 0x28, 0x29, 0x2A, 0x3F, 0x53 };
moel@195:     private readonly byte[] FAN_TACHO_BANK = 
moel@195:       new byte[] { 0, 0, 0, 0, 5 };       
moel@195:     private readonly byte[] FAN_BIT_REG =
moel@195:       new byte[] { 0x47, 0x4B, 0x4C, 0x59, 0x5D };
moel@195:     private readonly byte[] FAN_DIV_BIT0 = new byte[] { 36, 38, 30, 8, 10 };
moel@195:     private readonly byte[] FAN_DIV_BIT1 = new byte[] { 37, 39, 31, 9, 11 };
moel@195:     private readonly byte[] FAN_DIV_BIT2 = new byte[] { 5, 6, 7, 23, 15 };
moel@34: 
moel@34:     private byte ReadByte(byte bank, byte register) {
moel@236:       Ring0.WriteIoPort(
moel@34:          (ushort)(address + ADDRESS_REGISTER_OFFSET), BANK_SELECT_REGISTER);
moel@236:       Ring0.WriteIoPort(
moel@34:          (ushort)(address + DATA_REGISTER_OFFSET), bank);
moel@236:       Ring0.WriteIoPort(
moel@34:          (ushort)(address + ADDRESS_REGISTER_OFFSET), register);
moel@236:       return Ring0.ReadIoPort(
moel@34:         (ushort)(address + DATA_REGISTER_OFFSET));
moel@130:     } 
moel@34: 
moel@56:     private void WriteByte(byte bank, byte register, byte value) {
moel@236:       Ring0.WriteIoPort(
moel@56:          (ushort)(address + ADDRESS_REGISTER_OFFSET), BANK_SELECT_REGISTER);
moel@236:       Ring0.WriteIoPort(
moel@56:          (ushort)(address + DATA_REGISTER_OFFSET), bank);
moel@236:       Ring0.WriteIoPort(
moel@56:          (ushort)(address + ADDRESS_REGISTER_OFFSET), register);
moel@236:       Ring0.WriteIoPort(
moel@56:          (ushort)(address + DATA_REGISTER_OFFSET), value); 
moel@56:     }
moel@228: 
moel@228:     public byte? ReadGPIO(int index) {
moel@228:       return null;
moel@228:     }
moel@228: 
moel@228:     public void WriteGPIO(int index, byte value) { }
moel@323: 
moel@323:     public void SetControl(int index, byte? value) { }   
moel@323: 
moel@130:     public W836XX(Chip chip, byte revision, ushort address) {
moel@34:       this.address = address;
moel@34:       this.revision = revision;
moel@130:       this.chip = chip;
moel@34: 
moel@130:       if (!IsWinbondVendor())
moel@130:         return;
moel@130:       
moel@130:       temperatures = new float?[3];
moel@130:       peciTemperature = new bool[3];
moel@56:       switch (chip) {
moel@63:         case Chip.W83667HG:
moel@63:         case Chip.W83667HGB:
moel@130:           // note temperature sensor registers that read PECI
moel@63:           byte flag = ReadByte(0, TEMPERATURE_SOURCE_SELECT_REG);
moel@130:           peciTemperature[0] = (flag & 0x04) != 0;
moel@130:           peciTemperature[1] = (flag & 0x40) != 0;
moel@130:           peciTemperature[2] = false;
moel@63:           break;
moel@63:         case Chip.W83627DHG:        
moel@63:         case Chip.W83627DHGP:
moel@152:           // note temperature sensor registers that read PECI
moel@56:           byte sel = ReadByte(0, TEMPERATURE_SOURCE_SELECT_REG);
moel@130:           peciTemperature[0] = (sel & 0x07) != 0;
moel@130:           peciTemperature[1] = (sel & 0x70) != 0;
moel@130:           peciTemperature[2] = false;
moel@56:           break;
moel@56:         default:
moel@130:           // no PECI support
moel@130:           peciTemperature[0] = false;
moel@130:           peciTemperature[1] = false;
moel@130:           peciTemperature[2] = false;
moel@56:           break;
moel@56:       }
moel@34: 
moel@34:       switch (chip) {
moel@130:         case Chip.W83627EHF:
moel@130:           voltages = new float?[10];
moel@130:           voltageRegister = new byte[] { 
moel@130:             0x20, 0x21, 0x22, 0x23, 0x24, 0x25, 0x26, 0x50, 0x51, 0x52 };
moel@130:           voltageBank = new byte[] { 0, 0, 0, 0, 0, 0, 0, 5, 5, 5 };
moel@130:           voltageGain = 0.008f;
moel@130:           fans = new float?[5];
moel@130:           break;
moel@34:         case Chip.W83627DHG:
moel@130:         case Chip.W83627DHGP:        
moel@34:         case Chip.W83667HG:
moel@130:         case Chip.W83667HGB:
moel@130:           voltages = new float?[9];
moel@130:           voltageRegister = new byte[] { 
moel@130:             0x20, 0x21, 0x22, 0x23, 0x24, 0x25, 0x26, 0x50, 0x51 };
moel@130:           voltageBank = new byte[] { 0, 0, 0, 0, 0, 0, 0, 5, 5 };
moel@130:           voltageGain = 0.008f;
moel@130:           fans = new float?[5];
moel@34:           break;
moel@54:         case Chip.W83627HF:
moel@54:         case Chip.W83627THF:
moel@67:         case Chip.W83687THF:
moel@130:           voltages = new float?[7];
moel@130:           voltageRegister = new byte[] { 
moel@130:             0x20, 0x21, 0x22, 0x23, 0x24, 0x50, 0x51 };
moel@130:           voltageBank = new byte[] { 0, 0, 0, 0, 0, 5, 5 };
moel@130:           voltageGain = 0.016f;
moel@130:           fans = new float?[3];         
moel@34:           break;
moel@34:       }
moel@130:     }    
moel@34: 
moel@34:     private bool IsWinbondVendor() {
moel@34:       ushort vendorId =
moel@34:         (ushort)((ReadByte(HIGH_BYTE, VENDOR_ID_REGISTER) << 8) |
moel@34:            ReadByte(0, VENDOR_ID_REGISTER));
moel@34:       return vendorId == WINBOND_VENDOR_ID;
moel@34:     }
moel@34: 
moel@167:     private static ulong SetBit(ulong target, int bit, int value) {
moel@85:       if ((value & 1) != value)
moel@85:         throw new ArgumentException("Value must be one bit only.");
moel@85: 
moel@85:       if (bit < 0 || bit > 63)
moel@85:         throw new ArgumentException("Bit out of range.");
moel@85: 
moel@85:       ulong mask = (((ulong)1) << bit);
moel@85:       return value > 0 ? target | mask : target & ~mask;
moel@85:     }
moel@85: 
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@56: 
moel@130:     public void Update() {
moel@236:       if (!Ring0.WaitIsaBusMutex(10))
moel@162:         return;
moel@130: 
moel@130:       for (int i = 0; i < voltages.Length; i++) {
moel@130:         if (voltageRegister[i] != VOLTAGE_VBAT_REG) {
moel@58:           // two special VCore measurement modes for W83627THF
moel@130:           float fvalue;
moel@67:           if ((chip == Chip.W83627HF || chip == Chip.W83627THF || 
moel@130:             chip == Chip.W83687THF) && i == 0) 
moel@67:           {
moel@58:             byte vrmConfiguration = ReadByte(0, 0x18);
moel@130:             int value = ReadByte(voltageBank[i], voltageRegister[i]);
moel@58:             if ((vrmConfiguration & 0x01) == 0)
moel@130:               fvalue = 0.016f * value; // VRM8 formula
moel@58:             else
moel@130:               fvalue = 0.00488f * value + 0.69f; // VRM9 formula
moel@58:           } else {
moel@130:             int value = ReadByte(voltageBank[i], voltageRegister[i]);
moel@130:             fvalue = voltageGain * value;
moel@58:           }
moel@130:           if (fvalue > 0)
moel@130:             voltages[i] = fvalue;
moel@130:           else
moel@130:             voltages[i] = null;
moel@34:         } else {
moel@34:           // Battery voltage
moel@34:           bool valid = (ReadByte(0, 0x5D) & 0x01) > 0;
moel@34:           if (valid) {
moel@130:             voltages[i] = voltageGain * ReadByte(5, VOLTAGE_VBAT_REG);
moel@84:           } else {
moel@130:             voltages[i] = null;
moel@84:           }
moel@34:         }
moel@34:       }
moel@34: 
moel@130:       for (int i = 0; i < temperatures.Length; i++) {
moel@130:         int value = ((sbyte)ReadByte(TEMPERATURE_BANK[i], 
moel@130:           TEMPERATURE_REG[i])) << 1;
moel@130:         if (TEMPERATURE_BANK[i] > 0) 
moel@130:           value |= ReadByte(TEMPERATURE_BANK[i],
moel@130:             (byte)(TEMPERATURE_REG[i] + 1)) >> 7;
moel@63: 
moel@56:         float temperature = value / 2.0f;
moel@130:         if (temperature <= 125 && temperature >= -55 && !peciTemperature[i]) {
moel@130:           temperatures[i] = temperature;
moel@34:         } else {
moel@130:           temperatures[i] = null;
moel@34:         }
moel@34:       }
moel@34: 
moel@85:       ulong bits = 0;
moel@34:       for (int i = 0; i < FAN_BIT_REG.Length; i++)
moel@34:         bits = (bits << 8) | ReadByte(0, FAN_BIT_REG[i]);
moel@85:       ulong newBits = bits;
moel@130:       for (int i = 0; i < fans.Length; i++) {
moel@130:         int count = ReadByte(FAN_TACHO_BANK[i], FAN_TACHO_REG[i]);
moel@85:         
moel@85:         // assemble fan divisor
moel@34:         int divisorBits = (int)(
moel@130:           (((bits >> FAN_DIV_BIT2[i]) & 1) << 2) |
moel@130:           (((bits >> FAN_DIV_BIT1[i]) & 1) << 1) |
moel@130:            ((bits >> FAN_DIV_BIT0[i]) & 1));
moel@34:         int divisor = 1 << divisorBits;
moel@85:        
moel@34:         float value = (count < 0xff) ? 1.35e6f / (count * divisor) : 0;
moel@130:         fans[i] = value;
moel@85: 
moel@85:         // update fan divisor
moel@85:         if (count > 192 && divisorBits < 7) 
moel@85:           divisorBits++;
moel@85:         if (count < 96 && divisorBits > 0)
moel@85:           divisorBits--;
moel@85: 
moel@130:         newBits = SetBit(newBits, FAN_DIV_BIT2[i], (divisorBits >> 2) & 1);
moel@130:         newBits = SetBit(newBits, FAN_DIV_BIT1[i], (divisorBits >> 1) & 1);
moel@130:         newBits = SetBit(newBits, FAN_DIV_BIT0[i], divisorBits & 1);
moel@85:       }
moel@85:      
moel@85:       // write new fan divisors 
moel@85:       for (int i = FAN_BIT_REG.Length - 1; i >= 0; i--) {
moel@85:         byte oldByte = (byte)(bits & 0xFF);
moel@85:         byte newByte = (byte)(newBits & 0xFF);
moel@85:         bits = bits >> 8;
moel@85:         newBits = newBits >> 8;
moel@85:         if (oldByte != newByte) 
moel@85:           WriteByte(0, FAN_BIT_REG[i], newByte);        
moel@85:       }
moel@162: 
moel@236:       Ring0.ReleaseIsaBusMutex();
moel@34:     }
moel@34: 
moel@130:     public string GetReport() {
moel@34:       StringBuilder r = new StringBuilder();
moel@34: 
moel@34:       r.AppendLine("LPC " + this.GetType().Name);
moel@34:       r.AppendLine();
moel@34:       r.Append("Chip ID: 0x"); r.AppendLine(chip.ToString("X"));
moel@166:       r.Append("Chip revision: 0x");
moel@166:       r.AppendLine(revision.ToString("X", CultureInfo.InvariantCulture));
moel@166:       r.Append("Base Adress: 0x");
moel@166:       r.AppendLine(address.ToString("X4", CultureInfo.InvariantCulture));
moel@34:       r.AppendLine();
moel@162: 
moel@236:       if (!Ring0.WaitIsaBusMutex(100))
moel@162:         return r.ToString();
moel@162: 
moel@34:       r.AppendLine("Hardware Monitor Registers");
moel@34:       r.AppendLine();
moel@34:       r.AppendLine("      00 01 02 03 04 05 06 07 08 09 0A 0B 0C 0D 0E 0F");
moel@34:       r.AppendLine();
moel@56:       for (int i = 0; i <= 0x7; i++) {
moel@166:         r.Append(" ");
moel@166:         r.Append((i << 4).ToString("X2", CultureInfo.InvariantCulture)); 
moel@166:         r.Append("  ");
moel@34:         for (int j = 0; j <= 0xF; j++) {
moel@34:           r.Append(" ");
moel@166:           r.Append(ReadByte(0, (byte)((i << 4) | j)).ToString(
moel@166:             "X2", CultureInfo.InvariantCulture));
moel@34:         }
moel@34:         r.AppendLine();
moel@34:       }
moel@53:       for (int k = 1; k <= 15; k++) {
moel@34:         r.AppendLine("Bank " + k);
moel@34:         for (int i = 0x5; i < 0x6; i++) {
moel@166:           r.Append(" "); 
moel@166:           r.Append((i << 4).ToString("X2", CultureInfo.InvariantCulture)); 
moel@166:           r.Append("  ");
moel@34:           for (int j = 0; j <= 0xF; j++) {
moel@34:             r.Append(" ");
moel@166:             r.Append(ReadByte((byte)(k), (byte)((i << 4) | j)).ToString(
moel@166:               "X2", CultureInfo.InvariantCulture));
moel@34:           }
moel@34:           r.AppendLine();
moel@34:         }
moel@34:       }
moel@34:       r.AppendLine();
moel@34: 
moel@236:       Ring0.ReleaseIsaBusMutex();
moel@162: 
moel@34:       return r.ToString();
moel@34:     }
moel@130:   } 
moel@34: }