annotate doc/Test-system-interface @ 125:306da04b3be2

LICENSE added
author Mychaela Falconia <falcon@freecalypso.org>
date Thu, 07 Nov 2019 22:41:19 +0000
parents 01bae2629ffd
children 8e26cb57c7f8
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
bd62be88259d initial import of rfcal code and docs from freecalypso-tools repository
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
1 The Test System Interface Daemon (TSID) will provide a connection-oriented
bd62be88259d initial import of rfcal code and docs from freecalypso-tools repository
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
2 (SOCK_STREAM) UNIX domain local socket at /tmp/fc_rftest_socket, and will speak
bd62be88259d initial import of rfcal code and docs from freecalypso-tools repository
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
3 an ASCII line-based command-response protocol on this socket. All command and
bd62be88259d initial import of rfcal code and docs from freecalypso-tools repository
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
4 response lines will end with \n only (no \r), and each TSID response including
bd62be88259d initial import of rfcal code and docs from freecalypso-tools repository
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
5 the initial greeting on connection establishment will begin with a '+' or '-'
bd62be88259d initial import of rfcal code and docs from freecalypso-tools repository
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
6 character to indicate OK or error, respectively, like in POP3.
bd62be88259d initial import of rfcal code and docs from freecalypso-tools repository
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
7
bd62be88259d initial import of rfcal code and docs from freecalypso-tools repository
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
8 The following commands are currently defined:
bd62be88259d initial import of rfcal code and docs from freecalypso-tools repository
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
9
bd62be88259d initial import of rfcal code and docs from freecalypso-tools repository
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
10 vcxo-cal-setup band arfcn
bd62be88259d initial import of rfcal code and docs from freecalypso-tools repository
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
11
bd62be88259d initial import of rfcal code and docs from freecalypso-tools repository
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
12 This command is sent to the TSID to prepare the RF test system for the VCXO
bd62be88259d initial import of rfcal code and docs from freecalypso-tools repository
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
13 calibration procedure. The first argument after the command keyword is the
bd62be88259d initial import of rfcal code and docs from freecalypso-tools repository
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
14 band to be used (850, 900, 1800 or 1900) and the second argument is the ARFCN
bd62be88259d initial import of rfcal code and docs from freecalypso-tools repository
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
15 in that band on which the DUT will be transmitting.
bd62be88259d initial import of rfcal code and docs from freecalypso-tools repository
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
16
bd62be88259d initial import of rfcal code and docs from freecalypso-tools repository
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
17 freq-meas hint
bd62be88259d initial import of rfcal code and docs from freecalypso-tools repository
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
18
bd62be88259d initial import of rfcal code and docs from freecalypso-tools repository
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
19 This command directs the RF test system to take a frequency offset measurement
bd62be88259d initial import of rfcal code and docs from freecalypso-tools repository
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
20 (vcxo-cal-setup must have been performed previously) and report it back to the
bd62be88259d initial import of rfcal code and docs from freecalypso-tools repository
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
21 client in the response line. The hint argument after the freq-meas keyword will
bd62be88259d initial import of rfcal code and docs from freecalypso-tools repository
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
22 be sent by the VCXO calibration program (fc-rfcal-vcxo) to tell the RF test
bd62be88259d initial import of rfcal code and docs from freecalypso-tools repository
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
23 system what kind of frequency offset measurement is being made, i.e., which step
36
d348d47f8a04 doc/Test-system-interface: added commands for Tx power level calibration
Mychaela Falconia <falcon@freecalypso.org>
parents: 0
diff changeset
24 in the VCXO calibration sequence is being performed; see the fc-rfcal-vcxo
d348d47f8a04 doc/Test-system-interface: added commands for Tx power level calibration
Mychaela Falconia <falcon@freecalypso.org>
parents: 0
diff changeset
25 source for the hint keywords.
d348d47f8a04 doc/Test-system-interface: added commands for Tx power level calibration
Mychaela Falconia <falcon@freecalypso.org>
parents: 0
diff changeset
26
d348d47f8a04 doc/Test-system-interface: added commands for Tx power level calibration
Mychaela Falconia <falcon@freecalypso.org>
parents: 0
diff changeset
27 txpwr-cal-setup band arfcn
d348d47f8a04 doc/Test-system-interface: added commands for Tx power level calibration
Mychaela Falconia <falcon@freecalypso.org>
parents: 0
diff changeset
28
d348d47f8a04 doc/Test-system-interface: added commands for Tx power level calibration
Mychaela Falconia <falcon@freecalypso.org>
parents: 0
diff changeset
29 This command is sent to the TSID to prepare the RF test system for the Tx power
d348d47f8a04 doc/Test-system-interface: added commands for Tx power level calibration
Mychaela Falconia <falcon@freecalypso.org>
parents: 0
diff changeset
30 level calibration procedure. The first argument after the command keyword is
d348d47f8a04 doc/Test-system-interface: added commands for Tx power level calibration
Mychaela Falconia <falcon@freecalypso.org>
parents: 0
diff changeset
31 the band to be used (850, 900, 1800 or 1900) and the second argument is the
d348d47f8a04 doc/Test-system-interface: added commands for Tx power level calibration
Mychaela Falconia <falcon@freecalypso.org>
parents: 0
diff changeset
32 ARFCN in that band on which the DUT will be transmitting.
d348d47f8a04 doc/Test-system-interface: added commands for Tx power level calibration
Mychaela Falconia <falcon@freecalypso.org>
parents: 0
diff changeset
33
113
01bae2629ffd doc/Test-system-interface: txpwr-cal-channel addition documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 93
diff changeset
34 txpwr-cal-channel arfcn
01bae2629ffd doc/Test-system-interface: txpwr-cal-channel addition documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 93
diff changeset
35
01bae2629ffd doc/Test-system-interface: txpwr-cal-channel addition documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 93
diff changeset
36 This command is used during Tx power level calibration procedures to tell the
01bae2629ffd doc/Test-system-interface: txpwr-cal-channel addition documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 93
diff changeset
37 RF test system to switch to a different channel.
01bae2629ffd doc/Test-system-interface: txpwr-cal-channel addition documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 93
diff changeset
38
36
d348d47f8a04 doc/Test-system-interface: added commands for Tx power level calibration
Mychaela Falconia <falcon@freecalypso.org>
parents: 0
diff changeset
39 power-meas
d348d47f8a04 doc/Test-system-interface: added commands for Tx power level calibration
Mychaela Falconia <falcon@freecalypso.org>
parents: 0
diff changeset
40
d348d47f8a04 doc/Test-system-interface: added commands for Tx power level calibration
Mychaela Falconia <falcon@freecalypso.org>
parents: 0
diff changeset
41 This command directs the RF test system to take a power level measurement
d348d47f8a04 doc/Test-system-interface: added commands for Tx power level calibration
Mychaela Falconia <falcon@freecalypso.org>
parents: 0
diff changeset
42 (txpwr-cal-setup must have been performed previously) and report it back to the
d348d47f8a04 doc/Test-system-interface: added commands for Tx power level calibration
Mychaela Falconia <falcon@freecalypso.org>
parents: 0
diff changeset
43 client in the response line.
0
bd62be88259d initial import of rfcal code and docs from freecalypso-tools repository
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
44
bd62be88259d initial import of rfcal code and docs from freecalypso-tools repository
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
45 signal-gen-setup band
bd62be88259d initial import of rfcal code and docs from freecalypso-tools repository
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
46
bd62be88259d initial import of rfcal code and docs from freecalypso-tools repository
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
47 This command is sent to the TSID to prepare the RF test system for tests in
bd62be88259d initial import of rfcal code and docs from freecalypso-tools repository
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
48 which the latter acts as a signal generator. The argument after the command
bd62be88259d initial import of rfcal code and docs from freecalypso-tools repository
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
49 keyword is the band number (850, 900, 1800 or 1900), and it selects the
bd62be88259d initial import of rfcal code and docs from freecalypso-tools repository
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
50 downlink frequency band in which the signal generator will need to operate.
bd62be88259d initial import of rfcal code and docs from freecalypso-tools repository
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
51
bd62be88259d initial import of rfcal code and docs from freecalypso-tools repository
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
52 signal-gen-sine arfcn offset level
bd62be88259d initial import of rfcal code and docs from freecalypso-tools repository
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
53
bd62be88259d initial import of rfcal code and docs from freecalypso-tools repository
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
54 This command directs the RF test system to turn on its signal generator and put
bd62be88259d initial import of rfcal code and docs from freecalypso-tools repository
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
55 out a pure sine wave at the frequency corresponding to the specified ARFCN (in
93
20e2b4571cd6 doc/Test-system-interface: typo fix
Mychaela Falconia <falcon@freecalypso.org>
parents: 36
diff changeset
56 the downlink band previously selected with signal-gen-setup) plus the specified
0
bd62be88259d initial import of rfcal code and docs from freecalypso-tools repository
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
57 offset in kHz (-67 or +67 with TI's Rx path calibration procedures), and at the
bd62be88259d initial import of rfcal code and docs from freecalypso-tools repository
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
58 specified Tx power level in dBm.
bd62be88259d initial import of rfcal code and docs from freecalypso-tools repository
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
59
bd62be88259d initial import of rfcal code and docs from freecalypso-tools repository
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
60 signal-gen-off
bd62be88259d initial import of rfcal code and docs from freecalypso-tools repository
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
61
bd62be88259d initial import of rfcal code and docs from freecalypso-tools repository
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
62 Turn off the signal generator.