Hardware/LPC/LPCIO.cs
author Stephane Lenclud
Sat, 30 Jan 2016 23:01:51 +0100
branchMiniDisplay
changeset 454 f84878f52cd9
parent 423 47f5dcaf8e9f
permissions -rw-r--r--
Disabling Nuvoton NCT6791D because of fan full speed bug on Asus Z97 WS.
     1 /*
     2  
     3   This Source Code Form is subject to the terms of the Mozilla Public
     4   License, v. 2.0. If a copy of the MPL was not distributed with this
     5   file, You can obtain one at http://mozilla.org/MPL/2.0/.
     6  
     7   Copyright (C) 2009-2013 Michael Möller <mmoeller@openhardwaremonitor.org>
     8 	
     9 */
    10 
    11 using System;
    12 using System.Collections.Generic;
    13 using System.Globalization;
    14 using System.Text;
    15 using System.Threading;
    16 
    17 namespace OpenHardwareMonitor.Hardware.LPC {
    18   internal class LPCIO {
    19 
    20     private readonly List<ISuperIO> superIOs = new List<ISuperIO>();
    21     private readonly StringBuilder report = new StringBuilder();
    22 
    23     // I/O Ports
    24     private readonly ushort[] REGISTER_PORTS = new ushort[] { 0x2E, 0x4E };
    25     private readonly ushort[] VALUE_PORTS = new ushort[] { 0x2F, 0x4F };
    26 
    27     private ushort registerPort;
    28     private ushort valuePort;
    29 
    30     // Registers
    31     private const byte CONFIGURATION_CONTROL_REGISTER = 0x02;
    32     private const byte DEVCIE_SELECT_REGISTER = 0x07;
    33     private const byte CHIP_ID_REGISTER = 0x20;
    34     private const byte CHIP_REVISION_REGISTER = 0x21;
    35     private const byte BASE_ADDRESS_REGISTER = 0x60;
    36 
    37     private byte ReadByte(byte register) {
    38       Ring0.WriteIoPort(registerPort, register);
    39       return Ring0.ReadIoPort(valuePort);
    40     }
    41 
    42     private void WriteByte(byte register, byte value) {
    43       Ring0.WriteIoPort(registerPort, register);
    44       Ring0.WriteIoPort(valuePort, value);
    45     }
    46 
    47     private ushort ReadWord(byte register) {
    48       return (ushort)((ReadByte(register) << 8) |
    49         ReadByte((byte)(register + 1)));
    50     }
    51 
    52     private void Select(byte logicalDeviceNumber) {
    53       Ring0.WriteIoPort(registerPort, DEVCIE_SELECT_REGISTER);
    54       Ring0.WriteIoPort(valuePort, logicalDeviceNumber);
    55     }
    56 
    57     private void ReportUnknownChip(string type, int chip) {
    58       report.Append("Chip ID: Unknown ");
    59       report.Append(type);
    60       report.Append(" with ID 0x");
    61       report.Append(chip.ToString("X", CultureInfo.InvariantCulture));
    62       report.Append(" at 0x");
    63       report.Append(registerPort.ToString("X", CultureInfo.InvariantCulture));
    64       report.Append("/0x");
    65       report.AppendLine(valuePort.ToString("X", CultureInfo.InvariantCulture));
    66       report.AppendLine();
    67     }
    68 
    69     #region Winbond, Nuvoton, Fintek
    70 
    71     private const byte FINTEK_VENDOR_ID_REGISTER = 0x23;
    72     private const ushort FINTEK_VENDOR_ID = 0x1934;
    73 
    74     private const byte WINBOND_NUVOTON_HARDWARE_MONITOR_LDN = 0x0B;
    75 
    76     private const byte F71858_HARDWARE_MONITOR_LDN = 0x02;
    77     private const byte FINTEK_HARDWARE_MONITOR_LDN = 0x04;
    78 
    79     private const byte NUVOTON_HARDWARE_MONITOR_IO_SPACE_LOCK = 0x28;
    80 
    81     private void WinbondNuvotonFintekEnter() {
    82       Ring0.WriteIoPort(registerPort, 0x87);
    83       Ring0.WriteIoPort(registerPort, 0x87);
    84     }
    85 
    86     private void WinbondNuvotonFintekExit() {
    87       Ring0.WriteIoPort(registerPort, 0xAA);
    88     }
    89 
    90     private bool DetectWinbondFintek() {
    91       WinbondNuvotonFintekEnter();
    92 
    93       byte logicalDeviceNumber = 0;
    94       byte id = ReadByte(CHIP_ID_REGISTER);
    95       byte revision = ReadByte(CHIP_REVISION_REGISTER);
    96       Chip chip = Chip.Unknown;
    97       switch (id) {
    98         case 0x05:
    99           switch (revision) {
   100             case 0x07:
   101               chip = Chip.F71858;
   102               logicalDeviceNumber = F71858_HARDWARE_MONITOR_LDN;
   103               break;
   104             case 0x41:
   105               chip = Chip.F71882;
   106               logicalDeviceNumber = FINTEK_HARDWARE_MONITOR_LDN;
   107               break;
   108           } break;
   109         case 0x06:
   110           switch (revision) {
   111             case 0x01:
   112               chip = Chip.F71862;
   113               logicalDeviceNumber = FINTEK_HARDWARE_MONITOR_LDN;
   114               break;
   115           } break;
   116         case 0x07:
   117           switch (revision) {
   118             case 0x23:
   119               chip = Chip.F71889F;
   120               logicalDeviceNumber = FINTEK_HARDWARE_MONITOR_LDN;
   121               break;
   122           } break;
   123         case 0x08:
   124           switch (revision) {
   125             case 0x14:
   126               chip = Chip.F71869;
   127               logicalDeviceNumber = FINTEK_HARDWARE_MONITOR_LDN;
   128               break;
   129           } break;
   130         case 0x09:
   131           switch (revision) {
   132             case 0x01:
   133               chip = Chip.F71808E;
   134               logicalDeviceNumber = FINTEK_HARDWARE_MONITOR_LDN;
   135               break;
   136             case 0x09:
   137               chip = Chip.F71889ED;
   138               logicalDeviceNumber = FINTEK_HARDWARE_MONITOR_LDN;
   139               break;
   140           } break;
   141         case 0x10:
   142           switch (revision) {
   143             case 0x05:
   144               chip = Chip.F71889AD;
   145               logicalDeviceNumber = FINTEK_HARDWARE_MONITOR_LDN;
   146               break;
   147             case 0x07:
   148               chip = Chip.F71869A;
   149               logicalDeviceNumber = FINTEK_HARDWARE_MONITOR_LDN;
   150               break;
   151           } break;
   152         case 0x52:
   153           switch (revision) {
   154             case 0x17:
   155             case 0x3A:
   156             case 0x41:
   157               chip = Chip.W83627HF;
   158               logicalDeviceNumber = WINBOND_NUVOTON_HARDWARE_MONITOR_LDN;
   159               break;
   160           } break;
   161         case 0x82:
   162           switch (revision & 0xF0) {
   163             case 0x80:
   164               chip = Chip.W83627THF;
   165               logicalDeviceNumber = WINBOND_NUVOTON_HARDWARE_MONITOR_LDN;
   166               break;
   167           } break;
   168         case 0x85:
   169           switch (revision) {
   170             case 0x41:
   171               chip = Chip.W83687THF;
   172               logicalDeviceNumber = WINBOND_NUVOTON_HARDWARE_MONITOR_LDN;
   173               break;
   174           } break;
   175         case 0x88:
   176           switch (revision & 0xF0) {
   177             case 0x50:
   178             case 0x60:
   179               chip = Chip.W83627EHF;
   180               logicalDeviceNumber = WINBOND_NUVOTON_HARDWARE_MONITOR_LDN;
   181               break;
   182           } break;
   183         case 0xA0:
   184           switch (revision & 0xF0) {
   185             case 0x20:
   186               chip = Chip.W83627DHG;
   187               logicalDeviceNumber = WINBOND_NUVOTON_HARDWARE_MONITOR_LDN;
   188               break;
   189           } break;
   190         case 0xA5:
   191           switch (revision & 0xF0) {
   192             case 0x10:
   193               chip = Chip.W83667HG;
   194               logicalDeviceNumber = WINBOND_NUVOTON_HARDWARE_MONITOR_LDN;
   195               break;
   196           } break;
   197         case 0xB0:
   198           switch (revision & 0xF0) {
   199             case 0x70:
   200               chip = Chip.W83627DHGP;
   201               logicalDeviceNumber = WINBOND_NUVOTON_HARDWARE_MONITOR_LDN;
   202               break;
   203           } break;
   204         case 0xB3:
   205           switch (revision & 0xF0) {
   206             case 0x50:
   207               chip = Chip.W83667HGB;
   208               logicalDeviceNumber = WINBOND_NUVOTON_HARDWARE_MONITOR_LDN;
   209               break;
   210           } break;
   211         case 0xB4:
   212           switch (revision & 0xF0) {
   213             case 0x70:
   214               chip = Chip.NCT6771F;
   215               logicalDeviceNumber = WINBOND_NUVOTON_HARDWARE_MONITOR_LDN;
   216               break;
   217           } break;
   218         case 0xC3:
   219           switch (revision & 0xF0) {
   220             case 0x30:
   221               chip = Chip.NCT6776F;
   222               logicalDeviceNumber = WINBOND_NUVOTON_HARDWARE_MONITOR_LDN;
   223               break;
   224           } break;
   225         case 0xC5:
   226           switch (revision & 0xF0) {
   227             case 0x60:
   228               chip = Chip.NCT6779D;
   229               logicalDeviceNumber = WINBOND_NUVOTON_HARDWARE_MONITOR_LDN;
   230               break;
   231           } break;
   232         case 0xC8:
   233           switch (revision) {
   234             case 0x03:
   235               //SL: disabling because of fan spinning issue
   236               //chip = Chip.NCT6791D;
   237               //logicalDeviceNumber = WINBOND_NUVOTON_HARDWARE_MONITOR_LDN;
   238               break;
   239           } break;
   240       }
   241       if (chip == Chip.Unknown) {
   242         if (id != 0 && id != 0xff) {
   243           WinbondNuvotonFintekExit();
   244 
   245           ReportUnknownChip("Winbond / Nuvoton / Fintek", 
   246             ((id << 8) | revision));
   247         }
   248       } else {
   249 
   250         Select(logicalDeviceNumber);
   251         ushort address = ReadWord(BASE_ADDRESS_REGISTER);
   252         Thread.Sleep(1);
   253         ushort verify = ReadWord(BASE_ADDRESS_REGISTER);
   254 
   255         ushort vendorID = ReadWord(FINTEK_VENDOR_ID_REGISTER);
   256 
   257         // disable the hardware monitor i/o space lock on NCT6791D chips
   258         
   259         if (address == verify && chip == Chip.NCT6791D) {
   260           byte options = ReadByte(NUVOTON_HARDWARE_MONITOR_IO_SPACE_LOCK);
   261 
   262           // if the i/o space lock is enabled
   263           if ((options & 0x10) > 0) {
   264 
   265             // disable the i/o space lock
   266             WriteByte(NUVOTON_HARDWARE_MONITOR_IO_SPACE_LOCK,
   267               (byte)(options & ~0x10));
   268           }
   269         }
   270         
   271 
   272         WinbondNuvotonFintekExit();
   273 
   274         if (address != verify) {
   275           report.Append("Chip ID: 0x");
   276           report.AppendLine(chip.ToString("X"));
   277           report.Append("Chip revision: 0x");
   278           report.AppendLine(revision.ToString("X",
   279             CultureInfo.InvariantCulture));
   280           report.AppendLine("Error: Address verification failed");
   281           report.AppendLine();
   282           return false;
   283         }
   284 
   285         // some Fintek chips have address register offset 0x05 added already
   286         if ((address & 0x07) == 0x05)
   287           address &= 0xFFF8;
   288 
   289         if (address < 0x100 || (address & 0xF007) != 0) {
   290           report.Append("Chip ID: 0x");
   291           report.AppendLine(chip.ToString("X"));
   292           report.Append("Chip revision: 0x");
   293           report.AppendLine(revision.ToString("X",
   294             CultureInfo.InvariantCulture));
   295           report.Append("Error: Invalid address 0x");
   296           report.AppendLine(address.ToString("X",
   297             CultureInfo.InvariantCulture));
   298           report.AppendLine();
   299           return false;
   300         }
   301 
   302         switch (chip) {
   303           case Chip.W83627DHG:
   304           case Chip.W83627DHGP:
   305           case Chip.W83627EHF:
   306           case Chip.W83627HF:
   307           case Chip.W83627THF:
   308           case Chip.W83667HG:
   309           case Chip.W83667HGB:
   310           case Chip.W83687THF:
   311             superIOs.Add(new W836XX(chip, revision, address));
   312             break;
   313           case Chip.NCT6771F:
   314           case Chip.NCT6776F:
   315           case Chip.NCT6779D:
   316           case Chip.NCT6791D:
   317             superIOs.Add(new NCT677X(chip, revision, address));
   318             break;
   319           case Chip.F71858:
   320           case Chip.F71862:
   321           case Chip.F71869:
   322           case Chip.F71869A:
   323           case Chip.F71882:
   324           case Chip.F71889AD:
   325           case Chip.F71889ED:
   326           case Chip.F71889F:
   327           case Chip.F71808E:
   328             if (vendorID != FINTEK_VENDOR_ID) {
   329               report.Append("Chip ID: 0x");
   330               report.AppendLine(chip.ToString("X"));
   331               report.Append("Chip revision: 0x");
   332               report.AppendLine(revision.ToString("X",
   333                 CultureInfo.InvariantCulture));
   334               report.Append("Error: Invalid vendor ID 0x");
   335               report.AppendLine(vendorID.ToString("X",
   336                 CultureInfo.InvariantCulture));
   337               report.AppendLine();
   338               return false;
   339             }
   340             superIOs.Add(new F718XX(chip, address));
   341             break;
   342           default: break;
   343         }
   344 
   345         return true;
   346       }
   347 
   348       return false;
   349     }
   350 
   351     #endregion
   352 
   353     #region ITE
   354 
   355     private const byte IT87_ENVIRONMENT_CONTROLLER_LDN = 0x04;
   356     private const byte IT8705_GPIO_LDN = 0x05;
   357     private const byte IT87XX_GPIO_LDN = 0x07;
   358     private const byte IT87_CHIP_VERSION_REGISTER = 0x22;
   359 
   360     private void IT87Enter() {
   361       Ring0.WriteIoPort(registerPort, 0x87);
   362       Ring0.WriteIoPort(registerPort, 0x01);
   363       Ring0.WriteIoPort(registerPort, 0x55);
   364       Ring0.WriteIoPort(registerPort, 0x55);
   365     }
   366 
   367     private void IT87Exit() {
   368       Ring0.WriteIoPort(registerPort, CONFIGURATION_CONTROL_REGISTER);
   369       Ring0.WriteIoPort(valuePort, 0x02);
   370     }
   371 
   372     private bool DetectIT87() {
   373 
   374       // IT87XX can enter only on port 0x2E
   375       if (registerPort != 0x2E)
   376         return false;
   377 
   378       IT87Enter();
   379 
   380       ushort chipID = ReadWord(CHIP_ID_REGISTER);
   381       Chip chip;
   382       switch (chipID) {
   383         case 0x8705: chip = Chip.IT8705F; break;
   384         case 0x8712: chip = Chip.IT8712F; break;
   385         case 0x8716: chip = Chip.IT8716F; break;
   386         case 0x8718: chip = Chip.IT8718F; break;
   387         case 0x8720: chip = Chip.IT8720F; break;
   388         case 0x8721: chip = Chip.IT8721F; break;
   389         case 0x8726: chip = Chip.IT8726F; break;
   390         case 0x8728: chip = Chip.IT8728F; break;
   391         case 0x8771: chip = Chip.IT8771E; break;
   392         case 0x8772: chip = Chip.IT8772E; break;
   393         default: chip = Chip.Unknown; break;
   394       }
   395       if (chip == Chip.Unknown) {
   396         if (chipID != 0 && chipID != 0xffff) {
   397           IT87Exit();
   398 
   399           ReportUnknownChip("ITE", chipID);
   400         }
   401       } else {
   402         Select(IT87_ENVIRONMENT_CONTROLLER_LDN);
   403         ushort address = ReadWord(BASE_ADDRESS_REGISTER);
   404         Thread.Sleep(1);
   405         ushort verify = ReadWord(BASE_ADDRESS_REGISTER);
   406 
   407         byte version = (byte)(ReadByte(IT87_CHIP_VERSION_REGISTER) & 0x0F);
   408 
   409         ushort gpioAddress;
   410         ushort gpioVerify;
   411         if (chip == Chip.IT8705F) {
   412           Select(IT8705_GPIO_LDN);
   413           gpioAddress = ReadWord(BASE_ADDRESS_REGISTER);
   414           Thread.Sleep(1);
   415           gpioVerify = ReadWord(BASE_ADDRESS_REGISTER);
   416         } else {
   417           Select(IT87XX_GPIO_LDN);
   418           gpioAddress = ReadWord(BASE_ADDRESS_REGISTER + 2);
   419           Thread.Sleep(1);
   420           gpioVerify = ReadWord(BASE_ADDRESS_REGISTER + 2);
   421         }
   422         
   423         IT87Exit();
   424 
   425         if (address != verify || address < 0x100 || (address & 0xF007) != 0) {
   426           report.Append("Chip ID: 0x");
   427           report.AppendLine(chip.ToString("X"));
   428           report.Append("Error: Invalid address 0x");
   429           report.AppendLine(address.ToString("X",
   430             CultureInfo.InvariantCulture));
   431           report.AppendLine();
   432           return false;
   433         }
   434 
   435         if (gpioAddress != gpioVerify || gpioAddress < 0x100 ||
   436           (gpioAddress & 0xF007) != 0) {
   437           report.Append("Chip ID: 0x");
   438           report.AppendLine(chip.ToString("X"));
   439           report.Append("Error: Invalid GPIO address 0x");
   440           report.AppendLine(gpioAddress.ToString("X",
   441             CultureInfo.InvariantCulture));
   442           report.AppendLine();
   443           return false;
   444         }
   445 
   446         superIOs.Add(new IT87XX(chip, address, gpioAddress, version));
   447         return true;
   448       }
   449 
   450       return false;
   451     }
   452 
   453     #endregion
   454 
   455     #region SMSC
   456 
   457     private void SMSCEnter() {
   458       Ring0.WriteIoPort(registerPort, 0x55);
   459     }
   460 
   461     private void SMSCExit() {
   462       Ring0.WriteIoPort(registerPort, 0xAA);
   463     }
   464 
   465     private bool DetectSMSC() {
   466       SMSCEnter();
   467 
   468       ushort chipID = ReadWord(CHIP_ID_REGISTER);
   469       Chip chip;
   470       switch (chipID) {
   471         default: chip = Chip.Unknown; break;
   472       }
   473       if (chip == Chip.Unknown) {
   474         if (chipID != 0 && chipID != 0xffff) {
   475           SMSCExit();
   476 
   477           ReportUnknownChip("SMSC", chipID);
   478         }
   479       } else {
   480         SMSCExit();
   481         return true;
   482       }
   483 
   484       return false;
   485     }
   486 
   487     #endregion
   488 
   489     private void Detect() {
   490 
   491       for (int i = 0; i < REGISTER_PORTS.Length; i++) {
   492         registerPort = REGISTER_PORTS[i];
   493         valuePort = VALUE_PORTS[i];
   494 
   495         if (DetectWinbondFintek()) continue;
   496 
   497         if (DetectIT87()) continue;
   498 
   499         if (DetectSMSC()) continue;
   500       }
   501     }
   502 
   503     public LPCIO() {
   504       if (!Ring0.IsOpen)
   505         return;
   506 
   507       if (!Ring0.WaitIsaBusMutex(100))
   508         return;
   509 
   510       Detect();
   511 
   512       Ring0.ReleaseIsaBusMutex();
   513     }
   514 
   515     public ISuperIO[] SuperIO {
   516       get {
   517         return superIOs.ToArray();
   518       }
   519     }
   520 
   521     public string GetReport() {
   522       if (report.Length > 0) {
   523         return "LPCIO" + Environment.NewLine + Environment.NewLine + report;
   524       } else
   525         return null;
   526     }
   527   }
   528 }