changeset 94:b443d0665c1f

top README and INSTALL files added
author Mychaela Falconia <falcon@freecalypso.org>
date Mon, 17 Jul 2017 08:28:57 +0000
parents 20e2b4571cd6
children b68301b38ff2
files INSTALL README
diffstat 2 files changed, 58 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/INSTALL	Mon Jul 17 08:28:57 2017 +0000
@@ -0,0 +1,35 @@
+The calibration software needs to be installed on a Unix/Linux machine that is
+able to communicate serially with both your CMU200 instrument and your Calypso
+devices to be calibrated.  Because we use serial communication with the CMU200
+instead of GPIB, no exotic drivers or libraries are needed.  However, you do
+need to have FreeCalypso host tools (release fc-host-tools-r5 or later)
+installed on your system under /opt/freecalypso before you can compile and
+install the present calibration software, as we use the rvinterf program from
+FC host tools to communicate with Calypso DUTs (or more precisely, with the
+L1TM component in their firmware), and we need some rvinterf definitions in
+order to compile.
+
+Once you have fc-host-tools-r5 or later compiled and installed under
+/opt/freecalypso, run 'make' to compile the calibration sw.  Then run
+'make install' to add the calibration programs to your FC software installation
+under /opt/freecalypso.
+
+You will also need to create one or more cable config files corresponding to
+your cabling setup(s); see doc/cableconf-example.  These cable config files
+need to be placed in the /opt/freecalypso/rfcal/cableconf directory, and they
+should be given some appropriately descriptive names:
+
+* If you have a cable setup that terminates in an SMA connector for calibrating
+  Calypso GSM devices with SMA antenna interfaces, the corresponding cable
+  config file should be named "sma".
+
+* If you have a cable setup that terminates in an MS-147 probe connector for
+  recalibrating Mot C1xx phones or similar, the corresponding cable config file
+  should be named "ms147".
+
+* If you have a cable setup that terminates in a Murata SWD/SWF probe for
+  working with devices like Openmoko GTA0x, the corresponding cable config file
+  should be named "murata".
+
+You will then select the cable configuration to be used in a given calibration
+session with the -c option to fc-cmu200d.
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README	Mon Jul 17 08:28:57 2017 +0000
@@ -0,0 +1,23 @@
+You are looking at the suite of software tools developed by the Mother of
+FreeCalypso for calibrating a number of RF parameters on TI-based GSM devices.
+The use of this software absolutely requires highly specialized RF test
+equipment (R&S CMU200 is the only equipment make and model for which support is
+currently implemented) which needs to be connected to the DUT (device under
+test) with an RF coax; all calibration procedures involve the connected external
+test equipment either analyzing the RF signal put out by the DUT or acting as a
+signal generator.  If you don't have the necessary RF test equipment, the
+software alone cannot do anything useful for you.
+
+Because the present software is not intended or usable for end users, a fairly
+advanced level of skill and understanding is expected from the operator.  The
+write-ups in the doc subdirectory provide some guidance, but you are expected
+to study the source code for yourself to fill in the remaining details.
+
+The automated calibration software resides in the autocal and cmu200
+subdirectories; the part in the cmu200 subdir is naturally specific to the R&S
+CMU200, whereas the part in the autocal subdir is agnostic to the specific type
+of RF test equipment as long as it provides the needed functionality.  If you
+wish to use our software with some other type of RF test equipment than CMU200,
+you will need to develop your own replacement for our fc-cmu200d program; you
+should be able to start with the existing fc-cmu200d source and adapt it as
+necessary for your other equipment.