mirrors/poky
1
0
Fork 0
mirror of https://git.yoctoproject.org/poky synced 2026-01-29 21:08:42 +01:00
Code Issues Packages Projects Releases Wiki Activity

documentation/bsp-guide/bsp.xml: Patch applied for Licensing

Browse Source 
"The LICENSE_FLAGS mechanism can now be used to meet the special
license requirements needed by some BSPs.  Update the documentation to
reflect the current BSP licensing mechanisms.

Also add a new blurb about the time-limited kernel."

                                  - Tom Zanussi

I applied this patch verbatim and will check and clean up text
as needed.

(From yocto-docs rev: d05a7ddbc0d6017e5a8be2b3e0117f53e30a204b)

Signed-off-by: Tom Zanussi <tom.zanussi@intel.com>
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Tom Zanussi
2012-03-22 07:20:52 -06:00
committed by Richard Purdie
parent 9332e39d86
commit 9d2974a31b
1 changed files with 93 additions and 103 deletions
Download Patch File Download Diff File Expand all files Collapse all files

196
documentation/bsp-guide/bsp.xml
View File

@@ -656,135 +656,125 @@
</section>
</section>
<section id='bsp-click-through-licensing'>
<title>BSP 'Click-Through' Licensing Procedure</title>
<note> This section describes how
click-through licensing is expected to work.
Currently, this functionality is not yet implemented.
</note>
<section id='bsp-licensing'>
<title>BSP Licensing Considerations</title>
<para>
In some cases, a BSP contains separately licensed IP
(Intellectual Property) for a component that imposes
upon the user a requirement to accept the terms of a
'click-through' license.
Once the license is accepted the
Yocto Project build system can then build and include the
corresponding component in the final BSP image.
Some affected components might be essential to the normal
functioning of the system and have no 'free' replacement
(i.e. the resulting system would be non-functional
without them).
On the other hand, other components might be simply
'good-to-have' or purely elective, or if essential
nonetheless have a 'free' (possibly less-capable)
version that could be used as a in the BSP recipe.
(Intellectual Property) for a component or components
that impose upon the user a requirement to accept the
terms of a commercial or other type of license that
requires some kind of explicit EULA (End User License
Agreement). Once the license is accepted the Yocto
Project build system can then build and include the
corresponding component in the final BSP image, or if
the BSP is available in the form of an already built
image, the user will be able to download the image after
agreeing to the license or EULA.
</para>
<para>
Some affected components might be essential to the
normal functioning of the system and have no 'free'
replacement (i.e. the resulting system would be
non-functional without them). On the other hand, other
components might be simply 'good-to-have' or purely
elective, or if essential nonetheless have a 'free'
(possibly less-capable) version that could be used as a
in the BSP recipe.
</para>
<para>
For cases where you can substitute something and still maintain functionality,
the Yocto Project website's
<ulink url='&YOCTO_HOME_URL;/download/all?keys=&amp;download_type=1&amp;download_version='>BSP Download Page</ulink>
makes available 'de-featured' BSPs that are completely free of any IP encumbrances.
For these cases you can use the substitution directly and without any further licensing
requirements.
If present, these fully 'de-featured' BSPs are named appropriately different
as compared to the names of the respective encumbered BSPs.
If available, these substitutions are the simplest and most preferred options.
This, of course, assumes the resulting functionality meets requirements.
For cases where you can substitute something and still
maintain functionality, the Yocto Project website's
<ulink url='&YOCTO_HOME_URL;/download/all?keys=&amp;download_type=1&amp;download_version='>BSP
Download Page</ulink> makes available 'de-featured' BSPs
that are completely free of any IP encumbrances. For
these cases you can use the substitution directly and
without any further licensing requirements. If present,
these fully 'de-featured' BSPs are named appropriately
different as compared to the names of the respective
encumbered BSPs. If available, these substitutions are
the simplest and most preferred options. This, of
course, assumes the resulting functionality meets
requirements.
</para>
<para>
If however, a non-encumbered version is unavailable or the 'free' version
would provide unsuitable functionality or quality, you can use
an encumbered version.
If however, a non-encumbered version is unavailable or
the 'free' version would provide unsuitable
functionality or quality, you can use an encumbered
version.
</para>
<para>
Several methods exist within the Yocto Project build system to satisfy the licensing
requirements for an encumbered BSP.
The following list describes them in preferential order:
<para> A couple different methods exist within the Yocto
Project build system to satisfy the licensing
requirements for an encumbered BSP. The following list
describes them in order of preference:
</para>
<orderedlist>
<listitem>
<para>
Yocto recipes that have commercial or other types of
specially-licensed packages define a variable named
LICENSE_FLAGS. For each of those recipes, a user
can specify a matching license string in a
local.conf variable named LICENSE_FLAGS_WHITELIST.
This signifies that the user agrees to the license,
and the corresponding recipe can then be built and
included in the image. See Section 3.3.2. in The
Yocto Project Reference Manual for details on these
variables and how to make use of them.
</para>
<para>
Get a license key (or keys) for the encumbered BSP by visiting
a website and providing the name of the BSP and your email address
through a web form.
</para>
If you build as you normally would, without
specifying any recipes in the
LICENSE_FLAGS_WHITELIST, the build will stop and
provide you with the list of recipes that you've
tried to include in the image which need entries in
the LICENSE_FLAGS_WHITELIST. Once the appropriate
license flags have been entered into the whitelist,
restart the build to continue where it left off.
During the build the prompt will not appear again
since you have satisfied the requirement.
</para>
<para>
After agreeing to any applicable license terms, the
BSP key(s) will be immediately sent to the address
you gave and you can use them by specifying BSPKEY_&lt;keydomain&gt;
environment variables when building the image:
</para>
<literallayout class='monospaced'>
$ BSPKEY_&lt;keydomain&gt;=&lt;key&gt; bitbake core-image-sato
</literallayout>
<para>
These steps allow the encumbered image to be built
with no change at all to the normal build process.
</para>
<para>
Equivalently and probably more conveniently, a line
for each key can instead be put into the user's
<filename>local.conf</filename> file found in the Yocto Project file's
build directory.
</para>
<para>
The &lt;keydomain&gt; component of the
BSPKEY_&lt;keydomain&gt; is required because there
might be multiple licenses in effect for a given BSP.
In such cases, a given &lt;keydomain&gt; corresponds to
a particular license. In order for an encumbered
BSP that encompasses multiple key domains to be built
successfully, a &lt;keydomain&gt; entry for each
applicable license must be present in <filename>local.conf</filename> or
supplied on the command-line.
Once the appropriate license flags are whitelisted
in the LICENSE_FLAGS_WHITELIST variable, the
encumbered image can be built with no change at all
to the normal build process.
</para>
</listitem>
<listitem>
<para>
Do nothing - build as you normally would.
When a license is needed the build will stop and prompt you with instructions.
Follow the license prompts that originate from the
encumbered BSP.
These prompts usually take the form of instructions
needed to manually fetch the encumbered package(s)
and md5 sums into the required directory
(e.g. the <filename>yocto/build/downloads</filename>).
Once the manual package fetch has been
completed, restart the build to continue where
it left off.
During the build the prompt will not appear again since you have satisfied the
requirement.
</para>
</listitem>
<listitem>
<para>
Get a full-featured BSP recipe rather than a key.
You can do this by visiting the Yocto Project website's
<ulink url='&YOCTO_HOME_URL;/download'>Download</ulink> page and
clicking on "BSP Downloads".
BSP tarballs that have proprietary information can be downloaded after agreeing
to licensing requirements as part of the download process.
Obtaining the code this way allows you to build an encumbered image with
no changes at all as compared to the normal build.
Get a pre-built version of the BSP. You can do this
by visiting the Yocto Project website's
<ulink url='&YOCTO_HOME_URL;/download'>Download</ulink>
page and clicking on "BSP Downloads". BSP tarballs
that contain proprietary components can be
downloaded after agreeing to the licensing
requirements of each of the individually encumbered
packages as part of the download process. Obtaining
the BSP this way allows you to access an encumbered
image immediately after agreeing to the
click-through license agreements presented by the
website. Note that if you want to build the image
yourself using the recipes contained within the BSP
tarball, you will still need to create an
appropriate LICENSE_FLAGS_WHITELIST to match the
encumbered recipes in the BSP.
</para>
</listitem>
</orderedlist>
<para>
Note that the third method is also the only option available
when downloading pre-compiled images generated from non-free BSPs.
Those images are likewise available at from the Yocto Project website.
Note also that the pre-compiled images are bundled with
a time-limited kernel which will run for only a
predetermined amount of time (10 days) before it forces
the system to reboot. This is meant as a discouragement
to directly redistributing the image as-is, and means
that you'll have to eventually rebuild the image if you
want to remove that restriction.
</para>
</section>