2 * Copyright (c) 2016, NVIDIA CORPORATION. All rights reserved.
4 * Permission is hereby granted, free of charge, to any person obtaining a
5 * copy of this software and associated documentation files (the "Software"),
6 * to deal in the Software without restriction, including without limitation
7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8 * and/or sell copies of the Software, and to permit persons to whom the
9 * Software is furnished to do so, subject to the following conditions:
11 * The above copyright notice and this permission notice shall be included in
12 * all copies or substantial portions of the Software.
14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
17 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
19 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
20 * DEALINGS IN THE SOFTWARE.
26 #include <core/gpuobj.h>
27 #include <core/firmware.h>
28 #include <engine/falcon.h>
29 #include <subdev/pmu.h>
30 #include <core/msgqueue.h>
31 #include <engine/sec2.h>
34 * struct acr_r352_flcn_bl_desc - DMEM bootloader descriptor
35 * @signature: 16B signature for secure code. 0s if no secure code
36 * @ctx_dma: DMA context to be used by BL while loading code/data
37 * @code_dma_base: 256B-aligned Physical FB Address where code is located
38 * (falcon's $xcbase register)
39 * @non_sec_code_off: offset from code_dma_base where the non-secure code is
40 * located. The offset must be multiple of 256 to help perf
41 * @non_sec_code_size: the size of the nonSecure code part.
42 * @sec_code_off: offset from code_dma_base where the secure code is
43 * located. The offset must be multiple of 256 to help perf
44 * @sec_code_size: offset from code_dma_base where the secure code is
45 * located. The offset must be multiple of 256 to help perf
46 * @code_entry_point: code entry point which will be invoked by BL after
48 * @data_dma_base: 256B aligned Physical FB Address where data is located.
49 * (falcon's $xdbase register)
50 * @data_size: size of data block. Should be multiple of 256B
52 * Structure used by the bootloader to load the rest of the code. This has
53 * to be filled by host and copied into DMEM at offset provided in the
54 * hsflcn_bl_desc.bl_desc_dmem_load_off.
56 struct acr_r352_flcn_bl_desc {
62 u32 non_sec_code_size;
73 * acr_r352_generate_flcn_bl_desc - generate generic BL descriptor for LS image
76 acr_r352_generate_flcn_bl_desc(const struct nvkm_acr *acr,
77 const struct ls_ucode_img *img, u64 wpr_addr,
80 struct acr_r352_flcn_bl_desc *desc = _desc;
81 const struct ls_ucode_img_desc *pdesc = &img->ucode_desc;
82 u64 base, addr_code, addr_data;
84 base = wpr_addr + img->ucode_off + pdesc->app_start_offset;
85 addr_code = (base + pdesc->app_resident_code_offset) >> 8;
86 addr_data = (base + pdesc->app_resident_data_offset) >> 8;
88 desc->ctx_dma = FALCON_DMAIDX_UCODE;
89 desc->code_dma_base = lower_32_bits(addr_code);
90 desc->code_dma_base1 = upper_32_bits(addr_code);
91 desc->non_sec_code_off = pdesc->app_resident_code_offset;
92 desc->non_sec_code_size = pdesc->app_resident_code_size;
93 desc->code_entry_point = pdesc->app_imem_entry;
94 desc->data_dma_base = lower_32_bits(addr_data);
95 desc->data_dma_base1 = upper_32_bits(addr_data);
96 desc->data_size = pdesc->app_resident_data_size;
101 * struct hsflcn_acr_desc - data section of the HS firmware
103 * This header is to be copied at the beginning of DMEM by the HS bootloader.
105 * @signature: signature of ACR ucode
106 * @wpr_region_id: region ID holding the WPR header and its details
107 * @wpr_offset: offset from the WPR region holding the wpr header
108 * @regions: region descriptors
109 * @nonwpr_ucode_blob_size: size of LS blob
110 * @nonwpr_ucode_blob_start: FB location of LS blob is
112 struct hsflcn_acr_desc {
114 u8 reserved_dmem[0x200];
116 } ucode_reserved_space;
120 #define FLCN_ACR_MAX_REGIONS 2
130 } region_props[FLCN_ACR_MAX_REGIONS];
133 u64 ucode_blob_base __aligned(8);
144 * Low-secure blob creation
148 * struct acr_r352_lsf_lsb_header - LS firmware header
149 * @signature: signature to verify the firmware against
150 * @ucode_off: offset of the ucode blob in the WPR region. The ucode
151 * blob contains the bootloader, code and data of the
153 * @ucode_size: size of the ucode blob, including bootloader
154 * @data_size: size of the ucode blob data
155 * @bl_code_size: size of the bootloader code
156 * @bl_imem_off: offset in imem of the bootloader
157 * @bl_data_off: offset of the bootloader data in WPR region
158 * @bl_data_size: size of the bootloader data
159 * @app_code_off: offset of the app code relative to ucode_off
160 * @app_code_size: size of the app code
161 * @app_data_off: offset of the app data relative to ucode_off
162 * @app_data_size: size of the app data
163 * @flags: flags for the secure bootloader
165 * This structure is written into the WPR region for each managed falcon. Each
166 * instance is referenced by the lsb_offset member of the corresponding
169 struct acr_r352_lsf_lsb_header {
171 * LS falcon signatures
172 * @prd_keys: signature to use in production mode
173 * @dgb_keys: signature to use in debug mode
174 * @b_prd_present: whether the production key is present
175 * @b_dgb_present: whether the debug key is present
176 * @falcon_id: ID of the falcon the ucode applies to
200 * struct acr_r352_lsf_wpr_header - LS blob WPR Header
201 * @falcon_id: LS falcon ID
202 * @lsb_offset: offset of the lsb_lsf_header in the WPR region
203 * @bootstrap_owner: secure falcon reponsible for bootstrapping the LS falcon
204 * @lazy_bootstrap: skip bootstrapping by ACR
205 * @status: bootstrapping status
207 * An array of these is written at the beginning of the WPR region, one for
208 * each managed falcon. The array is terminated by an instance which falcon_id
209 * is LSF_FALCON_ID_INVALID.
211 struct acr_r352_lsf_wpr_header {
217 #define LSF_IMAGE_STATUS_NONE 0
218 #define LSF_IMAGE_STATUS_COPY 1
219 #define LSF_IMAGE_STATUS_VALIDATION_CODE_FAILED 2
220 #define LSF_IMAGE_STATUS_VALIDATION_DATA_FAILED 3
221 #define LSF_IMAGE_STATUS_VALIDATION_DONE 4
222 #define LSF_IMAGE_STATUS_VALIDATION_SKIPPED 5
223 #define LSF_IMAGE_STATUS_BOOTSTRAP_READY 6
227 * struct ls_ucode_img_r352 - ucode image augmented with r352 headers
229 struct ls_ucode_img_r352 {
230 struct ls_ucode_img base;
232 struct acr_r352_lsf_wpr_header wpr_header;
233 struct acr_r352_lsf_lsb_header lsb_header;
235 #define ls_ucode_img_r352(i) container_of(i, struct ls_ucode_img_r352, base)
238 * ls_ucode_img_load() - create a lsf_ucode_img and load it
240 struct ls_ucode_img *
241 acr_r352_ls_ucode_img_load(const struct acr_r352 *acr,
242 const struct nvkm_secboot *sb,
243 enum nvkm_secboot_falcon falcon_id)
245 const struct nvkm_subdev *subdev = acr->base.subdev;
246 const struct acr_r352_ls_func *func = acr->func->ls_func[falcon_id];
247 struct ls_ucode_img_r352 *img;
250 img = kzalloc(sizeof(*img), GFP_KERNEL);
252 return ERR_PTR(-ENOMEM);
254 img->base.falcon_id = falcon_id;
256 ret = func->load(sb, func->version_max, &img->base);
258 kfree(img->base.ucode_data);
259 kfree(img->base.sig);
264 /* Check that the signature size matches our expectations... */
265 if (img->base.sig_size != sizeof(img->lsb_header.signature)) {
266 nvkm_error(subdev, "invalid signature size for %s falcon!\n",
267 nvkm_secboot_falcon_name[falcon_id]);
268 return ERR_PTR(-EINVAL);
271 /* Copy signature to the right place */
272 memcpy(&img->lsb_header.signature, img->base.sig, img->base.sig_size);
274 /* not needed? the signature should already have the right value */
275 img->lsb_header.signature.falcon_id = falcon_id;
280 #define LSF_LSB_HEADER_ALIGN 256
281 #define LSF_BL_DATA_ALIGN 256
282 #define LSF_BL_DATA_SIZE_ALIGN 256
283 #define LSF_BL_CODE_SIZE_ALIGN 256
284 #define LSF_UCODE_DATA_ALIGN 4096
287 * acr_r352_ls_img_fill_headers - fill the WPR and LSB headers of an image
289 * @img: image to generate for
290 * @offset: offset in the WPR region where this image starts
292 * Allocate space in the WPR area from offset and write the WPR and LSB headers
295 * Return: offset at the end of this image.
298 acr_r352_ls_img_fill_headers(struct acr_r352 *acr,
299 struct ls_ucode_img_r352 *img, u32 offset)
301 struct ls_ucode_img *_img = &img->base;
302 struct acr_r352_lsf_wpr_header *whdr = &img->wpr_header;
303 struct acr_r352_lsf_lsb_header *lhdr = &img->lsb_header;
304 struct ls_ucode_img_desc *desc = &_img->ucode_desc;
305 const struct acr_r352_ls_func *func =
306 acr->func->ls_func[_img->falcon_id];
308 /* Fill WPR header */
309 whdr->falcon_id = _img->falcon_id;
310 whdr->bootstrap_owner = acr->base.boot_falcon;
311 whdr->status = LSF_IMAGE_STATUS_COPY;
313 /* Skip bootstrapping falcons started by someone else than ACR */
314 if (acr->lazy_bootstrap & BIT(_img->falcon_id))
315 whdr->lazy_bootstrap = 1;
317 /* Align, save off, and include an LSB header size */
318 offset = ALIGN(offset, LSF_LSB_HEADER_ALIGN);
319 whdr->lsb_offset = offset;
320 offset += sizeof(*lhdr);
323 * Align, save off, and include the original (static) ucode
326 offset = ALIGN(offset, LSF_UCODE_DATA_ALIGN);
327 _img->ucode_off = lhdr->ucode_off = offset;
328 offset += _img->ucode_size;
331 * For falcons that use a boot loader (BL), we append a loader
332 * desc structure on the end of the ucode image and consider
333 * this the boot loader data. The host will then copy the loader
334 * desc args to this space within the WPR region (before locking
335 * down) and the HS bin will then copy them to DMEM 0 for the
338 lhdr->bl_code_size = ALIGN(desc->bootloader_size,
339 LSF_BL_CODE_SIZE_ALIGN);
340 lhdr->ucode_size = ALIGN(desc->app_resident_data_offset,
341 LSF_BL_CODE_SIZE_ALIGN) + lhdr->bl_code_size;
342 lhdr->data_size = ALIGN(desc->app_size, LSF_BL_CODE_SIZE_ALIGN) +
343 lhdr->bl_code_size - lhdr->ucode_size;
345 * Though the BL is located at 0th offset of the image, the VA
346 * is different to make sure that it doesn't collide the actual
349 lhdr->bl_imem_off = desc->bootloader_imem_offset;
350 lhdr->app_code_off = desc->app_start_offset +
351 desc->app_resident_code_offset;
352 lhdr->app_code_size = desc->app_resident_code_size;
353 lhdr->app_data_off = desc->app_start_offset +
354 desc->app_resident_data_offset;
355 lhdr->app_data_size = desc->app_resident_data_size;
357 lhdr->flags = func->lhdr_flags;
358 if (_img->falcon_id == acr->base.boot_falcon)
359 lhdr->flags |= LSF_FLAG_DMACTL_REQ_CTX;
361 /* Align and save off BL descriptor size */
362 lhdr->bl_data_size = ALIGN(func->bl_desc_size, LSF_BL_DATA_SIZE_ALIGN);
365 * Align, save off, and include the additional BL data
367 offset = ALIGN(offset, LSF_BL_DATA_ALIGN);
368 lhdr->bl_data_off = offset;
369 offset += lhdr->bl_data_size;
375 * acr_r352_ls_fill_headers - fill WPR and LSB headers of all managed images
378 acr_r352_ls_fill_headers(struct acr_r352 *acr, struct list_head *imgs)
380 struct ls_ucode_img_r352 *img;
385 /* Count the number of images to manage */
386 list_for_each(l, imgs)
390 * Start with an array of WPR headers at the base of the WPR.
391 * The expectation here is that the secure falcon will do a single DMA
392 * read of this array and cache it internally so it's ok to pack these.
393 * Also, we add 1 to the falcon count to indicate the end of the array.
395 offset = sizeof(img->wpr_header) * (count + 1);
398 * Walk the managed falcons, accounting for the LSB structs
399 * as well as the ucode images.
401 list_for_each_entry(img, imgs, base.node) {
402 offset = acr_r352_ls_img_fill_headers(acr, img, offset);
409 * acr_r352_ls_write_wpr - write the WPR blob contents
412 acr_r352_ls_write_wpr(struct acr_r352 *acr, struct list_head *imgs,
413 struct nvkm_gpuobj *wpr_blob, u64 wpr_addr)
415 struct ls_ucode_img *_img;
417 u32 max_desc_size = 0;
420 /* Figure out how large we need gdesc to be. */
421 list_for_each_entry(_img, imgs, node) {
422 const struct acr_r352_ls_func *ls_func =
423 acr->func->ls_func[_img->falcon_id];
425 max_desc_size = max(max_desc_size, ls_func->bl_desc_size);
428 gdesc = kmalloc(max_desc_size, GFP_KERNEL);
434 list_for_each_entry(_img, imgs, node) {
435 struct ls_ucode_img_r352 *img = ls_ucode_img_r352(_img);
436 const struct acr_r352_ls_func *ls_func =
437 acr->func->ls_func[_img->falcon_id];
439 nvkm_gpuobj_memcpy_to(wpr_blob, pos, &img->wpr_header,
440 sizeof(img->wpr_header));
442 nvkm_gpuobj_memcpy_to(wpr_blob, img->wpr_header.lsb_offset,
443 &img->lsb_header, sizeof(img->lsb_header));
445 /* Generate and write BL descriptor */
446 memset(gdesc, 0, ls_func->bl_desc_size);
447 ls_func->generate_bl_desc(&acr->base, _img, wpr_addr, gdesc);
449 nvkm_gpuobj_memcpy_to(wpr_blob, img->lsb_header.bl_data_off,
450 gdesc, ls_func->bl_desc_size);
453 nvkm_gpuobj_memcpy_to(wpr_blob, img->lsb_header.ucode_off,
454 _img->ucode_data, _img->ucode_size);
456 pos += sizeof(img->wpr_header);
459 nvkm_wo32(wpr_blob, pos, NVKM_SECBOOT_FALCON_INVALID);
468 /* Both size and address of WPR need to be 256K-aligned */
469 #define WPR_ALIGNMENT 0x40000
471 * acr_r352_prepare_ls_blob() - prepare the LS blob
473 * For each securely managed falcon, load the FW, signatures and bootloaders and
474 * prepare a ucode blob. Then, compute the offsets in the WPR region for each
475 * blob, and finally write the headers and ucode blobs into a GPU object that
476 * will be copied into the WPR region by the HS firmware.
479 acr_r352_prepare_ls_blob(struct acr_r352 *acr, struct nvkm_secboot *sb)
481 const struct nvkm_subdev *subdev = acr->base.subdev;
482 struct list_head imgs;
483 struct ls_ucode_img *img, *t;
484 unsigned long managed_falcons = acr->base.managed_falcons;
485 u64 wpr_addr = sb->wpr_addr;
486 u32 wpr_size = sb->wpr_size;
487 int managed_count = 0;
488 u32 image_wpr_size, ls_blob_size;
492 INIT_LIST_HEAD(&imgs);
494 /* Load all LS blobs */
495 for_each_set_bit(falcon_id, &managed_falcons, NVKM_SECBOOT_FALCON_END) {
496 struct ls_ucode_img *img;
498 img = acr->func->ls_ucode_img_load(acr, sb, falcon_id);
500 if (acr->base.optional_falcons & BIT(falcon_id)) {
501 managed_falcons &= ~BIT(falcon_id);
502 nvkm_info(subdev, "skipping %s falcon...\n",
503 nvkm_secboot_falcon_name[falcon_id]);
510 list_add_tail(&img->node, &imgs);
514 /* Commit the actual list of falcons we will manage from now on */
515 acr->base.managed_falcons = managed_falcons;
518 * If the boot falcon has a firmare, let it manage the bootstrap of other
521 if (acr->func->ls_func[acr->base.boot_falcon] &&
522 (managed_falcons & BIT(acr->base.boot_falcon))) {
523 for_each_set_bit(falcon_id, &managed_falcons,
524 NVKM_SECBOOT_FALCON_END) {
525 if (falcon_id == acr->base.boot_falcon)
528 acr->lazy_bootstrap |= BIT(falcon_id);
533 * Fill the WPR and LSF headers with the right offsets and compute
536 image_wpr_size = acr->func->ls_fill_headers(acr, &imgs);
537 image_wpr_size = ALIGN(image_wpr_size, WPR_ALIGNMENT);
539 ls_blob_size = image_wpr_size;
542 * If we need a shadow area, allocate twice the size and use the
545 if (wpr_size == 0 && acr->func->shadow_blob)
548 /* Allocate GPU object that will contain the WPR region */
549 ret = nvkm_gpuobj_new(subdev->device, ls_blob_size, WPR_ALIGNMENT,
550 false, NULL, &acr->ls_blob);
554 nvkm_debug(subdev, "%d managed LS falcons, WPR size is %d bytes\n",
555 managed_count, image_wpr_size);
557 /* If WPR address and size are not fixed, set them to fit the LS blob */
559 wpr_addr = acr->ls_blob->addr;
560 if (acr->func->shadow_blob)
561 wpr_addr += acr->ls_blob->size / 2;
563 wpr_size = image_wpr_size;
565 * But if the WPR region is set by the bootloader, it is illegal for
566 * the HS blob to be larger than this region.
568 } else if (image_wpr_size > wpr_size) {
569 nvkm_error(subdev, "WPR region too small for FW blob!\n");
570 nvkm_error(subdev, "required: %dB\n", image_wpr_size);
571 nvkm_error(subdev, "available: %dB\n", wpr_size);
577 ret = acr->func->ls_write_wpr(acr, &imgs, acr->ls_blob, wpr_addr);
579 nvkm_gpuobj_del(&acr->ls_blob);
582 list_for_each_entry_safe(img, t, &imgs, node) {
583 kfree(img->ucode_data);
595 acr_r352_fixup_hs_desc(struct acr_r352 *acr, struct nvkm_secboot *sb,
598 struct hsflcn_acr_desc *desc = _desc;
599 struct nvkm_gpuobj *ls_blob = acr->ls_blob;
601 /* WPR region information if WPR is not fixed */
602 if (sb->wpr_size == 0) {
603 u64 wpr_start = ls_blob->addr;
604 u64 wpr_end = wpr_start + ls_blob->size;
606 desc->wpr_region_id = 1;
607 desc->regions.no_regions = 2;
608 desc->regions.region_props[0].start_addr = wpr_start >> 8;
609 desc->regions.region_props[0].end_addr = wpr_end >> 8;
610 desc->regions.region_props[0].region_id = 1;
611 desc->regions.region_props[0].read_mask = 0xf;
612 desc->regions.region_props[0].write_mask = 0xc;
613 desc->regions.region_props[0].client_mask = 0x2;
615 desc->ucode_blob_base = ls_blob->addr;
616 desc->ucode_blob_size = ls_blob->size;
621 acr_r352_generate_hs_bl_desc(const struct hsf_load_header *hdr, void *_bl_desc,
624 struct acr_r352_flcn_bl_desc *bl_desc = _bl_desc;
625 u64 addr_code, addr_data;
627 addr_code = offset >> 8;
628 addr_data = (offset + hdr->data_dma_base) >> 8;
630 bl_desc->ctx_dma = FALCON_DMAIDX_VIRT;
631 bl_desc->code_dma_base = lower_32_bits(addr_code);
632 bl_desc->non_sec_code_off = hdr->non_sec_code_off;
633 bl_desc->non_sec_code_size = hdr->non_sec_code_size;
634 bl_desc->sec_code_off = hsf_load_header_app_off(hdr, 0);
635 bl_desc->sec_code_size = hsf_load_header_app_size(hdr, 0);
636 bl_desc->code_entry_point = 0;
637 bl_desc->data_dma_base = lower_32_bits(addr_data);
638 bl_desc->data_size = hdr->data_size;
642 * acr_r352_prepare_hs_blob - load and prepare a HS blob and BL descriptor
644 * @sb secure boot instance to prepare for
645 * @fw name of the HS firmware to load
646 * @blob pointer to gpuobj that will be allocated to receive the HS FW payload
647 * @bl_desc pointer to the BL descriptor to write for this firmware
648 * @patch whether we should patch the HS descriptor (only for HS loaders)
651 acr_r352_prepare_hs_blob(struct acr_r352 *acr, struct nvkm_secboot *sb,
652 const char *fw, struct nvkm_gpuobj **blob,
653 struct hsf_load_header *load_header, bool patch)
655 struct nvkm_subdev *subdev = &sb->subdev;
657 struct fw_bin_header *hsbin_hdr;
658 struct hsf_fw_header *fw_hdr;
659 struct hsf_load_header *load_hdr;
663 acr_image = hs_ucode_load_blob(subdev, sb->boot_falcon, fw);
664 if (IS_ERR(acr_image))
665 return PTR_ERR(acr_image);
667 hsbin_hdr = acr_image;
668 fw_hdr = acr_image + hsbin_hdr->header_offset;
669 load_hdr = acr_image + fw_hdr->hdr_offset;
670 acr_data = acr_image + hsbin_hdr->data_offset;
672 /* Patch descriptor with WPR information? */
674 struct hsflcn_acr_desc *desc;
676 desc = acr_data + load_hdr->data_dma_base;
677 acr->func->fixup_hs_desc(acr, sb, desc);
680 if (load_hdr->num_apps > ACR_R352_MAX_APPS) {
681 nvkm_error(subdev, "more apps (%d) than supported (%d)!",
682 load_hdr->num_apps, ACR_R352_MAX_APPS);
686 memcpy(load_header, load_hdr, sizeof(*load_header) +
687 (sizeof(load_hdr->apps[0]) * 2 * load_hdr->num_apps));
689 /* Create ACR blob and copy HS data to it */
690 ret = nvkm_gpuobj_new(subdev->device, ALIGN(hsbin_hdr->data_size, 256),
691 0x1000, false, NULL, blob);
696 nvkm_gpuobj_memcpy_to(*blob, 0, acr_data, hsbin_hdr->data_size);
706 * acr_r352_load_blobs - load blobs common to all ACR V1 versions.
708 * This includes the LS blob, HS ucode loading blob, and HS bootloader.
710 * The HS ucode unload blob is only used on dGPU if the WPR region is variable.
713 acr_r352_load_blobs(struct acr_r352 *acr, struct nvkm_secboot *sb)
715 struct nvkm_subdev *subdev = &sb->subdev;
718 /* Firmware already loaded? */
719 if (acr->firmware_ok)
722 /* Load and prepare the managed falcon's firmwares */
723 ret = acr_r352_prepare_ls_blob(acr, sb);
727 /* Load the HS firmware that will load the LS firmwares */
728 if (!acr->load_blob) {
729 ret = acr_r352_prepare_hs_blob(acr, sb, "acr/ucode_load",
731 &acr->load_bl_header, true);
736 /* If the ACR region is dynamically programmed, we need an unload FW */
737 if (sb->wpr_size == 0) {
738 ret = acr_r352_prepare_hs_blob(acr, sb, "acr/ucode_unload",
740 &acr->unload_bl_header, false);
745 /* Load the HS firmware bootloader */
746 if (!acr->hsbl_blob) {
747 acr->hsbl_blob = nvkm_acr_load_firmware(subdev, "acr/bl", 0);
748 if (IS_ERR(acr->hsbl_blob)) {
749 ret = PTR_ERR(acr->hsbl_blob);
750 acr->hsbl_blob = NULL;
754 if (acr->base.boot_falcon != NVKM_SECBOOT_FALCON_PMU) {
755 acr->hsbl_unload_blob = nvkm_acr_load_firmware(subdev,
757 if (IS_ERR(acr->hsbl_unload_blob)) {
758 ret = PTR_ERR(acr->hsbl_unload_blob);
759 acr->hsbl_unload_blob = NULL;
763 acr->hsbl_unload_blob = acr->hsbl_blob;
767 acr->firmware_ok = true;
768 nvkm_debug(&sb->subdev, "LS blob successfully created\n");
774 * acr_r352_load() - prepare HS falcon to run the specified blob, mapped.
776 * Returns the start address to use, or a negative error value.
779 acr_r352_load(struct nvkm_acr *_acr, struct nvkm_falcon *falcon,
780 struct nvkm_gpuobj *blob, u64 offset)
782 struct acr_r352 *acr = acr_r352(_acr);
783 const u32 bl_desc_size = acr->func->hs_bl_desc_size;
784 const struct hsf_load_header *load_hdr;
785 struct fw_bin_header *bl_hdr;
786 struct fw_bl_desc *hsbl_desc;
787 void *bl, *blob_data, *hsbl_code, *hsbl_data;
791 bl_desc = kzalloc(bl_desc_size, GFP_KERNEL);
795 /* Find the bootloader descriptor for our blob and copy it */
796 if (blob == acr->load_blob) {
797 load_hdr = &acr->load_bl_header;
799 } else if (blob == acr->unload_blob) {
800 load_hdr = &acr->unload_bl_header;
801 bl = acr->hsbl_unload_blob;
803 nvkm_error(_acr->subdev, "invalid secure boot blob!\n");
809 hsbl_desc = bl + bl_hdr->header_offset;
810 blob_data = bl + bl_hdr->data_offset;
811 hsbl_code = blob_data + hsbl_desc->code_off;
812 hsbl_data = blob_data + hsbl_desc->data_off;
813 code_size = ALIGN(hsbl_desc->code_size, 256);
816 * Copy HS bootloader data
818 nvkm_falcon_load_dmem(falcon, hsbl_data, 0x0, hsbl_desc->data_size, 0);
820 /* Copy HS bootloader code to end of IMEM */
821 nvkm_falcon_load_imem(falcon, hsbl_code, falcon->code.limit - code_size,
822 code_size, hsbl_desc->start_tag, 0, false);
824 /* Generate the BL header */
825 acr->func->generate_hs_bl_desc(load_hdr, bl_desc, offset);
828 * Copy HS BL header where the HS descriptor expects it to be
830 nvkm_falcon_load_dmem(falcon, bl_desc, hsbl_desc->dmem_load_off,
834 return hsbl_desc->start_tag << 8;
838 acr_r352_shutdown(struct acr_r352 *acr, struct nvkm_secboot *sb)
840 struct nvkm_subdev *subdev = &sb->subdev;
843 /* Run the unload blob to unprotect the WPR region */
844 if (acr->unload_blob && sb->wpr_set) {
847 nvkm_debug(subdev, "running HS unload blob\n");
848 ret = sb->func->run_blob(sb, acr->unload_blob, sb->halt_falcon);
852 * Unload blob will return this error code - it is not an error
853 * and the expected behavior on RM as well
855 if (ret && ret != 0x1d) {
856 nvkm_error(subdev, "HS unload failed, ret 0x%08x\n", ret);
859 nvkm_debug(subdev, "HS unload blob completed\n");
862 for (i = 0; i < NVKM_SECBOOT_FALCON_END; i++)
863 acr->falcon_state[i] = NON_SECURE;
871 * Check if the WPR region has been indeed set by the ACR firmware, and
872 * matches where it should be.
875 acr_r352_wpr_is_set(const struct acr_r352 *acr, const struct nvkm_secboot *sb)
877 const struct nvkm_subdev *subdev = &sb->subdev;
878 const struct nvkm_device *device = subdev->device;
880 u64 wpr_range_lo, wpr_range_hi;
882 nvkm_wr32(device, 0x100cd4, 0x2);
883 wpr_lo = (nvkm_rd32(device, 0x100cd4) & ~0xff);
885 nvkm_wr32(device, 0x100cd4, 0x3);
886 wpr_hi = (nvkm_rd32(device, 0x100cd4) & ~0xff);
889 if (sb->wpr_size != 0) {
890 wpr_range_lo = sb->wpr_addr;
891 wpr_range_hi = wpr_range_lo + sb->wpr_size;
893 wpr_range_lo = acr->ls_blob->addr;
894 wpr_range_hi = wpr_range_lo + acr->ls_blob->size;
897 return (wpr_lo >= wpr_range_lo && wpr_lo < wpr_range_hi &&
898 wpr_hi > wpr_range_lo && wpr_hi <= wpr_range_hi);
902 acr_r352_bootstrap(struct acr_r352 *acr, struct nvkm_secboot *sb)
904 const struct nvkm_subdev *subdev = &sb->subdev;
905 unsigned long managed_falcons = acr->base.managed_falcons;
912 /* Make sure all blobs are ready */
913 ret = acr_r352_load_blobs(acr, sb);
917 nvkm_debug(subdev, "running HS load blob\n");
918 ret = sb->func->run_blob(sb, acr->load_blob, sb->boot_falcon);
919 /* clear halt interrupt */
920 nvkm_falcon_clear_interrupt(sb->boot_falcon, 0x10);
921 sb->wpr_set = acr_r352_wpr_is_set(acr, sb);
924 } else if (ret > 0) {
925 nvkm_error(subdev, "HS load failed, ret 0x%08x\n", ret);
928 nvkm_debug(subdev, "HS load blob completed\n");
929 /* WPR must be set at this point */
931 nvkm_error(subdev, "ACR blob completed but WPR not set!\n");
935 /* Run LS firmwares post_run hooks */
936 for_each_set_bit(falcon_id, &managed_falcons, NVKM_SECBOOT_FALCON_END) {
937 const struct acr_r352_ls_func *func =
938 acr->func->ls_func[falcon_id];
940 if (func->post_run) {
941 ret = func->post_run(&acr->base, sb);
951 * acr_r352_reset_nopmu - dummy reset method when no PMU firmware is loaded
953 * Reset is done by re-executing secure boot from scratch, with lazy bootstrap
954 * disabled. This has the effect of making all managed falcons ready-to-run.
957 acr_r352_reset_nopmu(struct acr_r352 *acr, struct nvkm_secboot *sb,
958 unsigned long falcon_mask)
964 * Perform secure boot each time we are called on FECS. Since only FECS
965 * and GPCCS are managed and started together, this ought to be safe.
967 if (!(falcon_mask & BIT(NVKM_SECBOOT_FALCON_FECS)))
970 ret = acr_r352_shutdown(acr, sb);
974 ret = acr_r352_bootstrap(acr, sb);
979 for_each_set_bit(falcon, &falcon_mask, NVKM_SECBOOT_FALCON_END) {
980 acr->falcon_state[falcon] = RESET;
986 * acr_r352_reset() - execute secure boot from the prepared state
988 * Load the HS bootloader and ask the falcon to run it. This will in turn
989 * load the HS firmware and run it, so once the falcon stops all the managed
990 * falcons should have their LS firmware loaded and be ready to run.
993 acr_r352_reset(struct nvkm_acr *_acr, struct nvkm_secboot *sb,
994 unsigned long falcon_mask)
996 struct acr_r352 *acr = acr_r352(_acr);
997 struct nvkm_msgqueue *queue;
999 bool wpr_already_set = sb->wpr_set;
1002 /* Make sure secure boot is performed */
1003 ret = acr_r352_bootstrap(acr, sb);
1007 /* No PMU interface? */
1008 if (!nvkm_secboot_is_managed(sb, _acr->boot_falcon)) {
1009 /* Redo secure boot entirely if it was already done */
1010 if (wpr_already_set)
1011 return acr_r352_reset_nopmu(acr, sb, falcon_mask);
1012 /* Else return the result of the initial invokation */
1017 switch (_acr->boot_falcon) {
1018 case NVKM_SECBOOT_FALCON_PMU:
1019 queue = sb->subdev.device->pmu->queue;
1021 case NVKM_SECBOOT_FALCON_SEC2:
1022 queue = sb->subdev.device->sec2->queue;
1028 /* Otherwise just ask the LS firmware to reset the falcon */
1029 for_each_set_bit(falcon, &falcon_mask, NVKM_SECBOOT_FALCON_END)
1030 nvkm_debug(&sb->subdev, "resetting %s falcon\n",
1031 nvkm_secboot_falcon_name[falcon]);
1032 ret = nvkm_msgqueue_acr_boot_falcons(queue, falcon_mask);
1034 nvkm_error(&sb->subdev, "error during falcon reset: %d\n", ret);
1037 nvkm_debug(&sb->subdev, "falcon reset done\n");
1043 acr_r352_fini(struct nvkm_acr *_acr, struct nvkm_secboot *sb, bool suspend)
1045 struct acr_r352 *acr = acr_r352(_acr);
1047 return acr_r352_shutdown(acr, sb);
1051 acr_r352_dtor(struct nvkm_acr *_acr)
1053 struct acr_r352 *acr = acr_r352(_acr);
1055 nvkm_gpuobj_del(&acr->unload_blob);
1057 if (_acr->boot_falcon != NVKM_SECBOOT_FALCON_PMU)
1058 kfree(acr->hsbl_unload_blob);
1059 kfree(acr->hsbl_blob);
1060 nvkm_gpuobj_del(&acr->load_blob);
1061 nvkm_gpuobj_del(&acr->ls_blob);
1066 const struct acr_r352_ls_func
1067 acr_r352_ls_fecs_func = {
1068 .load = acr_ls_ucode_load_fecs,
1069 .generate_bl_desc = acr_r352_generate_flcn_bl_desc,
1070 .bl_desc_size = sizeof(struct acr_r352_flcn_bl_desc),
1073 const struct acr_r352_ls_func
1074 acr_r352_ls_gpccs_func = {
1075 .load = acr_ls_ucode_load_gpccs,
1076 .generate_bl_desc = acr_r352_generate_flcn_bl_desc,
1077 .bl_desc_size = sizeof(struct acr_r352_flcn_bl_desc),
1078 /* GPCCS will be loaded using PRI */
1079 .lhdr_flags = LSF_FLAG_FORCE_PRIV_LOAD,
1085 * struct acr_r352_pmu_bl_desc - PMU DMEM bootloader descriptor
1086 * @dma_idx: DMA context to be used by BL while loading code/data
1087 * @code_dma_base: 256B-aligned Physical FB Address where code is located
1088 * @total_code_size: total size of the code part in the ucode
1089 * @code_size_to_load: size of the code part to load in PMU IMEM.
1090 * @code_entry_point: entry point in the code.
1091 * @data_dma_base: Physical FB address where data part of ucode is located
1092 * @data_size: Total size of the data portion.
1093 * @overlay_dma_base: Physical Fb address for resident code present in ucode
1094 * @argc: Total number of args
1095 * @argv: offset where args are copied into PMU's DMEM.
1097 * Structure used by the PMU bootloader to load the rest of the code
1099 struct acr_r352_pmu_bl_desc {
1102 u32 code_size_total;
1103 u32 code_size_to_load;
1104 u32 code_entry_point;
1107 u32 overlay_dma_base;
1112 u16 overlay_dma_base1;
1116 * acr_r352_generate_pmu_bl_desc() - populate a DMEM BL descriptor for PMU LS image
1120 acr_r352_generate_pmu_bl_desc(const struct nvkm_acr *acr,
1121 const struct ls_ucode_img *img, u64 wpr_addr,
1124 const struct ls_ucode_img_desc *pdesc = &img->ucode_desc;
1125 const struct nvkm_pmu *pmu = acr->subdev->device->pmu;
1126 struct acr_r352_pmu_bl_desc *desc = _desc;
1132 base = wpr_addr + img->ucode_off + pdesc->app_start_offset;
1133 addr_code = (base + pdesc->app_resident_code_offset) >> 8;
1134 addr_data = (base + pdesc->app_resident_data_offset) >> 8;
1135 addr_args = pmu->falcon->data.limit;
1136 addr_args -= NVKM_MSGQUEUE_CMDLINE_SIZE;
1138 desc->dma_idx = FALCON_DMAIDX_UCODE;
1139 desc->code_dma_base = lower_32_bits(addr_code);
1140 desc->code_dma_base1 = upper_32_bits(addr_code);
1141 desc->code_size_total = pdesc->app_size;
1142 desc->code_size_to_load = pdesc->app_resident_code_size;
1143 desc->code_entry_point = pdesc->app_imem_entry;
1144 desc->data_dma_base = lower_32_bits(addr_data);
1145 desc->data_dma_base1 = upper_32_bits(addr_data);
1146 desc->data_size = pdesc->app_resident_data_size;
1147 desc->overlay_dma_base = lower_32_bits(addr_code);
1148 desc->overlay_dma_base1 = upper_32_bits(addr_code);
1150 desc->argv = addr_args;
1153 static const struct acr_r352_ls_func
1154 acr_r352_ls_pmu_func = {
1155 .load = acr_ls_ucode_load_pmu,
1156 .generate_bl_desc = acr_r352_generate_pmu_bl_desc,
1157 .bl_desc_size = sizeof(struct acr_r352_pmu_bl_desc),
1158 .post_run = acr_ls_pmu_post_run,
1161 const struct acr_r352_func
1163 .fixup_hs_desc = acr_r352_fixup_hs_desc,
1164 .generate_hs_bl_desc = acr_r352_generate_hs_bl_desc,
1165 .hs_bl_desc_size = sizeof(struct acr_r352_flcn_bl_desc),
1166 .ls_ucode_img_load = acr_r352_ls_ucode_img_load,
1167 .ls_fill_headers = acr_r352_ls_fill_headers,
1168 .ls_write_wpr = acr_r352_ls_write_wpr,
1170 [NVKM_SECBOOT_FALCON_FECS] = &acr_r352_ls_fecs_func,
1171 [NVKM_SECBOOT_FALCON_GPCCS] = &acr_r352_ls_gpccs_func,
1172 [NVKM_SECBOOT_FALCON_PMU] = &acr_r352_ls_pmu_func,
1176 static const struct nvkm_acr_func
1177 acr_r352_base_func = {
1178 .dtor = acr_r352_dtor,
1179 .fini = acr_r352_fini,
1180 .load = acr_r352_load,
1181 .reset = acr_r352_reset,
1185 acr_r352_new_(const struct acr_r352_func *func,
1186 enum nvkm_secboot_falcon boot_falcon,
1187 unsigned long managed_falcons)
1189 struct acr_r352 *acr;
1192 /* Check that all requested falcons are supported */
1193 for_each_set_bit(i, &managed_falcons, NVKM_SECBOOT_FALCON_END) {
1194 if (!func->ls_func[i])
1195 return ERR_PTR(-ENOTSUPP);
1198 acr = kzalloc(sizeof(*acr), GFP_KERNEL);
1200 return ERR_PTR(-ENOMEM);
1202 acr->base.boot_falcon = boot_falcon;
1203 acr->base.managed_falcons = managed_falcons;
1204 acr->base.func = &acr_r352_base_func;
1211 acr_r352_new(unsigned long managed_falcons)
1213 return acr_r352_new_(&acr_r352_func, NVKM_SECBOOT_FALCON_PMU,