Re: [PATCH v3 1/3] docs/interop/firmware.json: add new enum FirmwareFormat
Hi Hanna and Kevin,
any updates?
On Mon, Mar 11, 2024 at 02:29:25PM +0100, Markus Armbruster wrote:
> Thomas Weißschuh writes:
>
> > Only a small subset of all blockdev drivers make sense for firmware
> > images. Introduce and use a new enum to represent this.
> >
> > This also reduces the dependency of firmware.json on the global qapi
> > definitions.
> >
> > Suggested-by: Daniel P. Berrangé
> > Signed-off-by: Thomas Weißschuh
> > ---
> > docs/interop/firmware.json | 18 --
> > 1 file changed, 16 insertions(+), 2 deletions(-)
> >
> > diff --git a/docs/interop/firmware.json b/docs/interop/firmware.json
> > index 54a1fc6c1041..0e619e8780e7 100644
> > --- a/docs/interop/firmware.json
> > +++ b/docs/interop/firmware.json
> > @@ -15,7 +15,11 @@
> > ##
> >
> > { 'include' : 'machine.json' }
> > -{ 'include' : 'block-core.json' }
> > +
> > +{ 'pragma': {
> > +'documentation-exceptions': [
> > +'FirmwareFormat'
> > +] } }
>
> Necessary because ...
> >
> > ##
> > # @FirmwareOSInterface:
> > @@ -200,6 +204,16 @@
> > 'enrolled-keys', 'requires-smm', 'secure-boot',
> > 'verbose-dynamic', 'verbose-static' ] }
> >
> > +##
> > +# @FirmwareFormat:
> > +#
> > +# Formats that are supported for firmware images.
> > +#
>
> ... we don't document the members here. Documenting them would be
> nicer. We'd do that if we could steal it from BlockdevDriver, but
> there's nothing to steal there.
>
> Mere observation; I'm not asking you to come up with documentation
> BlockdevDriver doesn't have.
>
> > +# Since: 8.3
> > +##
> > +{ 'enum': 'FirmwareFormat',
> > + 'data': [ 'raw', 'qcow2' ] }
>
> @raw or @file? Kevin or Hanna, thoughts?
The existing descriptors in pc-bios/descriptors/ are using @raw.
> > +
> > ##
> > # @FirmwareFlashFile:
> > #
> > @@ -219,7 +233,7 @@
> > ##
> > { 'struct' : 'FirmwareFlashFile',
> >'data' : { 'filename' : 'str',
> > - 'format' : 'BlockdevDriver' } }
> > + 'format' : 'FirmwareFormat' } }
> >
> >
> > ##
Thanks,
Thomas
Re: [PATCH v3 1/3] docs/interop/firmware.json: add new enum FirmwareFormat
Thomas Weißschuh writes:
> Only a small subset of all blockdev drivers make sense for firmware
> images. Introduce and use a new enum to represent this.
>
> This also reduces the dependency of firmware.json on the global qapi
> definitions.
>
> Suggested-by: Daniel P. Berrangé
> Signed-off-by: Thomas Weißschuh
> ---
> docs/interop/firmware.json | 18 --
> 1 file changed, 16 insertions(+), 2 deletions(-)
>
> diff --git a/docs/interop/firmware.json b/docs/interop/firmware.json
> index 54a1fc6c1041..0e619e8780e7 100644
> --- a/docs/interop/firmware.json
> +++ b/docs/interop/firmware.json
> @@ -15,7 +15,11 @@
> ##
>
> { 'include' : 'machine.json' }
> -{ 'include' : 'block-core.json' }
> +
> +{ 'pragma': {
> +'documentation-exceptions': [
> +'FirmwareFormat'
> +] } }
Necessary because ...
>
> ##
> # @FirmwareOSInterface:
> @@ -200,6 +204,16 @@
> 'enrolled-keys', 'requires-smm', 'secure-boot',
> 'verbose-dynamic', 'verbose-static' ] }
>
> +##
> +# @FirmwareFormat:
> +#
> +# Formats that are supported for firmware images.
> +#
... we don't document the members here. Documenting them would be
nicer. We'd do that if we could steal it from BlockdevDriver, but
there's nothing to steal there.
Mere observation; I'm not asking you to come up with documentation
BlockdevDriver doesn't have.
> +# Since: 8.3
> +##
> +{ 'enum': 'FirmwareFormat',
> + 'data': [ 'raw', 'qcow2' ] }
@raw or @file? Kevin or Hanna, thoughts?
> +
> ##
> # @FirmwareFlashFile:
> #
> @@ -219,7 +233,7 @@
> ##
> { 'struct' : 'FirmwareFlashFile',
>'data' : { 'filename' : 'str',
> - 'format' : 'BlockdevDriver' } }
> + 'format' : 'FirmwareFormat' } }
>
>
> ##
Re: [PATCH v3 1/3] docs/interop/firmware.json: add new enum FirmwareFormat
On Mon, Mar 11, 2024 at 01:08:19PM +0100, Philippe Mathieu-Daudé wrote:
> On 11/3/24 12:46, Thomas Weißschuh wrote:
> > Only a small subset of all blockdev drivers make sense for firmware
> > images. Introduce and use a new enum to represent this.
> >
> > This also reduces the dependency of firmware.json on the global qapi
> > definitions.
> >
> > Suggested-by: Daniel P. Berrangé
> > Signed-off-by: Thomas Weißschuh
> > ---
> > docs/interop/firmware.json | 18 --
> > 1 file changed, 16 insertions(+), 2 deletions(-)
>
>
> > +##
> > +# @FirmwareFormat:
> > +#
> > +# Formats that are supported for firmware images.
> > +#
> > +# Since: 8.3
>
> That will be 9.0 :/
Thanks.
IMO it doesn't warrant a new revision, the maintainer can change it when
applying.
Locally I changed it, so if a new revision is necessary for other
reasons it will have the change.
> > +##
> > +{ 'enum': 'FirmwareFormat',
> > + 'data': [ 'raw', 'qcow2' ] }
>
Re: [PATCH v3 1/3] docs/interop/firmware.json: add new enum FirmwareFormat
On 11/3/24 12:46, Thomas Weißschuh wrote:
Only a small subset of all blockdev drivers make sense for firmware
images. Introduce and use a new enum to represent this.
This also reduces the dependency of firmware.json on the global qapi
definitions.
Suggested-by: Daniel P. Berrangé
Signed-off-by: Thomas Weißschuh
---
docs/interop/firmware.json | 18 --
1 file changed, 16 insertions(+), 2 deletions(-)
+##
+# @FirmwareFormat:
+#
+# Formats that are supported for firmware images.
+#
+# Since: 8.3
That will be 9.0 :/
+##
+{ 'enum': 'FirmwareFormat',
+ 'data': [ 'raw', 'qcow2' ] }
[PATCH v3 1/3] docs/interop/firmware.json: add new enum FirmwareFormat
Only a small subset of all blockdev drivers make sense for firmware
images. Introduce and use a new enum to represent this.
This also reduces the dependency of firmware.json on the global qapi
definitions.
Suggested-by: Daniel P. Berrangé
Signed-off-by: Thomas Weißschuh
---
docs/interop/firmware.json | 18 --
1 file changed, 16 insertions(+), 2 deletions(-)
diff --git a/docs/interop/firmware.json b/docs/interop/firmware.json
index 54a1fc6c1041..0e619e8780e7 100644
--- a/docs/interop/firmware.json
+++ b/docs/interop/firmware.json
@@ -15,7 +15,11 @@
##
{ 'include' : 'machine.json' }
-{ 'include' : 'block-core.json' }
+
+{ 'pragma': {
+'documentation-exceptions': [
+'FirmwareFormat'
+] } }
##
# @FirmwareOSInterface:
@@ -200,6 +204,16 @@
'enrolled-keys', 'requires-smm', 'secure-boot',
'verbose-dynamic', 'verbose-static' ] }
+##
+# @FirmwareFormat:
+#
+# Formats that are supported for firmware images.
+#
+# Since: 8.3
+##
+{ 'enum': 'FirmwareFormat',
+ 'data': [ 'raw', 'qcow2' ] }
+
##
# @FirmwareFlashFile:
#
@@ -219,7 +233,7 @@
##
{ 'struct' : 'FirmwareFlashFile',
'data' : { 'filename' : 'str',
- 'format' : 'BlockdevDriver' } }
+ 'format' : 'FirmwareFormat' } }
##
--
2.44.0
