Add documentation to scom_addr_p9.sh, probe_cpus.sh
Change-Id: Id49ebf7c63beff6ff7d9939fa5c0d2e41d28098c
Signed-off-by: Sridevi Ramesh <sridevra@in.ibm.com>
diff --git a/tools/ras/probe_cpus.sh b/tools/ras/probe_cpus.sh
index 33710ea..a1fa03c 100755
--- a/tools/ras/probe_cpus.sh
+++ b/tools/ras/probe_cpus.sh
@@ -1,4 +1,5 @@
#!/bin/bash
+# Refer to help text in the usage function for details.
CPU_SYS_DIR=/sys/devices/system/cpu/
NR_CPUS=0
@@ -8,6 +9,8 @@
function usage()
{
+ echo "This script runs on HOST OS and gives core-id"
+ echo "corresponding to the chip-id."
echo "usage:"
echo " $0 [cpu] [-L]"
echo
diff --git a/tools/ras/scom_addr_p9.sh b/tools/ras/scom_addr_p9.sh
index e0b8098..a7c5ff0 100755
--- a/tools/ras/scom_addr_p9.sh
+++ b/tools/ras/scom_addr_p9.sh
@@ -1,15 +1,17 @@
#!/bin/bash
+# Refer to help text in the usage function for details.
function usage()
{
echo
- echo "usage: $0: <scom_addr> <core-id>"
+ echo "This script runs on HOST OS and gives translated SCOM address."
+ echo "usage: $0: <scom_addr> <core_id>"
echo
echo " <scom_addr>:"
- echo " SCOM address that needs transaltion."
- echo " <core-id>:"
+ echo " SCOM address that needs translation (e.g. '10010800')."
+ echo " <core_id>:"
echo " Core id as obtained from probe_cpu.sh."
- echo " Should be between 0-23."
+ echo " Should be between 0-23 (e.g. '0')."
exit 1
}