boot-architecture

boot-architecture@lists.linaro.org

1 participants
677 discussions

EBBR Weekly - Notes 17 May 2018

by Grant Likely

https://github.com/ARM-software/ebbr/wiki/EBBR-Notes-2018.05.17 # 17 May 2018 ## Attendees * Alex Graf (SUSE) * Ryan Harkin (Linaro) * Rob Herring (Linaro) * Udit Kumar (NXP) * Grant Likely (Arm) * Bill Mills (TI) * Tom Rini (Konsulko) * Daniel Thompson (Linaro) ## Agenda * Issue/Action review * Any other business ## Notes ### Issue/Action review * Issue #1 - Bill will assign to himself * Issue #2 - Leif on Holiday * Issue #3 - Daniel will take * Issue #4 - grant to take * Issue #8 - partitioning tool rules - Daniel will take * Issue #10 & 11 - Assign to Udit * Issue #10 - Document how to certify * Dong added that we can probably leverage UEFI SCT * Issue #13 - Daniel to take ### Other Business Rob: Looks like there is interest from the Google/Android folks in EBBR * Rob to set up a meeting with the relevant folks 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.

7 years, 9 months

[PATCH] Remove MP Start protocol from EBBR and revert to PSCI v1.0

by Grant Likely

EBBR platforms are unlikely to ever use the MP Start protocol used in some AArch64 server systems. It was only used to support platforms without EL3. No more EL2-only platforms are expected, and MP Start is being removed from the next release of SBBR. Devicetree platforms in the same scenario use the Linux spin table protocol instead. MP Start was only included for completeness to align the SBBR and EBBR specifications. Therefore remove it entirely, leaving PSCI and spin table as the only acceptable implementations. Also revert to PSCI v1.0 as that is the minimum level of functionality required. PSCI v1.1 adds new capabilities, but is not required for interoperability. Suggested-by: Dong Wei <dong.wei(a)arm.com> Signed-off-by: Grant Likely <grant.likely(a)arm.com> --- source/ebbr.rst | 15 +++++---------- 1 file changed, 5 insertions(+), 10 deletions(-) diff --git a/source/ebbr.rst b/source/ebbr.rst index 40f03f1..4100b2f 100644 --- a/source/ebbr.rst +++ b/source/ebbr.rst @@ -329,10 +329,9 @@ Power State Coordination Interface specification[PSCI_]. Platforms without EL3 must implement one of: - PSCI at EL2 (leaving only EL1 available to an operating system) -- MP Startup for Arm[MPSTART_] (ACPI Parking Protocol) on an ACPI platform -- Linux AArch64 spin tables[LINUXA64BOOT_] on a Devicetree platform +- Linux AArch64 spin tables[LINUXA64BOOT_] (Devicetree only) -However, the MP Startup and Spintable protocols are strongly discouraged. +However, the spin table protocol is strongly discouraged. Future versions of this specification will only allow PSCI, and PSCI should be implemented in all new designs. @@ -575,13 +574,9 @@ EFI_ISCSI_INITIATOR_NAME_PROTOCOL 16.2 <https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux-stable.git/tre…>`_, Linux kernel -.. [MPSTART] `MP Startup for Arm - <https://acpica.org/sites/acpica/files/MP%20Startup%20for%20ARM%20platforms.…>`_, - 20 December 2012, `Microsoft <http://microsoft.com>`_ - -.. [PSCI] `Power State Coordination Interface Issue D (PSCI v1.1) - <http://infocenter.arm.com/help//topic/com.arm.doc.den0022d/Power_State_Coor…>`_, - 21 April 2017, `Arm Limited <http://arm.com>`_ +.. [PSCI] `Power State Coordination Interface Issue C (PSCI v1.0) + <https://static.docs.arm.com/den0022/c/DEN0022C_Power_State_Coordination_Int…>`_ + 30 January 2015, `Arm Limited <http://arm.com>`_ .. [SBBR] `Arm Server Base Boot Requirements specification Issue B (v1.0) <https://static.docs.arm.com/den0044/b/DEN0044B_Server_Base_Boot_Requirement…>`_ -- 2.13.0

7 years, 9 months

Re: [Arm.ebbr-discuss] [PATCH] Be specific about DT or ACPI requirements

by Grant Likely

On 18/05/2018 18:08, Mark Brown wrote: > On Fri, May 18, 2018 at 06:04:11PM +0100, Grant Likely wrote: > >> My bikeshed now has a sign that reads: > >> +As stated above, EBBR systems must not provide both ACPI >> +and Devicetree tables at the same time. >> +Systems that support both interfaces must provide a configuration >> +mechanism to select either ACPI or Devicetree, >> +and must ensure only the selected interface is provided >> +to the OS loader. > > I think that's a very pleasing shade, thanks! :) > > (Sorry, I spent far too long working on interoperability of some > particularly poorly specified networking standards so now have > difficulty reading any spec without assuming the worst.) > Thanks! I'll take that as you're Acked-by then. :-) g.

7 years, 9 months

Re: [Arm.ebbr-discuss] [PATCH] Be specific about DT or ACPI requirements

by Grant Likely

On 18/05/2018 17:45, Mark Brown wrote: > On Fri, May 18, 2018 at 05:28:10PM +0100, Grant Likely wrote: > >> +Devicetree tables at the same time. Platforms that want to offer >> +both ACPI and Devicetree solutions must implement a boot time >> +mechanism to select one or the other, before the OS Loader is >> +executed. > > How about "...must configure this using a mechanism that ensures that > one or the other is chosen and provided to the OS loader when it is > executed"? It doesn't really matter for sensible systems but I can see > someone misreading the above and thinking there must be a prompt on boot > or something, I do think this is me being paranoid about perverse > implementors though. > My bikeshed now has a sign that reads: +As stated above, EBBR systems must not provide both ACPI +and Devicetree tables at the same time. +Systems that support both interfaces must provide a configuration +mechanism to select either ACPI or Devicetree, +and must ensure only the selected interface is provided +to the OS loader. g.

7 years, 9 months

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.

7 years, 9 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.

7 years, 9 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

7 years, 9 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.

7 years, 9 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

7 years, 9 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

7 years, 9 months

← Newer
1
...
44
45
46
47
48
49
50
...
68
Older →

Jump to page:

2026

2025

2024

2023

2022

2021

2020

2019

2018

2017

2016

2015

2014

2013

2012

2011

2010

boot-architecture