You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
115 lines
5.2 KiB
XML
115 lines
5.2 KiB
XML
<?xml version="1.0" encoding="UTF-8"?>
|
|
<!--
|
|
Copyright (c) 2016 OpenPOWER Foundation
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
you may not use this file except in compliance with the License.
|
|
You may obtain a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
|
|
-->
|
|
|
|
<!-- The following entity variable is used to reflect the version of the
|
|
template document master used for building a document. This value
|
|
should be set by copy of the of template used to create a new
|
|
document and should not be changed. Use of this value is in
|
|
in the Abstract section in this file. -->
|
|
<!DOCTYPE book [
|
|
<!ENTITY template_version "1.0.0">
|
|
]>
|
|
|
|
<book xmlns="http://docbook.org/ns/docbook"
|
|
xmlns:xi="http://www.w3.org/2001/XInclude"
|
|
xmlns:xlink="http://www.w3.org/1999/xlink"
|
|
version="5.0"
|
|
xml:id="bk_main">
|
|
|
|
<!-- TODO: Pick a Title for the new document -->
|
|
<title>Enable new FPGA cards for CAPI2.0</title>
|
|
<!-- TODO: Either add a subtitle or remove the following line -->
|
|
<subtitle>BSP and SNAP</subtitle>
|
|
|
|
<info>
|
|
<author>
|
|
<!-- TODO: Set the correct Work Group Name and email id for WG Chair -->
|
|
<personname>
|
|
Acceleration Workgroup
|
|
</personname>
|
|
<email>aclwg-chair@openpowerfoundation.org</email>
|
|
<affiliation>
|
|
<orgname>OpenPower Foundation</orgname>
|
|
</affiliation>
|
|
</author>
|
|
<copyright>
|
|
<year>2018</year>
|
|
<holder>OpenPOWER Foundation</holder>
|
|
</copyright>
|
|
<!-- TODO: Set the correct document releaseinfo -->
|
|
<releaseinfo>Revision 1.0_pre1</releaseinfo>
|
|
<productname>OpenPOWER</productname>
|
|
<pubdate/>
|
|
|
|
<legalnotice role="apache2">
|
|
<!--legalnotice role="opfExternal"-->
|
|
|
|
<annotation>
|
|
<remark>Copyright details are filled in by the template.</remark>
|
|
</annotation>
|
|
</legalnotice>
|
|
|
|
<!-- TODO: Update the following text with the correct document description (first paragraph),
|
|
Work Group name, and Work Product track (both in second paragraph). -->
|
|
<abstract>
|
|
<!-- TODO: remove "phrase" tags (2) and text below and insert proper information -->
|
|
<para>The purpose of this document is to describe how to enable a new customer card on CAPI SNAP framework. SNAP is a open-sourced programming framework for FPGA Acclerations. Its homepage is <link xlink:href="https://github.com/open-power/snap">https://github.com/open-power/snap</link>. With it, you can develop accelerations with Power and CAPI technology easily.</para>
|
|
|
|
<para>This document describes the flow and steps to enable a new PCIe FPGA card to have or CAPI2.0 capability. Firstly, please check whether your PCIe FPGA card is listed on today's "SNAP enabled cards" (On the homepage README of <link xlink:href="https://github.com/open-power/snap">SNAP Github</link>), if not, this document will guide you on <emphasis role="bold">how to enable it</emphasis>. Since all of the project files are open-sourced, you can create a Github repository fork, and create a new board support package (BSP) and walk through the entire working flow to enable SNAP. </para>
|
|
|
|
<para>This document is a Standard Track, Workgroup Specification work product owned by the Acceleration Workgroup and handled in compliance with the requirements outlined in the
|
|
<citetitle>OpenPOWER Foundation Work Group (WG) Process</citetitle> document. It was
|
|
created using the <citetitle>Master Template Guide</citetitle> version &template_version;.
|
|
Comments, questions, etc. can be submitted to the
|
|
public mailing list for the parent specification at
|
|
<email>tbd@mailinglist.openpowerfoundation.org</email>.</para>
|
|
</abstract>
|
|
|
|
<revhistory>
|
|
<revision>
|
|
<!-- TODO: Set correct date and remove "phrase" tags (1) and text below and insert proper information -->
|
|
<date>2019-03-29</date>
|
|
<revdescription>
|
|
<itemizedlist spacing="compact">
|
|
<listitem>
|
|
<para>Start from the original Word document</para>
|
|
</listitem>
|
|
</itemizedlist>
|
|
</revdescription>
|
|
</revision>
|
|
</revhistory>
|
|
</info>
|
|
|
|
<!-- The ch_preface.xml file is required by all documents -->
|
|
<xi:include href="../../Docs-Master/common/ch_preface.xml"/>
|
|
|
|
<!-- TODO: Add your chapter heading files here. Remove both files and insert your own. -->
|
|
<!-- See the template document for naming conventions and location of files. -->
|
|
<xi:include href="ch_introduction.xml"/>
|
|
<xi:include href="ch_capi20_bsp.xml"/>
|
|
<xi:include href="ch_capi20_snap.xml"/>
|
|
|
|
<!-- The app_foundation.xml appendix file is required by all documents. -->
|
|
<xi:include href="../../Docs-Master/common/app_foundation.xml"/>
|
|
|
|
<!-- TODO: The following template document may be modified to create additional appendices as needed. -->
|
|
<!-- <xi:include href="app_template.xml"/>
|
|
-->
|
|
|
|
</book>
|