├── .github └── workflows │ └── build-pdf.yml ├── .gitmodules ├── LICENSE ├── Makefile ├── bibliography.adoc ├── boot_protocol.adoc ├── contributors.adoc ├── dependencies ├── Gemfile ├── README.md ├── apt_packages.txt └── package.json ├── efi_protocol.bib ├── header.adoc ├── images └── riscv-logo.svg ├── intro.adoc └── readme.adoc /.github/workflows/build-pdf.yml: -------------------------------------------------------------------------------- 1 | # This workflow installs dependencies for PDF generation, generates the PDF, 2 | # and uploads the PDF as an artifact. 3 | 4 | name: Build Document PDF 5 | 6 | on: 7 | push: 8 | branches: [ $default-branch ] 9 | pull_request: 10 | branches: [ $default-branch ] 11 | workflow_dispatch: 12 | 13 | jobs: 14 | build: 15 | runs-on: ubuntu-latest 16 | 17 | env: 18 | APT_PACKAGES_FILE: ${{ github.workspace }}/dependencies/apt_packages.txt 19 | BUNDLE_GEMFILE: ${{ github.workspace }}/dependencies/Gemfile 20 | BUNDLE_BIN: ${{ github.workspace }}/bin 21 | NPM_PACKAGE_FOLDER: ${{ github.workspace }}/dependencies 22 | steps: 23 | - name: Checkout repository 24 | uses: actions/checkout@v2 25 | with: 26 | submodules: 'true' 27 | - name: Install Ubuntu packages 28 | run: | 29 | sudo apt-get update 30 | grep -vE '^#' ${APT_PACKAGES_FILE} | xargs sudo apt-get install --yes --no-install-recommends 31 | # Ruby for asciidoctor 32 | - name: Setup Ruby and Gemfile content 33 | uses: ruby/setup-ruby@v1 34 | with: 35 | ruby-version: "2.6" 36 | bundler-cache: true 37 | # Node.js for wavedrom 38 | - uses: actions/cache@v2 39 | with: 40 | path: ~/.npm 41 | key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }} 42 | restore-keys: | 43 | ${{ runner.os }}-node- 44 | - name: Setup Node.js 45 | uses: actions/setup-node@v2 46 | with: 47 | node-version: '14' 48 | - name: Install Node.js dependencies 49 | run: npm install ${NPM_PACKAGE_FOLDER} 50 | - name: Generate PDF 51 | run: | 52 | PATH=${PATH}:${BUNDLE_BIN}:$(npm bin) \ 53 | make 54 | - name: Archive PDF result 55 | uses: actions/upload-artifact@v2 56 | with: 57 | name: RISCV_UEFI_PROTOCOL-spec.pdf 58 | path: RISCV_UEFI_PROTOCOL-spec.pdf 59 | retention-days: 7 60 | -------------------------------------------------------------------------------- /.gitmodules: -------------------------------------------------------------------------------- 1 | [submodule "docs-resources"] 2 | path = docs-resources 3 | url = https://github.com/riscv/docs-resources.git 4 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Attribution 4.0 International 2 | 3 | ======================================================================= 4 | 5 | Creative Commons Corporation ("Creative Commons") is not a law firm and 6 | does not provide legal services or legal advice. Distribution of 7 | Creative Commons public licenses does not create a lawyer-client or 8 | other relationship. Creative Commons makes its licenses and related 9 | information available on an "as-is" basis. Creative Commons gives no 10 | warranties regarding its licenses, any material licensed under their 11 | terms and conditions, or any related information. Creative Commons 12 | disclaims all liability for damages resulting from their use to the 13 | fullest extent possible. 14 | 15 | Using Creative Commons Public Licenses 16 | 17 | Creative Commons public licenses provide a standard set of terms and 18 | conditions that creators and other rights holders may use to share 19 | original works of authorship and other material subject to copyright 20 | and certain other rights specified in the public license below. The 21 | following considerations are for informational purposes only, are not 22 | exhaustive, and do not form part of our licenses. 23 | 24 | Considerations for licensors: Our public licenses are 25 | intended for use by those authorized to give the public 26 | permission to use material in ways otherwise restricted by 27 | copyright and certain other rights. Our licenses are 28 | irrevocable. Licensors should read and understand the terms 29 | and conditions of the license they choose before applying it. 30 | Licensors should also secure all rights necessary before 31 | applying our licenses so that the public can reuse the 32 | material as expected. Licensors should clearly mark any 33 | material not subject to the license. This includes other CC- 34 | licensed material, or material used under an exception or 35 | limitation to copyright. More considerations for licensors: 36 | wiki.creativecommons.org/Considerations_for_licensors 37 | 38 | Considerations for the public: By using one of our public 39 | licenses, a licensor grants the public permission to use the 40 | licensed material under specified terms and conditions. If 41 | the licensor's permission is not necessary for any reason--for 42 | example, because of any applicable exception or limitation to 43 | copyright--then that use is not regulated by the license. Our 44 | licenses grant only permissions under copyright and certain 45 | other rights that a licensor has authority to grant. Use of 46 | the licensed material may still be restricted for other 47 | reasons, including because others have copyright or other 48 | rights in the material. A licensor may make special requests, 49 | such as asking that all changes be marked or described. 50 | Although not required by our licenses, you are encouraged to 51 | respect those requests where reasonable. More_considerations 52 | for the public: 53 | wiki.creativecommons.org/Considerations_for_licensees 54 | 55 | ======================================================================= 56 | 57 | Creative Commons Attribution 4.0 International Public License 58 | 59 | By exercising the Licensed Rights (defined below), You accept and agree 60 | to be bound by the terms and conditions of this Creative Commons 61 | Attribution 4.0 International Public License ("Public License"). To the 62 | extent this Public License may be interpreted as a contract, You are 63 | granted the Licensed Rights in consideration of Your acceptance of 64 | these terms and conditions, and the Licensor grants You such rights in 65 | consideration of benefits the Licensor receives from making the 66 | Licensed Material available under these terms and conditions. 67 | 68 | 69 | Section 1 -- Definitions. 70 | 71 | a. Adapted Material means material subject to Copyright and Similar 72 | Rights that is derived from or based upon the Licensed Material 73 | and in which the Licensed Material is translated, altered, 74 | arranged, transformed, or otherwise modified in a manner requiring 75 | permission under the Copyright and Similar Rights held by the 76 | Licensor. For purposes of this Public License, where the Licensed 77 | Material is a musical work, performance, or sound recording, 78 | Adapted Material is always produced where the Licensed Material is 79 | synched in timed relation with a moving image. 80 | 81 | b. Adapter's License means the license You apply to Your Copyright 82 | and Similar Rights in Your contributions to Adapted Material in 83 | accordance with the terms and conditions of this Public License. 84 | 85 | c. Copyright and Similar Rights means copyright and/or similar rights 86 | closely related to copyright including, without limitation, 87 | performance, broadcast, sound recording, and Sui Generis Database 88 | Rights, without regard to how the rights are labeled or 89 | categorized. For purposes of this Public License, the rights 90 | specified in Section 2(b)(1)-(2) are not Copyright and Similar 91 | Rights. 92 | 93 | d. Effective Technological Measures means those measures that, in the 94 | absence of proper authority, may not be circumvented under laws 95 | fulfilling obligations under Article 11 of the WIPO Copyright 96 | Treaty adopted on December 20, 1996, and/or similar international 97 | agreements. 98 | 99 | e. Exceptions and Limitations means fair use, fair dealing, and/or 100 | any other exception or limitation to Copyright and Similar Rights 101 | that applies to Your use of the Licensed Material. 102 | 103 | f. Licensed Material means the artistic or literary work, database, 104 | or other material to which the Licensor applied this Public 105 | License. 106 | 107 | g. Licensed Rights means the rights granted to You subject to the 108 | terms and conditions of this Public License, which are limited to 109 | all Copyright and Similar Rights that apply to Your use of the 110 | Licensed Material and that the Licensor has authority to license. 111 | 112 | h. Licensor means the individual(s) or entity(ies) granting rights 113 | under this Public License. 114 | 115 | i. Share means to provide material to the public by any means or 116 | process that requires permission under the Licensed Rights, such 117 | as reproduction, public display, public performance, distribution, 118 | dissemination, communication, or importation, and to make material 119 | available to the public including in ways that members of the 120 | public may access the material from a place and at a time 121 | individually chosen by them. 122 | 123 | j. Sui Generis Database Rights means rights other than copyright 124 | resulting from Directive 96/9/EC of the European Parliament and of 125 | the Council of 11 March 1996 on the legal protection of databases, 126 | as amended and/or succeeded, as well as other essentially 127 | equivalent rights anywhere in the world. 128 | 129 | k. You means the individual or entity exercising the Licensed Rights 130 | under this Public License. Your has a corresponding meaning. 131 | 132 | 133 | Section 2 -- Scope. 134 | 135 | a. License grant. 136 | 137 | 1. Subject to the terms and conditions of this Public License, 138 | the Licensor hereby grants You a worldwide, royalty-free, 139 | non-sublicensable, non-exclusive, irrevocable license to 140 | exercise the Licensed Rights in the Licensed Material to: 141 | 142 | a. reproduce and Share the Licensed Material, in whole or 143 | in part; and 144 | 145 | b. produce, reproduce, and Share Adapted Material. 146 | 147 | 2. Exceptions and Limitations. For the avoidance of doubt, where 148 | Exceptions and Limitations apply to Your use, this Public 149 | License does not apply, and You do not need to comply with 150 | its terms and conditions. 151 | 152 | 3. Term. The term of this Public License is specified in Section 153 | 6(a). 154 | 155 | 4. Media and formats; technical modifications allowed. The 156 | Licensor authorizes You to exercise the Licensed Rights in 157 | all media and formats whether now known or hereafter created, 158 | and to make technical modifications necessary to do so. The 159 | Licensor waives and/or agrees not to assert any right or 160 | authority to forbid You from making technical modifications 161 | necessary to exercise the Licensed Rights, including 162 | technical modifications necessary to circumvent Effective 163 | Technological Measures. For purposes of this Public License, 164 | simply making modifications authorized by this Section 2(a) 165 | (4) never produces Adapted Material. 166 | 167 | 5. Downstream recipients. 168 | 169 | a. Offer from the Licensor -- Licensed Material. Every 170 | recipient of the Licensed Material automatically 171 | receives an offer from the Licensor to exercise the 172 | Licensed Rights under the terms and conditions of this 173 | Public License. 174 | 175 | b. No downstream restrictions. You may not offer or impose 176 | any additional or different terms or conditions on, or 177 | apply any Effective Technological Measures to, the 178 | Licensed Material if doing so restricts exercise of the 179 | Licensed Rights by any recipient of the Licensed 180 | Material. 181 | 182 | 6. No endorsement. Nothing in this Public License constitutes or 183 | may be construed as permission to assert or imply that You 184 | are, or that Your use of the Licensed Material is, connected 185 | with, or sponsored, endorsed, or granted official status by, 186 | the Licensor or others designated to receive attribution as 187 | provided in Section 3(a)(1)(A)(i). 188 | 189 | b. Other rights. 190 | 191 | 1. Moral rights, such as the right of integrity, are not 192 | licensed under this Public License, nor are publicity, 193 | privacy, and/or other similar personality rights; however, to 194 | the extent possible, the Licensor waives and/or agrees not to 195 | assert any such rights held by the Licensor to the limited 196 | extent necessary to allow You to exercise the Licensed 197 | Rights, but not otherwise. 198 | 199 | 2. Patent and trademark rights are not licensed under this 200 | Public License. 201 | 202 | 3. To the extent possible, the Licensor waives any right to 203 | collect royalties from You for the exercise of the Licensed 204 | Rights, whether directly or through a collecting society 205 | under any voluntary or waivable statutory or compulsory 206 | licensing scheme. In all other cases the Licensor expressly 207 | reserves any right to collect such royalties. 208 | 209 | 210 | Section 3 -- License Conditions. 211 | 212 | Your exercise of the Licensed Rights is expressly made subject to the 213 | following conditions. 214 | 215 | a. Attribution. 216 | 217 | 1. If You Share the Licensed Material (including in modified 218 | form), You must: 219 | 220 | a. retain the following if it is supplied by the Licensor 221 | with the Licensed Material: 222 | 223 | i. identification of the creator(s) of the Licensed 224 | Material and any others designated to receive 225 | attribution, in any reasonable manner requested by 226 | the Licensor (including by pseudonym if 227 | designated); 228 | 229 | ii. a copyright notice; 230 | 231 | iii. a notice that refers to this Public License; 232 | 233 | iv. a notice that refers to the disclaimer of 234 | warranties; 235 | 236 | v. a URI or hyperlink to the Licensed Material to the 237 | extent reasonably practicable; 238 | 239 | b. indicate if You modified the Licensed Material and 240 | retain an indication of any previous modifications; and 241 | 242 | c. indicate the Licensed Material is licensed under this 243 | Public License, and include the text of, or the URI or 244 | hyperlink to, this Public License. 245 | 246 | 2. You may satisfy the conditions in Section 3(a)(1) in any 247 | reasonable manner based on the medium, means, and context in 248 | which You Share the Licensed Material. For example, it may be 249 | reasonable to satisfy the conditions by providing a URI or 250 | hyperlink to a resource that includes the required 251 | information. 252 | 253 | 3. If requested by the Licensor, You must remove any of the 254 | information required by Section 3(a)(1)(A) to the extent 255 | reasonably practicable. 256 | 257 | 4. If You Share Adapted Material You produce, the Adapter's 258 | License You apply must not prevent recipients of the Adapted 259 | Material from complying with this Public License. 260 | 261 | 262 | Section 4 -- Sui Generis Database Rights. 263 | 264 | Where the Licensed Rights include Sui Generis Database Rights that 265 | apply to Your use of the Licensed Material: 266 | 267 | a. for the avoidance of doubt, Section 2(a)(1) grants You the right 268 | to extract, reuse, reproduce, and Share all or a substantial 269 | portion of the contents of the database; 270 | 271 | b. if You include all or a substantial portion of the database 272 | contents in a database in which You have Sui Generis Database 273 | Rights, then the database in which You have Sui Generis Database 274 | Rights (but not its individual contents) is Adapted Material; and 275 | 276 | c. You must comply with the conditions in Section 3(a) if You Share 277 | all or a substantial portion of the contents of the database. 278 | 279 | For the avoidance of doubt, this Section 4 supplements and does not 280 | replace Your obligations under this Public License where the Licensed 281 | Rights include other Copyright and Similar Rights. 282 | 283 | 284 | Section 5 -- Disclaimer of Warranties and Limitation of Liability. 285 | 286 | a. UNLESS OTHERWISE SEPARATELY UNDERTAKEN BY THE LICENSOR, TO THE 287 | EXTENT POSSIBLE, THE LICENSOR OFFERS THE LICENSED MATERIAL AS-IS 288 | AND AS-AVAILABLE, AND MAKES NO REPRESENTATIONS OR WARRANTIES OF 289 | ANY KIND CONCERNING THE LICENSED MATERIAL, WHETHER EXPRESS, 290 | IMPLIED, STATUTORY, OR OTHER. THIS INCLUDES, WITHOUT LIMITATION, 291 | WARRANTIES OF TITLE, MERCHANTABILITY, FITNESS FOR A PARTICULAR 292 | PURPOSE, NON-INFRINGEMENT, ABSENCE OF LATENT OR OTHER DEFECTS, 293 | ACCURACY, OR THE PRESENCE OR ABSENCE OF ERRORS, WHETHER OR NOT 294 | KNOWN OR DISCOVERABLE. WHERE DISCLAIMERS OF WARRANTIES ARE NOT 295 | ALLOWED IN FULL OR IN PART, THIS DISCLAIMER MAY NOT APPLY TO YOU. 296 | 297 | b. TO THE EXTENT POSSIBLE, IN NO EVENT WILL THE LICENSOR BE LIABLE 298 | TO YOU ON ANY LEGAL THEORY (INCLUDING, WITHOUT LIMITATION, 299 | NEGLIGENCE) OR OTHERWISE FOR ANY DIRECT, SPECIAL, INDIRECT, 300 | INCIDENTAL, CONSEQUENTIAL, PUNITIVE, EXEMPLARY, OR OTHER LOSSES, 301 | COSTS, EXPENSES, OR DAMAGES ARISING OUT OF THIS PUBLIC LICENSE OR 302 | USE OF THE LICENSED MATERIAL, EVEN IF THE LICENSOR HAS BEEN 303 | ADVISED OF THE POSSIBILITY OF SUCH LOSSES, COSTS, EXPENSES, OR 304 | DAMAGES. WHERE A LIMITATION OF LIABILITY IS NOT ALLOWED IN FULL OR 305 | IN PART, THIS LIMITATION MAY NOT APPLY TO YOU. 306 | 307 | c. The disclaimer of warranties and limitation of liability provided 308 | above shall be interpreted in a manner that, to the extent 309 | possible, most closely approximates an absolute disclaimer and 310 | waiver of all liability. 311 | 312 | 313 | Section 6 -- Term and Termination. 314 | 315 | a. This Public License applies for the term of the Copyright and 316 | Similar Rights licensed here. However, if You fail to comply with 317 | this Public License, then Your rights under this Public License 318 | terminate automatically. 319 | 320 | b. Where Your right to use the Licensed Material has terminated under 321 | Section 6(a), it reinstates: 322 | 323 | 1. automatically as of the date the violation is cured, provided 324 | it is cured within 30 days of Your discovery of the 325 | violation; or 326 | 327 | 2. upon express reinstatement by the Licensor. 328 | 329 | For the avoidance of doubt, this Section 6(b) does not affect any 330 | right the Licensor may have to seek remedies for Your violations 331 | of this Public License. 332 | 333 | c. For the avoidance of doubt, the Licensor may also offer the 334 | Licensed Material under separate terms or conditions or stop 335 | distributing the Licensed Material at any time; however, doing so 336 | will not terminate this Public License. 337 | 338 | d. Sections 1, 5, 6, 7, and 8 survive termination of this Public 339 | License. 340 | 341 | 342 | Section 7 -- Other Terms and Conditions. 343 | 344 | a. The Licensor shall not be bound by any additional or different 345 | terms or conditions communicated by You unless expressly agreed. 346 | 347 | b. Any arrangements, understandings, or agreements regarding the 348 | Licensed Material not stated herein are separate from and 349 | independent of the terms and conditions of this Public License. 350 | 351 | 352 | Section 8 -- Interpretation. 353 | 354 | a. For the avoidance of doubt, this Public License does not, and 355 | shall not be interpreted to, reduce, limit, restrict, or impose 356 | conditions on any use of the Licensed Material that could lawfully 357 | be made without permission under this Public License. 358 | 359 | b. To the extent possible, if any provision of this Public License is 360 | deemed unenforceable, it shall be automatically reformed to the 361 | minimum extent necessary to make it enforceable. If the provision 362 | cannot be reformed, it shall be severed from this Public License 363 | without affecting the enforceability of the remaining terms and 364 | conditions. 365 | 366 | c. No term or condition of this Public License will be waived and no 367 | failure to comply consented to unless expressly agreed to by the 368 | Licensor. 369 | 370 | d. Nothing in this Public License constitutes or may be interpreted 371 | as a limitation upon, or waiver of, any privileges and immunities 372 | that apply to the Licensor or You, including from the legal 373 | processes of any jurisdiction or authority. 374 | 375 | 376 | ======================================================================= 377 | 378 | Creative Commons is not a party to its public 379 | licenses. Notwithstanding, Creative Commons may elect to apply one of 380 | its public licenses to material it publishes and in those instances 381 | will be considered the “Licensor.” The text of the Creative Commons 382 | public licenses is dedicated to the public domain under the CC0 Public 383 | Domain Dedication. Except for the limited purpose of indicating that 384 | material is shared under a Creative Commons public license or as 385 | otherwise permitted by the Creative Commons policies published at 386 | creativecommons.org/policies, Creative Commons does not authorize the 387 | use of the trademark "Creative Commons" or any other trademark or logo 388 | of Creative Commons without its prior written consent including, 389 | without limitation, in connection with any unauthorized modifications 390 | to any of its public licenses or any other arrangements, 391 | understandings, or agreements concerning use of licensed material. For 392 | the avoidance of doubt, this paragraph does not form part of the 393 | public licenses. 394 | 395 | Creative Commons may be contacted at creativecommons.org. 396 | 397 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | HEADER_SOURCE := header.adoc 2 | PDF_RESULT := RISCV_UEFI_PROTOCOL-spec.pdf 3 | 4 | all: build 5 | 6 | build: 7 | 8 | @echo "Building asciidoc" 9 | asciidoctor-pdf \ 10 | --attribute=mathematical-format=svg \ 11 | --attribute=pdf-fontsdir=docs-resources/fonts \ 12 | --attribute=pdf-style=docs-resources/themes/riscv-pdf.yml \ 13 | --failure-level=ERROR \ 14 | --require=asciidoctor-bibtex \ 15 | --require=asciidoctor-diagram \ 16 | --require=asciidoctor-mathematical \ 17 | --out-file=$(PDF_RESULT) \ 18 | $(HEADER_SOURCE) 19 | 20 | clean: 21 | rm $(PDF_RESULT) 22 | -------------------------------------------------------------------------------- /bibliography.adoc: -------------------------------------------------------------------------------- 1 | [bibliography] 2 | == References 3 | 4 | * link:http://lists.infradead.org/pipermail/linux-riscv/2021-December/010604.html[Discussion on the requirement] 5 | 6 | //bibliography::[] 7 | -------------------------------------------------------------------------------- /boot_protocol.adoc: -------------------------------------------------------------------------------- 1 | [[boot_protocol]] 2 | == RISCV_EFI_BOOT_PROTOCOL 3 | Either Device Tree (DT) or Advanced Configuration and Power Interface (ACPI) 4 | configuration tables are used to convey the information about hardware to the 5 | Operating Systems. Some of the information are known only at boot time and 6 | needed very early before the Operating Systems/boot loaders can parse the 7 | firmware tables. 8 | 9 | One example is the boot hartid on RISC-V systems. On non-UEFI systems, this is 10 | typically passed as an argument to the kernel (in a0). However, UEFI systems need 11 | to follow UEFI application calling conventions and hence it can not be passed in 12 | a0. There is an existing solution which uses the /chosen node in DT based systems 13 | to pass this information. However, this solution doesn't work for ACPI based 14 | systems. Hence, a UEFI protocol is preferred for both DT and ACPI based systems. 15 | 16 | This UEFI protocol for RISC-V systems provides early information to the 17 | bootloaders or Operating Systems. Firmwares like EDK2 and u-boot need to 18 | implement this protocol on RISC-V UEFI systems. 19 | 20 | This protocol is typically called by the bootloaders before invoking 21 | *ExitBootServices()*. They then pass the information to the Operating 22 | Systems. 23 | 24 | The version of RISCV_EFI_BOOT_PROTOCOL specified by this specification is 25 | 0x00010000. All future revisions must be backwards compatible. If a new version 26 | of the specification breaks backwards compatibility, a new GUID must be defined. 27 | 28 | === GUID 29 | [source,C] 30 | ---- 31 | #define RISCV_EFI_BOOT_PROTOCOL_GUID \ 32 | { 0xccd15fec, 0x6f73, 0x4eec, \ 33 | { 0x83, 0x95, 0x3e, 0x69, 0xe4, 0xb9, 0x40, 0xbf } } 34 | ---- 35 | 36 | === Revision Number 37 | [source,C] 38 | ---- 39 | #define RISCV_EFI_BOOT_PROTOCOL_REVISION 0x00010000 40 | #define RISCV_EFI_BOOT_PROTOCOL_LATEST_VERSION \ 41 | RISCV_EFI_BOOT_PROTOCOL_REVISION 42 | ---- 43 | 44 | === Protocol Interface Structure 45 | [source,C] 46 | ---- 47 | typedef struct _RISCV_EFI_BOOT_PROTOCOL { 48 | UINT64 Revision; 49 | EFI_GET_BOOT_HARTID GetBootHartId; 50 | } RISCV_EFI_BOOT_PROTOCOL; 51 | ---- 52 | 53 | ==== RISCV_EFI_BOOT_PROTOCOL.GetBootHartId 54 | This interface provides the hartid of the boot cpu. 55 | 56 | ===== Prototype 57 | [source,C] 58 | ---- 59 | typedef EFI_STATUS 60 | (EFIAPI *EFI_GET_BOOT_HARTID) ( 61 | IN RISCV_EFI_BOOT_PROTOCOL *This, 62 | OUT UINTN *BootHartId 63 | ); 64 | ---- 65 | 66 | ===== Parameters 67 | .GetBootHartId Parameters 68 | [cols="1,3",options="header"] 69 | |=== 70 | |Parameter | Description 71 | | *This* | Pointer to the protocol 72 | | *BootHartId* | Pointer to the variable receiving the hartid of the boot cpu. 73 | |=== 74 | 75 | ===== Status Codes Returned 76 | .GetBootHartId Return Value 77 | [cols="1,2",options="header"] 78 | |=== 79 | |Return Value | Description 80 | | *EFI_SUCCESS* | The boot hart id could be returned. 81 | | *EFI_INVALID_PARAMETER* | *This* parameter is NULL or does not point to a valid RISCV_EFI_BOOT_PROTOCOL implementation. 82 | | *EFI_INVALID_PARAMETER* | *BootHartId* parameter is NULL. 83 | |=== 84 | -------------------------------------------------------------------------------- /contributors.adoc: -------------------------------------------------------------------------------- 1 | == Contributors 2 | 3 | This RISC-V specification has been contributed to directly or indirectly by: 4 | 5 | [%hardbreaks] 6 | * Sunil V L 7 | * Ard Biesheuvel 8 | * Heinrich Schuchardt 9 | * Jessica Clarke 10 | * Atish Patra 11 | * Anup Patel 12 | * Abner Chang 13 | -------------------------------------------------------------------------------- /dependencies/Gemfile: -------------------------------------------------------------------------------- 1 | source 'https://rubygems.org' 2 | gem 'asciidoctor' 3 | gem 'asciidoctor-bibtex' 4 | gem 'asciidoctor-diagram' 5 | gem 'asciidoctor-mathematical' 6 | gem 'asciidoctor-pdf' 7 | gem 'citeproc-ruby' 8 | gem 'coderay' 9 | gem 'csl-styles' 10 | gem 'json' 11 | gem 'pygments.rb' 12 | gem 'rghost' 13 | gem 'rouge' 14 | gem 'ruby_dev' 15 | -------------------------------------------------------------------------------- /dependencies/README.md: -------------------------------------------------------------------------------- 1 | Dependencies for the build environment for various package managers. Used in 2 | `.github/workflows/`. 3 | 4 | -------------------------------------------------------------------------------- /dependencies/apt_packages.txt: -------------------------------------------------------------------------------- 1 | bison 2 | build-essential 3 | cmake 4 | curl 5 | flex 6 | fonts-lyx 7 | git 8 | graphviz 9 | # For wavedrom 10 | default-jre 11 | libcairo2-dev 12 | libffi-dev 13 | libgdk-pixbuf2.0-dev 14 | libpango1.0-dev 15 | libxml2-dev 16 | make 17 | pkg-config 18 | ruby 19 | ruby-dev 20 | -------------------------------------------------------------------------------- /dependencies/package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "local", 3 | "version": "0.0.1", 4 | "dependencies": { 5 | "wavedrom-cli": "^2.6.8" 6 | } 7 | } 8 | -------------------------------------------------------------------------------- /efi_protocol.bib: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/riscv-non-isa/riscv-uefi/3e4309410039faf8f71f81c9ae2191c011b852fe/efi_protocol.bib -------------------------------------------------------------------------------- /header.adoc: -------------------------------------------------------------------------------- 1 | [[header]] 2 | :description: RISC-V UEFI PROTOCOL Specification 3 | :company: RISC-V.org 4 | :revdate: 05/09/2022 5 | :revnumber: 1.0.0 6 | :revremark: Ratified 7 | :url-riscv: http://riscv.org 8 | :doctype: book 9 | :preface-title: Preamble 10 | :colophon: 11 | :appendix-caption: Appendix 12 | :imagesdir: images 13 | :title-logo-image: image:riscv-logo.svg[pdfwidth=3.25in,align=center] 14 | // Settings: 15 | :experimental: 16 | :reproducible: 17 | // needs to be changed? bug discussion started 18 | //:WaveDromEditorApp: app/wavedrom-editor.app 19 | :imagesoutdir: images 20 | :bibtex-file: efi_protocol.bib 21 | :bibtex-order: alphabetical 22 | :bibtex-style: apa 23 | :icons: font 24 | :lang: en 25 | :listing-caption: Listing 26 | :sectnums: 27 | :toc: left 28 | :toclevels: 4 29 | :source-highlighter: pygments 30 | ifdef::backend-pdf[] 31 | :source-highlighter: coderay 32 | endif::[] 33 | :data-uri: 34 | :hide-uri-scheme: 35 | :stem: latexmath 36 | :footnote: 37 | :xrefstyle: short 38 | 39 | = RISC-V UEFI PROTOCOL Specification 40 | RISC-V Platform HSC Group 41 | 42 | // Preable 43 | [WARNING] 44 | .This document is in the link:http://riscv.org/spec-state[Ratified state] 45 | ==== 46 | No changes are allowed. Any desired or needed changes can be the subject of 47 | a follow-on new extension. Ratified extensions are never revised. 48 | ==== 49 | 50 | [preface] 51 | == Copyright and license information 52 | This specification is licensed under the Creative Commons 53 | Attribution 4.0 International License (CC-BY 4.0). The full 54 | license text is available at 55 | https://creativecommons.org/licenses/by/4.0/. 56 | 57 | Copyright 2022 by RISC-V International. 58 | 59 | [preface] 60 | include::contributors.adoc[] 61 | 62 | include::intro.adoc[] 63 | include::boot_protocol.adoc[] 64 | //the index must precede the bibliography 65 | //include::index.adoc[] 66 | include::bibliography.adoc[] 67 | -------------------------------------------------------------------------------- /images/riscv-logo.svg: -------------------------------------------------------------------------------- 1 | ../docs-resources/images/riscv-logo.svg -------------------------------------------------------------------------------- /intro.adoc: -------------------------------------------------------------------------------- 1 | [[intro]] 2 | == Introduction 3 | This specification details all new UEFI protocols required only for 4 | RISC-V platforms. These protocol specs are maintained by RISC-V community. 5 | 6 | == Revision History 7 | [cols="1,1,3",options="header"] 8 | |=== 9 | |Date | Revision | Change 10 | |05/09/2022 | 1.0.0 | Ratified version 11 | |03/23/2022 | 1.0-rc3 | Frozen version 12 | |01/21/2022 | 1.0-rc2 | Few documentation template changes 13 | |01/18/2022 | 1.0-rc1 | Renamed EFI_RISCV_BOOT_PROTOCOL to 14 | RISCV_EFI_BOOT_PROTOCOL as per Ard's feedback. 15 | |01/13/2022 | 0.3 Draft | Improved text as per feedback from Atish. 16 | |01/12/2022 | 0.2 Draft | 1) Added wrapper EFI_PROTOCOL spec + 17 | 2) Added protocol revision field directly in 18 | BOOT_PROTOCOL and remove GetProtocolVersion + 19 | 3) Changed UINT32 * to UINTN * for BootHartId in 20 | BOOT_PROTOCOL 21 | |01/10/2022 | 0.1 Draft | Initial Draft for Platform HSC review 22 | |=== 23 | -------------------------------------------------------------------------------- /readme.adoc: -------------------------------------------------------------------------------- 1 | = RISC-V UEFI PROTOCOL Specification 2 | 3 | RISC-V Platforms need special UEFI Protocols. The discussion of such 4 | requirements occurs on the https://lists.riscv.org/g/tech-unixplatformspec[RISC-V Unix Platform Mailing 5 | list]. It is publicly readable but posting requires being a member of the 6 | RISC-V Foundation. Any new UEFI Protocol needs to be discussed and approved 7 | there before being merged. Once approved in RISC-V community, it can be 8 | added/referenced to the UEFI spec maintained by UEFI forum. 9 | 10 | = License 11 | 12 | This work is licensed under a Creative Commons Attribution 4.0 International License (CC-BY-4.0). 13 | See the https://github.com/riscv/docs-spec-template/blob/main/LICENSE[LICENSE] file for details. 14 | 15 | = Contributors 16 | 17 | Contributors to this specification are contained in the 18 | https://github.com/riscv-non-isa/riscv-uefi/blob/main/contributors.adoc[contributors.adoc] file. 19 | 20 | = Dependencies 21 | 22 | This project is built using AsciiDoctor (Ruby). The repository has been setup to build the PDF on 23 | checkin using GitHub actions. Workflow ependencies are located in the `dependencies` directory. 24 | 25 | For more information on the AsciiDoctor, specification guidelines, or building locally, see the 26 | https://github.com/riscv/docs-dev-guide[RISC-V Documentation Developer Guide]. 27 | 28 | = Cloning the project 29 | 30 | This project uses https://git-scm.com/book/en/v2/Git-Tools-Submodules[GitHub Submodules] 31 | to include the https://github.com/riscv/docs-resources[RISC-V docs-resources project] 32 | to achieve a common look and feel. 33 | 34 | When cloning this repository for the first time, you must either use 35 | `git clone --recurse-submodules` or execute `git submodule init` and `git submodule update` after the clone to populate the docs-resources directory. Failure to clone the submodule, will result 36 | in the PDF build fail with an error message like the following: 37 | 38 | $ make 39 | asciidoctor-pdf \ 40 | -a toc \ 41 | -a compress \ 42 | -a pdf-style=docs-resources/themes/riscv-pdf.yml \ 43 | -a pdf-fontsdir=docs-resources/fonts \ 44 | --failure-level=ERROR \ 45 | -o profiles.pdf profiles.adoc 46 | asciidoctor: ERROR: could not locate or load the built-in pdf theme `docs-resources/themes/riscv-pdf.yml'; reverting to default theme 47 | No such file or directory - notoserif-regular-subset.ttf not found in docs-resources/fonts 48 | Use --trace for backtrace 49 | make: *** [Makefile:7: profiles.pdf] Error 1 50 | 51 | = Building the document 52 | 53 | The final specification form of PDF can be generated using the `make` command. 54 | --------------------------------------------------------------------------------