Hardware/LPC/LPCIO.cs
author moel.mich
Sun, 30 Jun 2013 11:41:36 +0000
changeset 408 bbeb9004c491
parent 355 17dbf781401e
child 413 362c5e77197d
permissions -rw-r--r--
Added support for the Fintek F71869A (F71868AD) super I/O chip.
     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 ushort ReadWord(byte register) {
    43       return (ushort)((ReadByte(register) << 8) |
    44         ReadByte((byte)(register + 1)));
    45     }
    46 
    47     private void Select(byte logicalDeviceNumber) {
    48       Ring0.WriteIoPort(registerPort, DEVCIE_SELECT_REGISTER);
    49       Ring0.WriteIoPort(valuePort, logicalDeviceNumber);
    50     }
    51 
    52     private void ReportUnknownChip(string type, int chip) {
    53       report.Append("Chip ID: Unknown ");
    54       report.Append(type);
    55       report.Append(" with ID 0x");
    56       report.Append(chip.ToString("X", CultureInfo.InvariantCulture));
    57       report.Append(" at 0x");
    58       report.Append(registerPort.ToString("X", CultureInfo.InvariantCulture));
    59       report.Append("/0x");
    60       report.AppendLine(valuePort.ToString("X", CultureInfo.InvariantCulture));
    61       report.AppendLine();
    62     }
    63 
    64     #region Winbond, Nuvoton, Fintek
    65 
    66     private const byte FINTEK_VENDOR_ID_REGISTER = 0x23;
    67     private const ushort FINTEK_VENDOR_ID = 0x1934;
    68 
    69     private const byte WINBOND_NUVOTON_HARDWARE_MONITOR_LDN = 0x0B;
    70 
    71     private const byte F71858_HARDWARE_MONITOR_LDN = 0x02;
    72     private const byte FINTEK_HARDWARE_MONITOR_LDN = 0x04;
    73 
    74     private void WinbondNuvotonFintekEnter() {
    75       Ring0.WriteIoPort(registerPort, 0x87);
    76       Ring0.WriteIoPort(registerPort, 0x87);
    77     }
    78 
    79     private void WinbondNuvotonFintekExit() {
    80       Ring0.WriteIoPort(registerPort, 0xAA);
    81     }
    82 
    83     private bool DetectWinbondFintek() {
    84       WinbondNuvotonFintekEnter();
    85 
    86       byte logicalDeviceNumber = 0;
    87       byte id = ReadByte(CHIP_ID_REGISTER);
    88       byte revision = ReadByte(CHIP_REVISION_REGISTER);
    89       Chip chip = Chip.Unknown;
    90       switch (id) {
    91         case 0x05:
    92           switch (revision) {
    93             case 0x07:
    94               chip = Chip.F71858;
    95               logicalDeviceNumber = F71858_HARDWARE_MONITOR_LDN;
    96               break;
    97             case 0x41:
    98               chip = Chip.F71882;
    99               logicalDeviceNumber = FINTEK_HARDWARE_MONITOR_LDN;
   100               break;
   101           } break;
   102         case 0x06:
   103           switch (revision) {
   104             case 0x01:
   105               chip = Chip.F71862;
   106               logicalDeviceNumber = FINTEK_HARDWARE_MONITOR_LDN;
   107               break;
   108           } break;
   109         case 0x07:
   110           switch (revision) {
   111             case 0x23:
   112               chip = Chip.F71889F;
   113               logicalDeviceNumber = FINTEK_HARDWARE_MONITOR_LDN;
   114               break;
   115           } break;
   116         case 0x08:
   117           switch (revision) {
   118             case 0x14:
   119               chip = Chip.F71869;
   120               logicalDeviceNumber = FINTEK_HARDWARE_MONITOR_LDN;
   121               break;
   122           } break;
   123         case 0x09:
   124           switch (revision) {
   125             case 0x01:
   126               chip = Chip.F71808E;
   127               logicalDeviceNumber = FINTEK_HARDWARE_MONITOR_LDN;
   128               break;
   129             case 0x09:
   130               chip = Chip.F71889ED;
   131               logicalDeviceNumber = FINTEK_HARDWARE_MONITOR_LDN;
   132               break;
   133           } break;
   134         case 0x10:
   135           switch (revision) {
   136             case 0x05:
   137               chip = Chip.F71889AD;
   138               logicalDeviceNumber = FINTEK_HARDWARE_MONITOR_LDN;
   139               break;
   140             case 0x07:
   141               chip = Chip.F71869A;
   142               logicalDeviceNumber = FINTEK_HARDWARE_MONITOR_LDN;
   143               break;
   144           } break;
   145         case 0x52:
   146           switch (revision) {
   147             case 0x17:
   148             case 0x3A:
   149             case 0x41:
   150               chip = Chip.W83627HF;
   151               logicalDeviceNumber = WINBOND_NUVOTON_HARDWARE_MONITOR_LDN;
   152               break;
   153           } break;
   154         case 0x82:
   155           switch (revision & 0xF0) {
   156             case 0x80:
   157               chip = Chip.W83627THF;
   158               logicalDeviceNumber = WINBOND_NUVOTON_HARDWARE_MONITOR_LDN;
   159               break;
   160           } break;
   161         case 0x85:
   162           switch (revision) {
   163             case 0x41:
   164               chip = Chip.W83687THF;
   165               logicalDeviceNumber = WINBOND_NUVOTON_HARDWARE_MONITOR_LDN;
   166               break;
   167           } break;
   168         case 0x88:
   169           switch (revision & 0xF0) {
   170             case 0x50:
   171             case 0x60:
   172               chip = Chip.W83627EHF;
   173               logicalDeviceNumber = WINBOND_NUVOTON_HARDWARE_MONITOR_LDN;
   174               break;
   175           } break;
   176         case 0xA0:
   177           switch (revision & 0xF0) {
   178             case 0x20:
   179               chip = Chip.W83627DHG;
   180               logicalDeviceNumber = WINBOND_NUVOTON_HARDWARE_MONITOR_LDN;
   181               break;
   182           } break;
   183         case 0xA5:
   184           switch (revision & 0xF0) {
   185             case 0x10:
   186               chip = Chip.W83667HG;
   187               logicalDeviceNumber = WINBOND_NUVOTON_HARDWARE_MONITOR_LDN;
   188               break;
   189           } break;
   190         case 0xB0:
   191           switch (revision & 0xF0) {
   192             case 0x70:
   193               chip = Chip.W83627DHGP;
   194               logicalDeviceNumber = WINBOND_NUVOTON_HARDWARE_MONITOR_LDN;
   195               break;
   196           } break;
   197         case 0xB3:
   198           switch (revision & 0xF0) {
   199             case 0x50:
   200               chip = Chip.W83667HGB;
   201               logicalDeviceNumber = WINBOND_NUVOTON_HARDWARE_MONITOR_LDN;
   202               break;
   203           } break;
   204         case 0xB4:
   205           switch (revision & 0xF0) {
   206             case 0x70:
   207               chip = Chip.NCT6771F;
   208               logicalDeviceNumber = WINBOND_NUVOTON_HARDWARE_MONITOR_LDN;
   209               break;
   210           } break;
   211         case 0xC3:
   212           switch (revision & 0xF0) {
   213             case 0x30:
   214               chip = Chip.NCT6776F;
   215               logicalDeviceNumber = WINBOND_NUVOTON_HARDWARE_MONITOR_LDN;
   216               break;
   217           } break;
   218         case 0xC5:
   219           switch (revision & 0xF0) {
   220             case 0x60:
   221               chip = Chip.NCT6779D;
   222               logicalDeviceNumber = WINBOND_NUVOTON_HARDWARE_MONITOR_LDN;
   223               break;
   224           } break;
   225       }
   226       if (chip == Chip.Unknown) {
   227         if (id != 0 && id != 0xff) {
   228           WinbondNuvotonFintekExit();
   229 
   230           ReportUnknownChip("Winbond / Nuvoton / Fintek", 
   231             ((id << 8) | revision));
   232         }
   233       } else {
   234 
   235         Select(logicalDeviceNumber);
   236         ushort address = ReadWord(BASE_ADDRESS_REGISTER);
   237         Thread.Sleep(1);
   238         ushort verify = ReadWord(BASE_ADDRESS_REGISTER);
   239 
   240         ushort vendorID = ReadWord(FINTEK_VENDOR_ID_REGISTER);
   241 
   242         WinbondNuvotonFintekExit();
   243 
   244         if (address != verify) {
   245           report.Append("Chip ID: 0x");
   246           report.AppendLine(chip.ToString("X"));
   247           report.Append("Chip revision: 0x");
   248           report.AppendLine(revision.ToString("X",
   249             CultureInfo.InvariantCulture));
   250           report.AppendLine("Error: Address verification failed");
   251           report.AppendLine();
   252           return false;
   253         }
   254 
   255         // some Fintek chips have address register offset 0x05 added already
   256         if ((address & 0x07) == 0x05)
   257           address &= 0xFFF8;
   258 
   259         if (address < 0x100 || (address & 0xF007) != 0) {
   260           report.Append("Chip ID: 0x");
   261           report.AppendLine(chip.ToString("X"));
   262           report.Append("Chip revision: 0x");
   263           report.AppendLine(revision.ToString("X",
   264             CultureInfo.InvariantCulture));
   265           report.Append("Error: Invalid address 0x");
   266           report.AppendLine(address.ToString("X",
   267             CultureInfo.InvariantCulture));
   268           report.AppendLine();
   269           return false;
   270         }
   271 
   272         switch (chip) {
   273           case Chip.W83627DHG:
   274           case Chip.W83627DHGP:
   275           case Chip.W83627EHF:
   276           case Chip.W83627HF:
   277           case Chip.W83627THF:
   278           case Chip.W83667HG:
   279           case Chip.W83667HGB:
   280           case Chip.W83687THF:
   281             superIOs.Add(new W836XX(chip, revision, address));
   282             break;
   283           case Chip.NCT6771F:
   284           case Chip.NCT6776F:
   285           case Chip.NCT6779D:
   286             superIOs.Add(new NCT677X(chip, revision, address));
   287             break;
   288           case Chip.F71858:
   289           case Chip.F71862:
   290           case Chip.F71869:
   291           case Chip.F71869A:
   292           case Chip.F71882:
   293           case Chip.F71889AD:
   294           case Chip.F71889ED:
   295           case Chip.F71889F:
   296           case Chip.F71808E:
   297             if (vendorID != FINTEK_VENDOR_ID) {
   298               report.Append("Chip ID: 0x");
   299               report.AppendLine(chip.ToString("X"));
   300               report.Append("Chip revision: 0x");
   301               report.AppendLine(revision.ToString("X",
   302                 CultureInfo.InvariantCulture));
   303               report.Append("Error: Invalid vendor ID 0x");
   304               report.AppendLine(vendorID.ToString("X",
   305                 CultureInfo.InvariantCulture));
   306               report.AppendLine();
   307               return false;
   308             }
   309             superIOs.Add(new F718XX(chip, address));
   310             break;
   311           default: break;
   312         }
   313 
   314         return true;
   315       }
   316 
   317       return false;
   318     }
   319 
   320     #endregion
   321 
   322     #region ITE
   323 
   324     private const byte IT87_ENVIRONMENT_CONTROLLER_LDN = 0x04;
   325     private const byte IT8705_GPIO_LDN = 0x05;
   326     private const byte IT87XX_GPIO_LDN = 0x07;
   327     private const byte IT87_CHIP_VERSION_REGISTER = 0x22;
   328 
   329     private void IT87Enter() {
   330       Ring0.WriteIoPort(registerPort, 0x87);
   331       Ring0.WriteIoPort(registerPort, 0x01);
   332       Ring0.WriteIoPort(registerPort, 0x55);
   333       Ring0.WriteIoPort(registerPort, 0x55);
   334     }
   335 
   336     private void IT87Exit() {
   337       Ring0.WriteIoPort(registerPort, CONFIGURATION_CONTROL_REGISTER);
   338       Ring0.WriteIoPort(valuePort, 0x02);
   339     }
   340 
   341     private bool DetectIT87() {
   342 
   343       // IT87XX can enter only on port 0x2E
   344       if (registerPort != 0x2E)
   345         return false;
   346 
   347       IT87Enter();
   348 
   349       ushort chipID = ReadWord(CHIP_ID_REGISTER);
   350       Chip chip;
   351       switch (chipID) {
   352         case 0x8705: chip = Chip.IT8705F; break;
   353         case 0x8712: chip = Chip.IT8712F; break;
   354         case 0x8716: chip = Chip.IT8716F; break;
   355         case 0x8718: chip = Chip.IT8718F; break;
   356         case 0x8720: chip = Chip.IT8720F; break;
   357         case 0x8721: chip = Chip.IT8721F; break;
   358         case 0x8726: chip = Chip.IT8726F; break;
   359         case 0x8728: chip = Chip.IT8728F; break;
   360         case 0x8771: chip = Chip.IT8771E; break;
   361         case 0x8772: chip = Chip.IT8772E; break;
   362         default: chip = Chip.Unknown; break;
   363       }
   364       if (chip == Chip.Unknown) {
   365         if (chipID != 0 && chipID != 0xffff) {
   366           IT87Exit();
   367 
   368           ReportUnknownChip("ITE", chipID);
   369         }
   370       } else {
   371         Select(IT87_ENVIRONMENT_CONTROLLER_LDN);
   372         ushort address = ReadWord(BASE_ADDRESS_REGISTER);
   373         Thread.Sleep(1);
   374         ushort verify = ReadWord(BASE_ADDRESS_REGISTER);
   375 
   376         byte version = (byte)(ReadByte(IT87_CHIP_VERSION_REGISTER) & 0x0F);
   377 
   378         ushort gpioAddress;
   379         ushort gpioVerify;
   380         if (chip == Chip.IT8705F) {
   381           Select(IT8705_GPIO_LDN);
   382           gpioAddress = ReadWord(BASE_ADDRESS_REGISTER);
   383           Thread.Sleep(1);
   384           gpioVerify = ReadWord(BASE_ADDRESS_REGISTER);
   385         } else {
   386           Select(IT87XX_GPIO_LDN);
   387           gpioAddress = ReadWord(BASE_ADDRESS_REGISTER + 2);
   388           Thread.Sleep(1);
   389           gpioVerify = ReadWord(BASE_ADDRESS_REGISTER + 2);
   390         }
   391         
   392         IT87Exit();
   393 
   394         if (address != verify || address < 0x100 || (address & 0xF007) != 0) {
   395           report.Append("Chip ID: 0x");
   396           report.AppendLine(chip.ToString("X"));
   397           report.Append("Error: Invalid address 0x");
   398           report.AppendLine(address.ToString("X",
   399             CultureInfo.InvariantCulture));
   400           report.AppendLine();
   401           return false;
   402         }
   403 
   404         if (gpioAddress != gpioVerify || gpioAddress < 0x100 ||
   405           (gpioAddress & 0xF007) != 0) {
   406           report.Append("Chip ID: 0x");
   407           report.AppendLine(chip.ToString("X"));
   408           report.Append("Error: Invalid GPIO address 0x");
   409           report.AppendLine(gpioAddress.ToString("X",
   410             CultureInfo.InvariantCulture));
   411           report.AppendLine();
   412           return false;
   413         }
   414 
   415         superIOs.Add(new IT87XX(chip, address, gpioAddress, version));
   416         return true;
   417       }
   418 
   419       return false;
   420     }
   421 
   422     #endregion
   423 
   424     #region SMSC
   425 
   426     private void SMSCEnter() {
   427       Ring0.WriteIoPort(registerPort, 0x55);
   428     }
   429 
   430     private void SMSCExit() {
   431       Ring0.WriteIoPort(registerPort, 0xAA);
   432     }
   433 
   434     private bool DetectSMSC() {
   435       SMSCEnter();
   436 
   437       ushort chipID = ReadWord(CHIP_ID_REGISTER);
   438       Chip chip;
   439       switch (chipID) {
   440         default: chip = Chip.Unknown; break;
   441       }
   442       if (chip == Chip.Unknown) {
   443         if (chipID != 0 && chipID != 0xffff) {
   444           SMSCExit();
   445 
   446           ReportUnknownChip("SMSC", chipID);
   447         }
   448       } else {
   449         SMSCExit();
   450         return true;
   451       }
   452 
   453       return false;
   454     }
   455 
   456     #endregion
   457 
   458     private void Detect() {
   459 
   460       for (int i = 0; i < REGISTER_PORTS.Length; i++) {
   461         registerPort = REGISTER_PORTS[i];
   462         valuePort = VALUE_PORTS[i];
   463 
   464         if (DetectWinbondFintek()) continue;
   465 
   466         if (DetectIT87()) continue;
   467 
   468         if (DetectSMSC()) continue;
   469       }
   470     }
   471 
   472     public LPCIO() {
   473       if (!Ring0.IsOpen)
   474         return;
   475 
   476       if (!Ring0.WaitIsaBusMutex(100))
   477         return;
   478 
   479       Detect();
   480 
   481       Ring0.ReleaseIsaBusMutex();
   482     }
   483 
   484     public ISuperIO[] SuperIO {
   485       get {
   486         return superIOs.ToArray();
   487       }
   488     }
   489 
   490     public string GetReport() {
   491       if (report.Length > 0) {
   492         return "LPCIO" + Environment.NewLine + Environment.NewLine + report;
   493       } else
   494         return null;
   495     }
   496   }
   497 }