ArmScmiClock2Protocol.h

Go to the documentation of this file.

 
#ifndef ARM_SCMI_CLOCK2_PROTOCOL_H_
#define ARM_SCMI_CLOCK2_PROTOCOL_H_
 
#include <Protocol/ArmScmi.h>
#include <Protocol/ArmScmiClockProtocol.h>
 
#define ARM_SCMI_CLOCK2_PROTOCOL_GUID  {\
  0xb8d8caf2, 0x9e94, 0x462c, { 0xa8, 0x34, 0x6c, 0x99, 0xfc, 0x05, 0xef, 0xcf } \
  }
 
extern EFI_GUID  gArmScmiClock2ProtocolGuid;
 
#define SCMI_CLOCK2_PROTOCOL_VERSION  1
 
typedef struct _SCMI_CLOCK2_PROTOCOL SCMI_CLOCK2_PROTOCOL;
 
// Protocol Interface functions.
 
typedef
EFI_STATUS
(EFIAPI *SCMI_CLOCK2_GET_VERSION)(
  IN  SCMI_CLOCK2_PROTOCOL  *This,
  OUT UINT32                *Version
  );
 
typedef
EFI_STATUS
(EFIAPI *SCMI_CLOCK2_GET_TOTAL_CLOCKS)(
  IN  SCMI_CLOCK2_PROTOCOL  *This,
  OUT UINT32                *TotalClocks
  );
 
typedef
EFI_STATUS
(EFIAPI *SCMI_CLOCK2_GET_CLOCK_ATTRIBUTES)(
  IN  SCMI_CLOCK2_PROTOCOL  *This,
  IN  UINT32                ClockId,
  OUT BOOLEAN               *Enabled,
  OUT CHAR8                 *ClockAsciiName
  );
 
typedef
EFI_STATUS
(EFIAPI *SCMI_CLOCK2_DESCRIBE_RATES)(
  IN     SCMI_CLOCK2_PROTOCOL     *This,
  IN     UINT32                   ClockId,
  OUT    SCMI_CLOCK_RATE_FORMAT   *Format,
  OUT    UINT32                   *TotalRates,
  IN OUT UINT32                   *RateArraySize,
  OUT    SCMI_CLOCK_RATE          *RateArray
  );
 
typedef
EFI_STATUS
(EFIAPI *SCMI_CLOCK2_RATE_GET)(
  IN  SCMI_CLOCK2_PROTOCOL  *This,
  IN  UINT32                ClockId,
  OUT UINT64                *Rate
  );
 
typedef
EFI_STATUS
(EFIAPI *SCMI_CLOCK2_RATE_SET)(
  IN SCMI_CLOCK2_PROTOCOL   *This,
  IN UINT32                 ClockId,
  IN UINT64                 Rate
  );
 
typedef
EFI_STATUS
(EFIAPI *SCMI_CLOCK2_ENABLE)(
  IN SCMI_CLOCK2_PROTOCOL   *This,
  IN UINT32                 ClockId,
  IN BOOLEAN                Enable
  );
 
typedef struct _SCMI_CLOCK2_PROTOCOL {
  SCMI_CLOCK2_GET_VERSION             GetVersion;
  SCMI_CLOCK2_GET_TOTAL_CLOCKS        GetTotalClocks;
  SCMI_CLOCK2_GET_CLOCK_ATTRIBUTES    GetClockAttributes;
  SCMI_CLOCK2_DESCRIBE_RATES          DescribeRates;
  SCMI_CLOCK2_RATE_GET                RateGet;
  SCMI_CLOCK2_RATE_SET                RateSet;
 
  // Extension to original ClockProtocol, added here so SCMI_CLOCK2_PROTOCOL
  // can be cast to SCMI_CLOCK_PROTOCOL
  UINTN                               Version; // For future expandability
  SCMI_CLOCK2_ENABLE                  Enable;
} SCMI_CLOCK2_PROTOCOL;
 
#endif /* ARM_SCMI_CLOCK2_PROTOCOL_H_ */