/*-----------------------------------------------------------------------------


 Intel Silvermont Processor Power Management BIOS Reference Code

 Copyright (c) 2006 - 2014, Intel Corporation

  This program and the accompanying materials are licensed and made available under
  the terms and conditions of the BSD License that accompanies this distribution.
  The full text of the license may be found at
  http://opensource.org/licenses/bsd-license.php.

  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.


 Filename:    CPUPM.ASL

 Revision:    Refer to Readme

 Date:        Refer to Readme
-------------------------------------------------------------------------------

 This Processor Power Management BIOS Source Code is furnished under license
 and may only be used or copied in accordance with the terms of the license.
 The information in this document is furnished for informational use only, is
 subject to change without notice, and should not be construed as a commitment
 by Intel Corporation. Intel Corporation assumes no responsibility or liability
 for any errors or inaccuracies that may appear in this document or any
 software that may be provided in association with this document.

 Except as permitted by such license, no part of this document may be
 reproduced, stored in a retrieval system, or transmitted in any form or by
 any means without the express written consent of Intel Corporation.

 WARNING: You are authorized and licensed to install and use this BIOS code
 ONLY on an IST PC. This utility may damage any system that does not
 meet these requirements.

    An IST PC is a computer which
    (1) Is capable of seamlessly and automatically transitioning among
    multiple performance states (potentially operating at different
    efficiency ratings) based upon power source changes, END user
    preference, processor performance demand, and thermal conditions; and
    (2) Includes an Intel Pentium II processors, Intel Pentium III
    processor, Mobile Intel Pentium III Processor-M, Mobile Intel Pentium 4
    Processor-M, Intel Pentium M Processor, or any other future Intel
    processors that incorporates the capability to transition between
    different performance states by altering some, or any combination of,
    the following processor attributes: core voltage, core frequency, bus
    frequency, number of processor cores available, or any other attribute
    that changes the efficiency (instructions/unit time-power) at which the
    processor operates.
-------------------------------------------------------------------------------

NOTES:
    (1) <TODO> - Except for the SSDT package, the objects in this ASL code
    may be moved to the DSDT. It is kept separate in this reference package
    for ease of distribution only.
------------------------------------------------------------------------------*/

DefinitionBlock (
    "CPUPM.aml",
    "SSDT",
    0x01,
    "PmRef",
    "CpuPm",
    0x3000
    )
{
    External(\_PR.CPU0, DeviceObj)
    External(\_PR.CPU1, DeviceObj)
    External(\_PR.CPU2, DeviceObj)
    External(\_PR.CPU3, DeviceObj)
    External(SMIF)

  Scope(\)
  {

      // Package of pointers to SSDT's
      //
      // First column is SSDT name, used for debug only.
      // (First column must be EXACTLY eight characters.)
      // Second column is physical address.
      // Third column is table length.
      //
      // IF modifying this file, see warnings listed in ppminit.asm.
      //
      Name(SSDT,Package()
      {
          "CPU0IST ", 0x80000000, 0x80000000,
          "APIST   ", 0x80000000, 0x80000000,
          "CPU0CST ", 0x80000000, 0x80000000,
          "APCST   ", 0x80000000, 0x80000000
      })

      //
      // Note:  See PpmBiosInit in PPMINIT.ASM for a definition of
      // the PpmFlags mirrored in CFGD.
      //
      Name(CFGD, 0x80000000)

      Name(\PDC0,0x80000000)    // CPU0 _PDC Flags.
      Name(\PDC1,0x80000000)    // CPU1 _PDC Flags.
      Name(\PDC2,0x80000000)    // CPU2 _PDC Flags.
      Name(\PDC3,0x80000000)    // CPU3 _PDC Flags.
      Name(\SDTL,0x00)          // Loaded SSDT Flags.
  }

  Scope(\_PR.CPU0)
  {
      //
      // Define handles for opregions (used by load.)
      //
      Name(HI0,0)        // Handle to CPU0IST
      Name(HC0,0)        // Handle to CPU0CST

      Method(_PDC,1)
      {
          //
          // Check and extract the _PDC information.
          //
          Store(CPDC(Arg0), Local0)
          //
          // Save the capability information and load tables as needed.
          //
          GCAP(Local0)
          //
          // Return status.
          //
          //Return (Local0)
      }

      Method(_OSC, 4)
      {
          //
          // Check and extract the _OSC information.
          //
          Store(COSC(Arg0, Arg1, Arg2, Arg3), Local0)
          //
          // Save the capability information and load tables as needed.
          //
          GCAP(Local0)
          //
          // Return status.
          //
          Return (Local0)
      }

      //
      // Implement a generic Method to check _PDC information which may be called
      // by any of the processor scopes.  (The use of _PDC is deprecated in ACPI 3.
      // in favor of _OSC. However, for backwards compatibility, _PDC may be
      // implemented using _OSC as follows:)
      //
      Method(CPDC,1)
      {
          CreateDwordField (Arg0, 0, REVS)
          CreateDwordField (Arg0, 4, SIZE)

          //
          // Local0 = Number of bytes for Arg0
          //
          Store (SizeOf (Arg0), Local0)

          //
          // Local1 = Number of Capabilities bytes in Arg0
          //
          Store (Subtract (Local0, 8), Local1)

          //
          // TEMP = Temporary field holding Capability DWORDs
          //
          CreateField (Arg0, 64, Multiply (Local1, 8), TEMP)

          //
          // Create the Status (STAT) buffer with the first DWORD = 0
          // This is required as per ACPI 3.0 Spec which says the
          // first DWORD is used to return errors defined by _OSC.
          //
          Name (STS0, Buffer () {0x00, 0x00, 0x00, 0x00})

          //
          // Concatenate the _PDC capabilities bytes to the STS0 Buffer
          // and store them in a local variable for calling OSC
          //
          Concatenate (STS0, TEMP, Local2)

          Return(COSC (ToUUID("4077A616-290C-47BE-9EBD-D87058713953"), REVS, SIZE, Local2))
      }

      //
      // Implement a generic Method to check _OSC information which may be called
      // by any of the processor scopes.
      //
      Method(COSC, 4)
      {
          //
          // Point to Status DWORD in the Arg3 buffer (STATUS)
          //
          CreateDWordField(Arg3, 0, STS0)
          //
          // Point to Caps DWORDs of the Arg3 buffer (CAPABILITIES)
          //
          CreateDwordField(Arg3, 4, CAP0)

          //
          // _OSC needs to validate the UUID and Revision.
          //
          // IF Unrecognized UUID
          //    Return Unrecognized UUID _OSC Failure
          // IF Unsupported Revision
          //    Return Unsupported Revision _OSC Failure
          //
          //    STS0[0] = Reserved
          //    STS0[1] = _OSC Failure
          //    STS0[2] = Unrecognized UUID
          //    STS0[3] = Unsupported Revision
          //    STS0[4] = Capabilities masked
          //
          // Note:  The comparison method used is necessary due to
          // limitations of certain OSes which cannot perform direct
          // buffer comparisons.
          //
          // Create a set of "Input" UUID fields.
          //
          CreateDwordField(Arg0, 0x0, IID0)
          CreateDwordField(Arg0, 0x4, IID1)
          CreateDwordField(Arg0, 0x8, IID2)
          CreateDwordField(Arg0, 0xC, IID3)
          //
          // Create a set of "Expected" UUID fields.
          //
          Name(UID0, ToUUID("4077A616-290C-47BE-9EBD-D87058713953"))
          CreateDwordField(UID0, 0x0, EID0)
          CreateDwordField(UID0, 0x4, EID1)
          CreateDwordField(UID0, 0x8, EID2)
          CreateDwordField(UID0, 0xC, EID3)
          //
          // Verify the input UUID matches the expected UUID.
          //
          If(LNot(LAnd(LAnd(LEqual(IID0, EID0),LEqual(IID1, EID1)),LAnd(LEqual(IID2, EID2),LEqual(IID3, EID3)))))
          {
              //
              // Return Unrecognized UUID _OSC Failure
              //
              Store (0x6, STS0)
              Return (Arg3)
          }

          If(LNot(LEqual(Arg1,1)))
          {
              //
              // Return Unsupported Revision _OSC Failure
              //
              Store (0xA, STS0)
              Return (Arg3)
          }

          Return (Arg3)
      }

      //
      // Get the capability information and load appropriate tables as needed.
      //
      Method(GCAP, 1)
      {

          // Point to Status DWORD in the Arg0 buffer (STATUS)
          CreateDWordField(Arg0, 0, STS0)

          // Point to Caps DWORDs of the Arg0 buffer (CAPABILITIES)
          CreateDwordField(Arg0, 4, CAP0)

          //
          // If the UUID was unrecognized or the _OSC revision was unsupported,
          // return without updating capabilities.
          //
          If(LOr(LEqual(STS0,0x6),LEqual(STS0,0xA)))
          {
              Return()
          }

          //
          // Check if this is a query (BIT0 of Status = 1).
          // If so, mask off the bits we support and return.
          //
          if (And(STS0, 1))
          {
              And(CAP0, 0xBFF, CAP0)
              Return()
          }

          //
          // Store result of PDC. (We clear out the MSB, which was just
          // used as a placeholder for the compiler; and then "OR" the
          // value in case we get multiple calls, each of which only
          // reports partial support.)
          //
          Or(And(PDC0, 0x7FFFFFFF), CAP0, PDC0)

          //
          // Check IF the IST SSDTs should be loaded.
          //
          //   CFGD[0] = GV3 Capable/Enabled
          //
          If(And(CFGD,0x01))
          {
              //
              // Load the IST SSDTs if:
              //   (1) CMP capable and enabled.
              //   (2) Driver supports P-States in MP configurations
              //   (3) Driver supports direct HW P-State control
              //   (4) SSDT is not already loaded
              //
              //   CFGD[24] = Two or more cores enabled
              //   PDCx[3]  = OS supports C1 and P-states in MP systems
              //   PDCx[0]  = OS supports direct access of the perf MSR
              //   SDTL[0]  = CPU0 IST SSDT Loaded
              //
              If(LAnd(LAnd(And(CFGD,0x01000000),LEqual(And(PDC0, 0x0009), 0x0009)),LNot(And(SDTL,0x01))))
              {
                  //
                  // Flag the IST SSDT as loaded for CPU0
                  //
                  Or(SDTL, 0x01, SDTL)

                  OperationRegion(IST0,SystemMemory,DeRefOf(Index(SSDT,1)),DeRefOf(Index(SSDT,2)))
                  Load(IST0, HI0)    // Dynamically load the CPU0IST SSDT
              }
          }

          //
          // Check IF the CST SSDTs should be loaded.
          //
          //   CFGD[11,7,2,1] = C6, C4, C1E, C1 Capable/Enabled
          //
          If(And(CFGD,0x82))
          {
              //
              // Load the CST SSDTs if:
              //   (1) CMP capable/enabled
              //   (2) Driver supports multi-processor configurations
              //   (3) CPU0 CST ISDT is not already loaded
              //
              //   CFGD[24] = Two or more cores enabled
              //   PDCx[3]  = OS supports C1 and P-states in MP systems
              //   PDCx[4]  = OS supports ind. C2/C3 in MP systems
              //   SDTL[1]  = CPU0 CST SSDT Loaded
              //
              If(LAnd(LAnd(And(CFGD,0x01000000),And(PDC0,0x0018)),LNot(And(SDTL,0x02))))
              {
                  //
                  // Flag the CST SSDT as loaded for CPU0
                  //
                  Or(SDTL, 0x02, SDTL)

                  OperationRegion(CST0,SystemMemory,DeRefOf(Index(SSDT,7)),DeRefOf(Index(SSDT,8)))
                  Load(CST0, HC0)    // Dynamically load the CPU0CST SSDT
              }
          }

          Return ()
      }
  }


  Scope(\_PR.CPU1)
  {
      //
      // Define handles for opregions (used by load.)
      //
      Name(HI1,0)        // Handle to APIST
      Name(HC1,0)        // Handle to APCST

      Method(_PDC,1)
      {
          //
          // Refer to \_PR.CPU0._PDC for description.
          //
          Store(\_PR.CPU0.CPDC(Arg0), Local0)
          GCAP(Local0)
          //Return (Local0)
      }

      Method(_OSC, 4)
      {
          //
          // Refer to \_PR.CPU0._OSC for description.
          //
          Store(\_PR.CPU0.COSC(Arg0, Arg1, Arg2, Arg3), Local0)
          GCAP(Local0)
          Return (Local0)
      }

      //
      // Get the capability information and load appropriate tables as needed.
      //
      Method(GCAP, 1)
      {
          //
          // Point to Status DWORD in the Arg0 buffer (STATUS)
          //
          CreateDWordField(Arg0, 0, STS1)
          //
          // Point to Caps DWORDs of the Arg0 buffer (CAPABILITIES)
          //
          CreateDwordField(Arg0, 4, CAP1)
          //
          // If the UUID was unrecognized or the _OSC revision was unsupported,
          // return without updating capabilities.
          //
          If(LOr(LEqual(STS1,0x6),LEqual(STS1,0xA)))
          {
              Return()
          }

          //
          // Check if this is a query (BIT0 of Status = 1).
          // If so, mask off the bits we support and return.
          //
          if (And(STS1, 1))
          {
              And(CAP1, 0xBFF, CAP1)
              Return()
          }

          //
          // Store result of PDC. (We clear out the MSB, which was just
          // used as a placeholder for the compiler; and then "OR" the
          // value in case we get multiple calls, each of which only
          // reports partial support.)
          //
          Or(And(PDC1, 0x7FFFFFFF), CAP1, PDC1)

          //
          // Attempt to dynamically load the IST SSDTs if:
          //   (1) Driver supports P-States in MP configurations
          //   (2) Driver supports direct HW P-State control
          //
          //   PDCx[3]  = OS supports C1 and P-states in MP systems
          //   PDCx[0]  = OS supports direct access of the perf MSR
          //
          If(LEqual(And(PDC0, 0x0009), 0x0009))
          {
              APPT()
          }

          //
          // Load the CST SSDTs if:
          //   (1) Driver supports multi-processor configurations
          //
          //   PDCx[3]  = OS supports C1 and P-states in MP systems
          //   PDCx[4]  = OS supports ind. C2/C3 in MP systems
          //
          If(And(PDC0,0x0018))
          {
              APCT()
          }

          Return()
      }

      //
      // Dynamically load the CST SSDTs if:
      //   (1) C-States are enabled
      //   (2) SSDT is not already loaded
      //
      //   CFGD[11,7,2,1] = C6, C4, C1E, C1 Capable/Enabled
      //   SDTL[5]   = AP CST SSDT Loaded
      //
      Method(APCT,0)
      {
          If(LAnd(And(CFGD,0x82),LNot(And(SDTL,0x20))))
          {
              //
              // Flag the CST SSDT as loaded for the AP's
              //
              Or(SDTL, 0x20, SDTL)
              //
              // Dynamically load the APCST SSDT
              //
              OperationRegion(CST1,SystemMemory,DeRefOf(Index(SSDT,10)),DeRefOf(Index(SSDT,11)))
              Load(CST1, HC1)
          }
      }

      //
      // Dynamically load the IST SSDTs if:
      //   (1) If GV3 capable and enabled
      //   (2) SSDT is not already loaded
      //
      //   CFGD[0] = GV3 Capable/Enabled
      //   SDTL[4] = AP IST SSDT Loaded
      //
      Method(APPT,0)
      {
          If(LAnd(And(CFGD,0x01),LNot(And(SDTL,0x10))))
          {
              //
              // Flag the IST SSDT as loaded for CPU0
              //
              Or(SDTL, 0x10, SDTL)

              OperationRegion(IST1,SystemMemory,DeRefOf(Index(SSDT,4)),DeRefOf(Index(SSDT,5)))
              Load(IST1, HI1)    // Dynamically load the CPU1IST SSDT
          }
      }
  }    // End CPU1

  Scope(\_PR.CPU2)
  {
      //
      // Define handles for opregions (used by load.)
      //
      Name(HI1,0)        // Handle to APIST
      Name(HC1,0)        // Handle to APCST

      Method(_PDC,1)
      {
          //
          // Refer to \_PR.CPU0._PDC for description.
          //
          Store(\_PR.CPU0.CPDC(Arg0), Local0)
          GCAP(Local0)
          //Return (Local0)
      }

      Method(_OSC, 4)
      {
          //
          // Refer to \_PR.CPU0._OSC for description.
          //
          Store(\_PR.CPU0.COSC(Arg0, Arg1, Arg2, Arg3), Local0)
          GCAP(Local0)
          Return (Local0)
      }

      //
      // Get the capability information and load appropriate tables as needed.
      //
      Method(GCAP, 1)
      {
          //
          // Point to Status DWORD in the Arg0 buffer (STATUS)
          //
          CreateDWordField(Arg0, 0, STS1)
          //
          // Point to Caps DWORDs of the Arg0 buffer (CAPABILITIES)
          //
          CreateDwordField(Arg0, 4, CAP1)
          //
          // If the UUID was unrecognized or the _OSC revision was unsupported,
          // return without updating capabilities.
          //
          If(LOr(LEqual(STS1,0x6),LEqual(STS1,0xA)))
          {
              Return()
          }

          //
          // Check if this is a query (BIT0 of Status = 1).
          // If so, mask off the bits we support and return.
          //
          if (And(STS1, 1))
          {
              And(CAP1, 0xBFF, CAP1)
              Return()
          }

          //
          // Store result of PDC. (We clear out the MSB, which was just
          // used as a placeholder for the compiler; and then "OR" the
          // value in case we get multiple calls, each of which only
          // reports partial support.)
          //
          Or(And(PDC1, 0x7FFFFFFF), CAP1, PDC1)

          //
          // Attempt to dynamically load the IST SSDTs if:
          //   (1) Driver supports P-States in MP configurations
          //   (2) Driver supports direct HW P-State control
          //
          //   PDCx[3]  = OS supports C1 and P-states in MP systems
          //   PDCx[0]  = OS supports direct access of the perf MSR
          //
          If(LEqual(And(PDC0, 0x0009), 0x0009))
          {
              APPT()
          }

          //
          // Load the CST SSDTs if:
          //   (1) Driver supports multi-processor configurations
          //
          //   PDCx[3]  = OS supports C1 and P-states in MP systems
          //   PDCx[4]  = OS supports ind. C2/C3 in MP systems
          //
          If(And(PDC0,0x0018))
          {
              APCT()
          }

          Return()
      }

      //
      // Dynamically load the CST SSDTs if:
      //   (1) C-States are enabled
      //   (2) SSDT is not already loaded
      //
      //   CFGD[11,7,2,1] = C6, C4, C1E, C1 Capable/Enabled
      //   SDTL[5]   = AP CST SSDT Loaded
      //
      Method(APCT,0)
      {
          If(LAnd(And(CFGD,0x82),LNot(And(SDTL,0x20))))
          {
              //
              // Flag the CST SSDT as loaded for the AP's
              //
              Or(SDTL, 0x20, SDTL)
              //
              // Dynamically load the APCST SSDT
              //
              OperationRegion(CST1,SystemMemory,DeRefOf(Index(SSDT,10)),DeRefOf(Index(SSDT,11)))
              Load(CST1, HC1)
          }
      }

      //
      // Dynamically load the IST SSDTs if:
      //   (1) If GV3 capable and enabled
      //   (2) SSDT is not already loaded
      //
      //   CFGD[0] = GV3 Capable/Enabled
      //   SDTL[4] = AP IST SSDT Loaded
      //
      Method(APPT,0)
      {
          If(LAnd(And(CFGD,0x01),LNot(And(SDTL,0x10))))
          {
              //
              // Flag the IST SSDT as loaded for CPU0
              //
              Or(SDTL, 0x10, SDTL)

              OperationRegion(IST1,SystemMemory,DeRefOf(Index(SSDT,4)),DeRefOf(Index(SSDT,5)))
              Load(IST1, HI1)    // Dynamically load the CPU1IST SSDT
          }
      }
  }    // End CPU1

  Scope(\_PR.CPU3)
  {
      //
      // Define handles for opregions (used by load.)
      //
      Name(HI1,0)        // Handle to APIST
      Name(HC1,0)        // Handle to APCST

      Method(_PDC,1)
      {
          //
          // Refer to \_PR.CPU0._PDC for description.
          //
          Store(\_PR.CPU0.CPDC(Arg0), Local0)
          GCAP(Local0)
          //Return (Local0)
      }

      Method(_OSC, 4)
      {
          //
          // Refer to \_PR.CPU0._OSC for description.
          //
          Store(\_PR.CPU0.COSC(Arg0, Arg1, Arg2, Arg3), Local0)
          GCAP(Local0)
          Return (Local0)
      }

      //
      // Get the capability information and load appropriate tables as needed.
      //
      Method(GCAP, 1)
      {
          //
          // Point to Status DWORD in the Arg0 buffer (STATUS)
          //
          CreateDWordField(Arg0, 0, STS1)
          //
          // Point to Caps DWORDs of the Arg0 buffer (CAPABILITIES)
          //
          CreateDwordField(Arg0, 4, CAP1)
          //
          // If the UUID was unrecognized or the _OSC revision was unsupported,
          // return without updating capabilities.
          //
          If(LOr(LEqual(STS1,0x6),LEqual(STS1,0xA)))
          {
              Return()
          }

          //
          // Check if this is a query (BIT0 of Status = 1).
          // If so, mask off the bits we support and return.
          //
          if (And(STS1, 1))
          {
              And(CAP1, 0xBFF, CAP1)
              Return()
          }

          //
          // Store result of PDC. (We clear out the MSB, which was just
          // used as a placeholder for the compiler; and then "OR" the
          // value in case we get multiple calls, each of which only
          // reports partial support.)
          //
          Or(And(PDC1, 0x7FFFFFFF), CAP1, PDC1)

          //
          // Attempt to dynamically load the IST SSDTs if:
          //   (1) Driver supports P-States in MP configurations
          //   (2) Driver supports direct HW P-State control
          //
          //   PDCx[3]  = OS supports C1 and P-states in MP systems
          //   PDCx[0]  = OS supports direct access of the perf MSR
          //
          If(LEqual(And(PDC0, 0x0009), 0x0009))
          {
              APPT()
          }

          //
          // Load the CST SSDTs if:
          //   (1) Driver supports multi-processor configurations
          //
          //   PDCx[3]  = OS supports C1 and P-states in MP systems
          //   PDCx[4]  = OS supports ind. C2/C3 in MP systems
          //
          If(And(PDC0,0x0018))
          {
              APCT()
          }

          Return()
      }

      //
      // Dynamically load the CST SSDTs if:
      //   (1) C-States are enabled
      //   (2) SSDT is not already loaded
      //
      //   CFGD[11,7,2,1] = C6, C4, C1E, C1 Capable/Enabled
      //   SDTL[5]   = AP CST SSDT Loaded
      //
      Method(APCT,0)
      {
          If(LAnd(And(CFGD,0x82),LNot(And(SDTL,0x20))))
          {
              //
              // Flag the CST SSDT as loaded for the AP's
              //
              Or(SDTL, 0x20, SDTL)
              //
              // Dynamically load the APCST SSDT
              //
              OperationRegion(CST1,SystemMemory,DeRefOf(Index(SSDT,10)),DeRefOf(Index(SSDT,11)))
              Load(CST1, HC1)
          }
      }

      //
      // Dynamically load the IST SSDTs if:
      //   (1) If GV3 capable and enabled
      //   (2) SSDT is not already loaded
      //
      //   CFGD[0] = GV3 Capable/Enabled
      //   SDTL[4] = AP IST SSDT Loaded
      //
      Method(APPT,0)
      {
          If(LAnd(And(CFGD,0x01),LNot(And(SDTL,0x10))))
          {
              //
              // Flag the IST SSDT as loaded for CPU0
              //
              Or(SDTL, 0x10, SDTL)

              OperationRegion(IST1,SystemMemory,DeRefOf(Index(SSDT,4)),DeRefOf(Index(SSDT,5)))
              Load(IST1, HI1)    // Dynamically load the CPU1IST SSDT
          }
      }
  }    // End CPU3
} // End of Definition Block