1 // SPDX-License-Identifier: GPL-2.0 2 /* 3 * Support for Intel Camera Imaging ISP subsystem. 4 * Copyright (c) 2015, Intel Corporation. 5 * 6 * This program is free software; you can redistribute it and/or modify it 7 * under the terms and conditions of the GNU General Public License, 8 * version 2, as published by the Free Software Foundation. 9 * 10 * This program is distributed in the hope it will be useful, but WITHOUT 11 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 12 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for 13 * more details. 14 */ 15 16 #include <linux/string.h> /* for memcpy() */ 17 #include <linux/slab.h> 18 #include <linux/vmalloc.h> 19 20 #include "hmm.h" 21 22 #include <math_support.h> 23 #include "platform_support.h" 24 #include "sh_css_firmware.h" 25 26 #include "sh_css_defs.h" 27 #include "ia_css_debug.h" 28 #include "sh_css_internal.h" 29 #include "ia_css_isp_param.h" 30 31 #include "assert_support.h" 32 33 #include "isp.h" /* PMEM_WIDTH_LOG2 */ 34 35 #include "ia_css_isp_params.h" 36 #include "ia_css_isp_configs.h" 37 #include "ia_css_isp_states.h" 38 39 #define _STR(x) #x 40 #define STR(x) _STR(x) 41 42 struct firmware_header { 43 struct sh_css_fw_bi_file_h file_header; 44 struct ia_css_fw_info binary_header; 45 }; 46 47 struct fw_param { 48 const char *name; 49 const void *buffer; 50 }; 51 52 static struct firmware_header *firmware_header; 53 54 /* 55 * The string STR is a place holder 56 * which will be replaced with the actual RELEASE_VERSION 57 * during package generation. Please do not modify 58 */ 59 static const char *release_version = STR(irci_stable_candrpv_0415_20150521_0458); 60 61 #define MAX_FW_REL_VER_NAME 300 62 static char FW_rel_ver_name[MAX_FW_REL_VER_NAME] = "---"; 63 64 struct ia_css_fw_info sh_css_sp_fw; 65 struct ia_css_blob_descr *sh_css_blob_info; /* Only ISP blob info (no SP) */ 66 unsigned int sh_css_num_binaries; /* This includes 1 SP binary */ 67 68 static struct fw_param *fw_minibuffer; 69 70 char *sh_css_get_fw_version(void) 71 { 72 return FW_rel_ver_name; 73 } 74 75 /* 76 * Split the loaded firmware into blobs 77 */ 78 79 /* Setup sp/sp1 binary */ 80 static int 81 setup_binary(struct ia_css_fw_info *fw, const char *fw_data, 82 struct ia_css_fw_info *sh_css_fw, unsigned int binary_id) 83 { 84 const char *blob_data; 85 86 if ((!fw) || (!fw_data)) 87 return -EINVAL; 88 89 blob_data = fw_data + fw->blob.offset; 90 91 *sh_css_fw = *fw; 92 93 sh_css_fw->blob.code = vmalloc(fw->blob.size); 94 if (!sh_css_fw->blob.code) 95 return -ENOMEM; 96 97 memcpy((void *)sh_css_fw->blob.code, blob_data, fw->blob.size); 98 sh_css_fw->blob.data = (char *)sh_css_fw->blob.code + fw->blob.data_source; 99 fw_minibuffer[binary_id].buffer = sh_css_fw->blob.code; 100 101 return 0; 102 } 103 104 int 105 sh_css_load_blob_info(const char *fw, const struct ia_css_fw_info *bi, 106 struct ia_css_blob_descr *bd, 107 unsigned int index) 108 { 109 const char *name; 110 const unsigned char *blob; 111 112 if ((!fw) || (!bd)) 113 return -EINVAL; 114 115 /* Special case: only one binary in fw */ 116 if (!bi) 117 bi = (const struct ia_css_fw_info *)fw; 118 119 name = fw + bi->blob.prog_name_offset; 120 blob = (const unsigned char *)fw + bi->blob.offset; 121 122 /* sanity check */ 123 if (bi->blob.size != 124 bi->blob.text_size + bi->blob.icache_size + 125 bi->blob.data_size + bi->blob.padding_size) { 126 /* sanity check, note the padding bytes added for section to DDR alignment */ 127 return -EINVAL; 128 } 129 130 if ((bi->blob.offset % (1UL << (ISP_PMEM_WIDTH_LOG2 - 3))) != 0) 131 return -EINVAL; 132 133 bd->blob = blob; 134 bd->header = *bi; 135 136 if (bi->type == ia_css_isp_firmware || bi->type == ia_css_sp_firmware) { 137 char *namebuffer; 138 139 namebuffer = kstrdup(name, GFP_KERNEL); 140 if (!namebuffer) 141 return -ENOMEM; 142 bd->name = fw_minibuffer[index].name = namebuffer; 143 } else { 144 bd->name = name; 145 } 146 147 if (bi->type == ia_css_isp_firmware) { 148 size_t paramstruct_size = sizeof(struct ia_css_memory_offsets); 149 size_t configstruct_size = sizeof(struct ia_css_config_memory_offsets); 150 size_t statestruct_size = sizeof(struct ia_css_state_memory_offsets); 151 152 char *parambuf = kmalloc(paramstruct_size + configstruct_size + 153 statestruct_size, 154 GFP_KERNEL); 155 if (!parambuf) 156 return -ENOMEM; 157 158 bd->mem_offsets.array[IA_CSS_PARAM_CLASS_PARAM].ptr = NULL; 159 bd->mem_offsets.array[IA_CSS_PARAM_CLASS_CONFIG].ptr = NULL; 160 bd->mem_offsets.array[IA_CSS_PARAM_CLASS_STATE].ptr = NULL; 161 162 fw_minibuffer[index].buffer = parambuf; 163 164 /* copy ia_css_memory_offsets */ 165 memcpy(parambuf, (void *)(fw + 166 bi->blob.memory_offsets.offsets[IA_CSS_PARAM_CLASS_PARAM]), 167 paramstruct_size); 168 bd->mem_offsets.array[IA_CSS_PARAM_CLASS_PARAM].ptr = parambuf; 169 170 /* copy ia_css_config_memory_offsets */ 171 memcpy(parambuf + paramstruct_size, 172 (void *)(fw + bi->blob.memory_offsets.offsets[IA_CSS_PARAM_CLASS_CONFIG]), 173 configstruct_size); 174 bd->mem_offsets.array[IA_CSS_PARAM_CLASS_CONFIG].ptr = parambuf + 175 paramstruct_size; 176 177 /* copy ia_css_state_memory_offsets */ 178 memcpy(parambuf + paramstruct_size + configstruct_size, 179 (void *)(fw + bi->blob.memory_offsets.offsets[IA_CSS_PARAM_CLASS_STATE]), 180 statestruct_size); 181 bd->mem_offsets.array[IA_CSS_PARAM_CLASS_STATE].ptr = parambuf + 182 paramstruct_size + configstruct_size; 183 } 184 return 0; 185 } 186 187 bool 188 sh_css_check_firmware_version(struct device *dev, const char *fw_data) 189 { 190 struct sh_css_fw_bi_file_h *file_header; 191 192 firmware_header = (struct firmware_header *)fw_data; 193 file_header = &firmware_header->file_header; 194 195 if (strcmp(file_header->version, release_version) != 0) { 196 dev_err(dev, "Firmware version may not be compatible with this driver\n"); 197 dev_err(dev, "Expecting version '%s', but firmware is '%s'.\n", 198 release_version, file_header->version); 199 } 200 201 /* For now, let's just accept a wrong version, even if wrong */ 202 return false; 203 } 204 205 static const char * const fw_type_name[] = { 206 [ia_css_sp_firmware] = "SP", 207 [ia_css_isp_firmware] = "ISP", 208 [ia_css_bootloader_firmware] = "BootLoader", 209 [ia_css_acc_firmware] = "accel", 210 }; 211 212 static const char * const fw_acc_type_name[] = { 213 [IA_CSS_ACC_NONE] = "Normal", 214 [IA_CSS_ACC_OUTPUT] = "Accel for output", 215 [IA_CSS_ACC_VIEWFINDER] = "Accel for viewfinder", 216 [IA_CSS_ACC_STANDALONE] = "Stand-alone accel", 217 }; 218 219 int 220 sh_css_load_firmware(struct device *dev, const char *fw_data, 221 unsigned int fw_size) 222 { 223 unsigned int i; 224 struct ia_css_fw_info *binaries; 225 struct sh_css_fw_bi_file_h *file_header; 226 int ret; 227 228 firmware_header = (struct firmware_header *)fw_data; 229 file_header = &firmware_header->file_header; 230 binaries = &firmware_header->binary_header; 231 strscpy(FW_rel_ver_name, file_header->version, 232 min(sizeof(FW_rel_ver_name), sizeof(file_header->version))); 233 ret = sh_css_check_firmware_version(dev, fw_data); 234 if (ret) { 235 IA_CSS_ERROR("CSS code version (%s) and firmware version (%s) mismatch!", 236 file_header->version, release_version); 237 return -EINVAL; 238 } else { 239 IA_CSS_LOG("successfully load firmware version %s", release_version); 240 } 241 242 /* some sanity checks */ 243 if (!fw_data || fw_size < sizeof(struct sh_css_fw_bi_file_h)) 244 return -EINVAL; 245 246 if (file_header->h_size != sizeof(struct sh_css_fw_bi_file_h)) 247 return -EINVAL; 248 249 sh_css_num_binaries = file_header->binary_nr; 250 /* Only allocate memory for ISP blob info */ 251 if (sh_css_num_binaries > NUM_OF_SPS) { 252 sh_css_blob_info = kmalloc( 253 (sh_css_num_binaries - NUM_OF_SPS) * 254 sizeof(*sh_css_blob_info), GFP_KERNEL); 255 if (!sh_css_blob_info) 256 return -ENOMEM; 257 } else { 258 sh_css_blob_info = NULL; 259 } 260 261 fw_minibuffer = kcalloc(sh_css_num_binaries, sizeof(struct fw_param), 262 GFP_KERNEL); 263 if (!fw_minibuffer) 264 return -ENOMEM; 265 266 for (i = 0; i < sh_css_num_binaries; i++) { 267 struct ia_css_fw_info *bi = &binaries[i]; 268 /* 269 * note: the var below is made static as it is quite large; 270 * if it is not static it ends up on the stack which could 271 * cause issues for drivers 272 */ 273 static struct ia_css_blob_descr bd; 274 int err; 275 276 err = sh_css_load_blob_info(fw_data, bi, &bd, i); 277 278 if (err) 279 return -EINVAL; 280 281 if (bi->blob.offset + bi->blob.size > fw_size) 282 return -EINVAL; 283 284 switch (bd.header.type) { 285 case ia_css_isp_firmware: 286 if (bd.header.info.isp.type > IA_CSS_ACC_STANDALONE) { 287 dev_err(dev, "binary #%2d: invalid SP type\n", 288 i); 289 return -EINVAL; 290 } 291 292 dev_dbg(dev, 293 "binary #%-2d type %s (%s), binary id is %2d: %s\n", 294 i, 295 fw_type_name[bd.header.type], 296 fw_acc_type_name[bd.header.info.isp.type], 297 bd.header.info.isp.sp.id, 298 bd.name); 299 break; 300 case ia_css_sp_firmware: 301 case ia_css_bootloader_firmware: 302 case ia_css_acc_firmware: 303 dev_dbg(dev, 304 "binary #%-2d type %s: %s\n", 305 i, fw_type_name[bd.header.type], 306 bd.name); 307 break; 308 default: 309 if (bd.header.info.isp.type > IA_CSS_ACC_STANDALONE) { 310 dev_err(dev, 311 "binary #%2d: invalid firmware type\n", 312 i); 313 return -EINVAL; 314 } 315 break; 316 } 317 318 if (bi->type == ia_css_sp_firmware) { 319 if (i != SP_FIRMWARE) 320 return -EINVAL; 321 err = setup_binary(bi, fw_data, &sh_css_sp_fw, i); 322 if (err) 323 return err; 324 325 } else { 326 /* 327 * All subsequent binaries 328 * (including bootloaders) (i>NUM_OF_SPS) 329 * are ISP firmware 330 */ 331 if (i < NUM_OF_SPS) 332 return -EINVAL; 333 334 if (bi->type != ia_css_isp_firmware) 335 return -EINVAL; 336 if (!sh_css_blob_info) /* cannot happen but KW does not see this */ 337 return -EINVAL; 338 sh_css_blob_info[i - NUM_OF_SPS] = bd; 339 } 340 } 341 342 return 0; 343 } 344 345 void sh_css_unload_firmware(void) 346 { 347 /* release firmware minibuffer */ 348 if (fw_minibuffer) { 349 unsigned int i = 0; 350 351 for (i = 0; i < sh_css_num_binaries; i++) { 352 kfree(fw_minibuffer[i].name); 353 kvfree(fw_minibuffer[i].buffer); 354 } 355 kfree(fw_minibuffer); 356 fw_minibuffer = NULL; 357 } 358 359 memset(&sh_css_sp_fw, 0, sizeof(sh_css_sp_fw)); 360 kfree(sh_css_blob_info); 361 sh_css_blob_info = NULL; 362 sh_css_num_binaries = 0; 363 } 364 365 ia_css_ptr 366 sh_css_load_blob(const unsigned char *blob, unsigned int size) 367 { 368 ia_css_ptr target_addr = hmm_alloc(size, HMM_BO_PRIVATE, 0, NULL, 0); 369 /* 370 * this will allocate memory aligned to a DDR word boundary which 371 * is required for the CSS DMA to read the instructions. 372 */ 373 374 assert(blob); 375 if (target_addr) 376 hmm_store(target_addr, blob, size); 377 return target_addr; 378 } 379