Commit Graph

305 Commits

Author SHA1 Message Date
Reyes, Amy 4d49876366 doc: Update sdc reference in overview hld
- Clarify that sdc predefined scenario is no longer supported
- Minor cleanup

Tracked-On: #6701
Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-03-22 12:08:26 -07:00
Chenli Wei 7dec39a9e8 doc: change the parameter of virtio-net
Remove device name requirement for “tap” and "vmnet", change the
parameter format like:
"-s 4,virtio-net,tap/vmnet=dev_name".
change mac_seed to virtio-net sub-parameter
As a parameter of acrn-dm,the mac_seed is only used for virtio-net.
So this patch change it to the sub-parameter of virtio-net.
The final format is:
-s 4,virtio-net,tap/vmnet=dev_name,mac_seed=XXXX

Tracked-On: #6690
Signed-off-by: Chenli Wei chenli.wei@linux.intel.com
2022-03-20 20:21:56 -07:00
Reyes, Amy f5b021b1b5 doc: Minor style cleanup
- Remove "currently"
- Capitalize titles and Device Model

Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-03-18 16:35:00 -07:00
Reyes, Amy 21aeb4f422 doc: Style cleanup in host bridge hld
Style changes per Acrolinx recommendations and for consistency

Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-03-18 15:38:52 -07:00
Reyes, Amy a3ebc4f19e doc: Style cleanup in hypercall hld
Style changes per Acrolinx recommendations and for consistency

Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-03-18 12:24:01 -07:00
Reyes, Amy 09980e778e doc: Style cleanup in CPU virt hld
Style changes per Acrolinx recommendations and for consistency

Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-03-18 11:28:34 -07:00
Reyes, Amy 0178cf51da doc: Fix line wrap in ivshmem hld
Wrap long lines

Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-03-09 13:44:10 -08:00
Reyes, Amy 5c52f6fc2c doc: Style cleanup in timer hld
- Minor style changes per Acrolinx recommendations and for consistency

Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-02-28 12:17:00 -08:00
Reyes, Amy a98f623a35 doc: Style cleanup in ivshmem hld
- Minor style changes per Acrolinx recommendations and for consistency

Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-02-28 10:46:06 -08:00
Reyes, Amy 72a9b7bae3 doc: Style cleanup in usercrash, trusty, vuart docs
- Minor style changes per Acrolinx recommendations and for consistency

Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-02-27 13:33:21 -08:00
Reyes, Amy 85fe6d7d1a doc: Style cleanup in dm, gpio, interrupt hld
Minor style changes per Acrolinx recommendations and for consistency

Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-02-27 13:29:48 -08:00
Chenli Wei b41ff11a9c doc: add UID parameter for acpidev_pt
Now the acpidev_pt module only use the hid to check the device,it can't
work well if there are more then one instance.

So this patch add UID to identify same type device to fix these issue.

Tracked-On: #6690
Signed-off-by: Chenli Wei <chenli.wei@linux.intel.com>
2022-02-22 09:44:02 -08:00
Yuanyuan Zhao 8c046616c8 doc: dm cpu affinity dynamic param refine
Cpu affinty was set by pCPU ID which can't be obtained
explictly by user. Use lapic ID instead which can be easily
read from `/proc/cpuinfo` as `apicid`.

Signed-off-by: Yuanyuan Zhao <yuanyuan.zhao@linux.intel.com>
2022-01-26 09:37:23 -08:00
Yuanyuan Zhao f731904638 doc: remove short version of dm dynamic param `-W`
Rename '--virtio_msix' to '--virtio_msi' for this param
means 'force virtio to use singel-vector MSI'.

Remove the `-W` which is the short version of `--virtio_msi`.

Tracked-On: #6690
Signed-off-by: Yuanyuan Zhao <yuanyuan.zhao@linux.intel.com>
2022-01-24 09:07:39 -08:00
Yuanyuan Zhao 75884af9ac doc: remove dm dynamic param '-A'
Update document to remove 'acrn-dm' dynamic param '-A'.

Signed-off-by: Yuanyuan Zhao <yuanyuan.zhao@linux.intel.com>
2022-01-21 16:07:37 -08:00
Chenli Wei fa8837b5ff doc: remove some dynamic parameters from acrn-dm usage
The following parameters have not used by new design:

1.  --vsbl <vsbl_file_path>
2.  --part_info <part_info_name>
3.  -G, --gvtargs <GVT_args>
4.  -s <slot>,pci-gvt
5.  -Y, --mptgen
6.  -s <slot>,virtio-hdcp
7.  -s <slot>,npk
8.  -s <slot>,virtio-coreu
9.  -i, --ioc_node <ioc_mediator_parameters>
10. --pm_by_vuart [pty|tty],<node_path>
11. --pm_notify_channel <channel>

This patch remove these parameters from doc.

Tracked-On: #6690
Signed-off-by: Chenli Wei <chenli.wei@linux.intel.com>
2022-01-14 10:53:26 -08:00
Amy Reyes 48063c840b doc: Remove placeholder text from acrntrace
Removed placeholders for images. Will create an issue for tracking.

Signed-off-by: Amy Reyes <amy.reyes@intel.com>
2021-12-06 10:05:51 -08:00
Amy Reyes 22f4041d48 doc: terminology cleanup in hld/tutorial images
- Replace SOS or Service OS with Service VM
- Replace UOS or User OS with User VM

Signed-off-by: Amy Reyes <amy.reyes@intel.com>
2021-12-06 10:05:07 -08:00
Amy Reyes 30875208a6 doc: terminology cleanup in openstack and hld images
- Replace SOS or Service OS with Service VM
- Replace UOS or User OS with User VM
- Replace VHM with HSM

Signed-off-by: Amy Reyes <amy.reyes@intel.com>
2021-12-01 11:25:11 -08:00
Amy Reyes 82eeaee55f doc: terminology cleanup in DM HLD
- Replace SOS or Service OS with Service VM
- Replace UOS or User OS with User VM
- Clean up some of the grammar

Signed-off-by: Amy Reyes <amy.reyes@intel.com>
2021-12-01 11:23:47 -08:00
Amy Reyes 7ffa2a4a5f doc: terminology cleanup in HLD overview
- Replace SOS or Service OS with Service VM
- Replace UOS or User OS with User VM
- Replace VHM with HSM

Signed-off-by: Amy Reyes <amy.reyes@intel.com>
2021-12-01 10:20:06 -08:00
Amy Reyes 49d9567132 doc: terminology cleanup in mem mgmt hld
- Replace SOS or Service OS with Service VM
- Replace UOS or User OS with User VM
- Clean up some of the grammar

Signed-off-by: Amy Reyes <amy.reyes@intel.com>
2021-11-25 06:00:26 -08:00
Amy Reyes fc61bd6220 doc: terminology cleanup in hostbridge hld
- Replace UOS or User OS with User VM
- Clean up some of the grammar

Signed-off-by: Amy Reyes <amy.reyes@intel.com>
2021-11-25 05:54:59 -08:00
Kunhui-Li a3015d3973 doc: replace UUID with vmname to identify a vm
Since the PR #6787 has landed, we need to remove the uuid parameter
"-U" of "acrn-dm" and replace UUID with vm name to identify a VM
in document.

Signed-off-by: Kunhui-Li <kunhuix.li@intel.com>
2021-11-25 05:41:08 -08:00
Amy Reyes fcb0469bce doc: terminology cleanup in virtio-rnd
- Replace UOS or User OS with User VM
- Replace SOS or Service OS with Service VM
- Clean up some of the grammar

Signed-off-by: Amy Reyes <amy.reyes@intel.com>
2021-11-24 17:36:35 -08:00
dongshen 066856d6f9 doc: add vCAT documentation
This patch adds user guide and high level design for vCAT

Tracked-On: #5917
Signed-off-by: dongshen <dongsheng.x.zhang@intel.com>
2021-11-24 06:31:56 -08:00
Amy Reyes dec624a0fe doc: terminology cleanup in usb doc
- Replace SOS or Service OS with Service VM
- Replace UOS or User OS with User VM
- Clean up some of the grammar

Signed-off-by: Amy Reyes <amy.reyes@intel.com>
2021-11-24 06:27:42 -08:00
Amy Reyes 417c369feb doc: terminology cleanup in RTC virt
- Replace SOS or Service OS with Service VM
- Clean up some of the grammar

Signed-off-by: Amy Reyes <amy.reyes@intel.com>
2021-11-22 10:40:48 -08:00
Amy Reyes 7811b6217d doc: terminology cleanup in images (uart)
- Replace SOS or Service OS with Service VM
- Replace UOS or User OS with User VM

Signed-off-by: Amy Reyes <amy.reyes@intel.com>
2021-11-22 10:38:22 -08:00
hangliu1 195d3df4c6 doc: remove VBSK related content
VBSK is not supported anymore, clean the documents up.

Track-On: #6738
Signed-off-by: hangliu1 <hang1.liu@linux.intel.com>
2021-11-22 08:40:38 -08:00
Amy Reyes 41c552dea8 doc: terminology cleanup in file names, labels
- Replace SOS with Service VM
- Replace UOS with User VM

Signed-off-by: Amy Reyes <amy.reyes@intel.com>
2021-11-22 07:57:47 -08:00
Amy Reyes 64f9ef202e doc: terminology cleanup in images (I/O HLD)
- Replace SOS or Service OS with Service VM
- Replace UOS or User OS with User VM

Signed-off-by: Amy Reyes <amy.reyes@intel.com>
2021-11-22 07:43:59 -08:00
Amy Reyes 9af91ed571 doc: terminology cleanup in images (gpio)
- Replace SOS or Service OS with Service VM
- Replace UOS or User OS with User VM

Signed-off-by: Amy Reyes <amy.reyes@intel.com>
2021-11-22 07:34:29 -08:00
Musa Ünal 5bc0c97a12 fix misspelling
fix misspelling in memory management doc

Signed-off-by: Musa Unal umusasadik@gmail.com
2021-11-19 07:05:10 -08:00
Amy Reyes 58e27983b4 doc: terminology cleanup in partition mode
- Replace SOS or Service OS with Service VM
- Replace UOS or User OS with User VM
- Clean up some of the grammar

Signed-off-by: Amy Reyes <amy.reyes@intel.com>
2021-11-12 15:22:51 -08:00
Amy Reyes 6023388e79 doc: terminology cleanup in IOC virt
- Replace SOS or Service OS with Service VM
- Replace UOS or User OS with User VM
- Clean up some of the grammar

Signed-off-by: Amy Reyes <amy.reyes@intel.com>
2021-11-11 15:29:34 -08:00
Amy Reyes e66d65152c doc: terminology cleanup in What Is ACRN, HLD intro
- Replace UOS or User OS with User VM
- Clean up some of the grammar

Signed-off-by: Amy Reyes <amy.reyes@intel.com>
2021-11-09 14:01:17 -08:00
David B. Kinder 6ae241d398 doc: fix git clone and misspelling
It's recommended we always use the .git extension when referring to the
git repo when cloning.  Fix that in the GSG.

Also, fix a misspelling in the hld-power-management doc.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2021-11-09 09:55:59 -08:00
Amy Reyes 2ae8a468f9 Update AGL and TME links per feedback
Signed-off-by: Amy Reyes <amy.reyes@intel.com>
2021-11-08 15:31:41 -08:00
Amy Reyes 812cd3e6de doc: terminology cleanup in HLD security
- Replace SOS or Service OS with Service VM
- Replace UOS or User OS with User VM
- Clean up some of the grammar

Signed-off-by: Amy Reyes <amy.reyes@intel.com>
2021-11-08 15:31:41 -08:00
Amy Reyes fe6adb606c Updated per feedback
Signed-off-by: Amy Reyes <amy.reyes@intel.com>
2021-11-08 11:04:00 -08:00
Amy Reyes 47a3912e7c Updated per feedback
Signed-off-by: Amy Reyes <amy.reyes@intel.com>
2021-11-08 11:04:00 -08:00
Amy Reyes 7ac09dda43 doc: terminology cleanup in HLD overview
- Replace SOS or Service OS with Service VM
- Replace UOS or User OS with User VM
- Replace platform names with link to Support Hardware page
- Clean up some of the grammar

Signed-off-by: Amy Reyes <amy.reyes@intel.com>
2021-11-08 11:04:00 -08:00
Amy Reyes 2fbe9ccb42 Updated per feedback
Signed-off-by: Amy Reyes <amy.reyes@intel.com>
2021-11-08 11:02:26 -08:00
Amy Reyes dfe18717ed doc: terminology cleanup in HLD startup
- Replace SOS or Service OS with Service VM
- Replace UOS or User OS with User VM
- Clean up some of the grammar

Signed-off-by: Amy Reyes <amy.reyes@intel.com>
2021-11-08 11:02:26 -08:00
Amy Reyes a11c4592c3 Updated per feedback
Signed-off-by: Amy Reyes <amy.reyes@intel.com>
2021-11-08 11:00:30 -08:00
Amy Reyes b662ea1f08 doc: terminology cleanup in HLD virtio
- Replace SOS or Service OS with Service VM
- Replace UOS or User OS with User VM
- Replace VHM with HSM
- Clean up some of the grammar

Signed-off-by: Amy Reyes <amy.reyes@intel.com>
2021-11-08 11:00:30 -08:00
Amy Reyes 602a380e03 doc: Update VT-d spec link
Publisher of this document confirmed that VT-d spec link should be updated, and the existing link will be EOL.

Signed-off-by: Amy Reyes <amy.reyes@intel.com>
2021-11-08 10:56:12 -08:00
Liu Long 3f4ea38158 ACRN: misc: Unify terminology for service vm/user vm
Rename SOS_VM type to SERVICE_VM
rename UOS to User VM in XML description
rename uos_thread_pid to user_vm_thread_pid
rename devname_uos to devname_user_vm
rename uosid to user_vmid
rename UOS_ACK to USER_VM_ACK
rename SOS_VM_CONFIG_CPU_AFFINITY to SERVICE_VM_CONFIG_CPU_AFFINITY
rename SOS_COM to SERVICE_VM_COM
rename SOS_UART1_VALID_NUM" to SERVICE_VM_UART1_VALID_NUM
rename SOS_BOOTARGS_DIFF to SERVICE_VM_BOOTARGS_DIFF
rename uos to user_vm in launch script and xml

Tracked-On: #6744
Signed-off-by: Liu Long <long.liu@linux.intel.com>
Reviewed-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2021-11-02 10:00:55 +08:00
Amy Reyes 6d61c2dfff Updated per feedback
Signed-off-by: Amy Reyes <amy.reyes@intel.com>
2021-10-28 13:32:11 -07:00