meta-intel-qat
==============

This README file contains information on adding and building
meta-intel-qat layer.  Please see the corresponding sections below
for details.


Yocto Project Compatible
========================

This layer are compatible with the Yocto Project
as per the requirements listed here:

  https://www.yoctoproject.org/webform/yocto-project-compatible-registration


Supported QAT Version
======================

This layer provides the following QuickAssist Technology Software with their
corresponding supported hardware

  1) QATmux.L.2.6.0-60 (qat16) - Intel Communication Chipset 8925 to 8955 Series
  2) QAT1.7.L.4.7.0-00006 (qat17) - Intel QAT HW version 1.7

For additional information for these QAT software and documentation, please go
to https://01.org/intel-quickassist-technology


Additional QAT Features
=======================

Apart from the QAT Software Packages, this layer includes recipes for several
other software necessary for the QAT on various acceleration tasks

  1) QAT Zlib Compression Shim Layer version 0.4.7-002 for QATmux.L.2.6.0-60
  2) QAT Zlib Compression Shim Layer version 0.4.10-003 for QAT1.7.L.4.7.0-00006

Ensure the correct QAT version for your platform, refer to "Supported QAT Version"
section above for correct qat16 or qat17 to be used in your build conf.


Dependencies
============

This layer depends on:

  URI: git://git.openembedded.org/bitbake
  branch: 1.38

  URI: git://git.openembedded.org/openembedded-core
  layers: meta
  branch: sumo


Guidelines for submitting patches
====================================

Please submit any patches against meta-intel-qat to the meta-intel-qat
mailing list (meta-intel@yoctoproject.org).  Also, if your patches are
available via a public git repository, please also include a URL to
the repo and branch containing your patches as that makes it easier
for maintainers to grab and test your patches.

There are patch submission scripts available that will, among other
things, automatically include the repo URL and branch as mentioned.
Please see the Yocto Project Development Manual sections entitled
'Using Scripts to Push a Change Upstream and Request a Pull' and
'Using Email to Submit a Patch' for details.

Regardless of how you submit a patch or patchset, the patches should
at minimum follow the suggestions outlined in the 'Submitting a Change
to the Yocto Project' section in the Yocto Project Development Manual.
Specifically, they should:

  - Include a 'Signed-off-by:' line.  A commit can't legally be pulled
    in without this.

  - Provide a single-line, short summary of the change.  This short
    description should be prefixed by the BSP or recipe name, as
    appropriate, followed by a colon.  Capitalize the first character
    of the summary (following the colon).

  - For the body of the commit message, provide detailed information
    that describes what you changed, why you made the change, and the
    approach you used.

  - If the change addresses a specific bug or issue that is associated
    with a bug-tracking ID, include a reference to that ID in your
    detailed description in the following format: [YOCTO #<bug-id>].

  - Pay attention to line length - please don't allow any particular
    line in the commit message to stretch past 72 characters.

  - For any non-trivial patch, provide information about how you
    tested the patch, and for any non-trivial or non-obvious testing
    setup, provide details of that setup.

Doing a quick 'git log' in meta-intel-qat will provide you with many
examples of good example commits if you have questions about any
aspect of the preferred format.

The meta-intel-qat maintainers will do their best to review and/or pull in
a patch or patchset within 24 hours of the time it was posted.  For
larger and/or more involved patches and patchsets, the review process
may take longer.