##############################
cmake.peakrdl/peakrdl_regblock
##############################

.. module:: cmake.peakrdl/peakrdl_regblock


.. function:: peakrdl_regblock(IP_LIB **kwargs)

   Create a target for invoking PeakRDL-regblock on IP_LIB.
   
   PeakRDL-regblock is transforming SystemRDL input files to SystemVerilog register block files.
   Regblock documentation can be found on this `link <https://peakrdl-regblock.readthedocs.io/en/latest/>`_.
   
   Function expects that **${IP_LIB}** has **SYSTEMRDL_SOURCES** property set with
   a list of SystemRDL files to be used as inputs. To set the SYSTEMRDL_SOURCES property use the ip_sources()
   
   .. code-block:: cmake
   
      ip_sources(ip SYSTEMRDL ${PROJECT_SOURCE_DIR}/file.rdl)
   
   
   This function will append 2 generated files from PeakRDL-regblock to the **SYSTEMVERILOG_SOURCES** property of the
   **${IP_LIB}**.
   
   :param IP_LIB: IP for which to create regblock target.
   :type IP_LIB: IP library
   
   **Keyword Arguments**
   
   :keyword OUTDIR: output directory in which the files will be generated.
   If ommited ${BINARY_DIR}/regblock will be used.
   :type OUTDIR: string
   :keyword RENAME: Rename the generated module and file name to a custom string, otherwise the
   name will be ${IP_LIB}.sv.
   :type RENAME: string
   :keyword INTF: Interface to use for the regblock. Possible values are:
   [apb3 (default), apb3-flat, apb4, apb4-flat, axi4-lite, axi4-lite-flat, avalon-mm, avalon-mm-flat, passthrough]
   :type INTF: string
   :keyword RESET: reset type for generated regblock. Possible values are:
   [rst (default), rst,rst_n,arst,arst_n]
   :type RESET: string
   :keyword ARGS: any additional arguments to pass to peakrdl cli
   :type ARGS: list