-
Notifications
You must be signed in to change notification settings - Fork 38
Quansheng UV-K5 EEPROM programmer
License
sq5bpf/k5prog
Folders and files
Name | Name | Last commit message | Last commit date | |
---|---|---|---|---|
Repository files navigation
k5prog - Quansheng UV-K5 EEPROM and flash programmer v0.9 (c) 2023 Jacek Lipkowski <sq5bpf@lipkowski.org> This program can read and write the EEPROM of Quansheng UV-K5. It can read/write arbitrary data, and might be useful for making backups of the configuration, mass programming of radios or reverse engineering of the radio configuration. Please note that it is probably possible to break your radio by writing a bad configuration to it, so please use at your own risk. Note that this program does not edit the contents of the EEPROM. Use an external hex editor. The program can also flash the firmware on the Quansheng UV-K5. This will flash the raw binary, and not the Quansheng-encrypted firmware files. A Quansheng-encrypted firmware can be decrypted using the fw.py script from here: https://github.com/fagci/qs-uvk5-firmware-modder An example decrypted file is provided in k5_flash_test.raw, this is the vendor 2.01.23 firmware without any modifications. Please use extreme caution, as reprogramming the radioflash can potentially brick your radio. If unsure, please use the vendor flashing software. The flashing support in k5prog was used in at least 2 cases to recover radios which were bricked by flashing firmware using the vendor flasher. I don't know why this worked, but it did. To compile, please see the compiling section at the end. The program is written to (hopefully) run on POSIX systems. Testing was done on GNU/Linux, but macOS and Windows under Cygwin should work too. For licensing see the file LICENSE. ---- Usage ---- to display help run the program without arguments, or with the -h option. The configuration options are: Quansheng UV-K5 EEPROM programmer v0.8 (c) 2023 Jacek Lipkowski <sq5bpf@lipkowski.org> cmdline opts: -f <file> filename that contains the EEPROM dump (default: k5_eeprom.raw) -b <file> filename that contains the raw flash image (default k5_flash.raw) -Y increase "I know what I'm doing" value, to enable functionality likely to break the radio -D wait for the message from the radio flasher, print it's version -F flash firmware, WARNING: this will likely brick your radio! -M <ver> Set the firmware major version to <ver> during the flash process (default: *.01.23) -r read EEPROM -w write EEPROM like the original software does -W write most of the EEPROM (but without what I think is calibration data) -B write ALL of the EEPROM (the "brick my radio" mode) -p <port> device name (default: /dev/ttyUSB0) -s <speed> serial speed (default: 38400, the UV-K5 doesn't accept any other speed) -h print this help -v be verbose, use multiple times for more verbosity ---- Reading/writing the configuration EEPROM ---- For a basic usage use -r to read EEPROM, -w to write EEPROM. The -v option gives more verbosity. Read configuration: sq5bpf@chronos:~/k5prog$ ./k5prog -r -v Quansheng UV-K5 EEPROM programmer v0.5 (c) 2023 Jacek Lipkowski <sq5bpf@lipkowski.org> k5_prepare: try 0 ****** Connected to firmware version: [k5_2.01.23] Successfully read EEPROM The EEPROM contents are written to the file k5_eeprom.raw, this can be changed with the -f option. Write configuration from file k5_eeprom.raw: sq5bpf@chronos:~/chirp/k5prog$ ./k5prog -w -v Quansheng UV-K5 EEPROM programmer v0.5 (c) 2023 Jacek Lipkowski <sq5bpf@lipkowski.org> k5_prepare: try 0 ****** Connected to firmware version: [k5_2.01.23] Read file k5_eeprom.raw success Successfully wrote EEPROM The -w option writes only the memory blocks which are written by the original radio software, in the same order. The -W option is a bit braver as it writes all memory upto 0x1d00. I _think_ that the radio has calibration data above this address, but of course this is not certain, because this knowledge is a result of reverse engineering, and not information from the manufacturer. The -B option is the "brick my radio" mode. It writes all memory, possibly allowing overwriting of calibration data (if there is any) or other data which may be critical to the proper functioning of your radio. I have used this on my radio, and it still works but please be extra-careful. I have written the radio EEPROM with the -W option tens of times, and others have too. So far it hasn't produced any bad results. But of course beware. ---- Flashing support ---- The flashing support is for the really brave people who know what they are doing (hence the -Y flag is needed). It is possible to read the bootloader version using the -D option. This option is safe, but needs the -Y value. Put the radio into flash mode and: ./k5prog -Y -D Quansheng UV-K5 EEPROM programmer v0.5 (c) 2023 Jacek Lipkowski <sq5bpf@lipkowski.org> "I know what I'm doing" value set to 1 ******** k5 command hexdump [obf_len:44 clear_len:36 crc_ok:1 ********** ## obfuscated ## 0x00002c |0 |1 |2 |3 |4 |5 |6 |7 |8 |9 |a |b |c |d |e |f | ---------+--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+------------ 0x000000: ab cd 24 00 0e 69 34 e6 2f 93 0f 46 3d 66 85 0a ..$..i4./..F=f.. 0x000010: 24 44 16 8f 9a 6c 47 e6 1c bf 3d 70 0f 05 e3 40 $D...lG...=p...@ 0x000020: 27 09 e9 80 16 6c 14 c6 d1 6e dc ba '....l...n.. ## cleartext ## 0x000024 |0 |1 |2 |3 |4 |5 |6 |7 |8 |9 |a |b |c |d |e |f | ---------+--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+------------ 0x000000: 18 05 20 00 01 02 02 06 1c 53 50 4a 37 47 ff 0f .. ......SPJ7G.. 0x000010: 8c 00 53 00 32 2e 30 30 2e 30 36 00 34 0a 00 00 ..S.2.00.06.4... 0x000020: 00 00 00 20 ... ***************** Flasher version is: [2.00.06] The radio can also be flashed with the raw unencrypted binary. An example binary is provided in the k5_flash.raw file (this is the 2.01.23 firmware). The binary file can be specified with the -b option. Flashing the radio requires the "I know what I'm doing value" of at least 5. ./k5prog -b k5_flash.raw -YYYYYY -F Quansheng UV-K5 EEPROM programmer v0.5 (c) 2023 Jacek Lipkowski <sq5bpf@lipkowski.org> "I know what I'm doing" value set to 6 ******** k5 command hexdump [obf_len:44 clear_len:36 crc_ok:1 ********** ## obfuscated ## 0x00002c |0 |1 |2 |3 |4 |5 |6 |7 |8 |9 |a |b |c |d |e |f | ---------+--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+------------ 0x000000: ab cd 24 00 0e 69 34 e6 2f 93 0f 46 3d 66 85 0a ..$..i4./..F=f.. 0x000010: 24 44 16 8f 9a 6c 47 e6 1c bf 3d 70 0f 05 e3 40 $D...lG...=p...@ 0x000020: 27 09 e9 80 16 6c 14 c6 d1 6e dc ba '....l...n.. ## cleartext ## 0x000024 |0 |1 |2 |3 |4 |5 |6 |7 |8 |9 |a |b |c |d |e |f | ---------+--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+------------ 0x000000: 18 05 20 00 01 02 02 06 1c 53 50 4a 37 47 ff 0f .. ......SPJ7G.. 0x000010: 8c 00 53 00 32 2e 30 30 2e 30 36 00 34 0a 00 00 ..S.2.00.06.4... 0x000020: 00 00 00 20 ... ***************** Flasher version is: [2.00.06] *** FLASH at 0x0000 length 0x0100 result=1 *** FLASH at 0x0100 length 0x0100 result=1 *** FLASH at 0x0200 length 0x0100 result=1 *** FLASH at 0x0300 length 0x0100 result=1 etc... until all flash is writtem It is possible to set the flashed firmware version, which will be later checked by the bootloader. Currently this is set to *.01.23, which all known bootloaders will accept, but can be set explicitly to some firmware version like: /k5prog -YYY -F -M '2.01.23' -b firmware.bin ---- Compiling ---- This software was tested to compile using gcc on GNU/Linux systems, using a simple makefile: sq5bpf@dellix:~/k5prog-0.1$ make gcc -O2 k5prog.c -o k5prog Other POSIX platforms should work also, including macOS. The software compiles under Cygwin/Microsoft Windows, but has not been tested. According to the Cygwin documentation you should use /dev/comX to use port comX (for example using com6: k5prog.exe -v -r -p /dev/com6) If you port this to another platform, or do anything interesting with this software, tell me about it. ---- Other uses ---- The file uvk5_original_eeprom.raw contains an EEPROM downloaded from an UV-K5 radio. Maybe it can be used to resurrect another radio of the same type if it was broken (perhaps by the use of this software :). ---- Protocol ---- The programming protocol used by this software has been reverse engineered by observing communications between the radio and the original programming software. It is not a variation of the typical Baofeng-like protocol. The format of the datagram sent to the radio is: 0xAB 0xCD len 0x00 <data bytes> <2 bytes CRC> 0xDC 0xBA The length is the length of the data bytes. The data is protected by a typical CRC-16 xmodem algorithm. The data bytes and the CRC are obfuscated by xor-in it with an 8-byte sequence. Fortunately the EEPROM data contains a lot of 0xFF and 0x00 bytes, so the XOR sequence is easy to find by observing the traffic. The datagram sent from the radio is the same, but the CRC field is set to 0xFFFF. This shows that the CRC is not for data integrity, but for further obfuscation (same as the XOR). I intend to publish a further description of the protocol, and the EEPROM contents, meanwhile the sources can be used as documentation. VY 73 Jacek / SQ5BPF
About
Quansheng UV-K5 EEPROM programmer
Resources
License
Stars
Watchers
Forks
Releases
No releases published
Packages 0
No packages published