1 /* SPDX-License-Identifier: GPL-2.0 */ 1 /* SPDX-License-Identifier: GPL-2.0 */
2 /* 2 /*
3 * Copyright (C) 2017-2018, Intel Corporation 3 * Copyright (C) 2017-2018, Intel Corporation
4 */ 4 */
5 5
6 #ifndef __STRATIX10_SVC_CLIENT_H 6 #ifndef __STRATIX10_SVC_CLIENT_H
7 #define __STRATIX10_SVC_CLIENT_H 7 #define __STRATIX10_SVC_CLIENT_H
8 8
9 /* 9 /*
10 * Service layer driver supports client names 10 * Service layer driver supports client names
11 * 11 *
12 * fpga: for FPGA configuration 12 * fpga: for FPGA configuration
13 * rsu: for remote status update 13 * rsu: for remote status update
14 */ 14 */
15 #define SVC_CLIENT_FPGA "fpga" 15 #define SVC_CLIENT_FPGA "fpga"
16 #define SVC_CLIENT_RSU "rsu" 16 #define SVC_CLIENT_RSU "rsu"
17 #define SVC_CLIENT_FCS "fcs" 17 #define SVC_CLIENT_FCS "fcs"
18 18
19 /* 19 /*
20 * Status of the sent command, in bit number 20 * Status of the sent command, in bit number
21 * 21 *
22 * SVC_STATUS_OK: 22 * SVC_STATUS_OK:
23 * Secure firmware accepts the request issued 23 * Secure firmware accepts the request issued by one of service clients.
24 * 24 *
25 * SVC_STATUS_BUFFER_SUBMITTED: 25 * SVC_STATUS_BUFFER_SUBMITTED:
26 * Service client successfully submits data bu 26 * Service client successfully submits data buffer to secure firmware.
27 * 27 *
28 * SVC_STATUS_BUFFER_DONE: 28 * SVC_STATUS_BUFFER_DONE:
29 * Secure firmware completes data process, rea 29 * Secure firmware completes data process, ready to accept the
30 * next WRITE transaction. 30 * next WRITE transaction.
31 * 31 *
32 * SVC_STATUS_COMPLETED: 32 * SVC_STATUS_COMPLETED:
33 * Secure firmware completes service request s 33 * Secure firmware completes service request successfully. In case of
34 * FPGA configuration, FPGA should be in user 34 * FPGA configuration, FPGA should be in user mode.
35 * 35 *
36 * SVC_COMMAND_STATUS_BUSY: 36 * SVC_COMMAND_STATUS_BUSY:
37 * Service request is still in process. 37 * Service request is still in process.
38 * 38 *
39 * SVC_COMMAND_STATUS_ERROR: 39 * SVC_COMMAND_STATUS_ERROR:
40 * Error encountered during the process of the 40 * Error encountered during the process of the service request.
41 * 41 *
42 * SVC_STATUS_NO_SUPPORT: 42 * SVC_STATUS_NO_SUPPORT:
43 * Secure firmware doesn't support requested f 43 * Secure firmware doesn't support requested features such as RSU retry
44 * or RSU notify. 44 * or RSU notify.
45 */ 45 */
46 #define SVC_STATUS_OK 0 46 #define SVC_STATUS_OK 0
47 #define SVC_STATUS_BUFFER_SUBMITTED 1 47 #define SVC_STATUS_BUFFER_SUBMITTED 1
48 #define SVC_STATUS_BUFFER_DONE 2 48 #define SVC_STATUS_BUFFER_DONE 2
49 #define SVC_STATUS_COMPLETED 3 49 #define SVC_STATUS_COMPLETED 3
50 #define SVC_STATUS_BUSY 4 50 #define SVC_STATUS_BUSY 4
51 #define SVC_STATUS_ERROR 5 51 #define SVC_STATUS_ERROR 5
52 #define SVC_STATUS_NO_SUPPORT 6 52 #define SVC_STATUS_NO_SUPPORT 6
53 #define SVC_STATUS_INVALID_PARAM 7 53 #define SVC_STATUS_INVALID_PARAM 7
54 54
55 /* 55 /*
56 * Flag bit for COMMAND_RECONFIG 56 * Flag bit for COMMAND_RECONFIG
57 * 57 *
58 * COMMAND_RECONFIG_FLAG_PARTIAL: 58 * COMMAND_RECONFIG_FLAG_PARTIAL:
59 * Set to FPGA configuration type (full or par 59 * Set to FPGA configuration type (full or partial).
60 */ 60 */
61 #define COMMAND_RECONFIG_FLAG_PARTIAL 0 61 #define COMMAND_RECONFIG_FLAG_PARTIAL 0
62 62
63 /* 63 /*
64 * Timeout settings for service clients: 64 * Timeout settings for service clients:
65 * timeout value used in Stratix10 FPGA manage 65 * timeout value used in Stratix10 FPGA manager driver.
66 * timeout value used in RSU driver 66 * timeout value used in RSU driver
67 */ 67 */
68 #define SVC_RECONFIG_REQUEST_TIMEOUT_MS 68 #define SVC_RECONFIG_REQUEST_TIMEOUT_MS 300
69 #define SVC_RECONFIG_BUFFER_TIMEOUT_MS 69 #define SVC_RECONFIG_BUFFER_TIMEOUT_MS 720
70 #define SVC_RSU_REQUEST_TIMEOUT_MS 70 #define SVC_RSU_REQUEST_TIMEOUT_MS 300
71 #define SVC_FCS_REQUEST_TIMEOUT_MS 71 #define SVC_FCS_REQUEST_TIMEOUT_MS 2000
72 #define SVC_COMPLETED_TIMEOUT_MS 72 #define SVC_COMPLETED_TIMEOUT_MS 30000
73 73
74 struct stratix10_svc_chan; 74 struct stratix10_svc_chan;
75 75
76 /** 76 /**
77 * enum stratix10_svc_command_code - supported 77 * enum stratix10_svc_command_code - supported service commands
78 * 78 *
79 * @COMMAND_NOOP: do 'dummy' request for integ 79 * @COMMAND_NOOP: do 'dummy' request for integration/debug/trouble-shooting
80 * 80 *
81 * @COMMAND_RECONFIG: ask for FPGA configurati 81 * @COMMAND_RECONFIG: ask for FPGA configuration preparation, return status
82 * is SVC_STATUS_OK 82 * is SVC_STATUS_OK
83 * 83 *
84 * @COMMAND_RECONFIG_DATA_SUBMIT: submit buffe 84 * @COMMAND_RECONFIG_DATA_SUBMIT: submit buffer(s) of bit-stream data for the
85 * FPGA configuration, return status is SVC_ST 85 * FPGA configuration, return status is SVC_STATUS_SUBMITTED or SVC_STATUS_ERROR
86 * 86 *
87 * @COMMAND_RECONFIG_DATA_CLAIM: check the sta 87 * @COMMAND_RECONFIG_DATA_CLAIM: check the status of the configuration, return
88 * status is SVC_STATUS_COMPLETED, or SVC_STAT 88 * status is SVC_STATUS_COMPLETED, or SVC_STATUS_BUSY, or SVC_STATUS_ERROR
89 * 89 *
90 * @COMMAND_RECONFIG_STATUS: check the status 90 * @COMMAND_RECONFIG_STATUS: check the status of the configuration, return
91 * status is SVC_STATUS_COMPLETED, or SVC_STAT 91 * status is SVC_STATUS_COMPLETED, or SVC_STATUS_BUSY, or SVC_STATUS_ERROR
92 * 92 *
93 * @COMMAND_RSU_STATUS: request remote system 93 * @COMMAND_RSU_STATUS: request remote system update boot log, return status
94 * is log data or SVC_STATUS_RSU_ERROR 94 * is log data or SVC_STATUS_RSU_ERROR
95 * 95 *
96 * @COMMAND_RSU_UPDATE: set the offset of the 96 * @COMMAND_RSU_UPDATE: set the offset of the bitstream to boot after reboot,
97 * return status is SVC_STATUS_OK or SVC_STATU 97 * return status is SVC_STATUS_OK or SVC_STATUS_ERROR
98 * 98 *
99 * @COMMAND_RSU_NOTIFY: report the status of h 99 * @COMMAND_RSU_NOTIFY: report the status of hard processor system
100 * software to firmware, return status is SVC_ 100 * software to firmware, return status is SVC_STATUS_OK or
101 * SVC_STATUS_ERROR 101 * SVC_STATUS_ERROR
102 * 102 *
103 * @COMMAND_RSU_RETRY: query firmware for the 103 * @COMMAND_RSU_RETRY: query firmware for the current image's retry counter,
104 * return status is SVC_STATUS_OK or SVC_STATU 104 * return status is SVC_STATUS_OK or SVC_STATUS_ERROR
105 * 105 *
106 * @COMMAND_RSU_MAX_RETRY: query firmware for 106 * @COMMAND_RSU_MAX_RETRY: query firmware for the max retry value,
107 * return status is SVC_STATUS_OK or SVC_STATU 107 * return status is SVC_STATUS_OK or SVC_STATUS_ERROR
108 * 108 *
109 * @COMMAND_RSU_DCMF_VERSION: query firmware f 109 * @COMMAND_RSU_DCMF_VERSION: query firmware for the DCMF version, return status
110 * is SVC_STATUS_OK or SVC_STATUS_ERROR 110 * is SVC_STATUS_OK or SVC_STATUS_ERROR
111 * 111 *
112 * @COMMAND_POLL_SERVICE_STATUS: poll if the s 112 * @COMMAND_POLL_SERVICE_STATUS: poll if the service request is complete,
113 * return statis is SVC_STATUS_OK, SVC_STATUS_ 113 * return statis is SVC_STATUS_OK, SVC_STATUS_ERROR or SVC_STATUS_BUSY
114 * 114 *
115 * @COMMAND_FIRMWARE_VERSION: query running fi 115 * @COMMAND_FIRMWARE_VERSION: query running firmware version, return status
116 * is SVC_STATUS_OK or SVC_STATUS_ERROR 116 * is SVC_STATUS_OK or SVC_STATUS_ERROR
117 * 117 *
118 * @COMMAND_SMC_SVC_VERSION: Non-mailbox SMC S 118 * @COMMAND_SMC_SVC_VERSION: Non-mailbox SMC SVC API Version,
119 * return status is SVC_STATUS_OK 119 * return status is SVC_STATUS_OK
120 * 120 *
121 * @COMMAND_MBOX_SEND_CMD: send generic mailbo 121 * @COMMAND_MBOX_SEND_CMD: send generic mailbox command, return status is
122 * SVC_STATUS_OK or SVC_STATUS_ERROR 122 * SVC_STATUS_OK or SVC_STATUS_ERROR
123 * 123 *
124 * @COMMAND_RSU_DCMF_STATUS: query firmware fo 124 * @COMMAND_RSU_DCMF_STATUS: query firmware for the DCMF status
125 * return status is SVC_STATUS_OK or SVC_STATU 125 * return status is SVC_STATUS_OK or SVC_STATUS_ERROR
126 * 126 *
127 * @COMMAND_FCS_REQUEST_SERVICE: request valid 127 * @COMMAND_FCS_REQUEST_SERVICE: request validation of image from firmware,
128 * return status is SVC_STATUS_OK, SVC_STATUS_ 128 * return status is SVC_STATUS_OK, SVC_STATUS_INVALID_PARAM
129 * 129 *
130 * @COMMAND_FCS_SEND_CERTIFICATE: send a certi 130 * @COMMAND_FCS_SEND_CERTIFICATE: send a certificate, return status is
131 * SVC_STATUS_OK, SVC_STATUS_INVALID_PARAM, SV 131 * SVC_STATUS_OK, SVC_STATUS_INVALID_PARAM, SVC_STATUS_ERROR
132 * 132 *
133 * @COMMAND_FCS_GET_PROVISION_DATA: read the p 133 * @COMMAND_FCS_GET_PROVISION_DATA: read the provisioning data, return status is
134 * SVC_STATUS_OK, SVC_STATUS_INVALID_PARAM, SV 134 * SVC_STATUS_OK, SVC_STATUS_INVALID_PARAM, SVC_STATUS_ERROR
135 * 135 *
136 * @COMMAND_FCS_DATA_ENCRYPTION: encrypt the d 136 * @COMMAND_FCS_DATA_ENCRYPTION: encrypt the data, return status is
137 * SVC_STATUS_OK, SVC_STATUS_INVALID_PARAM, SV 137 * SVC_STATUS_OK, SVC_STATUS_INVALID_PARAM, SVC_STATUS_ERROR
138 * 138 *
139 * @COMMAND_FCS_DATA_DECRYPTION: decrypt the d 139 * @COMMAND_FCS_DATA_DECRYPTION: decrypt the data, return status is
140 * SVC_STATUS_OK, SVC_STATUS_INVALID_PARAM, SV 140 * SVC_STATUS_OK, SVC_STATUS_INVALID_PARAM, SVC_STATUS_ERROR
141 * 141 *
142 * @COMMAND_FCS_RANDOM_NUMBER_GEN: generate a 142 * @COMMAND_FCS_RANDOM_NUMBER_GEN: generate a random number, return status
143 * is SVC_STATUS_OK, SVC_STATUS_ERROR 143 * is SVC_STATUS_OK, SVC_STATUS_ERROR
144 */ 144 */
145 enum stratix10_svc_command_code { 145 enum stratix10_svc_command_code {
146 /* for FPGA */ 146 /* for FPGA */
147 COMMAND_NOOP = 0, 147 COMMAND_NOOP = 0,
148 COMMAND_RECONFIG, 148 COMMAND_RECONFIG,
149 COMMAND_RECONFIG_DATA_SUBMIT, 149 COMMAND_RECONFIG_DATA_SUBMIT,
150 COMMAND_RECONFIG_DATA_CLAIM, 150 COMMAND_RECONFIG_DATA_CLAIM,
151 COMMAND_RECONFIG_STATUS, 151 COMMAND_RECONFIG_STATUS,
152 /* for RSU */ 152 /* for RSU */
153 COMMAND_RSU_STATUS = 10, 153 COMMAND_RSU_STATUS = 10,
154 COMMAND_RSU_UPDATE, 154 COMMAND_RSU_UPDATE,
155 COMMAND_RSU_NOTIFY, 155 COMMAND_RSU_NOTIFY,
156 COMMAND_RSU_RETRY, 156 COMMAND_RSU_RETRY,
157 COMMAND_RSU_MAX_RETRY, 157 COMMAND_RSU_MAX_RETRY,
158 COMMAND_RSU_DCMF_VERSION, 158 COMMAND_RSU_DCMF_VERSION,
159 COMMAND_RSU_DCMF_STATUS, 159 COMMAND_RSU_DCMF_STATUS,
160 COMMAND_FIRMWARE_VERSION, 160 COMMAND_FIRMWARE_VERSION,
161 /* for FCS */ 161 /* for FCS */
162 COMMAND_FCS_REQUEST_SERVICE = 20, 162 COMMAND_FCS_REQUEST_SERVICE = 20,
163 COMMAND_FCS_SEND_CERTIFICATE, 163 COMMAND_FCS_SEND_CERTIFICATE,
164 COMMAND_FCS_GET_PROVISION_DATA, 164 COMMAND_FCS_GET_PROVISION_DATA,
165 COMMAND_FCS_DATA_ENCRYPTION, 165 COMMAND_FCS_DATA_ENCRYPTION,
166 COMMAND_FCS_DATA_DECRYPTION, 166 COMMAND_FCS_DATA_DECRYPTION,
167 COMMAND_FCS_RANDOM_NUMBER_GEN, 167 COMMAND_FCS_RANDOM_NUMBER_GEN,
168 /* for general status poll */ 168 /* for general status poll */
169 COMMAND_POLL_SERVICE_STATUS = 40, 169 COMMAND_POLL_SERVICE_STATUS = 40,
170 /* for generic mailbox send command */ 170 /* for generic mailbox send command */
171 COMMAND_MBOX_SEND_CMD = 100, 171 COMMAND_MBOX_SEND_CMD = 100,
172 /* Non-mailbox SMC Call */ 172 /* Non-mailbox SMC Call */
173 COMMAND_SMC_SVC_VERSION = 200, 173 COMMAND_SMC_SVC_VERSION = 200,
174 }; 174 };
175 175
176 /** 176 /**
177 * struct stratix10_svc_client_msg - message s 177 * struct stratix10_svc_client_msg - message sent by client to service
178 * @payload: starting address of data need be 178 * @payload: starting address of data need be processed
179 * @payload_length: to be processed data size 179 * @payload_length: to be processed data size in bytes
180 * @payload_output: starting address of proces 180 * @payload_output: starting address of processed data
181 * @payload_length_output: processed data size 181 * @payload_length_output: processed data size in bytes
182 * @command: service command 182 * @command: service command
183 * @arg: args to be passed via registers and n 183 * @arg: args to be passed via registers and not physically mapped buffers
184 */ 184 */
185 struct stratix10_svc_client_msg { 185 struct stratix10_svc_client_msg {
186 void *payload; 186 void *payload;
187 size_t payload_length; 187 size_t payload_length;
188 void *payload_output; 188 void *payload_output;
189 size_t payload_length_output; 189 size_t payload_length_output;
190 enum stratix10_svc_command_code comman 190 enum stratix10_svc_command_code command;
191 u64 arg[3]; 191 u64 arg[3];
192 }; 192 };
193 193
194 /** 194 /**
195 * struct stratix10_svc_command_config_type - 195 * struct stratix10_svc_command_config_type - config type
196 * @flags: flag bit for the type of FPGA confi 196 * @flags: flag bit for the type of FPGA configuration
197 */ 197 */
198 struct stratix10_svc_command_config_type { 198 struct stratix10_svc_command_config_type {
199 u32 flags; 199 u32 flags;
200 }; 200 };
201 201
202 /** 202 /**
203 * struct stratix10_svc_cb_data - callback dat 203 * struct stratix10_svc_cb_data - callback data structure from service layer
204 * @status: the status of sent command 204 * @status: the status of sent command
205 * @kaddr1: address of 1st completed data bloc 205 * @kaddr1: address of 1st completed data block
206 * @kaddr2: address of 2nd completed data bloc 206 * @kaddr2: address of 2nd completed data block
207 * @kaddr3: address of 3rd completed data bloc 207 * @kaddr3: address of 3rd completed data block
208 */ 208 */
209 struct stratix10_svc_cb_data { 209 struct stratix10_svc_cb_data {
210 u32 status; 210 u32 status;
211 void *kaddr1; 211 void *kaddr1;
212 void *kaddr2; 212 void *kaddr2;
213 void *kaddr3; 213 void *kaddr3;
214 }; 214 };
215 215
216 /** 216 /**
217 * struct stratix10_svc_client - service clien 217 * struct stratix10_svc_client - service client structure
218 * @dev: the client device 218 * @dev: the client device
219 * @receive_cb: callback to provide service cl 219 * @receive_cb: callback to provide service client the received data
220 * @priv: client private data 220 * @priv: client private data
221 */ 221 */
222 struct stratix10_svc_client { 222 struct stratix10_svc_client {
223 struct device *dev; 223 struct device *dev;
224 void (*receive_cb)(struct stratix10_sv 224 void (*receive_cb)(struct stratix10_svc_client *client,
225 struct stratix10_sv 225 struct stratix10_svc_cb_data *cb_data);
226 void *priv; 226 void *priv;
227 }; 227 };
228 228
229 /** 229 /**
230 * stratix10_svc_request_channel_byname() - re 230 * stratix10_svc_request_channel_byname() - request service channel
231 * @client: identity of the client requesting 231 * @client: identity of the client requesting the channel
232 * @name: supporting client name defined above 232 * @name: supporting client name defined above
233 * 233 *
234 * Return: a pointer to channel assigned to th 234 * Return: a pointer to channel assigned to the client on success,
235 * or ERR_PTR() on error. 235 * or ERR_PTR() on error.
236 */ 236 */
237 struct stratix10_svc_chan 237 struct stratix10_svc_chan
238 *stratix10_svc_request_channel_byname(struct s 238 *stratix10_svc_request_channel_byname(struct stratix10_svc_client *client,
239 const char *name); 239 const char *name);
240 240
241 /** 241 /**
242 * stratix10_svc_free_channel() - free service 242 * stratix10_svc_free_channel() - free service channel.
243 * @chan: service channel to be freed 243 * @chan: service channel to be freed
244 */ 244 */
245 void stratix10_svc_free_channel(struct stratix 245 void stratix10_svc_free_channel(struct stratix10_svc_chan *chan);
246 246
247 /** 247 /**
248 * stratix10_svc_allocate_memory() - allocate 248 * stratix10_svc_allocate_memory() - allocate the momory
249 * @chan: service channel assigned to the clie 249 * @chan: service channel assigned to the client
250 * @size: number of bytes client requests 250 * @size: number of bytes client requests
251 * 251 *
252 * Service layer allocates the requested numbe 252 * Service layer allocates the requested number of bytes from the memory
253 * pool for the client. 253 * pool for the client.
254 * 254 *
255 * Return: the starting address of allocated m 255 * Return: the starting address of allocated memory on success, or
256 * ERR_PTR() on error. 256 * ERR_PTR() on error.
257 */ 257 */
258 void *stratix10_svc_allocate_memory(struct str 258 void *stratix10_svc_allocate_memory(struct stratix10_svc_chan *chan,
259 size_t siz 259 size_t size);
260 260
261 /** 261 /**
262 * stratix10_svc_free_memory() - free allocate 262 * stratix10_svc_free_memory() - free allocated memory
263 * @chan: service channel assigned to the clie 263 * @chan: service channel assigned to the client
264 * @kaddr: starting address of memory to be fr 264 * @kaddr: starting address of memory to be free back to pool
265 */ 265 */
266 void stratix10_svc_free_memory(struct stratix1 266 void stratix10_svc_free_memory(struct stratix10_svc_chan *chan, void *kaddr);
267 267
268 /** 268 /**
269 * stratix10_svc_send() - send a message to th 269 * stratix10_svc_send() - send a message to the remote
270 * @chan: service channel assigned to the clie 270 * @chan: service channel assigned to the client
271 * @msg: message data to be sent, in the forma 271 * @msg: message data to be sent, in the format of
272 * struct stratix10_svc_client_msg 272 * struct stratix10_svc_client_msg
273 * 273 *
274 * Return: 0 for success, -ENOMEM or -ENOBUFS 274 * Return: 0 for success, -ENOMEM or -ENOBUFS on error.
275 */ 275 */
276 int stratix10_svc_send(struct stratix10_svc_ch 276 int stratix10_svc_send(struct stratix10_svc_chan *chan, void *msg);
277 277
278 /** 278 /**
279 * stratix10_svc_done() - complete service req 279 * stratix10_svc_done() - complete service request
280 * @chan: service channel assigned to the clie 280 * @chan: service channel assigned to the client
281 * 281 *
282 * This function is used by service client to 282 * This function is used by service client to inform service layer that
283 * client's service requests are completed, or 283 * client's service requests are completed, or there is an error in the
284 * request process. 284 * request process.
285 */ 285 */
286 void stratix10_svc_done(struct stratix10_svc_c 286 void stratix10_svc_done(struct stratix10_svc_chan *chan);
287 #endif 287 #endif
288 288
289 289
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.