Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/linux-sunxi/sunxi-tools.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBernhard Nortmann <bernhard.nortmann@web.de>2016-05-04 23:13:57 +0300
committerBernhard Nortmann <bernhard.nortmann@web.de>2016-05-04 23:13:57 +0300
commit217c440bcfaaea71daacb1cd1e017ad758360d39 (patch)
tree8ad0a23755e342fce4492291cab1f5f7239d9694 /README.md
parent805d2a8e16a4dbf8c8010e6029f4093ae34ee427 (diff)
README: Improve on (markdown) formatting
Signed-off-by: Bernhard Nortmann <bernhard.nortmann@web.de>
Diffstat (limited to 'README.md')
-rw-r--r--README.md102
1 files changed, 53 insertions, 49 deletions
diff --git a/README.md b/README.md
index ad77cc4..ada5432 100644
--- a/README.md
+++ b/README.md
@@ -7,74 +7,78 @@ Copyright (C) 2012 Alejandro Mery <amery@geeks.cl>
Tools to help hacking Allwinner A10 (aka sun4i) based devices and possibly
it's successors, that's why the 'x' in the package name.
-<pre>
-sunxi-fexc:
- `.fex` file (de)compiler
+### sunxi-fexc
+`.fex` file (de)compiler
- Usage: ./sunxi-fexc [-vq] [-I &lt;infmt>] [-O &lt;outfmt>] [&lt;input> [&lt;output>]]
+ Usage: ./sunxi-fexc [-vq] [-I <infmt>] [-O <outfmt>] [<input> [<output>]]
infmt: fex, bin (default:fex)
outfmt: fex, bin (default:bin)
-bin2fex:
- compatibility shortcut to call `sunxi-fexc` to decompile a script.bin
- blob back into `.fex` format used by allwinner's SDK to configure
- the boards.
+### bin2fex
+compatibility shortcut to call `sunxi-fexc` to decompile a _script.bin_
+blob back into `.fex` format used by Allwinner's SDK to configure
+the boards.
-fex2bin:
- compatiblity shortcut to call `sunxi-fexc` to compile a `.fex` file
- into the binary form used by the sun4i kernel.
+### fex2bin
+compatiblity shortcut to call `sunxi-fexc` to compile a `.fex` file
+into the binary form used by the legacy 3.4 kernel ("linux&#8209;sunxi").
-sunxi-fel:
- script interface for talking to the FEL USB handler built in to
- th CPU. You activate FEL mode by pushing the usboot/recovery
- button at poweron. See http://linux-sunxi.org/FEL/USBBoot for
- a detailed usage guide.
+### sunxi-fel
+script interface for talking to the FEL USB handler built in to
+the CPU. You activate [FEL mode] by pushing the _uboot_ / _recovery_
+button at poweron. See http://linux-sunxi.org/FEL/USBBoot for
+a detailed usage guide.
-fel-gpio:
- Simple wrapper around fel-pio and fel to allos GPIO manipulations
- via FEL
-
-fel-sdboot:
- ARM native sdcard bootloader forcing the device into FEL mode
+### fel-gpio
+Simple wrapper (script) around `fel-pio` and `sunxi-fel`
+to allow GPIO manipulations via FEL
-fel-pio:
- ARM native helper for fel-gpio
+### fel-sdboot
+ARM native sdcard bootloader forcing the device into FEL mode
-sunxi-pio:
- Manipulate PIO register dumps
+### fel-pio
+ARM native helper (binary) for `fel-gpio`
-sunxi-nand-part:
- Tool for manipulating Allwinner NAND partition tables
+### sunxi-pio
+Manipulate PIO register dumps
-jtag-loop.sunxi:
- ARM native boot helper to force the SD port into JTAG
- and then stop, to ease debugging of bootloaders.
+### sunxi-nand-part
+Tool for manipulating Allwinner NAND partition tables
+
+### jtag-loop.sunxi
+ARM native boot helper to force the SD port into JTAG and then stop,
+to ease debugging of bootloaders.
+
+### sunxi-bootinfo
+Dump information from Allwinner boot files (_boot0_ / _boot1_)
-sunxi-bootinfo:
- Dump information from Allwinner boot files (boot0/boot1)
--type=sd include SD boot info
--type=nand include NAND boot info (not implemented)
-phoenix_info:
- gives information about a phoenix image created by the
- phoenixcard utility and optionally extracts the embedded boot
- code & firmware file from their hidden partitions.
+### phoenix_info
+gives information about a phoenix image created by the
+phoenixcard utility and optionally extracts the embedded boot
+code & firmware file from their hidden partitions.
+
+### sunxi-meminfo
+Tool for reading DRAM settings from registers. Compiled as a
+static binary for use on android and other OSes.
+To build this, get a toolchain and run:
+
+ make CROSS_COMPILE=arm-linux-gnueabihf- sunxi-meminfo
-sunxi-meminfo:
- Tool for reading DRAM settings from registers. Compiled as a
- static binary for use on android and other OSes. To build this,
- get a toolchain, and run:
- make CROSS_COMPILE=arm-linux-gnueabihf- sunxi-meminfo
+### sunxi-script_extractor
+A simple tool, which can be executed on a rooted Android device
+to dump the _script.bin_ blob from RAM via reading _/dev/mem_.
+To build this, get a toolchain and run:
-sunxi-script_extractor:
- A simple tool, which can be executed on a rooted Android device
- to dump the script.bin blob from RAM via reading /dev/mem.
- To build this, get a toolchain, and run:
- make CROSS_COMPILE=arm-linux-gnueabihf- sunxi-script_extractor
-</pre>
+ make CROSS_COMPILE=arm-linux-gnueabihf- sunxi-script_extractor
+---
+## License
This software is licensed under the terms of GPLv2+ as defined by the
Free Software Foundation, details can be read in the [COPYING][] file.
-[copying]: COPYING \ No newline at end of file
+[copying]: COPYING
+[fel mode]: http://linux-sunxi.org/FEL