projects / mirror_edk2.git / blame
| Commit | Line | Data |
|---|---|---|
| 4f2494cf GP |
1 | /** @file\r |
| 2 | \r | |
| 3 | Copyright (c) 2017-2018, Arm Limited. All rights reserved.\r | |
| 4 | \r | |
| 4059386c | 5 | SPDX-License-Identifier: BSD-2-Clause-Patent\r |
| 4f2494cf GP |
6 | \r |
| 7 | System Control and Management Interface V1.0\r | |
| 8 | http://infocenter.arm.com/help/topic/com.arm.doc.den0056a/\r | |
| 9 | DEN0056A_System_Control_and_Management_Interface.pdf\r | |
| 10 | **/\r | |
| 11 | \r | |
| 12 | #ifndef ARM_SCMI_CLOCK_PROTOCOL_PRIVATE_H_\r | |
| 13 | #define ARM_SCMI_CLOCK_PROTOCOL_PRIVATE_H_\r | |
| 14 | \r | |
| 15 | #pragma pack(1)\r | |
| 16 | \r | |
| 17 | // Clock rate in two 32bit words.\r | |
| 18 | typedef struct {\r | |
| 19 | UINT32 Low;\r | |
| 20 | UINT32 High;\r | |
| 21 | } CLOCK_RATE_DWORD;\r | |
| 22 | \r | |
| 23 | // Format of the returned rate array. Linear or Non-linear,.RatesFlag Bit[12]\r | |
| 24 | #define RATE_FORMAT_SHIFT 12\r | |
| 25 | #define RATE_FORMAT_MASK 0x0001\r | |
| 26 | #define RATE_FORMAT(RatesFlags) ((RatesFlags >> RATE_FORMAT_SHIFT) \\r | |
| 27 | & RATE_FORMAT_MASK)\r | |
| 28 | \r | |
| 29 | // Number of remaining rates after a call to the SCP, RatesFlag Bits[31:16]\r | |
| 30 | #define NUM_REMAIN_RATES_SHIFT 16\r | |
| 31 | #define NUM_REMAIN_RATES(RatesFlags) ((RatesFlags >> NUM_REMAIN_RATES_SHIFT))\r | |
| 32 | \r | |
| 33 | // Number of rates that are returned by a call.to the SCP, RatesFlag Bits[11:0]\r | |
| 34 | #define NUM_RATES_MASK 0x0FFF\r | |
| 35 | #define NUM_RATES(RatesFlags) (RatesFlags & NUM_RATES_MASK)\r | |
| 36 | \r | |
| 37 | // Return values for the CLOCK_DESCRIBER_RATE command.\r | |
| 38 | typedef struct {\r | |
| 39 | UINT32 NumRatesFlags;\r | |
| 40 | \r | |
| 41 | // NOTE: Since EDK2 does not allow flexible array member [] we declare\r | |
| 42 | // here array of 1 element length. However below is used as a variable\r | |
| 43 | // length array.\r | |
| 44 | CLOCK_RATE_DWORD Rates[1];\r | |
| 45 | } CLOCK_DESCRIBE_RATES;\r | |
| 46 | \r | |
| 47 | #define CLOCK_SET_DEFAULT_FLAGS 0\r | |
| 48 | \r | |
| 49 | // Message parameters for CLOCK_RATE_SET command.\r | |
| 50 | typedef struct {\r | |
| 51 | UINT32 Flags;\r | |
| 52 | UINT32 ClockId;\r | |
| 53 | CLOCK_RATE_DWORD Rate;\r | |
| 54 | } CLOCK_RATE_SET_ATTRIBUTES;\r | |
| 55 | \r | |
| 559a07d8 JB |
56 | \r |
| 57 | // Message parameters for CLOCK_CONFIG_SET command.\r | |
| 58 | typedef struct {\r | |
| 59 | UINT32 ClockId;\r | |
| 60 | UINT32 Attributes;\r | |
| 61 | } CLOCK_CONFIG_SET_ATTRIBUTES;\r | |
| 62 | \r | |
| 4f2494cf GP |
63 | // if ClockAttr Bit[0] is set then clock device is enabled.\r |
| 64 | #define CLOCK_ENABLE_MASK 0x1\r | |
| 65 | #define CLOCK_ENABLED(ClockAttr) ((ClockAttr & CLOCK_ENABLE_MASK) == 1)\r | |
| 66 | \r | |
| 67 | typedef struct {\r | |
| 68 | UINT32 Attributes;\r | |
| 69 | UINT8 ClockName[SCMI_MAX_STR_LEN];\r | |
| 70 | } CLOCK_ATTRIBUTES;\r | |
| 71 | \r | |
| 72 | #pragma pack()\r | |
| 73 | \r | |
| 74 | /** Initialize clock management protocol and install protocol on a given handle.\r | |
| 75 | \r | |
| 76 | @param[in] Handle Handle to install clock management protocol.\r | |
| 77 | \r | |
| 78 | @retval EFI_SUCCESS Clock protocol interface installed successfully.\r | |
| 79 | **/\r | |
| 80 | EFI_STATUS\r | |
| 81 | ScmiClockProtocolInit (\r | |
| 82 | IN EFI_HANDLE *Handle\r | |
| 83 | );\r | |
| 84 | \r | |
| 85 | #endif /* ARM_SCMI_CLOCK_PROTOCOL_PRIVATE_H_ */\r |