annotate README @ 104:7ad0495991ed

autocal: use the new ERROR_RFFAIL exit code
author Mychaela Falconia <falcon@freecalypso.org>
date Sat, 09 Dec 2017 07:01:13 +0000
parents ea54469409d4
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
94
b443d0665c1f top README and INSTALL files added
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
1 You are looking at the suite of software tools developed by the Mother of
b443d0665c1f top README and INSTALL files added
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
2 FreeCalypso for calibrating a number of RF parameters on TI-based GSM devices.
b443d0665c1f top README and INSTALL files added
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
3 The use of this software absolutely requires highly specialized RF test
b443d0665c1f top README and INSTALL files added
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
4 equipment (R&S CMU200 is the only equipment make and model for which support is
b443d0665c1f top README and INSTALL files added
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
5 currently implemented) which needs to be connected to the DUT (device under
b443d0665c1f top README and INSTALL files added
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
6 test) with an RF coax; all calibration procedures involve the connected external
b443d0665c1f top README and INSTALL files added
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
7 test equipment either analyzing the RF signal put out by the DUT or acting as a
b443d0665c1f top README and INSTALL files added
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
8 signal generator. If you don't have the necessary RF test equipment, the
b443d0665c1f top README and INSTALL files added
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
9 software alone cannot do anything useful for you.
b443d0665c1f top README and INSTALL files added
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
10
b443d0665c1f top README and INSTALL files added
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
11 Because the present software is not intended or usable for end users, a fairly
b443d0665c1f top README and INSTALL files added
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
12 advanced level of skill and understanding is expected from the operator. The
96
ea54469409d4 top README: refer to doc/General-flow
Mychaela Falconia <falcon@freecalypso.org>
parents: 94
diff changeset
13 write-ups in the doc subdirectory provide some guidance (doc/General-flow is a
ea54469409d4 top README: refer to doc/General-flow
Mychaela Falconia <falcon@freecalypso.org>
parents: 94
diff changeset
14 good place to start), but you are expected to study the source code for yourself
ea54469409d4 top README: refer to doc/General-flow
Mychaela Falconia <falcon@freecalypso.org>
parents: 94
diff changeset
15 to fill in the remaining details.
94
b443d0665c1f top README and INSTALL files added
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
16
b443d0665c1f top README and INSTALL files added
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
17 The automated calibration software resides in the autocal and cmu200
b443d0665c1f top README and INSTALL files added
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
18 subdirectories; the part in the cmu200 subdir is naturally specific to the R&S
b443d0665c1f top README and INSTALL files added
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
19 CMU200, whereas the part in the autocal subdir is agnostic to the specific type
b443d0665c1f top README and INSTALL files added
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
20 of RF test equipment as long as it provides the needed functionality. If you
b443d0665c1f top README and INSTALL files added
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
21 wish to use our software with some other type of RF test equipment than CMU200,
b443d0665c1f top README and INSTALL files added
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
22 you will need to develop your own replacement for our fc-cmu200d program; you
b443d0665c1f top README and INSTALL files added
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
23 should be able to start with the existing fc-cmu200d source and adapt it as
b443d0665c1f top README and INSTALL files added
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
24 necessary for your other equipment.