├── .gitignore ├── Makefile ├── esptool2.sln ├── readme.txt ├── esptool2.h ├── esptool2_elf.h ├── elf.h ├── esptool2.vcxproj ├── esptool2_elf.c ├── esptool2.c └── license.txt /.gitignore: -------------------------------------------------------------------------------- 1 | *.o 2 | *.exe 3 | *.user 4 | *.sdf 5 | *.opensdf 6 | *.suo 7 | esptool 8 | Debug 9 | Release 10 | ipch 11 | esptool2 12 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | # 2 | # Makefile for esptool2 3 | # https://github.com/raburton/esp8266 4 | # 5 | 6 | CFLAGS = -O2 -Wall 7 | CC = gcc 8 | LD = gcc 9 | 10 | all: esptool2 11 | 12 | esptool2.o: esptool2.c esptool2.h esptool2_elf.h elf.h 13 | @echo "CC $<" 14 | $(CC) $(CFLAGS) -c $< -o $@ 15 | 16 | esptool2_elf.o: esptool2_elf.c esptool2.h esptool2_elf.h elf.h 17 | @echo "CC $<" 18 | $(CC) $(CFLAGS) -c $< -o $@ 19 | 20 | esptool2: esptool2.o esptool2_elf.o 21 | @echo "LD $@" 22 | $(LD) -o $@ $^ 23 | 24 | clean: 25 | @echo "RM *.o esptool2 esptool2.exe" 26 | @rm -f *.o 27 | @rm -f esptool2 esptool2.exe 28 | -------------------------------------------------------------------------------- /esptool2.sln: -------------------------------------------------------------------------------- 1 | 2 | Microsoft Visual Studio Solution File, Format Version 11.00 3 | # Visual Studio 2010 4 | Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "esptool2", "esptool2.vcxproj", "{F8903074-16A4-431E-BBEF-A8437E0ADE25}" 5 | EndProject 6 | Global 7 | GlobalSection(SolutionConfigurationPlatforms) = preSolution 8 | Debug|Win32 = Debug|Win32 9 | Release|Win32 = Release|Win32 10 | EndGlobalSection 11 | GlobalSection(ProjectConfigurationPlatforms) = postSolution 12 | {F8903074-16A4-431E-BBEF-A8437E0ADE25}.Debug|Win32.ActiveCfg = Debug|Win32 13 | {F8903074-16A4-431E-BBEF-A8437E0ADE25}.Debug|Win32.Build.0 = Debug|Win32 14 | {F8903074-16A4-431E-BBEF-A8437E0ADE25}.Release|Win32.ActiveCfg = Release|Win32 15 | {F8903074-16A4-431E-BBEF-A8437E0ADE25}.Release|Win32.Build.0 = Release|Win32 16 | EndGlobalSection 17 | GlobalSection(SolutionProperties) = preSolution 18 | HideSolutionNode = FALSE 19 | EndGlobalSection 20 | EndGlobal 21 | -------------------------------------------------------------------------------- /readme.txt: -------------------------------------------------------------------------------- 1 | Esptool2 2 | richardaburton@gmail.com 3 | http://richard.burtons.org/ 4 | 5 | Esptool2 is a tool for creating rom images for the ESP8266. It is an alternative 6 | to using the SDK supplied shell script/Makefile/python script combo, which is a 7 | mess. It was inspired by the windows esptool v0.0.2 by mamalala and found on 8 | www.esp8266.com but made somewhat simpler in code and usage. It also adds 9 | support for boot loader v1.2+ rom types, which was the main reason I wrote it. 10 | 11 | It was written for my own use and the name was simply to distinguish it for the 12 | other version on my system. The 2 is not intended to imply it is better than the 13 | original. The original has since been updated to v0.0.3 which can write to the 14 | flash, but I currently have no intention to add that to esptool2, it is purely a 15 | rom creating utility. It has become an integral part of my build process now and 16 | has added functionality needed for building the rBoot boot loader. Since I have 17 | released rBoot I needed to release this as well. 18 | 19 | Run tool for full usage instructions, or look at the code. 20 | -------------------------------------------------------------------------------- /esptool2.h: -------------------------------------------------------------------------------- 1 | /********************************************************************************** 2 | * 3 | * Copyright (c) 2015 Richard A Burton 4 | * 5 | * This file is part of esptool2. 6 | * 7 | * esptool2 is free software: you can redistribute it and/or modify 8 | * it under the terms of the GNU General Public License as published by 9 | * the Free Software Foundation, either version 3 of the License, or 10 | * (at your option) any later version. 11 | * 12 | * esptool2 is distributed in the hope that it will be useful, 13 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | * GNU General Public License for more details. 16 | * 17 | * You should have received a copy of the GNU General Public License 18 | * along with esptool2. If not, see . 19 | * 20 | **********************************************************************************/ 21 | 22 | #ifndef ESPTOOL2_H 23 | #define ESPTOOL2_H 24 | 25 | #include 26 | #include 27 | 28 | void debug( const char* format, ... ); 29 | void print( const char* format, ... ); 30 | void error( const char* format, ... ); 31 | 32 | #endif 33 | -------------------------------------------------------------------------------- /esptool2_elf.h: -------------------------------------------------------------------------------- 1 | /********************************************************************************** 2 | * 3 | * Copyright (c) 2015 Richard A Burton 4 | * 5 | * This file is part of esptool2. 6 | * 7 | * esptool2 is free software: you can redistribute it and/or modify 8 | * it under the terms of the GNU General Public License as published by 9 | * the Free Software Foundation, either version 3 of the License, or 10 | * (at your option) any later version. 11 | * 12 | * esptool2 is distributed in the hope that it will be useful, 13 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | * GNU General Public License for more details. 16 | * 17 | * You should have received a copy of the GNU General Public License 18 | * along with esptool2. If not, see . 19 | * 20 | **********************************************************************************/ 21 | 22 | #ifndef ESPTOOL2_ELF_H 23 | #define ESPTOOL2_ELF_H 24 | 25 | #include 26 | 27 | #include "elf.h" 28 | 29 | typedef struct { 30 | Elf32_Off offset; 31 | Elf32_Addr address; 32 | Elf32_Word size; 33 | char *name; 34 | } MyElf_Section; 35 | 36 | typedef struct { 37 | FILE *fd; 38 | Elf32_Ehdr header; 39 | char *strings; 40 | MyElf_Section *sections; 41 | } MyElf_File; 42 | 43 | MyElf_File* LoadElf(char *infile); 44 | void UnloadElf(MyElf_File *e_object); 45 | MyElf_Section* GetElfSection(MyElf_File *e_object, char *name); 46 | unsigned char* GetElfSectionData(MyElf_File *e_object, MyElf_Section *section); 47 | 48 | #endif 49 | -------------------------------------------------------------------------------- /elf.h: -------------------------------------------------------------------------------- 1 | // Based on a small portion of ELF.h from LLVM 2 | 3 | //===-- llvm/Support/ELF.h - ELF constants and data structures --*- C++ -*-===// 4 | // 5 | // The LLVM Compiler Infrastructure 6 | // 7 | // This file is distributed under the University of Illinois Open Source 8 | // License. 9 | // 10 | //===----------------------------------------------------------------------===// 11 | // 12 | // This header contains common, non-processor-specific data structures and 13 | // constants for the ELF file format. 14 | // 15 | // The details of the ELF32 bits in this file are largely based on the Tool 16 | // Interface Standard (TIS) Executable and Linking Format (ELF) Specification 17 | // Version 1.2, May 1995. The ELF64 stuff is based on ELF-64 Object File Format 18 | // Version 1.5, Draft 2, May 1998 as well as OpenBSD header files. 19 | // 20 | //===----------------------------------------------------------------------===// 21 | 22 | #ifndef ELF_H 23 | #define ELF_H 24 | 25 | typedef uint32_t Elf32_Addr; // Program address 26 | typedef uint32_t Elf32_Off; // File offset 27 | typedef uint16_t Elf32_Half; 28 | typedef uint32_t Elf32_Word; 29 | typedef int32_t Elf32_Sword; 30 | 31 | // e_ident size and indices 32 | enum { 33 | EI_MAG0 = 0, // File identification index. 34 | EI_MAG1 = 1, // File identification index. 35 | EI_MAG2 = 2, // File identification index. 36 | EI_MAG3 = 3, // File identification index. 37 | EI_CLASS = 4, // File class. 38 | EI_DATA = 5, // Data encoding. 39 | EI_VERSION = 6, // File version. 40 | EI_OSABI = 7, // OS/ABI identification. 41 | EI_ABIVERSION = 8, // ABI version. 42 | EI_PAD = 9, // Start of padding bytes. 43 | EI_NIDENT = 16 // Number of bytes in e_ident. 44 | }; 45 | 46 | typedef struct { 47 | unsigned char e_ident[EI_NIDENT]; // ELF Identification bytes 48 | Elf32_Half e_type; // Type of file (see ET_* below) 49 | Elf32_Half e_machine; // Required architecture for this file (see EM_*) 50 | Elf32_Word e_version; // Must be equal to 1 51 | Elf32_Addr e_entry; // Address to jump to in order to start program 52 | Elf32_Off e_phoff; // Program header table's file offset, in bytes 53 | Elf32_Off e_shoff; // Section header table's file offset, in bytes 54 | Elf32_Word e_flags; // Processor-specific flags 55 | Elf32_Half e_ehsize; // Size of ELF header, in bytes 56 | Elf32_Half e_phentsize; // Size of an entry in the program header table 57 | Elf32_Half e_phnum; // Number of entries in the program header table 58 | Elf32_Half e_shentsize; // Size of an entry in the section header table 59 | Elf32_Half e_shnum; // Number of entries in the section header table 60 | Elf32_Half e_shstrndx; // Sect hdr table index of sect name string table 61 | } Elf32_Ehdr; 62 | 63 | typedef struct { 64 | Elf32_Word sh_name; // Section name (index into string table) 65 | Elf32_Word sh_type; // Section type (SHT_*) 66 | Elf32_Word sh_flags; // Section flags (SHF_*) 67 | Elf32_Addr sh_addr; // Address where section is to be loaded 68 | Elf32_Off sh_offset; // File offset of section data, in bytes 69 | Elf32_Word sh_size; // Size of section, in bytes 70 | Elf32_Word sh_link; // Section type-specific header table index link 71 | Elf32_Word sh_info; // Section type-specific extra information 72 | Elf32_Word sh_addralign; // Section address alignment 73 | Elf32_Word sh_entsize; // Size of records contained within the section 74 | } Elf32_Shdr; 75 | 76 | #endif 77 | -------------------------------------------------------------------------------- /esptool2.vcxproj: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | Debug 6 | Win32 7 | 8 | 9 | Release 10 | Win32 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | {F8903074-16A4-431E-BBEF-A8437E0ADE25} 24 | Win32Proj 25 | esptool2 26 | 27 | 28 | 29 | Application 30 | true 31 | Unicode 32 | 33 | 34 | Application 35 | false 36 | true 37 | Unicode 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | true 51 | D:\Projects\ESP8266\esptool2\include;$(IncludePath) 52 | 53 | 54 | false 55 | D:\Projects\ESP8266\esptool2\include;$(IncludePath) 56 | 57 | 58 | 59 | 60 | 61 | Level3 62 | Disabled 63 | WIN32;_DEBUG;_CONSOLE;_CRT_SECURE_NO_WARNINGS;%(PreprocessorDefinitions) 64 | 65 | 66 | Console 67 | true 68 | 69 | 70 | 71 | 72 | Level3 73 | 74 | 75 | MaxSpeed 76 | true 77 | true 78 | WIN32;NDEBUG;_CONSOLE;_CRT_SECURE_NO_WARNINGS;%(PreprocessorDefinitions) 79 | 80 | 81 | Console 82 | true 83 | true 84 | true 85 | 86 | 87 | 88 | 89 | 90 | -------------------------------------------------------------------------------- /esptool2_elf.c: -------------------------------------------------------------------------------- 1 | /********************************************************************************** 2 | * 3 | * Copyright (c) 2015 Richard A Burton 4 | * 5 | * This file is part of esptool2. 6 | * 7 | * esptool2 is free software: you can redistribute it and/or modify 8 | * it under the terms of the GNU General Public License as published by 9 | * the Free Software Foundation, either version 3 of the License, or 10 | * (at your option) any later version. 11 | * 12 | * esptool2 is distributed in the hope that it will be useful, 13 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | * GNU General Public License for more details. 16 | * 17 | * You should have received a copy of the GNU General Public License 18 | * along with esptool2. If not, see . 19 | * 20 | **********************************************************************************/ 21 | 22 | #include 23 | #include 24 | 25 | #include "esptool2.h" 26 | #include "esptool2_elf.h" 27 | 28 | // Find a section in an elf file by name. 29 | // Returns pointer to section if found, else returns zero. 30 | // Does not produce any messages. 31 | MyElf_Section* GetElfSection(MyElf_File *elf, char *name) { 32 | 33 | int i; 34 | 35 | for(i = 0; i < elf->header.e_shnum - 1; i++) { 36 | if(!strcmp(name, elf->sections[i].name)) { 37 | debug("Found section '%s'.\r\n", name); 38 | return &elf->sections[i]; 39 | } 40 | } 41 | 42 | debug("Could not find section '%s'.\r\n", name); 43 | return 0; 44 | } 45 | 46 | // Reads an elf section (actual data) from the elf file. 47 | // Returns a pointer to newly allocated memory (or zero on error), 48 | // which should be freed by the caller when finished with. 49 | // Produces error message on failure (so caller doesn't need to). 50 | unsigned char* GetElfSectionData(MyElf_File *elf, MyElf_Section *section) { 51 | 52 | unsigned char *data = 0; 53 | 54 | if (section->size && section->offset) { 55 | 56 | data = (unsigned char*)malloc(section->size); 57 | if(!data) { 58 | error("Error: Out of memory!\r\n"); 59 | return 0; 60 | } 61 | 62 | if(fseek(elf->fd, section->offset, SEEK_SET) || 63 | fread(data, 1, section->size, elf->fd) != section->size) { 64 | error("Error: Can't read section '%s' data from elf file.\r\n", section->name); 65 | free(data); 66 | return 0; 67 | } 68 | 69 | } else { 70 | error("Error: Section '%s' has no data to read.\r\n", section->name); 71 | } 72 | 73 | return data; 74 | } 75 | 76 | // Opens an elf file and reads the string table and file & section headers. 77 | // Returns a pointer to a MyElf_File structure (or zero on error). 78 | // UnloadElf should be called to dispose of the MyElf_File structure. 79 | // Produces error message on failure (so caller doesn't need to). 80 | MyElf_File* LoadElf(char *infile) { 81 | 82 | int i; 83 | MyElf_File *elf; 84 | Elf32_Shdr temp; 85 | 86 | // allocate the elf structure 87 | elf = (MyElf_File*)malloc(sizeof(MyElf_File)); 88 | if(!elf) { 89 | error("Error: Out of memory!\r\n"); 90 | goto error_exit; 91 | } 92 | memset(elf, 0, sizeof(MyElf_File)); 93 | 94 | // open the file 95 | elf->fd = fopen(infile, "rb"); 96 | if(!elf->fd) { 97 | error("Error: Can't open elf file '%s'.\r\n", infile); 98 | goto error_exit; 99 | } 100 | 101 | // read the header 102 | if(fread(&elf->header, 1, sizeof(Elf32_Ehdr), elf->fd) != sizeof(Elf32_Ehdr)) { 103 | error("Error: Can't read elf file header.\r\n"); 104 | goto error_exit; 105 | } 106 | 107 | // check the file header 108 | if (memcmp(elf->header.e_ident, "\x7f" "ELF", 4)) { 109 | error("Error: Input files doesn't look like an elf file (bad header).\r\n"); 110 | goto error_exit; 111 | } 112 | 113 | // is there a string table section (we need one) 114 | if(!elf->header.e_shstrndx) { 115 | error("Error: Elf file does not contain a string table.\r\n"); 116 | goto error_exit; 117 | } 118 | 119 | // get the string table section header 120 | if(fseek(elf->fd, elf->header.e_shoff + (elf->header.e_shentsize * elf->header.e_shstrndx), SEEK_SET) || 121 | fread(&temp, 1, sizeof(Elf32_Shdr), elf->fd) != sizeof(Elf32_Shdr)) { 122 | 123 | error("Error: Can't read string table section from elf file.\r\n"); 124 | goto error_exit; 125 | } 126 | 127 | // read the actual string table 128 | if(!temp.sh_size) { 129 | error("Error: Elf file contains an empty string table.\r\n"); 130 | goto error_exit; 131 | } 132 | elf->strings = (char*)malloc(temp.sh_size); 133 | if(!elf->strings) { 134 | error("Error: Out of memory!\r\n"); 135 | goto error_exit; 136 | } 137 | if(fseek(elf->fd, temp.sh_offset, SEEK_SET) || 138 | fread(elf->strings, 1, temp.sh_size, elf->fd) != temp.sh_size) { 139 | error("Error: Failed to read string stable from elf file.\r\n"); 140 | goto error_exit; 141 | } 142 | 143 | // read section headers 144 | elf->sections = (MyElf_Section*)malloc(sizeof(MyElf_Section) * elf->header.e_shnum); 145 | if(!elf->sections) { 146 | error("Error: Out of memory!\r\n"); 147 | goto error_exit; 148 | } 149 | for(i = 1; i < elf->header.e_shnum; i++) { 150 | if(fseek(elf->fd, elf->header.e_shoff + (elf->header.e_shentsize * i), SEEK_SET) 151 | || fread(&temp, 1, sizeof(Elf32_Shdr), elf->fd) != sizeof(Elf32_Shdr)) { 152 | error("Error: Can't read section %d from elf file.\r\n", i); 153 | break; 154 | } 155 | debug("Read section %d '%s'.\r\n", i, elf->strings + temp.sh_name); 156 | elf->sections[i-1].address = temp.sh_addr; 157 | elf->sections[i-1].offset = temp.sh_offset; 158 | elf->sections[i-1].size = temp.sh_size; 159 | elf->sections[i-1].name = elf->strings + temp.sh_name; 160 | } 161 | 162 | return elf; 163 | 164 | error_exit: 165 | if (elf) { 166 | if (elf->fd) fclose(elf->fd); 167 | if (elf->strings) free(elf->strings); 168 | free(elf); 169 | } 170 | return 0; 171 | 172 | } 173 | 174 | // Close an elf file and dispose of the MyElf_File structure. 175 | void UnloadElf(MyElf_File *elf) { 176 | if (elf) { 177 | debug("Unloading elf file.\r\n"); 178 | if(elf->fd) fclose(elf->fd); 179 | if(elf->strings) free(elf->strings); 180 | if(elf->sections) free(elf->sections); 181 | free(elf); 182 | } 183 | } 184 | -------------------------------------------------------------------------------- /esptool2.c: -------------------------------------------------------------------------------- 1 | /********************************************************************************** 2 | * 3 | * Copyright (c) 2015 Richard A Burton 4 | * 5 | * This file is part of esptool2. 6 | * 7 | * esptool2 is free software: you can redistribute it and/or modify 8 | * it under the terms of the GNU General Public License as published by 9 | * the Free Software Foundation, either version 3 of the License, or 10 | * (at your option) any later version. 11 | * 12 | * esptool2 is distributed in the hope that it will be useful, 13 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | * GNU General Public License for more details. 16 | * 17 | * You should have received a copy of the GNU General Public License 18 | * along with esptool2. If not, see . 19 | * 20 | **********************************************************************************/ 21 | 22 | #include 23 | #include 24 | #include 25 | 26 | #include "esptool2.h" 27 | #include "esptool2_elf.h" 28 | 29 | #define IMAGE_PADDING 16 30 | #define SECTION_PADDING 4 31 | #define CHECKSUM_INIT 0xEF 32 | #define BIN_MAGIC_IROM 0xEA 33 | #define BIN_MAGIC_FLASH 0xE9 34 | 35 | typedef struct { 36 | Elf32_Addr addr; 37 | Elf32_Word size; 38 | } Section_Header; 39 | 40 | typedef struct { 41 | uint8_t magic; 42 | uint8_t count; 43 | uint8_t byte2; 44 | uint8_t byte3; 45 | Elf32_Addr entry; 46 | } Image_Header; 47 | 48 | static const char PADDING[IMAGE_PADDING] = {0}; 49 | 50 | static bool debugon = false; 51 | static bool quieton = false; 52 | 53 | // Print a standard info message (unless quiet mode) 54 | void print(const char* format, ...) { 55 | va_list args; 56 | 57 | if (!quieton) { 58 | va_start(args, format); 59 | vprintf(format, args); 60 | va_end(args); 61 | } 62 | } 63 | 64 | // Print a debug message (if debug mode) 65 | void debug(const char* format, ...) { 66 | va_list args; 67 | 68 | if (debugon) { 69 | va_start(args, format); 70 | vprintf(format, args); 71 | va_end(args); 72 | } 73 | } 74 | 75 | // Print an error message (always) 76 | void error(const char* format, ...) { 77 | va_list args; 78 | 79 | va_start(args, format); 80 | vfprintf(stderr, format, args); 81 | va_end(args); 82 | } 83 | 84 | // Write an elf section (by name) to an existing file. 85 | // Parameters: 86 | // headed - add a header to the output 87 | // zeroaddr - force zero entry point in header (default is the real entry point) 88 | // padded - output will be padded to multiple of SECTION_PADDING bytes 89 | // chksum - pointer to existing checksum to add this data to (zero if not needed) 90 | // Produces error message on failure (so caller doesn't need to). 91 | bool WriteElfSection(MyElf_File *elf, FILE *outfile, char* name, bool headed, 92 | bool zeroaddr, int padto, unsigned char *chksum) { 93 | 94 | int i, pad = 0; 95 | bool ret = false; 96 | unsigned char *bindata = 0; 97 | Section_Header sechead; 98 | MyElf_Section *sect; 99 | 100 | // get elf section header 101 | sect = GetElfSection(elf, name); 102 | if(!sect) { 103 | error("Error: Section '%s' not found in elf file.\r\n", name); 104 | goto end_function; 105 | } 106 | 107 | // create image section header 108 | sechead.addr = (zeroaddr ? 0 : sect->address); 109 | sechead.size = sect->size; 110 | 111 | // do we need to pad the section? 112 | if (padto) { 113 | pad = sechead.size % padto; 114 | if (pad > 0) { 115 | pad = padto - pad; 116 | sechead.size += pad; 117 | } 118 | } 119 | 120 | debug("Adding section '%s', addr: 0x%08x, size: %d (+%d bytes(s) padding).\r\n", 121 | name, sect->address, sect->size, pad); 122 | 123 | // get elf section binary data 124 | bindata = GetElfSectionData(elf, sect); 125 | if (!bindata) { 126 | goto end_function; 127 | } 128 | 129 | // write section (and pad if required) 130 | if((headed && fwrite(&sechead, 1, sizeof(sechead), outfile) != sizeof(sechead)) 131 | || fwrite(bindata, 1, sect->size, outfile) != sect->size 132 | || (pad > 0 && fwrite(PADDING, 1, pad, outfile) != pad)) { 133 | error("Error: Failed to write section '%s' to image file.\r\n", name); 134 | goto end_function; 135 | } 136 | 137 | // include section data in the checksum 138 | if(chksum) { 139 | for(i = 0; i < (int)sect->size; i++) { 140 | *chksum ^= bindata[i]; 141 | } 142 | } 143 | 144 | ret = true; 145 | 146 | end_function: 147 | if (bindata) free(bindata); 148 | return ret; 149 | } 150 | 151 | // Load an elf file and export a section of it to a new file, without 152 | // header, padding or checksum. For exporting the .irom0.text library. 153 | // Produces error message on failure (so caller doesn't need to). 154 | bool ExportElfSection(char *infile, char *outfile, char *name) { 155 | 156 | bool ret = false; 157 | FILE *fd = 0; 158 | MyElf_File *elf = 0; 159 | 160 | // load elf file 161 | elf = LoadElf(infile); 162 | if (!elf) { 163 | goto end_function; 164 | } 165 | 166 | // open output file 167 | fd = fopen(outfile, "wb"); 168 | if(!fd) { 169 | error("Error: Can't open output file '%s' for writing.\r\n", outfile); 170 | goto end_function; 171 | } 172 | 173 | // actually do the export 174 | ret = WriteElfSection(elf, fd, name, false, false, false, 0); 175 | 176 | end_function: 177 | // clean up 178 | if (fd) fclose(fd); 179 | UnloadElf(elf); 180 | 181 | return ret; 182 | } 183 | 184 | // Create the main binary firmware image, from specified elf sections. 185 | // Can produce for standard standalone app (separate .irom0.text) 186 | // or sdk bootloaded apps (integrated .irom0.text). 187 | // Choice of type requires appropriately linked elf file. 188 | // Produces error message on failure (so caller doesn't need to). 189 | bool CreateHeaderFile(char *elffile, char *imagefile, char *sections[], int numsec) { 190 | 191 | bool ret = false; 192 | int i; 193 | unsigned int j, len; 194 | FILE *outfile = 0; 195 | MyElf_File *elf = 0; 196 | MyElf_Section *sect; 197 | unsigned char *bindata = 0; 198 | char name[31]; 199 | 200 | // load elf file 201 | elf = LoadElf(elffile); 202 | if (!elf) { 203 | goto end_function; 204 | } 205 | 206 | // open output file 207 | outfile = fopen(imagefile, "wb"); 208 | if(outfile == NULL) { 209 | error("Error: Failed to open output file '%s' for writing.\r\n", imagefile); 210 | goto end_function; 211 | } 212 | 213 | // add entry point 214 | fprintf(outfile, "const uint32_t entry_addr = 0x%08x;\r\n", elf->header.e_entry); 215 | 216 | // add sections 217 | for (i = 0; i < numsec; i++) { 218 | // get elf section header 219 | sect = GetElfSection(elf, sections[i]); 220 | if(!sect) { 221 | error("Error: Section '%s' not found in elf file.\r\n", sections[i]); 222 | goto end_function; 223 | } 224 | 225 | // simple name fix name 226 | strncpy(name, sect->name, 31); 227 | len = strlen(name); 228 | for (j = 0; j < len; j++) { 229 | if (name[j] == '.') name[j] = '_'; 230 | } 231 | 232 | // add address, length and start the data block 233 | debug("Adding section '%s', addr: 0x%08x, size: %d.\r\n", sections[i], sect->address, sect->size); 234 | fprintf(outfile, "\r\nconst uint32_t %s_addr = 0x%08x;\r\nconst uint32_t %s_len = %d;\r\nconst uint8_t %s_data[] = {", 235 | name, sect->address, name, sect->size, name); 236 | 237 | // get elf section binary data 238 | bindata = GetElfSectionData(elf, sect); 239 | if (!bindata) { 240 | goto end_function; 241 | } 242 | 243 | // add the data and finish off the block 244 | for (j = 0; j < sect->size; j++) { 245 | if (j % 16 == 0) fprintf(outfile, "\r\n 0x%02x,", bindata[j]); 246 | else fprintf(outfile, " 0x%02x,", bindata[j]); 247 | } 248 | fprintf(outfile, "\r\n};\r\n"); 249 | free(bindata); 250 | bindata = 0; 251 | } 252 | 253 | // if we got this far everything worked! 254 | ret = true; 255 | 256 | end_function: 257 | // clean up 258 | if (outfile) fclose(outfile); 259 | if (elf) UnloadElf(elf); 260 | if (bindata) free(bindata); 261 | 262 | return ret; 263 | } 264 | 265 | // Create the main binary firmware image, from specified elf sections. 266 | // Can produce for standard standalone app (separate .irom0.text) 267 | // or sdk bootloaded apps (integrated .irom0.text). 268 | // Choice of type requires appropriately linked elf file. 269 | // Produces error message on failure (so caller doesn't need to). 270 | bool CreateBinFile(char *elffile, char *imagefile, int bootver, unsigned char mode, 271 | unsigned char clock, unsigned char size, bool iromchksum, char *sections[], int numsec) { 272 | 273 | bool ret = false; 274 | int i, pad, len; 275 | unsigned char chksum = CHECKSUM_INIT; 276 | unsigned char *data = 0; 277 | FILE *outfile = 0; 278 | MyElf_File *elf = 0; 279 | Image_Header imghead; 280 | 281 | // load elf file 282 | elf = LoadElf(elffile); 283 | if (!elf) { 284 | goto end_function; 285 | } 286 | 287 | // open output file 288 | outfile = fopen(imagefile, "wb"); 289 | if(outfile == NULL) { 290 | error("Error: Failed to open output file '%s' for writing.\r\n", imagefile); 291 | goto end_function; 292 | } 293 | 294 | // set options common to standard and boot v1.2+ headers 295 | imghead.byte2 = mode; 296 | //imghead.byte3 = (int)((int)size << 4 | clock) && 0xff; 297 | imghead.byte3 = ((size << 4) | clock) & 0xff; 298 | imghead.entry = elf->header.e_entry; 299 | debug("Size = %02x\r\n", size); 300 | debug("Byte2 = %02x\r\n", imghead.byte2); 301 | debug("Byte3 = %02x\r\n", imghead.byte3); 302 | debug("Entry = %08x\r\n", imghead.entry); 303 | 304 | // boot v1.2+ header 305 | if (bootver == 2) { 306 | // extra header 307 | imghead.magic = BIN_MAGIC_IROM; 308 | imghead.count = 4; // probably a version number here, not a count 309 | if(fwrite(&imghead, 1, sizeof(imghead), outfile) != sizeof(imghead)) { 310 | error("Error: Failed to write header to image file.\r\n"); 311 | goto end_function; 312 | } 313 | if(!WriteElfSection(elf, outfile, ".irom0.text", true, true, IMAGE_PADDING, (iromchksum ? &chksum : 0))) { 314 | goto end_function; 315 | } 316 | } 317 | 318 | // standard header 319 | imghead.magic = BIN_MAGIC_FLASH; 320 | imghead.count = numsec; 321 | // write header 322 | if(fwrite(&imghead, 1, sizeof(imghead), outfile) != sizeof(imghead)) { 323 | error("Error: Failed to write header to image file.\r\n"); 324 | goto end_function; 325 | } 326 | 327 | // add sections 328 | for (i = 0; i < numsec; i++) { 329 | if(!WriteElfSection(elf, outfile, sections[i], true, false, SECTION_PADDING, &chksum)) { 330 | goto end_function; 331 | } 332 | } 333 | 334 | // get image length (plus a byte for the checksum) 335 | len = ftell(outfile) + 1; 336 | 337 | // do we need to pad the image? 338 | pad = len % IMAGE_PADDING; 339 | if (pad > 0) { 340 | pad = IMAGE_PADDING - pad; 341 | debug("Padding image with %d byte(s).\r\n", pad); 342 | if(fwrite(PADDING, 1, pad, outfile) != pad) { 343 | error("Error: Failed to write padding to image file.\r\n"); 344 | goto end_function; 345 | } 346 | } 347 | 348 | // write checksum 349 | if(fwrite(&chksum, 1, 1, outfile) != 1) { 350 | error("Error: Failed to write checksum to image file.\r\n"); 351 | goto end_function; 352 | } 353 | 354 | // boot v1.1 355 | if(bootver == 1) { 356 | // write 'ff' padding up to the position of the library 357 | len = 0x10000 - ftell(outfile); 358 | debug("Adding boot v1.1 padding, %d bytes of '0xff'.\r\n", len); 359 | data = (unsigned char*)malloc(len); 360 | if (!data) { 361 | error("Error: Can't allocate memory.\r\n"); 362 | goto end_function; 363 | } 364 | 365 | memset(data, 0xff, len); 366 | if(fwrite(data, 1, len, outfile) != len) { 367 | error("Error: Failed to write boot v1.1 spacer.\r\n"); 368 | goto end_function; 369 | } 370 | 371 | // write the library 372 | if(!WriteElfSection(elf, outfile, ".irom0.text", false, false, 0, 0)) { 373 | goto end_function; 374 | } 375 | } 376 | 377 | // if we got this far everything worked! 378 | ret = true; 379 | 380 | end_function: 381 | // clean up 382 | if (outfile) fclose(outfile); 383 | if (data) free(data); 384 | if (elf) UnloadElf(elf); 385 | 386 | return ret; 387 | } 388 | 389 | int main(int argc, char *argv[]) { 390 | 391 | int i; 392 | char *infile; 393 | char *outfile; 394 | int numstr; 395 | bool binfile = false; 396 | bool libfile = false; 397 | bool headerfile = false; 398 | bool paramerror = false; 399 | bool iromchksum = false; 400 | int bootver = 0; 401 | unsigned char mode = 0; 402 | unsigned char size = 0; 403 | unsigned char clock = 0; 404 | int opts = 0; 405 | 406 | // parse options 407 | for (i = 1; i < argc; i++) { 408 | if (!strcmp(argv[i], "-bin")) { 409 | binfile = true; 410 | opts++; 411 | } else if (!strcmp(argv[i], "-lib")) { 412 | libfile = true; 413 | opts++; 414 | } else if (!strcmp(argv[i], "-header")) { 415 | headerfile = true; 416 | opts++; 417 | } else if (!strcmp(argv[i], "-quiet")) { 418 | quieton = true; 419 | } else if (!strcmp(argv[i], "-debug")) { 420 | debugon = true; 421 | } else if (!strcmp(argv[i], "-boot0")) { 422 | bootver = 0; 423 | } else if (!strcmp(argv[i], "-boot1")) { 424 | bootver = 1; 425 | } else if (!strcmp(argv[i], "-boot2")) { 426 | bootver = 2; 427 | } else if (!strcmp(argv[i], "-qio")) { 428 | mode = 0; 429 | } else if (!strcmp(argv[i], "-qout")) { 430 | mode = 1; 431 | } else if (!strcmp(argv[i], "-dio")) { 432 | mode = 2; 433 | } else if (!strcmp(argv[i], "-dout")) { 434 | mode = 3; 435 | } else if (!strcmp(argv[i], "-256")) { 436 | size = 1; 437 | } else if (!strcmp(argv[i], "-512")) { 438 | size = 0; 439 | } else if (!strcmp(argv[i], "-1024")) { 440 | size = 2; 441 | } else if (!strcmp(argv[i], "-2048")) { 442 | size = 3; 443 | } else if (!strcmp(argv[i], "-2048b")) { 444 | size = 5; 445 | } else if (!strcmp(argv[i], "-4096")) { 446 | size = 4; 447 | } else if (!strcmp(argv[i], "-8192")) { 448 | size = 8; 449 | } else if (!strcmp(argv[i], "-16384")) { 450 | size = 9; 451 | } else if (!strcmp(argv[i], "-20")) { 452 | clock = 2; 453 | } else if (!strcmp(argv[i], "-26.7")) { 454 | clock = 1; 455 | } else if (!strcmp(argv[i], "-40")) { 456 | clock = 0; 457 | } else if (!strcmp(argv[i], "-80")) { 458 | clock = 15; 459 | } else if (!strcmp(argv[i], "-iromchksum")) { 460 | iromchksum = true; 461 | } else if (!strcmp(argv[i], "--")) { 462 | i++; 463 | break; 464 | } else if (argv[i][0] == '-') { 465 | paramerror = true; 466 | break; 467 | } else { 468 | break; 469 | } 470 | } 471 | 472 | print("esptool2 v2.0.0 - (c) 2015 Richard A Burton \r\n"); 473 | print("This program is licensed under the GPL v3.\r\n"); 474 | print("See the file LICENSE for details.\r\n\r\n"); 475 | 476 | if (paramerror) { 477 | error("Error: Unrecognised option '%s'.\r\n", argv[i]); 478 | return -1; 479 | } 480 | 481 | if (argc < 2) { 482 | print("Usage:\r\n"); 483 | print("esptool2 -lib [options] \r\n"); 484 | print("esptool2 -bin [options] ...\r\n"); 485 | print("esptool2 -header [options] ...\r\n"); 486 | print("\r\n"); 487 | print(" -lib\r\n"); 488 | print(" Export the sdk library (.irom0.text), for a standalone app.\r\n"); 489 | print(" e.g. esptool2 -elf esp8266_iot.out out.bin\r\n"); 490 | print("\r\n"); 491 | print(" -header\r\n"); 492 | print(" Export elf sections as bytes to a C header file.\r\n"); 493 | print(" e.g. esptool2 -elf esp8266_iot.out out.h .text .data .rodata\r\n"); 494 | print("\r\n"); 495 | print(" -bin\r\n"); 496 | print(" Create binary program image, for standalone and bootloaded apps, with\r\n"); 497 | print(" specified elf sections. Includes sdk library for bootloaded apps.\r\n"); 498 | print(" e.g. esptool2 -bin esp8266_iot.out out.bin .text .data .rodata\r\n"); 499 | print(" Options:\r\n"); 500 | print(" bootloader: -boot0 -boot1 -boot2 (default -boot0)\r\n"); 501 | print(" -boot0 = standalone app, not built for bootloader use\r\n"); 502 | print(" -boot1 = built for bootloader v1.1\r\n"); 503 | print(" -boot2 = built for bootloader v1.2+ (use for rBoot roms)\r\n"); 504 | print(" (elf file must have been linked appropriately for chosen option)\r\n"); 505 | print(" spi size (kb): -256 -512 -1024 -2048 -4096 -8192 -16384 (default -512)\r\n"); 506 | print(" spi mode: -qio -qout -dio -dout (default -qio)\r\n"); 507 | print(" spi speed: -20 -26.7 -40 -80 (default -40)\r\n"); 508 | print(" include irom in checksum: -iromchksum (also needs enabling in rBoot)\r\n"); 509 | print("\r\n"); 510 | print("General options:\r\n"); 511 | print(" -quiet prints only error messages\r\n"); 512 | print(" -debug print extra debug information\r\n"); 513 | print(" -- no more options follow (needed if your elf file starts with a '-')\r\n"); 514 | print("\r\n"); 515 | print("Returns:\r\n"); 516 | print(" 0 on success\r\n"); 517 | print(" -1 on failure\r\n"); 518 | print("\r\n"); 519 | return -1; 520 | } 521 | 522 | // validate command line options 523 | if (opts != 1) { 524 | error("Error: You must specify -bin OR -lib OR -header for build type.\r\n"); 525 | return -1; 526 | } 527 | 528 | if (quieton && debugon) { 529 | error("Error: You cannot specify -quiet and -debug.\r\n"); 530 | return -1; 531 | } 532 | 533 | // check enough parameters 534 | if ((libfile && i + 2 > argc) || ((binfile | headerfile) && i + 3 > argc)) { 535 | error("Error: Not enough arguments supplied.\r\n"); 536 | return -1; 537 | } else if (libfile && i + 2 < argc) { 538 | error("Error: Too many arguments supplied.\r\n"); 539 | return -1; 540 | } 541 | 542 | // get parameters 543 | infile = argv[i++]; 544 | outfile = argv[i++]; 545 | numstr = argc - i; 546 | 547 | // do it 548 | if (binfile) { 549 | if (!CreateBinFile(infile, outfile, bootver, mode, clock, size, iromchksum, &argv[i], numstr)) { 550 | remove(outfile); 551 | return -1; 552 | } 553 | } else if (headerfile) { 554 | if (!CreateHeaderFile(infile, outfile, &argv[i], numstr)) { 555 | remove(outfile); 556 | return -1; 557 | } 558 | } else { 559 | if (!ExportElfSection(infile, outfile, ".irom0.text")) { 560 | remove(outfile); 561 | return -1; 562 | } 563 | 564 | } 565 | 566 | print("Successfully created '%s'.\r\n", outfile); 567 | return 0; 568 | 569 | } 570 | -------------------------------------------------------------------------------- /license.txt: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------