Changes between Initial Version and Version 1 of WARPLab/Reference/Interface/X245

Timestamp:

May 15, 2013, 4:44:54 PM (11 years ago)

Author:

chunter

Comment:

--

WARPLab/Reference/Interface/X245

@@ +1 @@
+[[TracNav(WARPLab/TOC)]]
+
+= X245 Interface Module Module Implementation =
+
+The WARPLab Reference Design implements an [wiki:../../Framework/Modules##InterfaceGroup Interface Group] module for controlling the MAX2829-based radio interfaces on WARP v2 and v3. A single X245 Interface Group module can support up to 4 radio interfaces.
+
+= X245 Interface Commands =
+
+Interface commands are selected as string inputs to the {{{wl_interfaceCmd}}} method in [browser:ResearchApps/PHY/WARPLAB/WARPLab7/M_Code_Reference/classes/wl_node.m wl_node.m]. These strings are each individual cases of the switch statement in {{{procCmd}}} method of [browser:ResearchApps/PHY/WARPLAB/WARPLab7/M_Code_Reference/classes/wl_interface_group_X245.m wl_interface_group_X245.m].
+
+== Syntax == 
+MATLAB allows two valid forms of syntax for calling methods
+
+ * Let {{{N}}} be a scalar or vector of {{{wl_node}}} objects
+ * Let {{{command_string}}} be a string containing a particular command
+ * Let {{{interface_selection}}} be a collection of interfaces or the string {{{'RF_ALL'}}}
+ * Let {{{arg}}} be an argument for that command (optional)
+
+Syntax 1: {{{wl_interfaceCmd(N, interface_selection, command_string, arg1, arg2, ..., argN)}}}
+
+Syntax 2: {{{N.wl_interfaceCmd(interface_selection, command_string, arg1, arg2, ..., argN)}}}
+
+These two different forms of syntax are identical and either may be used for issuing commands to WARP nodes.
+
+
+== Command List and Documentation == 
+
+=== {{{tx_en}}} ===
+Enable transmit mode for selected interfaces[[BR]]
+
+
+'''Arguments:''' none
+
+'''Returns:''' none
+
+
+=== {{{rx_en}}} ===
+Enable receive mode for selected interfaces[[BR]]
+
+
+'''Arguments:''' none
+
+'''Returns:''' none
+
+
+=== {{{tx_rx_dis}}} ===
+Disable transmita and receive for selected interfaces (standby mode)[[BR]]
+
+
+'''Arguments:''' none
+
+'''Returns:''' none
+
+
+=== {{{channel}}} ===
+Tune selected interfaces to the specified band and channel[[BR]]
+
+
+'''Arguments:''' (float BAND, int CHAN)
+BAND: Must be 2.4 or 5, to select 2.4GHz or 5GHz channels[[BR]]
+CHAN: Must be integer in ![1,11] for BAND=2.4, ![1,23] for BAND=5[[BR]]
+
+'''Returns:''' none
+
+BAND and CHAN must be scalars (same values for all specified interfaces) or[[BR]]
+1-D vectors (one value per interface) with length equal to the length of the interface ID vector[[BR]]
+
+Band/Channel - Center Frequency Map:[[BR]]
+||||=  2.4GHz  =||||=  5GHz  =||
+|| Chan || Freq || Chan || Freq ||
+||  1 ||    2412 ||  1 ||    5180 ||
+||  2 ||    2417 ||  2 ||    5200 ||
+||  3 ||    2422 ||  3 ||    5220 ||
+||  4 ||    2427 ||  4 ||    5240 ||
+||  5 ||    2432 ||  5 ||    5260 ||
+||  6 ||    2437 ||  6 ||    5280 ||
+||  7 ||    2442 ||  7 ||    5300 ||
+||  8 ||    2447 ||  8 ||    5320 ||
+||  9 ||    2452 ||  9 ||    5500 ||
+||  10 ||   2457 ||  10 ||   5520 ||
+||  11 ||   2462 ||  11 ||   5540 ||
+|| || ||  12 ||   5560 ||
+|| || ||  13 ||   5580 ||
+|| || ||  14 ||   5600 ||
+|| || ||  15 ||   5620 ||
+|| || ||  16 ||   5640 ||
+|| || ||  17 ||   5660 ||
+|| || ||  18 ||   5680 ||
+|| || ||  19 ||   5700 ||
+|| || ||  20 ||   5745 ||
+|| || ||  21 ||   5765 ||
+|| || ||  22 ||   5785 ||
+|| || ||  23 ||   5805 ||
+
+
+=== {{{tx_gains}}} ===
+Sets the gains for the variable gain amplifiers in the MAX2829 Tx path[[BR]]
+Refer to MAX2829 datasheet for curves of gain value vs actual gain at 2.4 and 5GHz[[BR]]
+
+
+'''Arguments:''' (int BB_GAIN, int RF_GAIN)
+BB_GAIN: Must be integer in ![0,1,2,3] for approx ![-5, -3, -1.5, 0]dB baseband gain[[BR]]
+RF_GAIN: Must be integer in ![0:63] for approx ![0:31]dB RF gain[[BR]]
+
+'''Returns:''' none
+
+BB_GAIN and RF_GAIN must be scalars (same values for all specified interfaces) or[[BR]]
+1-D vectors (one value per interface) with length equal to the length of the interface ID vector[[BR]]
+
+
+=== {{{rx_gains}}} ===
+Sets the gains for the variable gain amplifiers in the MAX2829 Rx path[[BR]]
+Refer to MAX2829 datasheet for curves of gain value vs actual gain at 2.4 and 5GHz[[BR]]
+
+
+'''Arguments:''' (int BB_GAIN, int RF_GAIN)
+BB_GAIN: Must be integer in ![0:31] for approx ![0:63]dB baseband gain[[BR]]
+RF_GAIN: Must be integer in ![1,2,3] for approx ![0,15,30]dB RF gain[[BR]]
+
+'''Returns:''' none
+
+BB_GAIN and RF_GAIN must be scalars (same values for all specified interfaces) or[[BR]]
+1-D vectors (one value per interface) with length equal to the length of the interface ID vector[[BR]]
+
+
+=== {{{tx_lpf_corn_freq}}} ===
+Sets the corner frequency for the MAX2829 Tx path low pass filter[[BR]]
+Refer to MAX2829 datasheet for curves of the frequency response with each setting[[BR]]
+
+
+'''Arguments:''' (int FILT)
+FILT: Must be integer in ![1,2,3] for approx ![12,18,24]MHz corner frequencies (![24,36,48]MHz bandwidths)[[BR]]
+
+'''Returns:''' none
+
+FILT must be scalar (same value for all specified interfaces) or 1-D vector (one value per interface) [[BR]]
+with length equal to the length of the interface ID vector[[BR]]
+
+
+=== {{{rx_lpf_corn_freq}}} ===
+Sets the corner frequency for the MAX2829 Rx path low pass filter[[BR]]
+Refer to MAX2829 datasheet for curves of the frequency response with each setting[[BR]]
+
+
+'''Arguments:''' (int FILT)
+FILT: Must be integer in ![0,1,2,3] for approx ![7.5,9.5,14,18]MHz corner [[BR]]
+frequencies (![15,19,28,36]MHz bandwidths)[[BR]]
+
+'''Returns:''' none
+
+FILT must be scalar (same value for all specified interfaces) or 1-D vector (one value per interface) [[BR]]
+with length equal to the length of the interface ID vector[[BR]]
+
+
+=== {{{rx_gain_mode}}} ===
+Sets the gain selection mode[[BR]]
+
+
+'''Arguments:''' (string MODE)
+MODE: 'automatic' for AGC, or 'manual' for manual gain control[[BR]]
+
+'''Returns:''' none