# PCI express simulation framework for Cocotb
[](https://github.com/alexforencich/cocotbext-pcie/actions/)
[](https://codecov.io/gh/alexforencich/cocotbext-pcie)
[](https://pypi.org/project/cocotbext-pcie)
[](https://pepy.tech/project/cocotbext-pcie)
GitHub repository: https://github.com/alexforencich/cocotbext-pcie
## Introduction
PCI express simulation framework for [cocotb](https://github.com/cocotb/cocotb).
## Installation
Installation from pip (release version, stable):
$ pip install cocotbext-pcie
Installation from git (latest development version, potentially unstable):
$ pip install https://github.com/alexforencich/cocotbext-pcie/archive/master.zip
Installation for active development:
$ git clone https://github.com/alexforencich/cocotbext-pcie
$ pip install -e cocotbext-pcie
## Documentation and usage examples
See the `tests` directory, [verilog-pcie](https://github.com/alexforencich/verilog-pcie), and [corundum](https://github.com/corundum/corundum) for complete testbenches using these modules.
### Core PCIe simulation framework
The core PCIe simulation framework is included in `cocotbext.pcie.core`. This framework implements an extensive event driven simulation of a complete PCI express system, including root complex, switches, devices, and functions, including support for configuration spaces, capabilities and extended capabilities, and memory and IO operations between devices. The framework includes code to enumerate the bus, initialize configuration space registers and allocate BARs, route messages between devices, perform memory read and write operations, allocate DMA accessible memory regions in the root complex, and handle message signaled interrupts. Any module can be connected to a cosimulated design, enabling testing of not only isolated components and host-device communication but also communication between multiple components such as device-to-device DMA and message passing.
### PCIe IP core models
#### Xilinx UltraScale and UltraScale+
Models of the Xilinx UltraScale and UltraScale+ PCIe hard cores are included in `cocotbext.pcie.xilinx.us`. These modules can be used in combination with the PCIe BFM to test an HDL design that targets Xilinx UltraScale, UltraScale+, or Virtex 7 series FPGAs, up to PCIe gen 3 x16 or PCIe gen 4 x8. The models currently only support operation as a device, not as a root port.
#### Intel Stratix 10 H-Tile/L-Tile
Models of the Intel Stratix 10 H-Tile/L-Tile PCIe hard cores are included in `cocotbext.pcie.intel.s10`. These modules can be used in combination with the PCIe BFM to test an HDL design that targets Intel Stratix 10 GX, SX, TX, and MX series FPGAs that contain H-Tiles or L-Tiles, up to PCIe gen 3 x16. The models currently only support operation as a device, not as a root port.
#### Intel P-Tile
Models of the Intel P-Tile PCIe hard cores are included in `cocotbext.pcie.intel.ptile`. These modules can be used in combination with the PCIe BFM to test an HDL design that targets Intel Stratix 10 DX or Agilex F series FPGAs that contain P-Tiles, up to PCIe gen 4 x16. The models currently only support operation as a device, not as a root port.
Raw data
{
"_id": null,
"home_page": "https://github.com/alexforencich/cocotbext-pcie",
"name": "cocotbext-pcie",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "pcie,cocotb",
"author": "Alex Forencich",
"author_email": "alex@alexforencich.com",
"download_url": "https://files.pythonhosted.org/packages/3f/2e/c66ecc8d6d61acf29b7e015042790fbccc4d0ebc03d088dbcf5826725032/cocotbext-pcie-0.2.14.tar.gz",
"platform": "any",
"description": "# PCI express simulation framework for Cocotb\n\n[](https://github.com/alexforencich/cocotbext-pcie/actions/)\n[](https://codecov.io/gh/alexforencich/cocotbext-pcie)\n[](https://pypi.org/project/cocotbext-pcie)\n[](https://pepy.tech/project/cocotbext-pcie)\n\nGitHub repository: https://github.com/alexforencich/cocotbext-pcie\n\n## Introduction\n\nPCI express simulation framework for [cocotb](https://github.com/cocotb/cocotb).\n\n## Installation\n\nInstallation from pip (release version, stable):\n\n $ pip install cocotbext-pcie\n\nInstallation from git (latest development version, potentially unstable):\n\n $ pip install https://github.com/alexforencich/cocotbext-pcie/archive/master.zip\n\nInstallation for active development:\n\n $ git clone https://github.com/alexforencich/cocotbext-pcie\n $ pip install -e cocotbext-pcie\n\n## Documentation and usage examples\n\nSee the `tests` directory, [verilog-pcie](https://github.com/alexforencich/verilog-pcie), and [corundum](https://github.com/corundum/corundum) for complete testbenches using these modules.\n\n### Core PCIe simulation framework\n\nThe core PCIe simulation framework is included in `cocotbext.pcie.core`. This framework implements an extensive event driven simulation of a complete PCI express system, including root complex, switches, devices, and functions, including support for configuration spaces, capabilities and extended capabilities, and memory and IO operations between devices. The framework includes code to enumerate the bus, initialize configuration space registers and allocate BARs, route messages between devices, perform memory read and write operations, allocate DMA accessible memory regions in the root complex, and handle message signaled interrupts. Any module can be connected to a cosimulated design, enabling testing of not only isolated components and host-device communication but also communication between multiple components such as device-to-device DMA and message passing.\n\n### PCIe IP core models\n\n#### Xilinx UltraScale and UltraScale+\n\nModels of the Xilinx UltraScale and UltraScale+ PCIe hard cores are included in `cocotbext.pcie.xilinx.us`. These modules can be used in combination with the PCIe BFM to test an HDL design that targets Xilinx UltraScale, UltraScale+, or Virtex 7 series FPGAs, up to PCIe gen 3 x16 or PCIe gen 4 x8. The models currently only support operation as a device, not as a root port.\n\n#### Intel Stratix 10 H-Tile/L-Tile\n\nModels of the Intel Stratix 10 H-Tile/L-Tile PCIe hard cores are included in `cocotbext.pcie.intel.s10`. These modules can be used in combination with the PCIe BFM to test an HDL design that targets Intel Stratix 10 GX, SX, TX, and MX series FPGAs that contain H-Tiles or L-Tiles, up to PCIe gen 3 x16. The models currently only support operation as a device, not as a root port.\n\n#### Intel P-Tile\n\nModels of the Intel P-Tile PCIe hard cores are included in `cocotbext.pcie.intel.ptile`. These modules can be used in combination with the PCIe BFM to test an HDL design that targets Intel Stratix 10 DX or Agilex F series FPGAs that contain P-Tiles, up to PCIe gen 4 x16. The models currently only support operation as a device, not as a root port.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "PCI express simulation framework for cocotb",
"version": "0.2.14",
"project_urls": {
"Bug Tracker": "https://github.com/alexforencich/cocotbext-pcie/issues",
"Download": "https://github.com/alexforencich/cocotbext-pcie/tarball/master",
"Homepage": "https://github.com/alexforencich/cocotbext-pcie",
"Source Code": "https://github.com/alexforencich/cocotbext-pcie"
},
"split_keywords": [
"pcie",
"cocotb"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8372af8a93e78213f23d54d972fcde33993e1a0f882c2e89fb3f34ae97e48480",
"md5": "2383ba1b52c7ee1bd7034448d2294a4a",
"sha256": "e69a94d8892d6c9697fef729dd30ef80d6e21da192f057fa2313424d12e4541d"
},
"downloads": -1,
"filename": "cocotbext_pcie-0.2.14-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2383ba1b52c7ee1bd7034448d2294a4a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 133429,
"upload_time": "2023-06-24T05:17:42",
"upload_time_iso_8601": "2023-06-24T05:17:42.451454Z",
"url": "https://files.pythonhosted.org/packages/83/72/af8a93e78213f23d54d972fcde33993e1a0f882c2e89fb3f34ae97e48480/cocotbext_pcie-0.2.14-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3f2ec66ecc8d6d61acf29b7e015042790fbccc4d0ebc03d088dbcf5826725032",
"md5": "1a3359c9306c42c1c0f79f8f75c16c92",
"sha256": "fad3ab62df14a5973761e4885d850b76e7819244d3275258a5e704a22acbd3aa"
},
"downloads": -1,
"filename": "cocotbext-pcie-0.2.14.tar.gz",
"has_sig": false,
"md5_digest": "1a3359c9306c42c1c0f79f8f75c16c92",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 150223,
"upload_time": "2023-06-24T05:17:44",
"upload_time_iso_8601": "2023-06-24T05:17:44.363580Z",
"url": "https://files.pythonhosted.org/packages/3f/2e/c66ecc8d6d61acf29b7e015042790fbccc4d0ebc03d088dbcf5826725032/cocotbext-pcie-0.2.14.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-24 05:17:44",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "alexforencich",
"github_project": "cocotbext-pcie",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "cocotbext-pcie"
}
JSON
