mirror of
https://github.com/ARM-software/arm-trusted-firmware.git
synced 2025-04-23 13:36:05 +00:00
40fd755bad
Define new transfer entry TL_TAG_OPTEE_PAGABLE_PART for OP-TEE. Add API for achieving handoff args from transfer entries. Add API for dumping the transfer list. Add tl->flags, tl->reserved and TL_FLAGS_HAS_CHECKSUM to align to the spec update. Update TL signature to 4a0f_b10b to align to the spec update. Minor fixes for the coding and comment style. Change-Id: I0e159672e4ef4c50576f70b82e1b7bae08407acc Signed-off-by: Raymond Mao <raymond.mao@linaro.org>
133 lines
3.7 KiB
C
133 lines
3.7 KiB
C
/*
|
|
* Copyright (c) 2023, Linaro Limited and Contributors. All rights reserved.
|
|
*
|
|
* SPDX-License-Identifier: BSD-3-Clause
|
|
*/
|
|
|
|
#ifndef __TRANSFER_LIST_H
|
|
#define __TRANSFER_LIST_H
|
|
|
|
#include <stdbool.h>
|
|
#include <stdint.h>
|
|
|
|
#include <common/ep_info.h>
|
|
#include <lib/utils_def.h>
|
|
|
|
#define TRANSFER_LIST_SIGNATURE U(0x4a0fb10b)
|
|
#define TRANSFER_LIST_VERSION U(0x0001)
|
|
|
|
/*
|
|
* Init value of maximum alignment required by any TE data in the TL
|
|
* specified as a power of two
|
|
*/
|
|
#define TRANSFER_LIST_INIT_MAX_ALIGN U(3)
|
|
|
|
/* Alignment required by TE header start address, in bytes */
|
|
#define TRANSFER_LIST_GRANULE U(8)
|
|
|
|
/*
|
|
* Version of the register convention used.
|
|
* Set to 1 for both AArch64 and AArch32 according to fw handoff spec v0.9
|
|
*/
|
|
#define REGISTER_CONVENTION_VERSION_MASK (1 << 24)
|
|
|
|
#ifndef __ASSEMBLER__
|
|
|
|
#define TL_FLAGS_HAS_CHECKSUM BIT(0)
|
|
|
|
enum transfer_list_tag_id {
|
|
TL_TAG_EMPTY = 0,
|
|
TL_TAG_FDT = 1,
|
|
TL_TAG_HOB_BLOCK = 2,
|
|
TL_TAG_HOB_LIST = 3,
|
|
TL_TAG_ACPI_TABLE_AGGREGATE = 4,
|
|
TL_TAG_OPTEE_PAGABLE_PART = 0x100,
|
|
};
|
|
|
|
enum transfer_list_ops {
|
|
TL_OPS_NON, /* invalid for any operation */
|
|
TL_OPS_ALL, /* valid for all operations */
|
|
TL_OPS_RO, /* valid for read only */
|
|
TL_OPS_CUS, /* abort or switch to special code to interpret */
|
|
};
|
|
|
|
struct transfer_list_header {
|
|
uint32_t signature;
|
|
uint8_t checksum;
|
|
uint8_t version;
|
|
uint8_t hdr_size;
|
|
uint8_t alignment; /* max alignment of TE data */
|
|
uint32_t size; /* TL header + all TEs */
|
|
uint32_t max_size;
|
|
uint32_t flags;
|
|
uint32_t reserved; /* spare bytes */
|
|
/*
|
|
* Commented out element used to visualize dynamic part of the
|
|
* data structure.
|
|
*
|
|
* Note that struct transfer_list_entry also is dynamic in size
|
|
* so the elements can't be indexed directly but instead must be
|
|
* traversed in order
|
|
*
|
|
* struct transfer_list_entry entries[];
|
|
*/
|
|
};
|
|
|
|
struct transfer_list_entry {
|
|
uint16_t tag_id;
|
|
uint8_t reserved0; /* place holder */
|
|
uint8_t hdr_size;
|
|
uint32_t data_size;
|
|
/*
|
|
* Commented out element used to visualize dynamic part of the
|
|
* data structure.
|
|
*
|
|
* Note that padding is added at the end of @data to make to reach
|
|
* a 8-byte boundary.
|
|
*
|
|
* uint8_t data[ROUNDUP(data_size, 8)];
|
|
*/
|
|
};
|
|
|
|
void transfer_list_dump(struct transfer_list_header *tl);
|
|
entry_point_info_t *
|
|
transfer_list_set_handoff_args(struct transfer_list_header *tl,
|
|
entry_point_info_t *ep_info);
|
|
struct transfer_list_header *transfer_list_init(void *addr, size_t max_size);
|
|
|
|
struct transfer_list_header *
|
|
transfer_list_relocate(struct transfer_list_header *tl, void *addr,
|
|
size_t max_size);
|
|
enum transfer_list_ops
|
|
transfer_list_check_header(const struct transfer_list_header *tl);
|
|
|
|
void transfer_list_update_checksum(struct transfer_list_header *tl);
|
|
bool transfer_list_verify_checksum(const struct transfer_list_header *tl);
|
|
|
|
bool transfer_list_set_data_size(struct transfer_list_header *tl,
|
|
struct transfer_list_entry *entry,
|
|
uint32_t new_data_size);
|
|
|
|
void *transfer_list_entry_data(struct transfer_list_entry *entry);
|
|
bool transfer_list_rem(struct transfer_list_header *tl,
|
|
struct transfer_list_entry *entry);
|
|
|
|
struct transfer_list_entry *transfer_list_add(struct transfer_list_header *tl,
|
|
uint16_t tag_id,
|
|
uint32_t data_size,
|
|
const void *data);
|
|
|
|
struct transfer_list_entry *
|
|
transfer_list_add_with_align(struct transfer_list_header *tl, uint16_t tag_id,
|
|
uint32_t data_size, const void *data,
|
|
uint8_t alignment);
|
|
|
|
struct transfer_list_entry *
|
|
transfer_list_next(struct transfer_list_header *tl,
|
|
struct transfer_list_entry *last);
|
|
|
|
struct transfer_list_entry *transfer_list_find(struct transfer_list_header *tl,
|
|
uint16_t tag_id);
|
|
|
|
#endif /*__ASSEMBLER__*/
|
|
#endif /*__TRANSFER_LIST_H*/
|