RfidResearchGroup/proxmark3
1
1
Fork 0
mirror of https://github.com/RfidResearchGroup/proxmark3.git synced 2025-03-16 01:53:02 +08:00
Code Issues Projects Releases Packages Wiki Activity

adapt flasher docs

Browse source
This commit is contained in:
Philippe Teuwen 2019-09-09 19:55:55 +02:00
parent 6385ee960f
commit 9f88580061
3 changed files with 38 additions and 105 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

43
doc/md/Installation_Instructions/Mac-OS-X-Homebrew-Installation-Instructions.md
View file

@ -84,39 +84,14 @@ brew install RfidResearchGroup/proxmark3/arm-none-eabi-gcc
## Compile and use the project
To use the compiled client, the only difference is that the Proxmark3 port is `/dev/tty.usbmodemiceman1`, so commands become:
```sh
proxmark3 /dev/ttyACM0 => proxmark3 /dev/tty.usbmodemiceman1
```
Now you're ready to follow the [compilation instructions](/doc/md/Use_of_Proxmark/0_Compilation-Instructions.md).
To use the compiled client and flasher, the only difference is that the Proxmark3 port is `/dev/tty.usbmodemiceman1`.
To flash: With your Proxmark3 unplugged from your machine, press and hold the button on your Proxmark3 as you plug it into a USB port. You can release the button, two of the four LEDs should stay on. You're un bootloader mode, ready for the next step. In case the two LEDs don't stay on when you're releasing the button, you've an old bootloader, start over and keep the button pressed during the whole flashing procedure.
In principle, the helper script `pm3-flash-all` should auto-detect your port, so you can just try:
```sh
pm3-flash-all
```
If port detection failed, you'll have to call the flasher manually and specify the correct port:
```sh
proxmark3 /dev/tty.usbmodemiceman1 --flash --unlock-bootloader --image /usr/local/share/proxmark3/firmware/bootrom.elf --image /usr/local/share/proxmark3/firmware/fullimage.elf
```
or from the local repo
```sh
client/proxmark3 /dev/tty.usbmodemiceman1 --flash --unlock-bootloader --image bootrom/obj/bootrom.elf --image armsrc/obj/fullimage.elf
```
Similarly, to run the client, you may try:
```sh
pm3
```
Or, by specifying the port manually:
```sh
proxmark3 /dev/tty.usbmodemiceman1
```
To flash on OS X, better to enter the bootloader mode manually, else you may experience errors.
With your Proxmark3 unplugged from your machine, press and hold the button on your Proxmark3 as you plug it into a USB port. You can release the button, two of the four LEDs should stay on. You're in bootloader mode, ready for the next step. In case the two LEDs don't stay on when you're releasing the button, you've an old bootloader, start over and keep the button pressed during the whole flashing procedure.
From there, you can follow the original compilation instructions.

76
doc/md/Installation_Instructions/Windows-Installation-Instructions.md
View file

@ -52,40 +52,14 @@ pacman -S mingw-w64-x86_64-astyle
## Compile and use the project
To use the compiled client, the only differences are that executables end with `.exe` (e.g. `proxmark3.exe`) and that the Proxmark3 port is one of your `comX` ports where "X" is the com port number assigned to proxmark3 under Windows, so commands become:
```sh
proxmark3 /dev/ttyACM0 => proxmark3.exe comX
```
Now you're ready to follow the [compilation instructions](/doc/md/Use_of_Proxmark/0_Compilation-Instructions.md).
To use the compiled client and flasher, the only differences are that executables end with `.exe` (e.g. `proxmark3.exe`) and that the Proxmark3 port is one of your `comX` ports where "X" is the com port number assigned to proxmark3 under Windows.
To flash: In principle, the helper script `pm3-flash-all` should auto-detect your COM port, so you can just try:
```sh
pm3-flash-all
```
If COM port detection failed, you'll have to call the flasher manually and specify the correct port:
```sh
proxmark3 comX --flash --unlock-bootloader --image /usr/local/share/proxmark3/firmware/bootrom.elf --image /usr/local/share/proxmark3/firmware/fullimage.elf
```
or from the local repo
```sh
client/proxmark3 comX --flash --unlock-bootloader --image bootrom/obj/bootrom.elf --image armsrc/obj/fullimage.elf
```
Similarly, to run the client, you may try:
```sh
pm3
```
Or, by specifying the COM port manually:
```sh
proxmark3.exe comX
```
# Installing on Windows with WSL
It requires to run a Windows 10 version 1709 or above. Previous versions didn't have support for COM ports.
@ -118,9 +92,11 @@ git clone https://github.com/RfidResearchGroup/proxmark3.git
## Compile and use the project
Now you're ready to follow the [compilation instructions](/doc/md/Use_of_Proxmark/0_Compilation-Instructions.md).
To use the compiled client, the only difference is that the Proxmark3 port is translated from your `comX` port where "X" is the com port number assigned to proxmark3 under Windows, to a `/dev/ttySX`, so commands become:
To use the compiled client and flasher, the only difference is that the Proxmark3 port is translated from your `comX` port where "X" is the com port number assigned to proxmark3 under Windows, to a `/dev/ttySX`.
```sh
proxmark3 /dev/ttyACM0 => proxmark3 /dev/ttySX
```
Depending on the Windows version, you might need to give permission to the current user to access `/dev/ttySX`: (change X to your port number)
@ -147,34 +123,6 @@ and add it to your Bash profile for the next times:
echo "export DISPLAY=:0" >> ~/.bashrc
```
To flash: In principle, the helper script `pm3-flash-all` should auto-detect your COMX==/dev/ttySX port, so you can just try:
```sh
pm3-flash-all
```
If port detection failed, you'll have to call the flasher manually and specify the correct port:
```sh
proxmark3 /dev/ttySX --flash --unlock-bootloader --image /usr/local/share/proxmark3/firmware/bootrom.elf --image /usr/local/share/proxmark3/firmware/fullimage.elf
```
or from the local repo
```sh
client/proxmark3 /dev/ttySX --flash --unlock-bootloader --image bootrom/obj/bootrom.elf --image armsrc/obj/fullimage.elf
```
Similarly, to run the client, you may try:
```sh
pm3
```
Or, by specifying the COM port manually:
```sh
proxmark3 /dev/ttySX
```
Note that it may take a quite long time for a freshly plugged Proxmark3 to be visible on a WSL /dev/ttySX port.
Now you're ready to follow the [compilation instructions](/doc/md/Use_of_Proxmark/0_Compilation-Instructions.md).

24
doc/md/Use_of_Proxmark/0_Compilation-Instructions.md
View file

@ -40,18 +40,28 @@ e.g. calling `./pm3` or `client/proxmark3` instead of just `pm3` or `proxmark3`.
## Flash the BOOTROM & FULLIMAGE
In most cases, you can run the script `pm3-flash-all` which try to auto-detect the port to use, on several OS.
For the other cases, specify the port by yourself. For example, for a Proxmark3 connected via USB under Linux:
In most cases, you can run the following script which try to auto-detect the port to use, on several OS:
```sh
proxmark3 /dev/ttyACM0 --flash --unlock-bootloader --image /usr/local/share/proxmark3/firmware/bootrom.elf --image /usr/local/share/proxmark3/firmware/fullimage.elf
pm3-flash-all
```
or from the local repo
For the other cases, specify the port by yourself. For example, for a Proxmark3 connected via USB under Linux (adjust the port for your OS):
```sh
client/proxmark3 /dev/ttyACM0 --flash --unlock-bootloader --image bootrom/obj/bootrom.elf --image armsrc/obj/fullimage.elf
proxmark3 /dev/ttyACM0 --flash --unlock-bootloader --image bootrom.elf --image fullimage.elf
```
The firmware files will be searched in the expected locations (installed files, working repo files, user folder, etc.). You can also specify their location:
```sh
pm3-flash -b /tmp/my-bootrom.elf /tmp/my-fullimage.elf
```
or
```sh
proxmark3 /dev/ttyACM0 --flash --unlock-bootloader --image /tmp/my-bootrom.elf --image /tmp/my-fullimage.elf
```
## Run the client
@ -60,7 +70,7 @@ In most cases, you can run the script `pm3` which try to auto-detect the port to
For the other cases, specify the port by yourself. For example, for a Proxmark3 connected via USB under Linux:
Here, for example, for a Proxmark3 connected via USB under Linux:
Here, for example, for a Proxmark3 connected via USB under Linux (adjust the port for your OS):
```sh
proxmark3 /dev/ttyACM0