UefiCpuPkg: Move AsmRelocateApLoopStart from Mpfuncs.nasm to AmdSev.nasm

[mirror_edk2.git] / ArmPkg / Drivers / ArmScmiDxe / ArmScmiClockProtocolPrivate.h

/** @file\r
\r
  Copyright (c) 2017-2018, Arm Limited. All rights reserved.\r
\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
  System Control and Management Interface V1.0\r
    http://infocenter.arm.com/help/topic/com.arm.doc.den0056a/\r
    DEN0056A_System_Control_and_Management_Interface.pdf\r
**/\r
\r
#ifndef ARM_SCMI_CLOCK_PROTOCOL_PRIVATE_H_\r
#define ARM_SCMI_CLOCK_PROTOCOL_PRIVATE_H_\r
\r
#pragma pack(1)\r
\r
// Clock rate in two 32bit words.\r
typedef struct {\r
  UINT32    Low;\r
  UINT32    High;\r
} CLOCK_RATE_DWORD;\r
\r
// Format of the returned rate array. Linear or Non-linear,.RatesFlag Bit[12]\r
#define RATE_FORMAT_SHIFT  12\r
#define RATE_FORMAT_MASK   0x0001\r
#define RATE_FORMAT(RatesFlags)  ((RatesFlags >> RATE_FORMAT_SHIFT)     \\r
                                     & RATE_FORMAT_MASK)\r
\r
// Number of remaining rates after a call to the SCP, RatesFlag Bits[31:16]\r
#define NUM_REMAIN_RATES_SHIFT  16\r
#define NUM_REMAIN_RATES(RatesFlags)  ((RatesFlags >> NUM_REMAIN_RATES_SHIFT))\r
\r
// Number of rates that are returned by a call.to the SCP, RatesFlag Bits[11:0]\r
#define NUM_RATES_MASK  0x0FFF\r
#define NUM_RATES(RatesFlags)  (RatesFlags & NUM_RATES_MASK)\r
\r
// Return values for the CLOCK_DESCRIBER_RATE command.\r
typedef struct {\r
  UINT32              NumRatesFlags;\r
\r
  // NOTE: Since EDK2 does not allow flexible array member [] we declare\r
  // here array of 1 element length. However below is used as a variable\r
  // length array.\r
  CLOCK_RATE_DWORD    Rates[1];\r
} CLOCK_DESCRIBE_RATES;\r
\r
#define CLOCK_SET_DEFAULT_FLAGS  0\r
\r
// Message parameters for CLOCK_RATE_SET command.\r
typedef struct {\r
  UINT32              Flags;\r
  UINT32              ClockId;\r
  CLOCK_RATE_DWORD    Rate;\r
} CLOCK_RATE_SET_ATTRIBUTES;\r
\r
// Message parameters for CLOCK_CONFIG_SET command.\r
typedef struct {\r
  UINT32    ClockId;\r
  UINT32    Attributes;\r
} CLOCK_CONFIG_SET_ATTRIBUTES;\r
\r
//  if ClockAttr Bit[0] is set then clock device is enabled.\r
#define CLOCK_ENABLE_MASK  0x1\r
#define CLOCK_ENABLED(ClockAttr)  ((ClockAttr & CLOCK_ENABLE_MASK) == 1)\r
\r
typedef struct {\r
  UINT32    Attributes;\r
  UINT8     ClockName[SCMI_MAX_STR_LEN];\r
} CLOCK_ATTRIBUTES;\r
\r
#pragma pack()\r
\r
/** Initialize clock management protocol and install protocol on a given handle.\r
\r
  @param[in] Handle              Handle to install clock management protocol.\r
\r
  @retval EFI_SUCCESS            Clock protocol interface installed successfully.\r
**/\r
EFI_STATUS\r
ScmiClockProtocolInit (\r
  IN EFI_HANDLE  *Handle\r
  );\r
\r
#endif /* ARM_SCMI_CLOCK_PROTOCOL_PRIVATE_H_ */\r