Re: PI 1.6: Issues within the SPI sections.

[Andrew Fish <afish@apple.com>]

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