Document Outline

• Avalon Verification IP Suite User Guide
  • Contents
  • Section I. Introduction to Avalon Verification IP Suite
    • Advantages of Using BFMs and Monitors
    • Implementation of BFMs
    • Application Programming Interface
    • Application Example of BFMs
    • In This User Guide
  • Section II. Clock, Reset, and Interrupt BFMs
  • 1. Clock Source BFM
    • Parameters
    • Application Program Interface
      • clock_start()
      • clock_stop()
      • get_run_state()
      • get_version()
  • 2. Reset Source BFM
    • Parameters
    • Application Program Interface
      • reset_assert
      • reset_deassert
      • get_version()
  • 3. Avalon Interrupt Source and Interrupt Sink BFMs
    • Parameters
    • Application Program Interface
      • clear_irq()
      • get_irq()
      • get_version()
      • set_irq()
  • Section III. Avalon-MM BFMs
  • 1. Avalon-MM Master BFM
    • Functional Description
      • Timing
      • Block Diagram
    • Parameters
    • Application Program Interface
      • all_transactions_complete()
      • get_command_issued_queue_size()
      • get_command_pending_queue_size()
      • get_read_response_queue_size()
      • get_response_address()
      • get_response_byte_enable()
      • get_response_burst_size()
      • get_response_data()
      • get_response_latency()
      • get_response_queue_size()
      • get_response_read_id()
      • get_response_read_response()
      • get_response_request()
      • get_response_wait_time()
      • get_response_write_id()
      • get_response_write_response()
      • get_write_response_queue_size()
      • get_version()
      • init()
      • pop_response()
      • push_command()
      • set_clken()
      • set_command_address()
      • set_command_arbiterlock()
      • set_command_byte_enable()
      • set_command_burst_count()
      • set_command_burst_size()
      • set_command_data()
      • set_command_debugaccess()
      • set_command_idle()
      • set_command_init_latency()
      • set_command_lock()
      • set_command_request()
      • set_command_timeout()
      • set_command_transaction_id()
      • set_command_write_response_request()
      • set_max_command_queue_size()
      • set_min_command_queue_size()
      • set_response_timeout()
      • signal_all_transactions_complete
      • signal_command_issued
      • signal_fatal_error
      • signal_max_command_queue_size
      • signal_min_command_queue_size
      • signal_read_response_complete()
      • signal_response_complete()
      • signal_write_response_complete()
  • 2. Avalon-MM Master BFM with Avalon-ST API Wrapper
  • 3. Avalon-MM Slave BFM
    • Functional Description
      • Timing
      • Block Diagram
    • Parameters
    • Application Program Interface
      • get_clken()
      • get_command_address()
      • get_command_arbiterlock()
      • get_command_burst_count()
      • get_command_burst_cycle()
      • get_command_byte_enable()
      • get_command_data()
      • get_command_debugaccess()
      • get_command_queue_size()
      • get_command_lock()
      • get_command_request()
      • get_command_transaction_id()
      • get_command_write_response_request()
      • get_pending_read_latency_cycle()
      • get_pending_write_latency_cycle()
      • get_response_queue_size()
      • get_slave_bfm_status
      • get_version()
      • init()
      • pop_command()
      • push_response()
      • set_command_transaction_mode()
      • set_interface_wait_time()
      • set_max_response_queue_size()
      • set_min_response_queue_size()
      • set_read_response_id()
      • set_read_response_status()
      • set_response_burst_size()
      • set_response_data()
      • set_response_latency()
      • set_response_request()
      • set_response_timeout()
      • set_write_response_id()
      • set_write_response_status()
      • signal_command_received
      • signal_error_exceed_max_pending_reads
      • signal_max_response_queue_size
      • signal_min_command_queue_size
      • signal_fatal_error
      • signal_response_issued
  • 4. Avalon-MM Slave BFM with Avalon-ST API Wrapper
  • 5. Avalon-MM Monitor
    • Parameters
    • Application Program Interface
      • Assertion Checking
        • set_enable_a_address_align_with_data_width()
        • set_enable_a_beginbursttransfer_exist()
        • set_enable_a_beginbursttransfer_legal()
        • set_enable_a_beginbursttransfer_single_cycle()
        • set_enable_a_begintransfer_exist()
        • set_enable_a_begintransfer_legal()
        • set_enable_a_begintransfer_single_cycle()
        • set_enable_a_burst_legal()
        • set_enable_a_byteenable_legal()
        • set_enable_a_constant_during_burst()
        • set_enable_a_constant_during_clk_disabled()
        • set_enable_a_constant_during_waitrequest()
        • set_enable_a_exclusive_read_write()
        • set_enable_a_half_cycle_reset_legal()
        • set_enable_a_less_than_burstcount_max_size()
        • set_enable_a_less_than_maximumpendingreadtransactions()
        • set_enable_a_no_readdatavalid_during_reset()
        • set_enable_a_no_read_during_reset()
        • set_enable_a_no_write_during_reset()
        • set_enable_a_readid_sequence()
        • set_enable_a_read_response_sequence()
        • set_enable_a_read_response_timeout()
        • set_enable_a_register_incoming_signals()
        • set_enable_a_waitrequest_during_reset()
        • set_enable_a_waitrequest_timeout()
        • set_enable_a_write_burst_timeout()
        • set_enable_a_writeid_sequence()
      • Coverage Group
        • set_enable_c_b2b_read_read()
        • set_enable_c_b2b_read_write()
        • set_enable_c_b2b_write_read()
        • set_enable_c_b2b_write_write()
        • set_enable_c_continuous_read()
        • set_enable_c_continuous_readdatavalid()
        • set_enable_c_continuous_waitrequest()
        • set_enable_c_continuous_waitrequest_from_idle_to_read()
        • set_enable_c_continuous_waitrequest_from_idle_to_write()
        • set_enable_c_continuous_write()
        • set_enable_c_idle_before_transaction()
        • set_enable_c_idle_in_read_response()
        • set_enable_c_idle_in_write_burst()
        • set_enable_c_pending_read()
        • set_enable_c_read()
        • set_enable_c_read_after_reset()
        • set_enable_c_read_burstcount()
        • set_enable_c_read_byteenable()
        • set_enable_c_read_latency()
        • set_enable_c_read_response()
        • set_enable_c_waitrequest_in_write_burst()
        • set_enable_c_waitrequested_read()
        • set_enable_c_waitrequest_without_command()
        • set_enable_c_waitrequested_write()
        • set_enable_c_write()
        • set_enable_c_write_with_and_without_writeresponserequest()
        • set_enable_c_write_after_reset()
        • set_enable_c_write_burstcount()
        • set_enable_c_write_byteenable()
        • set_enable_c_write_response()
      • Transaction Monitoring
        • get_clken()
        • get_version()
        • get_command_address()
        • get_command_arbiterlock()
        • get_command_burst_count()
        • get_command_burst_cycle()
        • get_command_byte_enable()
        • get_command_data()
        • get_command_debugaccess()
        • get_command_issued_queue_size()
        • get_command_queue_size()
        • get_command_lock()
        • get_command_request()
        • get_command_transaction_id()
        • get_command_write_response_request()
        • get_read_response_queue_size()
        • get_response_address()
        • get_response_byte_enable()
        • get_response_burst_size()
        • get_response_data()
        • get_response_latency()
        • get_response_queue_size()
        • get_response_read_id()
        • get_response_read_response()
        • get_response_request()
        • get_response_wait_time()
        • get_response_write_id()
        • get_response_write_response()
        • get_transaction_fifo_max()
        • get_transaction_fifo_threshold()
        • get_write_response_queue_size()
        • init()
        • pop_command()
        • pop_response()
        • set_command_transaction_mode()
        • set_transaction_fifo_max()
        • set_transaction_fifo_threshold()
        • signal_command_received
        • signal_fatal_error
        • signal_read_response_complete
        • signal_response_complete
        • signal_transaction_fifo_overflow
        • signal_transaction_fifo_threshold
        • signal_write_response_complete
  • Section IV. Avalon-ST BFMs
  • 1. Avalon-ST Source BFM
    • Functional Description
      • Timing
      • Block Diagram
    • Parameters
    • Application Program Interface
      • get_response_latency()
      • get_response_queue_size()
      • get_src_ready()
      • get_src_transaction_complete()
      • get_transaction_queue_size()
      • get_version()
      • init()
      • pop_response()
      • push_transaction()
      • set_max_transaction_queue_size()
      • set_min_transaction_queue_size()
      • set_response_timeout()
      • set_transaction_channel()
      • set_transaction_data()
      • set_transaction_idles()
      • set_transaction_eop()
      • set_transaction_empty()
      • set_transaction_error()
      • set_transaction_sop()
      • signal_fatal_error
      • signal_max_transaction_queue_size
      • signal_min_transaction_queue_size
      • signal_response_done
      • signal_src_driving_transaction
      • signal_src_not_ready
      • signal_src_ready
      • signal_src_transaction_complete
  • 2. Avalon-ST Source BFM with Avalon-ST API Wrapper
  • 3. Avalon-ST Sink BFM
    • Functional Description
      • Timing
      • Block Diagram
    • Parameters
    • Application Program Interface
      • get_transaction_channel()
      • get_transaction_data()
      • get_transaction_idles()
      • get_transaction_eop()
      • get_transaction_empty()
      • get_transaction_error()
      • get_transaction_queue_size()
      • get_transaction_sop()
      • get_version()
      • init()
      • pop_transaction()
      • set_ready()
      • signal_fatal_error
      • signal_sink_ready_assert
      • signal_sink_ready_deassert
      • signal_transaction_received
  • 4. Avalon-ST Sink BFM with Avalon-ST API Wrapper
  • 5. Avalon-ST Monitor
    • Parameters
    • Application Program Interface
      • Assertion Checking
        • set_enable_a_empty_legal()
        • set_enable_a_less_than_max_channel()
        • set_enable_a_no_data_outside_packet()
        • set_enable_a_non_missing_endofpacket()
        • set_enable_a_non_missing_startofpacket()
        • set_enable_a_valid_legal()
      • Coverage Group
        • set_enable_c_all_idle_beats()
        • set_enable_c_all_valid_beats()
        • set_enable_c_b2b_data_different_channel()
        • set_enable_c_b2b_data_same_channel()
        • set_enable_c_b2b_packet_different_channel()
        • set_enable_c_b2b_packet_in_different_transaction()
        • set_enable_c_b2b_packet_same_channel()
        • set_enable_c_b2b_packet_within_single_cycle()
        • set_enable_c_channel_change_in_packet()
        • set_enable_c_empty()
        • set_enable_c_error()
        • set_enable_c_error_in_middle_of_packet()
        • set_enable_c_idle_beat_between_packet()
        • set_enable_c_multiple_packet_per_cycle()
        • set_enable_c_non_valid_ready()
        • set_enable_c_non_valid_non_ready()
        • set_enable_c_packet()
        • set_enable_c_packet_no_idles_no_back_pressure()
        • set_enable_c_packet_size()
        • set_enable_c_packet_with_back_pressure()
        • set_enable_c_packet_with_idles()
        • set_enable_c_partial_valid_beats()
        • set_enable_c_single_packet_per_cycle()
        • set_enable_c_transfer()
        • set_enable_c_transaction_after_reset()
        • set_enable_c_valid_non_ready()
      • Transaction Monitoring
        • get_transaction_channel()
        • get_transaction_data()
        • get_transaction_empty()
        • get_transaction_eop()
        • get_transaction_error()
        • get_transaction_idles()
        • get_transaction_queue_size()
        • get_transaction_sop()
        • get_version()
        • pop_transaction()
        • set_transaction_fifo_max()
        • set_transaction_fifo_threshold()
        • signal_fatal_error
        • signal_transaction_fifo_overflow
        • signal_transaction_fifo_threshold
        • signal_transaction_received
  • Section V. Conduit and External Memory BFMs
  • 1. Conduit BFM
    • Block Diagram
    • Parameters
    • Application Program Interface
      • get_<role name>()
      • get_version()
      • set_<role name>()
      • set_<role name>_oe()
      • signal_input_<role name>_change
  • 2. Tri-State Conduit BFM
    • Block Diagram
    • Parameters
    • Application Program Interface
      • get_input_transaction_queue_size()
      • get_output_transaction_queue_size()
      • get_transaction_<role name>_in()
      • get_transaction_latency()
      • get_version()
      • pop_transaction()
      • push_transaction()
      • set_max_transaction_queue_size()
      • set_min_transaction_queue_size()
      • set_num_of_transactions()
      • set_transaction_<role name>_out()
      • set_transaction_<role name>_outen()
      • set_transaction_idles()
      • set_valid_transaction_<role name>_out()
      • signal_all_transactions_complete
      • signal_fatal_error
      • signal_grant_deasserted_while_request_remain_asserted()
      • signal_interface_granted
      • signal_max_transaction_queue_size
      • signal_min_transaction_queue_size
  • 3. External Memory BFM
    • Functional Description
      • Block Diagram
      • Initializing the Memory Content
      • Reading and Writing to the Memory Content
        • Reading from the Memory
        • Writing to the Memory
    • Parameters
    • Application Program Interface
      • fill()
      • read()
      • signal_api_call
      • write()
  • Section VI. Nios II Custom Instruction BFMs
  • 1. Nios II Custom Instruction Master BFM
    • Block Diagram
    • Parameters
    • Application Program Interface
      • get_instruction_queue_size()
      • get_result_delay()
      • get_result_queue_size()
      • get_result_value()
      • get_version()
      • insert_instruction()
      • pop_result()
      • push_instruction()
      • retrive_result()
      • set_ci_clk_en()
      • set_clock_enable_timeout()
      • set_instruction_a()
      • set_instruction_b()
      • set_instruction_c()
      • set_instruction_dataa()
      • set_instruction_datab()
      • set_instruction_err_inject()
      • set_instruction_idle()
      • set_instruction_n()
      • set_instruction_readra()
      • set_instruction_readrb()
      • set_instruction_timeout()
      • set_instruction_writerc()
      • set_max_instruction_queue_size()
      • set_max_result_queue_size()
      • set_min_instruction_queue_size()
      • set_min_result_queue_size()
      • set_result_timeout()
      • signal_unexpected_result_received
      • signal_fatal_error
      • signal_instructions_completed
      • signal_instruction_start
      • signal_max_instruction_queue_size
      • signal_max_result_queue_size
      • signal_min_instruction_queue_size
      • signal_min_result_queue_size
      • signal_result_received
  • 2. Nios II Custom Instruction Slave BFM
    • Block Diagram
    • Parameters
    • Application Program Interface
      • get_ci_clk_en()
      • get_instruction_a()
      • get_instruction_b()
      • get_instruction_c()
      • get_instruction_dataa()
      • get_instruction_datab()
      • get_instruction_idle()
      • get_instruction_n()
      • get_instruction_readra()
      • get_instruction_readrb()
      • get_instruction_writerc()
      • get_version()
      • insert_result()
      • retrieve_instruction()
      • set_clock_enable_timeout()
      • set_instruction_a()
      • set_instruction_b()
      • set_instruction_c()
      • set_instruction_timeout()
      • set_result_delay()
      • set_result_err_inject()
      • set_result_value()
      • signal_fatal_error
      • signal_instructions_inconsistent
      • signal_known_instruction_received
      • signal_result_done
      • signal_result_driven
      • signal_unknown_instruction_received
  • Section VII. Tutorials
  • 1. SOPC Builder Tutorial
    • Software Requirements
    • Verifying Avalon-MM Slave DUT
      • Setting up the Test
        • Creating an SOPC Builder Testbench for the DUT
        • Connecting and Generating the SOPC Builder System
      • Running the Simulation
      • Observing the Results
    • Verifying Avalon-MM Master DUT
      • Setting Up the Test
        • Creating an SOPC Builder Testbench for the DUT
        • Connecting and Generating the SOPC Builder System
      • Running the Simulation
      • Observing the Results
  • 2. Qsys Tutorial
    • Software Requirements
    • Verifying Avalon-ST DUT
      • Setting up the Test
        • Creating a Qsys System for the DUT
        • Generating a Qsys Testbench System
      • Setting up the Simulation Environment
      • Running the Simulation
      • Observing the Results
  • Additional Information
    • Document Revision History
    • How to Contact Altera
    • Typographic Conventions