Changes between Version 4 and Version 5 of WARPLab/Reference/TriggerManager/TriggerProcessor

Timestamp:

Mar 13, 2015, 12:36:38 PM (9 years ago)

Author:

welsh

Comment:

--

WARPLab/Reference/TriggerManager/TriggerProcessor

@@ -170 +170 @@
 
 
-== Command List and Documentation == 
+== Command List and Documentation ==
+
 === {{{add_ethernet_trigger}}} ===
 Associates node to a trigger input[[BR]]
@@ -180 +181 @@
 
 
+
 === {{{delete_ethernet_trigger}}} ===
-Deassociates node to a trigger input[[BR]]
+De-associates node to a trigger input[[BR]]
 
 
@@ -187 +189 @@
 
 '''Returns:''' none
+
 
 
@@ -198 +201 @@
 
 
+
+=== {{{set_ethernet_trigger_type}}} ===
+Set the Ethernet trigger type[[BR]]
+
+In WARP v3, the ability was added to the trigger manager to "sniff" the axi stream between the Ethernet controller and the AXI interface to the Ethernet controller, such as the AXI DMA or AXI FIFO.  This allows for more predictable timing for Ethernet triggers since it does not depend on any SW interaction.  However, this feature could not be added to the WARP v2 trigger manager due to differences in Ethernet components.  Therefore, in reference designs since this feature was introduced, WARP v3 has used hardware for Ethernet triggers while WARP v2 has used software.[[BR]]
+
+Unfortunately, this introduced a large timing difference between WARP v2 and WARP v3 when asserting the Ethernet trigger within the node in response to a broadcast Ethernet trigger.  This adds a complication to experiments involving a mix of WARP v2 and WARP v3 nodes.  Therefore, trigger manager
+v1.04.a addressed this by being able to select between using the hardware capabilities WARP v3 or using software, like WARP v2, for Ethernet triggers.[[BR]]
+
+This command allows users to set whether the WARP v3 node uses hardware or software for Ethernet triggers.  Since WARP v2 does not support using hardware for Ethernet triggers, this command does nothing.
+
+
+'''Arguments:''' (TRIGGER_TYPE:  'hardware' or 'software')
+
+'''Returns:''' none
+
+
+
 === {{{get_ethernet_trigger}}} ===
 Reads current trigger association from node[[BR]]
@@ -204 +225 @@
 '''Arguments:''' node
 
-'''Returns:''' (uint32 TRIGGER_ASSOCIATION)
-TRIGGER_ASSOCIATION: bit-wise AND of associated[[BR]]
-trigger IDs[[BR]]
+'''Returns:''' (uint32 TRIGGER_ASSOCIATION)[[BR]]
+  TRIGGER_ASSOCIATION: bit-wise AND of associated trigger IDs[[BR]]
+
 
 
@@ -216 +237 @@
 '''Returns:''' none
 
-OUTPUTS:      vector of output trigger IDs, provided by[[BR]]
-wl_getTriggerOutputIDs[[BR]]
-
-OR_INPUTS:    vector of input trigger IDs, provided by[[BR]]
-wl_getTriggerInputIDs. Any triggers in[[BR]]
-this vector that assert will cause the[[BR]]
-output trigger to assert.[[BR]]
-
-AND_INPUTS:   vector of input trigger IDs, provided by[[BR]]
-wl_getTriggerInputIDs. Only if all triggers[[BR]]
-in this vector assert will the output [[BR]]
-trigger assert.   [[BR]]
-
-Usage note: This command replaces the current input[[BR]]
-selection on the board. Previous state is not saved.[[BR]]
+OUTPUTS:      vector of output trigger IDs, provided by wl_getTriggerOutputIDs[[BR]]
+
+OR_INPUTS:    vector of input trigger IDs, provided by wl_getTriggerInputIDs. Any triggers in this vector that assert will cause the output trigger to assert.[[BR]]
+
+AND_INPUTS:   vector of input trigger IDs, provided by wl_getTriggerInputIDs. Only if all triggers in this vector assert will the output trigger assert.   [[BR]]
+
+NOTE: This command replaces the current input selection on the board. The previous state is not saved.[[BR]]
+
 
 
 === {{{output_config_delay}}} ===
-Configures specified output triggers to be have an[[BR]]
-additional delay relative to their inputs[[BR]]
+Configures specified output triggers to be have an additional delay relative to their inputs[[BR]]
 
 
@@ -242 +255 @@
 '''Returns:''' none
 
-OUTPUTS:      vector of output trigger IDs, provided by[[BR]]
-wl_getTriggerOutputIDs[[BR]]
-
-DELAY_NS:     scalar value of the intended delay,[[BR]]
-specified in nanoseconds (1e-9 seconds)[[BR]]
+OUTPUTS:      vector of output trigger IDs, provided by wl_getTriggerOutputIDs[[BR]]
+
+DELAY_NS:     scalar value of the intended delay, specified in nanoseconds (1e-9 seconds)[[BR]]
+
 
 
 === {{{output_config_hold_mode}}} ===
-Configures whether specified output triggers should[[BR]]
-hold their outputs once triggered[[BR]]
+Configures whether specified output triggers should hold their outputs once triggered[[BR]]
 
 
@@ -258 +269 @@
 '''Returns:''' none
 
-OUTPUTS:      vector of output trigger IDs, provided by[[BR]]
-wl_getTriggerOutputIDs[[BR]]
+OUTPUTS:      vector of output trigger IDs, provided by wl_getTriggerOutputIDs[[BR]]
 
 MODE:         'enable' or 'disable'[[BR]]
 
 
+
 === {{{output_state_read}}} ===
-Reads current state of output triggers. Note: this[[BR]]
-command is intended to be used on output triggers[[BR]]
-that have enabled their hold mode.[[BR]]
+Reads current state of output triggers. Note: this command is intended to be used on output triggers that have enabled their hold mode.[[BR]]
 
 
@@ -274 +283 @@
 '''Returns:''' (bool STATES)
 
-OUTPUTS:      vector of output trigger IDs, provided by[[BR]]
-wl_getTriggerOutputIDs[[BR]]
-
-STATES:       vector of (true, false) trigger states[[BR]]
-corresponding to state of OUTPUTS vector[[BR]]
+OUTPUTS:      vector of output trigger IDs, provided by wl_getTriggerOutputIDs[[BR]]
+
+STATES:       vector of (true, false) trigger states corresponding to state of OUTPUTS vector[[BR]]
+
 
 
@@ -289 +297 @@
 '''Returns:''' none
 
-OUTPUTS:      vector of output trigger IDs, provided by[[BR]]
-wl_getTriggerOutputIDs[[BR]]
+OUTPUTS:      vector of output trigger IDs, provided by wl_getTriggerOutputIDs[[BR]]
 
 
 
 === {{{input_config_enable_selection}}} ===
-Configures specified input triggers to be enabled[[BR]]
-as inputs that feed the trigger manager core.[[BR]]
-Note: This command disables all inputs before[[BR]]
-enabling the selected inputs -- no previous state is[[BR]]
-stored in the node.[[BR]]
+Configures specified input triggers to be enabled as inputs that feed the trigger manager core.[[BR]]
+Note: This command disables all inputs before enabling the selected inputs -- no previous state is stored in the node.[[BR]]
 
 
@@ -306 +310 @@
 '''Returns:''' none
 
-INPUTS:      vector of output trigger IDs, provided by[[BR]]
-wl_getTriggerInputIDs[[BR]]
+INPUTS:      vector of output trigger IDs, provided by wl_getTriggerInputIDs[[BR]]
+
 
 
 === {{{input_config_debounce_mode}}} ===
-Configures specified input triggers to enable or[[BR]]
-disable debounce circuit. Note: debounce circuit adds[[BR]]
-delay of 4 cycles, where each cycle is a duration[[BR]]
-specified in the delayStep_ns property of the[[BR]]
-wl_manager_proc.m class.[[BR]]
+Configures specified input triggers to enable or disable debounce circuit. Note: debounce circuit adds delay of 4 cycles, where each cycle is a duration specified in the input_delayStep_ns property of the wl_trigger_manager_proc.m class.[[BR]]
 
 
@@ -322 +322 @@
 '''Returns:''' none
 
-INPUTS:      vector of output trigger IDs, provided by[[BR]]
-wl_getTriggerInputIDs[[BR]]
+INPUTS:      vector of output trigger IDs, provided by wl_getTriggerInputIDs[[BR]]
 
 MODE:         'enable' or 'disable'[[BR]]
 
 
+
+=== {{{input_config_delay}}} ===
+Configures specified input triggers to be have an additional delay relative to their inputs[[BR]]
+
+
+'''Arguments:''' (uint32 INPUTS), (double DELAY_NS)
+
+'''Returns:''' none
+
+INPUTS:       vector of input trigger IDs, provided by wl_getTriggerInputIDs[[BR]]
+
+DELAY_NS:     scalar value of the intended delay, specified in nanoseconds (1e-9 seconds)[[BR]]
+
+
+
 === {{{energy_config_busy_threshold}}} ===
-Configures the threshold above which RSSI is[[BR]]
-considered as a "busy" medium.[[BR]]
+Configures the threshold above which RSSI is considered as a "busy" medium.[[BR]]
 
 
@@ -337 +350 @@
 '''Returns:''' none
 
-THRESH:      busy threshold. For the MAX2829-based[[BR]]
-interfaces, WARP uses a 10-bit ADC for[[BR]]
-RSSI (range of ![0,1023]).[[BR]]
-
-Note: RSSI averaging in the core does NOT divide by[[BR]]
-the number of samples that are summed together.[[BR]]
-Averaging by N cycles means that the maximum possible[[BR]]
-RSSI post-averaging is N*1023.[[BR]]
+THRESH:      busy threshold. For the MAX2829-based interfaces, WARP uses a 10-bit ADC for RSSI (range of ![0,1023]).[[BR]]
+
+Note: RSSI averaging in the core does NOT divide by the number of samples that are summed together. Averaging by N cycles means that the maximum possible RSSI post-averaging is N*1023.[[BR]]
+
 
 
 === {{{energy_config_average_length}}} ===
-Configures the number of samples over which RSSI is[[BR]]
-averaged before it is compared to any threshold.[[BR]]
+Configures the number of samples over which RSSI is averaged before it is compared to any threshold.[[BR]]
 
 
@@ -356 +364 @@
 '''Returns:''' none
 
-LENGTH:      Number of samples over which RSSI is[[BR]]
-averaged.[[BR]]
-
-Note: For all hardware versions, RSSI is sampled at[[BR]]
-10 MHz. Each sample is, therefore, 100 ns.[[BR]]
+LENGTH:      Number of samples over which RSSI is averaged.[[BR]]
+
+Note: For all hardware versions, RSSI is sampled at 10 MHz. Each sample is, therefore, 100 ns.[[BR]]
+
 
 
 === {{{energy_config_busy_minlength}}} ===
-Average RSSI samples must exceed the busy threshold[[BR]]
-for a minimum number of samples before the trigger is[[BR]]
-activated. This command sets this minimum value.[[BR]]
+Average RSSI samples must exceed the busy threshold for a minimum number of samples before the trigger is activated. This command sets this minimum value.[[BR]]
 
 
@@ -373 +378 @@
 '''Returns:''' none
 
-LENGTH:      Minimum number of samples that RSSI must[[BR]]
-be busy before trigger is raised.[[BR]]
+LENGTH:      Minimum number of samples that RSSI must be busy before trigger is raised.[[BR]]
+
 
 
 === {{{energy_config_interface_selection}}} ===
-Selects the interfaces from which energy detection[[BR]]
-should base its decision[[BR]]
+Selects the interfaces from which energy detection should base its decision[[BR]]
 
 
@@ -386 +390 @@
 '''Returns:''' none
 
-IFCSELECTION:     One or more interfaces that the[[BR]]
-energy detector system should[[BR]]
-monitor[[BR]]
-
-Note: IFCSELECTION is intended to be used with the[[BR]]
-return values from the wl_getInterfaceIDs method.[[BR]]
+IFCSELECTION:     One or more interfaces that the energy detector system should monitor[[BR]]
+
+Note: IFCSELECTION is intended to be used with the return values from the wl_getInterfaceIDs method.[[BR]]
+
 
 
@@ -401 +403 @@
 
 '''Returns:''' none
+