Skip to content

Commit be803f4

Browse files
HU90mrivos-eblot
authored andcommitted
[ot] Fixed some typos in the opentitan documentation.
Signed-off-by: Hugo McNally <[email protected]>
1 parent 50b9fc3 commit be803f4

File tree

5 files changed

+16
-16
lines changed

5 files changed

+16
-16
lines changed

docs/opentitan/checkregs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
`checkregs.py` checks whether QEMU register definitions for OpenTitan match the generated OpenTitan
44
`*_regs.h` files. This enables to spot major differences whenever OpenTitan definitions are updated.
55

6-
Note that only register addresses are checked for now, the bit assignement in each register is not
6+
Note that only register addresses are checked for now, the bit assignment in each register is not
77
validated.
88

99
## Usage

docs/opentitan/earlgrey.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ Devices in this group implement subset(s) of the real HW.
4343
* CSRNG
4444
* AES CTR not supported (uses xoroshiro128++ reseeded from entropy src)
4545

46-
### Sparsely implemented adevices
46+
### Sparsely implemented devices
4747

4848
In this group, device CSRs are supported (w/ partial or full access control & masking) but only some
4949
features are implemented.
@@ -96,7 +96,7 @@ generate the `.raw` image files.
9696

9797
## Available tools
9898

99-
Launching a QEMU VM with the right option switches may rapidely become complex due to the number
99+
Launching a QEMU VM with the right option switches may rapidly become complex due to the number
100100
of options and the available features. Several helper tools are provided in the `scripts/opentitan`
101101
directory to help with these tasks.
102102

@@ -118,7 +118,7 @@ directory to help with these tasks.
118118
### vCPU
119119

120120
* `-icount 6` reduces the execution speed of the vCPU (Ibex core) to 1GHz >> 6, _i.e._ ~15MHz,
121-
which should roughly match the expected speed of the Ibex core runninng on the CW310 FPGA, which
121+
which should roughly match the expected speed of the Ibex core running on the CW310 FPGA, which
122122
is set to 10 MHz. This option is very useful/mandatory to run many OpenTitan tests that rely on
123123
time or CPU cycle to validate features. Using `-icount` option slows down execution speed though,
124124
so it is not recommended to use it when the main goal is to develop SW to run on the virtual
@@ -133,7 +133,7 @@ directory to help with these tasks.
133133

134134
### AES
135135

136-
* `-global ot-aes.fast-mode=false` can be used to better emulate AES HW IP, as some OT tests expects
136+
* `-global ot-aes.fast-mode=false` can be used to better emulate AES HW IP, as some OT tests expect
137137
the Ibex core to execute while the HW is performing AES rounds. Without this option, the virtual
138138
HW may only give back execution to the vCPU once the AES operation is complete, which make those
139139
OT tests to fail. Disabling fast mode better emulates the HW to the expense of higher AES latency
@@ -216,7 +216,7 @@ to enumerate these log features, however the most useful ones are enumerated her
216216

217217
* `unimp` reports log messages for unimplemented features, _e.g._ when the vCPU attempts to
218218
read from or write into a memory mapped device that has not been implemented.
219-
* `guest_errors` repots log messages of invalid guest software requests, _e.g._ attempts to
219+
* `guest_errors` reports log messages of invalid guest software requests, _e.g._ attempts to
220220
perform an invalid configuration.
221221
* `int` reports all interruptions *and* exceptions handled by the vCPU. It may be quite verbose
222222
but also very useful to track down an invalid memory or I/O access for example. This is the

docs/opentitan/flashgen.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -42,10 +42,10 @@ The (signed) binary files contain no symbols, which can make low-level debugging
4242
when using the `-d in_asm` and/or `-d exec` option switches.
4343

4444
If an ELF file with the same radix as a binary file is located in the directory of the binary
45-
file, or its location is specified with on the command line, the path to the ELF file is encoded
46-
into the flash image into a dedicated debug section.
45+
file, or its location is specified in the command line, the path to the ELF file is encoded
46+
into the flash image within a dedicated debug section.
4747

48-
The OT flash controller emulation, when the stored ELF file exists, attemps to load the symbols
48+
The OT flash controller emulation, when the stored ELF file exists, attempts to load the symbols
4949
from this ELF file into QEMU disassembler. This enables the QEMU disassembler - used with the
5050
`in_asm`/`exec` QEMU options - to output the name of each executed function as an addition to the
5151
guest PC value.
@@ -58,7 +58,7 @@ matching signed binary files to help with debugging.
5858
* `-a bank` specify the data partition to store the binary file into, mutually exclusive with `-t`.
5959

6060
* `-B elf` specify an alternative path to the BL0 ELF file. If not specified, the ELF path file is
61-
recontructed from the specified binary file (from the same directory). The ELF file is only used
61+
reconstructed from the specified binary file (from the same directory). The ELF file is only used
6262
as a hint for QEMU loader. Requires option `-b`, mutually exclusive with `-t`.
6363

6464
* `-b file` specify the BL0 (signed) binary file to store in the data partition of the flash
@@ -82,7 +82,7 @@ matching signed binary files to help with debugging.
8282
This option is mutually exclusive with `-b`, `-B`, `-x`, `-X` and `-a`.
8383

8484
* `-X elf` specify an alternative path to the ROM_EXT ELF file. If not specified, the ELF path file
85-
is recontructed from the specified binary file (from the same directory). The ELF file is only
85+
is reconstructed from the specified binary file (from the same directory). The ELF file is only
8686
used as a hint for QEMU loader. Requires option `-x`, mutually exclusive with `-t`.
8787

8888
* `-x file` specify the ROM_EXT (signed) binary file or the application to store into the data

docs/opentitan/otpconv.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ This script works in three different modes.
4343

4444
* `-b` byte-swap in input VMEM words (should work Ok w/o this option)
4545

46-
* `-c` specify the register file, which is only useful to decoce OTP content (see `-s` option)
46+
* `-c` specify the register file, which is only useful to decode OTP content (see `-s` option)
4747

4848
* `-d` only useful to debug the script, reports any Python traceback to the standard error stream.
4949

docs/opentitan/pyot.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ Files:
5252

5353
This tool may be used in two ways, which can be combined:
5454

55-
* From the command line, it is possible to run a QEMU test session for one application,
55+
* From the command line, it is possible to run a QEMU test session for one application.
5656
* Using a JSON configuration file, it is possible to run several QEMU test sessions for each
5757
specified test in the configuration file. This mode is enabled when a JSON config file is
5858
specified.
@@ -427,7 +427,7 @@ Sample config for running some non-OpenTitan tests:
427427
This section defines shortcut to further reduce the definition and report of test filenames.
428428

429429
Any test filename ending up with one of the suffixes is automatically stripped. Further test
430-
configuration in the the `tests` section should omit this suffix. The generated test report also
430+
configuration in the `tests` section should omit this suffix. The generated test report also
431431
omit these suffixes.
432432

433433
* `tests`
@@ -456,7 +456,7 @@ commands:
456456
session is over
457457

458458
Regular or 'synchronous' commands are only executed if all the previous commands have been
459-
succesful. Moreover, commands in the `post` subsection are only executed if the QEMU session has
459+
successful. Moreover, commands in the `post` subsection are only executed if the QEMU session has
460460
completed successfully.
461461

462462
Background commands are commands that run in the background till they complete on their own, or
@@ -497,7 +497,7 @@ aes_test,pass,0.044,6,
497497

498498
## Return value
499499

500-
The script returns the error code of the most occuring error, or success (0)
500+
The script returns the error code of the most occurring error, or success (0)
501501

502502
## Examples
503503

0 commit comments

Comments
 (0)