ArmScmiClockProtocolPrivate.h File Reference

Go to the source code of this file.

Data Structures
struct	CLOCK_RATE_DWORD
struct	CLOCK_DESCRIBE_RATES
struct	CLOCK_RATE_SET_ATTRIBUTES
struct	CLOCK_CONFIG_SET_ATTRIBUTES
struct	CLOCK_ATTRIBUTES

Macros
#define	RATE_FORMAT_SHIFT   12
#define	RATE_FORMAT_MASK   0x0001
#define	RATE_FORMAT(RatesFlags)
#define	NUM_REMAIN_RATES_SHIFT   16
#define	NUM_REMAIN_RATES(RatesFlags)   ((RatesFlags >> NUM_REMAIN_RATES_SHIFT))
#define	NUM_RATES_MASK   0x0FFF
#define	NUM_RATES(RatesFlags)   (RatesFlags & NUM_RATES_MASK)
#define	CLOCK_SET_DEFAULT_FLAGS   0
#define	CLOCK_ENABLE_MASK   0x1
#define	CLOCK_ENABLED(ClockAttr)   ((ClockAttr & CLOCK_ENABLE_MASK) == 1)

Functions
EFI_STATUS	ScmiClockProtocolInit (IN EFI_HANDLE *Handle)

Detailed Description

Copyright (c) 2017-2018, Arm Limited. All rights reserved.

SPDX-License-Identifier: BSD-2-Clause-Patent

System Control and Management Interface V1.0 http://infocenter.arm.com/help/topic/com.arm.doc.den0056a/ DEN0056A_System_Control_and_Management_Interface.pdf

Definition in file ArmScmiClockProtocolPrivate.h.

Macro Definition Documentation

CLOCK_ENABLE_MASK

#define CLOCK_ENABLE_MASK   0x1

Definition at line 63 of file ArmScmiClockProtocolPrivate.h.

CLOCK_ENABLED

#define CLOCK_ENABLED

(

ClockAttr

)

((ClockAttr & CLOCK_ENABLE_MASK) == 1)

Definition at line 64 of file ArmScmiClockProtocolPrivate.h.

CLOCK_SET_DEFAULT_FLAGS

#define CLOCK_SET_DEFAULT_FLAGS   0

Definition at line 47 of file ArmScmiClockProtocolPrivate.h.

NUM_RATES

#define NUM_RATES

(

RatesFlags

)

(RatesFlags & NUM_RATES_MASK)

Definition at line 35 of file ArmScmiClockProtocolPrivate.h.

NUM_RATES_MASK

#define NUM_RATES_MASK   0x0FFF

Definition at line 34 of file ArmScmiClockProtocolPrivate.h.

NUM_REMAIN_RATES

#define NUM_REMAIN_RATES

(

RatesFlags

)

((RatesFlags >> NUM_REMAIN_RATES_SHIFT))

Definition at line 31 of file ArmScmiClockProtocolPrivate.h.

NUM_REMAIN_RATES_SHIFT

#define NUM_REMAIN_RATES_SHIFT   16

Definition at line 30 of file ArmScmiClockProtocolPrivate.h.

RATE_FORMAT

#define RATE_FORMAT

(

RatesFlags

)

Value:

                                     ((RatesFlags >> RATE_FORMAT_SHIFT)     \
                                     & RATE_FORMAT_MASK)

Definition at line 26 of file ArmScmiClockProtocolPrivate.h.

RATE_FORMAT_MASK

#define RATE_FORMAT_MASK   0x0001

Definition at line 25 of file ArmScmiClockProtocolPrivate.h.

RATE_FORMAT_SHIFT

#define RATE_FORMAT_SHIFT   12

Definition at line 24 of file ArmScmiClockProtocolPrivate.h.

Function Documentation

ScmiClockProtocolInit()

EFI_STATUS ScmiClockProtocolInit

(

IN EFI_HANDLE *

Handle

)

Initialize clock management protocol and install protocol on a given handle.

Parameters

[in]

Handle

Handle to install clock management protocol.

Return values

EFI_SUCCESS

Clock protocol interface installed successfully.

Definition at line 461 of file ScmiClockProtocol.c.