diff mbox series

[v3,10/15] docs/interop/firmware.json: Add igvm to FirmwareDevice

Message ID 1bcb6bdfe74f96c7c2553ff25fb79f1def381f74.1718979106.git.roy.hopkins@suse.com
State New
Headers show
Series Introduce support for IGVM files | expand

Commit Message

Roy Hopkins June 21, 2024, 2:29 p.m. UTC
Create an enum entry within FirmwareDevice for 'igvm' to describe that
an IGVM file can be used to map firmware into memory as an alternative
to pre-existing firmware devices.

Signed-off-by: Roy Hopkins <roy.hopkins@suse.com>
---
 docs/interop/firmware.json | 9 ++++++++-
 1 file changed, 8 insertions(+), 1 deletion(-)

Comments

Stefano Garzarella June 27, 2024, 12:53 p.m. UTC | #1
On Fri, Jun 21, 2024 at 03:29:13PM GMT, Roy Hopkins wrote:
>Create an enum entry within FirmwareDevice for 'igvm' to describe that
>an IGVM file can be used to map firmware into memory as an alternative
>to pre-existing firmware devices.
>
>Signed-off-by: Roy Hopkins <roy.hopkins@suse.com>
>---
> docs/interop/firmware.json | 9 ++++++++-
> 1 file changed, 8 insertions(+), 1 deletion(-)
>
>diff --git a/docs/interop/firmware.json b/docs/interop/firmware.json
>index 54a1fc6c10..9a9178606e 100644
>--- a/docs/interop/firmware.json
>+++ b/docs/interop/firmware.json
>@@ -55,10 +55,17 @@
> #
> # @memory: The firmware is to be mapped into memory.
> #
>+# @igvm: The firmware is defined by a file conforming to the IGVM
>+#        specification and mapped into memory according to directives
>+#        defined in the file. This is similar to @memory but may
>+#        include additional processing defined by the IGVM file
>+#        including initial CPU state or population of metadata into
>+#        the guest address space.

Should we add (Since: 9.1) ?

I'm not sure about that, since I don't see it used much in docs/interop/

Thanks,
Stefano

>+#
> # Since: 3.0
> ##
> { 'enum' : 'FirmwareDevice',
>-  'data' : [ 'flash', 'kernel', 'memory' ] }
>+  'data' : [ 'flash', 'kernel', 'memory', 'igvm' ] }
>
> ##
> # @FirmwareTarget:
>-- 
>2.43.0
>
Roy Hopkins July 2, 2024, 10:36 a.m. UTC | #2
On Thu, 2024-06-27 at 14:53 +0200, Stefano Garzarella wrote:
> On Fri, Jun 21, 2024 at 03:29:13PM GMT, Roy Hopkins wrote:
> > Create an enum entry within FirmwareDevice for 'igvm' to describe that
> > an IGVM file can be used to map firmware into memory as an alternative
> > to pre-existing firmware devices.
> > 
> > Signed-off-by: Roy Hopkins <roy.hopkins@suse.com>
> > ---
> > docs/interop/firmware.json | 9 ++++++++-
> > 1 file changed, 8 insertions(+), 1 deletion(-)
> > 
> > diff --git a/docs/interop/firmware.json b/docs/interop/firmware.json
> > index 54a1fc6c10..9a9178606e 100644
> > --- a/docs/interop/firmware.json
> > +++ b/docs/interop/firmware.json
> > @@ -55,10 +55,17 @@
> > #
> > # @memory: The firmware is to be mapped into memory.
> > #
> > +# @igvm: The firmware is defined by a file conforming to the IGVM
> > +#        specification and mapped into memory according to directives
> > +#        defined in the file. This is similar to @memory but may
> > +#        include additional processing defined by the IGVM file
> > +#        including initial CPU state or population of metadata into
> > +#        the guest address space.
> 
> Should we add (Since: 9.1) ?
> 
> I'm not sure about that, since I don't see it used much in docs/interop/
> 
> Thanks,
> Stefano
> 

I'll add it to the end of the @igvm description. Thanks.

> > +#
> > # Since: 3.0
> > ##
> > { 'enum' : 'FirmwareDevice',
> > -  'data' : [ 'flash', 'kernel', 'memory' ] }
> > +  'data' : [ 'flash', 'kernel', 'memory', 'igvm' ] }
> > 
> > ##
> > # @FirmwareTarget:
> > -- 
> > 2.43.0
> > 
>
diff mbox series

Patch

diff --git a/docs/interop/firmware.json b/docs/interop/firmware.json
index 54a1fc6c10..9a9178606e 100644
--- a/docs/interop/firmware.json
+++ b/docs/interop/firmware.json
@@ -55,10 +55,17 @@ 
 #
 # @memory: The firmware is to be mapped into memory.
 #
+# @igvm: The firmware is defined by a file conforming to the IGVM
+#        specification and mapped into memory according to directives
+#        defined in the file. This is similar to @memory but may
+#        include additional processing defined by the IGVM file
+#        including initial CPU state or population of metadata into
+#        the guest address space.
+#
 # Since: 3.0
 ##
 { 'enum' : 'FirmwareDevice',
-  'data' : [ 'flash', 'kernel', 'memory' ] }
+  'data' : [ 'flash', 'kernel', 'memory', 'igvm' ] }
 
 ##
 # @FirmwareTarget: