Changes between Version 8 and Version 9 of WARPLab/Reference/Baseband/Buffers


Ignore:
Timestamp:
Dec 18, 2015, 11:11:24 AM (6 years ago)
Author:
welsh
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • WARPLab/Reference/Baseband/Buffers

    v8 v9  
    9797
    9898
    99 '''Requires BUFF_SEL:''' Yes
     99'''Requires BUFF_SEL:''' Yes (Vector notation [RFA, RFB])
    100100
    101101'''Arguments:''' none
     
    109109
    110110
    111 '''Requires BUFF_SEL:''' Yes
     111'''Requires BUFF_SEL:''' Yes (Vector notation [RFA, RFB])
    112112
    113113'''Arguments:''' none
     
    156156
    157157
    158 '''Requires BUFF_SEL:''' Yes
     158'''Requires BUFF_SEL:''' Yes (Scalar notation [RFA + RFB])
    159159
    160160'''Arguments:''' none
     
    170170
    171171
    172 '''Requires BUFF_SEL:''' Yes
     172'''Requires BUFF_SEL:''' Yes (Scalar notation [RFA + RFB])
    173173
    174174'''Arguments:''' none
     
    183183
    184184
    185 '''Requires BUFF_SEL:''' Yes
     185'''Requires BUFF_SEL:''' Yes (Scalar notation [RFA + RFB])
    186186
    187187'''Arguments:''' none
     
    195195
    196196
    197 '''Requires BUFF_SEL:''' Yes
     197'''Requires BUFF_SEL:''' Yes (Vector notation [RFA, RFB])
    198198
    199199'''Arguments:''' none
     
    319319
    320320
     321=== {{{get_tx_count}}} ===
     322For the given buffers, get the number of times the TX state machine has run[[BR]]
     323
     324
     325'''Requires BUFF_SEL:''' Yes (Vector notation [RFA, RFB])
     326
     327'''Arguments:''' none
     328
     329'''Returns:''' [uint32 BUFFER_COUNTER]
     330
     331
     332
     333=== {{{get_rx_count}}} ===
     334For the given buffers, get the number of times the RX state machine has run [[BR]]
     335
     336
     337'''Requires BUFF_SEL:''' Yes (Vector notation [RFA, RFB])
     338
     339'''Arguments:''' none
     340
     341'''Returns:''' [uint32 BUFFER_COUNTER]
     342
     343
     344
     345=== {{{reset_tx_count}}} ===
     346For the given buffers, reset the counter that records the number of times the TX state machine has run [[BR]]
     347
     348
     349'''Requires BUFF_SEL:''' Yes (Vector notation [RFA, RFB])
     350
     351'''Arguments:''' none
     352
     353'''Returns:''' [uint32 BUFFER_COUNTER]
     354
     355
     356
     357=== {{{reset_rx_count}}} ===
     358For the given buffers, reset the counter that records the number of times the RX state machine has run [[BR]]
     359
     360
     361'''Requires BUFF_SEL:''' Yes (Vector notation [RFA, RFB])
     362
     363'''Arguments:''' none
     364
     365'''Returns:''' [uint32 BUFFER_COUNTER]
     366
     367
    321368=== {{{agc_state}}} ===
    322369Read AGC state from the specified buffers. The elements of the buffer selection must be scalers which
     
    324371
    325372
    326 '''Requires BUFF_SEL:''' Yes (combined BUFF_SEL values not allowed)
     373'''Requires BUFF_SEL:''' Yes (Vector notation [RFA, RFB])
    327374
    328375'''Arguments:''' none
     
    376423
    377424
    378 === {{{agc_trig_delay}}} ===
    379 
    380 Command is deprecated. Use the output_config_delay[[BR]]
    381 command of the trigger manager instead.[[BR]]
     425=== {{{agc_done_addr}}} ===
     426Sample index where AGC finished[[BR]]
     427
     428
     429'''Requires BUFF_SEL:''' No. Values apply to all RF paths
     430
     431'''Arguments:'''
     432
     433'''Returns:''' (uint32) sample_index
    382434
    383435
     
    395447
    396448
    397 === {{{agc_done_addr}}} ===
    398 Sample index where AGC finished[[BR]]
    399 
    400 
    401 '''Requires BUFF_SEL:''' No. Values apply to all RF paths
    402 
    403 '''Arguments:'''
    404 
    405 '''Returns:''' (uint32) sample_index
    406 
    407 
    408 
    409 === {{{agc_reset_on_timeout}}} ===
    410 Gets / Sets whether the AGC will reset on timeout[[BR]]
     449=== {{{agc_reset_per_rx}}} ===
     450Get / Set whether the AGC will reset on per RX or hold gains across RX [[BR]]
    411451
    412452
     
    417457
    418458
    419 === {{{agc_reset_timeout_value}}} ===
    420 Gets / Sets the AGC Reset Timeout Value[[BR]]
    421 
    422 
    423 '''Arguments:''' timeout value in usec on write; none on read
    424 
    425 '''Returns:'''   none on write; timeout value in usec on read
    426 
    427 
    428 
     459=== {{{agc_config}}} ===
     460Set the configuration of the AGC[[BR]]
     461
     462This function will set the following AGC configuration fields:[[BR]]
     463- RSSI averaging length
     464- Voltage DB Adjust
     465- Initial BB Gain
     466
     467
     468'''Requires BUFF_SEL:''' No
     469
     470'''Arguments:''' [[BR]]
     471- RSSI Averaging length (Integer value in [0, 3])[[BR]]
     472- Voltage DB Adjust (Integer value in [0, 63])[[BR]]
     473- Initial BB Gain (RX) (Integer value in [0, 31])[[BR]]
     474
     475Returns  : None[[BR]]
     476
     477
     478
     479=== {{{agc_iir_hpf}}} ===
     480Set the Infinite Impulse Response (IIR) High Pass Filter (HPF) coefficients[[BR]]
     481
     482This function will set the following IIR HPF coefficients:[[BR]]
     483- A1
     484- B0
     485
     486NOTE:  By default the reference design uses a filter with a 3 dB cutoff at
     48720 kHz with 40 MHz sampling.  This results in coefficients:[[BR]]
     488- A1 = -0.996863331833438[[BR]]
     489- B0 = 0.99843166591671906[[BR]]
     490
     491
     492'''Requires BUFF_SEL:''' No
     493
     494'''Arguments:''' [[BR]]
     495- A1 coefficient (Value in [-1, 1]; range represented by Fix_18_17)[[BR]]
     496- B0 coefficient (Value in [0, 2]; range represented by UFix_18_17)[[BR]]
     497
     498Returns  : None[[BR]]
     499
     500
     501
     502=== {{{agc_rf_gain_threshold}}} ===
     503Set the RF gain thresholds[[BR]]
     504
     505This function will set the following fields:[[BR]]
     506- 3 -> 2 RF gain threshold
     507- 2 -> 1 RF gain threshold
     508
     509After the AGC has converted RSSI to power (dBm), this will select the
     510the thresholds used to set the RF (LNA) gain in the MAX2829.  [[BR]]
     511
     512
     513'''Requires BUFF_SEL:''' No
     514
     515'''Arguments:'''[[BR]]
     516- 3 -> 2 RF gain threshold (Integer value in [-128, 127])[[BR]]
     517- 2 -> 1 RF gain threshold (Integer value in [-128, 127])[[BR]]
     518
     519Returns  : None[[BR]]
     520
     521
     522
     523=== {{{agc_timing}}} ===
     524Set the AGC timing[[BR]]
     525
     526This function will set the following fields:[[BR]]
     527- Sample to take first RSSI capture
     528- Sample to take second RSSI capture
     529- Sample to take the Voltage DB capture
     530- Sample to complete the AGC
     531
     532
     533'''Requires BUFF_SEL:''' No
     534
     535'''Arguments:'''[[BR]]
     536- Capture RSSI 1 (Integer value in [0, 255])[[BR]]
     537- Capture RSSI 2 (Integer value in [0, 255])[[BR]]
     538- Capture Voltage DB (Integer value in [0, 255])[[BR]]
     539- AGC Done (Integer value in [0, 255])[[BR]]
     540
     541Returns  : None[[BR]]
     542
     543
     544
     545=== {{{agc_dco_timing}}} ===
     546Set the AGC DC Offset (DCO) timing[[BR]]
     547
     548This function will set the following fields:[[BR]]
     549- Sample to start the DCO
     550- Sample to start the IIR HPF
     551
     552
     553'''Requires BUFF_SEL:''' No
     554
     555'''Arguments:'''[[BR]]
     556- Start DCO (Integer value in [0, 255])[[BR]]
     557- Start IIR HPF (Integer value in [0, 255])[[BR]]
     558
     559Returns  : None[[BR]]