adding docs and modules

13 files changed, 145 insertions, 0 deletions

diff --git a/release/README b/release/README
new file mode 100644
index 0000000..ca0b3b4
--- /dev/null
+++ b/release/README
@@ -0,0 +1,106 @@
+#
+# Bellow is what we need to edit after a default XiVO install
+# on the XIOH board.
+# TODO:
+#   * Write the install.sh script
+#   * Finish this How To
+#   * Have the default iPXE install doing this job
+#
+# .
+# |-- etc
+# |   |-- init.d
+# |   |   `-- xioh
+# |   `-- profile.d
+# |       `-- xioh.sh
+# |-- lib
+# |   `-- modules
+# |       `-- 2.6.32-5-686
+# |           `-- xioh
+# |               |-- e1000.ko
+# |               |-- gcu.ko
+# |               |-- gpio.ko
+# |               |-- hssvoice_driver.ko
+# |               |-- tdm_infra.ko
+# |               |-- tdm_setup_driver.ko
+# |               |-- xivo_tdm.ko
+# |               |-- xivovp.ko
+# |               `-- xivoxhfc.ko
+# `-- usr
+#     `-- share
+#         `-- xioh
+#             `-- tts_asterisk.sh
+#
+
+XIOH install SOP
+
+  Contents
+
+    * 1 Install XiVO on the Hard Drive
+
+        * 1.1 Use an other computer
+        * 1.2 Setup the serial console
+
+    * 2 Personalize the system
+
+        * 2.1 Install our modules
+        * 2.2 Configure the init
+
+    * 3 FAQ
+
+        * 3.1 How to set the hardware clock?
+        * 3.2 How to report bugs?
+        * 3.4 Where to find the sources?
+        * 3.5 How to send a patch?
+
+    * 4 Tips
+
+        * 4.1 Setup the serial console with GRUB LEGACY
+
+
+
+  Install XiVO on the Hard Drive
+
+    Use an other computer to install XiVO. Once finished, you need to setup the serial console.
+
+      Setup the serial console
+
+    For GRUB LEGACY, see section Tips.
+    For GRUB 2, edit `/etc/default/grub` and define the following variables (replace if any):
+
+        GRUB_SERIAL_COMMAND="serial --unit=0 --speed=115200 --word=8 --parity=no --stop=1"
+        GRUB_TERMINAL="serial"
+        GRUB_CMDLINE_LINUX="console=ttyS0,115200n8"
+
+    Then, you need to update GRUB with the following command:
+
+        `update-grub`
+
+
+  Personalize the system
+
+    Install our modules
+
+    Mount the Suresnes/Common Filer, and cd to the `Hardware/binary_lkm/release` dir.
+    Then, cp the `modules/xioh` dir in the following directory:
+
+        /lib/modules/`uname -a |awk '{print $3}'`
+
+    Finally install the new modules with the following command:
+
+        depmod -a
+
+    Configure the init
+
+    Copy `etc/init.d/xioh` in `/etc/init.d` and then run the following command:
+
+        update-rc.d xioh defaults
+
+
+  FAQ
+
+    ask on IRC Freenode at #xivo-hard
+
+
+<!-- vi:syntax=markdown tw=80
+  -->
+
diff --git a/release/etc/init.d/xioh b/release/etc/init.d/xioh
new file mode 100755
index 0000000..7ca4f7e
--- /dev/null
+++ b/release/etc/init.d/xioh
@@ -0,0 +1,20 @@
+#!/bin/sh -e
+#
+### BEGIN INIT INFO
+# Provides:          xioh
+# Default-Start:     2 3 4 5
+# Default-Stop:      0 1 6
+# Required-Start:    $remote_fs $syslog $network
+# Required-Stop:     $remote_fs $syslog $network
+# Short-Description: Used to load our drivers. Should be provided though a .deb
+### END INIT INFO
+#
+
+modprobe -f xivovp
+modprobe -f xivoxhfc
+dahdi_cfg -vvv
+
+modprobe gcu
+modprobe e1000
+
+exit 0
diff --git a/release/etc/profile.d/xioh.sh b/release/etc/profile.d/xioh.sh
new file mode 100755
index 0000000..5d142e7
--- /dev/null
+++ b/release/etc/profile.d/xioh.sh
@@ -0,0 +1 @@
+alias haaaaaaaalt="sync;mount -f -o remount,ro / && echo 'RO fs mounted, you can power off now.'"
diff --git a/release/modules/xioh/e1000.ko b/release/modules/xioh/e1000.ko
new file mode 100755
index 0000000..ae89968
--- /dev/null
+++ b/release/modules/xioh/e1000.ko
diff --git a/release/modules/xioh/gcu.ko b/release/modules/xioh/gcu.ko
new file mode 100755
index 0000000..173867e
--- /dev/null
+++ b/release/modules/xioh/gcu.ko
diff --git a/release/modules/xioh/gpio.ko b/release/modules/xioh/gpio.ko
new file mode 100755
index 0000000..696da26
--- /dev/null
+++ b/release/modules/xioh/gpio.ko
diff --git a/release/modules/xioh/hssvoice_driver.ko b/release/modules/xioh/hssvoice_driver.ko
new file mode 100755
index 0000000..2c5088f
--- /dev/null
+++ b/release/modules/xioh/hssvoice_driver.ko
diff --git a/release/modules/xioh/tdm_infra.ko b/release/modules/xioh/tdm_infra.ko
new file mode 100755
index 0000000..8385944
--- /dev/null
+++ b/release/modules/xioh/tdm_infra.ko
diff --git a/release/modules/xioh/tdm_setup_driver.ko b/release/modules/xioh/tdm_setup_driver.ko
new file mode 100755
index 0000000..d468740
--- /dev/null
+++ b/release/modules/xioh/tdm_setup_driver.ko
diff --git a/release/modules/xioh/xivo_tdm.ko b/release/modules/xioh/xivo_tdm.ko
new file mode 100755
index 0000000..0169493
--- /dev/null
+++ b/release/modules/xioh/xivo_tdm.ko
diff --git a/release/modules/xioh/xivovp.ko b/release/modules/xioh/xivovp.ko
new file mode 100755
index 0000000..5858dbc
--- /dev/null
+++ b/release/modules/xioh/xivovp.ko
diff --git a/release/modules/xioh/xivoxhfc.ko b/release/modules/xioh/xivoxhfc.ko
new file mode 100755
index 0000000..e3ac619
--- /dev/null
+++ b/release/modules/xioh/xivoxhfc.ko
diff --git a/release/usr/share/xioh/tts_asterisk.sh b/release/usr/share/xioh/tts_asterisk.sh
new file mode 100755
index 0000000..af06a56
--- /dev/null
+++ b/release/usr/share/xioh/tts_asterisk.sh
@@ -0,0 +1,18 @@
+#!/bin/sh -e
+
+XIOH_HOME=/usr/share/xioh
+TMP_DIR=/tmp
+RESULTS_TMP=$TMP_DIR/results.txt
+SND_TMP=$TMP_DIR/result.wav
+SND_RESULT=$TMP_DIR/result_forast.wav
+
+[ -e $SND_TMP ] && rm -f $SND_TMP
+[ -e $SND_RESULT ] && rm -f $SND_RESULT
+
+
+echo "Asterisk is running" > $RESULTS_TMP
+text2wave $RESULTS_TMP -o $SND_TMP
+sox $SND_TMP -t wav -c1 -r8000 $SND_RESULT
+
+exit 0
+