diff --git a/CHANGELOG.md b/CHANGELOG.md index c02d4496e..caa56107e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,6 +3,7 @@ All notable changes to this project will be documented in this file. This project uses the changelog in accordance with [keepchangelog](http://keepachangelog.com/). Please use this to write notable changes, which is not the same as git commit log... ## [unreleased][unreleased] +- Added doc/md/PM5_Start_Here/Getting_Started_With_PM5.md now exists as a starting point for those who have their PM5 (@innocentbystanderproxmark) - Fixed `tools/ePassport` - the personal number read from the MRZ optional-data field showed a filler character where a space belonged, and a document number longer than nine characters left its overflow there (@pkilar) - Fixed `tools/ePassport` - the detail tabs named the files their data came from as fixed text, so a document without EF_DG11 was told otherwise, and the personal-number caption wrapped (@pkilar) - Added `tools/ePassport` - EF_DG13 is decoded, and a Polish document's PESEL is shown as the personal number when it carries no EF_DG11 (@pkilar) diff --git a/doc/md/PM5_Start_Here/Getting_Started_With_PM5.md b/doc/md/PM5_Start_Here/Getting_Started_With_PM5.md index 4eabef6cf..7e16a992c 100644 --- a/doc/md/PM5_Start_Here/Getting_Started_With_PM5.md +++ b/doc/md/PM5_Start_Here/Getting_Started_With_PM5.md @@ -123,56 +123,26 @@ hf 14a read --drop sudo apt-get install dfu-util ``` + ### DFU Mode * Press and hold the button while plugging in the Proxmark5 to the USB port on the same side as the button. You will know that you are in DFU Mode when the lights go off. Continue to hold the button down the entire time you are running `dfu-util` commands. -### Option 1: The device hangs while flashing over USB -* Put your Proxmark5 into [DFU Mode](#DFU-Mode) -* Backup the existing firmware -``` -sudo dfu-util -d 2e3c:df11 -a 0 -s 0x08000000:1048576 -U pm5-full-flash-backup.bin -``` -* Prep the files to use -``` -rm -f /tmp/pm5-bootrom.bin /tmp/pm5-fullimage.bin -arm-none-eabi-objcopy -O binary bootrom/obj/bootrom.elf /tmp/pm5-bootrom.bin -arm-none-eabi-objcopy -O binary armsrc/obj/fullimage.elf /tmp/pm5-fullimage.bin -``` -* Flash the bootrom -``` -sudo dfu-util -d 2e3c:df11 -a 0 -s 0x08000000 -D /tmp/pm5-bootrom.bin -``` -* Flash the Fullimage -``` -sudo dfu-util -d 2e3c:df11 -a 0 -s 0x08004000:leave -D /tmp/pm5-fullimage.bin -``` -* Unplug -* [Go back where you were in the process and continue from there.](#Flash-the-Bootrom) +### You're here because your Proxmark5 failed to flash or is unresponsive/won't enter *Boot Mode*. - -### Option 2: The device seems unresponsive and is unable to enter Boot Mode. Recover to factory/known safe firmware. * The Proxmark5 does not require J-Link or similar tools for unbricking. * Put your Proxmark5 into [DFU Mode](#DFU-Mode) -* Optional: Backup the existing firmware +* Backup the existing firmware ( technically optional ) ``` sudo dfu-util -d 2e3c:df11 -a 0 -s 0x08000000:1048576 -U pm5-full-flash-backup.bin ``` -#### Method 1: Flash everthing together * Flash All to recovery version ``` sudo dfu-util -d 2e3c:df11 -a 0 -s 0x08000000:leave -D recovery/recovery.bin ``` -#### Method 2: Flash Bootrom and Fullimage individually +* Unplug +* If this is your first time through this document [Go back where you were in the process and continue from there.](#Flash-the-Bootrom) -* Flash the Bootrom -``` -sudo dfu-util -d 2e3c:df11 -a 0 -s 0x08000000 -D recovery/bootrom.bin -``` -* Flash the Fullimage -``` -sudo dfu-util -d 2e3c:df11 -a 0 -s 0x08004000:leave -D recovery/fullimage.bin -``` ### Windows Options @@ -211,4 +181,8 @@ Do not use them unless you fully understand what you're doing. ## Links to Further Reading -- [BWM Usage Document](./BWM-USAGE.md) +- [BWM Usage Document](./PM5-BWM-USAGE.md) +- [PM5 ANT Controller](./PM5_Controllers/PM5_ANT_Controller_RM.md) +- [PM5 Button Controller](./PM5_Controllers/PM5_Button_Controller_RM.md) +- [PM5 RGB Controller](./PM5_Controllers/PM5_RGB_Controller_RM.md) +- [PM5 BWM Install](https://github.com/RfidResearchGroup/Proxmark5_BWM_esp32/blob/master/INSTALL.md) diff --git a/doc/md/PM5_Start_Here/BWM-USAGE.md b/doc/md/PM5_Start_Here/PM5-BWM-USAGE.md similarity index 100% rename from doc/md/PM5_Start_Here/BWM-USAGE.md rename to doc/md/PM5_Start_Here/PM5-BWM-USAGE.md diff --git a/doc/md/PM5_Controllers/PM5_ANT_Controller_RM.md b/doc/md/PM5_Start_Here/PM5_Controllers/PM5_ANT_Controller_RM.md similarity index 100% rename from doc/md/PM5_Controllers/PM5_ANT_Controller_RM.md rename to doc/md/PM5_Start_Here/PM5_Controllers/PM5_ANT_Controller_RM.md diff --git a/doc/md/PM5_Controllers/PM5_Button_Controller_RM.md b/doc/md/PM5_Start_Here/PM5_Controllers/PM5_Button_Controller_RM.md similarity index 100% rename from doc/md/PM5_Controllers/PM5_Button_Controller_RM.md rename to doc/md/PM5_Start_Here/PM5_Controllers/PM5_Button_Controller_RM.md diff --git a/doc/md/PM5_Controllers/PM5_RGB_Controller_RM.md b/doc/md/PM5_Start_Here/PM5_Controllers/PM5_RGB_Controller_RM.md similarity index 100% rename from doc/md/PM5_Controllers/PM5_RGB_Controller_RM.md rename to doc/md/PM5_Start_Here/PM5_Controllers/PM5_RGB_Controller_RM.md