├── 3dlut-extract ├── make-brightness-rgb-palette ├── README.md ├── ambarella-h22-firmware-repack ├── ambarella-h22-firmware-unpack └── LICENSE /3dlut-extract: -------------------------------------------------------------------------------- 1 | #!/usr/bin/python3 2 | # -*- coding: utf-8 -*- 3 | """ 4 | Extract a 16x16x16 3D-LUT table from an Ambarella ROMFS file. 5 | 6 | NOTICE: The saved image is a PNG 3x8-bit, where the original 7 | colors are 3x10-bit instead. 8 | """ 9 | 10 | from PIL import Image, ImageDraw 11 | import mmap 12 | import os 13 | import sys 14 | 15 | __author__ = "Niccolo Rigacci" 16 | __copyright__ = "Copyright 2021 Niccolo Rigacci " 17 | __license__ = "GPLv3-or-later" 18 | __email__ = "niccolo@rigacci.org" 19 | __version__ = "0.1.1" 20 | 21 | LUT_SIZE = 16 22 | BIT_MASK = 0b1111111111 23 | DOT_SIZE = 8 24 | BORDER = DOT_SIZE 25 | 26 | 27 | def norm(val): 28 | # Normalize a 10-bit number to 8-bit. 29 | return int(float(val) / float(BIT_MASK) * 256.0) 30 | 31 | 32 | if len(sys.argv) < 3: 33 | print('Usage: %s FILE OFFSET' % (os.path.basename(sys.argv[0]),)) 34 | sys.exit(1) 35 | 36 | firmware_file = sys.argv[1] 37 | offset = int(sys.argv[2], 16) 38 | lut_filename = '%s_lut-0x%08X.png' % (firmware_file, offset) 39 | 40 | fw = open(firmware_file, "r+b") 41 | f = mmap.mmap(fw.fileno(), 0) 42 | f.seek(offset) 43 | 44 | image_width = (LUT_SIZE * DOT_SIZE) * LUT_SIZE + BORDER * (LUT_SIZE + 1) 45 | image_height = (LUT_SIZE * DOT_SIZE) + BORDER * 2 46 | img = Image.new('RGB', (image_width, image_height), color = 'white') 47 | for z in range(0, LUT_SIZE): 48 | for y in range(0, LUT_SIZE): 49 | for x in range(0, LUT_SIZE): 50 | int32 = int.from_bytes(f.read(4), 'little') 51 | red = (int32 >> 0) & BIT_MASK 52 | green = (int32 >> 10) & BIT_MASK 53 | blue = (int32 >> 20) & BIT_MASK 54 | print('(%4d, %4d, %4d), ' % (red, green, blue), end='') 55 | #print('(%3x, %3x, %3x), ' % (red, green, blue)) 56 | fill_color = 'rgb(%d,%d,%d)' % (norm(red), norm(green), norm(blue)) 57 | x0 = BORDER + x * DOT_SIZE + z * (DOT_SIZE * LUT_SIZE + BORDER) 58 | y0 = BORDER + (LUT_SIZE - y - 1) * DOT_SIZE 59 | square = ImageDraw.Draw(img) 60 | square.rectangle([x0, y0, x0 + DOT_SIZE, y0 + DOT_SIZE], fill=fill_color) 61 | print('') 62 | print('') 63 | print('') 64 | img.save(lut_filename) 65 | 66 | file_pointer = f.tell() 67 | f.seek(0, 2) 68 | file_end = f.tell() 69 | print('LUT: start: 0x%08X, size: %d, end: 0x%08X - File end: 0x%08X, remaining bytes: %d' % (offset, 4 * (LUT_SIZE ** 3), file_pointer, file_end, file_end - file_pointer)) 70 | -------------------------------------------------------------------------------- /make-brightness-rgb-palette: -------------------------------------------------------------------------------- 1 | #!/usr/bin/python3 2 | # -*- coding: utf-8 -*- 3 | """ 4 | Generate an image with the full RGB palette and varying brightness. 5 | """ 6 | 7 | import colorsys 8 | import sys 9 | from PIL import Image, ImageDraw 10 | 11 | IMAGE_WIDTH = 1920 12 | IMAGE_HEIGHT = 1080 13 | DOT_SIZE = 8 14 | DST_FILE='brightness-rgb-palette.png' 15 | 16 | __author__ = "Niccolo Rigacci" 17 | __copyright__ = "Copyright 2021 Niccolo Rigacci " 18 | __license__ = "GPLv3-or-later" 19 | __email__ = "niccolo@rigacci.org" 20 | __version__ = "0.1.3" 21 | 22 | # Index of colors in RGB coordinates. 23 | RED = 0 24 | GREEN = 1 25 | BLUE = 2 26 | # Max value for a color component: 255 for 8-bit colors. 27 | MAX_VAL = 255.0 28 | 29 | # Edges of the color cube to follow when creating the color gradient. 30 | # Blue -> Violet -> Red -> Yellow -> Green -> Cyan -> Blue 31 | EDGES = [[BLUE, RED], [RED, GREEN], [GREEN, BLUE]] 32 | 33 | # Shift the palette to le left. 34 | # A value of 1.0 means to shift to the next primary color. 35 | PALETTE_SHIFT = -0.5 36 | 37 | 38 | def color_adjust(c, luminance): 39 | """ Set the brightness of an RGB color, using HLS model """ 40 | h, l, s = colorsys.rgb_to_hls(c[0] / MAX_VAL, c[1] / MAX_VAL, c[2] / MAX_VAL) 41 | r, g, b = colorsys.hls_to_rgb(h, luminance, s) 42 | return (int(r * MAX_VAL), int(g * MAX_VAL), int(b * MAX_VAL)) 43 | 44 | 45 | def make_gradient(brightness): 46 | """ Create a color gradient along the colors in EDGES """ 47 | ramp = [] 48 | # The ramp gradates with two sub-gradients for each pair of primary colors. 49 | step_count = int(IMAGE_WIDTH / DOT_SIZE / 2.0 / 3.0) 50 | # Increment of the color component. 51 | step = float(MAX_VAL) / step_count 52 | current_color = [0, 0, 0] 53 | for edge in EDGES: 54 | # Make the sub-gradients from one primary color to another: 55 | # * Begin with pure primary color #1. 56 | # * Step increasing the component of primary color #2. 57 | # * Step decreasing the component of primary color #1. 58 | component_0 = edge[0] 59 | component_1 = edge[1] 60 | current_color[component_0] = int(MAX_VAL) 61 | for i in range(0, step_count): 62 | val = step * i 63 | current_color[component_1] = int(val) 64 | #print(current_color) 65 | ramp.append(color_adjust(current_color, brightness)) 66 | current_color[component_1] = int(MAX_VAL) 67 | for i in range(0, step_count): 68 | val = MAX_VAL - step * i 69 | current_color[component_0] = int(val) 70 | #print(current_color) 71 | ramp.append(color_adjust(current_color, brightness)) 72 | current_color[component_0] = 0 73 | #print('----') 74 | shift_index = int(PALETTE_SHIFT * step_count * 2.0) 75 | ramp = ramp[shift_index:] + ramp[:shift_index] 76 | return ramp 77 | 78 | img = Image.new('RGB', (IMAGE_WIDTH, IMAGE_HEIGHT), color = 'black') 79 | steps_y = int(IMAGE_HEIGHT / DOT_SIZE) 80 | for y in range(0, steps_y): 81 | brightness = (steps_y - y) / steps_y 82 | ramp = make_gradient(brightness) 83 | x = 0 84 | for c in ramp: 85 | fill_color = 'rgb(%d,%d,%d)' % (c[RED], c[GREEN], c[BLUE]) 86 | x0 = x * DOT_SIZE 87 | y0 = y * DOT_SIZE 88 | square = ImageDraw.Draw(img) 89 | square.rectangle([x0, y0, x0 + DOT_SIZE, y0 + DOT_SIZE], fill=fill_color) 90 | x += 1 91 | img.save(DST_FILE) 92 | print('Created file "%s"' % (DST_FILE,)) 93 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Ambarella H22 Firmware unpacker and packer 2 | 3 | **Unpak and re-pack firmwares for action cameras based on the Ambarella H22 SoC** 4 | 5 | The **ambarella-h22-firmware-repack** and 6 | **ambarella-h22-firmware-unpack** are two Python scripts that 7 | can upack and re-pack the firmwares released for action cameras 8 | based on the Ambarella H22 SoC. 9 | 10 | Unpacking the firmware is necessary if you want to edit some 11 | settings. E.g. if you want to change video bitrates, GOP 12 | paramters, gamma and LUT tables, translation strings, etc. Once 13 | edited the files, you have to re-pack everything into a new 14 | firmware file, updating CRC32 and MD5 checksums. 15 | 16 | The scripts are tested on firmwares for the **SJCAM SJ8 Pro** 17 | and the Hawk Eye **Firefly X Lite** cameras, they can extract 18 | each section from the archive, and check the CRC32 checksums. 19 | 20 | Generally the firmware sections may consist of RTOS (Real Time 21 | Operating System) images, Linux kernel images, GNU/Linux root 22 | filesystem images or Ambarella ROMFS images. Ambarella ROMFS 23 | images contain files, which are extracted and checked against 24 | their CRC32 checksums. 25 | 26 | The **SCAM SJ10 Pro** camera uses a slightly different format 27 | for the ROMFS partitions; at the moment the difference cannot be 28 | autodetected and you must change a constant definition into the 29 | script. 30 | 31 | As far I know, there is no official documentation about 32 | firmwares file format and it is no clear if the file format is 33 | common to all the Ambarella H22 cameras or if each maker (SJCAM, 34 | Hawk Eye, etc.) can customize it freely. 35 | 36 | The scripts are based on reverese engeneering and upon some 37 | softwares available as open source: 38 | 39 | * [BitrateEditor](https://github.com/vmax1145/BitrateEditor) 40 | * [dji-firmware-tools](https://github.com/o-gs/dji-firmware-tools) 41 | 42 | I tried also the Ambarella Firmware Toolbox 1.3.3 which can 43 | analyze firmwares for Ambarella A2, A5 and A7. Unfortunately it 44 | cannot parse H22 files. 45 | 46 | As far I know, the existing softwares (I mainly tested 47 | BitrateEditor) does not re-pack the firmware 100% correctly, 48 | because it does not update the CRC32 checksums in the firmware 49 | header. Neverthless the SJ8 Pro accepts to flash firmwares with 50 | that CRC32 mismatches. 51 | 52 | ## Programs usage 53 | 54 | To extract data from a firmware, use the command: 55 | 56 | ``` 57 | ambarella-h22-firmware-unpack FIRMWARE.bin FIRMWARE_CHECK.ch DST_DIRECTORY 58 | ``` 59 | 60 | where the **.bin** file is actually the firmware and the **.ch** 61 | file contains the MD5 checksum. The **DST_DIRECTORY** will be 62 | created and filled with the sections. If one of the section is 63 | detected as ROMFS, files contained therein will be estracted and 64 | saved into a subdirectory. 65 | 66 | To re-pack the content of a directory, use the command: 67 | 68 | ``` 69 | ambarella-h22-firmware-repack SRC_DIRECTORY DST_FIRMWARE.bin DST_FIRMWARE.ch 70 | ``` 71 | 72 | The **SRC_DIRECTORY** must contains files as they were extracted 73 | (headers, binary images, files lists and subdirectories), the 74 | **DST_FIRMWARE.bin** and **DST_FIRMWARE.ch** will be created 75 | with updated CRC32 and MD5 checksums. 76 | 77 | ## Firmwares used for testing 78 | 79 | * [SJ8 Series Firmware](http://support.sjcam.com/support/solutions/folders/9000184902) 80 | * [Firefly Firmwares](http://www.hawkeyefpv.com.cn/About.aspx?ClassID=35) 81 | * [SJ10 Series Firmware Updates](http://support.sjcam.com/support/solutions/folders/9000192806) 82 | 83 | -------------------------------------------------------------------------------- /ambarella-h22-firmware-repack: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | # -*- coding: utf-8 -*- 3 | """ 4 | Re-pack files extracted from an Ambarella H22 firmware file using 5 | the ambarella-h22-firmware-unpack tool. 6 | Section lengths, CRC32 and MD5 checksum are re-calculated and 7 | headers are updated. 8 | """ 9 | 10 | import hashlib 11 | import mmap 12 | import os.path 13 | import sys 14 | import zlib 15 | 16 | __author__ = "Niccolo Rigacci" 17 | __copyright__ = "Copyright 2021 Niccolo Rigacci " 18 | __license__ = "GPLv3-or-later" 19 | __email__ = "niccolo@rigacci.org" 20 | __version__ = "0.1.0" 21 | 22 | ROMFS_TYPE = 'SJ8PRO' 23 | #ROMFS_TYPE = 'SJ10PRO' 24 | 25 | # File header, containing the firmware sections table. 26 | FIRMWARE_FILE_HEADER_LEN = 560 27 | FIRMWARE_FILE_HEADER_SECTIONS_TABLE_OFFSET = 48 28 | # Ambarella firmare sections. 29 | SECTION_HEADER_LEN = 256 30 | # Ambarella ROMFS partition header Magic identifier: 0x8A32FC66. 31 | ROMFS_PARTITION_HEADER_MAGIC = b'\x8A\x32\xFC\x66' 32 | if ROMFS_TYPE == 'SJ8PRO': 33 | # SJ8Pro, Firefly X Lite 34 | ROMFS_PARTITION_HEADER_LEN = 2048 * 3 35 | ROMFS_FILENAME_LEN = 64 36 | else: 37 | # SJ10Pro 38 | ROMFS_PARTITION_HEADER_LEN = 2048 * 68 39 | ROMFS_FILENAME_LEN = 256 40 | ROMFS_FILE_ENTRY_LEN = ROMFS_FILENAME_LEN + 12 41 | 42 | def update_sections_table(firmware, sections_count, section_len, crc32_running): 43 | """ Update section length and running CRC32 in header's sections table """ 44 | firmware.seek(FIRMWARE_FILE_HEADER_SECTIONS_TABLE_OFFSET + 8 * sections_count) 45 | firmware.write(section_len.to_bytes(4, 'little')) 46 | crc32_negated = 0xffffffff ^ crc32_running 47 | firmware.write(crc32_negated.to_bytes(4, 'little')) 48 | firmware.seek(0, 2) 49 | 50 | 51 | def get_content(filename): 52 | """ Read a whole file in binary mode and return it as a bytes object """ 53 | with open(filename, 'rb') as f: 54 | return f.read() 55 | 56 | 57 | def replace_bytes(buffer, offset, replace): 58 | """ Replace some bytes at specified offset in buffer of bytes """ 59 | return buffer[0:offset] + replace + buffer[offset+len(replace):] 60 | 61 | 62 | #------------------------------------------------------------------------- 63 | # Get filenames from command line. 64 | #------------------------------------------------------------------------- 65 | if len(sys.argv) < 4: 66 | print('Usage: %s SRC_DIRECTORY DST_FIRMWARE.bin DST_FIRMWARE.ch' % (os.path.basename(sys.argv[0]),)) 67 | sys.exit(1) 68 | 69 | src_directory = sys.argv[1] 70 | dst_firmware = sys.argv[2] 71 | dst_checksum = sys.argv[3] 72 | 73 | if os.path.exists(dst_firmware): 74 | print('ERROR: File "%s" alrady exists' % (dst_firmware,)) 75 | sys.exit(1) 76 | if os.path.exists(dst_checksum): 77 | print('ERROR: File "%s" alrady exists' % (dst_checksum,)) 78 | sys.exit(1) 79 | 80 | firmware = open(dst_firmware, 'wb') 81 | firmware.close() 82 | firmware = open(dst_firmware, 'r+b') 83 | 84 | # Read items contained into the source directory. 85 | items = os.listdir(src_directory) 86 | items.sort() 87 | 88 | sections_count = 0 89 | crc32_running = 0 90 | for i in items: 91 | if i == '00000000_header.bin': 92 | print('Processing file header 0x00000000') 93 | firmware.write(get_content(os.path.join(src_directory, i))) 94 | elif i.endswith('_head.bin'): 95 | # Process each section header. 96 | offset_head = int(i[0:-9], 16) 97 | offset_sect = offset_head + SECTION_HEADER_LEN 98 | print('Processing section header 0x%08x' % (offset_head,)) 99 | section_filename = os.path.join(src_directory, '%08X_sect.bin' % (offset_sect,)) 100 | section_romfs_list = os.path.join(src_directory, '%08X.dir' % (offset_sect,)) 101 | section_romfs_dir = os.path.join(src_directory, '%08X_files' % (offset_sect,)) 102 | if os.path.isfile(section_romfs_list): 103 | # Section is a ROMFS partition: re-pack each file. 104 | file_offset = ROMFS_PARTITION_HEADER_LEN 105 | file_list = [] 106 | with open(section_romfs_list, 'r') as f: 107 | file_list = f.read().splitlines() 108 | subdir = os.path.join(src_directory, '%08X_files' % (offset_sect,)) 109 | romfs_header = b'' 110 | romfs_image = b'' 111 | romfs_header += ROMFS_PARTITION_HEADER_MAGIC 112 | romfs_header += len(file_list).to_bytes(4, 'little') 113 | for f in file_list: 114 | filename = os.path.join(section_romfs_dir, f) 115 | print(' Adding file %s' % (filename,)) 116 | file_content = get_content(filename) 117 | file_len = len(file_content) 118 | file_crc32 = zlib.crc32(file_content, 0) & 0xffffffff 119 | padding_zeroes = 2048 - (file_len % 2048) 120 | romfs_image += file_content 121 | romfs_image += b'\0'*padding_zeroes 122 | romfs_header += (f.encode('utf-8') + b'\0'*ROMFS_FILENAME_LEN)[0:ROMFS_FILENAME_LEN] 123 | romfs_header += file_len.to_bytes(4, 'little') 124 | romfs_header += file_offset.to_bytes(4, 'little') 125 | romfs_header += file_crc32.to_bytes(4, 'little') 126 | file_offset += (file_len + padding_zeroes) 127 | padding_zeroes = ROMFS_PARTITION_HEADER_LEN - len(romfs_header) 128 | romfs_header += b'\0'*padding_zeroes 129 | # Get the original section header and update CRC32 and length. 130 | section_header = get_content(os.path.join(src_directory, i)) 131 | section_data = romfs_header + romfs_image 132 | section_len = len(section_data) 133 | section_crc32 = zlib.crc32(section_data, 0) & 0xffffffff 134 | section_header = replace_bytes(section_header, 0, section_crc32.to_bytes(4, 'little')) 135 | section_header = replace_bytes(section_header, 12, section_len.to_bytes(4, 'little')) 136 | section_complete = section_header + section_data 137 | firmware.write(section_complete) 138 | # Update section length and CRC32 in sections table. 139 | crc32_running = zlib.crc32(section_complete, crc32_running) & 0xffffffff 140 | update_sections_table(firmware, sections_count, len(section_complete), crc32_running) 141 | sections_count += 1 142 | elif os.path.isfile(section_filename): 143 | # Section is a generic binary image: add header and section untouched. 144 | print(' Adding data from section "%s"' % (section_filename,)) 145 | section_len = 0 146 | content = get_content(os.path.join(src_directory, i)) 147 | section_len += len(content) 148 | crc32_running = zlib.crc32(content, crc32_running) & 0xffffffff 149 | firmware.write(content) 150 | content = get_content(section_filename) 151 | section_len += len(content) 152 | firmware.write(content) 153 | # Update section length and CRC32 in sections table. 154 | crc32_running = zlib.crc32(content, crc32_running) & 0xffffffff 155 | update_sections_table(firmware, sections_count, section_len, crc32_running) 156 | sections_count += 1 157 | else: 158 | print('ERROR: Missing data for "%s": need either "%s" or "%s"' % (i, section_romfs_list, section_filename)) 159 | sys.exit(1) 160 | 161 | # Re-calculate the CRC32 excluding the firmware header. 162 | firmware.seek(FIRMWARE_FILE_HEADER_LEN) 163 | content = firmware.read() 164 | crc32 = zlib.crc32(content, 0) & 0xffffffff 165 | firmware.seek(36) 166 | firmware.write(crc32.to_bytes(4, 'little')) 167 | # Calculate the MD5 sum of the entire file. 168 | firmware.seek(0) 169 | md5 = hashlib.md5(firmware.read()).hexdigest() 170 | firmware.close() 171 | # Write the MD5 sum file as 4 * 32bits little endian integers. 172 | with open(dst_checksum, 'wb') as f: 173 | for i in range(0, 4): 174 | chunk = int(md5[i*8:(i+1)*8], 16) 175 | f.write(chunk.to_bytes(4, 'little')) 176 | -------------------------------------------------------------------------------- /ambarella-h22-firmware-unpack: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | # -*- coding: utf-8 -*- 3 | """ 4 | Ambarella Firmware Analyzer and unpacker, based on reverse 5 | engeneering of SJCAM 8 Pro firmwares. 6 | 7 | Tested on firmwares for the SJCAM 8 Pro and the Hawkeye 8 | Firefly X, both based on the Ambarella H22 SoC. 9 | 10 | Thanks to the following open source projects: 11 | * https://github.com/vmax1145/BitrateEditor 12 | * https://github.com/o-gs/dji-firmware-tools 13 | """ 14 | 15 | import hashlib 16 | import mmap 17 | import os.path 18 | import sys 19 | import zlib 20 | 21 | __author__ = "Niccolo Rigacci" 22 | __copyright__ = "Copyright 2021 Niccolo Rigacci " 23 | __license__ = "GPLv3-or-later" 24 | __email__ = "niccolo@rigacci.org" 25 | __version__ = "0.1.0" 26 | 27 | ROMFS_TYPE = 'SJ8PRO' 28 | #ROMFS_TYPE = 'SJ10PRO' 29 | 30 | # File header, containing the firmware sections table. 31 | FIRMWARE_FILE_HEADER_LEN = 560 32 | FIRMWARE_FILE_HEADER_NAME_LEN = 32 33 | FIRMWARE_FILE_HEADER_SECTIONS_TABLE_OFFSET = 48 34 | FIRMWARE_FILE_HEADER_SECTIONS_TABLE_MAX_ENTRIES = 16 35 | # Ambarella firmware section Magic identifier: 0x90EB24A3. 36 | SECTION_MAGIC = b'\x90\xEB\x24\xA3' 37 | SECTION_HEADER_LEN = 256 38 | SECTION_VERSION_FORMAT = 'big' # Minor and major number byte order: 'little' or 'big'. 39 | # Ambarella ROMFS partition header Magic identifier: 0x8A32FC66. 40 | ROMFS_PARTITION_HEADER_MAGIC = b'\x8A\x32\xFC\x66' 41 | if ROMFS_TYPE == 'SJ8PRO': 42 | # SJ8Pro, Firefly X Lite 43 | ROMFS_PARTITION_HEADER_LEN = 2048 * 3 44 | ROMFS_FILENAME_LEN = 64 45 | else: 46 | # SJ10Pro 47 | ROMFS_PARTITION_HEADER_LEN = 2048 * 68 48 | ROMFS_FILENAME_LEN = 256 49 | ROMFS_FILE_ENTRY_LEN = ROMFS_FILENAME_LEN + 12 50 | 51 | 52 | # Structure of an SJ8 Pro (Ambarella H22) firmware file: 53 | # * 560 bytes header 54 | # * 32 bytes zeroes 55 | # * 4 bytes: E6 DF 32 87 (Magic number? The same for SJ8Pro, SJ10Pro, Firefly X Lite) 56 | # * 4 bytes: CRC32 of all the file content, from 0x00000230 to EOF 57 | # * 8 bytes: zeroes 58 | # * 16 * 8 bytes. One entry for each section: 59 | # * 4 bytes: Length of section, from header to header, little endian. 60 | # * 4 bytes: Running CRC32 of sections with negated bits, from header to header, little endian. 61 | # * ... 62 | # * At offset 0x00B0: 384 bytes ??? 63 | # * Firmware Sections (partitions images). 64 | 65 | # Structure of an Ambarella firmware section: 66 | # * 256 bytes header 67 | # * 4 bytes: CRC32 for the partition, excluding the header. 68 | # * 2 + 2 bytes: Version minor and major number (big or little endian). 69 | # * 1 + 1 + 2 bytes: day, month and year (little endian). 70 | # * 4 bytes: Partition length, excluding the header, unsigned int little endian. 71 | # * 4 bytes: Memory ??? 72 | # * 4 bytes: Flags ??? 73 | # * 4 bytes: Section Magic number '90EB24A3'. 74 | # * 228 bytes: zeroes 75 | # * Firmware section (partition image). 76 | 77 | # Structure of an Ambarella ROMFS partition (SJ8 Pro, Ambarella H22): 78 | # * 4 bytes: Partition Magic number '8A32FC66'. 79 | # * 4 bytes: File count, unsigned int little endian. 80 | # * One entry for each file. Max 80 entries? (6144 - 4 - 4) / 76 = 80.736 81 | # * 64 bytes: filename, zero terminated string (SJ8Pro, 256 bytes for the SJ10Pro) 82 | # * 4 bytes: file length, unsigned int little endian. 83 | # * 4 bytes: file offset relative to partition begin, unsigned int little endian. 84 | # * 4 bytes: file CRC32, unsigned int little endian. 85 | # * Zeroes padding to 6144 bytes (2048 * 3) from partition begin (2048 * 68 for the SJ10Pro) 86 | # * For each file: 87 | # * File content 88 | # * Zeroes padding: (2048 - (file_end_offset % 2048)) 89 | 90 | # Structure of an Ambarella ROMFS partition (SJ7 Star, Ambarella A12): 91 | # * 4 bytes: File count, unsigned int little endian. 92 | # * 4 bytes: Partition Magic number '8A32FC66'. 93 | # * One entry of 128 bytes for each file. 94 | # * 116 bytes: filename, zero terminated string. 95 | # * 4 bytes: file offset relative to partition begin, unsigned int little endian. 96 | # * 4 bytes: file length, unsigned int little endian. 97 | # * 4 bytes: File entry Magic number '76AB8723'. 98 | # * 0xFF padding to 2048 multiple from partition begin. 99 | # * For each file: 100 | # * File content 101 | # * Padding ??? 102 | 103 | 104 | def check_md5(file_bin, filename_sum): 105 | """ Compare the MD5 sum of a memory mapped file with the content of a file """ 106 | file_bin.seek(0) 107 | md5_calc = hashlib.md5(file_bin.read()).hexdigest() 108 | # The file packs the MD5 sum as 4 * 32bits little endian integers. 109 | with open(filename_sum, 'rb') as f: 110 | md5_expected = '' 111 | for i in range(0, 4): 112 | int32 = int.from_bytes(f.read(4), 'little') 113 | md5_expected += '%08x' % (int32,) 114 | return (md5_calc.lower() == md5_expected.lower()) 115 | 116 | 117 | def hex_repr(bytes): 118 | """ Return the hex representation of bytes """ 119 | return ''.join(map('{:02X}'.format, bytes)) 120 | 121 | 122 | def ok_fail(v1, v2): 123 | return 'OK' if v1 == v2 else 'FAIL' 124 | 125 | 126 | def magic_search_offset(mm, magic): 127 | """ Search firmware for some Magic id number """ 128 | magic_offsets = [] 129 | offset = mm.find(magic, 0) 130 | while offset != -1: 131 | magic_offsets.append(offset) 132 | mm.seek(offset + len(magic)) 133 | offset = mm.find(magic, offset + len(magic)) 134 | return magic_offsets 135 | 136 | 137 | def get_crc32(f, offset, length=-1, value=0): 138 | """ Read some bytes from a file hanlde and return the CRC32 """ 139 | f.seek(offset) 140 | content = f.read(length) 141 | return zlib.crc32(content, value) & 0xffffffff 142 | 143 | 144 | def save_file_part(f, dst_filename, offset, length=-1): 145 | """ Read some byte from a file handle and save into a named file """ 146 | global dst_directory 147 | file_path = os.path.join(dst_directory, dst_filename) 148 | path = os.path.dirname(file_path) 149 | if not os.path.exists(path): 150 | os.mkdir(path) 151 | f.seek(offset) 152 | content = f.read(length) 153 | with open(file_path, 'wb') as of: 154 | of.write(content) 155 | 156 | 157 | class get_firmware_header: 158 | """ Read and parse the firmware file header """ 159 | def __init__(self, firmware): 160 | firmware.seek(0) 161 | self.sections_table = [] 162 | self.name = firmware.read(FIRMWARE_FILE_HEADER_NAME_LEN).decode('utf-8').rstrip('\0') 163 | self.unknown1 = int.from_bytes(firmware.read(4), 'little') 164 | self.crc32 = int.from_bytes(firmware.read(4), 'little') 165 | self.crc32_actual = get_crc32(firmware, FIRMWARE_FILE_HEADER_LEN) 166 | # Read the sections table. 167 | section_offset = FIRMWARE_FILE_HEADER_LEN 168 | sections_running_crc32 = 0 169 | for i in range(0, FIRMWARE_FILE_HEADER_SECTIONS_TABLE_MAX_ENTRIES): 170 | entry_offset = FIRMWARE_FILE_HEADER_SECTIONS_TABLE_OFFSET + i * 8 171 | firmware.seek(entry_offset) 172 | section_len = int.from_bytes(mm.read(4), 'little') 173 | if section_len == 0: 174 | break 175 | # The stored CRC32 is a "running CRC32" with bits negated. 176 | section_crc32 = 0xffffffff ^ int.from_bytes(mm.read(4), 'little') 177 | # Calculate the actual running CRC32 of the sections. 178 | sections_running_crc32 = get_crc32(firmware, section_offset, section_len, sections_running_crc32) 179 | section_entry = sections_table_entry(section_offset, section_len, section_crc32, sections_running_crc32) 180 | self.sections_table.append(section_entry) 181 | section_offset += section_len 182 | 183 | 184 | class sections_table_entry: 185 | """ Contains one entry of the sections table, contained into the firmware file header """ 186 | def __init__(self, offset, length, crc32, crc32_actual): 187 | self.offset = offset 188 | self.length = length 189 | self.crc32 = crc32 190 | self.crc32_actual = crc32_actual 191 | 192 | 193 | class get_section_header: 194 | """ Read the header of a firmware section, given the offset """ 195 | def __init__(self, firmware, header_offset): 196 | firmware.seek(header_offset) 197 | self.offset_head = header_offset 198 | self.offset_sect = header_offset + SECTION_HEADER_LEN 199 | self.crc32 = int.from_bytes(firmware.read(4), 'little') 200 | if SECTION_VERSION_FORMAT == 'big': 201 | self.ver_major = int.from_bytes(firmware.read(2), SECTION_VERSION_FORMAT) 202 | self.ver_minor = int.from_bytes(firmware.read(2), SECTION_VERSION_FORMAT) 203 | else: 204 | self.ver_minor = int.from_bytes(firmware.read(2), SECTION_VERSION_FORMAT) 205 | self.ver_major = int.from_bytes(firmware.read(2), SECTION_VERSION_FORMAT) 206 | self.day = int.from_bytes(firmware.read(1), 'little') 207 | self.month = int.from_bytes(firmware.read(1), 'little') 208 | self.year = int.from_bytes(firmware.read(2), 'little') 209 | self.length = int.from_bytes(firmware.read(4), 'little') 210 | self.memory = int.from_bytes(firmware.read(4), 'little') 211 | self.flag = int.from_bytes(firmware.read(4), 'little') 212 | self.version = '%d.%d' % (self.ver_major, self.ver_minor) 213 | self.date = '%04d-%02d-%02d' % (self.year, self.month, self.day) 214 | self.crc32_actual = get_crc32(firmware, self.offset_sect, self.length) 215 | 216 | 217 | class get_romfs_header: 218 | """ Read the header of an Ambarella ROMFS partition """ 219 | def __init__(self, firmware, partition_offset): 220 | firmware.seek(partition_offset + len(ROMFS_PARTITION_HEADER_MAGIC)) 221 | self.offset = None 222 | self.file_count = None 223 | self.files_directory = [] 224 | self.offset = partition_offset 225 | self.file_count = int.from_bytes(firmware.read(4), 'little') 226 | if self.file_count > 0xffff: 227 | # Too much files! Magic did not work? 228 | self.file_count = -1 229 | return 230 | offset_expected = ROMFS_PARTITION_HEADER_LEN 231 | for i in range(0, self.file_count): 232 | file_entry_offset = partition_offset + len(ROMFS_PARTITION_HEADER_MAGIC) + 4 + ROMFS_FILE_ENTRY_LEN * i 233 | firmware.seek(file_entry_offset) 234 | name = firmware.read(ROMFS_FILENAME_LEN).decode('utf-8').rstrip('\0') 235 | length = int.from_bytes(firmware.read(4), 'little') 236 | offset_rel = int.from_bytes(firmware.read(4), 'little') # File offset relative to partition. 237 | offset_abs = partition_offset + offset_rel # File offset relative to firmware image file. 238 | crc32 = int.from_bytes(firmware.read(4), 'little') 239 | padding_zeroes = 2048 - ((offset_rel + length) % 2048) 240 | offset_next = offset_rel + length + padding_zeroes 241 | crc32_actual = get_crc32(firmware, offset_abs, length) 242 | item = romfs_file_entry(i, name, length, offset_rel, offset_abs, crc32, padding_zeroes, offset_next, crc32_actual, offset_expected) 243 | offset_expected = offset_next 244 | self.files_directory.append(item) 245 | 246 | 247 | class romfs_file_entry: 248 | """ Contains one entry of the ROMFS directory """ 249 | def __init__(self, pos, name, length, offset_rel, offset_abs, crc32, padding_zeroes, offset_next, crc32_actual, offset_expected): 250 | self.pos = pos 251 | self.name = name 252 | self.length = length 253 | self.offset_rel = offset_rel 254 | self.offset_abs = offset_abs 255 | self.crc32 = crc32 256 | self.padding_zeroes = padding_zeroes 257 | self.offset_next = offset_next 258 | self.crc32_actual = crc32_actual 259 | self.offset_expected = offset_expected 260 | 261 | 262 | def firmware_print_header(h): 263 | """ """ 264 | print('%s: CRC32 on file [0x%04X:EOF]: from header 0x%08X <=> actual 0x%08X' % (ok_fail(h.crc32, h.crc32_actual), FIRMWARE_FILE_HEADER_LEN, h.crc32, h.crc32_actual)) 265 | print('') 266 | tw = 67 267 | print('+%s+' % ('-'*tw,)) 268 | print('|%s|' % 'Ambarella Firmware File Header - Sections Table'.center(tw),) 269 | print('+%s+' % ('-'*tw,)) 270 | print('| %-13s | %-10s | %-15s | %-18s |' % ('Len (+header)', '~CRC32', 'Running CRC32', 'Offset calculated')) 271 | print('|%s|' % ('-'*tw,)) 272 | for i in h.sections_table: 273 | print('| %13d | 0x%08X | 0x%08X %4s | 0x%08X %s |' % (i.length, i.crc32, i.crc32_actual, ok_fail(i.crc32, i.crc32_actual), i.offset, ' '*7)) 274 | print('+%s+' % ('-'*tw,)) 275 | print('') 276 | 277 | 278 | def section_print_header(headers): 279 | """ """ 280 | tw = 107 281 | print('+%s+' % ('-'*tw,)) 282 | print('|%s|' % ('Ambarella Firmware Sections found by Magic %s' % (hex_repr(SECTION_MAGIC),)).center(tw),) 283 | print('+%s+' % ('-'*tw,)) 284 | print('| %-10s | %-10s | %-8s | %-15s | %-11s | %-10s | %-10s | %-10s |' % ('Header', 'Section', 'Len', 'CRC32', 'Version', 'Date', 'Memory', 'Flag')) 285 | print('+%s+' % ('-'*tw,)) 286 | for h in headers: 287 | print('| 0x%08X | 0x%08X | %8d | 0x%08X %-4s | %11s | %010s | 0x%08X | 0x%08X |' % (h.offset_head, h.offset_sect, h.length, h.crc32, ok_fail(h.crc32, h.crc32_actual), h.version, h.date, h.memory, h.flag)) 288 | print('+%s+' % ('-'*tw,)) 289 | print('') 290 | 291 | 292 | def romfs_print_header(romfs): 293 | """ """ 294 | tw = 100 295 | print('+%s' % ('-'*tw,)) 296 | print('| Ambarella ROMFS Partition found by Magic %s at 0x%08X, file count: %d' % (hex_repr(ROMFS_PARTITION_HEADER_MAGIC), romfs.offset, romfs.file_count)) 297 | print('+%s' % ('-'*tw,)) 298 | print('| %-2s | %-10s | %-10s | %-7s | %-4s | %-10s | %-15s | %s' % ('#', 'Offset', 'Rel. off.', 'Len', 'Pad', 'Next off.', 'CRC32', 'Name')) 299 | print('+%s' % ('-'*tw,)) 300 | for i in romfs.files_directory: 301 | print('| %02d | 0x%08X | 0x%08X | %7d | %4d | 0x%08X | 0x%08X %4s | %s' % (i.pos, i.offset_abs, i.offset_rel, i.length, i.padding_zeroes, romfs.offset + i.offset_next, i.crc32, ok_fail(i.crc32, i.crc32_actual), i.name,)) 302 | print('+%s' % ('-'*tw,)) 303 | print('') 304 | warnings = False 305 | for i in romfs.files_directory: 306 | if i.offset_rel != i.offset_expected : 307 | print('WARNING: File %02d: relative offset declared in header: 0x%08X, calculated: 0x%08X' % (i.pos, i.offset_rel, i.offset_expected)) 308 | warnings = True 309 | if warnings: 310 | print('') 311 | 312 | 313 | def romfs_extract_files(firmware, romfs): 314 | """ Save files from Ambarella ROMFS partition """ 315 | subdir = '%08X_files' % (romfs.offset,) 316 | for i in romfs.files_directory: 317 | dst_file = os.path.join(subdir, i.name) 318 | save_file_part(firmware, dst_file, i.offset_abs, i.length) 319 | print('INFO: File "%s" saved' % (dst_file,)) 320 | print('') 321 | 322 | 323 | #------------------------------------------------------------------------- 324 | # Get filenames from command line. 325 | #------------------------------------------------------------------------- 326 | if len(sys.argv) < 4: 327 | print('Usage: %s FIRMWARE.bin FIRMWARE_CHECK.ch DST_DIRECTORY' % (os.path.basename(sys.argv[0]),)) 328 | sys.exit(1) 329 | firmware_file = sys.argv[1] 330 | firmware_check = sys.argv[2] 331 | dst_directory = sys.argv[3] 332 | if not os.path.exists(firmware_file): 333 | print('ERROR: File "%s" does not exists' % (firmware_file,)) 334 | sys.exit(1) 335 | if not os.path.exists(firmware_check): 336 | print('WARNING: File "%s" does not exists' % (firmware_check,)) 337 | firmware_check = None 338 | if os.path.exists(dst_directory): 339 | print('ERROR: Directory "%s" alrady exists' % (dst_directory,)) 340 | sys.exit(1) 341 | 342 | #------------------------------------------------------------------------- 343 | # Main program. 344 | #------------------------------------------------------------------------- 345 | fw = open(firmware_file, "r+b") 346 | mm = mmap.mmap(fw.fileno(), 0) 347 | 348 | # Check firmware file against the MD5 checksum file. 349 | if firmware_check is not None: 350 | if check_md5(mm, firmware_check): 351 | print('OK: MD5 calculated on file "%s" matches content of "%s"' % (firmware_file, firmware_check)) 352 | else: 353 | print('FAIL: MD5 calculated on file "%s" does not match content of "%s"' % (firmware_file, firmware_check)) 354 | else: 355 | print('WARNING: No checksum for file "%s" was specified' % (firmware_file,)) 356 | 357 | # Parse the header of the firmware file. 358 | file_header = get_firmware_header(mm) 359 | firmware_print_header(file_header) 360 | dst_file = '%08X_header.bin' % (0,) 361 | save_file_part(mm, dst_file, 0, FIRMWARE_FILE_HEADER_LEN) 362 | print('INFO: File "%s" saved' % (dst_file,)) 363 | print('') 364 | 365 | # Search Ambarella sections using Magic identifier. 366 | magics = magic_search_offset(mm, SECTION_MAGIC) 367 | print('Section Magic IDs found at: %s\n' % (' '.join(['0x%08X' % x for x in magics]),)) 368 | sections_magic_offset = [x-24 for x in magics] 369 | 370 | # Verify that offsets found by Magic do match the sections table. 371 | sections_table_offsets = [x.offset for x in file_header.sections_table] 372 | for offset in sections_magic_offset: 373 | if not offset in sections_table_offsets: 374 | print('WARNING: Section found by Magic at offset 0x%08X does not match any entry in sections table' % (offset,)) 375 | 376 | # Get data from sections headers, save files and print info. 377 | section_headers = [] 378 | # Prefer sections found by Magic, not sections table in header. 379 | for offset in sections_magic_offset: 380 | sect_header = get_section_header(mm, offset) 381 | section_headers.append(sect_header) 382 | dst_file = '%08X_head.bin' % (sect_header.offset_head,) 383 | save_file_part(mm, dst_file, sect_header.offset_head, SECTION_HEADER_LEN) 384 | print('INFO: File "%s" saved' % (dst_file,)) 385 | dst_file = '%08X_sect.bin' % (sect_header.offset_sect,) 386 | save_file_part(mm, dst_file, sect_header.offset_sect, sect_header.length) 387 | print('INFO: File "%s" saved' % (dst_file,)) 388 | print('') 389 | section_print_header(section_headers) 390 | 391 | # Search Ambarella ROMFS partition using Magic identifier. 392 | romfs_partitions_offset = magic_search_offset(mm, ROMFS_PARTITION_HEADER_MAGIC) 393 | print('ROMFS Magic IDs found at: %s' % (' '.join(['0x%08X' % x for x in romfs_partitions_offset]),)) 394 | # Print ROMFS files directories, extract files and save file lists. 395 | for offset in romfs_partitions_offset: 396 | romfs_header = get_romfs_header(mm, offset) 397 | # TODO Check filelist! 398 | print('File list count: %d' % (len(romfs_header.files_directory),)) 399 | romfs_print_header(romfs_header) 400 | romfs_extract_files(mm, romfs_header) 401 | filename = '%08X.dir' % (romfs_header.offset,) 402 | with open(os.path.join(dst_directory, filename), 'w') as of: 403 | for i in romfs_header.files_directory: 404 | of.write(i.name + '\n') 405 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 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 | --------------------------------------------------------------------------------