# JTAG interface modules for Cocotb
[](https://github.com/daxzio/cocotbext-jtag/actions/)
[](https://codecov.io/gh/daxzio/cocotbext-jtag)
[](https://pypi.org/project/cocotbext-jtag)
[](https://pepy.tech/project/cocotbext-jtag)
GitHub repository: https://github.com/daxzio/cocotbext-jtag
## Introduction
JTAG simulation models for [cocotb](https://github.com/cocotb/cocotb).
## Installation
Installation from pip (release version, stable):
$ pip install cocotbext-jtag
Installation from git (latest development version, potentially unstable):
$ pip install https://github.com/daxzio/cocotbext-jtag/archive/main.zip
Installation for active development:
$ git clone https://github.com/daxzio/cocotbext-jtag
$ pip install -e cocotbext-jtag
## Documentation and usage examples
See the `tests` directory for complete testbenches using these modules.
### JTAG Bus
The `JTAGBus` is used to map to a JTAG interface on the `dut`. These hold instances of bus objects for the individual channels, which are currently extensions of `cocotb_bus.bus.Bus`. Class methods `from_entity` and `from_prefix` are provided to facilitate signal default name matching.
#### Required:
* _tck_
* _tms_
* _tdi_
* _tdo_
#### Optional:
* _trst_
### JTAG Driver
The `JTAGDriver` class implement a JTAG 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.jtag import JTAGDriver, JTAGBus, JTAGDevice
bus = JTAGBus(dut)
jtag_driver = JTAGDriver(bus)
jtag_driver.add_device(JTAGDevice())
The first argument to the constructor accepts an `JTAGBus` 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.
#### Additional optional arguments for `JTAGDriver`
* _period_: Clock frequency period of `tck`, default `100`
* _units_: Clock units, default `ns`
* _logging_enabled_: Logging enable, default `True`
#### Methods
* `add_device(device)`: Add device to jtag chain, must be of type `JTAGDevice`
* `set_reset(num)`: Reset for _num_ if _trst_ is present in `JTAGBus`, raise warning if _trst_ is not present
* `reset_finished()`: Asyn wait until reset is finished
* `reset_fsm()`: Send 5 _tck_ pulses while _tms_ is held high in `JTAGBus`, this resets the finite state machine inside a JTAG TAP
* `send_val(addr, val, device, write)`: Send _addr_ to _device_ (default: `0`). The _val_ is used to write if _write_ is True or verify against if _write_ is False
* `write_val(addr, val, device=0)`: Write _val_ to _addr_ of _device_ (default: `0`).
* `read_val(addr, val=None, device=0)`: Read from _addr_ of _device_ (default: `0`). If _val_ present verify against returned value.
* `read_idcode(device)`: Read device number _device_ and confirm it matched the IDCODE set for that device
### JTAG Device
`JTAGDriver` needs to be told what devices are in the JTAG chain it is communicating with inside the `dut`. A `JTAGDevice` needs to be defined for this purpose or a device that inherits from this base class.
A `JTAGDevice` needs a _name_, _idcode_ and _ir_len_. It also seens to have the IR Register map defined and the width of the the register. 'BYPASS' is prepopulated in the base class at last address in the IRLEN address map.
First inherit from the base class, , and after add all the other IR regiters using the _add_jtag_reg_ method.
from cocotbext.jtag import JTAGDevice
class J1JTAGDevice(JTAGDevice):
def __init__(self, name='jtaglet1', idcode=0x53817905, ir_len=5):
super().__init__(name, idcode, ir_len)
self.add_jtag_reg("IDCODE", 32, 0x1e)
self.add_jtag_reg('USERDATA', 32, 0x8)
self.add_jtag_reg('USEROP', 8, 0x9)
self.idle_delay = 6
* `add_jtag_reg(name, width, address)`: Add an IR register to `JTAGDevice`. _name_ is a string, _width_ is the DR shift width of the register and the address, which should be with in the range if the _ir_len_ of `JTAGDevice`
This results in a `JTAGDevice` that has 4 IR register defined:
0x08: USERDATA[31:0]
0x09: USEROP[7:0]
0x1e: IDCODE[31:0]
0x1f: BYPASS[0:0]
Multiple devices inside the JTAG chain:
from cocotbext.jtag import JTAGDriver
from cocotbext.jtag import JTAGBus
class testbench:
def __init__(self, dut):
bus = JTAGBus(dut)
self.jtag = JTAGDriver(bus)
self.jtag.add_device(J1JTAGDevice())
self.jtag.add_device(J2JTAGDevice())
Raw data
{
"_id": null,
"home_page": "https://github.com/daxzio/cocotbext-jtag",
"name": "cocotbext-jtag",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "jtag, cocotb",
"author": "Dave Keeshan",
"author_email": "dave.keeshan@daxzio.com",
"download_url": "https://files.pythonhosted.org/packages/ce/41/0549d671a7790e3d62d21b9df67d5da25130dd7327a7131dac95008a82d6/cocotbext_jtag-0.0.14.tar.gz",
"platform": "any",
"description": "# JTAG interface modules for Cocotb\n\n[](https://github.com/daxzio/cocotbext-jtag/actions/)\n[](https://codecov.io/gh/daxzio/cocotbext-jtag)\n[](https://pypi.org/project/cocotbext-jtag)\n[](https://pepy.tech/project/cocotbext-jtag)\n\nGitHub repository: https://github.com/daxzio/cocotbext-jtag\n\n## Introduction\n\nJTAG simulation models for [cocotb](https://github.com/cocotb/cocotb).\n\n## Installation\n\nInstallation from pip (release version, stable):\n\n $ pip install cocotbext-jtag\n\nInstallation from git (latest development version, potentially unstable):\n\n $ pip install https://github.com/daxzio/cocotbext-jtag/archive/main.zip\n\nInstallation for active development:\n\n $ git clone https://github.com/daxzio/cocotbext-jtag\n $ pip install -e cocotbext-jtag\n\n## Documentation and usage examples\n\nSee the `tests` directory for complete testbenches using these modules.\n\n### JTAG Bus\n\nThe `JTAGBus` is used to map to a JTAG interface on the `dut`. These hold instances of bus objects for the individual channels, which are currently extensions of `cocotb_bus.bus.Bus`. Class methods `from_entity` and `from_prefix` are provided to facilitate signal default name matching. \n\n#### Required:\n* _tck_\n* _tms_\n* _tdi_\n* _tdo_\n\n#### Optional:\n* _trst_\n\n### JTAG Driver\n\nThe `JTAGDriver` class implement a JTAG 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.jtag import JTAGDriver, JTAGBus, JTAGDevice\n\n bus = JTAGBus(dut)\n jtag_driver = JTAGDriver(bus)\n jtag_driver.add_device(JTAGDevice())\n\nThe first argument to the constructor accepts an `JTAGBus` 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#### Additional optional arguments for `JTAGDriver`\n\n* _period_: Clock frequency period of `tck`, default `100`\n* _units_: Clock units, default `ns`\n* _logging_enabled_: Logging enable, default `True`\n\n#### Methods\n\n\n* `add_device(device)`: Add device to jtag chain, must be of type `JTAGDevice`\n* `set_reset(num)`: Reset for _num_ if _trst_ is present in `JTAGBus`, raise warning if _trst_ is not present\n* `reset_finished()`: Asyn wait until reset is finished\n* `reset_fsm()`: Send 5 _tck_ pulses while _tms_ is held high in `JTAGBus`, this resets the finite state machine inside a JTAG TAP\n* `send_val(addr, val, device, write)`: Send _addr_ to _device_ (default: `0`). The _val_ is used to write if _write_ is True or verify against if _write_ is False\n* `write_val(addr, val, device=0)`: Write _val_ to _addr_ of _device_ (default: `0`). \n* `read_val(addr, val=None, device=0)`: Read from _addr_ of _device_ (default: `0`). If _val_ present verify against returned value.\n* `read_idcode(device)`: Read device number _device_ and confirm it matched the IDCODE set for that device\n\n\n### JTAG Device\n\n`JTAGDriver` needs to be told what devices are in the JTAG chain it is communicating with inside the `dut`. A `JTAGDevice` needs to be defined for this purpose or a device that inherits from this base class.\n\nA `JTAGDevice` needs a _name_, _idcode_ and _ir_len_. It also seens to have the IR Register map defined and the width of the the register. 'BYPASS' is prepopulated in the base class at last address in the IRLEN address map.\n\nFirst inherit from the base class, , and after add all the other IR regiters using the _add_jtag_reg_ method.\n\n\n from cocotbext.jtag import JTAGDevice\n\n class J1JTAGDevice(JTAGDevice):\n def __init__(self, name='jtaglet1', idcode=0x53817905, ir_len=5):\n super().__init__(name, idcode, ir_len)\n self.add_jtag_reg(\"IDCODE\", 32, 0x1e)\n self.add_jtag_reg('USERDATA', 32, 0x8)\n self.add_jtag_reg('USEROP', 8, 0x9)\n self.idle_delay = 6\n\n* `add_jtag_reg(name, width, address)`: Add an IR register to `JTAGDevice`. _name_ is a string, _width_ is the DR shift width of the register and the address, which should be with in the range if the _ir_len_ of `JTAGDevice`\n\n \nThis results in a `JTAGDevice` that has 4 IR register defined:\n\n\n 0x08: USERDATA[31:0] \n 0x09: USEROP[7:0] \n 0x1e: IDCODE[31:0] \n 0x1f: BYPASS[0:0] \n\n\nMultiple devices inside the JTAG chain:\n\n from cocotbext.jtag import JTAGDriver\n from cocotbext.jtag import JTAGBus\n\n class testbench:\n def __init__(self, dut):\n bus = JTAGBus(dut)\n self.jtag = JTAGDriver(bus)\n self.jtag.add_device(J1JTAGDevice())\n self.jtag.add_device(J2JTAGDevice())\n\n\n\n\n\n\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "jtag modules for cocotb",
"version": "0.0.14",
"project_urls": {
"Bug Tracker": "https://github.com/daxzio/cocotbext-jtag/issues",
"Download": "https://github.com/daxzio/cocotbext-jtag/tarball/master",
"Homepage": "https://github.com/daxzio/cocotbext-jtag",
"Source Code": "https://github.com/daxzio/cocotbext-jtag"
},
"split_keywords": [
"jtag",
" cocotb"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ce410549d671a7790e3d62d21b9df67d5da25130dd7327a7131dac95008a82d6",
"md5": "a6945fb4babdd3d6b3277339895b984c",
"sha256": "a9294c94cfe400ee09a48cf91e594dbcbe03dcc94a41290f27e69b3846524130"
},
"downloads": -1,
"filename": "cocotbext_jtag-0.0.14.tar.gz",
"has_sig": false,
"md5_digest": "a6945fb4babdd3d6b3277339895b984c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 15946,
"upload_time": "2025-01-03T17:24:45",
"upload_time_iso_8601": "2025-01-03T17:24:45.818214Z",
"url": "https://files.pythonhosted.org/packages/ce/41/0549d671a7790e3d62d21b9df67d5da25130dd7327a7131dac95008a82d6/cocotbext_jtag-0.0.14.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-03 17:24:45",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "daxzio",
"github_project": "cocotbext-jtag",
"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-jtag"
}
JSON
