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
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
|
/*
* Copyright (c) 2016, Freescale Semiconductor, Inc.
* Copyright 2017-2019 NXP
*
* SPDX-License-Identifier: BSD-3-Clause
*
* Redistribution and use in source and binary forms, with or without modification,
* are permitted provided that the following conditions are met:
*
* o Redistributions of source code must retain the above copyright notice, this list
* of conditions and the following disclaimer.
*
* o 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.
*
* o Neither the name of the copyright holder 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 "main/types.h"
#include "main/ipc.h"
/* Defines */
#define SCFW_API_VERSION_MAJOR 1U
#define SCFW_API_VERSION_MINOR 16U
#define SC_RPC_VERSION 1U
#define SC_RPC_MAX_MSG 8U
#define RPC_VER(MESG) ((MESG)->version)
#define RPC_SIZE(MESG) ((MESG)->size)
#define RPC_SVC(MESG) ((MESG)->svc)
#define RPC_FUNC(MESG) ((MESG)->func)
#define RPC_R8(MESG) ((MESG)->func)
#define RPC_I64(MESG, IDX) ((I64(RPC_U32((MESG), (IDX))) << 32ULL) \
| I64(RPC_U32((MESG), (IDX) + 4U)))
#define RPC_I32(MESG, IDX) ((MESG)->DATA.i32[(IDX) / 4U])
#define RPC_I16(MESG, IDX) ((MESG)->DATA.i16[(IDX) / 2U])
#define RPC_I8(MESG, IDX) ((MESG)->DATA.i8[(IDX)])
#define RPC_U64(MESG, IDX) ((U64(RPC_U32((MESG), (IDX))) << 32ULL) \
| U64(RPC_U32((MESG), (IDX) + 4U)))
#define RPC_U32(MESG, IDX) ((MESG)->DATA.u32[(IDX) / 4U])
#define RPC_U16(MESG, IDX) ((MESG)->DATA.u16[(IDX) / 2U])
#define RPC_U8(MESG, IDX) ((MESG)->DATA.u8[(IDX)])
#define SC_RPC_SVC_UNKNOWN 0U
#define SC_RPC_SVC_RETURN 1U
#define SC_RPC_SVC_PM 2U
#define SC_RPC_SVC_RM 3U
#define SC_RPC_SVC_TIMER 5U
#define SC_RPC_SVC_PAD 6U
#define SC_RPC_SVC_MISC 7U
#define SC_RPC_SVC_IRQ 8U
#define SC_RPC_SVC_SECO 9U
#define SC_RPC_SVC_ABORT 10U
#define SC_RPC_ASYNC_STATE_RD_START 0U
#define SC_RPC_ASYNC_STATE_RD_ACTIVE 1U
#define SC_RPC_ASYNC_STATE_RD_DONE 2U
#define SC_RPC_ASYNC_STATE_WR_START 3U
#define SC_RPC_ASYNC_STATE_WR_ACTIVE 4U
#define SC_RPC_ASYNC_STATE_WR_DONE 5U
/* SC -> Client general-purpose MU IRQs */
#define SC_RPC_MU_GIR_SVC 0x1U
#define SC_RPC_MU_GIR_WAKE 0x2U
#define SC_RPC_MU_GIR_BOOT 0x4U
#define SC_RPC_MU_GIR_DBG 0x8U
/* Client -> SC general-purpose MU IRQs */
#define SC_RPC_MU_GIR_RST 0x1U
#define I8(X) ((int8_t) (X))
#define I16(X) ((int16_t) (X))
#define I32(X) ((int32_t) (X))
#define I64(X) ((int64_t) (X))
#define U8(X) ((uint8_t) (X))
#define U16(X) ((uint16_t) (X))
#define U32(X) ((uint32_t) (X))
#define U64(X) ((uint64_t) (X))
#define PTR_I8(X) ((int8_t*) (X))
#define PTR_I16(X) ((int16_t*) (X))
#define PTR_I32(X) ((int32_t*) (X))
#define PTR_I64(X) ((int64_t*) (X))
#define PTR_U8(X) ((uint8_t*) (X))
#define PTR_U16(X) ((uint16_t*) (X))
#define PTR_U32(X) ((uint32_t*) (X))
#define PTR_U64(X) ((uint64_t*) (X))
#define U2B(X) (((X) != 0U) ? SC_TRUE : SC_FALSE)
#define U2B32(X) (((X) != 0UL) ? SC_TRUE : SC_FALSE)
#define B2U8(X) (((X) != SC_FALSE) ? U8(0x01U) : U8(0x00U))
#define B2U16(X) (((X) != SC_FALSE) ? U16(0x01U) : U16(0x00U))
#define B2U32(X) (((X) != SC_FALSE) ? U32(0x01U) : U32(0x00U))
/* Types */
typedef uint8_t sc_rpc_svc_t;
typedef struct
{
union
{
uint32_t header;
struct
{
uint8_t version;
uint8_t size;
uint8_t svc;
uint8_t func;
};
};
union
{
int32_t i32[(SC_RPC_MAX_MSG - 1U)];
int16_t i16[(SC_RPC_MAX_MSG - 1U) * 2U];
int8_t i8[(SC_RPC_MAX_MSG - 1U) * 4U];
uint32_t u32[(SC_RPC_MAX_MSG - 1U)];
uint16_t u16[(SC_RPC_MAX_MSG - 1U) * 2U];
uint8_t u8[(SC_RPC_MAX_MSG - 1U) * 4U];
} DATA;
} sc_rpc_msg_t;
typedef uint8_t sc_rpc_async_state_t;
typedef struct
{
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 SC_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, sc_bool_t no_resp);
#endif /* SC_RPC_H */
|
