]>
Commit | Line | Data |
---|---|---|
83d290c5 | 1 | /* SPDX-License-Identifier: GPL-2.0+ */ |
a131c1f4 SG |
2 | /* |
3 | * (C) Copyright 2015 Google, Inc | |
4 | * Written by Simon Glass <sjg@chromium.org> | |
a131c1f4 SG |
5 | */ |
6 | ||
7 | #ifndef _RKCOMMON_H | |
8 | #define _RKCOMMON_H | |
9 | ||
10 | enum { | |
11 | RK_BLK_SIZE = 512, | |
ad972ac3 | 12 | RK_INIT_SIZE_ALIGN = 2048, |
3641339e JC |
13 | RK_INIT_OFFSET = 4, |
14 | RK_MAX_BOOT_SIZE = 512 << 10, | |
7bf274b9 JC |
15 | RK_SPL_HDR_START = RK_INIT_OFFSET * RK_BLK_SIZE, |
16 | RK_SPL_HDR_SIZE = 4, | |
17 | RK_SPL_START = RK_SPL_HDR_START + RK_SPL_HDR_SIZE, | |
18 | RK_IMAGE_HEADER_LEN = RK_SPL_START, | |
a131c1f4 SG |
19 | }; |
20 | ||
7bf274b9 JC |
21 | /** |
22 | * rkcommon_check_params() - check params | |
23 | * | |
24 | * @return 0 if OK, -1 if ERROR. | |
25 | */ | |
26 | int rkcommon_check_params(struct image_tool_params *params); | |
27 | ||
28 | /** | |
29 | * rkcommon_get_spl_hdr() - get 4-bytes spl hdr for a Rockchip boot image | |
30 | * | |
31 | * Rockchip's bootrom requires the spl loader to start with a 4-bytes | |
32 | * header. The content of this header depends on the chip type. | |
33 | */ | |
34 | const char *rkcommon_get_spl_hdr(struct image_tool_params *params); | |
35 | ||
36 | /** | |
37 | * rkcommon_get_spl_size() - get spl size for a Rockchip boot image | |
38 | * | |
39 | * Different chip may have different sram size. And if we want to jump | |
40 | * back to the bootrom after spl, we may need to reserve some sram space | |
41 | * for the bootrom. | |
42 | * The spl loader size should be sram size minus reserved size(if needed) | |
43 | */ | |
44 | int rkcommon_get_spl_size(struct image_tool_params *params); | |
45 | ||
a131c1f4 SG |
46 | /** |
47 | * rkcommon_set_header() - set up the header for a Rockchip boot image | |
48 | * | |
49 | * This sets up a 2KB header which can be interpreted by the Rockchip boot ROM. | |
50 | * | |
51 | * @buf: Pointer to header place (must be at least 2KB in size) | |
52 | * @file_size: Size of the file we want the boot ROM to load, in bytes | |
53 | * @return 0 if OK, -ENOSPC if too large | |
54 | */ | |
7bf274b9 JC |
55 | int rkcommon_set_header(void *buf, uint file_size, |
56 | struct image_tool_params *params); | |
a131c1f4 | 57 | |
2fb371ff PT |
58 | /** |
59 | * rkcommon_verify_header() - verify the header for a Rockchip boot image | |
60 | * | |
61 | * @buf: Pointer to the image file | |
62 | * @file_size: Size of entire bootable image file (incl. all padding) | |
63 | * @return 0 if OK | |
64 | */ | |
65 | int rkcommon_verify_header(unsigned char *buf, int size, | |
66 | struct image_tool_params *params); | |
67 | ||
68 | /** | |
69 | * rkcommon_print_header() - print the header for a Rockchip boot image | |
70 | * | |
71 | * This prints the header, spl_name and whether this is a SD/MMC or SPI image. | |
72 | * | |
73 | * @buf: Pointer to the image (can be a read-only file-mapping) | |
74 | */ | |
75 | void rkcommon_print_header(const void *buf); | |
76 | ||
cfbcdade HS |
77 | /** |
78 | * rkcommon_need_rc4_spl() - check if rc4 encoded spl is required | |
79 | * | |
80 | * Some socs cannot disable the rc4-encryption of the spl binary. | |
81 | * rc4 encryption is disabled normally except on socs that cannot | |
82 | * handle unencrypted binaries. | |
83 | * @return true or false depending on rc4 being required. | |
84 | */ | |
85 | bool rkcommon_need_rc4_spl(struct image_tool_params *params); | |
86 | ||
87 | /** | |
88 | * rkcommon_rc4_encode_spl() - encode the spl binary | |
89 | * | |
90 | * Encrypts the SPL binary using the generic rc4 key as required | |
91 | * by some socs. | |
92 | * | |
93 | * @buf: Pointer to the SPL data (header and SPL binary) | |
94 | * @offset: offset inside buf to start at | |
95 | * @size: number of bytes to encode | |
96 | */ | |
97 | void rkcommon_rc4_encode_spl(void *buf, unsigned int offset, unsigned int size); | |
98 | ||
111bcc4f PT |
99 | /** |
100 | * rkcommon_vrec_header() - allocate memory for the header | |
101 | * | |
102 | * @params: Pointer to the tool params structure | |
103 | * @tparams: Pointer tot the image type structure (for setting | |
104 | * the header and header_size) | |
366aad4d PT |
105 | * @alignment: Alignment (a power of two) that the image should be |
106 | * padded to (e.g. 512 if we want to align with SD/MMC | |
107 | * blocksizes or 2048 for the SPI format) | |
108 | * | |
109 | * @return bytes of padding required/added (does not include the header_size) | |
111bcc4f | 110 | */ |
366aad4d PT |
111 | int rkcommon_vrec_header(struct image_tool_params *params, |
112 | struct image_type_params *tparams, | |
113 | unsigned int alignment); | |
111bcc4f | 114 | |
a131c1f4 | 115 | #endif |