CAPI2

Core API Version 2

Pattern Properties

  • ^name$ (string): VLNV identifier for core.

  • ^description$ (string): Short description of core.

  • ^provider$ (object): Provider of core.

    • Any of

      • object: github Provider. Cannot contain additional properties.

        • name (string, required)

        • user (string, required)

        • repo (string, required)

        • version (string, required)

        • patches (array)

          • Items (string)

        • cachable (boolean)

      • object: local Provider. Cannot contain additional properties.

        • name (string, required)

        • patches (array)

          • Items (string)

        • cachable (boolean)

      • object: git Provider. Cannot contain additional properties.

        • name (string, required)

        • repo (string, required)

        • version (string)

        • patches (array)

          • Items (string)

        • cachable (boolean)

      • object: opencores Provider. Cannot contain additional properties.

        • name (string, required)

        • repo_name (string, required)

        • repo_root (string, required)

        • revision (string, required)

        • patches (array)

          • Items (string)

        • cachable (boolean)

      • object: svn Provider. Cannot contain additional properties.

        • name (string, required)

        • url (string, required)

        • revision (string)

        • ignore_externals (boolean)

        • patches (array)

          • Items (string)

        • cachable (boolean)

      • object: url Provider. Cannot contain additional properties.

        • name (string, required)

        • url (string, required)

        • user-agent (string)

        • verify_cert (string)

        • filetype (string, required)

        • patches (array)

          • Items (string)

        • cachable (boolean)

  • ^filesets$ (object): A fileset represents a group of files with a common purpose. Each file in the fileset is required to have a file type and is allowed to have a logical_name which can be set for the whole fileset or individually for each file. A fileset can also have dependencies on other cores, specified in the depend section. Cannot contain additional properties.

    • ^.+$ (object): Name of fileset. Cannot contain additional properties.

      • ^file_type$ (string): Default file_type for files in fileset.

      • ^logical_name$ (string): Default logical_name (i.e. library) for files in fileset.

      • ^tags$ (array): Default tags for files in fileset.

        • Items (string)

      • ^files(_append)?$ (array): Files in fileset.

        • Items

          • One of

            • string

            • object: Cannot contain additional properties.

              • ^.+$ (object): Path to file. Cannot contain additional properties.

                • define (object): Defines to be used for this file. These defines will be added to those specified in the target parameters section. If a define is specified both here and in the target parameter section, the value specified here will take precedence. The parameter default value can be set here with param=value.

                  • ^.+$