1/*
2 * Copyright 2020 Advanced Micro Devices, Inc.
3 *
4 * Permission is hereby granted, free of charge, to any person obtaining a
5 * copy of this software and associated documentation files (the "Software"),
6 * to deal in the Software without restriction, including without limitation
7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8 * and/or sell copies of the Software, and to permit persons to whom the
9 * Software is furnished to do so, subject to the following conditions:
10 *
11 * The above copyright notice and this permission notice shall be included in
12 * all copies or substantial portions of the Software.
13 *
14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
17 * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
18 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
19 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
20 * OTHER DEALINGS IN THE SOFTWARE.
21 *
22 */
23
24#ifndef _TA_RAP_IF_H
25#define _TA_RAP_IF_H
26
27/* Responses have bit 31 set */
28#define RSP_ID_MASK (1U << 31)
29#define RSP_ID(cmdId) (((uint32_t)(cmdId)) | RSP_ID_MASK)
30
31enum ta_rap_status {
32	TA_RAP_STATUS__SUCCESS                              = 1,
33	TA_RAP_STATUS__ERROR_GENERIC_FAILURE                = 2,
34	TA_RAP_STATUS__ERROR_CMD_NOT_SUPPORTED              = 3,
35	TA_RAP_STATUS__ERROR_INVALID_VALIDATION_METHOD      = 4,
36	TA_RAP_STATUS__ERROR_NULL_POINTER                   = 5,
37	TA_RAP_STATUS__ERROR_NOT_INITIALIZED                = 6,
38	TA_RAP_STATUS__ERROR_VALIDATION_FAILED              = 7,
39	TA_RAP_STATUS__ERROR_ASIC_NOT_SUPPORTED             = 8,
40	TA_RAP_STATUS__ERROR_OPERATION_NOT_PERMISSABLE      = 9,
41	TA_RAP_STATUS__ERROR_ALREADY_INIT                   = 10,
42};
43
44enum ta_rap_cmd {
45	TA_CMD_RAP__INITIALIZE              = 1,
46	TA_CMD_RAP__VALIDATE_L0             = 2,
47};
48
49enum ta_rap_validation_method {
50	METHOD_A           = 1,
51};
52
53struct ta_rap_cmd_input_data {
54	uint8_t reserved[8];
55};
56
57struct ta_rap_cmd_output_data {
58	uint32_t    last_subsection;
59	uint32_t    num_total_validate;
60	uint32_t    num_valid;
61	uint32_t    last_validate_addr;
62	uint32_t    last_validate_val;
63	uint32_t    last_validate_val_exptd;
64};
65
66union ta_rap_cmd_input {
67	struct ta_rap_cmd_input_data input;
68};
69
70union ta_rap_cmd_output {
71	struct ta_rap_cmd_output_data output;
72};
73
74struct ta_rap_shared_memory {
75	uint32_t                    cmd_id;
76	uint32_t                    validation_method_id;
77	uint32_t                    resp_id;
78	enum ta_rap_status          rap_status;
79	union ta_rap_cmd_input      rap_in_message;
80	union ta_rap_cmd_output     rap_out_message;
81	uint8_t                     reserved[64];
82};
83
84#endif  // #define _TA_RAP_IF_H
85