1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
|
/*
* Copyright 2017 NXP
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* Redistributions of source code must retain the above copyright notice, this
* list of conditions and the following disclaimer.
*
* Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* Neither the name of ARM nor the names of its contributors may be used
* to endorse or promote products derived from this software without specific
* prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
/*!
* Header file for the RPC implementation.
*/
#ifndef _SC_RPC_H
#define _SC_RPC_H
/* Includes */
#include <sci/types.h>
#include <sci/ipc.h>
/* Defines */
#define SC_RPC_VERSION 1
#define SC_RPC_MAX_MSG 8
#define RPC_VER(MSG) ((MSG)->version)
#define RPC_SIZE(MSG) ((MSG)->size)
#define RPC_SVC(MSG) ((MSG)->svc)
#define RPC_FUNC(MSG) ((MSG)->func)
#define RPC_R8(MSG) ((MSG)->func)
#define RPC_D32(MSG, IDX) ((MSG)->DATA.d32[IDX / 4])
#define RPC_F32(MSG, IDX) ((MSG)->DATA.f32[IDX / 4])
#define RPC_D16(MSG, IDX) ((MSG)->DATA.d16[IDX / 2])
#define RPC_D8(MSG, IDX) ((MSG)->DATA.d8[IDX])
/* Types */
typedef enum sc_rpc_svc_e
{
SC_RPC_SVC_UNKNOWN = 0,
SC_RPC_SVC_RETURN = 1,
SC_RPC_SVC_PM = 2,
SC_RPC_SVC_RM = 3,
SC_RPC_SVC_OTP = 4,
SC_RPC_SVC_TIMER = 5,
SC_RPC_SVC_PAD = 6,
SC_RPC_SVC_MISC = 7,
SC_RPC_SVC_IRQ = 8,
SC_RPC_SVC_ABORT = 9
} sc_rpc_svc_t;
typedef struct sc_rpc_msg_s
{
uint8_t version;
uint8_t size;
uint8_t svc;
uint8_t func;
union
{
uint32_t d32[(SC_RPC_MAX_MSG - 1)];
uint16_t d16[(SC_RPC_MAX_MSG - 1) * 2];
uint8_t d8[(SC_RPC_MAX_MSG - 1) * 4];
} DATA;
} sc_rpc_msg_t;
typedef enum sc_rpc_async_state_e
{
SC_RPC_ASYNC_STATE_RD_START = 0,
SC_RPC_ASYNC_STATE_RD_ACTIVE = 1,
SC_RPC_ASYNC_STATE_RD_DONE = 2,
SC_RPC_ASYNC_STATE_WR_START = 3,
SC_RPC_ASYNC_STATE_WR_ACTIVE = 4,
SC_RPC_ASYNC_STATE_WR_DONE = 5,
} sc_rpc_async_state_t;
typedef struct sc_rpc_async_msg_s
{
sc_rpc_async_state_t state;
uint8_t wordIdx;
sc_rpc_msg_t msg;
uint32_t timeStamp;
} sc_rpc_async_msg_t;
/* Functions */
/*!
* This is an internal function to send an RPC message over an IPC
* channel. It is called by client-side SCFW API function shims.
*
* @param[in] ipc IPC handle
* @param[in,out] msg handle to a message
* @param[in] no_resp response flag
*
* If \a no_resp is false then this function waits for a response
* and returns the result in \a msg.
*/
void sc_call_rpc(sc_ipc_t ipc, sc_rpc_msg_t *msg, bool no_resp);
/*!
* This is an internal function to dispath an RPC call that has
* arrived via IPC over an MU. It is called by server-side SCFW.
*
* @param[in] mu MU message arrived on
* @param[in,out] msg handle to a message
*
* The function result is returned in \a msg.
*/
void sc_rpc_dispatch(sc_rsrc_t mu, sc_rpc_msg_t *msg);
/*!
* This function translates an RPC message and forwards on to the
* normal RPC API. It is used only by hypervisors.
*
* @param[in] ipc IPC handle
* @param[in,out] msg handle to a message
*
* This function decodes a message, calls macros to translate the
* resources, pins, addresses, partitions, memory regions, etc. and
* then forwards on to the hypervisors SCFW API.Return results are
* translated back abd placed back into the message to be returned
* to the original API.
*/
void sc_rpc_xlate(sc_ipc_t ipc, sc_rpc_msg_t *msg);
#endif /* _SC_RPC_H */
|
