Skip to content

Commit

Permalink
efi: Document #define FOO_PROTOCOL_GUID layout
Browse files Browse the repository at this point in the history
Add a comment documenting why EFI GUIDs are laid out like they are.

Ideally I'd like to change all the ", " to "," too, but right now the
format is such that checkpatch won't complain with new ones, and staring
at checkpatch didn't get me anywhere towards making that work.

Signed-off-by: Peter Jones <pjones@redhat.com>
Signed-off-by: Matt Fleming <matt@codeblueprint.co.uk>
Cc: Ard Biesheuvel <ard.biesheuvel@linaro.org>
Cc: Joe Perches <joe@perches.com>
Cc: Linus Torvalds <torvalds@linux-foundation.org>
Cc: Peter Zijlstra <peterz@infradead.org>
Cc: Thomas Gleixner <tglx@linutronix.de>
Cc: linux-efi@vger.kernel.org
Link: http://lkml.kernel.org/r/1466839230-12781-3-git-send-email-matt@codeblueprint.co.uk
Signed-off-by: Ingo Molnar <mingo@kernel.org>
  • Loading branch information
Peter Jones authored and Ingo Molnar committed Jun 27, 2016
1 parent 5356c32 commit 54fd11f
Showing 1 changed file with 16 additions and 1 deletion.
17 changes: 16 additions & 1 deletion include/linux/efi.h
Original file line number Diff line number Diff line change
Expand Up @@ -536,7 +536,22 @@ typedef efi_status_t efi_query_variable_store_t(u32 attributes,
void efi_native_runtime_setup(void);

/*
* EFI Configuration Table and GUID definitions
* EFI Configuration Table and GUID definitions
*
* These should be formatted roughly like the ones in the UEFI SPEC has
* them. It makes them easier to grep for, and they look the same when
* you're staring at them. Here's the guide:
*
* GUID: 12345678-1234-1234-1234-123456789012
* Spec:
* #define EFI_SOME_PROTOCOL_GUID \
* {0x12345678,0x1234,0x1234,\
* {0x12,0x34,0x12,0x34,0x56,0x78,0x90,0x12}}
* Here:
* #define SOME_PROTOCOL_GUID \
* EFI_GUID(0x12345678, 0x1234, 0x1234, \
* 0x12, 0x34, 0x12, 0x34, 0x56, 0x78, 0x90, 0x12)
* ^ tab ^tab ^ space
*/
#define NULL_GUID \
EFI_GUID(0x00000000, 0x0000, 0x0000, \
Expand Down

0 comments on commit 54fd11f

Please sign in to comment.