Commit 7a2ff00c authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab Committed by Ard Biesheuvel
Browse files

docs: efi: add CPER functions to driver-api 



There are two kernel-doc like descriptions at cper, which is used
by other parts of cper and on ghes driver. They both have kernel-doc
like descriptions.

Change the tags for them to be actual kernel-doc tags and add them
to the driver-api documentaion at the UEFI section.

Signed-off-by: default avatarMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Reviewed-by: default avatarJonathan Cameron <Jonathan.Cameron@huawei.com>
Acked-by: default avatarBorislav Petkov (AMD) <bp@alien8.de>
Signed-off-by: default avatarArd Biesheuvel <ardb@kernel.org>
parent 96b01053

Documentation/driver-api/firmware/efi/index.rst

+8 −3
Original line number Diff line number Diff line 
.. SPDX-License-Identifier: GPL-2.0



============

UEFI Support

============

====================================================

Unified Extensible Firmware Interface (UEFI) Support

====================================================



UEFI stub library functions

===========================



.. kernel-doc:: drivers/firmware/efi/libstub/mem.c

   :internal:



UEFI Common Platform Error Record (CPER) functions

==================================================



.. kernel-doc:: drivers/firmware/efi/cper.c

drivers/firmware/efi/cper.c

+1 −1
Original line number Diff line number Diff line
@@ -70,7 +70,7 @@ const char *cper_severity_str(unsigned int severity) 
}

EXPORT_SYMBOL_GPL(cper_severity_str);



/*

/**

 * cper_print_bits - print strings for set bits

 * @pfx: prefix for each line, including log level and prefix string

 * @bits: bit mask