# APB interface modules for Cocotb
[](https://github.com/daxzio/cocotbext-apb/actions/)
[](https://codecov.io/gh/daxzio/cocotbext-apb)
[](https://pypi.org/project/cocotbext-apb)
[](https://pepy.tech/project/cocotbext-apb)
GitHub repository: https://github.com/daxzio/cocotbext-apb
## Introduction
APB simulation models for [cocotb](https://github.com/cocotb/cocotb).
## Installation
Installation from pip (release version, stable):
$ pip install cocotbext-apb
Installation from git (latest development version, potentially unstable):
$ pip install https://github.com/daxzio/cocotbext-apb/archive/main.zip
Installation for active development:
$ git clone https://github.com/daxzio/cocotbext-apb
$ pip install -e cocotbext-apb
## Documentation and usage examples
See the `tests` directory for complete testbenches using these modules.
### APB Bus
The `APBBus` is used to map to a JTAG interface on the `dut`. Class methods `from_entity` and `from_prefix` are provided to facilitate signal default name matching.
#### Required:
* _psel_
* _pwrite_
* _paddr_
* _pwdata_
* _pready_
* _prdata_
#### Optional:
* _pstrb_
* _pprot_
* _pslverr_
### APB Master
The `ApbMaster` class implement a APB driver and is capable of generating read and write operations against JTAG devices, either singularly or in a chain.
To use these modules, import the one you need and connect it to the DUT:
from cocotbext.apb import ApbMaster, ApbBus
bus = ApbBus.from_prefix(dut, "s_apb")
apb_driver = ApbMaster(bus, dut.clk)
The first argument to the constructor accepts an `ApbBus` object. These objects are containers for the interface signals and include class methods to automate connections.
Once the module is instantiated, read and write operations can be initiated in a couple of different ways.
Raw data
{
"_id": null,
"home_page": "https://github.com/daxzio/cocotbext-apb",
"name": "cocotbext-apb",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "apb, cocotb",
"author": "Dave Keeshan",
"author_email": "dave.keeshan@daxzio.com",
"download_url": "https://files.pythonhosted.org/packages/cb/dc/44997d0ccc7d2183516911f8f0906a12ba881b0c71acbdf764829e26d00b/cocotbext_apb-0.0.5.tar.gz",
"platform": "any",
"description": "# APB interface modules for Cocotb\n\n[](https://github.com/daxzio/cocotbext-apb/actions/)\n[](https://codecov.io/gh/daxzio/cocotbext-apb)\n[](https://pypi.org/project/cocotbext-apb)\n[](https://pepy.tech/project/cocotbext-apb)\n\nGitHub repository: https://github.com/daxzio/cocotbext-apb\n\n## Introduction\n\nAPB simulation models for [cocotb](https://github.com/cocotb/cocotb).\n\n## Installation\n\nInstallation from pip (release version, stable):\n\n $ pip install cocotbext-apb\n\nInstallation from git (latest development version, potentially unstable):\n\n $ pip install https://github.com/daxzio/cocotbext-apb/archive/main.zip\n\nInstallation for active development:\n\n $ git clone https://github.com/daxzio/cocotbext-apb\n $ pip install -e cocotbext-apb\n\n## Documentation and usage examples\n\nSee the `tests` directory for complete testbenches using these modules.\n\n### APB Bus\n\nThe `APBBus` is used to map to a JTAG interface on the `dut`. Class methods `from_entity` and `from_prefix` are provided to facilitate signal default name matching. \n\n#### Required:\n* _psel_\n* _pwrite_\n* _paddr_\n* _pwdata_\n* _pready_\n* _prdata_\n\n#### Optional:\n* _pstrb_\n* _pprot_\n* _pslverr_\n\n### APB Master\n\nThe `ApbMaster` class implement a APB driver and is capable of generating read and write operations against JTAG devices, either singularly or in a chain. \n\nTo use these modules, import the one you need and connect it to the DUT:\n\n from cocotbext.apb import ApbMaster, ApbBus\n\n bus = ApbBus.from_prefix(dut, \"s_apb\")\n apb_driver = ApbMaster(bus, dut.clk)\n\nThe first argument to the constructor accepts an `ApbBus` object. These objects are containers for the interface signals and include class methods to automate connections.\n\nOnce the module is instantiated, read and write operations can be initiated in a couple of different ways.\n\n\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "apb modules for cocotb",
"version": "0.0.5",
"project_urls": {
"Bug Tracker": "https://github.com/daxzio/cocotbext-apb/issues",
"Download": "https://github.com/daxzio/cocotbext-apb/tarball/master",
"Homepage": "https://github.com/daxzio/cocotbext-apb",
"Source Code": "https://github.com/daxzio/cocotbext-apb"
},
"split_keywords": [
"apb",
" cocotb"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "cbdc44997d0ccc7d2183516911f8f0906a12ba881b0c71acbdf764829e26d00b",
"md5": "082c1ea0a82cc260caa6de539b087b7b",
"sha256": "eaaf75b17ccbc5395e8f65c24221098c4d90a5814a5856be65daab7dde26dd94"
},
"downloads": -1,
"filename": "cocotbext_apb-0.0.5.tar.gz",
"has_sig": false,
"md5_digest": "082c1ea0a82cc260caa6de539b087b7b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 8498,
"upload_time": "2025-01-03T17:24:11",
"upload_time_iso_8601": "2025-01-03T17:24:11.054734Z",
"url": "https://files.pythonhosted.org/packages/cb/dc/44997d0ccc7d2183516911f8f0906a12ba881b0c71acbdf764829e26d00b/cocotbext_apb-0.0.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-03 17:24:11",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "daxzio",
"github_project": "cocotbext-apb",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "cocotb",
"specs": []
},
{
"name": "cocotb-bus",
"specs": []
},
{
"name": "pytest",
"specs": []
},
{
"name": "pyflakes",
"specs": []
},
{
"name": "ruff",
"specs": []
},
{
"name": "mypy",
"specs": []
}
],
"lcname": "cocotbext-apb"
}
JSON
