doc: fix misspellings
Fix misspellings missed during regular reviews Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
This commit is contained in:
parent
c42f5c5cb6
commit
e7605fad7d
|
@ -56,7 +56,7 @@ the LPC bus. In the current implementation, two channel LPC UARTs are I/O mapped
|
||||||
the traditional COM port addresses of 0x3F8 and 0x2F8. These are defined in
|
the traditional COM port addresses of 0x3F8 and 0x2F8. These are defined in
|
||||||
global variable ``uart_lres``.
|
global variable ``uart_lres``.
|
||||||
|
|
||||||
There are two options needed for configuring the UART in the ``arcn-dm``
|
There are two options needed for configuring the UART in the ``acrn-dm``
|
||||||
command line. First, the LPC is defined as a PCI device::
|
command line. First, the LPC is defined as a PCI device::
|
||||||
|
|
||||||
-s 1:0,lpc
|
-s 1:0,lpc
|
||||||
|
@ -78,7 +78,7 @@ command line, for example::
|
||||||
-l com1,/dev/pts/1
|
-l com1,/dev/pts/1
|
||||||
|
|
||||||
|
|
||||||
When arcn-dm starts, ``pci_lpc_init`` is called as the callback of the
|
When acrn-dm starts, ``pci_lpc_init`` is called as the callback of the
|
||||||
``vdev_init`` of the PCI device given on the acrn-dm command line.
|
``vdev_init`` of the PCI device given on the acrn-dm command line.
|
||||||
Later, ``lpc_init`` is called in ``pci_lpc_init``. ``lpc_init`` iterates
|
Later, ``lpc_init`` is called in ``pci_lpc_init``. ``lpc_init`` iterates
|
||||||
on the available UART instances defined on the command line and
|
on the available UART instances defined on the command line and
|
||||||
|
|
|
@ -536,7 +536,7 @@ The module level configuration design rules are shown below:
|
||||||
|
|
||||||
6. In order to guarantee that the function pointer in the operations data
|
6. In order to guarantee that the function pointer in the operations data
|
||||||
structure is dereferenced after it has been instantiated, the pre-condition
|
structure is dereferenced after it has been instantiated, the pre-condition
|
||||||
shall be added for the function which deferences the function pointer,
|
shall be added for the function which dereferences the function pointer,
|
||||||
instead of checking the pointer for NULL.
|
instead of checking the pointer for NULL.
|
||||||
|
|
||||||
.. note:: The third rule shall be double checked during code review.
|
.. note:: The third rule shall be double checked during code review.
|
||||||
|
|
|
@ -54,7 +54,7 @@ Software setup
|
||||||
Set up a Clear Linux Operating System
|
Set up a Clear Linux Operating System
|
||||||
=====================================
|
=====================================
|
||||||
|
|
||||||
Currently, an installable version of ARCN does not exist. Therefore, you
|
Currently, an installable version of ACRN does not exist. Therefore, you
|
||||||
need to setup a base Clear Linux OS and you'll build and bootstrap ACRN
|
need to setup a base Clear Linux OS and you'll build and bootstrap ACRN
|
||||||
on your platform. You'll need a network connection for your platform to
|
on your platform. You'll need a network connection for your platform to
|
||||||
complete this setup.
|
complete this setup.
|
||||||
|
|
|
@ -9,7 +9,7 @@ source, follow these steps.
|
||||||
Install build tools and dependencies
|
Install build tools and dependencies
|
||||||
************************************
|
************************************
|
||||||
|
|
||||||
ARCN development is supported on popular Linux distributions,
|
ACRN development is supported on popular Linux distributions,
|
||||||
each with their own way to install development tools:
|
each with their own way to install development tools:
|
||||||
|
|
||||||
.. note::
|
.. note::
|
||||||
|
|
|
@ -540,7 +540,7 @@ initial release in March 2018 (click on the CommitID link to see details):
|
||||||
- :acrn-commit:`ba1b034` fix MISRA-C 243S
|
- :acrn-commit:`ba1b034` fix MISRA-C 243S
|
||||||
- :acrn-commit:`9af35ba` DM:monitor: add monitor_register_vm_ops()
|
- :acrn-commit:`9af35ba` DM:monitor: add monitor_register_vm_ops()
|
||||||
- :acrn-commit:`eada59c` DM: adapt dm-monitor and acrnctl to use the helpers
|
- :acrn-commit:`eada59c` DM: adapt dm-monitor and acrnctl to use the helpers
|
||||||
- :acrn-commit:`53ecd93` Tools: acrn-manager: add definitions of message sturcts
|
- :acrn-commit:`53ecd93` Tools: acrn-manager: add definitions of message structs
|
||||||
- :acrn-commit:`7d7cf30` Tools: acrn-manager: add lib with IPC helpers
|
- :acrn-commit:`7d7cf30` Tools: acrn-manager: add lib with IPC helpers
|
||||||
- :acrn-commit:`c001911` dm: virtio: support virtio 1.0 PCI configuration access capability
|
- :acrn-commit:`c001911` dm: virtio: support virtio 1.0 PCI configuration access capability
|
||||||
- :acrn-commit:`b25a30f` dm: add default handling in pci_emul_capwrite
|
- :acrn-commit:`b25a30f` dm: add default handling in pci_emul_capwrite
|
||||||
|
|
|
@ -82,7 +82,7 @@ New Features Details
|
||||||
- :acrn-issue:`2431` - VPCI code cleanup
|
- :acrn-issue:`2431` - VPCI code cleanup
|
||||||
- :acrn-issue:`2448` - Adding support for socket as a backend for Virtio-Console
|
- :acrn-issue:`2448` - Adding support for socket as a backend for Virtio-Console
|
||||||
- :acrn-issue:`2462` - Enable cache QOS with CAT
|
- :acrn-issue:`2462` - Enable cache QOS with CAT
|
||||||
- :acrn-issue:`2496` - VTD/IOMMU Modulization
|
- :acrn-issue:`2496` - VTD/IOMMU Modularization
|
||||||
|
|
||||||
Fixed Issues Details
|
Fixed Issues Details
|
||||||
********************
|
********************
|
||||||
|
@ -93,7 +93,7 @@ Fixed Issues Details
|
||||||
- :acrn-issue:`1782` - UOS failed to get ip with the pass-throughed network card
|
- :acrn-issue:`1782` - UOS failed to get ip with the pass-throughed network card
|
||||||
- :acrn-issue:`1999` - [APLNUC][KBLNUC][APLUP2]UOS reset fails with acrnctl reset command
|
- :acrn-issue:`1999` - [APLNUC][KBLNUC][APLUP2]UOS reset fails with acrnctl reset command
|
||||||
- :acrn-issue:`2276` - OVMF failed to launch UOS on UP2
|
- :acrn-issue:`2276` - OVMF failed to launch UOS on UP2
|
||||||
- :acrn-issue:`2298` - Hardcodes path to iasl
|
- :acrn-issue:`2298` - Hard codes path to iasl
|
||||||
- :acrn-issue:`2316` - Tools don't respect CFLAGS/LDFLAGS from environment
|
- :acrn-issue:`2316` - Tools don't respect CFLAGS/LDFLAGS from environment
|
||||||
- :acrn-issue:`2338` - [UP2]Lost 2G memory in SOS when using SBL as bootloader on UP2
|
- :acrn-issue:`2338` - [UP2]Lost 2G memory in SOS when using SBL as bootloader on UP2
|
||||||
- :acrn-issue:`2370` - Doesn't use parallel make in subbuilds
|
- :acrn-issue:`2370` - Doesn't use parallel make in subbuilds
|
||||||
|
@ -297,7 +297,7 @@ release in Feb 2019 (click on the CommitID link to see details):
|
||||||
- :acrn-commit:`56afe97e` - doc: fix broken external links
|
- :acrn-commit:`56afe97e` - doc: fix broken external links
|
||||||
- :acrn-commit:`e263b554` - HV: Fix modularization vm config code lost CAT code
|
- :acrn-commit:`e263b554` - HV: Fix modularization vm config code lost CAT code
|
||||||
- :acrn-commit:`703b366c` - dm: use power button acpi device to find its input event
|
- :acrn-commit:`703b366c` - dm: use power button acpi device to find its input event
|
||||||
- :acrn-commit:`8a324060` - ACRN: dm: Fix luanch UOS script "-d" parameter fail issue
|
- :acrn-commit:`8a324060` - ACRN: dm: Fix launch UOS script "-d" parameter fail issue
|
||||||
- :acrn-commit:`06118998` - OVMF release v0.7
|
- :acrn-commit:`06118998` - OVMF release v0.7
|
||||||
- :acrn-commit:`6794660e` - HV: use the common functions defined in vdev.c to reduce duplicate code
|
- :acrn-commit:`6794660e` - HV: use the common functions defined in vdev.c to reduce duplicate code
|
||||||
- :acrn-commit:`be3fbaa4` - HV: add generic vdev functions to vdev.c
|
- :acrn-commit:`be3fbaa4` - HV: add generic vdev functions to vdev.c
|
||||||
|
@ -324,7 +324,7 @@ release in Feb 2019 (click on the CommitID link to see details):
|
||||||
- :acrn-commit:`e38ff18b` - hv:cleanup header files for release folder
|
- :acrn-commit:`e38ff18b` - hv:cleanup header files for release folder
|
||||||
- :acrn-commit:`33ecdd73` - Makefile: undefine _FORTIFY_SOURCE prior using it
|
- :acrn-commit:`33ecdd73` - Makefile: undefine _FORTIFY_SOURCE prior using it
|
||||||
- :acrn-commit:`3b2784ec` - HV: CAT: support config CAT from acrn_vm_config
|
- :acrn-commit:`3b2784ec` - HV: CAT: support config CAT from acrn_vm_config
|
||||||
- :acrn-commit:`43ee5590` - HV: CAT: capability enumaration
|
- :acrn-commit:`43ee5590` - HV: CAT: capability enumeration
|
||||||
- :acrn-commit:`cf524e68` - HV: CAT: add platform specified info for CLOS
|
- :acrn-commit:`cf524e68` - HV: CAT: add platform specified info for CLOS
|
||||||
- :acrn-commit:`ae34fdd8` - doc: fix misspellings
|
- :acrn-commit:`ae34fdd8` - doc: fix misspellings
|
||||||
- :acrn-commit:`a9482f46` - tweak GSG
|
- :acrn-commit:`a9482f46` - tweak GSG
|
||||||
|
@ -364,11 +364,11 @@ release in Feb 2019 (click on the CommitID link to see details):
|
||||||
- :acrn-commit:`02ae775b` - hv: pae: fix a issue of loading pdptrs when handle cr4
|
- :acrn-commit:`02ae775b` - hv: pae: fix a issue of loading pdptrs when handle cr4
|
||||||
- :acrn-commit:`25385241` - hv: pae: fix bug when calculate PDPT address
|
- :acrn-commit:`25385241` - hv: pae: fix bug when calculate PDPT address
|
||||||
- :acrn-commit:`21ae3e74` - DM: virtio-gpio: add print log
|
- :acrn-commit:`21ae3e74` - DM: virtio-gpio: add print log
|
||||||
- :acrn-commit:`6b0643b5` - DM: virtio-gpio: implementation of gpio opearations
|
- :acrn-commit:`6b0643b5` - DM: virtio-gpio: implementation of gpio operations
|
||||||
- :acrn-commit:`77e17b5d` - DM: virtio-gpio: gpio initialization.
|
- :acrn-commit:`77e17b5d` - DM: virtio-gpio: gpio initialization.
|
||||||
- :acrn-commit:`57029315` - DM: virtio-gpio: virtio framework implementation.
|
- :acrn-commit:`57029315` - DM: virtio-gpio: virtio framework implementation.
|
||||||
- :acrn-commit:`5300e911` - config: enable parsing dmar table dynamically on UP2
|
- :acrn-commit:`5300e911` - config: enable parsing dmar table dynamically on UP2
|
||||||
- :acrn-commit:`8e8ed07d` - dm: implement power button for power managerment
|
- :acrn-commit:`8e8ed07d` - dm: implement power button for power management
|
||||||
- :acrn-commit:`b24a8a0f` - hv:cleanup header file for guest folder
|
- :acrn-commit:`b24a8a0f` - hv:cleanup header file for guest folder
|
||||||
- :acrn-commit:`75f6cab5` - hv:cleanup header file for per_cpu.h
|
- :acrn-commit:`75f6cab5` - hv:cleanup header file for per_cpu.h
|
||||||
- :acrn-commit:`c093638b` - hv:merge two header files to one with the same name
|
- :acrn-commit:`c093638b` - hv:merge two header files to one with the same name
|
||||||
|
|
|
@ -276,7 +276,7 @@ release in Feb 2019 (click on the CommitID link to see details):
|
||||||
- :acrn-commit:`83a98acb` - DM: virtio-gpio: support reading value from IRQ descriptor
|
- :acrn-commit:`83a98acb` - DM: virtio-gpio: support reading value from IRQ descriptor
|
||||||
- :acrn-commit:`d34b3ebd` - DM: virtio-gpio: emulate GPIO IRQ controller
|
- :acrn-commit:`d34b3ebd` - DM: virtio-gpio: emulate GPIO IRQ controller
|
||||||
- :acrn-commit:`92a0a399` - DM: virtio-gpio: GPIO IRQ initialization.
|
- :acrn-commit:`92a0a399` - DM: virtio-gpio: GPIO IRQ initialization.
|
||||||
- :acrn-commit:`9480af8d` - DM: virtio-gpio: setup two virqueues for gpio irq
|
- :acrn-commit:`9480af8d` - DM: virtio-gpio: setup two virtqueues for gpio irq
|
||||||
- :acrn-commit:`e381aef2` - hv: seed: remove unused seed parsing source files
|
- :acrn-commit:`e381aef2` - hv: seed: remove unused seed parsing source files
|
||||||
- :acrn-commit:`0947fbab` - HV: Fix a compiler warning in firmware.h
|
- :acrn-commit:`0947fbab` - HV: Fix a compiler warning in firmware.h
|
||||||
- :acrn-commit:`071ce15e` - dm: build E820 map for OVMF
|
- :acrn-commit:`071ce15e` - dm: build E820 map for OVMF
|
||||||
|
|
|
@ -5,7 +5,7 @@ ACRN documentation generation
|
||||||
|
|
||||||
These instructions will walk you through generating the Project ACRN's
|
These instructions will walk you through generating the Project ACRN's
|
||||||
documentation and publishing it to https://projectacrn.github.io.
|
documentation and publishing it to https://projectacrn.github.io.
|
||||||
You can also use these instructions to generate the ARCN documentation
|
You can also use these instructions to generate the ACRN documentation
|
||||||
on your local system.
|
on your local system.
|
||||||
|
|
||||||
Documentation overview
|
Documentation overview
|
||||||
|
|
|
@ -20,7 +20,7 @@ so that the VM will not evict the masked cache lines, as shown in :numref:
|
||||||
CAT Support on ACRN
|
CAT Support on ACRN
|
||||||
*******************
|
*******************
|
||||||
|
|
||||||
As described at `Intel (R) 64 and IA-32 Architectures Software Developer’s Manual
|
As described at `Intel (R) 64 and IA-32 Architectures Software Developer's Manual
|
||||||
<https://software.intel.com/en-us/download/intel-64-and-ia-32-architectures-sdm-combined-volumes-3a-3b-3c-and-3d-system-programming-guide>`_,
|
<https://software.intel.com/en-us/download/intel-64-and-ia-32-architectures-sdm-combined-volumes-3a-3b-3c-and-3d-system-programming-guide>`_,
|
||||||
chapter 17.19, volume 3. There are 3 steps to use CAT:
|
chapter 17.19, volume 3. There are 3 steps to use CAT:
|
||||||
|
|
||||||
|
@ -86,7 +86,7 @@ for the HV shell (refer to :ref:`getting-started-up2` for setup instructions).
|
||||||
|
|
||||||
.. code-block:: none
|
.. code-block:: none
|
||||||
|
|
||||||
ACRN:\>wrmsr –p1 0xc8f 0x100000000
|
ACRN:\>wrmsr -p1 0xc8f 0x100000000
|
||||||
|
|
||||||
Configure CAT for VM with VM Configuration
|
Configure CAT for VM with VM Configuration
|
||||||
##########################################
|
##########################################
|
||||||
|
|
|
@ -231,7 +231,7 @@ The ``acrnprobe`` detects all critical events on the platform and collects
|
||||||
specific information for debug purpose. These information would be saved as
|
specific information for debug purpose. These information would be saved as
|
||||||
logs, and the log path would be delivered to telemetrics-client as a record if
|
logs, and the log path would be delivered to telemetrics-client as a record if
|
||||||
the telemetrics-client existed on the system.
|
the telemetrics-client existed on the system.
|
||||||
For more detail on arcnprobe, please refer :ref:`acrnprobe_doc`.
|
For more detail on acrnprobe, please refer :ref:`acrnprobe_doc`.
|
||||||
|
|
||||||
usercrash
|
usercrash
|
||||||
=========
|
=========
|
||||||
|
|
Loading…
Reference in New Issue