Changes between Version 2 and Version 3 of OFDM/MIMO/Docs/ModelDriver

Timestamp:

Jan 8, 2007, 4:15:02 PM (17 years ago)

Author:

murphpo

Comment:

--

OFDM/MIMO/Docs/ModelDriver

@@ -1 @@
-== [wiki:OFDM/MIMO MIMO OFDM] | [wiki:OFDM/MIMO#Documentation Documentation] | OFDM Model Register Map ==
-The WARP MIMO OFDM core provides a C driver which simplifies the use of the core in user applications. The driver source code is available in the repository: [source:/PlatformSupport/CustomPeripherals/drivers/ofdm_TxRx_mimo_opbw_v1_07_a/src/].
+== [source:/PlatformSupport/CustomPeripherals/drivers/ofdm_TxRx_mimo_opbw_v1_07_a/src/ofdm_Rx_mimo.h ofdm_Rx_mimo.h] ==
 
-The macros and functions provided by the driver are described below.
+'''RESET_BER''': Resets the BER subsystem.
 
-== [source:/PlatformSupport/CustomPeripherals/drivers/ofdm_TxRx_mimo_opbw_v1_07_a/src/ofdm_Rx_mimo.h ofdm_Rx_mimo.h] ==
+'''REQ_LONG_CORR''': Requires a threshold crossing in the long correlator for packet detection.
+
+'''REQ_TWO_LONG_CORR''': Requires two threshold crossings spaced by 64 samples in the long correlator for packet detection.
+
+'''REQ_SHORT_CORR''': Requires short correlation (for internal packet detection) or an external packet detection trigger to begin processing a packet.
+
+'''EXT_PKT_DETECT''': Enables the external packet detection signal on port [wiki:OFDM/MIMO/Docs/ModelPorts#OFDMCore rx_extpktdet].
+
+'''INT_PKT_DETECT''': Enables the internal packet detection subsystem. This is useful only for debugging when the receive gains are fixed.
+
+'''DYNAMC_PKT_LENGTHS''': Enables inference of packet lengths from each packet's header. When disabled, every packet is processed with an assumed fixed length.
+
+'''RX_SISO_MODE''': Enables SISO mode in the receiver.
+
+'''BYPASS_CARR_REC''': Bypasses the carrier frequency offset correction system.
+
+'''CFO_USE_LTS''': Enables the estimation of carrier frequency offset based on the preamble's long training symbols.
+
+'''CFO_USE_STS''': Enables the estimation of carrier frequency offset based on the preamble's short training symbols.
+
+'''CFO_USE_LONGCORR''': Enables the re-timing of carrier frequency offset estimation based on the long correlator's output.
 
 '''INTR_BAD_PKTS''': Flag used when calling [source:/PlatformSupport/CustomPeripherals/drivers/ofdm_TxRx_mimo_opbw_v1_07_a/src/ofdm_Rx_mimo.c mimo_ofdmRx_setOptions()] to enable interrupts on the reception of packets which fail CRC.
 
 '''INTR_GOOD_PKTS''': Flag used when calling [source:/PlatformSupport/CustomPeripherals/drivers/ofdm_TxRx_mimo_opbw_v1_07_a/src/ofdm_Rx_mimo.c mimo_ofdmRx_setOptions()] to enable interrupts on the reception of packets which pass CRC.
+
 
 '''mimo_ofdmRx_setFFTScaling(c)''': Writes a value '''c''' to the [wiki:OFDM/MIMO/Docs/ModelRegisters#Rx_FFT_Scaling Rx_FFT_Scaling] register.
@@ -41 +61 @@
 '''void mimo_ofdmRx_disable()''': Disables operation of the OFDM receiver. The receiver can be re-enabled using '''mimo_ofdmRx_enable()'''.
 
-'''void mimo_ofdmRx_setOptions(unsigned int someOptions, unsigned int intType)''': Sets the options flags in the receiver's configuration registers. ''someOptions'' is a bitwise OR'd combination of the receiver configuration flags defined in [source:/PlatformSupport/CustomPeripherals/drivers/ofdm_TxRx_mimo_opbw_v1_07_a/src/ofdm_TxRx_mimo.h@L#L296 ofdm_TxRx_mimo.h]. ''intType'' is a bitwise OR'd combination of '''INTR_BAD_PKTS''' and '''INTR_GOOD_PKTS''', which are described above.
+'''void mimo_ofdmRx_setOptions(unsigned int someOptions, unsigned int intType)''': Sets the options flags in the receiver's configuration registers. ''someOptions'' is a bitwise OR'd combination of the receiver configuration flags defined above. ''intType'' is a bitwise OR'd combination of '''INTR_BAD_PKTS''' and '''INTR_GOOD_PKTS''', which are described above.
 
 '''void mimo_mac2phy_PktAck()''': Clears the interrupt registers in the receiver. When either interrupt is high, indication either a good or bad packet reception, the receiver will ignore all future incoming packets. The user application should process a received packet, then call this function to allow the receiver to process the next received packet.
@@ -47 +67 @@
 ----
 == [source:/PlatformSupport/CustomPeripherals/drivers/ofdm_TxRx_mimo_opbw_v1_07_a/src/ofdm_Tx_mimo.h ofdm_Tx_mimo.h] ==
+
+'''TX_SISO_MODE''': Enables SISO mode in the transmitter.
+
+'''TX_RANDOM_MODE''': Enables the transmission of random bytes; useful for spectral mask testing and other non-data based debugging.
+
+'''TX_DISABLE_ANTB_PREAMBLE''': Disables the transmission of a preamble from antenna B.
+
+'''TX_PILOT_SCRAMBLING''': Enables 802.11a-style scrambling of pilot tone values.
 
 '''TXBLOCK''': Flag used when calling [source:/PlatformSupport/CustomPeripherals/drivers/ofdm_TxRx_mimo_opbw_v1_07_a/src/ofdm_Tx_mimo.c mimo_mac2phy_pktTx()], causing the function to block until the packet finishes transmission. transmission.
@@ -82 +110 @@
 '''void mimo_ofdmTx_enable()''': Enables the OFDM transmitter by de-asserting the reset signal.
 
-'''void mimo_mac2phy_pktTx(unsigned int block, unsigned int radio)''': Initiates the transmission of a packet. This function should be called only after the packet is loaded into the transmit packet buffer and the packet's paramters (number of bytes, number of OFDM symbols, pilot tones, etc.) are configured via the macros described above. The argument ''block'' must be either '''TXBLOCK''' or '''TXNOBLOCK'''; ''radio'' is a bitwise OR'd combination of '''RADIO1_ADDR''', '''RADIO2_ADDR''', '''RADIO3_ADDR''' and '''RADIO4_ADDR''', indicating which radios should be used for the packet's transmission.
+'''void mimo_mac2phy_pktTx(unsigned int block, unsigned int radio)''': Initiates the transmission of a packet. This function should be called only after the packet is loaded into the transmit packet buffer and the packet's paramters (number of bytes, number of OFDM symbols, pilot tones, etc.) are configured via the macros described above. The argument ''block'' must be either '''TXBLOCK''' or '''TXNOBLOCK'''; ''radio'' is a bitwise OR'd combination of ''RADIO1_ADDR'', ''RADIO2_ADDR'', ''RADIO3_ADDR'' and ''RADIO4_ADDR'', indicating which radios should be used for the packet's transmission.