v2.4.9 (2026-06-04)

Changes/additions since OpenCPI Release v2.4.8

New Features

  • app: all example applications modified to be backwards compatible with new E31x DRC. (!1363)(202e58d0)

  • app: updated to use modified comp.sdr project components. (!1364)(d781992d)

  • app: standardize examples project hdl/assemblies folders and files. (!1365)(496bf177)

  • app: add run_mode_64b test application to test 64-bit wide data path throughput. (!1384)(4413a695)

  • app,comp: replaced standalone convert comps with convert_interface comp; deleted all standalone convert comp. (!1397)(0da000cd)

  • app,comp: update test project to worker with ocpidev2. (!1425)(10be7ac4)

  • app,tools: add signal analyzer support to smaller platforms. (!1367)(919cd91e)

  • comp: move dgrdma_config_dev.hdl and dgrdma_config_proxy.rcc to core.devices. (!1325)(c7b69d7f)

  • comp: add scipy to python env. (!1357)(00339cdd)

  • comp: ‘packet_gate_b’ created to replace ‘discontinuity_gate_b’ component to use metadata opcode. (!1364)(d781992d)

  • comp: add support to primitives, workers and assemblies for makeless builds. (!1400)(c6d6b1ea)

  • comp: convert assets project for less makefiles. (!1401)(4fad94b1)

  • comp,tools: implementation of new E31x DRC. (!1363)(202e58d0)

  • devops: add ocpidev2 tool. (!1298)(1eeef292)

  • devops: update CICD configs and scripts for new gitlab-runners. (!1299)(555e46d3)

  • devops: allow git commands to work on opencpi projects in container images. (!1304)(a588cea2)

  • devops: add ocpidev2 and ocpiadmin2 pytests to CI/CD pipelines. (!1323)(1c6d3d9b)

  • devops: add opencpi tutorials to CI/CD pipelines. (!1329)(8d534b3d)

  • devops: utilize ocpiadmin2 in CI-CD pipelines. (!1349)(d4688e6c)

  • devops: add ocpiremote2 tool. (!1386)(265e641d)

  • devops: update CI/CD to reflect tool changes. (!1425)(10be7ac4)

  • devops,tests: add hardware in the loop testing. (!1191)(ce89d142)

  • devops,tests: add hardware in the loop testing. (!1333)(1035d99b)

  • devops,tests: add hardware in the loop testing. (!1371)(fc80bbbb)

  • devops,tools: enable the examples project in CI/CD pipelines. (!1368)(e3946955)

  • doc: update tutorial project. (!1297)(72e10eae)

  • doc: add e31x to project dependencies in examples project. (!1340)(01386245)

  • doc: convert reference documentation to ocpidoc. (!1383)(9d8e5337)

  • doc: add prebuildscript and configfile documentation for workers, hdl primitives, and hdl assemblies. (!1408)(78ccfd10)

  • doc: update ocpidev commands in tutorial docs to reflect tool changes. (!1425)(10be7ac4)

  • doc: remove old ocpidev, ocpiadmin, and ocpiremote man pages. (!1425)(10be7ac4)

  • hdl base: codebase cleanup remove unused fir primitives from assets. (!1338)(446bef6e)

  • hdl base: make ad9361_interface_test assembly generic. (!1393)(7a421593)

  • osp: update zcu106 hdl platform. (!1379)(93a93e44)

  • osp: update delay values e31x drc in examples. (!1393)(7a421593)

  • runtime: modification of DRC base to add offset tuning and add E31x DRC and AD9361 source and include files. (!1363)(202e58d0)

  • runtime: enable managed cache dma for Zynq Ultrascale platforms. (!1384)(4413a695)

  • runtime,tools,tools: add questa hdl simulation platform. (!1387)(9885e427)

  • tests: add spec definitions to mocks in ocpidev2 unit tests. (!1306)(e8d2f824)

  • tests: add tests for ocpiadmin2 tool. (!1320)(733efbc4)

  • tests: adds pytests to automate running tutorials 1 and 2. (!1322)(29f922ab)

  • tests: update test-opencpi.sh to test new ocpidev, ocpiadmin, and ocpiremote. (!1425)(10be7ac4)

  • tests,tools: add tests for ocpidev2 delete command. (!1305)(27fcc660)

  • tests,tools: add base test class for ocpidev2 CLI tests. (!1307)(f1f6a076)

  • tests,tools: add tests for ocpidev2 create command. (!1309)(cce61c8f)

  • tests,tools: add tests for ocpidev2 show command. (!1310)(c65c4337)

  • tests,tools: add tests for ocpidev2 build command. (!1312)(4fa73d09)

  • tests,tools: add tests for running through OpenCPI tutorials using ocpidev2. (!1313)(c2066169)

  • tests,tools: add tests for ocpidev2 clean command. (!1314)(d7ea3193)

  • tests,tools: add tests for ocpidev2 run command. (!1315)(1a3ebecf)

  • tests,tools: add tests for ocpidev2 register and unregister commands. (!1318)(8b37595a)

  • tests,tools: add tests for ocpidev2 cli utils. (!1321)(02d80eeb)

  • tests,tools: simplify ocpidev2 asset models. (!1327)(714d854f)

  • tests,tools: refactor ocpidev2 models create parser classes. (!1345)(620e7a6c)

  • tests,tools: add tests for new models added to ocpidev2. (!1356)(3047f6eb)

  • tests,tools: add tests for new assets added to ocpidev2. (!1370)(ddf90372)

  • tests,tools: update ocpigen tool to only build HDL file IO assemblies when valid. (!1385)(4744f12f)

  • tests,tools: add improvements to ocpidev2 and ocpiadmin2. (!1391)(425b9573)

  • tools: add global ignores to ContainerProperty in GCC >= 10. (!1160)(b2928df1)

  • tools: add ocpiadmin2 tool to utilize ocpidev2. (!1320)(733efbc4)

  • tools: add ocpidev2 features to enable automatically running tutorials using. (!1322)(29f922ab)

  • tools: add ocpidev2 and ocpiadmin2 tools to OpenCPI installation. (!1323)(1c6d3d9b)

  • tools: add support for sha256 validation of prerequisite downloads. (!1324)(1a6ebe86)

  • tools: move hdl “part” definition to the platform xml. (!1325)(c7b69d7f)

  • tools: add sha256sum check to prerequisite source downloads. (!1332)(cfdda011)

  • tools: add ubuntu24_04 as development platform. (!1337)(c1a0a933)

  • tools: provide specific commit to adi no-OS prerequisite. (!1341)(b293dfb0)

  • tools: remove packaging directory containing legacy scripts. (!1342)(a08999c5)

  • tools: move ocpilint to singular python venv. (!1344)(1fb74561)

  • tools: move ocpidoc to singular python venv. (!1344)(1fb74561)

  • tools: add xml files to examples project to enable compatibility with ocpidev2. (!1350)(046bc50c)

  • tools: add ability to auto build HDL primitives. (!1372)(00dc3822)

  • tools: add wildcard card functionality to container files. (!1375)(71c574ce)

  • tools: add OcpiKernelCC option. (!1378)(cc995261)

  • tools: refactor Target asset class in ocpidev2. (!1380)(0ecc85de)

  • tools: add extra parsers for json & yaml. (!1380)(0ecc85de)

  • tools: suppress compiler warnings when log level set to 1 or 0. (!1406)(c5a8b80c)

  • tools: skip building workers by default when installing platforms. (!1412)(01991f56)

  • tools: replace ocpidev, ocpiadmin, and ocpiremote with ocpidev2, ocpiadmin2, and ocpiremote2. (!1425)(10be7ac4)

  • tools: change opencpi docs “all releases” link to point to opencpi.dev. (!1427)(c766e1c7)

Bug Fixes

  • comp: fix bug in pattern_v2 worker. (!1296)(c02e66ee)

  • comp: fix complex_mixer.hdl in tutorial project unnecessarily rebuilding. (!1343)(6bf70abc)

  • comp: prevent complex_mixer from tutorial building IP when target is not a Xilinx target as Xilinx tools may not be installed. (!1387)(9885e427)

  • comp: fix crc_validator_uc component. (!1390)(ade744c8)

  • devops: fix issue with extracting tarfiles in podman containers. (!1304)(a588cea2)

  • devops: fix inconsistencies in CI/CD pipelines pertaining to submodule initialization. (!1304)(a588cea2)

  • devops: fix tutorials not running in MR pipelines. (!1353)(0078942f)

  • hdl base: add missing to_short and to_ushort functions. (!1160)(b2928df1)

  • hdl base: use hdlimplementation for all adapters. (!1160)(b2928df1)

  • hdl base: fix complex short protocol type conversion issue. (!1160)(b2928df1)

  • hdl base: improve VHDL syntax in master.vhd and part_master.vhd to allow compilation in Questa. (!1387)(9885e427)

  • runtime: changed bounds checking in of Booking used_Impls vector Application.cc bookingOk function. (!1319)(ca1dee5b)

  • runtime: remove DRC enumerated classes, increasing efficiency. (!1371)(fc80bbbb)

  • runtime: fix e31x drc in examples project. (!1392)(ae2f74da)

  • runtime: fix remote session bug. (!1422)(67d078b9)

  • tests: fix build of unit tests containing HdlFileIO. (!1360)(68d2c7bc)

  • tests: fix build dependency on worker-specific properties for non-implementing tests. (!1398)(cd228168)

  • tests: fix skipping of worker-specific property tests when non-default values are used. (!1398)(cd228168)

  • tools: prevent zynq library from generating for other platforms. (!1160)(b2928df1)

  • tools: support finishedworkerisuut in ocpigen. (!1160)(b2928df1)

  • tools: support Xilinx parts with the temperature grade c. (!1160)(b2928df1)

  • tools: fix broken thing. (!1191)(ce89d142)

  • tools: allowed getPlatforms to handle invalid platform args for only- and excludePlatforms. (!1281)(97521f40)

  • tools: adding warning/error lines and conditionals to rcc-make.mk. (!1284)(69b5a4c6)

  • tools: added atomic flag to ocpirun_main signal handler that is consumed by application and container worker. (!1293)(108ca9fa)

  • tools: moved OcpiIcludeAssetAndParent call in test.mk earlier to use xml parameters. (!1294)(8c42c189)

  • tools: fix bugs in ocpidev2 when running through tutorials. (!1308)(9f0641eb)

  • tools: fix prerequisite source parsing. (!1324)(1a6ebe86)

  • tools: fix ocpidev2 failing to install for ubuntu22.04. (!1330)(9e625212)

  • tools: fix broken thing. (!1333)(1035d99b)

  • tools: allow –workers-as-needed to find -hdl.xml files. (!1335)(ee359b79)

  • tools: changed order and conditions of hdl assembly generation in ocpigen/src/tests.cc. (!1347)(5704d449)

  • tools: fix oacpiadmin2 not properly exporting hdl platforms. (!1351)(ac420dcc)

  • tools: move remaining file system logic in ocpidev2 from models to parsers. (!1352)(884d6ac2)

  • tools: disable the test_source_assy and test_sinky_assy assemblies for zed_ether. (!1354)(7283fd50)

  • tools: update ocpidev2 for backwards compatibility with python 3.8. (!1355)(1aa84e57)

  • tools: fix a few bugs discovered by newly added tests. (!1356)(3047f6eb)

  • tools: fix tutorial and examples project docs not generating with build-pages.py. (!1358)(28c8a3de)

  • tools: add OcpiKernelPrepareNotRequired variable to kernel builds. (!1359)(9ded4431)

  • tools: remove driver make variable as it no longer needed. (!1361)(ac232c4c)

  • tools: fix ubuntu24.04 install. (!1362)(4eb4a210)

  • tools: fix ocpilint xml parsing unicode strings. (!1366)(363b6535)

  • tools: fix ocpilint package checking within venv. (!1369)(3d2409fc)

  • tools: fix a few bugs discovered by newly added tests. (!1370)(ddf90372)

  • tools: fix kernel build for ubuntu24_04. (!1373)(20bd49b6)

  • tools: add missing python package for newer python versions. (!1374)(4579525e)

  • tools: fix ocpidev2 causing terminal cursor to disappear. (!1376)(2af69d9a)

  • tools: update broken zlib prerequisite for examples project. (!1377)(0d11e66f)

  • tools: fix standalone mode mount point on zynq platforms. (!1381)(ee4b0e7e)

  • tools: fix incorrect cppcheck syntax error when running ocpilint on rcc workers. (!1382)(deb2caeb)

  • tools: fix optimized builds of xilinx24_1_aarchXX rcc platforms. (!1384)(4413a695)

  • tools: fix for xsim 2025.2. (!1388)(dfe13984)

  • tools: fix ocpilint ignore pattern handling to fix a number of issues with both pattern classification and path matching. (!1389)(ed87c6ac)

  • tools: fix segfault when running tests. (!1402)(ea20eec3)

  • tools: exclude platforms from assemblies without enough resources. (!1403)(95402022)

  • tools: fix ocpidev2 stack trace when parsing asset XML file fails. (!1407)(51381c69)

  • tools: fix ocpidev2 not initializing HDL libraries when cleaned or project is registered. (!1407)(51381c69)

  • tools: fix ocpidev2 not initializing libraries when xml files exclude the host platform. (!1407)(51381c69)

  • tools: ensure project.mk “declare” recipe first executes the “imports” and “exports” recipes. (!1409)(2765f52f)

  • tools: put try/except block around ocpiremote2 status API to prevent stack trace on exception. (!1410)(3660e505)

  • tools: remove redundant status call in ocpiremote2 unload API. (!1410)(3660e505)

  • tools: update ocpiremote2 create to use -.tar.gz naming convention. (!1410)(3660e505)

  • tools: update ocpiremote2 to print message if existing tar file used when doing a load. (!1410)(3660e505)

  • tools: add missing “–optimize” when installing platforms with ocpiadmin2. (!1411)(f0190a75)

  • tools: fix ubuntu24_04 optimized build. (!1415)(fa6acb80)

  • tools: fix E31x DRC filter selection. (!1416)(fed136d6)

  • tools: fix ocpiadmin2 failing to install certain platforms. (!1417)(dcd083d7)

  • tools: fix ocpidev2 not filtering assets specified in library xml files. (!1418)(75f11ceb)

  • tools: make default output from building workers, tests, projects, and libraries less noisy. (!1419)(4775493b)

  • tools: fix order of platform ocpiremote2 CLI args for consistency with other tools (e.g., ocpiadmin2). (!1420)(fb215a50)

  • tools: add plutosdr as excluded platform for fsk_app_rx_hdl_assy. (!1421)(ab0102ad)

  • tools: fix “ocpiremote2 load” erroneously reporting that the remote sandbox directory already exists when the remote device cannot be reached. (!1424)(c7a22e70)

  • tools: fix “ocpiremote load” returning non-zero exit code when operation was successful. (!1426)(f9cfa6b2)

Documentation

  • app: remove reference to wget ads-b example readme. (!1339)(c94caff7)

  • app,doc,runtime: added info on OCPI_TRANSFER_PORT to the ocpirun man page and app dev guide. (!1300)(5fa1af87)

  • doc: fix broken hyperlinks, errors, typos, odd formatting issues in the Tutorials and a few Docs. (!1291)(10a1f428)

  • doc: changed xml code and commands in tutorial 2 document. (!1348)(abe4cb02)

v2.4.8 (2025-03-28)

Changes/additions since OpenCPI Release v2.4.7

New Features

  • app: add ocpi.comp.sdr based FSK application. (!1190)(092319f5)

  • app: make fsk_app more generic. (!1224)(446a2680)

  • app: new example application to generate an RF signal from file. (!1228)(8136509c)

  • comp,comp: remove assets_ts project. (!1199)(cede01c9)

  • comp,runtime: increase maximum HDL worker count to 127. (!1157)(0d25d54c)

  • devops: update AWS region. (!1089)(25937dda)

  • devops: change vendor tools. (!1089)(25937dda)

  • devops: fix broken autolabels in gitlab issue templates. (!1108)(4882d8dd)

  • devops: add zcu104 to HWIL testing. (!1148)(bc9a213e)

  • devops: update rocky8 dockerfile for CI/CD pipeline. (!1167)(b9a36d3f)

  • devops: auto-cancel pipelines if a pipeline on a new commit of the same ref is launched. (!1167)(b9a36d3f)

  • devops: migrate pipeline from docker to podman. (!1176)(26f5883b)

  • devops: more efficiently utilize image layer caching. (!1177)(e62e335a)

  • devops: re-enable GitLab cache for CI/CD pipelines. (!1178)(b5045117)

  • devops: enable rocky9 for CI/CD pipelines. (!1211)(7dd87c00)

  • devops: add OCPI_LD_PRELOAD to Ubuntu containers to support Xilinx 2024.1 tools. (!1275)(75a7381c)

  • devops,tests: allow for granular prerequisite installation. (!1181)(1af4b3b3)

  • doc: add examples project to documentation. (!1219)(90e1d6f8)

  • doc: add examples and ocpi.osp.hitech-global to doc website. (!1222)(a5b27d0e)

  • doc: remove refences to centos application development guide. (!1241)(22753fe9)

  • doc: remove deprecated platforms from OpenCPI OCCP guide. (!1250)(b8716878)

  • doc: update platform development guide remove deprecated platforms. (!1251)(91b54e4e)

  • doc: the tutorial project has been updated to current naming conventions by moving and renaming files and dropping the specs/ directory. (!1274)(da31d4c7)

  • doc: add AXI transport performance tuning guide. (!1276)(8e6b28fb)

  • doc: add kernel driver functionality guide. (!1277)(5a08c263)

  • doc,runtime: remove deprecated code. (!1226)(cc73b36c)

  • hdl base: fifo allow oneshot mode to be restarted repeatedly. (!1187)(a3956b6e)

  • hdl base: remove inactive project. (!1202)(95f7cb6a)

  • osp: framework support for AMD Xilinx RFoC. (!1212)(a70da31a)

  • osp: update git submodule hashes. (!1282)(99ca0616)

  • runtime: remove unimplemented argument from ocpirun usage printout. (!1090)(f1956b55)

  • runtime: remove sendpage for linux kernel 6.5.0 and newer. (!1121)(bd8ff4ba)

  • runtime: change class_create for linux kernel 6.4.0 and newer. (!1121)(bd8ff4ba)

  • runtime: use vm_flags_set for linux kernel 6.3.0 and newer. (!1121)(bd8ff4ba)

  • runtime: missing import in gcc 13.2.1. (!1121)(bd8ff4ba)

  • runtime: clean up occp admin registers and memory space. (!1162)(330f2582)

  • runtime: add ocpirun to ocpiremote sandbox. (!1172)(98b7a06b)

  • tests: add unit tests for examples/components. (!1198)(9dc591b7)

  • tests: add block-based generators for component unit testing. (!1209)(b24c3bc8)

  • tests,tools: add longlong generators to ocpi_testing. (!1111)(89e8e801)

  • tools: improve error when ocpidev called with OCPI_CDK_DIR unset. (!1121)(bd8ff4ba)

  • tools: add unit tests for ocpilint. (!1163)(a2b12e96)

  • tools: add xilinx21_1_aarch64 rcc platform. (!1165)(fa0f55da)

  • tools: add “–streamlined-build” option to “ocpidev build” command to reduce the number of invocations to Vivado when building assemblies and unit tests. (!1168)(b0801dc9)

  • tools: check existence of gdbserver when importing Xilinx SDK artifacts. (!1172)(98b7a06b)

  • tools: add ocpidev2 tool prototype. (!1173)(3bd83d2f)

  • tools: add packages for adi_plutosdr0_38. (!1175)(0ff04535)

  • tools: remove makefiles. (!1186)(fa730b02)

  • tools: exclude plutosdr_csts where plutosdr is excluded. (!1193)(eeec4633)

  • tools: complex time sampled marshaller and demarshaller. (!1212)(a70da31a)

  • tools: update ocpiadmin to use osp git submodules. (!1230)(b8f58ee9)

  • tools: remove ocpidev2 prototype. (!1232)(952e005c)

  • tools: remove. (!1236)(0441e5a9)

Bug Fixes

  • app,runtime: fix broken usedImpls vector. (!1162)(330f2582)

  • comp: prevent worker methods being called if worker is UNUSABLE. (!1121)(bd8ff4ba)

  • comp: fix vendor ip compatibility. (!1231)(a7c2cac2)

  • comp: add LD_PRELOAD to Vivado calls for complex_mixer_tutorial.hdl. (!1240)(85569788)

  • devops: pass CI_COMMIT_TAG env var to downstream doc jobs so that built docs are published upon upstream project release. (!1094)(6679f0e9)

  • devops: fix caching in CI pipelines attempting to update timestamps of deleted files. (!1192)(3a31bae3)

  • devops: change container image names to resolve issue uploading to GitLab container registry. (!1192)(3a31bae3)

  • doc: fix zed ether example doc. (!1127)(c847e4fa)

  • doc: fix genDocumentation.sh building some documents multiple times. (!1169)(b835ca99)

  • doc: fix genDocumentation.sh building some documents multiple times. (!1170)(7a558218)

  • doc: limit sphinx-rtd-theme package version. (!1184)(5361c0cc)

  • doc: fix installation guide toc. (!1201)(c5124147)

  • doc: remove erroneous closing tag from page 15. (!1213)(f46a1e1a)

  • doc: updated Tutorial7 docs and filenames. (!1229)(2d94c9ad)

  • doc: add rfdc prereq install to doc gen. (!1239)(986a319f)

  • doc: changes incorrect command to “ocpidev run application IQapp –after’ -d -v -mcomplex_mixer=hdl’”. (!1242)(01f3ce14)

  • doc,doc: revert tutorial project update due to CI/CD pipeline issues. (!1280)(52329b63)

  • doc,tools: fix ocpidoc crash issue if extra text is an empty string. (!1210)(f5457c66)

  • hdl base: add missing patch to Ultrascale clocking IP. (!1121)(bd8ff4ba)

  • hdl base: fifo.dhl infers bram. (!1187)(a3956b6e)

  • osp: add additional packages to support build of adi_plutosdr0_38 on rocky platforms. (!1223)(9b815d37)

  • runtime: fix to bug where calling fork with certain glibc versions results in a hang. (!1105)(31a3698c)

  • runtime: fix OpenCPI driver to be able to build on Rocky 8. (!1174)(b70e606f)

  • runtime: add missing methods to check worker control state. (!1183)(abe40076)

  • runtime: fix rcc worker RunCondition timeout inconsistency. (!1195)(4f4b824a)

  • runtime: fix kernel driver for newer Linux kernel versions. (!1205)(84d071be)

  • runtime: fix runtime drc build issue. (!1237)(1e09bb14)

  • tests: fix to allow finishport to be set for specific test cases. (!950)(0eda69a6)

  • tests: replace np.float with np.float64. (!1121)(bd8ff4ba)

  • tests: exclude plutosdr_csts from assets_ts test. (!1194)(7b55f7ef)

  • tests: fix generate attrs bug. (!1208)(510e7f23)

  • tests: changed an import in opencpi/projects/examples/components/ppm_demodulation_s_b.test/generate.py from “ocpi.sdr.assets” to “ocpi.examples”. (!1248)(1f4868b1)

  • tests,tools: fix ocpi_testing float generator random range. (!1085)(2bb61974)

  • tools: change codegen when MBurstLength is 1. (!1121)(bd8ff4ba)

  • tools: add gitignore to ignore driver artefacts. (!1121)(bd8ff4ba)

  • tools: correct #574 fix added by MR !1009 by removing erroneous insert. (!1121)(bd8ff4ba)

  • tools: prevent “warning: stray \ before -”. (!1121)(bd8ff4ba)

  • tools: replace egrep with grep -E to avoid deprecation warnings. (!1121)(bd8ff4ba)

  • tools: change ubuntu22.04 compiler to use gcc-12. (!1154)(0d0a52f9)

  • tools: fix branch for analog devices no-os prereq. (!1155)(23e99258)

  • tools: fix modelsim platform makefile space vs tab issue. (!1156)(fb311a76)

  • tools: fix opencpi driver load issue on xilinx19_2_aarch64. (!1171)(07894a4c)

  • tools: fix not being able to build dynamic worker configs when building assemblies with the “workers-as-needed” flag. (!1179)(8d26c360)

  • tools: fix “ocpidev clean” command not working for hdl assemblies. (!1180)(36b0bb23)

  • tools: fix search path for hdl workers defined in slave attribute. (!1185)(f5224dcf)

  • tools: fix issue preventing the running of ACI applications. (!1197)(b7ba15e4)

  • tools: tidy up code formatting and whitespace. (!1204)(fd5f9697)

  • tools: remove rfdc prereq from platform project. (!1220)(c137306f)

  • tools: fix opencpi kernel module to support rocky9.5. (!1221)(a0234723)

  • tools: fix asciidoc prerequisite url. (!1258)(edd1e1f0)

  • tools: prioritize -comp.xml files over -spec.xml files when searching for worker spec files during building of unit tests. (!1271)(30b61e34)

  • tools: added a chmod line to test file creation in ocpidev/assets/test.py. (!1272)(5d2be114)

  • tools: fix persistent ssh session with ocpiremote log command. (!1283)(f32669f2)

Documentation

  • doc: add FSK app guide. (!1196)(3a426d4a)

  • doc: remove gui tutorial pdfs. (!1233)(fcc2f6b3)

  • doc: remove deprecated platforms from OpenCPI Component Development Guide. (!1243)(77e251a4)

  • doc: remove deprecated platforms from documentation writer guide. (!1244)(bd25b217)

  • doc: edit to the styling of the “View Output Data” section of Tutorial 1. (!1245)(552ffd76)

  • doc: update hdl development guide. (!1246)(aa1cc0cc)

  • doc: remove redhawk export document. (!1252)(063fe4b6)

  • doc: update sdp buffer notes with latest rcc platforms. (!1253)(78738192)

  • doc: updated Tutorial 3 doc to reference Rocky 9, removed the dependency on the ocpi.tutorial project, and fixed a styling issue in a component creation command. (!1254)(0274bfd5)

  • doc: remove references to centos7 from install guide. (!1255)(488495d6)

  • doc: changed CentOS references to Rocky 9, added an underscore to the complex_mixer-rcc.xml code sample, and removed an invalid character from the complex_mixer-test.xml sample. (!1256)(89c7dae9)

  • doc: changed CentOS references to Rocky 9 and changed the spec field in time_demux-rcc.xml to ‘time_demux-comp.xml’. (!1257)(fa5410af)

  • doc: replace CentOS references in User Guide with Rocky. (!1259)(701f8c64)

  • doc: remove GUI sectopm in User Guide. (!1259)(701f8c64)

  • doc: update “Reserving Additional Memory for the Linux Kernel Device Driver” subsection in User Guide. (!1259)(701f8c64)

  • doc: changed all instances of -spec to -comp or removed the subtitle entirely. (!1260)(3d3231da)

  • doc: updated file names to remove -spec or add -hdl or -comp as needed. (!1261)(c909d87f)

  • doc: update briefing 8 - remove GUI and deprecated platforms. (!1262)(ab9f40d2)

  • doc: remove gui references in briefing 10. (!1263)(6880cf1b)

  • doc: update briefing 11 by removing GUI and deprecated platforms. (!1264)(99e32d17)

  • doc: remove GUI reference from briefing 9. (!1265)(e0d4a3f2)

  • doc: update briefing 13 by removing references to deprecated platforms. (!1266)(b7da2efc)

  • doc: remove tutorial 10, replaced by fsk application guide. (!1267)(bc6a4950)

  • doc: corrected a run test command to a build command. (!1268)(79bcb4fa)

  • doc: fix release version in platform development guide. (!1269)(a5e42503)

  • doc: remove deprecated platforms from man pages. (!1273)(5f8850fa)

  • doc: tutorials 7, 7hw, and 9 have been updated to reflect the new file names and locations. (!1274)(da31d4c7)

  • doc: fix broken hyperlinks in docs, fix odd formatting in Application Development Guide, and fix typos in Installation Guide. (!1285)(03fab8ef)

  • doc,runtime: add OpenCPI Memory Guide document. (!1166)(121f645c)

  • osp: update zed getting starting guide to use xilinx24_1_aarch32. (!1214)(10b7f596)

  • osp: fix install prerequisite of dependency. (!1249)(60085377)

  • tools: document “–export” flag for “ocpidev build”. (!1189)(88a5db28)

  • tools: update install guide for 2024.1 support. (!1207)(b9d96483)

v2.4.7 (2024-01-04)

Changes/additions since OpenCPI Release v2.4.6

Features

  • app: updated the fsk_dig_radio_ctrl image. (!1057)(b6fcacfb)

  • comp: support include and xi:include. (!995)(ebd35042)

  • comp: replace xi:include in property files with include. (!995)(ebd35042)

  • comp,tests: add ability to compare top N bits of fractional time in ocpi_testing. (!1144)(45d4d09e)

  • devops: enable autoscaling for CI/CD pipelines. (!1115)(2b0e5ab6)

  • devops: enable parallel building of workers in CI/CD pipelines. (!1115)(2b0e5ab6)

  • devops: allow for skipping of certain CI/CD pipeline jobs if relevant changes are not made to the repo. (!1120)(5c7c286a)

  • devops: make non-MR CI/CD pipelines start automatically after being launched. (!1124)(2da5d1c8)

  • devops: remove sudo from centos7 docker images. (!1125)(048f09e4)

  • devops: update ubuntu dockerfiles. (!1126)(8f2019c3)

  • devops: update rocky8 dockerfile. (!1128)(6b9a432d)

  • devops: allow projects using downstream-ci.yml to pass the CI_OCPI_PLATFORMS and CI_OCPI_PROJECTS variables when set in the project settings. (!1130)(baad9f06)

  • devops: re-implement CI/CD pipeline HWIL. (!1137)(92efb17b)

  • devops: enabling CI/CD pipelines to deploy full docker images to public registry. (!1141)(8c4d366d)

  • devops: add Ubuntu18.04 support to CI pipelines. (!842)(2fc0efd5)

  • devops: don’t run/build unit tests in CI pipelines for platforms when there is not a worker of the appropriate model available. (!859)(1d5b13b7)

  • devops: allow multiple devices of same platform in HWIL CI pipelines. (!862)(1332223f)

  • devops: enable zcu102, picozed, microzed platforms in HWIL CI pipelines. (!862)(1332223f)

  • devops: add source_sink application to CI/CD pipelines. (!867)(0eae0e52)

  • devops: add testbias app to CI pipelines. (!875)(13b4d819)

  • devops: prevent attempts to build inactive platforms in CI pipelines. (!875)(13b4d819)

  • devops: let runner dictate device to connect to in HWIL CI pipelines. (!875)(13b4d819)

  • devops: make pipeline ignore warnings from ocpidev. (!880)(ad9c8552)

  • devops: add FSK app to CI pipelines. (!893)(feccd726)

  • devops: add failed job report to CI pipelines. (!894)(c0026da7)

  • devops: auto push develop and release docker images to gitlab container registry. (!954)(da29f8d2)

  • devops: add zcu111 to pipeline. (!964)(7b6738bf)

  • devops: fix section that pushes to gitlab registry to use predefined ci variables. (!985)(46482d35)

  • devops: add x310 and x3u platforms to CI config to enable them to run properly in pipelines. (!1022)(243d0bbd)

  • devops: update docs to support building docs in forked projects. (!1091)(80eba8b2)

  • devops,tools: add rocky8 RCC development platform support. (!874)(cd558c26)

  • devops,tools: add ubuntu22_04 RCC development platform support. (!885)(4f8b666c)

  • doc: add install-opencpi man page. (!1021)(d179174a)

  • doc: add ocpidev asset doc system usage information to relevant man pages. (!1023)(cb54577f)

  • doc: fix ordering of options in man pages to be short form first. (!1023)(cb54577f)

  • doc: add ethernet transport performance tuning guide. (!1033)(2f8d0d14)

  • doc: rename HDL and RCC worker RST files to latest naming scheme. (!1035)(9d2a079f)

  • doc: update component RST docs to use latest terminology and template format. (!1035)(9d2a079f)

  • doc: update component RST block diagrams (*.odg, *.svg) to be exemplar. (!1035)(9d2a079f)

  • doc: update RST files and directories for platform project device workers to use current organization, structure, and naming scheme. (!1036)(594fc672)

  • doc: remove deprecated RST files and directories for platform project device workers. (!1036)(594fc672)

  • doc: add node graph to Tutorial 1. (!1039)(123ce17f)

  • doc: add node graph to tutorial 2. (!1040)(d85c577b)

  • doc: move picoevb and zed RST files and images to be co-located with their assets. (!1041)(95806072)

  • doc: update picoevb and zed GSG to refer to information in User Guide and Installation Guide. (!1041)(95806072)

  • doc: add missing hyphen to ocpidev command for #3647. (!1142)(11896d00)

  • doc: update tutorial docs for new code, and grammar issue #3646. (!1142)(11896d00)

  • doc,tools: remove --rcc-platform from ocpidev run man page, for #3662. (!1142)(11896d00)

  • doc,tools: add ocpi_documentation_include directive to ocpidoc. (!882)(877eb994)

  • doc,tools: add RST templates for OSP-related documentation. (!1008)(82b22c6a)

  • hdl base: add DG-RDMA Primitive Library. (!947)(7de0ace9)

  • hdl base: add (optional) fairer arbitration scheme to SDP. (!947)(7de0ace9)

  • hdl base: add DG-RDMA configuration device worker and proxy. (!947)(7de0ace9)

  • hdl base: add Ethernet MAC dependency. (!947)(7de0ace9)

  • osp: add Riviera-Pro support. (!906)(5e074965)

  • osp: add zed_ether platform as an HDL DG-RDMA reference OSP. (!947)(7de0ace9)

  • runtime: add ability to dump data when ocpirun receives CTL+C. (!1114)(6a5039d1)

  • runtime: adjust error message and fix memory issue. (!872)(9fc49553)

  • runtime: add worker property settings to system.xml, either app or artifact. (!877)(10c53c07)

  • runtime: add statically defined devices in system.xml, with options to include static devices or not. (!877)(10c53c07)

  • runtime: add various fixes to make DGRDMA work properly. (!877)(10c53c07)

  • runtime: introduce loadtime workers which have artifact load/unload lifecycle, not app lifecycle. (!877)(10c53c07)

  • runtime: add static discovery method and support for JTAG programming for Ethernet devices. (!947)(7de0ace9)

  • runtime: improvements to datagram transfer driver. (!947)(7de0ace9)

  • runtime: add new datagram2 transfer driver. (!947)(7de0ace9)

  • runtime: add pipelining to WCI to allow higher clock speed operation. (!1006)(b0005423)

  • runtime: enable MacOS Ventura (macos13_0) as an RCC platform and for remote containers. (!1017)(6dbc4bc5)

  • runtime,tests,tools: add optimized framework build capability. (!1077)(ba66363d)

  • tests: fix and expand successful testing in the iqstream_max_calc test app including testing on hardware. (!922)(7a5f218a)

  • tests: print to console after a certain time while running tests. (!943)(1cdf7755)

  • tests,tools: ocpigen: rework build config validation into a method of the Case struct. (!886)(5ad1095a)

  • tests,tools: ocpigen: simplify and correct logic in validateBuildConfigs. (!890)(3439f89a)

  • tests,tools: add end_of_files function to ocpi_testing. (!1112)(d56f975b)

  • tools: ocpidev create/build/clean/delete applies to doc for all asset types. (!792)(48375dfd)

  • tools: ocpidev: revamp/augment the class structures for asset types to remove the legacy bash and ocpidev run/show scripts. (!838)(1c664e3c)

  • tools: ocpidoc: have all the appropriate ocpidev verbs and nouns call ocpidoc as needed. (!838)(1c664e3c)

  • tools: support MacOS 12.2. (!838)(1c664e3c)

  • tools: add ping utility to package installation script for ubuntu18_04. (!842)(2fc0efd5)

  • tools: add an optional flag –export for ocpidev build. (!864)(5d986aeb)

  • tools: output message when platforms excluded by OnlyPlatforms or ExcludePlatforms variables. (!869)(6cb4815c)

  • tools: add util.mk:OcpiIsContainer(). (!885)(4f8b666c)

  • tools: upgrade gpsd prerequisite from version 3.18 to version 3.23.1. (!885)(4f8b666c)

  • tools: create batch mode installation script for Xilinx tools. (!889)(6f4f8f92)

  • tools: make install-xilinx-tools.sh non-interactive. (!892)(9e58479e)

  • tools: ocpiadmin: integrate Xilinx Vivado tool installer functionality. (!909)(2465b983)

  • tools: add wireshark dissectors for DG-RDMA protocol. (!947)(7de0ace9)

  • tools: skeleton file generated upon creation of hdl platform worker. (!982)(63c6bd09)

  • tools: make device parameters in hdl platforms and cards act as defaults for that platform/card. (!986)(3da54321)

  • tools: allow device parameters in card/platform XML to service as defaults, and be specified as fixed or overridable. (!1002)(78b274ce)

  • tools: device parameters in card XML can be tagged as applying to specific platforms. (!1002)(78b274ce)

  • tools: device-to-platform signal mappings can index the platform signal. (!1018)(40a2b265)

  • tools: the part number and even part family for an HDL platform can be defined in the platform’s XML, and not need a core repo change. (!1018)(40a2b265)

  • tools: constraint file references in XML can include parameters which are tcl variable settings. (!1018)(40a2b265)

  • tools: updated the drc’s to add the pincontrol value. (!1057)(b6fcacfb)

  • tools: add mint21_1 RCC development platform support. (!1069)(19315540)

  • tools,tools: add python38 and required associated modules to rocky8-packages.sh. (!1025)(87639584)

  • protocols,tests: add SCPI parser prerequisite to test project. (!1029)(0ce3bd8e)

  • runtime: add Log namespace to make ACI logging functions consistent with RCC logging. (!1003)(5223c6d6)

  • tools: throws error message when duplicate attributes are used in same xml element tag. (!1009)(3d41b60a)

  • tools: add OpenCPI linter tool. (!1076)(51e21a8a)

Bug Fixes

  • comp: fix data_src.vhd and data_src_cswm.vhd slice directions. (!1056)(725bc603)

  • comp: fix adapt_width output opcode reordering. (!1074)(771cd638)

  • comp,doc: modify peak_detector tutorial to fix #3648 and #3649. (!1142)(11896d00)

  • devops: change commit ref env var used in doc jobs to avoid character conversion. (!1106)(c73380fb)

  • devops: fix deploy job invalid image reference format. (!1116)(b936ec65)

  • devops: fix deploy pages job not cloning repo. (!1116)(b936ec65)

  • devops: make post-merge pipelines not require a manual trigger. (!1116)(b936ec65)

  • devops: prevent CI/CD pipelines from installing OSP projects on host platforms. (!1118)(1da2a534)

  • devops: fix invalid syntax in yaml preventing osp and comp project pipelines from running. (!1129)(90c424d2)

  • devops: update dind version in CI/CD pipeline deploy jobs. (!1131)(4a6246da)

  • devops: fix CI/CD pipeline test jobs using wrong image tag. (!1133)(3c12be67)

  • devops: fix MR failures for external projects. (!1138)(51eac05d)

  • devops: pull correct docker images in OSP CI pipelines. (!859)(1d5b13b7)

  • devops: use “-b” flag in “ocpiremote start” command in CI pipelines. (!859)(1d5b13b7)

  • devops: patch config.yml for zcu102 build. (!865)(1c34c150)

  • devops: fix job report failing when a job timed out. (!900)(a0b2ba57)

  • devops: use predefined ci variable to point to gitlab container registry. (!989)(d381290d)

  • devops: fix ci_report.py not including all failed jobs in reports for a given CI/CD pipeline. (!1027)(aeafe032)

  • devops: reimplement hdl-assemblies.mk assembly validation logic in ci_generate_pipeline.py. (!1058)(ef76f252)

  • devops,tools: fix util.mk:OcpiGetKernelDir() for container environments. (!885)(4f8b666c)

  • doc: fix air-gapped installation typo. (!1088)(ac254ca4)

  • doc: remove conflicting --worker option from ocpidev man pages that was conflicting with --workers-as-needed. (!838)(1c664e3c)

  • doc: fix typos in timegate_csts-index.rst component document and rename to timegate_csts-comp.rst. (!1038)(bf711640)

  • doc: add timegate_csts-hdl.rst HDL worker document. (!1038)(bf711640)

  • hdl base: remove type ambiguity in core hdl primitive. (!1143)(06fbc336)

  • hdl base: fix inferred latch for variable ‘ppsOut’ in time_server worker. (!981)(23dc837a)

  • runtime: add /pcap back to list of paths to search fpga manager. (!1145)(40efebde)

  • runtime: refactor runtime/base storage allocation logic. (!887)(0aa598f3)

  • runtime: avoid gcc warning relating to binary_function. (!1142)(11896d00)

  • runtime: avoid gcc warning relating to colliding variable names. (!1142)(11896d00)

  • runtime: make requests for default parameter values in apps and slave assemblies get default parameter values. (!986)(3da54321)

  • runtime: fix non-uniform exception being thrown using incorrect method and as non-string type within runtime code. (!994)(c11cdcaf)

  • runtime: fix order in XferDataGramEtherDriver2 destructor. (!1006)(b0005423)

  • runtime: external port methods getInputBuffer and getOutputBuffer now work in the Python ACI. (!1018)(40a2b265)

  • runtime,tests,tools: fixes for optimized builds of RCC platforms. (!1077)(ba66363d)

  • tests: disable some build configurations from building. (!959)(a096ee73)

  • tests,tools: fix termination of background process in testrun.sh. (!996)(6b9c809d)

  • tests,tools: fix kill of printToConsole() in testrun.sh. (!1043)(e60b78b5)

  • tools: change lzma prerequisite source. (!1113)(2d4902a7)

  • tools: add various missing .gitignores. (!1142)(11896d00)

  • tools: add .coverage to pytests clean command. (!1142)(11896d00)

  • tools: ocpigen: change opcode_pos to natural in hdl code generation. (!816)(85740873)

  • tools: make ocpidev both do better error checking on names, and allow more “legacy” names. (!876)(ed40a180)

  • tools: fix issue with deleting components. (!876)(ed40a180)

  • tools: fix issue with ocpidev showing nested libraries. (!876)(ed40a180)

  • tools: ocpidev: fix project name handling to allow periods. (!895)(e4fadc45)

  • tools: ocpidev: fix handling of hdl-primitives plural noun to allow for non-existent directories. (!895)(e4fadc45)

  • tools: fix ocpidev delete project to only unregister if it deletes. (!898)(abce881e)

  • tools: fix ocpidev inferring noun from hdl directories. (!899)(d1cea641)

  • tools: make it so you can build primitive library and cores from the primitives directory. (!901)(205a9939)

  • tools: fix ocpidev build hdl assemblies command to be able to be run from a project directory. (!903)(a9f35e4e)

  • tools: fix newly created hdl platforms using the wrong Makefile when using the ocpidev build command. (!904)(ed1fe16a)

  • tools: fix ocpidev creating incorrect paths to a project’s hdl platforms directory. (!904)(ed1fe16a)

  • tools: fix the ocpidev create hdl primitive command, that was creating a copy of the primitive in the wrong directory. (!905)(0b6dcb9e)

  • tools: fix not being able to run .xml applications. (!907)(67fcef4c)

  • tools: ocpiadmin: fix broken --url=URL option parsing. (!909)(2465b983)

  • tools: display protocol name correctly when executing ‘ocpidev show component’. (!910)(a66a2985)

  • tools: fix “–only-platform” and “–exclude-platform” options for “ocpidev run”. (!911)(63c23a2a)

  • tools: fix “ocpidev run” “–phase” option not working. (!913)(0e90d73c)

  • tools: give proper ocpidev error message when invalid option and no noun provided. (!915)(80cfbaf4)

  • tools: prevent “ocpidev show” from printing inaccurate warnings when “OCPI_PROJECT_PATH” env var is set. (!918)(3c7d167c)

  • tools: restore ability to use “–view” option with “ocpidev run”. (!927)(f47de6e8)

  • tools: worker skeleton files not generated for different authoring models. this fix generates both .vhd and .cc files. (!951)(4bca6909)

  • tools: make requests for default parameter values in hdl assemblies and containers get default parameter values. (!986)(3da54321)

  • tools: fix OsEther.cc compile error on ubuntu22_04 platform. (!997)(7d177ecc)

  • tools: remove gmp comments inside gpsd prereq install script. (!1013)(4ed6ae02)

  • tools: enable ComponentLibraries attributes in proxy worker, assembly, and assemblies XML files. (!1017)(6dbc4bc5)

  • tools: fix --hdl-rcc-platform option to work again in ocpidev. (!1017)(6dbc4bc5)

  • tools: fixed ocpidev show components to show both components in specs/ and .comp. (!1030)(89ee65ac)

  • tools: update ocpi_documentation_implementations.py to recognize worker docs named *-hdl.rst and *-rcc.rst. (!1035)(9d2a079f)

  • tools: fix version comparison in install-vivado.sh script. (!1037)(611ceedb)

  • tools: ocpigen: fix hdl-card.cc loop exit for “no match found” case. (!1042)(7175dfb6)

  • tools: fix TOPTS assignment in ocpiadmin.sh. (!1049)(6c259375)

  • tools: ocpidev: modify ComponentsCollection::show() for JSON output. (!1050)(5b21cb2a)

  • tools: disable show+verbose code blocks in ocpidev/assets/project.py. (!1059)(997a95c1)

  • tools: ocpiadmin: fix variable name error in getvars() function. (!1077)(ba66363d)

  • tools: fix container to allow signals to have an empty platform (not used). (!1082)(d3081fff)

  • tools,tools: fix ocpigen parser so modelsim platform will install. (!1062)(97f4d27d)

  • comp: prepare can handle and enter the error state. (!1007)(368d21d1)

  • comp: a stop on a inactive results in an error. (!1007)(368d21d1)

  • tools: fix broken delete libraries. (!991)(4c91e000)

Miscellaneous

  • comp: remove unused ‘enable’ property. (!942)(9eea6bd1)

  • comp: fix spec= attributes in XML files. (!1059)(997a95c1)

  • comp: modernize legacy drc-spec.xml and emulator-spec.xml OCS files. (!1059)(997a95c1)

  • devops: temporarily disable zcu102 and picoevb HWIL jobs in pipelines. (!1022)(243d0bbd)

  • devops,doc: update opencpi.gitlab.io home page. (!1028)(98041e32)

  • doc: add updated man page, asset doc system instructions to writer guide. (!1016)(e304c740)

  • doc: update docs for 2.5.x platform support. (!1016)(e304c740)

  • doc: update util_comps-library.rst file to recognize component RST docs named *-comp.rst. (!1038)(bf711640)

  • doc,tools: remove obsolete getting started guide template. (!1008)(82b22c6a)

  • doc,tools: update RST doc index templates to search for latest asset naming schemes, include warning about subsidiary filenames. (!1008)(82b22c6a)

  • doc,tools: change section heading titles and “Function” text in component RST template. (!1008)(82b22c6a)

  • doc,tools: document new ocpiadmin tool installer functionality. (!1046)(890998d3)

  • tools: update tool python files to use python3 shebang. (!1026)(267c9d84)

  • tools: fix ocpigen code comments made obsolete by MR !1018 changes. (!1042)(7175dfb6)

  • tools: delete obsolete and undocumented makeProject.sh script. (!1059)(997a95c1)

  • tools: minor ocpidev refactoring to resolve **kwargs vs. kwargs vs. args usage. (!1059)(997a95c1)

  • tools,tools: remove ubuntu16_04 RCC development platform support. (!1020)(88a87109)

  • doc: fix incorrect statements in the rcc and application dev guides and update tutorials 1-5 and 10. (!1068)(768a50aa)

v2.4.6 (2023-03-29)

Changes/additions since OpenCPI Release v2.4.5

Bug Fixes

  • tools: do not treat hdl/platforms/include directory as a platform name. (!1079)(7f02f6ce)

  • devops: fix CI bug introduced by clumsy cherry-pick of MR !1079 into release-2.4.6. (!1080)(ede1ff28)

  • tools: fix bug preventing running “ocpidev clean assembly”. (!1080)(ede1ff28)

Miscellaneous

  • devops,tools: add Epiq Solutions (z3u) OSP to doc processing/publishing machinery. (!1081)(26da634e)

v2.4.5 (2023-03-16)

Changes/additions since OpenCPI Release v2.4.4

New Features

  • tools: add target for the z3u to hdl-targets.xml. (!1070)(52832bb4)

  • tools: add xilinx18_3_aarch64 rcc platform. (!1070)(52832bb4)

Enhancements

  • devops: use env var in CI config for setting license file server. (!1071)(bc4ce570)

  • doc,tools: allow :spelling:ignore role in ocpidoc. (!1060)(55bafe4f)

  • runtime,tests,tools: add optimized framework build capability. (!1075)(4d44069d)

Bug Fixes

  • devops: fix COMP projects pulling incorrect image tags for release and develop CI/CD pipelines. (!1064)(eb5af875)

  • doc,tools: add format-change to list of handled tracked change types. (!1066)(21d106fc)

  • tests: fix statistical comparison method in ocpi_testing. (!1073)(316e2802)

  • tools: fix pip3 module version specs in ocpidoc.sh. (!1048)(d6ca94cf)

  • runtime,tests,tools: fixes for optimized builds of RCC platforms. (!1075)(4d44069d)

  • tools: ocpiadmin: fix variable name error in getvars() function. (!1075)(4d44069d)

Miscellaneous

  • devops,tools: disable processing of releases older than v2.3 by build-pages.py --all. (!1063)(7551c3a1)

  • devops,tools: add N3xx OSP to doc processing/publishing machinery. (!1078)(2913475a)

v2.4.4 (2023-01-22)

Changes/additions since OpenCPI Release v2.4.3

Enhancements

  • doc: add install-opencpi man page. (!1021)(d179174a)

  • doc: add ocpidev asset doc system usage information to relevant man pages. (!1023)(cb54577f)

  • doc: fix ordering of options in man pages to be short form first. (!1023)(cb54577f)

  • doc: add ethernet transport performance tuning guide. (!1033)(2f8d0d14)

  • doc: rename HDL and RCC worker RST files to latest naming scheme. (!1035)(9d2a079f)

  • doc: update component RST docs to use latest terminology and template format. (!1035)(9d2a079f)

  • doc: update component RST block diagrams (*.odg, *.svg) to be exemplar. (!1035)(9d2a079f)

  • doc: update RST files and directories for platform project device workers to use current organization, structure, and naming scheme. (!1036)(594fc672)

  • doc: remove deprecated RST files and directories for platform project device workers. (!1036)(594fc672)

  • doc,tools: add ocpi_documentation_include directive to ocpidoc. (!882)(877eb994)

  • runtime: add pipelining to WCI to allow higher clock speed operation. (!1006)(b0005423)

  • tools: throws error message when duplicate attributes are used in same xml element tag. (!1009)(3d41b60a)

  • doc: add ubuntu20_04 as a supported platform. (!1024)(ddb38000)

  • doc: add explanation to tutorials that platforms other than CentOS7 can be used. (!1053)(ac3e543d)

  • doc: clarify and update instructions for air-gapped install and installing from source in the Installation Guide. (!1055)(ac19818d)

  • hdl base: enable dual port full duplex CMOS mode ad9361 device workers. (!1054)(5d18c28c)

  • tests: add ad9361_data_interface_tests. (!1054)(5d18c28c)

Bug Fixes

  • doc: fix typos in timegate_csts-index.rst component document and rename to timegate_csts-comp.rst. (!1038)(bf711640)

  • doc: add timegate_csts-hdl.rst HDL worker document. (!1038)(bf711640)

  • runtime: eliminate need for OCPI_TRANSFER_IP_ADDRESS with PTP interfaces. (!999)(e1b2bae9)

  • runtime: fix order in XferDataGramEtherDriver2 destructor. (!1006)(b0005423)

  • tools: adds sdp library to allow for new hdl platform to build without errors. (!988)(c8a1635f)

  • tools: update ocpi_documentation_implementations.py to recognize worker docs named *-hdl.rst and *-rcc.rst. (!1035)(9d2a079f

  • comp: prepare can handle and enter the error state. (!1005)(6f3c7970)

  • comp: a stop on a inactive results in an error. (!1005)(6f3c7970)

  • doc: remove references to nonexistent --hdl-rcc-platform flag. (!1051)(54646100)

  • runtime: fix lock up issue with HDL support for DG-RDMA. (!1047)(e3b3e036)

Miscellaneous

  • devops,doc: update opencpi.gitlab.io home page. (!1028)(98041e32)

  • devops,tools: disable processing of releases older than v2.2 by build-pages.py --all. (!1010)(511fe41b)

  • doc: update util_comps-library.rst file to recognize component RST docs named *-comp.rst. (!1038)(bf711640)

  • doc,tools: allow build-pages.py to process avnet and xilinx OSP tagged releases. (!998)(94378527)

  • tools: update tool python files to use python3 shebang. (!1026)(267c9d84)

  • doc: update various guides for next v2.4.X patch release. (!1001)(b73d53a6)

v2.4.3 (2022-10-11)

Changes/additions since OpenCPI Release v2.4.2

Enhancements

  • doc: add Avnet and Xilinx platform information to shared systems tables file. (!917)(acdec5ea)

  • doc: add warning about view option and multiple test cases to ocpidev-test man page and Component Development Guide. (!948)(ca3f3dac)

  • doc: add OpenCPI Documentation Writer Guide source file (FODT format). (!958)(daf611a0)

  • doc: update doc/reference/README to refer to new writer guide. (!958)(daf611a0)

  • doc: update doc/reference/diagrams.txt to refer to new writer guide for latest procedures. (!958)(daf611a0)

  • doc: add new chapter on Linux kernel driver module to OpenCPI User Guide. (!962)(d3c82f53)

  • doc: revise chapter on PCI Express installation to be generic and describe loading driver. (!962)(d3c82f53)

  • doc: add reference to Linux kernel driver chapter in OpenCPI User Guide. (!962)(d3c82f53)

  • doc: add description of –no-kernel option to ocpiadmin man page. (!962)(d3c82f53)

  • doc,tools: modify ocpidoc to use both project and common dictionaries. (!923)(1b1a26a9)

  • doc,tools: enhancement to enable comments in ocpidoc dictionary. (!940)(35b0ad57)

  • doc,tools: add make declare preprocessing of COMPs and OSPs to build-pages.py. (!978)(ca6a8b6a)

  • osp: add parameters to DRC spec to allow optional inclusion of slave DSP workers. (!984)(e05ebd0a)

  • runtime: add static discovery method and support for JTAG programming for Ethernet devices. (!973)(ea02d2a5)

  • tools: copy macos12_4 to macos12_5 to enable macos12_5 with no changes from macos12_4. (!944)(f3a7624d)

  • tools: add controls for more and less (than previous default) SDP pipelining in container code generation. (!955)(3e19f598)

  • doc: update tutorial 4. (!961)(06548fb7)

  • doc: updates to tutorials 6-10. (!963)(bf3c56aa)

  • doc: update tutorial 5. (!965)(6bbda885)

  • doc: tutorial 1: update GUI figures and add additional prerequisite for default editor configuration. (!967)(e6f117dc)

  • doc: tutorial 1: replace deprecated “done” keyword with “finished”. (!967)(e6f117dc)

  • doc: tutorial 2: remove default editor instructions as they have been moved to OpenCPI GUI guide. (!968)(1e7d4a8e)

  • doc: tutorial 2: replace deprecated “done” keyword with “finished”. (!968)(1e7d4a8e)

  • doc: update tutorial 3. (!969)(84f4b83a)

  • hdl base,runtime,tools: add DG-RDMA interconnect support. (!957)(63ce844f)

  • runtime: add static discovery method and support for JTAG programming for Ethernet devices. (!980)(24d8010e)

Bug Fixes

  • doc: add instructions on using server mode to Installation Guide. (!917)(acdec5ea)

  • doc: fix formatting errors and examples in ocpiremote man page. (!917)(acdec5ea)

  • doc: add information to ocpidriver man page about working with secure boot. (!962)(d3c82f53)

  • doc,tools: fix issue with ocpidoc not finding proxy worker spec files. (!923)(1b1a26a9)

  • hdl base: add additional pipelining to DG-RDMA infrastructure. (!973)(ea02d2a5)

  • hdl base: sdp_pipeline replace use of fifo_1xn with fifo_2xn. (!973)(ea02d2a5)

  • hdl base: fix fifo_2xn. (!973)(ea02d2a5)

  • hdl base: fix incorrect combinatorial path when not arbitrating in sdp_node. (!973)(ea02d2a5)

  • runtime: fix crash when proxies that are also slaves are started by their proxy. (!937)(960c8f78)

  • runtime: reject all workers with parameter values that do not match defaults when the default is requested. (!944)(f3a7624d)

  • runtime: fix clock domain crossings in the time server. (!973)(ea02d2a5)

  • runtime: fix datagram2-ether transfer driver. (!990)(f192a8d2)

  • runtime: fix project exports to allow export platform that uses cpp_vhd. (!990)(f192a8d2)

  • tests: make iqstream tests work on modelsim. (!932)(7175b285)

  • tests,tools: add zlib1g-dev package to ubuntu package lists. (!928)(bfc7e743)

  • tests,tools: modify centos7 packages script for pip3-installed packages (Python modules). (!935)(e4e57fde)

  • tools: fix byte width definition when data width is greater than granule width. (!896)(28e0d348)

  • tools: ocpidev run now throws error when unable to find platform specified by --only-platform. (!914)(1a3b2ee0)

  • tools: build-pages.py: handle projects that do not have tags. (!916)(1825cc3c)

  • tools: fix timegate_csts worker. (!925)(364f3c30)

  • tools: fix verify.py in tutorial project’s peak_detector.test to properly validate min/max peak. (!926)(623fa7b8)

  • tools: swap non-ascii encoded characters with ascii equivalents. (!938)(141e0b23)

  • tools: fix minor xml issues with opencpi component specifications. (!938)(141e0b23)

  • tools: fix typo in longlong ocpi protocol defines. (!938)(141e0b23)

  • tools: fix minor typo in OpenCPI’s README.md file. (!941)(41bd2a43)

  • tools: properly record in artifact XML whether a parameter value is indeed the default value. (!944)(f3a7624d)

  • tools: do not create a build configuration for default values when the build file has configurations, none of which are the default. (!944)(f3a7624d)

  • tools: fix header file names for C++ files to be the same as runtime C++ header files, namely hh. (!955)(3e19f598)

  • tools: fix failures in container connections with devices in platform conigurations. (!966)(c13fc78e)

  • tools: prevent ocpidoc error when port type not defined. (!973)(ea02d2a5)

  • tools: fix build-pages.py to use ocpidev build when needed. (!977)(14eb1a9b)

  • tools: fix missing parameter values and default-value indicators in artifact XML. (!983)(b81f411c)

  • tools: build-opencpi.sh: add assets_ts to Projects for minimal framework installs. (!987)(28c1a752)

  • hdl base: add additional pipelining to DG-RDMA infrastructure. (!980)(24d8010e)

  • hdl base: sdp_pipeline replace use of fifo_1xn with fifo_2xn. (!980)(24d8010e)

  • hdl base: fix fifo_2xn. (!980)(24d8010e)

  • hdl base: fix incorrect combinatorial path when not arbitrating in sdp_node. (!980)(24d8010e)

  • runtime: fix clock domain crossings in the time server. (!980)(24d8010e)

  • tools: prevent ocpidoc error when port type not defined. (!980)(24d8010e)

  • tools: fix ocpidoc build issue. (!980)(24d8010e)

  • tests: exclude fir_complex_sse_ts.test fir_complex_sse.test fir_real_sse.test from picoevb due to lack of dsp resources (!934)(95480541)

  • runtime: fix datagram2-ether transfer driver (!990)(829b1849)

  • runtime: fix project exports to allow export platform that uses cpp_vhd (!990)(829b1849)

Miscellaneous

  • devops: update copyright scripts. (!960)(fc8f2817)

  • devops,tools: disable processing of releases older than v1.7 by build-pages.py --all. (!919)(8d444fb7)

  • tools: add avnet and xilinx to list of OSPs for doc generation. (!916)(1825cc3c)

  • tools: ocpidev: mitigate stricter parameter value checking. (!987)(28c1a752)

  • devops: backport MR !955 changes into release-2.4.3 branch. (!974)(1b130c1a)

  • tools: backport v2.4-required fixes from MR !885. (!933)(799a9ac8)

v2.4.2 (2022-05-26)

Changes/additions since OpenCPI Release v2.4.1

Enhancements

  • doc: update message payload descriptions in reference docs. (!879)(e08292fe)

  • doc: add timing diagram examples to HDL Development Guide. (!879)(e08292fe)

  • doc: update raw property interface description in Briefing 8. (!879)(e08292fe)

  • doc: update project and component directory diagrams in Briefing 5, 8, 11, HDL Development Guide. (!879)(e08292fe)

  • doc: update doc/man/src/README to current man page status. (!879)(e08292fe)

Bug Fixes

  • comp: fix CMOS ad9361 ADC frame alignment for 1r1t. (!912)(84966277)

  • doc: remove duplicate -d option from ocpidev-registry man page. (!879)(e08292fe)

  • doc: add hyperlink to ocpidev-project in ocpidev-unregister man page. (!879)(e08292fe)

  • doc: remove unnecessary ocpidev-subdevice man page. (!879)(e08292fe)

  • hdl base: Add BRAM1 into util library. (!888)(d8b87b73)

  • tests,tools: use pip3 to install scipy on centos7. (!866)(3dae6f2d)

  • tools: build-pages.py: register OSPs and COMPs. (!868)(186765d3)

  • tools: rename BF to OcpiBF in framework makefiles to avoid namespace collisions. (!881)(fb68e20b)

  • tools: ocpiadmin: fix broken long-format option parsing. (!897)(9d25285b)

  • tools: fix timegate_csts to accept CSTS timestamps. (!908)(65984e93)

v2.4.1 (2022-03-17)

Changes/additions since OpenCPI Release v2.4.0

Enhancements

  • comp: add RCC worker back to tutorial project. (!826)(601782ec)

  • doc: add complex mixer rcc back to documentation in tutorial project. (!826)(601782ec)

  • doc: update tutorial 3 based on feedback. (!828)(179e3c58)

  • doc: update tutorial 3 gui images. (!828)(179e3c58)

  • doc: update tutorial 7 based on feedback. (!829)(849badb1)

  • doc: update tutorial 7 gui images. (!829)(849badb1)

  • doc: add section that provides information on using conditional slave assemblies. (!832)(c8aaff7f)

  • doc: update GUI conditional section variable. (!851)(4c688b60)

  • doc: improve description of StringLength attribute in Component Development Guide. (!854)(29d5094e)

  • hdl base: add hdl assemblies parser. (!853)(f69a4f29)

Bug Fixes

  • devops: fix various issues related to CI/CD overhaul/containerization effort. (!831)(26413dfe)

  • devops: fix docker image tags used in release pipeline jobs. (!863)(ad1bd6c1)

  • doc: update tutorial 5. (!827)(cbb0ade6)

  • doc: fix typo in PyQt download, update Xilinx WebPACK installation to current procedure in OpenCPI Installation Guide. (!844)(7a7c4142)

  • doc: fix diagram problems in Briefing 2 and Briefing 9. (!852)(a6947c95)

  • doc: fix typos in Application Development Guide, RCC Development Guide. (!854)(29d5094e)

  • doc: correct example application XML in Briefing 14. (!856)(b6533bbd)

  • doc: fix diagrams in Briefing 2 that become corrupted when moving between LibreOffice versions and file formats. (!856)(b6533bbd)

  • tools: have genprojMetaData.py append the correct name to project-metadata.xml. (!817)(4143d320)

  • tools: patch asciidoc3 version 3.2.2 for python3.XX. (!830)(d80532fd)

  • tools: ocpiadmin: fix platform_dir setting. (!833)(c140f016)

  • tools: ocpidoc: make python3 virtual environment portable across runners. (!836)(a4ca5e30)

  • tools: ocpiremote: change env_args initializer to empty list. (!840)(b6dcde7b)

  • tools: rename generated applications.xml. (!845)(b46df5c7)

  • tools: replace "$(info" with "$(call OcpiInfo," in "<platform>.mk". (!847)(b0c56f92)

  • tools: allow ocpidev build to use attributes in applications.xml. (!855)(a9bd63be)

  • tools: ocpidev run: respect runtime attributes when found in the OAS. (!860)(6436fada)

Miscellaneous

  • doc: update Tutorial 4 per received feedback. (!820)(ab088225)

  • doc: update Tutorial 4 GUI screenshots. (!822)(845f5bce)

  • doc: update tutorial 1 content and GUI screenshots. (!824)(964cb480)

  • doc: update based on feedback as well as screenshots. (!825)(6b49ce6c)

  • doc: update tutorial 2 images and sections. (!835)(82617c30)

  • doc: update images to use new gui, and update multiple sections based on feedback for tutorial 6. (!837)(a1389694)

  • doc: add sentence to reference vivado usage guide. (!839)(ac152ddd)

  • doc: tutorial 2 references complex_mixer_tutorial. (!846)(442d8f1e)

  • doc: update tutorial 8 hardware version screen shots. (!848)(448e3f34)

  • doc: update all of tutorial 10 based on the DRC. (!861)(a77883c0)

  • tools: modify gen-cg-pdfs.sh to allow use of new section selector variable. (!834)(ae47fe61)

  • tools: refactor OcpiKernelDir assignment logic for centos and ubuntu platforms. (!849)(567041c2)

v2.4.0 (2022-01-28)

Changes/additions since OpenCPI Release v2.3.4

Enhancements

  • comp,tests: remove makefiles from the .test and .hdl workers used in tutorial 6. (!772)(b4539c8f)

  • comp,tests: remove makefiles from agc_complex.hdl and agc_complex.test. (!775)(08e2df44)

  • devops: overhaul the CI pipeline scripts for host platforms. (!728)(f0fe4603)

  • devops: containerize CI pipeline for host platforms (centos7 and ubuntu18_04). (!728)(f0fe4603)

  • devops: prevent commits from launching pipelines unless on the develop branch. (!728)(f0fe4603)

  • devops: add hardware in the loop capabilities to pipeline overhaul. (!769)(ca09cc42)

  • devops: integrate osp projects in pipeline overhaul and containerization effort. (!776)(8cbed9ef)

  • devops: add comp projects to pipeline overhaul/containerization effort. (!803)(3620bac2)

  • devops: resolve resource contention between CI pipelne jobs that install for Xilinx platforms. (!810)(333e5c0e)

  • devops,tests: overhaul and containerize CI/CD pipelines for cross platforms. (!755)(a5cb117c)

  • doc: add links to YouTube videos, to the opencpi.gitlab.io website. (!722)(a5a11eba)

  • doc: update tutorial 1-4 to use new GUI. (!761)(a1196d27)

  • doc: add ocpitest(1) man page. (!773)(3ab1d9f6)

  • doc: add CLI commands and new GUI screenshots to tutorial 8. (!777)(de0f7571)

  • doc: update tutorial 7 introductory sections and move primitives section. (!778)(5d1ea175)

  • doc: update tutorial 7 new project, component library sections. (!778)(5d1ea175)

  • doc: update tutorial 7 new worker sections. (!778)(5d1ea175)

  • doc: update tutorial 7 unit test and brief ocpiview sections. (!778)(5d1ea175)

  • doc: add gui and cli section marks to tutorial 7. (!778)(5d1ea175)

  • doc: update the 6th tutorial by adding new screenshots using the new opencpi gui, adding more detailed instructions and a new section on how to navigate the simulator used in the tutorials. (!782)(cc63f4b2)

  • doc: update tutorial 8. (!786)(2061830b)

  • doc: add cli and gui sections and update based on more Lisa comments. (!791)(14db225e)

  • doc: clarify component specification terminology in tutorial 1 overview. (!797)(40c7a8ad)

  • doc: add briefing on Application Control Interface (ACI). (!800)(392f7cd2)

  • doc: add briefing on OpenCPI debugging tools and techniques. (!800)(392f7cd2)

  • doc: update OpenCPI Installation Guide to describe latest GUI installation instructions. (!801)(e23fa800)

  • doc: update ocpigui(1) man page to describe latest usage information for GUI startup command. (!801)(e23fa800)

  • doc: add instructions to perform an air-gapped installation. (!806)(5385f82c)

  • doc: add updated and new *.fodt files to doc/tutorials/. (!807)(61ff8908)

  • doc: remove obsolete “in progress” tutorials from doc/tutorials/hold. (!807)(61ff8908)

  • doc,tools: add directive to ocpidoc to list an asset’s tested platforms. (!748)(fcd634d1)

  • hdl base: add example usage for raw2axi interface. (!726)(58d6e63b)

  • hdl base: remove duplicate complex_mixer in tutorial project. (!799)(c27b5ac3)

  • runtime: change all files under os/ now have names that match our conventions, and nearly no warnings. (!727)(2a4312bc)

  • runtime: move metadata management files into their own library and make file names compliant. (!742)(081897ab)

  • runtime: reorganize/rename files under runtime/util to be compliant and consistent. (!756)(bfbe939f)

  • runtime: update file, namespace naming and reduce warnings in dataplane C++ code. (!762)(daa9280b)

  • runtime,tools: cleanup runtime filenaming and namespacing and warnings. (!767)(21ac5973)

  • tests: replace done with finished in all test.xml files. (!729)(19ecea91)

  • tools: replace bash with python for ocpidev build test command. (!705)(795d4e03)

  • tools: add xilinx virtual cable driver as a development host prerequisite. (!734)(a9917d0f)

  • tools: update picoevb programming scripts to use Xilinx virtual cable driver prerequisite. (!740)(83f5d754)

  • tools: set pci_bus_master when enabling pci device. (!743)(8ac9fb60)

  • tools: add litefury and nitefury to pci_device_id enum. (!743)(8ac9fb60)

  • tools: add macos12_0 (a.k.a.Monterey) support. (!767)(21ac5973)

Bug Fixes

  • app: replace && with &amp in all xml files. (!813)(b087536b)

  • comp: fix naming collision between tutorial 9 worker and counter primitive. (!774)(e3fa4c3a)

  • comp: fix tutorial prims library build failure. (!780)(03b17777)

  • devops: fix various problems with CI pipeline overhaul and containerization. (!810)(333e5c0e)

  • doc: replace references to Make files, *.mk files, makefile variables with references to XML files and attributes. (!735)(207f7126)

  • doc: replace references to AV GUI in text and figures with OpenCPI GUI. (!735)(207f7126)

  • doc: replace references to older systems & platforms with references to latest. (!735)(207f7126)

  • doc: replace references to “run” phase with “execute” phase in component test suite descriptions. (!735)(207f7126)

  • doc: add –optimize option to description and examples, fix typos in ocpiadmin(1) man page. (!773)(3ab1d9f6)

  • doc: fix typos and remove “AV” from first figure in Installation Guide. (!773)(3ab1d9f6)

  • doc: fix time_demux.test. (!783)(5c1ff89c)

  • doc: add briefing sources saved with LibreOffice 5 on centos7 for correct PDF generation. (!800)(392f7cd2)

  • doc: update Tutorials 3 and 4 to provide “copy file from tutorial project” instructions. (!804)(c3ebd7e7)

  • doc: update Tutorial 3 to improve section on creating example worker code. (!804)(c3ebd7e7)

  • doc: change ocpi.tutorial project agc_complex data sheet to display properties and ports. (!807)(61ff8908)

  • doc,tools: fix ocpidoc to wrap long property values and support commented out xi include elements. (!737)(9db83fe9)

  • tests: fix and enable gpi.test case00.00 case01.00 case02.00. (!758)(73211e6e)

  • tests: fix the –view flag. (!802)(228d7b72)

  • tools: add the --workers-as-needed flag to the ocpidev build test function. (!715)(27de3f44)

  • tools: test asset default moves from project to components library. (!716)(22d1a646)

  • tools: fix xsim detection for newer xilinx tool versions 2021.1+. (!723)(293eecc5)

  • tools: fix ocpigen to not segfault on writable properties for instances in slave assemblies. (!727)(2a4312bc)

  • tools: generate assemblies for valid subcases. (!757)(aad7a5a1)

  • tools: fix broken metadata generation. (!770)(d777cb67)

  • tools: fix genProjMetaData.py removing ‘.xml’ extension for xml apps. (!789)(d6b2c392)

  • tools: ocpiview: exec bash instead of sh. (!793)(bd6f49a8)

  • tools: fix broken framework and platform installs due to inappropriately unsetting all OCPI_* variables. (!812)(8cd4e85a)

Miscellaneous

  • comp: convert tutorial 9 components to use makeless build environment. (!779)(8eb6b1fb)

  • comp: add complex_mixer.hdl back to tutorial project. (!805)(e997a4f6)

  • doc: add videos to website. (!745)(566c52f2)

  • doc: tutorial 9: add OpenCPI GUI instructions and update screenshots. (!793)(bd6f49a8)

  • doc: updates the documentation to copy the simulator version of tutorial 6. (!796)(11dc8787)

  • doc: add pluto instructions to separate tutorial 7 doc. (!808)(f147199f)

  • doc: re-contextualize tutorial 8 around complex_mixer_tutorial. (!811)(72e940c9)

  • doc: update the hardware version of tutorial 8. (!811)(72e940c9)

  • doc: update 8th tutorial to use complex_mixer in the assets project. (!814)(b64c20ea)

  • doc: update gui variable in 8HW tutorial. (!815)(772a53de)

  • doc: fix tutorial 4’s release info. (!815)(772a53de)

  • doc: fix tutorial 7hw’s view flag and ToC. (!815)(772a53de)

  • doc: initial overhaul of Tutorial 9. (!774)(e3fa4c3a)

  • doc: add GUI section selection logic to tutorial 9 source document. (!779)(8eb6b1fb)

  • doc: update Tutorial 9 GUI sections. (!781)(4af0fb75)

  • doc: add updated tutorial 5. (!794)(dc404ddc)

  • doc,tools: add tutorial project documentation to opencpi.gitlab.io web site. (!784)(e8ada53e)

v2.3.4 (2021-12-17)

Changes/additions since OpenCPI Release v2.3.3

Enhancements

  • doc: add ocpigui.1.txt to doc/man/src. (!766)(afff0d43)

Bug Fixes

  • doc: remove AV GUI references and replace with OpenCPI references in Installation Guide and User Guide. (!751)(fdf0e160)

  • doc: add adrv9361 and picoevb system and platform information to systems.fodt (shared doc file). (!751)(fdf0e160)

  • doc: update “how to document assets” chapter in User Guide to describe current ocpidoc functionality. (!751)(fdf0e160)

  • doc: remove references to “mode” option and replace with “phase” option in ocpidev-run.1.txt and ocpidev-test.1.txt. (!751)(fdf0e160)

  • doc: remove references to “RCC_DONE” and replace with “RCC_FINISHED” in Briefing 6, “OpenCPI RCC Development”. (!751)(fdf0e160)

  • doc: remove ocpiav.1.txt from doc/man/src. (!766)(afff0d43)

  • doc: modify opencpi.1.txt to link to ocpigui, not ocpiav. (!766)(afff0d43)

  • doc: remove obsolete data_sink_qdac(csts), data_src_qadc(csts) LaTeX files from projects/platform/hdl/devices/*.test/doc/. (!766)(afff0d43)

  • tools: fix generate_clk_gen_ip.sh error reporting. (!771)(7c7fc0ad)

v2.3.3 (2021-11-30)

Changes/additions since OpenCPI Release v2.3.2

Enhancements

  • tools: add ie-gui/doc to document processing scripts. (!763)(7946be52)

Bug Fixes

  • tests: fix to ocpi_testing and ocpi_protocols for ocpi.comp.sdr unit tests. (!760)(28e30a6d)

  • tools: genDocumentation.sh: skip non-existent directories in default search path. (!765)(396a781d)

  • tools: build-pages.py: don’t try to patch non-existent man page source docs. (!768)(6eff2030)

Miscellaneous

  • doc: delete user guide for Eclipse-based GUI. (!764)(30795061)

v2.3.2 (2021-11-08)

Changes/additions since OpenCPI Release v2.3.1

Enhancements

  • tools: add ocpidev show prerequisites command. (!744)(321aa8cc)

Bug Fixes

  • comp: undo a file_write.c change to fix timestamper_scdcd unit test. (!732)(c1e0a68b)

  • devops,tools: build-pages.py: fix detached HEAD processing. (!741)(963d24b8)

  • runtime: disable data on a rcc port if there is EOF. (!754)(0416e081)

  • tests,tools: fix failing test in tests/pytests/show_prereqs_test.py. (!750)(b72e4dfb)

  • tools: do not clear OCPI_PREREQUISITE_* envars that lead to install/build errors. (!736)(a3e2c459)

  • tools: update path in scripts to prioritize local xilinx version of dumpimage. (!738)(30c8f46f)

  • tools: detect empty SAMPLES messages and report the error rather than dump a stack frame. (!739)(d00d2536)

  • tools: add missing JPEG development package to centos7-packages.sh. (!749)(ae88e3dc)

  • tools: add missing error check for pip3 package installation. (!749)(ae88e3dc)

  • tools: fix unsorted output issue for ocpidev show prerequisites --table. (!750)(b72e4dfb)

  • tools: fix makeless issues in unit tests and HDL assemblies. (!753)(3102e9ae)

  • tools: createXilinxLinuxKernelHeaders.sh: fix broken handling of uconfig for aarch64. (!759)(0559eaf1)

Miscellaneous

  • tests: enable previously disabled test platforms that have been fixed. (!747)(1e15ee14)

v2.3.1 (2021-10-13)

Changes/additions since OpenCPI Release v2.3.0

Enhancements

  • doc: add Sphinx/RST-formatted versions of data sheets for data_sink_qdac_csts, data_src_qadc_csts, platform_ad9361_config_csts, platform_ad9361_config_proxy_csts, platform_ad9361_spi_csts, platform_csts_ad9361_data_sub assets in projects/platform/hdl/devices/. (!724)(1f899cf1)

  • doc: add LibreOffice ODG source versions and SVG output of component/worker block diagrams in platform_ad9361_config_csts.comp/, platform_ad9361_config_proxy_csts.comp/, platform_ad9361_spi_csts.comp/, platform_csts_ad9361_data_sub.comp/ in projects/platform/hdl/devices/. (!724)(1f899cf1)

  • hdl base: update data_sink_qdac_csts-spec.xml and data_src_qadc_csts-spec.xml in projects/platform/hdl/devices/specs/to use “real/imaginary” terms, not “IQ”. (!724)(1f899cf1)

  • tools: add checkAssetName function to util.sh. (!731)(8a74c5e1)

Bug Fixes

  • devops: fix CI pipelines failing to build sdcards when building for an OSP and Comp project. (!718)(e153b531)

  • hdl base: fix generic_pcie makefile. (!717)(28b533cd)

  • runtime: set correct PCI dmaOptions for scalable data-plane. (!730)(3870faa2)

  • tools: fix document generation in non-website-project pipelines. (!719)(9c4a9d5a)

  • tools: fix centos8-packages.sh for use in containers. (!721)(e48d6bc5)

  • tools: fix broken install if OCPI_* envars exist. (!725)(b6021ac4)

  • tools: fix local source installation of yaml-cpp prerequisite. (!731)(8a74c5e1)

  • tools: fix illegal prereq names yaml-cpp and rsync-3.1.1. (!731)(8a74c5e1)

  • tools: detect empty SAMPLES messages and report the error rather than dump a stack frame. (!733)(594c55ae)

v2.3.0 (2021-09-08)

Changes/additions since OpenCPI Release v2.3.0-rc.1

Enhancements

  • devops: make jobs in CI pipelines that run unit tests only require the necessary unit test to be built. (!707)(78f0f675)

  • devops,doc: add initial support for publishing HTML-rendered RST documents. (!704)(e2e3bebd)

  • devops,tests: enable ocpi.osp.analog project pipelines. (!703)(df9f947b)

  • tools: fix ocpidev to correctly iterate over all libraries in a collection. (!696)(b4bd6966)

  • tools: replace bash with python for ocpidev build test command. (!705)(795d4e03)

  • tools: add Library and LibraryCollection delete method. (!711)(a0b2aef5)

Bug Fixes

  • devops: fix ocpi.comp.sdr components not being built in CI pipelines for rcc platforms. (!707)(78f0f675)

  • devops: build devices before other assets in OSP CI pipelines. (!712)(5e08aec9)

  • doc: update top-level platform project doc index to include PicoEVB Getting Started Guide. (!708)(ffdb81e4)

  • doc: update platform_ad9361_config_proxy-spec.xml to remove a following underscore in a property description. (!708)(ffdb81e4)

  • doc: fix and add doc links, fix typos and inconsistencies in PicoEVB Getting Started Guide. (!708)(ffdb81e4)

  • doc: add “OpenCPI” to Zedboard Getting Started Guide title. (!708)(ffdb81e4)

  • doc: rename PicoEVB Getting Started Guide to “picoevb-gsg.rst”, delete old “index.rst”. (!708)(ffdb81e4)

  • doc: fix duplicate labels in platform_ad9361_config_proxy_csts-worker.rst, platform_ad9361_spi_csts-worker.rst, platform_csts_ad9361_data_sub-worker.rst, platform_ad9361_config_csts-worker.rst. (!708)(ffdb81e4)

  • doc: add link to AD9361 Register Ref doc to Properties section in platform_ad9361_config-index.rst. (!708)(ffdb81e4)

  • doc,tools: fix presentation of subdevice connections by ocpidoc for HDL device workers. (!710)(9e17b416)

  • hdl base: fix sdp2axi clock definition so ise doesn’t get confused and run forever. (!706)(84a6d83c)

  • hdl base: fix broken primitive generation logic. (!714)(ba2af617)

  • hdl base,tools: fix broken zcu104 install and Pin typo. (!709)(8493fcb9)

  • tools: fix zed_ise platform so it uses the correct tool. (!701)(4881426c)

  • tools: fix minimal OSP installation/build error. (!702)(1fdef398)

  • tools: add enchant to CentOS and Ubuntu package lists. (!713)(666ab5b8)

Miscellaneous

  • devops,doc: add analog and sdr projects to doc generation scripts. (!704)(e2e3bebd)

  • doc: change release version field in conf.py to 2.3.0. (!708)(ffdb81e4)

  • tools: add better script description. (!709)(8493fcb9)

v2.3.0-rc.1 (2021-08-25)

Changes/additions since OpenCPI Release v2.2.1

Enhancements

  • app,tests: add hdl assembly for platform testing. (!677)(f5fe2d3a)

  • devops: run non-HWIL centos7 jobs only on AWS-tagged runners. (!644)(aa28d515)

  • devops: automatically retry failed CI jobs once. (!653)(b115ed6e)

  • devops: build OSP platforms in opencpi pipelines. (!689)(30b7341c)

  • devops: build Comp assets in pipelines that build the platform the assets are being built for. (!689)(30b7341c)

  • doc: add description of man page availability and links to noun pages to ocpidev.1.txt. (!672)(62126413)

  • doc: clarify alias terms for “component specification” and make usage consistent in ocpidev-create.1.txt, ocpidev-component.1.txt. (!672)(62126413)

  • doc: explain use in ocpidev-show.1.txt of asterisks on HDL platform names when displayed in default display format. (!672)(62126413)

  • doc: update tutorials 1, 2, 3, 4 with results of running in a “makeless” environment. (!684)(9de419ac)

  • doc: update README file to list tutorials 2, 3, and 4. (!684)(9de419ac)

  • doc,tools: add a template for an OpenCPI application asset type to ocpidoc create. (!633)(d9eda20c)

  • doc,tools: add support for device, subdevice and proxy workers to ocpidoc. (!686)(121bf60f)

  • doc,tools: add ability to generate a getting started guide template from ocpidoc. (!686)(121bf60f)

  • doc,tools: add a separate “Signals” section to the ocpi_documentation_worker directive for ocpidoc. (!697)(8ffa8911)

  • hdl base: improve data_src_qadc_csts_ext_test_app and turn it into a proper unit test. (!642)(c66ad37c)

  • osp: set sdp_width to 2 on zynq_ultra platforms. (!657)(aafffede)

  • runtime: allow deployment of multichannel DRC applications. (!698)(02b638dd)

  • tools: add picoevb hdl platform support. (!544)(e41c4572)

  • tools: avoid type conversions on output port maps since quartus will not accept it. (!609)(24e53a8a)

  • tools: convert build and clean from bash to python. (!623)(6e4be2cd)

  • tools: convert component asset creation logic from bash to python. (!640)(5e68a0f2)

  • tools: replace bash with python for test asset creation. (!646)(a3d42d26)

  • tools: ocpidev: replace bash logic with python equivalent for test asset creation. (!650)(7cdfdc81)

  • tools: add support for conditionals in slave assembly XML. (!651)(4571de82)

  • tools: avoid process creation and file system ops when finding platforms for speedup. (!651)(4571de82)

  • tools: ocpidev: replace bash with python for test asset creation. (!656)(b037cea5)

  • tools: add python code that builds and cleans applications to replace bash code. (!660)(7684935b)

  • tools: add python code that builds and cleans an application to replace bash code. (!663)(ea36f425)

  • tools: replace bash with python for hdl platform asset creation. (!665)(e63bd04a)

  • tools: have project-metadata.xml differentiate between core and library primitives. (!666)(2b0d5057)

  • tools: replace bash with python for hdl platform asset creation. (!669)(fb0b917c)

  • tools: replace bash with python for hdl slot/card asset creation/deletion. (!671)(abbe4a10)

  • tools: replace bash with python for ocpidev build and clean library commands. (!673)(df8cb819)

  • tools: update complex_mixer.cc code example in tutorial project. (!684)(9de419ac)

  • tools: update peak_detector.cc code example in tutorial project. (!684)(9de419ac)

  • tools: update generate.py, verify.py, view.sh example test scripts for complex_mixer.test in tutorial project. (!684)(9de419ac)

  • tools: update generate.py, verify.py, view.sh example test scripts for peak_detector.test in tutorial project. (!684)(9de419ac)

Bug Fixes

  • comp: add zynq_ultra target part to dc_offset_filter.hdl. (!657)(aafffede)

  • devops: update e310 whitelist and IP. (!682)(ecc9689b)

  • devops: reduce verbosity of logging on remote devices under test. (!688)(ce50d20f)

  • doc: correct grammar and update content to describe latest procedures in ASSET_DOC_CONVERSION_README. (!655)(62541275)

  • doc: correct formatting in converted projects/platform/hdl/devices/*-index.rst and *-worker.rst files. (!655)(62541275)

  • doc: correct typos in converted projects/core/components/metadata_stressor*.rst files. (!655)(62541275)

  • doc: explain “peak” proeprty in projects/assets/components/dsp_comps/complex_mixer.hdl/complex_mixer-worker.rst. (!655)(62541275)

  • doc: remove duplicate “OCPI_” from OCPI_SOCKET_INTERFACE in ocpirun.1.txt. (!672)(62126413)

  • doc: correct description of -d option in ocpidev-set.1.txt and ocpidev-unset.1.txt. (!672)(62126413)

  • doc,tools: remove “readsync” and “writesync” from “access” field, and modify “Variable Type” to “Type” in “Variable_type” field for the ocpidoc worker properties directive. (!659)(cc218802)

  • doc,tools: pin docutils install at 0.16 and disable “html_permalinks” for Sphinx versions >= 3.5. (!659)(cc218802)

  • doc,tools: enable figure and equation numbering in ocpidoc generated worker pages. (!686)(121bf60f)

  • doc,tools: fix underline lengths to match header lengths in ocpidoc generated templates. (!697)(8ffa8911)

  • hdl base: fix IP generation. (!699)(038066fd)

  • hdl base: fix axi-pcie address translation. (!700)(8321fb6b)

  • runtime: use fork syscall instead of glibc wrapper function. (!658)(35dc6029)

  • runtime: remove incorrect error check that triggered with slave assemblies and port delegation. (!668)(c0789df9)

  • tests: modify capture_v2 unit test to not check if timestamps are incrementing. (!523)(718159b1)

  • tests: generate assemblies for which case properties match build config parameters. (!553)(15826f5f)

  • tools: fix genMetadata to recognize single application files. (!652)(69c6406b)

  • tools: ocpidev: update bash scripts, makefiles, and C++ code to enable -L option. (!654)(e5ca3b13)

  • tools: change “vs” to “with” in ocpidoc.py code description for clarity. (!655)(62541275)

  • tools: rewrite a few python3.6-isms so OpenCPI framework installs on Ubuntu 16.04 LTS. (!662)(8049b7af)

  • tools: ocpidev: fix more python3.X portability issues. (!664)(3361f0b7)

  • tools: make ocpidev show platforms work again. (!667)(6d16cab0)

  • tools: allow primitives to build without the noun being specified. (!679)(d2ec7173)

  • tools: fix opencpi.ko build on ubuntu20_04 platform. (!680)(d8679338)

  • tools: fix more python3.5 portability issues. (!681)(ca2a42cc)

  • tools: make ocpidev show platforms not horribly slow by eliminating process creating for “make” under python. (!683)(4169362c)

  • tools: ocpidev: fix child process (make) error handling. (!687)(f19a3e17)

  • tools: ocpidev: fix spec delete to default to component level rather than project level. (!690)(3c827ca2)

  • tools: change package file suffix for busybox prerequisite download. (!691)(47c4ec5f)

  • tools: allow proxy slaves to compile array properties using parameterized dimensions. (!693)(d5ff8e7c)

  • tools: ocpidev: prevent partial creation of test assets. (!695)(b92a004f)

Miscellaneous

  • doc: update specified opencpi release version. (!678)(ddd46e9a)

v2.2.1 (2021-07-22)

Changes/additions since OpenCPI Release v2.2.0

Enhancements

  • devops: implement on-the-fly patching of man page sources. (!638)(3855456a)

Bug Fixes

  • app,protocols,tests: remove superfluous code and empty lines and include data_sink_qdac_test_app_csts. (!641)(34d9cc98)

  • doc: fix typos in ocpirun.1.txt and ocpihdl.1.txt. (!638)(3855456a)

  • tools: fix generation of unit test assembly xml for optional output ports. (!611)(ad3a06af)

  • tools: fix tar prereq build as root user. (!636)(e17d3a33)

  • tools: restore ocpidev ability to automatically determine noun and name when not provided. (!637)(35c74d8c)

  • tools: fix issue with running applications with ocpidev. (!637)(35c74d8c)

  • tools: improve ability of ocpidev to automatically determine noun and name when not provided. (!639)(948fda06)

Miscellaneous

  • devops,doc: modify web site scripts to handle “ettus” OSP. (!634)(5c7107ba)

v2.2.0 (2021-07-08)

Changes/additions since OpenCPI Release v2.1.1

New Features

  • doc,tools: add new OpenCPI documentation tool and its dependencies. (!381)(8ef39f85)

  • osp: add zcu106 hdl platform. (!538)(f6878c8f)

  • osp: add ci directives for ettus_n310_v4 platform. (!588)(2ce32ae5)

  • osp: xilinx zcu106/fmcomms support. (!627)(6282d6d6)

  • runtime: replace OCPI_CDK_DIR/.. with OCPI_ROOT_DIR in all relevant scripts. (!484)(09d011e7)

Enhancements

  • app,protocols: create a version of an existing application that uses a new protocol. (!631)(ec705ff2)

  • app,runtime: add an application attribute by changing runtime. (!568)(6813aa29)

  • comp: add capture_v2 RCC worker. (!524)(300b7bb8)

  • comp: added RCC_FINISHED and RCC_ADVANCE_FINISHED as return values. (!542)(06b4c6a7)

  • comp,hdl base,protocols: create a version of the timegate component that uses the complex_short_timed_sample-prot. (!578)(f7ef0afe)

  • comp,tests: create iqstream_to_csts hdl worker and test. (!546)(7eeea630)

  • comp,tests: create csts_to_iqstream component and test. (!557)(6b8aba53)

  • devops: add Component Library Projects to CI pipelines. (!516)(ec445bc2)

  • devops: enable verify-pipeline job in non-opencpi project pipelines to delete unnecessary pipelines. (!539)(f72bc069)

  • devops: add an ocpiremote stop and log to retain logs. (!543)(b3337a84)

  • devops,tests: add hardware in the loop unit testing for e31x, matchstiq_z1, plutosdr, zed, and zcu104. (!481)(7039f08f)

  • devops,tests: add unit tests for cards and devices to CI pipeline. (!481)(7039f08f)

  • devops,tests: add hardware in the loop testing. (!545)(c594c28a)

  • devops,tests: add hardware in the loop testing for csts. (!583)(186d2319)

  • doc: create csts_to_iqstream doc. (!557)(6b8aba53)

  • doc: add new terms/definitions, make review comment corrections to existing terms/definitions in glossary. (!574)(2247edef)

  • doc: add new chapter to User Guide that describes how to document OpenCPI assets with the new asset doc system. (!574)(2247edef)

  • doc: update app guide for makeless. (!601)(170f514e)

  • doc: opencpi.gitlab.io: generate HTML man pages for post-v2.1.1 releases including develop. (!610)(2eacbfbe)

  • doc: opencpi.gitlab.io: add link to opencpi/opencpi project changelog. (!610)(2eacbfbe)

  • doc: update app, hdl, rcc docs. (!618)(c1beaa02)

  • doc: add file_read and file_write information from Application Development Guide and remove obsoleted text. (!621)(264501c3)

  • doc: make formatting changes to docs for better integration with existing OpenCPI doc conventions. (!621)(264501c3)

  • doc: remove references to Makefiles and *.mk files from Tutorials 1-4. (!624)(b977f218)

  • doc: update CDG. (!626)(0948f6a0)

  • doc: update platform guide and man pages for makeless. (!632)(dedbfee7)

  • doc,tools: add OpenCPI logo SVG file to ocpidoc configuration files. (!592)(b1db3c4f)

  • doc,tools: add new CSS file for OpenCPI doc styles to ocpidoc configuration files. (!592)(b1db3c4f)

  • doc,tools: modify ocpidoc conf.py configuration options to use OpenCPI documentation styles and fonts. (!592)(b1db3c4f)

  • hdl base: update axi pcie interface. (!529)(6da2cde4)

  • hdl base: support all 4 clock/reset options in axi adapters and add raw2axi. (!555)(37f38231)

  • hdl base: make the new csts versions of data_sink and data_src the default versions. (!564)(7bd49a50)

  • hdl base: update generation of Xilinx mmcm and pll to not use simnetlist functional simulation files for xsim. (!581)(79684764)

  • hdl base,tools: update primitive IP generation scripts. (!558)(8b4d3a01)

  • hdl base,tools: enable HDL platforms to be specified without any Makefile variables or files. (!560)(34e0f767)

  • protocols: create CSTS protocol using CSWM as a template. (!532)(be27350c)

  • protocols: create a version of data_sink_qdac.hdl and its dependencies that use complex_short_timed_sample protocol. (!549)(34f01874)

  • protocols: create version of data_src_qadc that uses the csts protocol. (!564)(7bd49a50)

  • runtime: support array ports for delegated connections from proxy ports to slave ports. (!521)(c1d71b1d)

  • runtime: allow application and slave assembly instances to bind to specific devices in the underlying HDL platform/card. (!521)(c1d71b1d)

  • runtime,tools: update for “Make-less” to use Project.xml. (!448)(da7815aa)

  • tests: specify cases to run in makefile so the test cases can still be run if specified. (!489)(6e1470b5)

  • tests,tools: makeless support for project assets. (!485)(d3343f48)

  • tools: replace make with xml for worker, hdl core, hdl library. (!504)(b1afdc16)

  • tools: add makeless support for library assets. (!519)(584e4bf5)

  • tools: support elements in devices in platform worker XML, and “device” attributes for app instances. (!521)(c1d71b1d)

  • tools: add ubuntu20_04 development platform. (!533)(39ebaa31)

  • tools: add support for Xilinx Vivado 20.2. (!533)(39ebaa31)

  • tools: allow RCC proxies to have HDL platforms as slaves. (!541)(2ec3529c)

  • tools: allow worker build configurations to be generated and the workers built based on assembly requirements. (!560)(34e0f767)

  • tools: remove requiring Makefiles for assets, fix code that makes the assumption there has to be Makefiles in each directory. (!566)(16d44d0b)

  • tools: create python argparsing for ocpidev. (!569)(f05ebd11)

  • tools: ocpidev now creates XML files where it previously created Makefiles. (!575)(47d32a7e)

  • tools: replace bash with python for ocpidev library create. (!587)(c7893281)

  • tools: initial yocto based platform support. (!588)(2ce32ae5)

  • tools: have git ignore “simulations” directories. (!589)(57289316)

  • tools: convert ocpidev register/unregister project from bash to python. (!590)(d43b8598)

  • tools: expose on-demand worker building to the ocpidev and ocpiadmin commands. (!596)(ea21b841)

  • tools: enable applications to be makeless, using attributes in the app’s XML file. (!601)(170f514e)

  • tools: replace bash with python for ocpidev set and unset. (!605)(c20dbeea)

  • tools: application create in python. (!607)(2620348d)

  • tools: ocpidev: replace bash refresh of project metadata. (!613)(23aa1a66)

  • tools: added package dependencies for ettus_n310_v4. (!619)(28c4d689)

  • tools: added tar as a dependency. (!619)(28c4d689)

  • tools: converted ocpidev component/spec deletion from bash to python. (!628)(d1fc5cd6)

Bug Fixes

  • app: no longer building python2 ACI wrappers. (!616)(3f69cfc7)

  • comp: fix file_write.vhd bug to properly respect src_rdy of cdc pulse. (!581)(79684764)

  • comp,hdl base,protocols: fix default base HDL platform device worker to use the correct default protocol. (!570)(dd5fc9a2)

  • devops: fix issue in pipelines causing jobs not to be created for certain project assets. (!526)(8a5b7b2d)

  • devops: fix issue with scheduled pipeline stages not waiting for prior stages. (!573)(11d253a1)

  • devops: fix ci project discovery. (!622)(4101ae01)

  • devops: move sandbox log retrieval to “after” script. (!629)(5fe8d6c0)

  • doc: improve EOF propagation explanation in CDG and RCC docs. (!545)(c594c28a)

  • doc: fix cswm_to_iqstream doc. (!557)(6b8aba53)

  • doc: update/correct platform information in tables and text of Installation Guide. (!574)(2247edef)

  • doc: move example of component spec from port elements descriptions into its own section in Component Development Guide. (!574)(2247edef)

  • doc: add missing hardware setup section to ZedBoard Getting Started Guide reST file (index.rst). (!602)(c00bd01a)

  • doc: remove file_read messaging snippet since it is not shared with any other files and ocpidoc complains about it. (!621)(264501c3)

  • doc: fix Unicode arrows to be -> in Tutorial 3 and Tutorial 4 examples. (!624)(b977f218)

  • doc,tools: remove equal sign from example_app.xml inserted by documentation generator. (!579)(2a3278a7)

  • doc,tools: suppress auto-generated None from ocpidoc directives when there is no Description element in the asset XML. (!580)(718b21ef)

  • doc,tools: add SpecProperty information to the Property and Parameter sections generated by ocpidoc for workers. (!598)(68222891)

  • doc,tools: remove ocpidoc generated Parameter section and include that information under the Properties section for workers. (!598)(68222891)

  • doc,tools: modify ocpidoc to generate Port sections for workers. (!598)(68222891)

  • doc,tools: modify ocpidoc to use US English spell-checking instead of UK English. (!598)(68222891)

  • doc,tools: remove utilization directive in HDL Worker docs since ocpidoc no longer recognizes it. (!621)(264501c3)

  • doc,tools: allow ocpidoc create specs-directory to be called inside a specs/ directory without a “not an OpenCPI asset directory” error. (!630)(db514f0a)

  • hdl base: fix bug in generic pcie build scripts. (!529)(6da2cde4)

  • hdl base: support vivado 2020.2 with xsim. (!555)(37f38231)

  • hdl base: correct hdl axi2sdp constant on zynq_ultra platforms. (!627)(6282d6d6)

  • osp: do not rely on the zed PS axi resets after a bitstream load. (!591)(e723e11b)

  • protocols: fix out of bound array in csts marshaller. (!546)(7eeea630)

  • protocols: fix marshaller typo. (!583)(186d2319)

  • runtime: fix ternary/conditional expression evaluation and add more related related error checks. (!521)(c1d71b1d)

  • runtime: make default cache mode to be 1 on zynq-ultra. (!600)(f44e9cf8)

  • runtime: set zynq_ultra control plane width to 32-bits. (!627)(6282d6d6)

  • tools: fix invalid strings corrupting HdlCore xml files. (!514)(86e8bcfa)

  • tools: fix ubuntu* platform package lists. (!554)(5e16071d)

  • tools: fix centos8 platform package list. (!554)(5e16071d)

  • tools: fix linux driver module (opencpi.ko) on centos8 and ubuntu20_04 platforms. (!554)(5e16071d)

  • tools: fix broken x4sim platform. (!560)(34e0f767)

  • tools: add python3.6 support for asciidoc3 on ubuntu16_04. (!561)(4c7209d4)

  • tools: add missing asciidoc3 dependencies to ubuntu* package lists. (!565)(962766e6)

  • tools: fix asciidoc3 installation script. (!567)(46ac7e0e)

  • tools: fix MANPATH setting in opencpi-setup.sh. (!571)(a1838575)

  • tools: fix version updating and reporting for autotools-built programs. (!577)(1eca618a)

  • tools: allow doc tools to use sphinx versions greater than distro-provided ones, without impacting users. (!582)(c29596bd)

  • tools: fix build-opencpi.sh to call opencpi-setup.sh with -r flag. (!584)(ee0a1e59)

  • tools: avoid type conversion on formal side of sdp port maps to make quartus happy. (!591)(e723e11b)

  • tools: fix ocpiremote to not prevent multiple servers. (!591)(e723e11b)

  • tools: fix typo in xsim.exports file. (!593)(cd806a6e)

  • tools: fix sdp port issue for single-width sdp. (!594)(4cc25f8e)

  • tools: properly generate default values for multidimensional arrays. (!596)(ea21b841)

  • tools: fix lib create makeless. (!603)(fd9055a8)

  • tools: fix “ocpidev unregister project” failing in ocpidev.py. (!604)(36f5dac4)

  • tools: fix “ocpidev build hdl primitives” requiring a “primitive noun” to be provided. (!604)(36f5dac4)

  • tools: fix --minimal install option on OSPs. (!606)(8ba10de7)

  • tools: expand m_usedImpls to 64 bits to allow >32 worker instances per app. (!608)(53ee0360)

  • tools: fix python ACI. (!618)(c1beaa02)

  • tools: fix various small application and unit testing glitches. (!626)(0948f6a0)

  • tools: restore ocpidev ability to automatically determine asset sub-directory. (!628)(d1fc5cd6)

  • tools: fix creating a library named “components” in ocpidev making a nested library instead of a top-level library. (!628)(d1fc5cd6)

  • tools: fix broken tests_test.py unit test “test_test_good_”. (!628)(d1fc5cd6)

  • tools: fix ocpirun regression. (!632)(dedbfee7)

Miscellaneous

  • doc: remove LaTeX versions of data sheets that have been converted to Sphinx reST format. (!602)(c00bd01a)

  • tools: remove dependency of OpenCPI root dir on cdk dir in scripts. (!488)(2eacf67e)

v2.1.1 (2021-05-19)

Changes/additions since OpenCPI Release v2.1.0

New Features

  • hdl base: update the generic_pcie scripts for Vivado 2019.2 IP generation file structure. (!455)(8bd8c7c7)

  • hdl base: temporarily exclude all targets except the artix7. (!455)(8bd8c7c7)

  • hdl base: add axi_interface_pcie master and slave header files for the generic pcie primitive. (!455)(8bd8c7c7)

  • hdl base: update generic_pcie package to include records for the remaining pcie and axi interface signals. (!455)(8bd8c7c7)

  • hdl base: update generic_pcie Makefile to point to the top-level module. (!455)(8bd8c7c7)

  • hdl base: remove vivado synthesis from the primitive generation script. (!455)(8bd8c7c7)

  • hdl base: add top-level vhd file for the generic_pcie primitive. (!455)(8bd8c7c7)

  • hdl base: add artix7 FPGA as Hdl target hdl-targets.mk. (!455)(8bd8c7c7)

  • runtime: option to set ad9361 external reference clock frequency from DRC worker. (!536)(a106c978)

Enhancements

  • comp: add pattern_v2 RCC worker. (!530)(75ff8679)

  • hdl base: make pattern_v2 a split clock worker. (!525)(31e4eda1)

  • hdl base: make file_read.hdl a split clock worker. (!528)(fa8c1a88)

  • hdl base: make file_write.hdl a split clock worker. (!528)(fa8c1a88)

  • tools: update ocpiremote help messages and argument parsing. (!556)(867d693e)

Bug Fixes

  • app: remove the extra instance of platform_ad9361_config. (!472)(8a6a3a3a)

  • app: change opcodes to be valid opcodes that can be sent in the pattern-bias-file_v2, pattern_v2, pattern_v2, tb_bias_v2, and test_width_v2 apps. (!530)(75ff8679)

  • hdl base: fix various ocpi.types functions when used on slices. (!520)(194c522e)

  • hdl base: fix clocking library tcl script. (!522)(66257f0a)

  • hdl base,tests: fix broken data_sink_qdac test. (!528)(fa8c1a88)

  • runtime: fix ocpiremote looking in incorrect location for hdl-specific system.xml. (!515)(9fc39bc5)

  • runtime: fix dataplane m_ports assertion error. (!527)(5915298a)

  • runtime,tools: fix PATH setting in importXilinxRelease script. (!518)(9ec0ce36)

  • tests,tools: ocpigen: fix test parameter generated values not able to override default values. (!540)(2976bc77)

  • tests,tools: ocpigen: fix valuesFile not recognized as a valid attribute of a property element. (!540)(2976bc77)

  • tools: fix differential tie offs in hdl containers. (!511)(9feffb41)

  • tools: fix master.vhd for small protocols. (!517)(1eac8ba0)

  • tools: fix scoring algorithm bug. (!528)(fa8c1a88)

  • tools: fix assertion workerClk.m_exported bug. (!528)(fa8c1a88)

  • tools: fix file2String() arg 1 processing. (!540)(2976bc77)

  • tools: add fakeroot as explicit package dependency on *ubuntu dev platform. (!547)(ef983b07)

  • tools: a platform’s project dependencies are now added to search rules when containers are built. (!552)(1bc4957f)

  • tools: fix ocpiremote failures. (!556)(867d693e)

Miscellaneous

  • doc: modify COPYRIGHT file. (!562)(6b71036f)

  • hdl base: remove obsolete drc files. (!509)(dddb8fb7)

  • runtime: substitute “finished” for “done” in code comments re: control state. (!531)(9ab5a657)

v2.1.0 (2021-03-17)

Changes/additions since OpenCPI Release v2.1.0-rc.2

Enhancements

  • comp,hdl base: add properties to the data_sink_qdac device worker for number of samples before the first underrun and number of underruns. (!510)(2238c355)

  • doc: rename Acronyms and Definitions to OpenCPI Glossary, update, and append to reference documents. (!508)(07aeb463)

  • hdl base: replace bsv primitive with a reset compatible with xilinx2020.1. (!486)(cccad883)

  • hdl base: allow timestamper_scdcd to insert sampling intervals. (!506)(c1a3059d)

  • tools: add optimization options to ocpiremote, and make its options consistent with ocpidev and others. (!505)(6c9e8bc6)

Bug Fixes

  • comp,hdl base: fix extra cycles for dev_out.valid signal when data valid goes low. (!510)(2238c355)

  • devops: fix build-pages.py to handle OSP default branch that isn’t develop. (!501)(aa1199e0)

  • devops,tests: disable gpi.test until proper fix implemented. (!503)(8e4af08d)

  • hdl base: change timestamper_scdcd and associated protocol marshaller to avoid idle cycles in output. (!506)(c1a3059d)

  • hdl base: set HDL device timeservice with system time when GPS time is not available. (!506)(c1a3059d)

  • hdl base,runtime: fix bug in HdlDevice.cxx that set enable_time_now_updates_from_PPS_written to true when not even using PPS. (!502)(da2a10a4)

  • runtime: disable compilation of event tracing. (!505)(6c9e8bc6)

  • runtime,tools: clean up compilation warnings that are errors in centos7 under optimization only. (!513)(bc347d5d)

Miscellaneous

  • doc: remove obsolete Acronyms and Definitions document. (!512)(63c1c7ac)

  • osp: hdl configuration file update. (!500)(55823787)

v2.1.0-rc.2 (2021-03-04)

Changes/additions since OpenCPI Release v2.1.0-rc.1

New Features

  • runtime: add OCPI_ROOT_DIR environment variable to setup scripts. (!471)(f4b25449)

Enhancements

  • devops,tools: allow gen-cg-pdfs.sh to work with recent LibreOffice versions. (!482)(3405e888)

  • hdl base: make capture_v2 a split clock worker. (!492)(a8098c74)

  • runtime: enable drc stop_config. (!483)(904f12ff)

  • runtime,tools: add --optimize option to opencpi-setup.sh. (!495)(dcf1e54c)

  • tools: building sw framework/rcc/aci for optimization is now fully enabled, but not in the UI yet. (!490)(c16a8374)

Bug Fixes

  • comp: fix bug in drc worker implementation. (!497)(2dad9b19)

  • hdl base: increase data path cdc fifo depth from 2 to 16 within timestamper_scdcd for better throughput. (!496)(6295897e)

  • osp: zcu104: fix a typo and a symlink. (!491)(ae8386a8)

  • runtime: DtDmaXfer.cxx: fix log-level for messages to/from FPGA. (!498)(d5164abd)

  • tools: ocpidev.sh: fix broken test statements. (!498)(d5164abd)

Miscellaneous

  • doc: update DRC briefing for LibreOffice 5.3 compatibility. (!487)(8c300713)

  • osp: zcu104: fix regression, thereby allowing data_sink_test_app and fsk_dig_radio_ctrl to run. (!491)(ae8386a8)

  • tests: temporarily disable capture_v2 test. (!499)(9595345e)

v2.1.0-rc.1 (2021-02-08)

Changes/additions since OpenCPI Release v2.1.0-beta.1

New Features

  • doc: add DRC documentation to Application Development Guide and Platform Development Guide, and create new briefing. (!480)(1b9693a3)

  • tests,tools: create iperf3 install script that is called by install-prerequisites script. (!445)(a6f9aa0f)

Enhancements

  • app: ocpiremote: use less memory on the target embedded system when creating the sandbox, allow setting dma memory side on start. (!457)(46f1aff7)

  • comp: allow workers to get the current time, and C workers to have log messages. (!457)(46f1aff7)

  • comp: add in fsk_modem assembly and drc for zcu104. (!469)(a78f78e6)

  • comp,hdl base: updated data_src_qadc_ad9631_sub for one clock per sample and added properties for data_src_qadc. (!449)(3c2ace47)

  • devops: fix downstream pipelines failing due to environment variables not being set correctly. (!437)(72adeca8)

  • hdl base: update cnt_zed_fmcomms_2_3_scdcd.xdc and cnt_zcu104_fmcomms_2_3_scdcd.xdc to properly constrain things for the ADC one clock per sample. (!451)(064d6479)

  • hdl base: enable SDP send and receive to support lots of cpu-side buffers (255). (!457)(46f1aff7)

  • hdl base: increase maximum message size between HDL workers to 64k-4. (!457)(46f1aff7)

  • hdl base: add timegate worker to support timed transmission. (!466)(344f26db)

  • hdl base: allow zynq platforms to use the ACP port (partial). (!470)(69121c36)

  • hdl base: add ACP handling for zynq on zed at least. (!475)(f2577630)

  • hdl base: updated ad9361 data sink txen logic. (!479)(a7dbf4fa)

  • osp: add macos11_1 support. (!457)(46f1aff7)

  • osp: move zcu104 platform where it should be in the platform project. (!457)(46f1aff7)

  • runtime: support delegating array ports in proxies, with individual port connections in slave assemblies. (!436)(4be9ec46)

  • runtime: make cpu-side buffering much more scalable to easily support lots of buffers. (!457)(46f1aff7)

  • runtime: use “gather” APIs to improve TCP throughput. (!470)(69121c36)

  • tests: add simple performance test workers, and update file_write to report throughput and check test data correctness. (!457)(46f1aff7)

  • tests,tools: convert old advanced_pattern unit test into current framework. (!435)(fbde6289)

  • tests,tools: unit under test is done worker. (!460)(66d68419)

  • tools: build hdl xmls to satisfy proxy dependencies. (!438)(5c313de0)

  • tools: fix code generation for parameterized SDP ports. (!457)(46f1aff7)

Bug Fixes

  • app,runtime: fix external connections on slave assemblies. (!456)(5fce8148)

  • devops,tests: fix potential resource exhaustion issue on runners due to broken tests. (!474)(6e01a7d6)

  • doc: fix ocpiadmin man page typo (-url –> --url). (!462)(e9180617)

  • hdl base: fix sdp_send to eliminate the single cycle of backpressure on input, build sdp for 32/64/128 widths. (!457)(46f1aff7)

  • hdl base,tools: clean up the hdl primitives folders. (!430)(7ae9105e)

  • runtime: make the DRC “stop_config” method required. (!457)(46f1aff7)

  • runtime: fix cases where buffer-counts and sizes were not being set by ocpirun options. (!457)(46f1aff7)

  • runtime: datagram: fix 32/64-bit issue when sides are different. (!457)(46f1aff7)

  • runtime: add missing zynq setup script to exported files. (!458)(48d37a8e)

  • runtime: remove rcc worker error for buffer size and protocol mismatch. (!461)(fa2287ce)

  • runtime: comment out second channel of drc. (!463)(8d158bd2)

  • runtime: add “guard” in configure_gps_if_enabled() function. (!465)(85a0a442)

  • runtime: fix setting gain_mode manual on rx channel using DRC. (!478)(10c11830)

  • tools: fix bad exports list for some Xilinx platforms when deploying to ZedBoard. (!446)(a7bf321b)

  • tools: fix handling of single-element array properties by RPROP_ARRAY_16 and WPROP_ARRAY_16. (!459)(e7f0be4c)

  • tools: fix help message in “ocpiadmin” script. (!462)(e9180617)

v2.1.0-beta.1 (2020-12-18)

Changes/additions since OpenCPI Release v2.0.1

New Features

  • runtime: slaves are not automatically included in the application without mentioning them. (!428)(22c9956b)

  • tools: add convenience script (scripts/install-gnuradio.sh) to install OpenCPI’s modified version of GNU Radio 3.7. (!283)(8ad0cd5f)

Enhancements

  • app: enable bbloopback mode for FSK application on matchstiq z1. (!422)(2c2ebb0d)

  • devops: add OSP support to yaml-generator.py. (!382)(bf7a9c77)

  • devops: implement child pipelines for cross-platform builds/tests. (!382)(bf7a9c77)

  • devops: implement grandchild pipelines so that more jobs can be dynamically generated. (!431)(c249580e)

  • devops: fix downstream pipelines failing due to environment variables not being set correctly. (!437)(72adeca8)

  • osp: add support for zcu102. (!407)(444d760c)

  • protocols: update ComplexShortWithMetadata-prot.xml to use a sequence length of 4096 instead of 4092 for the iq argument of the samples operation. (!427)(34d0d193)

  • runtime: port delegation from proxies to slaves is now implemented. (!421)(b718ff61)

  • runtime: generic DRC helper class established in an API header OcpiDrcProxyApi.hh. (!421)(b718ff61)

  • runtime: update zed/fmcomms2 platform with new drc. (!433)(d494dad9)

  • tools: install-gnuradio.sh: add GNU Radio 3.8 support. (!401)(4c92ed80)

  • tools: add missing fields to the opencpi GRC blocks. (!425)(a40d1a90)

  • tools: ocpigen: add XML parsing for project assets. (!434)(30acd3d2)

Bug Fixes

  • runtime: fix ocpiremote deploy not deploying boot files to correct remote directory. (!416)(56b316af)

  • tools: include bitstream argument in “ocpiremote restart” to prevent errors being thrown. (!371)(83566d76)

  • tools: improve gnuradio 3.8 install. (!405)(a18a710c)

Miscellaneous

  • doc,runtime,tests,tools: remove remaining CentOS 6 references and supporting code. (!403)(3b9c943b)

  • comp: make “socket_write.rcc” portable. (!418)(4755f36a)

  • hdl base: add ADI “mykonos” library as a prerequisite. (!385)(f2ec19c5)

  • tools: remove remaining BSV references and code from ocpigen. (!414)(8f73efd2)

v2.0.1 (2020-11-18)

Changes/additions since OpenCPI Release v2.0.0

Enhancements

  • osp: update/refactor the DRC support libraries to be sharable among proxies, and make pluto an example of using them. (!393)(df56b22b)

  • tools: doc site: include OSP documentation starting with version 1.7.1. (!402)(73a409c4)

  • tools: doc site: add man page link to a release’s index page if man pages exist. (!402)(73a409c4)

Bug Fixes

  • doc,tools: prevent libreoffice tracked changes from showing up in rendered pdfs. (!392)(a7cb3110)

  • hdl base: add IDLE state to state machine. (!404)(477404a2)

  • hdl base: fix bug with statemachine. (!406)(d7fca60c)

  • runtime: add new way of calling no-os ad9361 library. (!420)(01e79568)

  • tools: fix bugs for clock adapter insertion. (!383)(2632c226)

  • tools: fix ubuntu check scripts to not error on non-ubuntu platforms. (!398)(044e4db1)

  • tools: fix bugs for clock adapter insertion. (!399)(99e89a32)

  • tools: doc site: fix incorrect “latest” release labeling. (!402)(73a409c4)

  • tools: fix “ocpigen” processing of 64-bit initial values for 64-bit HDL worker parameters. (!417)(977c228e)

Miscellaneous

  • comp: move “zero_padding” component to “inactive” project. (!419)(64f4f058)

  • doc,runtime,tests,tools: remove remaining CentOS 6 references and supporting code. (!403)(3b9c943b)

v2.0.0 (2020-10-06)

Changes/additions since OpenCPI Release v2.0.0-rc.2

New Features

  • tools: add dockerfile for docker image used during GRCon20 workshops. (!386)(94e17772)

Enhancements

  • app: include the demo app from tutorial 1 in the tutorial project for completeness. (!373)(1566b9e9)

  • comp: Add timed sample protocols. (!370)(90c31833)

  • comp: add rcc and hdl workers for the tutorial 1 workers so we have both rcc and hdl of all of them. (!373)(1566b9e9)

  • comp: cleanup another tutorial worker, peak_detector.rcc, for tutorial 2. (!373)(1566b9e9)

  • doc: add files for the timestamper_scdcd datasheet to be compiled. (!357)(37931d3b)

  • runtime: to be more consistent, enable “worker” attribute in app instances to include the authoring model suffix. (!373)(1566b9e9)

  • runtime: allow “worker” variable in selection expressions. (!373)(1566b9e9)

  • runtime: when there are no slaves indicated for a proxy instance (like from GRC), find slaves automatically if such a thing can be unambiguous. This is still not fully inferred slaves, it is inferred slaves when they are already present, but not indicated as slaves. (!373)(1566b9e9)

  • runtime: enable OCPI_APPLICATION_PARAMS to work better and for more options like dump and verbose (still not documented). (!373)(1566b9e9)

  • runtime: have our hdl sim drivers kill sims on SIGTERM as well as SIGINT. (!373)(1566b9e9)

  • tools: ocpigen: make ocpi_debug a hidden property. (!373)(1566b9e9)

  • tools: ocpigr37: make ocpi_container a pseudo-property for GRC to be “partly hidden”. (!373)(1566b9e9)

  • tools: add platform, worker, model, and “done” pseudo-properties to the ocpigr37 output, and put them last after normal properties. (!373)(1566b9e9)

  • tools: ocpigen: make ocpi_endian a hidden property. (!373)(1566b9e9)

  • tools: add env var OCPI_DISTRO_BUILD to enable generic x86_64 distro build feature. (!380)(e849452b)

  • tools: build generic x86_64 GMP library when OCPI_DISTRO_BUILD env var is set. (!380)(e849452b)

  • tools: add non-positional parameter handling to ocpiadmin. (!384)(cb1209c6)

Bug Fixes

  • comp: fix bug in cdc_clk_gen.vhd. (!378)(3ac9aac6)

  • hdl base: fix an ancient bug in VHDL delta cycles that we previously blamed on being an isim-only bug. (!373)(1566b9e9)

  • runtime: don’t end up busy-waiting when the container has no applications to run at all. (!373)(1566b9e9)

  • tests: fix typo in ocpidev_directory_test.sh relating to ocpishow.py. (!377)(0723c9aa)

  • tools: fix an ancient bug in modelsim building that could report an error which then “disappeared” on rebuild. (!373)(1566b9e9)

  • tools: make the tutorial project depend on platform so it can build for pluto and other OSPs. (!373)(1566b9e9)

  • tools: fix centos8-check.sh script. (!375)(03a04a91)

  • tools: fix ocpishow.py to have better error handling. (!377)(0723c9aa)

  • tools: fix project.py (in tools/python/_opencpi) to have better error handling. (!377)(0723c9aa)

v2.0.0-rc.2 (2020-09-22)

Changes/additions since OpenCPI Release v2.0.0-rc.1

New Features

  • tools: add ability to specify host only prereqs. (!361)(3ac81b61)

Enhancements

  • devops: add script to automate creation of gitlab CI pipeline jobs for opencpi projects/platforms. (!351)(5b068b89)

  • doc: add more man pages: ocpihdl, ocpirun, opencpi, and some other updates. (!366)(207870c0)

  • tools: add yaml-cpp v0.6.x as prereq (x86_64 only), removing weak dependency on boost. (!356)(be3e4cfa)

Miscellaneous

  • comp: add fifo_depth_p of 2048 to fifo.hdl build configuration. (!358)(fcd0e217)

  • tests: suppress plutosdr from fir_complex_sse_ts.test due to lack of dsp resources. (!359)(387938a8)

v2.0.0-rc.1 (2020-08-28)

Changes/additions since OpenCPI Release v2.0.0-beta.1

Enhancements

  • comp: improve dc_offset_filter doc by adding transfer function. (!333)(364bb72e)

  • comp: build socket_write.rcc for ubuntu18_04 platform. (!353)(7ef32634)

  • devops,tests: remove obsolete “.bitz” files from git repo. (!337)(3d801f21)

  • doc: add more man pages for OpenCPI commands. (!347)(6b7e41eb)

  • doc,tools: add doc RPM to existing packaging machinery. (!329)(62cc8e74)

  • hdl base: all hdl platforms have a standard test bitstream exported in a standard place. (!338)(e19fc095)

  • runtime,tools: a proxy can have optional slaves so apps can have subsets, and the proxy can test or presence. (!338)(e19fc095)

  • tools: enable python2 ACI in addition to python3 ACI. (!334)(3ea0db4d)

  • tools: implement “-v” (verbose) option in “deploy-platform.sh” script. (!345)(5d7c5383)

  • tools: add VERSION file that defines the version of OpenCPI. (!346)(b1e80c4d)

  • tools: refactor scripts/update-release.sh to use new VERSION file. (!346)(b1e80c4d)

Bug Fixes

  • comp: timestamper_scdcd.vhd: add logic to confirm that EOF is valid. (!314)(b4918d13)

  • hdl base: complex_short_with_metadata_demarshaller.vhd: add reset for EOF. (!314)(b4918d13)

  • hdl base: time_downsampler.vhd: add reset for EOF. (!314)(b4918d13)

  • hdl base: the ml605 now builds everything including the inactive and tutorial projects. (!338)(e19fc095)

  • runtime: some property setting patterns, especially for remote device slaves, were broken and now fixed. (!344)(fb8e6c12)

  • tools: fix export logic so as not to create broken symlinks. (!329)(62cc8e74)

  • tools: build regressions on lesser used platforms not in normal pipeline. (!331)(a7f7cdd2)

  • tools: fix “ocpigr” error exceptions caused by obsolete bitstream files. (!337)(3d801f21)

  • tools: ocpigen: check status code returned by finalizeHdlDataPort() instead of ignoring it. (!339)(33f94239)

  • tools: fix building an ubuntu docker container with a non ubuntu host by preventing kernel related items from being built. (!343)(29a8c490)

  • tools: fix OSP HDL platform export mechanism. (!345)(5d7c5383)

  • tools: fix/restore usable of project-level componentlibrary settings in proxies in hdl/cards. (!350)(1584caf7)

Miscellaneous

  • tools: remove support for CentOS 6 as a development host platform. (!354)(3dc24ee0)

v2.0.0-beta.1 (2020-07-24)

Changes/additions since OpenCPI Release v1.7.0

New Features

  • devops: upload entire OpenCPI tree to AWS S3 when a job fails. (!297)(6708dc22)

  • osp: add support for additional xilinx software platforms: xilinx13_4_aarch32, xilinx19_2_aarch{32,64}. (!173)(5e034a9a)

  • tools: add AV GUI to ubuntu18_04 platform. (!294)(d74f201c)

  • tools: add centos8 RCC development platform. (!312)(c85641a3)

  • tools: initial add of “ubuntu18_04” development platform. (!278)(e053aac5)

Enhancements

  • devops: add ability for opencpi pipeline to launch downstream plutosdr pipeline. (!303)(ddb5b49e)

  • devops: add weekly scheduled CI pipeline to lessen load on MR pipelines. (!287)(c47409e0)

  • devops: move CI artifact hosting from gitlab to AWS. (!325)(8c28c710)

  • doc: add generation of html man pages. (!327)(196ab92e)

  • doc: add man pages for ocpidev nouns (previous ones are for verbs). (!327)(196ab92e)

  • doc,tools: export PDFs so they can more easily be packaged in an RPM. (!311)(fb4c4f4c)

  • hdl base: allow bitstream loading in linux 4.10, and avoid probing a bitstream when unloading or loading. (!316)(d3dabaf9)

  • hdl base,tools: component library searching is now all-libs-in-project, per project, not each-lib-in-all-projects. (!316)(d3dabaf9)

  • hdl base,tools: primitive libraries can be qualified by the project’s package id. (!316)(d3dabaf9)

  • hdl base,tools: workers chosen for an assembly are not affected by what is built as long as anything is built. (!316)(d3dabaf9)

  • osp: add initial support of ad9361 fmcomms transceiver for zcu104 platform. (!302)(bfe43f20)

  • tools: ocpigr: emit yaml instead of xml to support grc 3.8. (!306)(b2b8617d)

  • tools: refactor ocpiadmin.sh and relocate to tools/scripts/. (!319)(f37f3732)

Bug Fixes

  • devops: fix hdl platforms building in pipelines when they shouldn’t. (!317)(2c557552)

  • hdl base: check for hdl target before building zynq primitive wrapper. (!326)(308f360e)

  • tools: fix MANPATH and PYTHONPATH settings in “opencpi-setup.sh”. (!323)(3312352c)

  • tools: fix centos7 platform installation error when swig3 package not available. (!328)(8bf294e7)

  • tools: fix incorrect package-ids in artifacts using top-level specs (not specs in libraries). (!321)(380f6c63)

  • tools: fix ocpigr build issues. (!324)(543ab821)

  • tools: suppress cross-compilation for items in build/places that use the -t flag. (!307)(894f6e81)

Miscellaneous

  • devops: remove CentOS 6 from CI pipeline. (!308)(5006cbc1)

  • devops,tools: revamp OpenCPI RPM package production process. (!304)(2b62a34a)

  • doc: update ubuntu* and centos8 platform README files. (!315)(77e3a53c)

  • osp: exclude plutosdr in assets assemblies not capable of building. (!295)(a2c8fb98)

v1.7.0 (2020-07-09)

Changes/additions since OpenCPI Release v1.7.0-rc.1

Consolidated changelog
Full diff between v1.6.2 and v1.7.0

Enhancements

  • doc: tex documents are more consistent in terms of layout. (!286)(98c0cafb)

  • tools: revamp export script modularity to support RPM installs. (!299)(f66e7180)

Bug Fixes

  • hdl base: fix fractional and integer second misalignment in time_server.hdl. (!296)(9b9dc17a)

v1.7.0-rc.1 (2020-06-25)

Changes/additions since OpenCPI Release v1.7.0-beta.1

Enhancements

  • comp: add new complex_short_samples protocol. (!250)(d4a95651)

  • devops,tests: add specifying hdl platforms to run in pipeline using gitlab web UI. (!255)(f01d9a71)

  • doc: clarify that RCCPort::send() does not advance a worker’s output port buffer, and RCC_OK should be returned. (!285)(8468d7cc)

  • doc: clarify that git clone of Xilinx repos are automatic. (!285)(8468d7cc)

  • doc: clarify that minBufferCount in RCC workers refers to how many buffers exist and not how many need to be full of data. (!285)(8468d7cc)

  • runtime: update ocpiremote tar command. (!263)(7a0f0f14)

Bug Fixes

  • comp: fix cdc tester workers cosim issue. (!176)(6945a2af)

  • doc: fix opencpi.gitlab.io urls in various “develop” version docs. (!257)(b1ebfed1)

  • hdl base: bypass build for fir_real_sse_for_xilinx.hdl on rcc-platform builds. (!260)(d80c30a0)

  • hdl base: fix issue with generating clock generator primitive when using Vivado 2019.2. (!261)(ded238b4)

  • hdl base: fix verify script. (!273)(22d72ca5)

  • hdl base: only build zynq ultra primitives for xsim or zync_ultra. (!282)(25842f25)

  • hdl base,tools: clocking of split clock output ports propagating clocks from input ports was fixed. (!277)(869c4408)

  • osp: update xilinx13_3 exports for sd card generation. (!241)(1b2c2fb0)

  • runtime: fix EOF on output when the output port is not in the run condition. (!284)(752fea83)

  • runtime,tests: fix macos10_14/Mojave installations, mostly due to python2->python3 transition. (!262)(1ab35078)

  • tools: add missing CentOS 6 dependencies for ISE. (!282)(25842f25)

  • tools: ensure i386 repo is enabled for Ubuntu 16.04, some vendor tools require 32-bit libraries still. (!271)(1aabe590)

  • tools: fix HDL primitive search algorithm in tools/include/hdl/hdl-search.mk. (!266)(bdd9c797)

  • tools: fix altera build issue for part numbers. (!281)(bbbc0a18)

  • tools: fix macos catalina install. (!281)(bbbc0a18)

  • tools: install-platform script enhancements. (!268)(1ca453a1)

  • tools: remove clocking library from hdl-pre.mk. (!270)(c75b93ca)

Miscellaneous

  • doc: remove utilization.inc and configurations.inc from repo. (!251)(86b45477)

  • osp,tests: exclude plutosdr from fifo, fir_real_sse, fir_complex_sse unit tests. (!249)(981440b5)

  • tools: add openssl-devel to centos7 packages. (!254)(7e7e6d82)

v1.7.0-beta.1 (2020-05-31)

Summary

  • Support for ADALM-PLUTO via the new PLUTO SDR OSP.

  • Support for Zynq-UltraScale via the new built-in assets zcu104 HDL platform.

  • New built-in platform project moved a lot existing support for platforms out of theassets project.

  • Ubuntu 16.04 development host support

  • Vivado 2019.2 support

  • Plus many more enhancements and bug fixes! See sections below for full list of new features and improvements.

New Features

  • comp: add RCC work-a-like for HDL cic_dec. (!111)(d5c54a72)

  • comp: xilinx FIR compiler based fir_Real_sse worker. (!229)(2649bf6d)

  • comp,hdl base: create platform project and move zed platform, zed_ise platform, zynq primitive, data_src_adc component spec and data_src_dac component spec to platform project. (!182)(84aa3af6)

  • devops: developers can specify hdl platform to run in CI pipeline via their commit message. (!202)(b51e43c9)

  • doc: add component best practice guide. (!221)(fe014ed6)

  • doc: add ocpidev man pages. (!256)(47be5371)

  • hdl base: add new primitive library “clocking” for Xilinx MMCM and PLL. (!109)(b4a449ce)

  • osp: add zcu104 support, as well as the zynq-ultrascale infrastructure for any zynq-ultrascale platform. (!168)(466184ae)

  • tools: add support for Vivado 2019.2 xsim on ubuntu16_04 platform. (!180)(4fe483ce)

  • tools: add ubuntu16_04 software platform. (!170)(1b0f685e)

Enhancements

  • app: convert timing accuracy test procedures to exclusively use OpenCPI applications. (!79)(be7dc0af)

  • comp: add HDL worker for converting ComplexShortWithMetadata protocol to iqstream protocol. (!120)(8bd3d458)

  • comp: add HDL worker for converting iqstream protocol to ComplexShortWithMetadata protocol. (!165)(dd6d22e7)

  • comp: add enhancement of using BRAM to HDL pattern_v2 component. (!123)(bcc28387)

  • comp,doc: add component datasheet for iqstream_to_cswm.hdl. (!252)(dc821ec8)

  • devops: add building for matchstiq_z1 to the CI pipeline. (!161)(54d8c358)

  • devops: add building modelsim and tests for modelsim to CI pipeline. (!208)(723a71fa)

  • devops: add building of opencpi and building of tests for the zed platform to the CI pipeline. (!156)(fa188146)

  • devops: add isim building and testing to CI pipeline. (!190)(cbd5041e)

  • devops: downstream e3xx pipelines use branch with name matching upstream if one exists; otherwise develop. (!210)(de77a0e4)

  • devops: set xsim as default HDL platform tested by CI for non merge request pipelines. (!201)(adf29dc6)

  • doc: add preliminary documentation for adding HDL tool support. (!119)(4a68f932)

  • doc: document OCPI_SOCKET_INTERFACE env var when using remote containers on multi-homed systems. (!199)(ac023eef)

  • doc: document top level attributes for containers and pf configs: platform, config, constraints, onlyplatform etc. (!199)(ac023eef)

  • doc: explain how one protocol can xi:include another. (!199)(ac023eef)

  • doc: fix known defects, expand test coverage, and add support for HdlWorker StreamInterface attributes in docGen.py. (!118)(50ebe553)

  • doc: update cic_dec documentation to reflect the new tests. (!86)(db706821)

  • doc: update install/user/tutorial docs based on trainee feedback. (!220)(b4551467)

  • doc: update software platform and adc/dac sections of platform development guide. (!256)(47be5371)

  • doc,tools: automate document table generation for select component datasheets. (!163)(fb3edb44)

  • hdl base: add zynq 7010 support (generics added to asset’s project’s zynq_ps primitve). (!103)(451edd39)

  • hdl base: update hdl worker shell code for cdc best practices. (!172)(1d0c8f8e)

  • osp: add new configuration for ad9361-data-sub. (!237)(f3a85f72)

  • osp: add three new configurations for gpi. (!237)(f3a85f72)

  • osp: mint19 now works as a development platform with no FPGA tools tested. (!167)(4a8629c1)

  • osp: simplified and more robust export model for platforms and SD cards. (!158)(22f40996)

  • runtime: add loading boot files to device with ocpiremote.py. (!244)(2569d725)

  • runtime: expand ocpizynq utility to print out 7 series PS SPI registers. (!143)(27997461)

  • tests: update python test files from python 2 to python 3.4. Later changes removed the explicit python minor version. (!108)(b6929b1f)

  • tests,tools: add ability to use OpenCPI ACI with python3. (!209)(3247ecfc)

  • tests,tools: refactor kernel module build process. (!230)(08e8132f)

  • tests,tools: remove python2-related packages from <platform>-packages.sh scripts. (!218)(6371471c)

  • tools: add support for optional HDL ports with clockdirection=in. (!245)(30a645dd)

  • tools: automate how we create new Xilinx-based RCC software platforms, from 2013 to the present. (!135)(e0a92be8)

  • tools: change all “python34” references to “python3”. (!169)(eee26b03)

  • tools: convert ocpiremote.sh to ocpiremote.py. (!114)(0891c554)

  • tools: eliminate the tools/cdk from the source tree (not user-visible). (!203)(892a8e51)

Bug Fixes

  • app: fix cic_dec view.sh bug that failed to generate plots. (!86)(db706821)

  • comp: fix bug where data_sink_dac.hdl assigns Q from I value. (!120)(8bd3d458)

  • comp: fix pattern_v2 unit test bug. (!177)(8d0c0f6d)

  • comp,tests: fix test_tx_event unit test hanging on zed. (!187)(84a32435)

  • hdl base: fix bug when building assemblies for zed_ise. (!219)(ff39bcb2)

  • runtime: fix bug when trying to use remote containers with zed_ise. (!219)(ff39bcb2)

  • runtime: return correct value when getting scalar values from parameter properties with getPropertyValue<type>() API call. (!184)(1fabe14d)

  • tests: fix a socket test that fails when computer’s hostname is not resolvable. (!235)(4af69dd7)

  • tests: test-timer.cxx allowed duration increased from 5% to 15% of expected duration to account for VM sleep/wake overhead. (!205)(51ba070f)

  • tests,tools: fix matplotlib for python3.4 unavailable. (!209)(3247ecfc)

  • tools: fix codegen bug when multiple ports use the same protocol. (!246)(40698dca)

  • tools: fix gpsd build for “DBUS development package installed” case. (!243)(6cdcb044)

  • tools: fix sed expression in makeExportLinks.sh related to user-env.sh. (!198)(fbc9badb)

  • tools: improve ocpiav usage/help message. (!191)(e0abd684)

Miscellaneous

  • comp: change ComplexShortWithMetadata protocol. (!115)(5333a8a9)

  • comp: modify data_src_adc component/worker to match intended design. (!140)(1008e082)

  • doc: add plutosdr platform to OpenCPI Installation Guide. (!128)(981ebd35)

  • doc: update plutosdr platform in OpenCPI Installation Guide. (!216)(59318d87)

  • hdl base: move zynq_ultra primitive to new platform project. (!225)(e0e20753)

  • osp: add additional build configurations to components needed by the plutosdr platform. (!107)(2696ad7d)

  • osp: add dev system packages in support of plutosdr. (!242)(2afaf517)

  • runtime: remove bash-isms in ocpiremote scripts. (!148)(e5bfa8db)

  • tools: add shebangs to python scripts missing them. (!238)(d3600eb2)

  • tools: fix improper directory structure generation for genDocumentation.sh. (!183)(a14e6fe5)

  • tools: fix ocpigen error message for cards. (!226)(90d1425a)

  • tools: remove explicit uses of python to execute python scripts, relying on shebangs instead. (!238)(d3600eb2)

  • tools: use python3 version of doc packages instead of python34. (!232)(0cd230ad)

v1.6.2 (2020-04-05)

One framework related fix, rest are CI/CD related.

Enhancements

  • devops: add kicking off of e3xx project pipeline from main opencpi pipeline. (!171)(3dd44849)

Bug Fixes

  • devops: Don’t use $CI_REGISTRY_IMAGE as it is incorrect for forked projects. (!155)(fe8ac9f8)

  • devops: Explicitly set default job timeout as forked projects do not inherit the value. (!155)(fe8ac9f8)

  • doc,tools: Regex pattern used to parse git branch output was improved to correctly handle (detached from XXX). (!157)(6126f943)

  • hdl base: apply fix to sdp_receive_dma. (!166)(3024057a)

v1.6.1 (2020-03-02)

This is mainly a documentation + CI/CD improvement release. However, there was a handful of framework releated bug fixes.

Enhancements

  • devops: Speed up CI pipeline by 100%. (!131)(1ba546af)

  • devops: Trigger pipeline for downstream project opencpi.gitlab.io. (!141)(5a2e7683)

  • devops: Add support for passing upstream artifacts to downstream projects. (!144)(47da89d0)

  • devops,tools: Add a “latest” release url. (!125)(ab5ecf67)

  • doc: rename reference document file names to be friendlier and reflect their content better. (!122)(b9b730ad)

  • tools: Build and add tutorials to opencpi.gitlab.io. (!117)(674496a1)

  • tools: Build and add briefings to opencpi.gitlab.io. (!117)(674496a1)

  • tools: Pages: only build latest release of each version. (!136)(38889eec)

  • tools: Add CLI and GUI version of tutorials to doc site. Note: not all tutorials support this new format and will be made available when converted. (!138)(91922c85)

Bug Fixes

  • app: change instances of data_stream_type to direction. (!142)(6e3e9cb8)

  • tests: Change np.nan to sys.maxsize as not all systems support np.nan. (!100)(27099092)

  • tools: install package for Tahoma font. (!102)(8d5ca9a9)

  • tools: Replace libreoffice-headless dependency with libreoffice-writer so docs can be built on fresh install of CentOS 7 minimal. (!112)(f5638c53)

  • tools: ocpidev run now works for xml-only applications created with -X. (!116)(3c3d3fc9)

  • tools: ocpidev now allows spaces in argument values, equal sign values after –options. (!116)(3c3d3fc9)

  • tools: Fix OpenCPI version tag sorting for opencpi.gitlab.io. (!124)(bc9cfc14)

  • tools: Use unoconv to convert libreoffice docs to pdfs. (!126)(7361545e)

Miscellaneous

  • devops: Redirect https://opencpi.gitlab.io/opencpi to https://opencpi.gitlab.io/releases/latest/. (!145)(0a5ce1aa)

  • doc: Change relevant references from GitHub to GitLab. (!100)(27099092)

  • tools: Install tree package since tutorials use it. (!100)(27099092)

v1.6.0 (2020-02-06)

Enhancements

  • devops: Remove use of caching to pass artifacts between stages. Enables use of cloud and local resources. (!87)(72604cb1)

Bug Fixes

  • tests: Change #!/usr/bin/env python3 to #!/usr/bin/env python3.4. (!85)(5bf52ee2)

Documentation

  • Updated Release Notes. (!121)(e494630f)

  • Version bump documents to v1.6.0. (!121)(8e5967c3)

v1.6.0-rc.1 (2020-01-11)

New Features

  • app,comp: Builtin Tutorial project. (!92)(db38114a)

  • comp: Add Phase to amplitude CORDIC RCC work-a-like. (!83)(42c010ea)

  • devops: add xsim to the ci pipeline. (!50)(ed8bbff4)

  • devops: Add GitLab Pages static site generator for documentation. (!84)(5748523d)

  • devops: Add Dockerfile for docker image used to create pdfs and GitLab Pages. (!84)(5748523d)

  • devops: Use custom docker image in CI pipeline to create pdfs and GitLab Pages. (!84)(5748523d)

  • hdl base: Add debounce.vhd primitive. (!83)(42c010ea)

  • hdl base: Add GPI and GPO device workers. (!83)(42c010ea)

  • osp: Support MacOS Catalina (10.15). (!92)(db38114a)

  • tools: Add script, scripts/install-platform.sh, to install platforms and projects for that platform. (!92)(db38114a)

Enhancements

  • comp: Replace matchstiq_z1_gp_out worker with matchstiq_z1_gp_card “virtual card”. (!83)(42c010ea)

  • runtime: data and control clocks split throughout the unit test infrastructure. (!82)(f83770a5)

  • tools: Simplify installation of AV GUI and reduce user setup after installation. (!92)(db38114a)

Bug Fixes

  • app: Fixes fmcomss_2_3_tx artifact build issue for xilinx13_4. (!64)(f9f2791e)

  • app: Removed extra newline from template.py, added license to model core project. (!88)(86448f87)

  • app,comp: data_src.hdl: out port ZLM generation failed in some cases. (!73)(a5335922)

  • comp: Set data_sink_dac on_off port to correct clock domain. (!60)(8fc9e6fe)

  • hdl base: patches a bug in the fixed_float library seen when using older tools. (!67)(4e77a644)

  • osp: Fix exporting the zed_ise specific system.xml. (!72)(eaefb073)

  • tools: updated inode64.c url. (!65)(e54c92ea)

  • tools: Fix make-hw-deploy.sh to put system.xml in correct place. (!71)(b37f8244)

Documentation

  • app,comp,runtime: Add Briefing slides that provide background information about OpenCPI concepts and processes. (!92)(db38114a)

  • app,comp,runtime: Add Tutorial documents that allow completion of tutorials using an HDL simulator as well as an E310. (!92)(db38114a)

  • app,comp,runtime: Major update to developer guides. (!92)(db38114a)

  • comp: Add HDL worker documentation for data_sink_dac.hdl. (!61)(501dab62)

  • devops: replace github references with gitlab. (!46)(8079eafb)

  • devops: Refactor CHANGELOG.md. (!75)(5efbc78b)

  • osp: Update ZedBoard GSG to use new sharing scheme. (!92)(db38114a)

  • osp: Update Matchstiq GSG to refer to installation guide. (!92)(db38114a)

  • runtime,tools: New User document geared towards OpenCPI users. (!92)(db38114a)

  • tools: scripts/install-opencpi-docs.sh no longer builds the docs, one must additionally use make doc. (!84)(5748523d)

  • tools: Major update to installation guide. (!92)(db38114a)

v1.6.0-rc.0 (2019.11.08)

Feature Preview

  • app: Timestamping accuracy and characterization. (!27)(499967c3)

  • comp: Update ADC worker to work with split clocks. (!18)(634ad0cf)

  • comp: Update ADC worker to no longer timestamp. (!18)(634ad0cf)

  • comp: Update ADC worker to supply sample clock as an output. (!18)(634ad0cf)

  • comp: Add HDL worker for timestamping ComplextShortWithMetadata protocol data. Supports control, data, input and output clock domains. (!29)(408dfb16)

  • comp: Update DAC worker to work with split clocks. (!30)(bed4736b)

  • comp: Update DAC worker to no longer timestamp. (!30)(bed4736b)

  • comp: Update DAC worker to support end of data/burst and EOF distinct from underrun. (!30)(bed4736b)

New Features

  • devops: Init CI/CD starting with CentOS 7 software platform. (!5)(696bcc02)

  • devops: Utilize docker to test system package installation. (!21)(28805cf9)

  • devops: Add CentOS 6 software platform. (!25)(e8b67dc6)

  • devops: Add Xilinx 13.3 and 13.4 software platforms. (!41)(146e2693)

  • tests: Add CDC library primitives tests. (!38)(35b698a8)

  • tools: Add gpsd for all software platforms. (!4)(22842b54)

  • tools: Support remote HW testing, simplfying hardware in the loop testing. (!36, !34)(579e96fc)

Enhancements

  • comp: HDL time service worker provides “time is good” signal. (!9)(3aebfece)

  • comp: HDL time service worker uses booleans instead of bit fields for control and status registers. (!9)(3aebfece)

  • comp: time_server.hdl syncs with framework time service when initializing. (!40)(9a2a670f)

  • runtime: Support Zynq FPGA loading on linux kernels from 2013 to 2019, including non-Xilinx kernels. (!14)(c0c402dc)

  • runtime: Standardize on python3.4. (!33)(e2e1eddb)

  • runtime: Time service initializes time-of-day from gpsd. Falls back to system time-of-day if gpsd not available. (!40)(9a2a670f)

  • tests: Relax skew constraint for TestOcpiOsTimer to reduce false failures when executing in a VM. (!17) (3696eb69)

  • tools: Xilinx/zynq script updates to better support lots of xilinx software versions, including 2019.1. (!6)(fcf33e2a)

  • tools: Remove gdb prereq for Xilinx13. (!44)(aea49736)

Bug Fixes

  • tests: Do not page help output. Tests desinged to fail were stalling the pipeline. (!11)(155c809c)

  • tools: Fix make error if /opt/Xilinx does not exist. (!11)(155c809c)

  • tools: Prevent rare git issue when cloning repos that contain CRLF. (!11)(155c809c)

  • tools: Use tarball for rsync instead of git repo. (!32)(ab3864a5)

  • tools: Update inode64 url to a working location. (!34)(b2ca33ac)

  • tools: Error cross building opencpi.ko for Xilinx13 on CentOS6. (!35)(19d8f474)

Documentation

  • comp: Update ADC device worker to reflect enhancements. (!42)(c53385d3)