[HOWTO] Pearl DPF Easy Hacking

----------------------------------------------------------------------------
Some words of warning
----------------------------------------------------------------------------


These tools will help you detect your frames type and/or backup its original
firmware.
If you don't know what that means, then you probably shouldn't even try to use it.


If you don't understand half of what's written here, see the previous paragraph.


Do *NOT* do anything with this unless your are *REALLY* sure you understand what you're doing.


It may void your warranty, leave you with a paperweight or eat your frame.


If possible, use the Linux version of these tools!
See http://sourceforge.net/projects/dpf-ax.


Still here? Okay, you have been warned. Let's do it:


----------------------------------------------------------------------------
Prerequisites
----------------------------------------------------------------------------


1.
The firmware detection & backup programs are written in Python, so you
will need a Python 2 interpreter.
NOTE: Python 2 is required. Python 3 WILL NOT WORK!


Download it either from python.org (+ pythonwin extensions from sf):
http://python.org/download/  (use newest Python 2.7 Windows or Windows X86-64 Installer)
http://sourceforge.net/projects/pywin32/
or (recommended)
ActivePython Community Edition 2.7 (pythonwin extensions already included):
http://www.activestate.com/activepython/downloads ((use newest Python 2.7 Windows x86 or Windows x64 Installer).


2.
A frame with the original Buildwin firmware. An already hacked frame will *NOT* work!


3.
Download the dpf-ax tools: dpf-ax_0.xx_windows.zip from
http://sourceforge.net/projects/dpf-ax/files
("xx" is the version, e. g. "dpf-ax_0.40_windows.zip" - always use the newest one)
and extract the ZIP to, say, C:\.


----------------------------------------------------------------------------
Firmware detection
----------------------------------------------------------------------------


- Connect your frame and enable USB transfer
  (Press "MENU" -> select "USB Connect", "Connect to PC" or whatever its called).
- Wait until Windows shows the frame as a new CD-ROM drive.
  Note: do *NOT* install and/or start the software DPFMate on this CD-ROM!
- Open a Windows Command Prompt (START - Enter "cmd" in search box).
- cd to the directory you extracted the ZIP to, e.g.:
  $ cd c:\dpf-ax\fw


- Detect your frames type & make backup of its firmware:
  $ c:\Python27\python.exe identify.py e:
                                       ^
          Substitute with your CD-ROM drive letter
  A backup of the frames firmware will be saved to "fulldump_win_TIMESTAMP.bin".


- Detect type of a previously made dump:
  $ c:\Python27\python.exe fulldump.py fulldump_win_TIMESTAMP.bin
                                       ^
          Substitute with filename of the dump


If you installed Python to a different path, adjust it accordingly.


Identify.py will tell you if your frame is supported.
If yes --> continue with "Hacking the frame".
If no  --> continue with "Unsupported frame".


----------------------------------------------------------------------------
Firmware backup only
----------------------------------------------------------------------------


- Connect your frame and enable USB transfer
  (Press "MENU" -> select "USB Connect", "Connect to PC" or whatever its called).
- Wait until Windows shows the frame as a new CD-ROM drive.
  Note: do *NOT* install and/or start the software DPFMate on this CD-ROM!
- Open a Windows Command Prompt (START - Enter "cmd" in search box).
- cd to the directory you extracted the dpf-ax ZIP to, e.g.:
  $ cd c:\dpf-ax\fw


- Enter
  $ c:\Python27\python.exe fulldump.py e:
                                       ^
          Substitute with your CD-ROM drive letter
  A backup of the frames firmware will be saved to "fulldump_win_TIMESTAMP.bin".


If you installed Python to a different path, adjust it accordingly.


----------------------------------------------------------------------------
Hacking the frame
----------------------------------------------------------------------------


To flash the modified fw under Windows you need a tool called "ProgSPI.exe"
from Buildwins's SDK. Have a look at
http://openschemes.com/2011/08/24/ax206-hardware-bootloader-well-that-was-easy/
for more information.


Download the firmware package "dpf-ax_0.xx_firmware_YYYMMDD.zip" from
http://sourceforge.net/projects/dpf-ax/files
("xx" is the version, "YYYYMMDD" is a timestamp. Use the one with the newest timestamp).
Extract it and use the fw_TYPE.bin that matches the TYPE identify.py detected.


Note: if ProgSPI.exe tells you something like
"Can't find flash info, please add its info to flash library according to the flash ID"
your flash chip is not in its the list of know devices.
Go to http://forum.doozan.com/list.php?9 and search for "FlashLib.ini".
Use the newest one you can find. If the message still appears, post a request
in this forum (include ProgSPI's output) or - if you are *REALLY* sure what you are
doing - add a new entry to FlashLib.ini by yourself.


----------------------------------------------------------------------------
Unsupported frame
----------------------------------------------------------------------------


If your frame is currently not supported by dpf-ax, post a request in
http://forum.doozan.com/read.php?9,10026. Don't forget to include the
dump of the original firmware.
Or switch to a real OS (Linux), try to understand how dpf-ax works and add the
frame by yourself. ;-)


----------------------------------------------------------------------------
Windows driver
----------------------------------------------------------------------------


There is no Windows driver for hacked frames. Period.


----------------------------------------------------------------------------
Notes
----------------------------------------------------------------------------


- Again: if possible, use the Linux version of these tools!
  See http://sourceforge.net/projects/dpf-ax.
- You need a Python 2 interpreter. Python 3 will not work.
- Fulldump.py and identify.py are not able to detect the size of
  your frames flash chip under Windows. So they will ALWAYS read 1 MB of
  your frames flash (which is enough for type detection), even if
  the flash size is greater than 1 MB.

Fri, 10 May 2013
v0.40 by superelchi
       * General cleanup:
         - Removed unnecessary files.
	 - Makefile cleanup.
	 - README cleanup.
	 - Renamed display firmware files from fw_disp_* to fw_*.
	 - Readded missing "reverse" folder.
	 - Renamed folder "fw" to "tools".
       * Compatibility fixes:
         - Added check for correct sdcc version in src/Makefile.
         - Added headerfile <stdint.h> to dpf.h.
         - Compatibility fix in python/Makefile for non-debian linux.
         - All python skripts now syntax compatible with python 3. But still need python 2.7 to run. :-(
       * Partial windows support:
         - identify.py and fulldump.py now work on windows (see tools/README.windows).
       * identify.py changes:
         - Flashdump now saved to folder tools instead of tools/identify.out.
         - Flashdump filenames now include a date/time stamp.
	 - Renamed temp folder from identify.out to lcd.tmp.
	 - Dropped support for generic models.
	 - Better firmware detection.
	 - Signature expanded to include backlight and contrast type.
	 - "-d" switch will build skeleton lcd files (dpfmodel.h/lcdblit.s/lcdinit.s/lcdsetor.s) in identify.out.
       * Firmware:
         - Dropped support for generic models.
         - New resolution: 160x128.
	 - NO_BATTERY_CHECK in src/Make.config is now uncommented by default.
         - Menu-Setup-Backlight: value wraps around instead of stopping at lowest/highest value.
         - Menu-Setup-Contrast: value wraps around instead of stopping at lowest/highest value.
	 - Better Backlight & contrast handling.
	 - Fixed error in init.c: some types did not wake up on Keypress after Poweroff (by "Menu"|"Off").
       * Deleted all "generic" models:
         - blue.
	 - focal, focal_portrait.
	 - pearl, pearl_portrait.
	 - pink.
	 - white.
       * New models:
	 - abeyerr_black_3 (thx joelbl).
	 - august_dp150a.
	 - coby_dp180 (thx johni).
	 - dx104838_2 (thx j3r, mihre).
	 - dx104838_3 (thx ralf001).
	 - linkdelight_black_portrait_2 (thx Mr. P)
	 - linkdelight_black_portrait_3 (thx prezes551)
	 - veovision (thx ternyk).
	 - xg4241 (thx marcusbrutus).
	 - zipp_dp605 (thx CaptainCheeks).
       * Changed models:
	 - dx104838 brightness control fixed (only on/off supported by this modle).
         - linkdelight_black portrait now supported.
         - yallstock_black_portrait now supported.