Availability:
     Level 2    , 'D'

  Quick Help:
     LdpcIterationControl, D[itratn cnt],[glbl itratn],[BERP opts],[erasure],[slidewindowjog_sz],[ext itratn]

  Description:
    The Iteration Control command controls the channel's local and global iteration behavior.

  Input Parameters:

    0 - Local Iteration Count.
    
         This value is the number of local interations allowed.  Note that this value
         also determines the number of global iterations that will occur.
         If 0 to 3FF is entered, local override is set TRUE and the entered
         iteration count is used.
         If FFFF is entered, local override is set FALSE.
         If no value is entered, the override and iteration count will not be
         changed.
    
          Type:    unsigned 16-bit value
    
          Range:   0 - 3FF and FFFF.
    
          Default: No value entered means do not change local override or iteration count.
    
    1 - Enable Global Iterations
    
        This value indicates whether global iterations are allowed.
        0: Disable global iterations override
        1: Enable global override, enable global iterations
        2: Enable global override, disable global iterations
        3: Do not change global override or global iterations
        no value entered : do not change override or iterations
    
          Type:    unsigned 16-bit value
    
          Range:   0 - FFFF
    
          Default: No value entered means do not change the global iteration
                   override or the global iteration enable.
    
    2 - BERP options
    
        This value indicates BERP options setup.  The following are the
        bit definitions:
    
          bit 15 Disable BERP override disables Diagnostic BERP override control.
    
          bit 3 ExtIterations enables BERP Extended Iterations recovery.
          bit 2 SlideWindow enables BERP Sliding Window recovery.
          bit 1 Erasure enables BERP Erasure recovery.
          bit 0 MAMR enables MAMR recovery.
    
        Note parameters 2, 3, 4, and 5 must all be entered simultaneously
        otherwise the request is ignored, and the current settings are simply displayed.
     
          Type:    unsigned 16-bit value
    
          Range:   0 - FFFF
    
          Default: There is no default.
    
    3 - BERP erasure filter
    
        This value indicates BERP erasure filter setup in the read channel register.
        This may change with evolutions of read channels, so refer to your channel
        specification for proper programming.
    
        Note parameters 2, 3, 4, and 5 must all be entered simultaneously
        otherwise the request is ignored, and the current settings are simply displayed.
    
          Type:    unsigned 16-bit value
    
          Range:   0 - FFFF
    
          Default: There is no default.
    
    4 - BERP Sliding Window size and jog
    
        This value indicates BERP Sliding Window size, and Sliding Window jog.
          lower 16 bits Sliding Window size, in 16 bit channel buffer size.
          upper 16 bits Sliding Window jog, in 16 bit channel buffer size.
    
        Note parameters 2, 3, 4, and 5 must all be entered simultaneously
        otherwise the request is ignored, and the current settings are simply displayed.
    
          Type:    unsigned 32-bit value
    
          Range:   0 - FFFFFFFF
    
          Default: There is no default.
    
    5 - BERP Extended Iterations
    
        This value indicates BERP Extended Iterations count.
    
        Note parameters 2, 3, 4, and 5 must all be entered simultaneously
        otherwise the request is ignored, and the current settings are simply displayed.
    
          Type:    unsigned 16-bit value
    
          Range:   0 - FFFF
    
          Default: There is no default.
    
  Output Data:


    If an error occurred, the following information will be displayed.
    
          "DiagError aaaaaaaa"
    
       where
    
          aaaaaaaa is the Diagnostic Error Code
    
    If no error occurred, the LDCP iteration control state data will be displayed as follows.
    
          "Local iteration override xxxxxxxxx count = CC"
          "Global iteration override yyyyyyyyy  iterations zzzzzzzz"
          "Current hardware iteration count = DD"
          "BERP override setup:"
          "     Options = EE"
          "     Erasure = FFFF"
          "     Sliding Window size = GGGG"
          "     Extended Iterations = HHHH"
    
       where
    
          xxxxxxxx is " enabled" or "disabled" to indicate the state of local iteration override
          CC is the software's local iteration count
          yyyyyyyy is " enabled" or "disabled" to indicate the state of global iteration override
          zzzzzzzz is " enabled" or "disabled" to indicate the state of global iterations
          DD is the local iteration count read from the channel
          EE is the BERP options.
          FFFF is the BERP erasure setup.
          GGGG is te BERP sliding window size.
          HHHH is the BERP extended iterations count.
    
  Examples:

    Example #1:
    To set local iteration to 10 decimal:

       F3 2>DA

    Example #2:
    To disable local iteration override, enable global override, and disable global iterations:

       F3 2>DFFFF,1

    Example #3:
    To enable global iteration override and global iterations:

       F3 2>D,2
 
    Example #4:
    To set local iteration to 1E in the hardware:
 
       F3 2>D
       Local iteration override  enabled count = 14
       Global iteration override disabled  iterations disabled
       Current hardware iteration count = 14
                                                               
       F3 2>D1E
       Local iteration override  enabled count = 1E
       Global iteration override disabled  iterations disabled
       Current hardware iteration count = 14     14 still in hardware
                                                               
       F3 2>R
                                                               
       F3 2>D
       Local iteration override  enabled count = 1E
       Global iteration override disabled  iterations disabled
       Current hardware iteration count = 1E     The read forced 1E down to hardware.

  Revision History:

    0001.0000   Initial revision.
    0001.0001   Added BERP control.
    0001.0002   Further BERP refinement.