Changes between Version 4 and Version 5 of WARPLab/Reference/Node

Timestamp:

Sep 17, 2015, 2:08:58 PM (9 years ago)

Author:

welsh

Comment:

--

WARPLab/Reference/Node

@@ -39 +39 @@
 
 Hardware support:[[BR]]
-All:[[BR]]
-WARPLab design version[[BR]]
-Hardware version[[BR]]
-Ethernet MAC Address[[BR]]
-Number of Interface Groups[[BR]]
-Number of Interfaces[[BR]]
-
-WARP v3:[[BR]]
-Serial number[[BR]]
-Virtex-6 FPGA DNA[[BR]]
+  - All Platforms:
+    - WARPLab design version
+    - Hardware version
+    - Ethernet MAC Address
+    - Number of Interface Groups
+    - Number of Interfaces
+  - WARP v3:
+    - Serial number
+    - Virtex-6 FPGA DNA
 
 
@@ -92 +91 @@
 
 '''Returns:''' none
+
+
+
+=== {{{wl_getInterfaceIDs}}} ===
+Returns the interfaces IDs that can be used as inputs to all interface commands, some baseband commands and possibly some user extension commands.
+
+The interface IDs are returned in a structure that contains fields for individual interfaces and combinations of interfaces.  When a node only supports 2 interfaces, the fields for RFC and RFD (ie the fields specific to a 4 interface node) are not present in the structure.
+
+The fields in the structure are:
+  - Scalar fields:
+    - '''RF_A'''
+    - '''RF_B'''
+    - '''RF_C'''
+    - '''RF_D'''
+    - '''RF_ON_BOARD'''  (NOTE: RF_ON_BOARD = RF_A + RF_B)
+    - '''RF_FMC'''       (NOTE: RF_FMC = RF_C + RF_D)
+    - '''RF_ALL'''       (NOTE: 2RF:  RF_ALL = RF_A + RF_B; 4RF:  RF_ALL = RF_A + RF_B + RF_C + RF_D)
+  - Vector fields:
+    - '''RF_ON_BOARD_VEC''' (NOTE: RF_ON_BOARD_VEC  = [RF_A, RF_B])
+    - '''RF_FMC_VEC'''      (NOTE: RF_FMC_VEC       = [RF_C, RF_D])
+    - '''RF_ALL_VEC'''      (NOTE: 2RF:  RF_ALL_VEC = [RF_A, RF_B]; 4RF:  RF_ALL_VEC = [RF_A, RF_B, RF_C, RF_D])
+
+NOTE:  Due to Matlab behavior, the scalar fields for RF_A, RF_B, RF_C, and RF_D can be used as vectors and therefore do not need separate vector fields in the structure
+
+            % Examples:
+            %     Get the interface ID structure (let node be a wl_node object):
+            %         ifc_ids = wl_getInterfaceIDs(node);
+            %         ifc_ids = node.wl_getInterfaceIDs();
+            %
+            %     Use the interface ID structure:
+            %         1) Enable RF_A for transmit:  
+            %                wl_interfaceCmd(node, ifc_ids.RF_A, 'tx_en');
+            %
+            %         2) Get 1000 samples of Read IQ data from all interfaces:
+            %                rx_IQ = wl_basebandCmd(node, ifc_ids.RF_ALL_VEC, 'read_IQ', 0, 1000);
+
+
+Examples:
+  - Get the interface ID structure  (let node be a wl_node object):
+    {{{
+    ifc_ids = wl_getInterfaceIDs(node);
+    ifc_ids = node.wl_getInterfaceIDs();
+    }}}
+  - Use the trigger input ID structure:
+    - Enable RF_A for transmit:  
+      {{{
+      wl_interfaceCmd(node, ifc_ids.RF_A, 'tx_en');
+      }}}
+    - Get 1000 samples of Read IQ data from all interfaces:
+      {{{
+      rx_IQ = wl_basebandCmd(node, ifc_ids.RF_ALL_VEC, 'read_IQ', 0, 1000);
+      }}}
+
+
+'''Arguments:''' none
+
+'''Returns:''' (struct interface_ids)
+  - interface_ids - Interface ID structure
+
+
+
+=== {{{wl_getTriggerInputIDs}}} ===
+Returns the trigger input IDs that can be used as inputs to trigger manager commands
+
+The trigger input IDs are returned in a structure that contains fields for individual triggers.  
+
+The fields in the structure are:
+  - Scalar fields:
+    - '''ETH_A''' - Ethernet Port A 
+    - '''ETH_B''' - Ethernet Port B
+    - '''ENERGY_DET''' - Energy detection (See 'energy_config_*' commands in the Trigger Manager documentation)
+    - '''AGC_DONE''' - Automatic Gain Controller complete
+    - '''SW_REG''' - Software register (ie Memory mapped registers that can be triggered by a CPU write)
+    - '''EXT_IN_P0''' - External Input Pin 0
+    - '''EXT_IN_P1''' - External Input Pin 1
+    - '''EXT_IN_P2''' - External Input Pin 2
+    - '''EXT_IN_P3''' - External Input Pin 3
+
+Examples:
+  - Get the trigger input ID structure (let node be a wl_node object):
+    {{{
+    trig_in_ids = wl_getTriggerInputIDs(node);
+    trig_in_ids = node.wl_getTriggerInputIDs();
+    }}}
+  - Use the trigger input ID structure:
+    - Enable baseband and agc output triggers to be triggered on the Ethernet A input trigger:  
+      {{{
+      wl_triggerManagerCmd(nodes, 'output_config_input_selection', [trig_out_ids.BASEBAND, trig_out_ids.AGC], [trig_in_ids.ETH_A]);
+      }}}
+
+
+'''Arguments:''' none
+
+'''Returns:''' (struct trig_input_ids)
+  - trig_input_ids - Trigger Input ID structure
+
+
+
+=== {{{wl_getTriggerOutputIDs}}} ===
+Returns the trigger output IDs that can be used as inputs to trigger manager commands
+
+The trigger output IDs are returned in a structure that contains fields for individual triggers.  
+
+The fields in the structure are:
+  - Scalar fields:
+    - '''BASEBAND''' - Baseband buffers module 
+    - '''AGC''' - Automatic Gain Controller module
+    - '''EXT_OUT_P0''' - External Output Pin 0
+    - '''EXT_OUT_P1''' - External Output Pin 1
+    - '''EXT_OUT_P2''' - External Output Pin 2
+    - '''EXT_OUT_P3''' - External Output Pin 3
+
+Examples:
+  - Get the trigger output ID structure (let node be a wl_node object):
+    {{{
+    trig_out_ids = wl_getTriggerInputIDs(node);
+    trig_out_ids = node.wl_getTriggerInputIDs();
+    }}}
+  - Use the trigger input ID structure:
+    - Enable baseband and agc output triggers to be triggered on the Ethernet A input trigger:  
+      {{{
+      wl_triggerManagerCmd(node, 'output_config_input_selection', [trig_out_ids.BASEBAND, trig_out_ids.AGC], [trig_in_ids.ETH_A]);
+      }}}
+    - Configure output delay for the baseband:
+      {{{
+      wl_triggerManagerCmd(node, 'output_config_delay', [trig_out_ids.BASEBAND], 0);
+      }}}
+
+
+'''Arguments:''' none
+
+'''Returns:''' (struct trig_output_ids)
+  - trig_output_ids - Trigger Output ID structure
+
+
+
+
+
+