mirror of
https://github.com/ARM-software/arm-trusted-firmware.git
synced 2025-04-19 02:54:24 +00:00

For TF-A, there is no format specified for functional documentation. For AMD-Xilinx platforms, following kernel-doc format for the functional documentation to make sure AMD-xilinx documentation is align with actual code. For example use kernel-doc from linux to call: <linux>/scripts/kernel-doc -man -v 1 >/dev/null file... Signed-off-by: Prasad Kummari <prasad.kummari@amd.com> Change-Id: Idcc9def408b6c8da35b36f67ef82fc00890e998c
65 lines
1.7 KiB
C
65 lines
1.7 KiB
C
/*
|
|
* Copyright (c) 2013-2018, Arm Limited and Contributors. All rights reserved.
|
|
* Copyright (c) 2022-2023, Advanced Micro Devices, Inc. All rights reserved.
|
|
*
|
|
* SPDX-License-Identifier: BSD-3-Clause
|
|
*/
|
|
|
|
/*
|
|
* Contains definitions of commonly used macros and data types needed
|
|
* for PU Power Management. This file should be common for all PU's.
|
|
*/
|
|
|
|
#ifndef PM_COMMON_H
|
|
#define PM_COMMON_H
|
|
|
|
#include <stdint.h>
|
|
#include <plat_pm_common.h>
|
|
|
|
#if IPI_CRC_CHECK
|
|
#define PAYLOAD_ARG_CNT 8U
|
|
#define IPI_W0_TO_W6_SIZE 28U
|
|
#define PAYLOAD_CRC_POS 7U
|
|
#define CRC_INIT_VALUE 0x4F4EU
|
|
#define CRC_ORDER 16U
|
|
#define CRC_POLYNOM 0x8005U
|
|
#else
|
|
#define PAYLOAD_ARG_CNT 6U
|
|
#endif
|
|
#define PAYLOAD_ARG_SIZE 4U /* size in bytes */
|
|
|
|
#define TZ_VERSION_MAJOR 1
|
|
#define TZ_VERSION_MINOR 0
|
|
#define TZ_VERSION ((TZ_VERSION_MAJOR << 16) | \
|
|
TZ_VERSION_MINOR)
|
|
|
|
/**
|
|
* struct pm_ipi - struct for capturing IPI-channel specific info.
|
|
* @local_ipi_id: Local IPI agent ID.
|
|
* @remote_ipi_id: Remote IPI Agent ID.
|
|
* @buffer_base: base address for payload buffer.
|
|
*
|
|
*/
|
|
struct pm_ipi {
|
|
const uint32_t local_ipi_id;
|
|
const uint32_t remote_ipi_id;
|
|
const uintptr_t buffer_base;
|
|
};
|
|
|
|
/**
|
|
* struct pm_proc - struct for capturing processor related info.
|
|
* @node_id: node-ID of the processor.
|
|
* @pwrdn_mask: cpu-specific mask to be used for power control register.
|
|
* @ipi: pointer to IPI channel structure.
|
|
* (in APU all processors share one IPI channel)
|
|
*
|
|
*/
|
|
struct pm_proc {
|
|
const uint32_t node_id;
|
|
const uint32_t pwrdn_mask;
|
|
const struct pm_ipi *ipi;
|
|
};
|
|
|
|
const struct pm_proc *pm_get_proc(uint32_t cpuid);
|
|
|
|
#endif /* PM_COMMON_H */
|