boot-architecture May 2018

boot-architecture@lists.linaro.org

25 participants
38 discussions

Re: [Arm.ebbr-discuss] [PATCH] Move citations to the end of the document

by Grant Likely

On 18/05/2018 14:18, Tom Rini wrote: > On Fri, May 18, 2018 at 02:06:08PM +0100, Grant Likely wrote: > >> Use reStructuredText citation markup to capture all referenced >> documents. Sphinx will take care of creating a table of references at >> the end of the document. >> >> Fixes #6 >> Signed-off-by: Grant Likely <grant.likely(a)arm.com> > [snip] >> @@ -132,22 +115,11 @@ This document defines the boot and runtime services that are expected by an >> Operating System or hypervisor, for an ARM embedded device, which follows the >> UEFI specification. >> >> -This document references the following specification and versions: >> - >> - UEFI 2.7 >> - Published June 2017, includes the AArch64 bindings. >> - > > Is it clear enough when rendering the final document that here we don't > need a link down to the UEFI reference? Not sure what you mean. Can you elaborate? I do think the introduction chapter needs to be reworked anyway to talk about standardizing the firmware interface. It too quickly jumps to "when UEFI is chosen", when what I'd rather it present is "here is a standardized platform taylored to embedded systems"... and then get to UEFI is part of that standard. (it isn't about chosing UEFI; it is about choosing a standard platform) > >> This specification defines the boot and runtime services for a physical system, >> including services that are required for virtualization. >> It does not define a standardized abstract virtual machine view for a Guest >> Operating System. >> >> -When present with in a system, this document makes additional references to the >> -Power State Coordination Interface: >> - >> - PSCI 1.1 >> - Published April 2017. >> - > [snip] >> @@ -306,9 +278,10 @@ command: >> >> - EfiWarmReset() >> >> -.. note:: When Runtime Services and PSCI co-exist, it is anticipated that >> - Operating System calls to reset the system will go via Runtime Services and >> - not directly to PSCI. >> +.. note:: On platforms implementing the Power State Coordination Interface >> + specification[PSCI_], it is still required that EBBR compliant >> + Operating Systems calls to reset the system will go via Runtime Services >> + and not directly to PSCI. >> >> Set Variable >> ------------ > > Is all of the above equivalent in terms of talking about PSCI? Thanks! Ummm, yes? But I'm not sure that I understand what you're asking. Thanks for the reviews on all the other patches. g.

5 years, 11 months

Multi-cpu boot protocol?

by Grant Likely

I'm adding some EBBR text around the CPU state at boot and I've lost track of what is being done for multicore bringup. What is the current state-of-the-art for multicore boot protocol when PSCI isn't available? SBBR allows for the MP Boot Protocol; with the intend of phasing it out: https://acpica.org/sites/acpica/files/MP%20Startup%20for%20ARM%20platforms.… The kernel documents the spin table method: https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux-stable.git/tre… What are the cool kids currently doing here? g. IMPORTANT NOTICE: The contents of this email and any attachments are confidential and may also be privileged. If you are not the intended recipient, please notify the sender immediately and do not disclose the contents to any other person, use it for any purpose, or store or copy the information in any medium. Thank you.

5 years, 11 months

Re: [Arm.ebbr-discuss] [PATCH] Move contributing details to CONTRIBUTING file

by Daniel Thompson

On Wed, May 16, 2018 at 03:46:06PM +0100, Grant Likely wrote: > To match convention used by many projects on GitHub, put the > contribution details into a separate file instead of the top level > README. Also tighten up some of the language around contributing to be > clearer. > > Suggested-by: Jilayne Lovejoy <jilayne.lovejoy(a)arm.com> > Signed-off-by: Grant Likely <grant.likely(a)arm.com> > --- > CONTRIBUTING.rst | 70 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ > Makefile | 2 +- > README.rst | 67 ++++------------------------------------------------- > source/ebbr.rst | 4 ++-- > 4 files changed, 78 insertions(+), 65 deletions(-) > create mode 100644 CONTRIBUTING.rst > > diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst > new file mode 100644 > index 0000000..e101e5f > --- /dev/null > +++ b/CONTRIBUTING.rst > @@ -0,0 +1,70 @@ > +Contributing > +============ > + > +Master copy of this project is hosted on GitHub: > +https://github.com/ARM-software/ebbr > + > +Anyone may contribute to the EBBR project. > +Contributions are licensed under CC-BY-SA-4.0_ and must be made with a > +Developer Certificate of Origin (DCO_) attestation as described below. > + > +EBBR discussion uses the boot-architecture_ and arm.ebbr-discuss mailing lists. > +The 'official' list is arm.ebbr-discuss, but the list archives are not > +yet public, so boot-architecture_ is being used to keep everything in > +the open. > + > +* boot-architechture(a)lists.linaro.org That is not how you spell "architecture" (as I just discovered when I copy 'n pasted from the current README). Once that is fixed: Reviewed-by: Daniel Thompson <daniel.thompson(a)linaro.org> Daniel. > +* arm.ebbr-discuss(a)arm.com > + > +Past discussions can be found in the boot-architecture-archive_. > + > +We use the IRC channel `#ebbr`_ on OFTC_. > + > +DCO Attestation > +--------------- > + > +To help track the origin of contributions, this project uses the same > +DCO_ "sign-off" process as used by the Linux kernel. > +The sign-off is a simple line at the end of the explanation for the > +patch, which certifies that you wrote it or otherwise have the right to > +pass it on as an open-source patch. > +The rules are pretty simple: if you can certify the below: > + > +Developer's Certificate of Origin 1.1 > +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ > + > +By making a contribution to this project, I certify that: > + > + (a) The contribution was created in whole or in part by me and I > + have the right to submit it under the open source license > + indicated in the file; or > + > + (b) The contribution is based upon previous work that, to the best > + of my knowledge, is covered under an appropriate open source > + license and I have the right under that license to submit that > + work with modifications, whether created in whole or in part > + by me, under the same open source license (unless I am > + permitted to submit under a different license), as indicated > + in the file; or > + > + (c) The contribution was provided directly to me by some other > + person who certified (a), (b) or (c) and I have not modified > + it. > + > + (d) I understand and agree that this project and the contribution > + are public and that a record of the contribution (including all > + personal information I submit with it, including my sign-off) is > + maintained indefinitely and may be redistributed consistent with > + this project or the open source license(s) involved. > + > +then you just add a line saying:: > + > + Signed-off-by: Random J Developer <random(a)developer.example.org> > + > +.. _CC-BY-SA-4.0: LICENSE > +.. _#ebbr: https://webchat.oftc.net/?channels=%23ebbr&uio=d4 > +.. _OFTC: https://www.oftc.net/ > +.. _DCO: https://developercertificate.org/ > +.. _boot-architecture: https://lists.linaro.org/mailman/listinfo/boot-architecture > +.. _boot-architecture-archive: https://lists.linaro.org/pipermail/boot-architecture > + > diff --git a/Makefile b/Makefile > index 91bb4be..46ed82a 100644 > --- a/Makefile > +++ b/Makefile > @@ -17,4 +17,4 @@ help: > # Catch-all target: route all unknown targets to Sphinx using the new > # "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). > %: Makefile > - @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) > \ No newline at end of file > + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) > diff --git a/README.rst b/README.rst > index 57fac8f..67c7e85 100644 > --- a/README.rst > +++ b/README.rst > @@ -73,79 +73,22 @@ License > ======= > > This work is licensed under the Creative Commons Attribution-ShareAlike 4.0 > -International License. To view a copy of this license, visit > +International License (CC-BY-SA-4.0). To view a copy of this license, visit > http://creativecommons.org/licenses/by-sa/4.0/ or send a letter to > Creative Commons, PO Box 1866, Mountain View, CA 94042, USA. > > +Contributions are accepted under the same with sign-off under the Developer's > +Certificate of Origin. For more on contributing to EBBR, see CONTRIBUTING.rst_. > + > A copy of the license is included in the LICENSE_ file. > > .. image:: https://i.creativecommons.org/l/by-sa/4.0/88x31.png > :target: http://creativecommons.org/licenses/by-sa/4.0/ > :alt: Creative Commons License > > +.. _CONTRIBUTING.rst: ./CONTRIBUTING.rst > .. _LICENSE: ./LICENSE > > -Contributing > -============ > - > -Master copy of this project is hosted on GitHub: > -https://github.com/ARM-software/ebbr > - > -Anyone may contribute to the EBBR project. EBBR discussion uses the > -boot-architecture_ and arm.ebbr-discuss mailing lists. > -The 'official' list is arm.ebbr-discuss, but the list archives are not > -yet public, so boot-architecture_ is being used to keep everything in > -the open. > - > -* boot-architechture(a)lists.linaro.org > -* arm.ebbr-discuss(a)arm.com > - > -Past discussions can be found in the boot-architecture-archive_. > - > -To help track the origin of contributions, this project uses the same > -DCO_ "sign-off" process as used by the Linux kernel. > -The sign-off is a simple line at the end of the explanation for the > -patch, which certifies that you wrote it or otherwise have the right to > -pass it on as an open-source patch. The rules are pretty simple: if you > -can certify the below: > - > -Developer's Certificate of Origin 1.1 > -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ > - > -By making a contribution to this project, I certify that: > - > - (a) The contribution was created in whole or in part by me and I > - have the right to submit it under the open source license > - indicated in the file; or > - > - (b) The contribution is based upon previous work that, to the best > - of my knowledge, is covered under an appropriate open source > - license and I have the right under that license to submit that > - work with modifications, whether created in whole or in part > - by me, under the same open source license (unless I am > - permitted to submit under a different license), as indicated > - in the file; or > - > - (c) The contribution was provided directly to me by some other > - person who certified (a), (b) or (c) and I have not modified > - it. > - > - (d) I understand and agree that this project and the contribution > - are public and that a record of the contribution (including all > - personal information I submit with it, including my sign-off) is > - maintained indefinitely and may be redistributed consistent with > - this project or the open source license(s) involved. > - > -then you just add a line saying:: > - > - Signed-off-by: Random J Developer <random(a)developer.example.org> > - > -IRC Channel: ``#ebbr`` on ofct > - > -.. _DCO: https://developercertificate.org/ > -.. _boot-architecture: https://lists.linaro.org/mailman/listinfo/boot-architecture > -.. _boot-architecture-archive: https://lists.linaro.org/pipermail/boot-architecture > - > Writers Guide > ============= > > diff --git a/source/ebbr.rst b/source/ebbr.rst > index 414e3af..4269b49 100644 > --- a/source/ebbr.rst > +++ b/source/ebbr.rst > @@ -1,12 +1,12 @@ > .. EBBR Source Document > - Copyright Arm Ltd. 2018 > + Copyright Arm Limited, 2018 > SPDX-License-Identifier: CC-BY-SA-4.0 > > #################################################### > Embedded Base Boot Requirements (EBBR) Specification > #################################################### > > -Copyright © 2017-2018 Arm Ltd and Contributors. > +Copyright © 2017-2018 Arm Limited and Contributors. > > This work is licensed under the Creative Commons Attribution-ShareAlike 4.0 > International License. To view a copy of this license, visit > -- > 2.13.0 > > _______________________________________________ > Arm.ebbr-discuss mailing list > Arm.ebbr-discuss(a)arm.com

5 years, 11 months

Assigning EBBR issues

by Grant Likely

On the weekly call today I suggested for people to assign issues to themselves if they wanted to take it on. Turns out GitHub doesn't allow that unless you've got write access to the project. So, if you want to take on an issue, add a comment saying so and I'll send you an invite to join the project. Once you've accepted the invite I can assign issues to you. g. IMPORTANT NOTICE: The contents of this email and any attachments are confidential and may also be privileged. If you are not the intended recipient, please notify the sender immediately and do not disclose the contents to any other person, use it for any purpose, or store or copy the information in any medium. Thank you.

5 years, 11 months

[PATCH] Move contributing details to CONTRIBUTING file

by Grant Likely

To match convention used by many projects on GitHub, put the contribution details into a separate file instead of the top level README. Also tighten up some of the language around contributing to be clearer. Suggested-by: Jilayne Lovejoy <jilayne.lovejoy(a)arm.com> Signed-off-by: Grant Likely <grant.likely(a)arm.com> --- CONTRIBUTING.rst | 70 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Makefile | 2 +- README.rst | 67 ++++------------------------------------------------- source/ebbr.rst | 4 ++-- 4 files changed, 78 insertions(+), 65 deletions(-) create mode 100644 CONTRIBUTING.rst diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst new file mode 100644 index 0000000..e101e5f --- /dev/null +++ b/CONTRIBUTING.rst @@ -0,0 +1,70 @@ +Contributing +============ + +Master copy of this project is hosted on GitHub: +https://github.com/ARM-software/ebbr + +Anyone may contribute to the EBBR project. +Contributions are licensed under CC-BY-SA-4.0_ and must be made with a +Developer Certificate of Origin (DCO_) attestation as described below. + +EBBR discussion uses the boot-architecture_ and arm.ebbr-discuss mailing lists. +The 'official' list is arm.ebbr-discuss, but the list archives are not +yet public, so boot-architecture_ is being used to keep everything in +the open. + +* boot-architechture(a)lists.linaro.org +* arm.ebbr-discuss(a)arm.com + +Past discussions can be found in the boot-architecture-archive_. + +We use the IRC channel `#ebbr`_ on OFTC_. + +DCO Attestation +--------------- + +To help track the origin of contributions, this project uses the same +DCO_ "sign-off" process as used by the Linux kernel. +The sign-off is a simple line at the end of the explanation for the +patch, which certifies that you wrote it or otherwise have the right to +pass it on as an open-source patch. +The rules are pretty simple: if you can certify the below: + +Developer's Certificate of Origin 1.1 +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +By making a contribution to this project, I certify that: + + (a) The contribution was created in whole or in part by me and I + have the right to submit it under the open source license + indicated in the file; or + + (b) The contribution is based upon previous work that, to the best + of my knowledge, is covered under an appropriate open source + license and I have the right under that license to submit that + work with modifications, whether created in whole or in part + by me, under the same open source license (unless I am + permitted to submit under a different license), as indicated + in the file; or + + (c) The contribution was provided directly to me by some other + person who certified (a), (b) or (c) and I have not modified + it. + + (d) I understand and agree that this project and the contribution + are public and that a record of the contribution (including all + personal information I submit with it, including my sign-off) is + maintained indefinitely and may be redistributed consistent with + this project or the open source license(s) involved. + +then you just add a line saying:: + + Signed-off-by: Random J Developer <random(a)developer.example.org> + +.. _CC-BY-SA-4.0: LICENSE +.. _#ebbr: https://webchat.oftc.net/?channels=%23ebbr&uio=d4 +.. _OFTC: https://www.oftc.net/ +.. _DCO: https://developercertificate.org/ +.. _boot-architecture: https://lists.linaro.org/mailman/listinfo/boot-architecture +.. _boot-architecture-archive: https://lists.linaro.org/pipermail/boot-architecture + diff --git a/Makefile b/Makefile index 91bb4be..46ed82a 100644 --- a/Makefile +++ b/Makefile @@ -17,4 +17,4 @@ help: # Catch-all target: route all unknown targets to Sphinx using the new # "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). %: Makefile - @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) \ No newline at end of file + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/README.rst b/README.rst index 57fac8f..67c7e85 100644 --- a/README.rst +++ b/README.rst @@ -73,79 +73,22 @@ License ======= This work is licensed under the Creative Commons Attribution-ShareAlike 4.0 -International License. To view a copy of this license, visit +International License (CC-BY-SA-4.0). To view a copy of this license, visit http://creativecommons.org/licenses/by-sa/4.0/ or send a letter to Creative Commons, PO Box 1866, Mountain View, CA 94042, USA. +Contributions are accepted under the same with sign-off under the Developer's +Certificate of Origin. For more on contributing to EBBR, see CONTRIBUTING.rst_. + A copy of the license is included in the LICENSE_ file. .. image:: https://i.creativecommons.org/l/by-sa/4.0/88x31.png :target: http://creativecommons.org/licenses/by-sa/4.0/ :alt: Creative Commons License +.. _CONTRIBUTING.rst: ./CONTRIBUTING.rst .. _LICENSE: ./LICENSE -Contributing -============ - -Master copy of this project is hosted on GitHub: -https://github.com/ARM-software/ebbr - -Anyone may contribute to the EBBR project. EBBR discussion uses the -boot-architecture_ and arm.ebbr-discuss mailing lists. -The 'official' list is arm.ebbr-discuss, but the list archives are not -yet public, so boot-architecture_ is being used to keep everything in -the open. - -* boot-architechture(a)lists.linaro.org -* arm.ebbr-discuss(a)arm.com - -Past discussions can be found in the boot-architecture-archive_. - -To help track the origin of contributions, this project uses the same -DCO_ "sign-off" process as used by the Linux kernel. -The sign-off is a simple line at the end of the explanation for the -patch, which certifies that you wrote it or otherwise have the right to -pass it on as an open-source patch. The rules are pretty simple: if you -can certify the below: - -Developer's Certificate of Origin 1.1 -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -By making a contribution to this project, I certify that: - - (a) The contribution was created in whole or in part by me and I - have the right to submit it under the open source license - indicated in the file; or - - (b) The contribution is based upon previous work that, to the best - of my knowledge, is covered under an appropriate open source - license and I have the right under that license to submit that - work with modifications, whether created in whole or in part - by me, under the same open source license (unless I am - permitted to submit under a different license), as indicated - in the file; or - - (c) The contribution was provided directly to me by some other - person who certified (a), (b) or (c) and I have not modified - it. - - (d) I understand and agree that this project and the contribution - are public and that a record of the contribution (including all - personal information I submit with it, including my sign-off) is - maintained indefinitely and may be redistributed consistent with - this project or the open source license(s) involved. - -then you just add a line saying:: - - Signed-off-by: Random J Developer <random(a)developer.example.org> - -IRC Channel: ``#ebbr`` on ofct - -.. _DCO: https://developercertificate.org/ -.. _boot-architecture: https://lists.linaro.org/mailman/listinfo/boot-architecture -.. _boot-architecture-archive: https://lists.linaro.org/pipermail/boot-architecture - Writers Guide ============= diff --git a/source/ebbr.rst b/source/ebbr.rst index 414e3af..4269b49 100644 --- a/source/ebbr.rst +++ b/source/ebbr.rst @@ -1,12 +1,12 @@ .. EBBR Source Document - Copyright Arm Ltd. 2018 + Copyright Arm Limited, 2018 SPDX-License-Identifier: CC-BY-SA-4.0 #################################################### Embedded Base Boot Requirements (EBBR) Specification #################################################### -Copyright © 2017-2018 Arm Ltd and Contributors. +Copyright © 2017-2018 Arm Limited and Contributors. This work is licensed under the Creative Commons Attribution-ShareAlike 4.0 International License. To view a copy of this license, visit -- 2.13.0

5 years, 11 months

[PATCH 2/2] Add PDF output

by Grant Likely

Use Sphinx-doc to generate PDF output from the source text. With Sphinx installed, a PDF version of the document can be generated by typing: 'make latexpdf' Signed-off-by: Grant Likely <grant.likely(a)arm.com> --- .gitignore | 1 + Makefile | 20 +++++++ README.rst | 56 +++++++++++++++++++ source/conf.py | 163 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ source/ebbr.rst | 22 ++++++-- 5 files changed, 259 insertions(+), 3 deletions(-) create mode 100644 .gitignore create mode 100644 Makefile create mode 100644 source/conf.py diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..796b96d --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +/build diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..91bb4be --- /dev/null +++ b/Makefile @@ -0,0 +1,20 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +SPHINXPROJ = EBBR +SOURCEDIR = source +BUILDDIR = build + +# Put it first so that "make" without argument is like "make help". +help: + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +.PHONY: help Makefile + +# Catch-all target: route all unknown targets to Sphinx using the new +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +%: Makefile + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) \ No newline at end of file diff --git a/README.rst b/README.rst index 1babcf4..57fac8f 100644 --- a/README.rst +++ b/README.rst @@ -13,6 +13,62 @@ expected in September 2018. You can find the current draft text in this repository, but be aware that everything in the draft text is subject to change before an official v1.0 release is published. +Build Instructions +================== + +Requirements +^^^^^^^^^^^^ + +* Sphinx version 1.5 or later: http://sphinx-doc.org/contents.html +* LaTeX (and pdflatex, and various LaTeX packages) + +On Debian and Ubuntu +^^^^^^^^^^^^^^^^^^^^ +:: + + # apt-get install python-sphinx texlive texlive-latex-extra libalgorithm-diff-perl \ + texlive-humanities texlive-generic-recommended texlive-generic-extra + +If the version of python-sphinx installed is too old, then an additional +new version can be installed with the Python package installer:: + + $ apt-get install python-pip + $ pip install --user --upgrade Sphinx + $ export SPHINXBUILD=~/.local/bin/sphinx-build + +Export SPHINXBUILD (see above) if Sphinx was installed with pip --user, then follow Make commands below + +On Mac OS X +^^^^^^^^^^^ + +* Install MacTeX_ +* Install pip if you do not have it:: + + $ sudo easy_install pip + +* Install Sphinx:: + + $ pip install --user --upgrade Sphinx + +.. _MacTeX: http://tug.org/mactex + +Make Targets +^^^^^^^^^^^^ + +To generate PDF:: + + $ make latexpdf + +To generate hierarchy of HTML pages:: + + $ make html + +To generate a single HTML page:: + + $ make singlehtml + +Output goes in `./build` subdirectory. + License ======= diff --git a/source/conf.py b/source/conf.py new file mode 100644 index 0000000..fd4267b --- /dev/null +++ b/source/conf.py @@ -0,0 +1,163 @@ +#!/usr/bin/env python3 +# -*- coding: utf-8 -*- +# +# EBBR specification build configuration file, created by +# sphinx-quickstart on Thu May 10 18:49:38 2018. +# +# This file is execfile()d with the current directory set to its +# containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +# +# import os +# import sys +# sys.path.insert(0, os.path.abspath('.')) + +import subprocess + +# -- General configuration ------------------------------------------------ + +# If your documentation needs a minimal Sphinx version, state it here. +# +# needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = ['sphinx.ext.todo', + 'sphinx.ext.githubpages'] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +# +# source_suffix = ['.rst', '.md'] +source_suffix = '.rst' + +# The master toctree document. +master_doc = 'ebbr' + +# General information about the project. +project = 'Embedded Base Boot Requirements (EBBR) Specification' +copyright = '2018 Arm, Ltd. and Contributors' +author = 'Arm, Ltd. and Contributors' + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The short X.Y version. +try: + version = str(subprocess.check_output(["git", "describe", "--dirty"]), 'utf-8').strip() +except: + version = "unknown-rev" +# The full version, including alpha/beta/rc tags. +release = version + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = None + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This patterns also effect to html_static_path and html_extra_path +exclude_patterns = [] + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = True + + +# -- Options for HTML output ---------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +# +html_theme = 'alabaster' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +# +# html_theme_options = {} + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + + +# -- Options for HTMLHelp output ------------------------------------------ + +# Output file base name for HTML help builder. +htmlhelp_basename = 'EBBRdoc' + + +# -- Options for LaTeX output --------------------------------------------- + +latex_elements = { + # The paper size ('letterpaper' or 'a4paper'). + # + 'papersize': 'a4paper', + + # The font size ('10pt', '11pt' or '12pt'). + # + # 'pointsize': '10pt', + + # Additional stuff for the LaTeX preamble. + # + # 'preamble': '', + + # Latex figure (float) alignment + # + # 'figure_align': 'htbp', +} + +# Release numbers with a qualifier (ex. '-rc', '-pre') get a watermark. +if '-' in release: + latex_elements['preamble'] = '\\usepackage{draftwatermark}\\SetWatermarkScale{.45}\\SetWatermarkText{%s}' % (release) + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + (master_doc, 'EBBR.tex', project, author, 'manual'), +] + + +# -- Options for manual page output --------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + (master_doc, 'ebbr', project, [author], 1) +] + + +# -- Options for Texinfo output ------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + (master_doc, 'EBBR', project, author, 'EBBR', + 'One line description of project.', 'Miscellaneous'), +] + + + diff --git a/source/ebbr.rst b/source/ebbr.rst index be51f90..414e3af 100644 --- a/source/ebbr.rst +++ b/source/ebbr.rst @@ -2,8 +2,24 @@ Copyright Arm Ltd. 2018 SPDX-License-Identifier: CC-BY-SA-4.0 +#################################################### +Embedded Base Boot Requirements (EBBR) Specification +#################################################### + +Copyright © 2017-2018 Arm Ltd and Contributors. + +This work is licensed under the Creative Commons Attribution-ShareAlike 4.0 +International License. To view a copy of this license, visit +http://creativecommons.org/licenses/by-sa/4.0/ or send a letter to +Creative Commons, PO Box 1866, Mountain View, CA 94042, USA. + +.. image:: https://i.creativecommons.org/l/by-sa/4.0/88x31.png + :target: http://creativecommons.org/licenses/by-sa/4.0/ + :alt: Creative Commons License + :align: right + ******************* -ABOUT THIS DOCUMENT +About This Document ******************* Introduction @@ -439,7 +455,7 @@ APPENDIX D - Optional UEFI Protocols ******************************************* Basic Networking Support -==================== +======================== ============================================ ====== Service UEFI § @@ -453,7 +469,7 @@ EFI_MANAGED_NETWORK_SERVICE_BINDING_PROTOCOL 25.1 networking. Network Boot Protocols -==================== +====================== ========================================== ====== Service UEFI § -- 2.13.0

5 years, 11 months

[RFC PATCH] driver core: make deferring probe forever optional

by Rob Herring

Deferred probe will currently wait forever on dependent devices to probe, but sometimes a driver will never exist. It's also not always critical for a driver to exist. Platforms can rely on default configuration from the bootloader or reset defaults for things such as pinctrl and power domains. This is often the case with initial platform support until various drivers get enabled. There's at least 2 scenarios where deferred probe can render a platform broken. Both involve using a DT which has more devices and dependencies than the kernel supports. The 1st case is a driver may be disabled in the kernel config. The 2nd case is the kernel version may simply not have the dependent driver. This can happen if using a newer DT (provided by firmware perhaps) with a stable kernel version. Unfortunately, this change breaks with modules as we have no way of knowing when modules are done loading. One possibility is to make this opt in or out based on compatible strings rather than at a subsystem level. Ideally this information could be extracted automatically somehow. OTOH, maybe the lists are pretty small. There's only a handful of subsystems that can be optional, and then only so many drivers in those that can be modules (at least for pinctrl, many drivers are built-in only). Cc: Alexander Graf <agraf(a)suse.de> Signed-off-by: Rob Herring <robh(a)kernel.org> --- This patch came out of a discussion on the ARM boot-architecture list[1] about DT forwards and backwards compatibility issues. There are issues with newer DTs breaking on older, stable kernels. Some of these are difficult to solve, but cases of optional devices not having kernel support should be solvable. I tested this on a RPi3 B with the pinctrl driver forced off. With this change, the MMC/SD and UART drivers can function without the pinctrl driver. Rob [1] https://lists.linaro.org/pipermail/boot-architecture/2018-April/000466.html drivers/base/dd.c | 16 ++++++++++++++++ drivers/pinctrl/devicetree.c | 2 +- include/linux/device.h | 2 ++ 3 files changed, 19 insertions(+), 1 deletion(-) diff --git a/drivers/base/dd.c b/drivers/base/dd.c index c9f54089429b..5848808b9d7a 100644 --- a/drivers/base/dd.c +++ b/drivers/base/dd.c @@ -226,6 +226,15 @@ void device_unblock_probing(void) driver_deferred_probe_trigger(); } + +int driver_deferred_probe_optional(void) +{ + if (initcalls_done) + return -ENODEV; + + return -EPROBE_DEFER; +} + /** * deferred_probe_initcall() - Enable probing of deferred devices * @@ -240,6 +249,13 @@ static int deferred_probe_initcall(void) /* Sort as many dependencies as possible before exiting initcalls */ flush_work(&deferred_probe_work); initcalls_done = true; + + /* + * Trigger deferred probe again, this time we won't defer anything + * that is optional + */ + driver_deferred_probe_trigger(); + flush_work(&deferred_probe_work); return 0; } late_initcall(deferred_probe_initcall); diff --git a/drivers/pinctrl/devicetree.c b/drivers/pinctrl/devicetree.c index b601039d6c69..096e52a5c506 100644 --- a/drivers/pinctrl/devicetree.c +++ b/drivers/pinctrl/devicetree.c @@ -120,7 +120,7 @@ static int dt_to_map_one_config(struct pinctrl *p, np_config); of_node_put(np_pctldev); /* OK let's just assume this will appear later then */ - return -EPROBE_DEFER; + return driver_deferred_probe_optional(); } /* If we're creating a hog we can use the passed pctldev */ if (pctldev && (np_pctldev == p->dev->of_node)) diff --git a/include/linux/device.h b/include/linux/device.h index 0059b99e1f25..8de920442bc1 100644 --- a/include/linux/device.h +++ b/include/linux/device.h @@ -332,6 +332,8 @@ struct device *driver_find_device(struct device_driver *drv, struct device *start, void *data, int (*match)(struct device *dev, void *data)); +int driver_deferred_probe_optional(void); + /** * struct subsys_interface - interfaces to device functions * @name: name of the device function -- 2.17.0

5 years, 11 months

EBBR issues moved to github

by Grant Likely

I've started tracking EBBR issues in github, so I will no longer track them in the weekly meeting notes document. Please go take a look. Feel free to add issues for things that need to be done, or comment on the items that are there. Better yet, write patches to fix the existing issues! ;-) https://github.com/ARM-software/ebbr/issues Cheers, g. IMPORTANT NOTICE: The contents of this email and any attachments are confidential and may also be privileged. If you are not the intended recipient, please notify the sender immediately and do not disclose the contents to any other person, use it for any purpose, or store or copy the information in any medium. Thank you.

5 years, 11 months

[PATCH 1/2] Elaborate on DCO process and add full text of CC-BY-SA 4.0

by Grant Likely

Replace the LICENSE file with the full text of CC-BY-SA 4.0 License into the LICENSE file, and move the DCO description into the README. The LICENSE file is a verbatim copy of: https://creativecommons.org/licenses/by-sa/4.0/legalcode.txt Signed-off-by: Grant Likely <grant.likely(a)arm.com> --- LICENSE | 428 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ LICENSE.rst | 50 ------- README.rst | 75 ++++++++--- 3 files changed, 488 insertions(+), 65 deletions(-) create mode 100644 LICENSE delete mode 100644 LICENSE.rst diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..fe8dbc5 --- /dev/null +++ b/LICENSE @@ -0,0 +1,428 @@ +Attribution-ShareAlike 4.0 International + +======================================================================= + +Creative Commons Corporation ("Creative Commons") is not a law firm and +does not provide legal services or legal advice. Distribution of +Creative Commons public licenses does not create a lawyer-client or +other relationship. Creative Commons makes its licenses and related +information available on an "as-is" basis. Creative Commons gives no +warranties regarding its licenses, any material licensed under their +terms and conditions, or any related information. Creative Commons +disclaims all liability for damages resulting from their use to the +fullest extent possible. + +Using Creative Commons Public Licenses + +Creative Commons public licenses provide a standard set of terms and +conditions that creators and other rights holders may use to share +original works of authorship and other material subject to copyright +and certain other rights specified in the public license below. The +following considerations are for informational purposes only, are not +exhaustive, and do not form part of our licenses. + + Considerations for licensors: Our public licenses are + intended for use by those authorized to give the public + permission to use material in ways otherwise restricted by + copyright and certain other rights. Our licenses are + irrevocable. Licensors should read and understand the terms + and conditions of the license they choose before applying it. + Licensors should also secure all rights necessary before + applying our licenses so that the public can reuse the + material as expected. Licensors should clearly mark any + material not subject to the license. This includes other CC- + licensed material, or material used under an exception or + limitation to copyright. More considerations for licensors: + wiki.creativecommons.org/Considerations_for_licensors + + Considerations for the public: By using one of our public + licenses, a licensor grants the public permission to use the + licensed material under specified terms and conditions. If + the licensor's permission is not necessary for any reason--for + example, because of any applicable exception or limitation to + copyright--then that use is not regulated by the license. Our + licenses grant only permissions under copyright and certain + other rights that a licensor has authority to grant. Use of + the licensed material may still be restricted for other + reasons, including because others have copyright or other + rights in the material. A licensor may make special requests, + such as asking that all changes be marked or described. + Although not required by our licenses, you are encouraged to + respect those requests where reasonable. More considerations + for the public: + wiki.creativecommons.org/Considerations_for_licensees + +======================================================================= + +Creative Commons Attribution-ShareAlike 4.0 International Public +License + +By exercising the Licensed Rights (defined below), You accept and agree +to be bound by the terms and conditions of this Creative Commons +Attribution-ShareAlike 4.0 International Public License ("Public +License"). To the extent this Public License may be interpreted as a +contract, You are granted the Licensed Rights in consideration of Your +acceptance of these terms and conditions, and the Licensor grants You +such rights in consideration of benefits the Licensor receives from +making the Licensed Material available under these terms and +conditions. + + +Section 1 -- Definitions. + + a. Adapted Material means material subject to Copyright and Similar + Rights that is derived from or based upon the Licensed Material + and in which the Licensed Material is translated, altered, + arranged, transformed, or otherwise modified in a manner requiring + permission under the Copyright and Similar Rights held by the + Licensor. For purposes of this Public License, where the Licensed + Material is a musical work, performance, or sound recording, + Adapted Material is always produced where the Licensed Material is + synched in timed relation with a moving image. + + b. Adapter's License means the license You apply to Your Copyright + and Similar Rights in Your contributions to Adapted Material in + accordance with the terms and conditions of this Public License. + + c. BY-SA Compatible License means a license listed at + creativecommons.org/compatiblelicenses, approved by Creative + Commons as essentially the equivalent of this Public License. + + d. Copyright and Similar Rights means copyright and/or similar rights + closely related to copyright including, without limitation, + performance, broadcast, sound recording, and Sui Generis Database + Rights, without regard to how the rights are labeled or + categorized. For purposes of this Public License, the rights + specified in Section 2(b)(1)-(2) are not Copyright and Similar + Rights. + + e. Effective Technological Measures means those measures that, in the + absence of proper authority, may not be circumvented under laws + fulfilling obligations under Article 11 of the WIPO Copyright + Treaty adopted on December 20, 1996, and/or similar international + agreements. + + f. Exceptions and Limitations means fair use, fair dealing, and/or + any other exception or limitation to Copyright and Similar Rights + that applies to Your use of the Licensed Material. + + g. License Elements means the license attributes listed in the name + of a Creative Commons Public License. The License Elements of this + Public License are Attribution and ShareAlike. + + h. Licensed Material means the artistic or literary work, database, + or other material to which the Licensor applied this Public + License. + + i. Licensed Rights means the rights granted to You subject to the + terms and conditions of this Public License, which are limited to + all Copyright and Similar Rights that apply to Your use of the + Licensed Material and that the Licensor has authority to license. + + j. Licensor means the individual(s) or entity(ies) granting rights + under this Public License. + + k. Share means to provide material to the public by any means or + process that requires permission under the Licensed Rights, such + as reproduction, public display, public performance, distribution, + dissemination, communication, or importation, and to make material + available to the public including in ways that members of the + public may access the material from a place and at a time + individually chosen by them. + + l. Sui Generis Database Rights means rights other than copyright + resulting from Directive 96/9/EC of the European Parliament and of + the Council of 11 March 1996 on the legal protection of databases, + as amended and/or succeeded, as well as other essentially + equivalent rights anywhere in the world. + + m. You means the individual or entity exercising the Licensed Rights + under this Public License. Your has a corresponding meaning. + + +Section 2 -- Scope. + + a. License grant. + + 1. Subject to the terms and conditions of this Public License, + the Licensor hereby grants You a worldwide, royalty-free, + non-sublicensable, non-exclusive, irrevocable license to + exercise the Licensed Rights in the Licensed Material to: + + a. reproduce and Share the Licensed Material, in whole or + in part; and + + b. produce, reproduce, and Share Adapted Material. + + 2. Exceptions and Limitations. For the avoidance of doubt, where + Exceptions and Limitations apply to Your use, this Public + License does not apply, and You do not need to comply with + its terms and conditions. + + 3. Term. The term of this Public License is specified in Section + 6(a). + + 4. Media and formats; technical modifications allowed. The + Licensor authorizes You to exercise the Licensed Rights in + all media and formats whether now known or hereafter created, + and to make technical modifications necessary to do so. The + Licensor waives and/or agrees not to assert any right or + authority to forbid You from making technical modifications + necessary to exercise the Licensed Rights, including + technical modifications necessary to circumvent Effective + Technological Measures. For purposes of this Public License, + simply making modifications authorized by this Section 2(a) + (4) never produces Adapted Material. + + 5. Downstream recipients. + + a. Offer from the Licensor -- Licensed Material. Every + recipient of the Licensed Material automatically + receives an offer from the Licensor to exercise the + Licensed Rights under the terms and conditions of this + Public License. + + b. Additional offer from the Licensor -- Adapted Material. + Every recipient of Adapted Material from You + automatically receives an offer from the Licensor to + exercise the Licensed Rights in the Adapted Material + under the conditions of the Adapter's License You apply. + + c. No downstream restrictions. You may not offer or impose + any additional or different terms or conditions on, or + apply any Effective Technological Measures to, the + Licensed Material if doing so restricts exercise of the + Licensed Rights by any recipient of the Licensed + Material. + + 6. No endorsement. Nothing in this Public License constitutes or + may be construed as permission to assert or imply that You + are, or that Your use of the Licensed Material is, connected + with, or sponsored, endorsed, or granted official status by, + the Licensor or others designated to receive attribution as + provided in Section 3(a)(1)(A)(i). + + b. Other rights. + + 1. Moral rights, such as the right of integrity, are not + licensed under this Public License, nor are publicity, + privacy, and/or other similar personality rights; however, to + the extent possible, the Licensor waives and/or agrees not to + assert any such rights held by the Licensor to the limited + extent necessary to allow You to exercise the Licensed + Rights, but not otherwise. + + 2. Patent and trademark rights are not licensed under this + Public License. + + 3. To the extent possible, the Licensor waives any right to + collect royalties from You for the exercise of the Licensed + Rights, whether directly or through a collecting society + under any voluntary or waivable statutory or compulsory + licensing scheme. In all other cases the Licensor expressly + reserves any right to collect such royalties. + + +Section 3 -- License Conditions. + +Your exercise of the Licensed Rights is expressly made subject to the +following conditions. + + a. Attribution. + + 1. If You Share the Licensed Material (including in modified + form), You must: + + a. retain the following if it is supplied by the Licensor + with the Licensed Material: + + i. identification of the creator(s) of the Licensed + Material and any others designated to receive + attribution, in any reasonable manner requested by + the Licensor (including by pseudonym if + designated); + + ii. a copyright notice; + + iii. a notice that refers to this Public License; + + iv. a notice that refers to the disclaimer of + warranties; + + v. a URI or hyperlink to the Licensed Material to the + extent reasonably practicable; + + b. indicate if You modified the Licensed Material and + retain an indication of any previous modifications; and + + c. indicate the Licensed Material is licensed under this + Public License, and include the text of, or the URI or + hyperlink to, this Public License. + + 2. You may satisfy the conditions in Section 3(a)(1) in any + reasonable manner based on the medium, means, and context in + which You Share the Licensed Material. For example, it may be + reasonable to satisfy the conditions by providing a URI or + hyperlink to a resource that includes the required + information. + + 3. If requested by the Licensor, You must remove any of the + information required by Section 3(a)(1)(A) to the extent + reasonably practicable. + + b. ShareAlike. + + In addition to the conditions in Section 3(a), if You Share + Adapted Material You produce, the following conditions also apply. + + 1. The Adapter's License You apply must be a Creative Commons + license with the same License Elements, this version or + later, or a BY-SA Compatible License. + + 2. You must include the text of, or the URI or hyperlink to, the + Adapter's License You apply. You may satisfy this condition + in any reasonable manner based on the medium, means, and + context in which You Share Adapted Material. + + 3. You may not offer or impose any additional or different terms + or conditions on, or apply any Effective Technological + Measures to, Adapted Material that restrict exercise of the + rights granted under the Adapter's License You apply. + + +Section 4 -- Sui Generis Database Rights. + +Where the Licensed Rights include Sui Generis Database Rights that +apply to Your use of the Licensed Material: + + a. for the avoidance of doubt, Section 2(a)(1) grants You the right + to extract, reuse, reproduce, and Share all or a substantial + portion of the contents of the database; + + b. if You include all or a substantial portion of the database + contents in a database in which You have Sui Generis Database + Rights, then the database in which You have Sui Generis Database + Rights (but not its individual contents) is Adapted Material, + + including for purposes of Section 3(b); and + c. You must comply with the conditions in Section 3(a) if You Share + all or a substantial portion of the contents of the database. + +For the avoidance of doubt, this Section 4 supplements and does not +replace Your obligations under this Public License where the Licensed +Rights include other Copyright and Similar Rights. + + +Section 5 -- Disclaimer of Warranties and Limitation of Liability. + + a. UNLESS OTHERWISE SEPARATELY UNDERTAKEN BY THE LICENSOR, TO THE + EXTENT POSSIBLE, THE LICENSOR OFFERS THE LICENSED MATERIAL AS-IS + AND AS-AVAILABLE, AND MAKES NO REPRESENTATIONS OR WARRANTIES OF + ANY KIND CONCERNING THE LICENSED MATERIAL, WHETHER EXPRESS, + IMPLIED, STATUTORY, OR OTHER. THIS INCLUDES, WITHOUT LIMITATION, + WARRANTIES OF TITLE, MERCHANTABILITY, FITNESS FOR A PARTICULAR + PURPOSE, NON-INFRINGEMENT, ABSENCE OF LATENT OR OTHER DEFECTS, + ACCURACY, OR THE PRESENCE OR ABSENCE OF ERRORS, WHETHER OR NOT + KNOWN OR DISCOVERABLE. WHERE DISCLAIMERS OF WARRANTIES ARE NOT + ALLOWED IN FULL OR IN PART, THIS DISCLAIMER MAY NOT APPLY TO YOU. + + b. TO THE EXTENT POSSIBLE, IN NO EVENT WILL THE LICENSOR BE LIABLE + TO YOU ON ANY LEGAL THEORY (INCLUDING, WITHOUT LIMITATION, + NEGLIGENCE) OR OTHERWISE FOR ANY DIRECT, SPECIAL, INDIRECT, + INCIDENTAL, CONSEQUENTIAL, PUNITIVE, EXEMPLARY, OR OTHER LOSSES, + COSTS, EXPENSES, OR DAMAGES ARISING OUT OF THIS PUBLIC LICENSE OR + USE OF THE LICENSED MATERIAL, EVEN IF THE LICENSOR HAS BEEN + ADVISED OF THE POSSIBILITY OF SUCH LOSSES, COSTS, EXPENSES, OR + DAMAGES. WHERE A LIMITATION OF LIABILITY IS NOT ALLOWED IN FULL OR + IN PART, THIS LIMITATION MAY NOT APPLY TO YOU. + + c. The disclaimer of warranties and limitation of liability provided + above shall be interpreted in a manner that, to the extent + possible, most closely approximates an absolute disclaimer and + waiver of all liability. + + +Section 6 -- Term and Termination. + + a. This Public License applies for the term of the Copyright and + Similar Rights licensed here. However, if You fail to comply with + this Public License, then Your rights under this Public License + terminate automatically. + + b. Where Your right to use the Licensed Material has terminated under + Section 6(a), it reinstates: + + 1. automatically as of the date the violation is cured, provided + it is cured within 30 days of Your discovery of the + violation; or + + 2. upon express reinstatement by the Licensor. + + For the avoidance of doubt, this Section 6(b) does not affect any + right the Licensor may have to seek remedies for Your violations + of this Public License. + + c. For the avoidance of doubt, the Licensor may also offer the + Licensed Material under separate terms or conditions or stop + distributing the Licensed Material at any time; however, doing so + will not terminate this Public License. + + d. Sections 1, 5, 6, 7, and 8 survive termination of this Public + License. + + +Section 7 -- Other Terms and Conditions. + + a. The Licensor shall not be bound by any additional or different + terms or conditions communicated by You unless expressly agreed. + + b. Any arrangements, understandings, or agreements regarding the + Licensed Material not stated herein are separate from and + independent of the terms and conditions of this Public License. + + +Section 8 -- Interpretation. + + a. For the avoidance of doubt, this Public License does not, and + shall not be interpreted to, reduce, limit, restrict, or impose + conditions on any use of the Licensed Material that could lawfully + be made without permission under this Public License. + + b. To the extent possible, if any provision of this Public License is + deemed unenforceable, it shall be automatically reformed to the + minimum extent necessary to make it enforceable. If the provision + cannot be reformed, it shall be severed from this Public License + without affecting the enforceability of the remaining terms and + conditions. + + c. No term or condition of this Public License will be waived and no + failure to comply consented to unless expressly agreed to by the + Licensor. + + d. Nothing in this Public License constitutes or may be interpreted + as a limitation upon, or waiver of, any privileges and immunities + that apply to the Licensor or You, including from the legal + processes of any jurisdiction or authority. + + +======================================================================= + +Creative Commons is not a party to its public +licenses. Notwithstanding, Creative Commons may elect to apply one of +its public licenses to material it publishes and in those instances +will be considered the “Licensor.” The text of the Creative Commons +public licenses is dedicated to the public domain under the CC0 Public +Domain Dedication. Except for the limited purpose of indicating that +material is shared under a Creative Commons public license or as +otherwise permitted by the Creative Commons policies published at +creativecommons.org/policies, Creative Commons does not authorize the +use of the trademark "Creative Commons" or any other trademark or logo +of Creative Commons without its prior written consent including, +without limitation, in connection with any unauthorized modifications +to any of its public licenses or any other arrangements, +understandings, or agreements concerning use of licensed material. For +the avoidance of doubt, this paragraph does not form part of the +public licenses. + +Creative Commons may be contacted at creativecommons.org. + diff --git a/LICENSE.rst b/LICENSE.rst deleted file mode 100644 index 78313a4..0000000 --- a/LICENSE.rst +++ /dev/null @@ -1,50 +0,0 @@ -Creative Commons Attribution-ShareAlike 4.0 -=========================================== -:: - - This work is licensed under the Creative Commons Attribution-ShareAlike 4.0 - International License. To view a copy of this license, visit - http://creativecommons.org/licenses/by-sa/4.0/ or send a letter to - Creative Commons, PO Box 1866, Mountain View, CA 94042, USA. - -Developer Certificate of Origin -=============================== -:: - - Developer Certificate of Origin - Version 1.1 - - Copyright (C) 2004, 2006 The Linux Foundation and its contributors. - 1 Letterman Drive - Suite D4700 - San Francisco, CA, 94129 - - Everyone is permitted to copy and distribute verbatim copies of this - license document, but changing it is not allowed. - - - Developer's Certificate of Origin 1.1 - - By making a contribution to this project, I certify that: - - (a) The contribution was created in whole or in part by me and I - have the right to submit it under the open source license - indicated in the file; or - - (b) The contribution is based upon previous work that, to the best - of my knowledge, is covered under an appropriate open source - license and I have the right under that license to submit that - work with modifications, whether created in whole or in part - by me, under the same open source license (unless I am - permitted to submit under a different license), as indicated - in the file; or - - (c) The contribution was provided directly to me by some other - person who certified (a), (b) or (c) and I have not modified - it. - - (d) I understand and agree that this project and the contribution - are public and that a record of the contribution (including all - personal information I submit with it, including my sign-off) is - maintained indefinitely and may be redistributed consistent with - this project or the open source license(s) involved. diff --git a/README.rst b/README.rst index 84aeb0a..1babcf4 100644 --- a/README.rst +++ b/README.rst @@ -13,11 +13,21 @@ expected in September 2018. You can find the current draft text in this repository, but be aware that everything in the draft text is subject to change before an official v1.0 release is published. -The documentation in this project is provided under the terms of the -Creative Commons Attribution Share-Alike License. -Licensing details can be found in the LICENSE.rst_ file. +License +======= -.. _LICENSE.rst: ./LICENSE.rst +This work is licensed under the Creative Commons Attribution-ShareAlike 4.0 +International License. To view a copy of this license, visit +http://creativecommons.org/licenses/by-sa/4.0/ or send a letter to +Creative Commons, PO Box 1866, Mountain View, CA 94042, USA. + +A copy of the license is included in the LICENSE_ file. + +.. image:: https://i.creativecommons.org/l/by-sa/4.0/88x31.png + :target: http://creativecommons.org/licenses/by-sa/4.0/ + :alt: Creative Commons License + +.. _LICENSE: ./LICENSE Contributing ============ @@ -25,29 +35,64 @@ Contributing Master copy of this project is hosted on GitHub: https://github.com/ARM-software/ebbr -Anyone may contribute to EBBR. Contributions must be made with a -Developer Certificate of Origin (DCO_) attestation that the contribution -confirms to the license of the project. The attestation is made by the -developer including a ``Signed-off-by: <email-address>`` tag in the -commit text of the contribution. - -EBBR discussion is on the boot-architecture_ and arm.ebbr-discuss mailing lists. -The 'official' list is arm.ebbr-discuss, but the list archives are not yet public, -so boot-architecture_ is being used to keep everything in the open. +Anyone may contribute to the EBBR project. EBBR discussion uses the +boot-architecture_ and arm.ebbr-discuss mailing lists. +The 'official' list is arm.ebbr-discuss, but the list archives are not +yet public, so boot-architecture_ is being used to keep everything in +the open. * boot-architechture(a)lists.linaro.org * arm.ebbr-discuss(a)arm.com -Past discussions can be found in the _boot-architecture-archive. +Past discussions can be found in the boot-architecture-archive_. + +To help track the origin of contributions, this project uses the same +DCO_ "sign-off" process as used by the Linux kernel. +The sign-off is a simple line at the end of the explanation for the +patch, which certifies that you wrote it or otherwise have the right to +pass it on as an open-source patch. The rules are pretty simple: if you +can certify the below: + +Developer's Certificate of Origin 1.1 +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +By making a contribution to this project, I certify that: + + (a) The contribution was created in whole or in part by me and I + have the right to submit it under the open source license + indicated in the file; or + + (b) The contribution is based upon previous work that, to the best + of my knowledge, is covered under an appropriate open source + license and I have the right under that license to submit that + work with modifications, whether created in whole or in part + by me, under the same open source license (unless I am + permitted to submit under a different license), as indicated + in the file; or + + (c) The contribution was provided directly to me by some other + person who certified (a), (b) or (c) and I have not modified + it. + + (d) I understand and agree that this project and the contribution + are public and that a record of the contribution (including all + personal information I submit with it, including my sign-off) is + maintained indefinitely and may be redistributed consistent with + this project or the open source license(s) involved. + +then you just add a line saying:: + + Signed-off-by: Random J Developer <random(a)developer.example.org> IRC Channel: ``#ebbr`` on ofct .. _DCO: https://developercertificate.org/ .. _boot-architecture: https://lists.linaro.org/mailman/listinfo/boot-architecture -.. _boot-architecture-archive: https://lists.linaro.org/pipermail/boot-architecture/ +.. _boot-architecture-archive: https://lists.linaro.org/pipermail/boot-architecture Writers Guide ============= + All documentation in this repository uses reStructuredText_ markup with Sphinx_ extensions. -- 2.13.0

5 years, 11 months

EBBR repo created

by Grant Likely

Hi folks, Internal approval for EBBR has come through and we now have a GitHub repo. It's empty at the moment, but I'll be pushing the current EBBR text there shortly once I've fixed the license text. License will be CC-BY-SA https://github.com/ARM-software/ebbr We can start using this page to track issue. I'll put all the active action items into github issues. Cheers, g. IMPORTANT NOTICE: The contents of this email and any attachments are confidential and may also be privileged. If you are not the intended recipient, please notify the sender immediately and do not disclose the contents to any other person, use it for any purpose, or store or copy the information in any medium. Thank you.

5 years, 11 months

2024

2023

2022

2021

2020

2019

2018

2017

2016

2015

2014

2013

2012

2011

2010

boot-architecture May 2018