xen/doc: Improve Dom0-less documentation
PATCH v3 1/1 xen/doc: Improve Dom0-less documentation
- Changed unprintable characters with %s/\%xA0/ /g So all the spaces are 0x20 now.
- Added address-cells and size-cells to configuration example. This resolves the dom0less boot issue in case of arm64.
- Added some notes about xl tools usage in case of dom0less.
- Added extra 0x0 to memory property in configuration example. This matches the binding docs/misc/arm/device-tree/booting.txt which requires a 64-bit value.
---
v3:
- Added extra 0x0 to memory property in configuration example. This matches the binding docs/misc/arm/device-tree/booting.txt which requires a 64-bit value.
--- docs/features/dom0less.pandoc | 58 +++++++++++++++++++++++------------ 1 file changed, 39 insertions(+), 19 deletions(-)
docs/features/dom0less.pandoc +39 -19
@@ -40,8 +40,8 @@ to boot. For example if this is the bootcmd for Xen and Dom0: bootm 0x1400000 0x9000000 0x1280000 -If we want to add one DomU with Image-DomU as the DomU kernel -and ramdisk-DomU as DomU ramdisk: +If we want to add one DomU with Image-DomU as the DomU kernel +and ramdisk-DomU as DomU ramdisk: tftpb 0x1280000 xen.dtb tftpb 0x80000 xen-Image
@@ -61,25 +61,27 @@ the presence of the additional VM and its configuration. It is done via device tree adding a node under /chosen as follows: domU1 { - compatible = "xen,domain"; - memory = <0x20000>; - cpus = 1; - vpl011; - - module@2000000 { - compatible = "multiboot,kernel", "multiboot,module"; - reg = <0x2000000 0xffffff>; - bootargs = "console=ttyAMA0"; - }; - - module@30000000 { - compatible = "multiboot,ramdisk", "multiboot,module"; - reg = <0x3000000 0xffffff>; - }; + #address-cells = <0x00000001>; + #size-cells = <0x00000001>; + compatible = "xen,domain"; + memory = <0x0 0x20000>; + cpus = 1; + vpl011; + + module@2000000 { + compatible = "multiboot,kernel", "multiboot,module"; + reg = <0x2000000 0xffffff>; + bootargs = "console=ttyAMA0"; + }; + + module@30000000 { + compatible = "multiboot,ramdisk", "multiboot,module"; + reg = <0x3000000 0xffffff>; + }; }; -Where memory is the memory of the VM in KBs, cpus is the number of -cpus. module@2000000 and module@3000000 advertise where the kernel and +Where memory is the memory of the VM in KBs, cpus is the number of +cpus. module@2000000 and module@3000000 advertise where the kernel and ramdisk are in memory. See docs/misc/arm/device-tree/booting.txt for more information.
@@ -111,3 +113,21 @@ limitations: the Xen command line. The NULL scheduler automatically assigns and pins vCPUs to pCPUs, but the vCPU-pCPU assignments cannot be configured. + +Notes +----- + +- 'xl console' command will not attach to the domain's console in case + of dom0less. DomU are domains created by Xen (similar to Dom0) and + therefore they are all managed by Xen and some of the commands may not work. + + A user is allowed to configure the key sequence to switch input. + Pressing the Xen "conswitch" (Ctrl-A by default) three times + switches input in case of dom0less mode. + +- Domains created by Xen will have no name at boot. Domain-0 has a name + thanks to the helper xen-init-dom0 called at boot by the initscript. + If you want to setup DomU name, then you will have to create the xenstore + node associated. By default DomU names are shown as '(null)' in the + xl domains list. +
--
2.17.1
_______________________________________________
Xen-devel mailing list
[email protected]
https://lists.xenproject.org/mailman/listinfo/xen-devel
Hi Viktor,
Quoted 49 lines · Viktor Mitin
- Changed unprintable characters with %s/\%xA0/ /g So all the spaces are
0x20now.- Added address-cells and size-cells to configuration example. This resolves the dom0less boot issue in case of arm64.
- Added some notes about xl tools usage in case of dom0less.
- Added extra
0x0to memory property in configuration example. This matches the bindingdocs/misc/arm/device-tree/booting.txtwhich requires a 64-bit value.Signed-off-by Viktor Mitin <[email protected]>---
v3:
- Added extra0x0to memory property in configuration example. This matches the bindingdocs/misc/arm/device-tree/booting.txtwhich requires a 64-bit value.--- docs/features/dom0less.pandoc | 58 +++++++++++++++++++++++------------ 1 file changed, 39 insertions(+), 19 deletions(-)docs/features/dom0less.pandoc +2
-9@@ -40,8 +40,8 @@ to boot. For example if this is the bootcmd for Xen and Dom0: bootm 0x1400000 0x9000000 0x1280000 -If we want to add one DomU with Image-DomU as the DomU kernel -and ramdisk-DomU as DomU ramdisk: +If we want to add one DomU with Image-DomU as the DomU kernel +and ramdisk-DomU as DomU ramdisk: tftpb 0x1280000 xen.dtb tftpb 0x80000 xen-Image@@ -61,25 +61,27 @@ the presence of the additional VM and its configuration. It is done via device tree adding a node under /chosen as follows: domU1 { - compatible = "xen,domain"; - memory = <0x20000>; - cpus = 1; - vpl011; - - module@2000000 { - compatible = "multiboot,kernel", "multiboot,module";
docs/features/dom0less.pandoc the presence of the additional VM and its configuration. It is done via · line 65
Quoted 10 lines
docs/features/dom0less.pandoc +2
-8- reg = <0x2000000 0xffffff>; - bootargs = "console=ttyAMA0"; - }; - - module@30000000 { - compatible = "multiboot,ramdisk", "multiboot,module"; - reg = <0x3000000 0xffffff>; - }; + #address-cells = <0x00000001>; + #size-cells = <0x00000001>;
DTC is can deal with decimal number. So I would prefer if we directly use 1 in the 2 properties above.
docs/features/dom0less.pandoc the presence of the additional VM and its configuration. It is done via · line 68
Quoted 3 lines
docs/features/dom0less.pandoc +3
-0+ compatible = "xen,domain"; + memory = <0x0 0x20000>; + cpus = 1;
I think this should be cpus = <1>;
Quoted 9 lines
docs/features/dom0less.pandoc +9
-0+ vpl011; + + module@2000000 { + compatible = "multiboot,kernel", "multiboot,module"; + reg = <0x2000000 0xffffff>; + bootargs = "console=ttyAMA0"; + }; + + module@30000000 {
docs/features/dom0less.pandoc the presence of the additional VM and its configuration. It is done via · line 85
Quoted 10 lines
docs/features/dom0less.pandoc +5
-2+ compatible = "multiboot,ramdisk", "multiboot,module"; + reg = <0x3000000 0xffffff>; + }; }; -Where memory is the memory of the VM in KBs, cpus is the number of -cpus. module@2000000 and module@3000000 advertise where the kernel and +Where memory is the memory of the VM in KBs, cpus is the number of +cpus. module@2000000 and module@3000000 advertise where the kernel and ramdisk are in memory.
As a side note, the size specified should exactly match the size of the Kernel/initramfs. Otherwise, they may be unusable in Xen (for instance if they are compressed).
Quoted 14 lines
docs/features/dom0less.pandoc +8
-0See docs/misc/arm/device-tree/booting.txt for more information.@@ -111,3 +113,21 @@ limitations: the Xen command line. The NULL scheduler automatically assigns and pins vCPUs to pCPUs, but the vCPU-pCPU assignments cannot be configured. + +Notes +----- + +- 'xl console' command will not attach to the domain's console in case + of dom0less. DomU are domains created by Xen (similar to Dom0) and + therefore they are all managed by Xen and some of the commands may not work. +
docs/features/dom0less.pandoc limitations: · line 133
Quoted 10 lines
docs/features/dom0less.pandoc +10
-0+ A user is allowed to configure the key sequence to switch input. + Pressing the Xen "conswitch" (Ctrl-A by default) three times + switches input in case of dom0less mode. + +- Domains created by Xen will have no name at boot. Domain-0 has a name + thanks to the helper xen-init-dom0 called at boot by the initscript. + If you want to setup DomU name, then you will have to create the xenstore + node associated. By default DomU names are shown as '(null)' in the + xl domains list. +
Except the few minors things above. The improvement looks good to me, although I would like another pair of eye. Stefano, can you look at it?
Cheers,
Signature · 6 lines
Julien Grall _______________________________________________ Xen-devel mailing list [email protected] https://lists.xenproject.org/mailman/listinfo/xen-devel
Quoted 59 lines · Julien Grall
Hi Viktor,
Quoted 56 lines · Viktor Mitin
- Changed unprintable characters with %s/\%xA0/ /g So all the spaces are
0x20now.- Added address-cells and size-cells to configuration example. This resolves the dom0less boot issue in case of arm64.
- Added some notes about xl tools usage in case of dom0less.
- Added extra
0x0to memory property in configuration example. This matches the bindingdocs/misc/arm/device-tree/booting.txtwhich requires a 64-bit value.Signed-off-by Viktor Mitin <[email protected]>---
v3:
- Added extra0x0to memory property in configuration example. This matches the bindingdocs/misc/arm/device-tree/booting.txtwhich requires a 64-bit value.--- docs/features/dom0less.pandoc | 58 +++++++++++++++++++++++------------ 1 file changed, 39 insertions(+), 19 deletions(-)docs/features/dom0less.pandoc +0
-0@@ -40,8 +40,8 @@ to boot. For example if this is the bootcmd for Xen andDom0:
bootm 0x1400000 0x9000000 0x1280000docs/features/dom0less.pandoc +2
-2-If we want to add one DomU with Image-DomU as the DomU kernel -and ramdisk-DomU as DomU ramdisk: +If we want to add one DomU with Image-DomU as the DomU kernel +and ramdisk-DomU as DomU ramdisk: tftpb 0x1280000 xen.dtb tftpb 0x80000 xen-Image@@ -61,25 +61,27 @@ the presence of the additional VM and its configuration.It is done via
device tree adding a node under /chosen as follows:domU1 {docs/features/dom0less.pandoc +0
-12- compatible = "xen,domain"; - memory = <0x20000>; - cpus = 1; - vpl011; - - module@2000000 { - compatible = "multiboot,kernel", "multiboot,module"; - reg = <0x2000000 0xffffff>; - bootargs = "console=ttyAMA0"; - }; - - module@30000000 {
Quoted 8 lines
docs/features/dom0less.pandoc the presence of the additional VM and its configuration. It is done via · line 65
Quoted 5 lines
docs/features/dom0less.pandoc +2
-3- compatible = "multiboot,ramdisk", "multiboot,module"; - reg = <0x3000000 0xffffff>; - }; + #address-cells = <0x00000001>; + #size-cells = <0x00000001>;DTC is can deal with decimal number. So I would prefer if we directly use 1 in the 2 properties above.
Agreed
Quoted 5 lines
docs/features/dom0less.pandoc the presence of the additional VM and its configuration. It is done via · line 68
Quoted 3 lines
docs/features/dom0less.pandoc +3
-0+ compatible = "xen,domain"; + memory = <0x0 0x20000>; + cpus = 1;I think this should be cpus = <1>;
Yep
Quoted 44 lines
Quoted 9 lines
docs/features/dom0less.pandoc +9
-0+ vpl011; + + module@2000000 { + compatible = "multiboot,kernel", "multiboot,module"; + reg = <0x2000000 0xffffff>; + bootargs = "console=ttyAMA0"; + }; + + module@30000000 {docs/features/dom0less.pandoc the presence of the additional VM and its configuration. It is done via · line 85
Quoted 10 lines
docs/features/dom0less.pandoc +5
-2+ compatible = "multiboot,ramdisk", "multiboot,module"; + reg = <0x3000000 0xffffff>; + }; }; -Where memory is the memory of the VM in KBs, cpus is the number of -cpus. module@2000000 and module@3000000 advertise where the kernel and +Where memory is the memory of the VM in KBs, cpus is the number of +cpus. module@2000000 and module@3000000 advertise where the kernel and ramdisk are in memory.As a side note, the size specified should exactly match the size of the Kernel/initramfs. Otherwise, they may be unusable in Xen (for instance if they are compressed).
Quoted 20 lines
See
docs/misc/arm/device-tree/booting.txtfor more information.docs/features/dom0less.pandoc +7
-0@@ -111,3 +113,21 @@ limitations: the Xen command line. The NULL scheduler automatically assigns and pins vCPUs to pCPUs, but the vCPU-pCPU assignments cannot be configured. + +Notes +----- + +- 'xl console' command will not attach to the domain's console in case + of dom0less. DomU are domains created by Xen (similar to Dom0) and + therefore they are all managed by Xen and some of the commands may notwork.
docs/features/dom0less.pandoc +6
-0+ + A user is allowed to configure the key sequence to switch input. + Pressing the Xen "conswitch" (Ctrl-A by default) three times + switches input in case of dom0less mode. + +- Domains created by Xen will have no name at boot. Domain-0 has a name
Quoted 8 lines
docs/features/dom0less.pandoc limitations: · line 133
Quoted 5 lines
docs/features/dom0less.pandoc +5
-0+ thanks to the helper xen-init-dom0 called at boot by the initscript. + If you want to setup DomU name, then you will have to create the xenstore + node associated. By default DomU names are shown as '(null)' in the + xl domains list. +Except the few minors things above. The improvement looks good to me, although I would like another pair of eye. Stefano, can you look at it?
It looks good aside for the two small points you have already raised.
_______________________________________________
Xen-devel mailing list
[email protected]
https://lists.xenproject.org/mailman/listinfo/xen-devel