From d7c7060a1693e2fb423bcf33cf5521279781c675 Mon Sep 17 00:00:00 2001
From: Christopher Roy Bratusek <nano@tuxfamily.org>
Date: Fri, 28 Dec 2012 18:55:28 +0100
Subject: [PATCH] add API doc for 1.1

---
 libruntimeiospatch/API    | 98 +++++++++++++++++++++++++++++++++++++++
 libruntimeiospatch/README | 40 +---------------
 2 files changed, 99 insertions(+), 39 deletions(-)
 create mode 100644 libruntimeiospatch/API

diff --git a/libruntimeiospatch/API b/libruntimeiospatch/API
new file mode 100644
index 0000000..2239c39
--- /dev/null
+++ b/libruntimeiospatch/API
@@ -0,0 +1,98 @@
+libruntimeiospatch function overview
+====================================
+
+libruntimeiospatch 1.0:
+
+====================
+=== have_ahbprot ===
+====================
+
+This function returns true, then there is HW_AHBPROT access available.
+
+>> Flags: none
+
+******
+if (have_ahbprot()) {
+    do_something
+else
+    do_something_else
+fi
+******
+
+========================
+=== IosPatch_AHBPROT ===
+========================
+
+This function can be used to keep HW_AHBPROT access when going to reload IOS
+
+>> Flags: [bool]verbose (whether to print messages on-screen)
+
+******
+if(have_ahbprot()) {
+	s32 ret;
+    ret = IosPatch_AHBPROT(false);
+	if (ret) {
+        IOS_ReloadIOS(36);
+    } else {
+        printf("IosPatch_AHBPROT failed.");
+    }
+}
+******
+
+========================
+=== IosPatch_RUNTIME ===
+========================
+
+This function applies patches on current IOS
+
+>> Flags: [bool]wii (whether to apply Wii patches)
+          [bool]sciifii (whether to apply extra Sciifii patches)
+          [bool]vwii (whether to apply extra vWii patches)
+          [bool]verbose (whether to print messages on-screen)
+
+<< Patchsets:
+Wii:
+    * DI Readlimit
+    * ISFS Permissions
+    * ES SetUID
+    * ES SetIdentify
+    * Hash Check (aka Trucha)
+    * New Hash Check (aka New Trucha)
+
+Sciifii:
+    * MEM2 Prot
+    * ES OpenTitleContent 1 & 2
+    * ES ReadContent Prot
+    * ES CloseContent
+    * Es TitleVersionCheck
+    * ES TitleDeleteCheck
+
+vWii:
+   * Kill Anti-SystemTitle-Install 1, 2, 3, 4 & 5
+
+
+******
+If(have_ahbprot()) {
+	IosPatch_RUNTIME(true, false, false, false);
+}
+******
+
+libruntimeiospatch 1.1:
+
+=====================
+=== IosPatch_FULL ===
+=====================
+
+This function combines IosPatch_AHBPROT + IOS_ReloadIOS + IosPatch_RUNTIME
+
+>> Flags: [bool]wii (whether to apply Wii patches)
+          [bool]sciifii (whether to apply extra Sciifii patches)
+          [bool]vwii (whether to apply extra vWii patches)
+          [bool]verbose (whether to print messages on-screen)
+          [int]ios (which IOS to reload into)
+
+******
+If(have_ahbprot()) {
+	IosPatch_FULL(true, false, false, false, 58);
+}
+******
\ No newline at end of file
diff --git a/libruntimeiospatch/README b/libruntimeiospatch/README
index 4e96c9e..ee4e75a 100644
--- a/libruntimeiospatch/README
+++ b/libruntimeiospatch/README
@@ -12,45 +12,7 @@ LIBS := -lruntimeiospatch // Makefile
 
 === API ===
 
-have_ahbprot(): this function returns true, then there is HW_AHBPROT available
-
-IosPatch_AHBPROT(bool verbose): this function can be used to keep HW_AHBPROT when going to reload IOS
-
-example:
-...
-if(have_ahbprot()) {
-	IosPatch_AHBPROT(false);
-	IOS_ReloadIOS(36);
-	...
-}
-...
-
-IosPatch_RUNTIME(bool wii, bool sciifii, bool vwii, bool verbose): this function applies patches into IOS
-
-Flags:
-wii: apply standard wii patches (DI Readlimit, ISFS Permissions, ES SetUID, ES SetIdentify, Hash Check (aka Trucha), New Hash Check (aka New Trucha))
-sciifii: apply additional sciifii patches (MEM2 Prot, ES OpenTitleContent 1+2, ES ReadContent Prot, ES CloseContent, Es TitleVersionCheck, ES TitleDeleteCheck)
-vwii: apply special vwii-only patches (Kill Anti-SystemTitle-Install 1-5)
-
-example:
-
-...
-If(have_ahbprot()) {
-	IosPatch_RUNTIME(true, false, false, false);
-	...
-}
-...
-
-IosPatch_FULL(bool wii, bool sciifii, bool vwii, bool verbose, int IOS): this function combines IosPatch_AHBPROT + IOS_ReloadIOS + IosPatch_RUNTIME
-
-example:
-
-...
-If(have_ahbprot()) {
-	IosPatch_FULL(true, false, false, false, 58);
-	...
-}
-...
+see File "API"
 
 = Thanks =
 - libOGC devs