1 /* SPDX-License-Identifier: GPL-2.0 */ 2 /* 3 * Copyright (C) 2017-2018, Intel Corporation 4 */ 5 6 #ifndef __STRATIX10_SVC_CLIENT_H 7 #define __STRATIX10_SVC_CLIENT_H 8 9 /** 10 * Service layer driver supports client names 11 * 12 * fpga: for FPGA configuration 13 * rsu: for remote status update 14 */ 15 #define SVC_CLIENT_FPGA "fpga" 16 #define SVC_CLIENT_RSU "rsu" 17 18 /** 19 * Status of the sent command, in bit number 20 * 21 * SVC_COMMAND_STATUS_RECONFIG_REQUEST_OK: 22 * Secure firmware accepts the request of FPGA reconfiguration. 23 * 24 * SVC_STATUS_RECONFIG_BUFFER_SUBMITTED: 25 * Service client successfully submits FPGA configuration 26 * data buffer to secure firmware. 27 * 28 * SVC_COMMAND_STATUS_RECONFIG_BUFFER_DONE: 29 * Secure firmware completes data process, ready to accept the 30 * next WRITE transaction. 31 * 32 * SVC_COMMAND_STATUS_RECONFIG_COMPLETED: 33 * Secure firmware completes FPGA configuration successfully, FPGA should 34 * be in user mode. 35 * 36 * SVC_COMMAND_STATUS_RECONFIG_BUSY: 37 * FPGA configuration is still in process. 38 * 39 * SVC_COMMAND_STATUS_RECONFIG_ERROR: 40 * Error encountered during FPGA configuration. 41 * 42 * SVC_STATUS_RSU_OK: 43 * Secure firmware accepts the request of remote status update (RSU). 44 * 45 * SVC_STATUS_RSU_ERROR: 46 * Error encountered during remote system update. 47 * 48 * SVC_STATUS_RSU_NO_SUPPORT: 49 * Secure firmware doesn't support RSU retry or notify feature. 50 */ 51 #define SVC_STATUS_RECONFIG_REQUEST_OK 0 52 #define SVC_STATUS_RECONFIG_BUFFER_SUBMITTED 1 53 #define SVC_STATUS_RECONFIG_BUFFER_DONE 2 54 #define SVC_STATUS_RECONFIG_COMPLETED 3 55 #define SVC_STATUS_RECONFIG_BUSY 4 56 #define SVC_STATUS_RECONFIG_ERROR 5 57 #define SVC_STATUS_RSU_OK 6 58 #define SVC_STATUS_RSU_ERROR 7 59 #define SVC_STATUS_RSU_NO_SUPPORT 8 60 61 /** 62 * Flag bit for COMMAND_RECONFIG 63 * 64 * COMMAND_RECONFIG_FLAG_PARTIAL: 65 * Set to FPGA configuration type (full or partial), the default 66 * is full reconfig. 67 */ 68 #define COMMAND_RECONFIG_FLAG_PARTIAL 0 69 70 /** 71 * Timeout settings for service clients: 72 * timeout value used in Stratix10 FPGA manager driver. 73 * timeout value used in RSU driver 74 */ 75 #define SVC_RECONFIG_REQUEST_TIMEOUT_MS 100 76 #define SVC_RECONFIG_BUFFER_TIMEOUT_MS 240 77 #define SVC_RSU_REQUEST_TIMEOUT_MS 300 78 79 struct stratix10_svc_chan; 80 81 /** 82 * enum stratix10_svc_command_code - supported service commands 83 * 84 * @COMMAND_NOOP: do 'dummy' request for integration/debug/trouble-shooting 85 * 86 * @COMMAND_RECONFIG: ask for FPGA configuration preparation, return status 87 * is SVC_STATUS_RECONFIG_REQUEST_OK 88 * 89 * @COMMAND_RECONFIG_DATA_SUBMIT: submit buffer(s) of bit-stream data for the 90 * FPGA configuration, return status is SVC_STATUS_RECONFIG_BUFFER_SUBMITTED, 91 * or SVC_STATUS_RECONFIG_ERROR 92 * 93 * @COMMAND_RECONFIG_DATA_CLAIM: check the status of the configuration, return 94 * status is SVC_STATUS_RECONFIG_COMPLETED, or SVC_STATUS_RECONFIG_BUSY, or 95 * SVC_STATUS_RECONFIG_ERROR 96 * 97 * @COMMAND_RECONFIG_STATUS: check the status of the configuration, return 98 * status is SVC_STATUS_RECONFIG_COMPLETED, or SVC_STATUS_RECONFIG_BUSY, or 99 * SVC_STATUS_RECONFIG_ERROR 100 * 101 * @COMMAND_RSU_STATUS: request remote system update boot log, return status 102 * is log data or SVC_STATUS_RSU_ERROR 103 * 104 * @COMMAND_RSU_UPDATE: set the offset of the bitstream to boot after reboot, 105 * return status is SVC_STATUS_RSU_OK or SVC_STATUS_RSU_ERROR 106 * 107 * @COMMAND_RSU_NOTIFY: report the status of hard processor system 108 * software to firmware, return status is SVC_STATUS_RSU_OK or 109 * SVC_STATUS_RSU_ERROR 110 * 111 * @COMMAND_RSU_RETRY: query firmware for the current image's retry counter, 112 * return status is SVC_STATUS_RSU_OK or SVC_STATUS_RSU_ERROR 113 */ 114 enum stratix10_svc_command_code { 115 COMMAND_NOOP = 0, 116 COMMAND_RECONFIG, 117 COMMAND_RECONFIG_DATA_SUBMIT, 118 COMMAND_RECONFIG_DATA_CLAIM, 119 COMMAND_RECONFIG_STATUS, 120 COMMAND_RSU_STATUS, 121 COMMAND_RSU_UPDATE, 122 COMMAND_RSU_NOTIFY, 123 COMMAND_RSU_RETRY, 124 }; 125 126 /** 127 * struct stratix10_svc_client_msg - message sent by client to service 128 * @payload: starting address of data need be processed 129 * @payload_length: data size in bytes 130 * @command: service command 131 * @arg: args to be passed via registers and not physically mapped buffers 132 */ 133 struct stratix10_svc_client_msg { 134 void *payload; 135 size_t payload_length; 136 enum stratix10_svc_command_code command; 137 u64 arg[3]; 138 }; 139 140 /** 141 * struct stratix10_svc_command_config_type - config type 142 * @flags: flag bit for the type of FPGA configuration 143 */ 144 struct stratix10_svc_command_config_type { 145 u32 flags; 146 }; 147 148 /** 149 * struct stratix10_svc_cb_data - callback data structure from service layer 150 * @status: the status of sent command 151 * @kaddr1: address of 1st completed data block 152 * @kaddr2: address of 2nd completed data block 153 * @kaddr3: address of 3rd completed data block 154 */ 155 struct stratix10_svc_cb_data { 156 u32 status; 157 void *kaddr1; 158 void *kaddr2; 159 void *kaddr3; 160 }; 161 162 /** 163 * struct stratix10_svc_client - service client structure 164 * @dev: the client device 165 * @receive_cb: callback to provide service client the received data 166 * @priv: client private data 167 */ 168 struct stratix10_svc_client { 169 struct device *dev; 170 void (*receive_cb)(struct stratix10_svc_client *client, 171 struct stratix10_svc_cb_data *cb_data); 172 void *priv; 173 }; 174 175 /** 176 * stratix10_svc_request_channel_byname() - request service channel 177 * @client: identity of the client requesting the channel 178 * @name: supporting client name defined above 179 * 180 * Return: a pointer to channel assigned to the client on success, 181 * or ERR_PTR() on error. 182 */ 183 struct stratix10_svc_chan 184 *stratix10_svc_request_channel_byname(struct stratix10_svc_client *client, 185 const char *name); 186 187 /** 188 * stratix10_svc_free_channel() - free service channel. 189 * @chan: service channel to be freed 190 */ 191 void stratix10_svc_free_channel(struct stratix10_svc_chan *chan); 192 193 /** 194 * stratix10_svc_allocate_memory() - allocate the momory 195 * @chan: service channel assigned to the client 196 * @size: number of bytes client requests 197 * 198 * Service layer allocates the requested number of bytes from the memory 199 * pool for the client. 200 * 201 * Return: the starting address of allocated memory on success, or 202 * ERR_PTR() on error. 203 */ 204 void *stratix10_svc_allocate_memory(struct stratix10_svc_chan *chan, 205 size_t size); 206 207 /** 208 * stratix10_svc_free_memory() - free allocated memory 209 * @chan: service channel assigned to the client 210 * @kaddr: starting address of memory to be free back to pool 211 */ 212 void stratix10_svc_free_memory(struct stratix10_svc_chan *chan, void *kaddr); 213 214 /** 215 * stratix10_svc_send() - send a message to the remote 216 * @chan: service channel assigned to the client 217 * @msg: message data to be sent, in the format of 218 * struct stratix10_svc_client_msg 219 * 220 * Return: 0 for success, -ENOMEM or -ENOBUFS on error. 221 */ 222 int stratix10_svc_send(struct stratix10_svc_chan *chan, void *msg); 223 224 /** 225 * intel_svc_done() - complete service request 226 * @chan: service channel assigned to the client 227 * 228 * This function is used by service client to inform service layer that 229 * client's service requests are completed, or there is an error in the 230 * request process. 231 */ 232 void stratix10_svc_done(struct stratix10_svc_chan *chan); 233 #endif 234 235