From patchwork Thu Jul 11 06:28:56 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Mauro Carvalho Chehab X-Patchwork-Id: 812137 Received: from smtp.kernel.org (aws-us-west-2-korg-mail-1.web.codeaurora.org [10.30.226.201]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 8ACAF1C68E; Thu, 11 Jul 2024 06:31:09 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=10.30.226.201 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1720679469; cv=none; b=ud3dJt0Qh5mGnPQd4o0HWmELgfsf73FwrmmRUBd9uDI6YrNE39YG6EdH1zUSxe+C9IBKmF0S1wKEMcLO5EIdvahEv3cCrmc6uOfutHUhHgARfpufgyp9AAkEIHnrtzrrmXRvb7H4l2wVsyaz+T7VX0PW+PIwjj9zgvnKzKaYrys= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1720679469; c=relaxed/simple; bh=BUannu00JepoL1Z7Ukw4YDCb+t7wSdorptXpbpSwoW4=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=DNoEfhSNVPuN2sE54b4swvDQUbw6H2S5za6TniBHjCbWYibZ3QGMH4pFWxk6aX2lHUpHwyfjGrHYlDih9A13sOrOZPQp/sCOsnHp0iUNA78yINTF9xLOrPiZM6V4HgHdh9/ilb5O3PLRZ4DFmji4CAGGAnxq0P8L+fkYlSQc4T4= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b=TL4focKa; arc=none smtp.client-ip=10.30.226.201 Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b="TL4focKa" Received: by smtp.kernel.org (Postfix) with ESMTPSA id 2BC41C4AF0A; Thu, 11 Jul 2024 06:31:09 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1720679469; bh=BUannu00JepoL1Z7Ukw4YDCb+t7wSdorptXpbpSwoW4=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=TL4focKaTYEsMI+Z06IxZbgs8CcmQvCzawXZvTI/fxggw/kyAh7jz//5YdEPHA/xQ hxHdpjRR7+asmmp5SqLsgdOZbc9tPxarfD3HqlUUvfQbtetFgWe3VZtky4h00nzQmF q+eDwKIo0NLVUxxexGo4hwza9oXvoufsm8tcGjHPXqOLx/26ymB8hL/+8I9h1yIafQ xBzpkUv9cDAefB58AcuvCi7jwYew29Cun7EXBY6hsgZSSsxzral7P4bq8l0LQCyFb3 tcZwNPUPlGmV84s7Q1iokih1B94N51bUWtF9Eh8bbe/3RU8/qtx9s1Ss3U6jhecNVc B8ip+bzg1ziZQ== Received: from mchehab by mail.kernel.org with local (Exim 4.97.1) (envelope-from ) id 1sRnKc-00000002b5h-1ajO; Thu, 11 Jul 2024 08:31:06 +0200 From: Mauro Carvalho Chehab To: Borislav Petkov , Tony Luck Cc: Mauro Carvalho Chehab , "Ard Biesheuvel" , "James Morse" , "Jonathan Cameron" , "Len Brown" , "Rafael J. Wysocki" , "Shiju Jose" , Jonathan Corbet , linux-acpi@vger.kernel.org, linux-doc@vger.kernel.org, linux-edac@vger.kernel.org, linux-efi@vger.kernel.org, linux-kernel@vger.kernel.org Subject: [PATCH v2 5/5] docs: efi: add CPER functions to driver-api Date: Thu, 11 Jul 2024 08:28:56 +0200 Message-ID: X-Mailer: git-send-email 2.45.2 In-Reply-To: References: Precedence: bulk X-Mailing-List: linux-efi@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Sender: Mauro Carvalho Chehab 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: Mauro Carvalho Chehab Reviewed-by: Jonathan Cameron --- Documentation/driver-api/firmware/efi/index.rst | 11 ++++++++--- drivers/firmware/efi/cper.c | 2 +- 2 files changed, 9 insertions(+), 4 deletions(-) diff --git a/Documentation/driver-api/firmware/efi/index.rst b/Documentation/driver-api/firmware/efi/index.rst index 4fe8abba9fc6..5a6b6229592c 100644 --- a/Documentation/driver-api/firmware/efi/index.rst +++ b/Documentation/driver-api/firmware/efi/index.rst @@ -1,11 +1,16 @@ .. 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 diff --git a/drivers/firmware/efi/cper.c b/drivers/firmware/efi/cper.c index 462d739e8dd1..295f6f339575 100644 --- a/drivers/firmware/efi/cper.c +++ b/drivers/firmware/efi/cper.c @@ -69,7 +69,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