public inbox for devel@edk2.groups.io
 help / color / mirror / Atom feed
* PI 1.6: Issues within the SPI sections.
@ 2017-09-06  3:21 Marvin H?user
  2017-09-06  3:42 ` Marvin H?user
  2017-09-06 15:30 ` Andrew Fish
  0 siblings, 2 replies; 5+ messages in thread
From: Marvin H?user @ 2017-09-06  3:21 UTC (permalink / raw)
  To: edk2-devel@lists.01.org

Dear UEFI contributors,

I am not an UEFI contributor and hence cannot submit changes. Could somebody please take note of the following?


  1.  I do not see EFI_SPI_TRANSACTION_TYPE defined anywhere. There is a list of names for possible values with descriptions (PI 1.6, Vol. 5, page 368), though not assigned to numerical values. The size of the type is unknown, as far as I can see.
  2.  Some parameter names in the protocol descriptions are flawed (e.g. PI 1.6, Vol. 5, page 368: "Read Bytes", "Read Buffer").
  3.  Some protorype return types are flawed (e.g. PI 1.6, Vol. 5, page 367: "EFI STATUS" (space instead of underscore); page 364: "FI STATUS" (same as before, also "E" missing)).
  4.  Some prototype parameter types are flawed (e.g. PI 1.6, Vol. 5, page 364: "EFI- LEGACY- SPI- FLASH- PROTOCOL").
  5.  Some status code descriptions are flawed (e.g. PI 1.6, Vol. 5, page 364: "BLocksToProtect" (capital "L")).
  6.  Some formatations are flawed (e.g. PI 1.6, Vol. 5, page 358: multiple parameters in one line).
  7.  Some function decorators are flawed (e.g. PI 1.6, Vol. 5, page 357: "In" (lower-case "n")).
  8.  Some function parameter names are flawed (e.g. PI 1.6, Vol. 5, page 356: "LengthinBytes" (lower-case "i")).
  9.  Some descriptions contain spaces in inappropiate places (e.g. PI 1.5, Vol. 5, page 349: "EFI_SPI_P ART").
  10. Occasionally incorrect punctuation (e.g. PI 1.6, Vol. 5, page 346: "[...] SPI busses, The SPI bus layer [...]" (comma instead of period)).
  11. PI 1.6, Vol. 5, page 349: The description of "SpiPeripheralDriverGuid" speaks of a "Driversupported" routine. Is EFI_DRIVER_BINDING_PROTOCOL.Supported() meant by this?
  12. PI 1.6, Vol. 5, page 350: The description of "ChipSelectParameter" contains spaces, though they are barely noticable when having the PDF opened with the latest version of Acrobat DC. Can this be fixed?
  13. UEFI PI 1.6, Vol. 5, 18.2 contains a reference to "EDK2". Is this intended?

Please note that this list is not complete. Maybe the entire section 18 should be reviewed again?

Thank you in advance!

Regards,
Marvin.


^ permalink raw reply	[flat|nested] 5+ messages in thread

* Re: PI 1.6: Issues within the SPI sections.
  2017-09-06  3:21 PI 1.6: Issues within the SPI sections Marvin H?user
@ 2017-09-06  3:42 ` Marvin H?user
  2017-09-06  8:21   ` Marvin H?user
  2017-09-06 15:30 ` Andrew Fish
  1 sibling, 1 reply; 5+ messages in thread
From: Marvin H?user @ 2017-09-06  3:42 UTC (permalink / raw)
  To: edk2-devel@lists.01.org

Sorry, I forgot to mention that the new SPI protocols still mention "SMM" rather than "MM". Is this intended?

> -----Original Message-----
> From: edk2-devel [mailto:edk2-devel-bounces@lists.01.org] On Behalf Of
> Marvin H?user
> Sent: Wednesday, September 6, 2017 5:22 AM
> To: edk2-devel@lists.01.org
> Subject: [edk2] PI 1.6: Issues within the SPI sections.
> 
> Dear UEFI contributors,
> 
> I am not an UEFI contributor and hence cannot submit changes. Could
> somebody please take note of the following?
> 
> 
>   1.  I do not see EFI_SPI_TRANSACTION_TYPE defined anywhere. There is a
> list of names for possible values with descriptions (PI 1.6, Vol. 5, page 368),
> though not assigned to numerical values. The size of the type is unknown, as
> far as I can see.
>   2.  Some parameter names in the protocol descriptions are flawed (e.g. PI
> 1.6, Vol. 5, page 368: "Read Bytes", "Read Buffer").
>   3.  Some protorype return types are flawed (e.g. PI 1.6, Vol. 5, page 367: "EFI
> STATUS" (space instead of underscore); page 364: "FI STATUS" (same as
> before, also "E" missing)).
>   4.  Some prototype parameter types are flawed (e.g. PI 1.6, Vol. 5, page 364:
> "EFI- LEGACY- SPI- FLASH- PROTOCOL").
>   5.  Some status code descriptions are flawed (e.g. PI 1.6, Vol. 5, page 364:
> "BLocksToProtect" (capital "L")).
>   6.  Some formatations are flawed (e.g. PI 1.6, Vol. 5, page 358: multiple
> parameters in one line).
>   7.  Some function decorators are flawed (e.g. PI 1.6, Vol. 5, page 357: "In"
> (lower-case "n")).
>   8.  Some function parameter names are flawed (e.g. PI 1.6, Vol. 5, page 356:
> "LengthinBytes" (lower-case "i")).
>   9.  Some descriptions contain spaces in inappropiate places (e.g. PI 1.5, Vol.
> 5, page 349: "EFI_SPI_P ART").
>   10. Occasionally incorrect punctuation (e.g. PI 1.6, Vol. 5, page 346: "[...] SPI
> busses, The SPI bus layer [...]" (comma instead of period)).
>   11. PI 1.6, Vol. 5, page 349: The description of "SpiPeripheralDriverGuid"
> speaks of a "Driversupported" routine. Is
> EFI_DRIVER_BINDING_PROTOCOL.Supported() meant by this?
>   12. PI 1.6, Vol. 5, page 350: The description of "ChipSelectParameter"
> contains spaces, though they are barely noticable when having the PDF
> opened with the latest version of Acrobat DC. Can this be fixed?
>   13. UEFI PI 1.6, Vol. 5, 18.2 contains a reference to "EDK2". Is this intended?
> 
> Please note that this list is not complete. Maybe the entire section 18 should
> be reviewed again?
> 
> Thank you in advance!
> 
> Regards,
> Marvin.
> _______________________________________________
> edk2-devel mailing list
> edk2-devel@lists.01.org
> https://lists.01.org/mailman/listinfo/edk2-devel


^ permalink raw reply	[flat|nested] 5+ messages in thread

* Re: PI 1.6: Issues within the SPI sections.
  2017-09-06  3:42 ` Marvin H?user
@ 2017-09-06  8:21   ` Marvin H?user
  0 siblings, 0 replies; 5+ messages in thread
From: Marvin H?user @ 2017-09-06  8:21 UTC (permalink / raw)
  To: edk2-devel@lists.01.org

Sorry, but there are even more:

* "EFI_LEGACY_SPI_CONTROLLER_GUID" contains the non-hex character "l", which I suspect to be "1".
* "EFI_SPI_HOST_GUID" does not follow the usual naming scheme. Wouldn't "EFI_SPI_HC_PROTOCOL_GUID" be more fiting?
* The possible values for EFI_SPI_HC_PROTOCOL.Attributes are not defined.
* The possible values for EFI_SPI_IO_PROTOCOL.Attributes are not defined.

Thanks again for your time!

Regards,
Marvin.

> -----Original Message-----
> From: edk2-devel [mailto:edk2-devel-bounces@lists.01.org] On Behalf Of
> Marvin H?user
> Sent: Wednesday, September 6, 2017 5:42 AM
> To: edk2-devel@lists.01.org
> Subject: Re: [edk2] PI 1.6: Issues within the SPI sections.
> 
> Sorry, I forgot to mention that the new SPI protocols still mention "SMM"
> rather than "MM". Is this intended?
> 
> > -----Original Message-----
> > From: edk2-devel [mailto:edk2-devel-bounces@lists.01.org] On Behalf Of
> > Marvin H?user
> > Sent: Wednesday, September 6, 2017 5:22 AM
> > To: edk2-devel@lists.01.org
> > Subject: [edk2] PI 1.6: Issues within the SPI sections.
> >
> > Dear UEFI contributors,
> >
> > I am not an UEFI contributor and hence cannot submit changes. Could
> > somebody please take note of the following?
> >
> >
> >   1.  I do not see EFI_SPI_TRANSACTION_TYPE defined anywhere. There is
> > a list of names for possible values with descriptions (PI 1.6, Vol. 5,
> > page 368), though not assigned to numerical values. The size of the
> > type is unknown, as far as I can see.
> >   2.  Some parameter names in the protocol descriptions are flawed
> > (e.g. PI 1.6, Vol. 5, page 368: "Read Bytes", "Read Buffer").
> >   3.  Some protorype return types are flawed (e.g. PI 1.6, Vol. 5,
> > page 367: "EFI STATUS" (space instead of underscore); page 364: "FI
> > STATUS" (same as before, also "E" missing)).
> >   4.  Some prototype parameter types are flawed (e.g. PI 1.6, Vol. 5, page
> 364:
> > "EFI- LEGACY- SPI- FLASH- PROTOCOL").
> >   5.  Some status code descriptions are flawed (e.g. PI 1.6, Vol. 5, page 364:
> > "BLocksToProtect" (capital "L")).
> >   6.  Some formatations are flawed (e.g. PI 1.6, Vol. 5, page 358:
> > multiple parameters in one line).
> >   7.  Some function decorators are flawed (e.g. PI 1.6, Vol. 5, page 357: "In"
> > (lower-case "n")).
> >   8.  Some function parameter names are flawed (e.g. PI 1.6, Vol. 5, page
> 356:
> > "LengthinBytes" (lower-case "i")).
> >   9.  Some descriptions contain spaces in inappropiate places (e.g. PI 1.5,
> Vol.
> > 5, page 349: "EFI_SPI_P ART").
> >   10. Occasionally incorrect punctuation (e.g. PI 1.6, Vol. 5, page
> > 346: "[...] SPI busses, The SPI bus layer [...]" (comma instead of period)).
> >   11. PI 1.6, Vol. 5, page 349: The description of "SpiPeripheralDriverGuid"
> > speaks of a "Driversupported" routine. Is
> > EFI_DRIVER_BINDING_PROTOCOL.Supported() meant by this?
> >   12. PI 1.6, Vol. 5, page 350: The description of "ChipSelectParameter"
> > contains spaces, though they are barely noticable when having the PDF
> > opened with the latest version of Acrobat DC. Can this be fixed?
> >   13. UEFI PI 1.6, Vol. 5, 18.2 contains a reference to "EDK2". Is this
> intended?
> >
> > Please note that this list is not complete. Maybe the entire section
> > 18 should be reviewed again?
> >
> > Thank you in advance!
> >
> > Regards,
> > Marvin.
> > _______________________________________________
> > edk2-devel mailing list
> > edk2-devel@lists.01.org
> > https://lists.01.org/mailman/listinfo/edk2-devel
> _______________________________________________
> edk2-devel mailing list
> edk2-devel@lists.01.org
> https://lists.01.org/mailman/listinfo/edk2-devel


^ permalink raw reply	[flat|nested] 5+ messages in thread

* Re: PI 1.6: Issues within the SPI sections.
  2017-09-06  3:21 PI 1.6: Issues within the SPI sections Marvin H?user
  2017-09-06  3:42 ` Marvin H?user
@ 2017-09-06 15:30 ` Andrew Fish
  2017-09-08  3:10   ` Marvin Häuser
  1 sibling, 1 reply; 5+ messages in thread
From: Andrew Fish @ 2017-09-06 15:30 UTC (permalink / raw)
  To: Marvin H?user; +Cc: edk2-devel@lists.01.org

Marvin,

There is a public forum for feedback. 

http://www.uefi.org/FWOSForum <http://www.uefi.org/FWOSForum>

Thanks,

Andrew Fish


> On Sep 5, 2017, at 8:21 PM, Marvin H?user <Marvin.Haeuser@outlook.com> wrote:
> 
> Dear UEFI contributors,
> 
> I am not an UEFI contributor and hence cannot submit changes. Could somebody please take note of the following?
> 
> 
>  1.  I do not see EFI_SPI_TRANSACTION_TYPE defined anywhere. There is a list of names for possible values with descriptions (PI 1.6, Vol. 5, page 368), though not assigned to numerical values. The size of the type is unknown, as far as I can see.
>  2.  Some parameter names in the protocol descriptions are flawed (e.g. PI 1.6, Vol. 5, page 368: "Read Bytes", "Read Buffer").
>  3.  Some protorype return types are flawed (e.g. PI 1.6, Vol. 5, page 367: "EFI STATUS" (space instead of underscore); page 364: "FI STATUS" (same as before, also "E" missing)).
>  4.  Some prototype parameter types are flawed (e.g. PI 1.6, Vol. 5, page 364: "EFI- LEGACY- SPI- FLASH- PROTOCOL").
>  5.  Some status code descriptions are flawed (e.g. PI 1.6, Vol. 5, page 364: "BLocksToProtect" (capital "L")).
>  6.  Some formatations are flawed (e.g. PI 1.6, Vol. 5, page 358: multiple parameters in one line).
>  7.  Some function decorators are flawed (e.g. PI 1.6, Vol. 5, page 357: "In" (lower-case "n")).
>  8.  Some function parameter names are flawed (e.g. PI 1.6, Vol. 5, page 356: "LengthinBytes" (lower-case "i")).
>  9.  Some descriptions contain spaces in inappropiate places (e.g. PI 1.5, Vol. 5, page 349: "EFI_SPI_P ART").
>  10. Occasionally incorrect punctuation (e.g. PI 1.6, Vol. 5, page 346: "[...] SPI busses, The SPI bus layer [...]" (comma instead of period)).
>  11. PI 1.6, Vol. 5, page 349: The description of "SpiPeripheralDriverGuid" speaks of a "Driversupported" routine. Is EFI_DRIVER_BINDING_PROTOCOL.Supported() meant by this?
>  12. PI 1.6, Vol. 5, page 350: The description of "ChipSelectParameter" contains spaces, though they are barely noticable when having the PDF opened with the latest version of Acrobat DC. Can this be fixed?
>  13. UEFI PI 1.6, Vol. 5, 18.2 contains a reference to "EDK2". Is this intended?
> 
> Please note that this list is not complete. Maybe the entire section 18 should be reviewed again?
> 
> Thank you in advance!
> 
> Regards,
> Marvin.
> _______________________________________________
> edk2-devel mailing list
> edk2-devel@lists.01.org
> https://lists.01.org/mailman/listinfo/edk2-devel



^ permalink raw reply	[flat|nested] 5+ messages in thread

* Re: PI 1.6: Issues within the SPI sections.
  2017-09-06 15:30 ` Andrew Fish
@ 2017-09-08  3:10   ` Marvin Häuser
  0 siblings, 0 replies; 5+ messages in thread
From: Marvin Häuser @ 2017-09-08  3:10 UTC (permalink / raw)
  To: edk2-devel@lists.01.org; +Cc: afish@apple.com

Thank you very much Andrew, hadn't seen it yet. Sorry for spamming here.

Best regards,
Marvin.

From: afish@apple.com [mailto:afish@apple.com]
Sent: Wednesday, September 6, 2017 5:31 PM
To: Marvin H?user <Marvin.Haeuser@outlook.com>
Cc: edk2-devel@lists.01.org
Subject: Re: [edk2] PI 1.6: Issues within the SPI sections.

Marvin,

There is a public forum for feedback.

http://www.uefi.org/FWOSForum

Thanks,

Andrew Fish


On Sep 5, 2017, at 8:21 PM, Marvin H?user <Marvin.Haeuser@outlook.com<mailto:Marvin.Haeuser@outlook.com>> wrote:

Dear UEFI contributors,

I am not an UEFI contributor and hence cannot submit changes. Could somebody please take note of the following?


 1.  I do not see EFI_SPI_TRANSACTION_TYPE defined anywhere. There is a list of names for possible values with descriptions (PI 1.6, Vol. 5, page 368), though not assigned to numerical values. The size of the type is unknown, as far as I can see.
 2.  Some parameter names in the protocol descriptions are flawed (e.g. PI 1.6, Vol. 5, page 368: "Read Bytes", "Read Buffer").
 3.  Some protorype return types are flawed (e.g. PI 1.6, Vol. 5, page 367: "EFI STATUS" (space instead of underscore); page 364: "FI STATUS" (same as before, also "E" missing)).
 4.  Some prototype parameter types are flawed (e.g. PI 1.6, Vol. 5, page 364: "EFI- LEGACY- SPI- FLASH- PROTOCOL").
 5.  Some status code descriptions are flawed (e.g. PI 1.6, Vol. 5, page 364: "BLocksToProtect" (capital "L")).
 6.  Some formatations are flawed (e.g. PI 1.6, Vol. 5, page 358: multiple parameters in one line).
 7.  Some function decorators are flawed (e.g. PI 1.6, Vol. 5, page 357: "In" (lower-case "n")).
 8.  Some function parameter names are flawed (e.g. PI 1.6, Vol. 5, page 356: "LengthinBytes" (lower-case "i")).
 9.  Some descriptions contain spaces in inappropiate places (e.g. PI 1.5, Vol. 5, page 349: "EFI_SPI_P ART").
 10. Occasionally incorrect punctuation (e.g. PI 1.6, Vol. 5, page 346: "[...] SPI busses, The SPI bus layer [...]" (comma instead of period)).
 11. PI 1.6, Vol. 5, page 349: The description of "SpiPeripheralDriverGuid" speaks of a "Driversupported" routine. Is EFI_DRIVER_BINDING_PROTOCOL.Supported() meant by this?
 12. PI 1.6, Vol. 5, page 350: The description of "ChipSelectParameter" contains spaces, though they are barely noticable when having the PDF opened with the latest version of Acrobat DC. Can this be fixed?
 13. UEFI PI 1.6, Vol. 5, 18.2 contains a reference to "EDK2". Is this intended?

Please note that this list is not complete. Maybe the entire section 18 should be reviewed again?

Thank you in advance!

Regards,
Marvin.
_______________________________________________
edk2-devel mailing list
edk2-devel@lists.01.org<mailto:edk2-devel@lists.01.org>
https://lists.01.org/mailman/listinfo/edk2-devel



^ permalink raw reply	[flat|nested] 5+ messages in thread

end of thread, other threads:[~2017-09-08  3:08 UTC | newest]

Thread overview: 5+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2017-09-06  3:21 PI 1.6: Issues within the SPI sections Marvin H?user
2017-09-06  3:42 ` Marvin H?user
2017-09-06  8:21   ` Marvin H?user
2017-09-06 15:30 ` Andrew Fish
2017-09-08  3:10   ` Marvin Häuser

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox