/* * Copyright (c) 2018-2020, Arm Limited. All rights reserved. * * SPDX-License-Identifier: BSD-3-Clause */ #include #include #include #include #include #include #include #include "sptool.h" #define PAGE_SIZE 4096 /* * Entry describing Secure Partition package. */ struct sp_pkg_info { /* Location of the files in the host's RAM. */ void *img_data, *pm_data; /* Size of the files. */ uint32_t img_size, pm_size; /* Location of the binary files inside the package output file */ uint32_t img_offset, pm_offset; }; /* * List of input provided by user */ struct arg_list { char *usr_input; struct arg_list *next; }; /* Align an address to a power-of-two boundary. */ static unsigned int align_to(unsigned int address, unsigned int boundary) { unsigned int mask = boundary - 1U; if ((address & mask) != 0U) return (address + boundary) & ~mask; else return address; } /* Allocate a memory area of 'size' bytes and zero it. */ static void *xzalloc(size_t size, const char *msg) { void *d; d = malloc(size); if (d == NULL) { fprintf(stderr, "error: malloc: %s\n", msg); exit(1); } memset(d, 0, size); return d; } /* * Write 'size' bytes from 'buf' into the specified file stream. * Exit the program on error. */ static void xfwrite(void *buf, size_t size, FILE *fp) { if (fwrite(buf, 1, size, fp) != size) { fprintf(stderr, "error: Failed to write to output file.\n"); exit(1); } } /* * Set the file position indicator for the specified file stream. * Exit the program on error. */ static void xfseek(FILE *fp, long offset, int whence) { if (fseek(fp, offset, whence) != 0) { fprintf(stderr, "error: Failed to set file to offset 0x%lx (%d).\n", offset, whence); perror(NULL); exit(1); } } /* * Free SP package structure */ static void cleanup(struct sp_pkg_info *sp) { if (sp != NULL) { if (sp->img_data != NULL) { free(sp->img_data); } if (sp->pm_data != NULL) { free(sp->pm_data); } free(sp); } } /* * Free argument list structure */ static void freelist(struct arg_list *head) { struct arg_list *tmp; while (head != NULL) { tmp = head; head = head->next; free(tmp); } } /* * Append user inputs in argument list structure */ static void append_user_input(struct arg_list **head, char *args) { struct arg_list *tmp = *head; if (tmp == NULL) { tmp = xzalloc(sizeof(struct arg_list), "Failed to allocate arg_list struct"); tmp->usr_input = args; *head = tmp; } else { while (tmp->next != NULL) { tmp = tmp->next; } tmp->next = xzalloc(sizeof(struct arg_list), "Failed to allocate arg_list struct"); tmp = tmp->next; tmp->usr_input = args; } } /* * Allocate a buffer big enough to store the content of the specified file and * load the file into it. Fill 'size' with the file size. Exit the program on * error. */ static void load_file(const char *path, void **ptr, uint32_t *size) { FILE *f = fopen(path, "rb"); if (f == NULL) { fprintf(stderr, "error: %s couldn't be opened.\n", path); exit(1); } xfseek(f, 0, SEEK_END); *size = ftell(f); if (*size == 0) { fprintf(stderr, "error: Size of %s is 0\n", path); exit(1); } rewind(f); *ptr = malloc(*size); if (*ptr == NULL) { fprintf(stderr, "error: Not enough memory to load %s\n", path); exit(1); } if (fread(*ptr, *size, 1, f) != 1) { fprintf(stderr, "error: Couldn't read %s\n", path); exit(1); } fclose(f); } /* * Parse the string containing input payloads and fill in the * SP Package data structure. */ static void load_sp_pm(char *path, struct sp_pkg_info **sp_out) { struct sp_pkg_info *sp_pkg; char *split_mark = strstr(path, ":"); *split_mark = '\0'; char *sp_path = path; char *pm_path = split_mark + 1; sp_pkg = xzalloc(sizeof(struct sp_pkg_info), "Failed to allocate sp_pkg_info struct"); load_file(pm_path, &sp_pkg->pm_data, &sp_pkg->pm_size); printf("\nLoaded SP Manifest file %s (%u bytes)\n", pm_path, sp_pkg->pm_size); load_file(sp_path, &sp_pkg->img_data, &sp_pkg->img_size); printf("Loaded SP Image file %s (%u bytes)\n", sp_path, sp_pkg->img_size); *sp_out = sp_pkg; } /* * Write SP package data structure into output file. */ static void output_write(const char *path, struct sp_pkg_info *sp, bool header) { struct sp_pkg_header sp_header_info; unsigned int file_ptr = 0; FILE *f = fopen(path, "wb"); if (f == NULL) { fprintf(stderr, "error: Failed to open %s\n", path); exit(1); } /* Reserve Header size */ if (header) { file_ptr = sizeof(struct sp_pkg_header); } /* Save partition manifest */ xfseek(f, file_ptr, SEEK_SET); printf("Writing SP Manifest at offset 0x%x (%u bytes)\n", file_ptr, sp->pm_size); sp->pm_offset = file_ptr; xfwrite(sp->pm_data, sp->pm_size, f); /* Save partition image aligned to Page size */ file_ptr = align_to((sp->pm_offset + sp->pm_size), PAGE_SIZE); xfseek(f, file_ptr, SEEK_SET); printf("Writing SP Image at offset 0x%x (%u bytes)\n", file_ptr, sp->img_size); sp->img_offset = file_ptr; xfwrite(sp->img_data, sp->img_size, f); /* Finally, write header, if needed */ if (header) { sp_header_info.magic = SECURE_PARTITION_MAGIC; sp_header_info.version = 0x1; sp_header_info.img_offset = sp->img_offset; sp_header_info.img_size = sp->img_size; sp_header_info.pm_offset = sp->pm_offset; sp_header_info.pm_size = sp->pm_size; xfseek(f, 0, SEEK_SET); printf("Writing package header\n"); xfwrite(&sp_header_info, sizeof(struct sp_pkg_header), f); } /* All information has been written now */ printf("\nsptool: Built Secure Partition blob %s\n", path); fclose(f); } static void usage(void) { printf("usage: sptool "); #ifdef VERSION printf(VERSION); #else /* If built from sptool directory, VERSION is not set. */ printf("version unknown"); #endif printf(" []\n\n"); printf("This tool takes as input set of image binary files and the\n" "partition manifest blobs as input and generates set of\n" "output package files\n" "Usage example: sptool -i sp1.bin:sp1.dtb -o sp1.pkg\n" " -i sp2.bin:sp2.dtb -o sp2.pkg ...\n\n"); printf("Commands supported:\n"); printf(" -o Set output file path.\n"); printf(" -i Add Secure Partition image and\n" " Manifest blob (specified in two paths\n" " separated by a colon).\n"); printf(" -n Generate package without header\n"); printf(" -h Show this message.\n"); exit(1); } int main(int argc, char *argv[]) { struct sp_pkg_info *sp_pkg = NULL; struct arg_list *in_head = NULL; struct arg_list *out_head = NULL; struct arg_list *in_list = NULL; struct arg_list *out_list = NULL; unsigned int match_counter = 0; bool need_header = true; int ch; if (argc <= 1) { fprintf(stderr, "error: File paths must be provided.\n\n"); usage(); return 1; } while ((ch = getopt(argc, argv, "hni:o:")) != -1) { switch (ch) { case 'i': append_user_input(&in_head, optarg); match_counter++; break; case 'o': append_user_input(&out_head, optarg); match_counter--; break; case 'n': need_header = false; break; case 'h': default: usage(); } } if (match_counter) { fprintf(stderr, "error: Input/Output count mismatch.\n\n"); freelist(in_head); freelist(out_head); usage(); return 1; } in_list = in_head; out_list = out_head; while (in_list != NULL) { load_sp_pm(in_list->usr_input, &sp_pkg); output_write(out_list->usr_input, sp_pkg, need_header); in_list = in_list->next; out_list = out_list->next; } argc -= optind; argv += optind; cleanup(sp_pkg); freelist(in_head); freelist(out_head); return 0; }