--- /dev/null
+================================================================
+ * Copyright 2018-2023 Shanghai StarFive Technology Co., Ltd.
+================================================================
+
+spl_tool license:
+
+Valid-License-Identifier: GPL-2.0
+Valid-License-Identifier: GPL-2.0-only
+Valid-License-Identifier: GPL-2.0+
+Valid-License-Identifier: GPL-2.0-or-later
+SPDX-URL: https://spdx.org/licenses/GPL-2.0.html
+Usage-Guide:
+ To use this license in source code, put one of the following SPDX
+ tag/value pairs into a comment according to the placement
+ guidelines in the licensing rules documentation.
+ For 'GNU General Public License (GPL) version 2 only' use:
+ SPDX-License-Identifier: GPL-2.0
+ or
+ SPDX-License-Identifier: GPL-2.0-only
+ For 'GNU General Public License (GPL) version 2 or any later version' use:
+ SPDX-License-Identifier: GPL-2.0+
+ or
+ SPDX-License-Identifier: GPL-2.0-or-later
+License-Text:
+
+ GNU GENERAL PUBLIC LICENSE
+ Version 2, June 1991
+
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.
+ 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+ Preamble
+
+ The licenses for most software are designed to take away your
+freedom to share and change it. By contrast, the GNU General Public
+License is intended to guarantee your freedom to share and change free
+software--to make sure the software is free for all its users. This
+General Public License applies to most of the Free Software
+Foundation's software and to any other program whose authors commit to
+using it. (Some other Free Software Foundation software is covered by
+the GNU Library General Public License instead.) You can apply it to
+your programs, too.
+
+ When we speak of free software, we are referring to freedom, not
+price. Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+this service if you wish), that you receive source code or can get it
+if you want it, that you can change the software or use pieces of it
+in new free programs; and that you know you can do these things.
+
+ To protect your rights, we need to make restrictions that forbid
+anyone to deny you these rights or to ask you to surrender the rights.
+These restrictions translate to certain responsibilities for you if you
+distribute copies of the software, or if you modify it.
+
+ For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must give the recipients all the rights that
+you have. You must make sure that they, too, receive or can get the
+source code. And you must show them these terms so they know their
+rights.
+
+ We protect your rights with two steps: (1) copyright the software, and
+(2) offer you this license which gives you legal permission to copy,
+distribute and/or modify the software.
+
+ Also, for each author's protection and ours, we want to make certain
+that everyone understands that there is no warranty for this free
+software. If the software is modified by someone else and passed on, we
+want its recipients to know that what they have is not the original, so
+that any problems introduced by others will not reflect on the original
+authors' reputations.
+
+ Finally, any free program is threatened constantly by software
+patents. We wish to avoid the danger that redistributors of a free
+program will individually obtain patent licenses, in effect making the
+program proprietary. To prevent this, we have made it clear that any
+patent must be licensed for everyone's free use or not licensed at all.
+
+ The precise terms and conditions for copying, distribution and
+modification follow.
+\f
+ GNU GENERAL PUBLIC LICENSE
+ TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+ 0. This License applies to any program or other work which contains
+a notice placed by the copyright holder saying it may be distributed
+under the terms of this General Public License. The "Program", below,
+refers to any such program or work, and a "work based on the Program"
+means either the Program or any derivative work under copyright law:
+that is to say, a work containing the Program or a portion of it,
+either verbatim or with modifications and/or translated into another
+language. (Hereinafter, translation is included without limitation in
+the term "modification".) Each licensee is addressed as "you".
+
+Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope. The act of
+running the Program is not restricted, and the output from the Program
+is covered only if its contents constitute a work based on the
+Program (independent of having been made by running the Program).
+Whether that is true depends on what the Program does.
+
+ 1. You may copy and distribute verbatim copies of the Program's
+source code as you receive it, in any medium, provided that you
+conspicuously and appropriately publish on each copy an appropriate
+copyright notice and disclaimer of warranty; keep intact all the
+notices that refer to this License and to the absence of any warranty;
+and give any other recipients of the Program a copy of this License
+along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and
+you may at your option offer warranty protection in exchange for a fee.
+
+ 2. You may modify your copy or copies of the Program or any portion
+of it, thus forming a work based on the Program, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+ a) You must cause the modified files to carry prominent notices
+ stating that you changed the files and the date of any change.
+
+ b) You must cause any work that you distribute or publish, that in
+ whole or in part contains or is derived from the Program or any
+ part thereof, to be licensed as a whole at no charge to all third
+ parties under the terms of this License.
+
+ c) If the modified program normally reads commands interactively
+ when run, you must cause it, when started running for such
+ interactive use in the most ordinary way, to print or display an
+ announcement including an appropriate copyright notice and a
+ notice that there is no warranty (or else, saying that you provide
+ a warranty) and that users may redistribute the program under
+ these conditions, and telling the user how to view a copy of this
+ License. (Exception: if the Program itself is interactive but
+ does not normally print such an announcement, your work based on
+ the Program is not required to print an announcement.)
+\f
+These requirements apply to the modified work as a whole. If
+identifiable sections of that work are not derived from the Program,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works. But when you
+distribute the same sections as part of a whole which is a work based
+on the Program, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Program.
+
+In addition, mere aggregation of another work not based on the Program
+with the Program (or with a work based on the Program) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+ 3. You may copy and distribute the Program (or a work based on it,
+under Section 2) in object code or executable form under the terms of
+Sections 1 and 2 above provided that you also do one of the following:
+
+ a) Accompany it with the complete corresponding machine-readable
+ source code, which must be distributed under the terms of Sections
+ 1 and 2 above on a medium customarily used for software interchange; or,
+
+ b) Accompany it with a written offer, valid for at least three
+ years, to give any third party, for a charge no more than your
+ cost of physically performing source distribution, a complete
+ machine-readable copy of the corresponding source code, to be
+ distributed under the terms of Sections 1 and 2 above on a medium
+ customarily used for software interchange; or,
+
+ c) Accompany it with the information you received as to the offer
+ to distribute corresponding source code. (This alternative is
+ allowed only for noncommercial distribution and only if you
+ received the program in object code or executable form with such
+ an offer, in accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for
+making modifications to it. For an executable work, complete source
+code means all the source code for all modules it contains, plus any
+associated interface definition files, plus the scripts used to
+control compilation and installation of the executable. However, as a
+special exception, the source code distributed need not include
+anything that is normally distributed (in either source or binary
+form) with the major components (compiler, kernel, and so on) of the
+operating system on which the executable runs, unless that component
+itself accompanies the executable.
+
+If distribution of executable or object code is made by offering
+access to copy from a designated place, then offering equivalent
+access to copy the source code from the same place counts as
+distribution of the source code, even though third parties are not
+compelled to copy the source along with the object code.
+\f
+ 4. You may not copy, modify, sublicense, or distribute the Program
+except as expressly provided under this License. Any attempt
+otherwise to copy, modify, sublicense or distribute the Program is
+void, and will automatically terminate your rights under this License.
+However, parties who have received copies, or rights, from you under
+this License will not have their licenses terminated so long as such
+parties remain in full compliance.
+
+ 5. You are not required to accept this License, since you have not
+signed it. However, nothing else grants you permission to modify or
+distribute the Program or its derivative works. These actions are
+prohibited by law if you do not accept this License. Therefore, by
+modifying or distributing the Program (or any work based on the
+Program), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Program or works based on it.
+
+ 6. Each time you redistribute the Program (or any work based on the
+Program), the recipient automatically receives a license from the
+original licensor to copy, distribute or modify the Program subject to
+these terms and conditions. You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties to
+this License.
+
+ 7. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License. If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Program at all. For example, if a patent
+license would not permit royalty-free redistribution of the Program by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Program.
+
+If any portion of this section is held invalid or unenforceable under
+any particular circumstance, the balance of the section is intended to
+apply and the section as a whole is intended to apply in other
+circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system, which is
+implemented by public license practices. Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+\f
+ 8. If the distribution and/or use of the Program is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Program under this License
+may add an explicit geographical distribution limitation excluding
+those countries, so that distribution is permitted only in or among
+countries not thus excluded. In such case, this License incorporates
+the limitation as if written in the body of this License.
+
+ 9. The Free Software Foundation may publish revised and/or new versions
+of the General Public License from time to time. Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+Each version is given a distinguishing version number. If the Program
+specifies a version number of this License which applies to it and "any
+later version", you have the option of following the terms and conditions
+either of that version or of any later version published by the Free
+Software Foundation. If the Program does not specify a version number of
+this License, you may choose any version ever published by the Free Software
+Foundation.
+
+ 10. If you wish to incorporate parts of the Program into other free
+programs whose distribution conditions are different, write to the author
+to ask for permission. For software which is copyrighted by the Free
+Software Foundation, write to the Free Software Foundation; we sometimes
+make exceptions for this. Our decision will be guided by the two goals
+of preserving the free status of all derivatives of our free software and
+of promoting the sharing and reuse of software generally.
+
+ NO WARRANTY
+
+ 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
+OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
+TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
+PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
+REPAIR OR CORRECTION.
+
+ 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
+TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
+YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
+PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGES.
+
+ END OF TERMS AND CONDITIONS
+\f
+ How to Apply These Terms to Your New Programs
+
+ If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+ To do so, attach the following notices to the program. It is safest
+to attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+ <one line to give the program's name and a brief idea of what it does.>
+ Copyright (C) <year> <name of author>
+
+ This program is free software; you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation; either version 2 of the License, or
+ (at your option) any later version.
+
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with this program; if not, write to the Free Software
+ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+
+
+Also add information on how to contact you by electronic and paper mail.
+
+If the program is interactive, make it output a short notice like this
+when it starts in an interactive mode:
+
+ Gnomovision version 69, Copyright (C) year name of author
+ Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+ This is free software, and you are welcome to redistribute it
+ under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License. Of course, the commands you use may
+be called something other than `show w' and `show c'; they could even be
+mouse-clicks or menu items--whatever suits your program.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the program, if
+necessary. Here is a sample; alter the names:
+
+ Yoyodyne, Inc., hereby disclaims all copyright interest in the program
+ `Gnomovision' (which makes passes at compilers) written by James Hacker.
+
+ <signature of Ty Coon>, 1 April 1989
+ Ty Coon, President of Vice
+
+This General Public License does not permit incorporating your program into
+proprietary programs. If your program is a subroutine library, you may
+consider it more useful to permit linking proprietary applications with the
+library. If this is what you want to do, use the GNU Library General
+Public License instead of this License.
--- /dev/null
+// SPDX-License-Identifier: GPL-2.0+
+#define _GNU_SOURCE
+#include <sys/types.h>
+#include <sys/stat.h>
+#include <fcntl.h>
+#include <getopt.h>
+#include <stdio.h>
+#include <stdlib.h>
+#include <stdint.h>
+#include <string.h>
+#include <stdbool.h>
+#include <unistd.h>
+#include <endian.h>
+#include <errno.h>
+#include <limits.h>
+
+#define NOSIZE ((size_t)-1)
+
+extern uint32_t crc32(uint32_t iv, uint32_t sv, const void *data, size_t n);
+extern uint32_t crc32_final(uint32_t iv);
+
+/* all uint32_t ends up little endian in output header */
+struct __attribute__((__packed__)) ubootsplhdr {
+ uint32_t sofs; /* offset of spl header: 64+256+256 = 0x240 */
+ uint32_t bofs; /* SBL_BAK_OFFSET: Offset of backup SBL from Flash info start (from input_sbl_normal.cfg) */
+ uint8_t zro2[636];
+ uint32_t vers; /* version: shall be 0x01010101
+ * (from https://doc-en.rvspace.org/VisionFive2/SWTRM/VisionFive2_SW_TRM/create_spl.html) */
+ uint32_t fsiz; /* u-boot-spl.bin size in bytes */
+ uint32_t res1; /* Offset from HDR to SPL_IMAGE, 0x400 (00 04 00 00) currently */
+ uint32_t crcs; /* CRC32 of u-boot-spl.bin */
+ uint8_t zro3[364];
+};
+
+struct hdr_conf_t {
+ const char name[PATH_MAX];
+ uint32_t vers;
+ uint32_t bofs;
+ bool creat_hdr_flag;
+ bool fixed_img_hdr_flag;
+};
+
+static struct ubootsplhdr ubsplhdr;
+static struct ubootsplhdr imghdr;
+static struct hdr_conf_t g_hdr_conf;
+
+static char ubootspl[181072-sizeof(struct ubootsplhdr)+1];
+static char outpath[PATH_MAX];
+
+#define DEFVERSID 0x01010101
+#define DEFBACKUP 0x200000U
+#define CRCFAILED 0x5A5A5A5A
+
+static void xerror(int errnoval, const char *s)
+{
+ if (errnoval) perror(s);
+ else fprintf(stderr, "%s\n", s);
+ exit(2);
+}
+
+static void usage(void)
+{
+ const char help[] = {
+ "\n StarFive spl tool\n\n"
+ "usage:\n"
+ "-c, --creat-splhdr creat spl hdr\n"
+ "-i, --fix-imghdr fixed img hdr for emmc boot.\n"
+ "-a, --spl-bak-addr set backup SPL addr(default: 0x200000)\n"
+ "-v, --version set version (default: 0x01010101)\n"
+ "-f, --file input file name(spl/img)\n"
+ "-h, --help show this information\n"
+ };
+ puts(help);
+}
+
+static int parse_args(int argc, char **argv)
+{
+ uint32_t v;
+
+ enum {
+ OPTION_CREAD_HDR = 1,
+ OPTION_FIXED_HDR,
+ OPTION_SBL_BAK_OFFSET,
+ OPTION_VERSION,
+ OPTION_FILENAME,
+ OPTION_HELP,
+ };
+
+ static struct option long_options[] =
+ {
+ {"creat-splhdr" , no_argument, NULL, OPTION_CREAD_HDR},
+ {"fix-imghdr" , no_argument, NULL, OPTION_FIXED_HDR},
+ {"spl-bak-addr" , required_argument, NULL, OPTION_SBL_BAK_OFFSET},
+ {"version", required_argument, NULL, OPTION_VERSION},
+ {"file", required_argument, NULL, OPTION_FILENAME},
+ {"help", no_argument, NULL, OPTION_HELP},
+ {0, 0, 0, 0}
+ };
+
+ while (1)
+ {
+ /* getopt_long stores the option index here. */
+ int option_index = 0;
+
+ int c = getopt_long(argc, argv, "cio:v:f:h", long_options, &option_index);
+
+ /* Detect the end of the options. */
+ if (c == -1)
+ break;
+
+ switch (c) {
+ case 0:
+ /* If this option set a flag, do nothing else now. */
+ if (long_options[option_index].flag != 0)
+ break;
+
+ case 'c':
+ case OPTION_CREAD_HDR:
+ g_hdr_conf.creat_hdr_flag = true;
+ g_hdr_conf.fixed_img_hdr_flag = false;
+ break;
+
+ case 'i':
+ case OPTION_FIXED_HDR:
+ g_hdr_conf.fixed_img_hdr_flag = true;
+ g_hdr_conf.creat_hdr_flag = false;
+ break;
+
+ case 'a':
+ case OPTION_SBL_BAK_OFFSET:
+ v = (uint32_t)strtoul(optarg, NULL, 16);
+ v = htole32(v);
+ g_hdr_conf.bofs = v;
+ break;
+
+ case 'v':
+ case OPTION_VERSION:
+ v = (uint32_t)strtoul(optarg, NULL, 16);
+ v = htole32(v);
+ g_hdr_conf.vers = v;
+ break;
+
+ case 'f':
+ case OPTION_FILENAME:
+ strcpy((char*)g_hdr_conf.name, optarg);
+ break;
+
+ case 'h':
+ case OPTION_HELP:
+ usage();
+ break;
+
+ default:
+ usage();
+ break;
+ }
+ }
+ return 0;
+}
+
+int spl_creat_hdr(struct hdr_conf_t *conf)
+{
+ int fd;
+ uint32_t v;
+ size_t sz;
+
+ if (!conf->creat_hdr_flag)
+ return 0;
+
+ ubsplhdr.sofs = htole32(0x240U);
+ ubsplhdr.res1 = htole32(0x400U);
+ ubsplhdr.bofs = conf->bofs ? conf->bofs : htole32(DEFBACKUP);
+ ubsplhdr.vers = conf->vers ? conf->vers : htole32(DEFVERSID);
+
+ printf("ubsplhdr.sofs:%#x, ubsplhdr.bofs:%#x, ubsplhdr.vers:%#x name:%s\n",
+ ubsplhdr.sofs, ubsplhdr.bofs, ubsplhdr.vers, conf->name);
+
+ fd = open(conf->name, O_RDONLY);
+ if (fd == -1) xerror(errno, conf->name);
+
+ sz = (size_t)read(fd, ubootspl, sizeof(ubootspl));
+ if (sz == NOSIZE) xerror(errno, conf->name);
+ if (sz >= (sizeof(ubootspl)))
+ xerror(0, "File too large! Please rebuild your SPL with -Os. Maximum allowed size is 180048 bytes.");
+ v = htole32((uint32_t)sz);
+ ubsplhdr.fsiz = v;
+
+ close(fd);
+ snprintf(outpath, sizeof(outpath), "%s.normal.out", conf->name);
+ fd = creat(outpath, 0666);
+ if (fd == -1) xerror(errno, outpath);
+
+ v = crc32(~0U, 0x04c11db7U, ubootspl, sz);
+ v = crc32_final(v);
+ v = htole32(v);
+ ubsplhdr.crcs = v;
+
+ write(fd, &ubsplhdr, sizeof(struct ubootsplhdr));
+ write(fd, ubootspl, sz);
+
+ close(fd);
+
+ printf("SPL written to %s successfully.\n", outpath);
+
+ return 0;
+}
+
+int img_fixed_hdr(struct hdr_conf_t *conf)
+{
+ int fd;
+ size_t sz;
+
+ if (!conf->fixed_img_hdr_flag)
+ return 0;
+
+ fd = open(conf->name, O_RDWR);
+ if (fd == -1) xerror(errno, conf->name);
+
+ sz = (size_t)read(fd, &imghdr, sizeof(imghdr));
+ if (sz == NOSIZE) xerror(errno, conf->name);
+
+ /* When starting with emmc, bootrom will read 0x0 instead of partition 0. (Known issues).
+ Read GPT PMBR+Header, then write the backup address at 0x4, and write the wrong CRC
+ check value at 0x290, so that bootrom CRC check fails and jump to the backup address
+ to load the real spl. */
+
+ imghdr.bofs = conf->bofs ? conf->bofs : htole32(DEFBACKUP);
+ imghdr.crcs = htole32(CRCFAILED);
+
+ lseek(fd, 0x0, SEEK_SET);
+ write(fd, &imghdr, sizeof(imghdr));
+ close(fd);
+
+ printf("IMG %s fixed hdr successfully.\n", conf->name);
+
+ return 0;
+}
+
+int main(int argc, char **argv)
+{
+ parse_args(argc, argv);
+ spl_creat_hdr(&g_hdr_conf);
+ img_fixed_hdr(&g_hdr_conf);
+}
projects / platform / kernel / u-boot.git / commitdiff