schema_name: args
schema_version: 1.0
schema_type: peripheral

hdl_library_name: dp
hdl_library_description: "Data path (DP) peripherals for streaming data."

peripherals:
  - peripheral_name: dpmm    # pi_dpmm.py
    peripheral_description: "DP to MM FIFO to provide memory mapped MM read access from Data Path (DP) streaming interface."
    slave_ports:
      # MM port for mms_dp_fifo_to_mm.vhd / dp_fifo_to_mm_reg.vhd
      - slave_name: REG_DPMM_CTRL
        slave_type: REG
        slave_description: "DPMM = Monitor the DP to MM read FIFO."
        fields:
          - - field_name: rd_usedw
              field_description: "Number of words that can be read from the FIFO."
              access_mode: RO
              address_offset: 0x0
      
      # MM port for mms_dp_fifo_to_mm.vhd / dp_fifo_to_mm.vhd
      - slave_name: REG_DPMM_DATA   # Use REG_, instead of preferred FIFO_, to match slave_port_name in pi_dpmm.py
        slave_type: FIFO
        slave_description: "DPMM = read word from the DP to MM read FIFO"
        fields:
          - - field_name: rd_data
              field_description: "Read data from the FIFO."
              access_mode: RO
              address_offset: 0x0
        
  - peripheral_name: mmdp    # pi_mmdp.py
    peripheral_description: "MM to DP FIFO to provide memory mapped MM write access to Data Path (DP) streaming interface."
    slave_ports:                            
      # MM port for mms_dp_fifo_from_mm.vhd / dp_fifo_from_mm_reg.vhd
      - slave_name: REG_MMDP_CTRL
        slave_type: REG
        slave_description: "MMDP = Monitor the MM to DP write FIFO."
        fields:
          - - field_name: wr_usedw
              field_description: "Number of words that are in the write FIFO."
              access_mode: RO
              address_offset: 0x0
              
          - - field_name: wr_availw
              field_description: "Number of words that can be written to the write FIFO."
              access_mode: RO
              address_offset: 0x4
      
      # MM port for mms_dp_fifo_from_mm.vhd / dp_fifo_from_mm.vhd
      - slave_name: REG_MMDP_DATA   # Use REG_, instead of preferred FIFO_, to match slave_port_name in pi_mmdp.py
        slave_type: FIFO
        slave_description: "MMDP = write word to the MM to DP write FIFO"
        fields:
          - - field_name: data
              field_description: "Write data to the FIFO."
              access_mode: WO
              address_offset: 0x0