FilterController constructor

FilterController(
  1. Logic clk,
  2. Logic reset,
  3. Logic start,
  4. Logic inputValid,
  5. Logic inputDone, {
  6. required int drainCycles,
  7. String name = 'FilterController',
})

Creates a FilterController that sequences the filter bank.

After start is asserted the FSM moves through loading → running → draining (for drainCycles cycles) → done.

Implementation

FilterController(
  Logic clk,
  Logic reset,
  Logic start,
  Logic inputValid,
  Logic inputDone, {
  required int drainCycles,
  super.name = 'FilterController',
}) : super(definitionName: 'FilterController') {
  clk = addInput('clk', clk);
  reset = addInput('reset', reset);
  start = addInput('start', start);
  inputValid = addInput('inputValid', inputValid);
  inputDone = addInput('inputDone', inputDone);

  final filterEnable = addOutput('filterEnable');
  final loadingPhase = addOutput('loadingPhase');
  final doneFlag = addOutput('doneFlag');
  final state = addOutput('state', width: 3);

  // Drain counter
  final drainCount = Logic(width: 8, name: 'drainCount');
  final drainDone =
      drainCount.eq(Const(drainCycles, width: 8)).named('drainDone');

  _fsm = FiniteStateMachine<FilterState>(clk, reset, FilterState.idle, [
    State<FilterState>(
      FilterState.idle,
      events: {start: FilterState.loading},
      actions: [filterEnable < 0, loadingPhase < 0, doneFlag < 0],
    ),
    State<FilterState>(
      FilterState.loading,
      events: {inputValid: FilterState.running},
      actions: [filterEnable < 1, loadingPhase < 1, doneFlag < 0],
    ),
    State<FilterState>(
      FilterState.running,
      events: {inputDone: FilterState.draining},
      actions: [filterEnable < 1, loadingPhase < 0, doneFlag < 0],
    ),
    State<FilterState>(
      FilterState.draining,
      events: {drainDone: FilterState.done},
      actions: [filterEnable < 1, loadingPhase < 0, doneFlag < 0],
    ),
    State<FilterState>(
      FilterState.done,
      events: {},
      actions: [filterEnable < 0, loadingPhase < 0, doneFlag < 1],
    ),
  ]);

  state <= _fsm.currentState.zeroExtend(state.width);

  // Drain counter: Sequential block increments while draining,
  // resets to zero otherwise.
  final drainIdx = _fsm.getStateIndex(FilterState.draining)!;
  final isDraining = Logic(name: 'isDraining');
  isDraining <= _fsm.currentState.eq(Const(drainIdx, width: _fsm.stateWidth));

  Sequential(clk, reset: reset, [
    If(
      isDraining,
      then: [drainCount < drainCount + Const(1, width: 8)],
      orElse: [drainCount < Const(0, width: 8)],
    ),
  ]);
}