{"id":13775445,"url":"https://github.com/OpenCAPI/oc-accel","last_synced_at":"2025-05-11T07:32:44.090Z","repository":{"id":40792631,"uuid":"218463548","full_name":"OpenCAPI/oc-accel","owner":"OpenCAPI","description":"OpenCAPI Acceleration Framework: develop an accelerator with OpenCAPI technology","archived":false,"fork":false,"pushed_at":"2024-08-29T18:26:54.000Z","size":30595,"stargazers_count":64,"open_issues_count":6,"forks_count":45,"subscribers_count":11,"default_branch":"master","last_synced_at":"2024-11-17T10:39:55.191Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Verilog","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/OpenCAPI.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-10-30T07:03:30.000Z","updated_at":"2024-08-20T02:20:35.000Z","dependencies_parsed_at":"2024-08-03T17:10:18.762Z","dependency_job_id":"f22ae14e-a717-4810-b7d2-815c4dfc60e0","html_url":"https://github.com/OpenCAPI/oc-accel","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OpenCAPI%2Foc-accel","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OpenCAPI%2Foc-accel/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OpenCAPI%2Foc-accel/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OpenCAPI%2Foc-accel/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/OpenCAPI","download_url":"https://codeload.github.com/OpenCAPI/oc-accel/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253534084,"owners_count":21923515,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-03T17:01:38.817Z","updated_at":"2025-05-11T07:32:39.074Z","avatar_url":"https://github.com/OpenCAPI.png","language":"Verilog","funding_links":[],"categories":["Connectivity"],"sub_categories":[],"readme":"# OC-Accel Framework\n\nOpenCAPI Acceleration Framework, abbreviated as OC-Accel, is a framework that helps you implement your FPGA acceleration solutions with OpenCAPI technology.\n\n# Documentation\n \u003chttps://opencapi.github.io/oc-accel-doc/\u003e\n\n# Dependencies \n * On a X86 server:\n    * Install Xilinx tools (Check \u003chttps://opencapi.github.io/oc-accel-doc/#dependencies\u003e) with the desired fpga family (used by the card you want to test).\n    * set XILINX_ROOT and XILINXD_LICENSE_FILE accordingly and source Xilinx setting shell: \n    ```console\n    export XILINX_ROOT=/opt/Xilinx/xxxx.y   # setup your xilinx tools install dir. eg xxxx.y = 2020.1\n    export XILINXD_LICENSE_FILE=2100@xxxxx.com\t# Vivado license\n    . $XILINX_ROOT/settings64.sh\n    ```\n * On a POWER9 server:\n   * Install lib-ocxl on server:\n     ```console\n     sudo apt-get install libocxl-dev # for Ubuntu\n     sudo yum install libocxl-devel   # for RHEL\n     ```\n\n# Quick Start, Step 1: Simulate and Build FPGA on x86:\n * Clone OpenCAPI Simulation Engine and OC-Accel framework\n   ```console\n   git clone https://github.com/OpenCAPI/ocse.git\n   git clone https://github.com/OpenCAPI/oc-accel.git\n   cd oc-accel\n   make snap_config  ## this uses an opensource Kconfig menu\n   ```\n * In the menu: \n    * Select a card and an example (eg: hls_helloworld_1024) to test (use space bar)\n    * Exit the menu\n * Now run a simulation on X86 with default xsim simulator\n   ```console\n   make sim     ## (or make sim_tmux if no xterm available)\n   ```\n * In the terminal run:(stay in the current default directory) \n   ```console\n   snap_helloworld_1024 # the default help will propose the simulation example \n   ```\n * Run the proposed test and check it passes ok\n * To generate the flash content run:\n   ```console\n   make image\n   ```\n This produces a .bin file (it is the full description of the FPGA content) to be loaded in memory of the chosen OC card plugged in a POWER9 server.\n File is located in ~/oc-accel/hardware/build/Images/\n\n# Quick Start, Step 2: Program and Test on POWER9 server:\n* Card flash programming:\n     * Card is new : Check card supplier procedure. Some allow PCIe flash programming, other require JTAG probe.\n     * Card is already programmed with a previous OC binary:\n        * Transfer the .bin file into the POWER server by any mean (scp, ftp, ...)\n        * Use OpenCAPI Utils tools to load the oc_date_XX_hls_helloworld_1024_YY_OC-card_YY.bin file.\n           ```console\n           sudo git clone https://github.com/OpenCAPI/oc-utils.git\n           sudo make install # default installation\n           ```\n        * Flash the card memory.\n          ```console\n          sudo oc-flash-script oc_date_XX_hls_helloworld_1024_YY_OC-card_YY.bin\n          ```\n* Install oc-accel on the POWER server and compile code:\n  ```console\n  git clone https://github.com/OpenCAPI/oc-accel.git\n  cd oc-accel\n  make all\n  ```\n* Run the default test:\n  ```console\n  ./actions/hls_helloworld_1024/tests/hw_test.sh\n  ```\n* Check results\n\n# Contributing\nThis is an open-source project. We greatly appreciate your contributions and collaboration.\nBefore contributing to this project, please read and agree to the rules in\n* [CONTRIBUTING.md](CONTRIBUTING.md)\n\nTo simplify the sign-off, you may want to create a \".gitconfig\" file in you home by executing:\n```\n$ git config --global user.name \"John Doe\"\n$ git config --global user.email johndoe@example.com\n```\nThen, for every commit, use `git commit -s` to add the \"Signed-off by ...\" message.\n\nBy default the git repository is read-only. Users can fork the snap repository, make the changes there and issue a pull request.\nEven members with write access to this repository can't commit directly into the protected master branch. To contribute changes, please create a branch, make the changes there and issue a pull request.\n\nPull requests to merge into the master branch must be reviewed before they will be merged.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FOpenCAPI%2Foc-accel","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FOpenCAPI%2Foc-accel","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FOpenCAPI%2Foc-accel/lists"}