From nobody Tue Apr 7 06:14:32 2026 Received: from mail-wm1-f45.google.com (mail-wm1-f45.google.com [209.85.128.45]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id B2ECD1A3157 for ; Sun, 15 Mar 2026 15:38:20 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.128.45 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1773589102; cv=none; b=Xto8Z5FIveYxVbxMAAPpf1+HIgCJgNobR9rBDCTPASyEtuqnhHB1KOu6UL0UijR1kvNdn0/Cs3B5xBD44fr0cguOaq9/8GoLD48lmTKmV0OvlZaW9YDxODnVhVUIR7KBDjiCqR8HnDT7dhbAaMbzxMnPZdL+vzTaUUJpV3UmgkY= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1773589102; c=relaxed/simple; bh=DDZPuAOWzv4vTj8neHpc5Srgee87ymRhHawAGzTEMwg=; h=From:To:Cc:Subject:Date:Message-ID:MIME-Version; b=OPheuabQFduR5dPZ4qr8g0PGFu3EomaAA5GShdFKhVWHIgwZr6281lC490XXQAi2NogDGCnBMyCNPyYEdNuXaR+l9XjVzMuS59FdBDwxlgOulLmfzb/yyiY7fkPDarA7ua9JVJH2KG8pxDbKuponUuu9qRmOP1Nz3NmOLPbn/gY= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com; spf=pass smtp.mailfrom=gmail.com; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b=VO9VHcbO; arc=none smtp.client-ip=209.85.128.45 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=gmail.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="VO9VHcbO" Received: by mail-wm1-f45.google.com with SMTP id 5b1f17b1804b1-48534b59cf3so33204015e9.2 for ; Sun, 15 Mar 2026 08:38:20 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1773589099; x=1774193899; darn=vger.kernel.org; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:from:to:cc:subject:date:message-id:reply-to; bh=tgkBw5OnojBrxNHN+m3w323m1e8OxqpyisbSdD+yjCM=; b=VO9VHcbOOKcyCzMjimFXzY2bVkyJgFEL3VARCpdEEmyj5kWvCBk630Bvq+8aZXky7E AQ61iuwN2RY+zD5Xaa6qCk0F9B6IN6E1eN3hH2/nNO9f/16fhR63MYjjt9OYHAxj42// buS3ttCt1MR1SXNIrpbmrDJ8R+9C8nwCErV8JTgxrxRe+bl/gn5WPTWdK0UkaEuxLnQw SK9RNnDwg8nT2KbJcbDdMYnSHuMAz9/RN/hM8SHyzlNE90i6922WMVyoVs2TdJK+BZBT dg/BlrwnF2XVgTyAk53u4YrALpYuPXEsFMpHeeQayemVV/yO7R3+xSoALuvFRgO+Eenx 20og== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20251104; t=1773589099; x=1774193899; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:x-gm-gg:x-gm-message-state:from:to:cc:subject:date :message-id:reply-to; bh=tgkBw5OnojBrxNHN+m3w323m1e8OxqpyisbSdD+yjCM=; b=iqRN62qsGr0DB0X38iiayw1r8gp53MYSWtZ65CWngfMrbNptd6wDIusaZyHCpsLg9L rZOn8sjwz/zdEPQ7Zz4i+FdtZSiEYTmdYqlLknJNMmI489zeQHLZVS+fhfSYGBvHoU+8 oQ/PgIc2GlZmjDz88L0GC/S5YJJoVkjwVhSvNEsMAJjBY4Xu/ezsAg6zw9zDiL88IOqu nkpIZBMwOStSfCC0ZQ1WiK7ju5ilA/zOX5O6GmbTzIhu7Qnkm57i1aJWtE+Nq8R02MC6 L33MXEHicI6XXTUQ2NXPRzFVez57qZpa6HIGrxFd5ceFAGJfrVnItBMdvceLmsn1QHVn FRjA== X-Forwarded-Encrypted: i=1; AJvYcCVXRn7yAZNWmQIbDhFk6FAQRwC5RjpScINVwExhVvAXID3SgzEIqlB2JY5N5eHhj9lhRlmnI3BA1UO5tZc=@vger.kernel.org X-Gm-Message-State: AOJu0Ywp0iUCzB9PDjdPP1tVDu4PdXgmwUCxRQbSMpCNOd12Rh/o+aa4 lcRt6GDOSlsdA7JqhN3v/gnj5RfPeDmy3O/9AUTyAAreVFnlM3cqV4kw X-Gm-Gg: ATEYQzyll7fq7LVEpB+Q+KUWiFQDRHWXd/rrjR6EKssFZ+DolShG3dZxVjGh5DvES+3 pfSzDH4kk3PVJCBo77jTo0hDCdygPTTJAN4uj2b4506BRRpbgziP4sFkAz9ymLSd6794O+wfD4C WGRJYESOlkW9JkK9HKLN/QzvORNmAV8c/r0Sbh2+f7L/ZyQhJ7DBbnxafoV9BbDKFnYA6p8mvSx Re77Vuigm4i1r4tUu2MOLAuJ8tl3L75krqlMWZoZ6ruJ+itoke5q0BODU0Gk4gM8Npu3RpZdWzn sv9A//jxAzj8teQFDa6hTsr0wACRfeANYaLPBXXH3pA2LAHYGUIcYJg18P58S4mmX+tIemcbsIn wXYCsh02T/qawxsj1ljRVYgaYcqVGSe2xVh+f+H8b/d33XU4SfiFE10r/Nh01+ZNEF19gET4h3v VreNDADNYxHGjHs2AfgsZ+FbLt326szUzuCtZgydU99L1Uo4oNMUfHpGhOPGwWGQ7FKE4An8U76 gCHuRI4qq0qA6188vxggE3fVTruEQ== X-Received: by 2002:a05:600d:6445:10b0:485:35a4:939c with SMTP id 5b1f17b1804b1-4855670c0f4mr119960285e9.29.1773589098938; Sun, 15 Mar 2026 08:38:18 -0700 (PDT) Received: from DESKTOP-TILNSD1.localdomain ([139.47.104.103]) by smtp.gmail.com with ESMTPSA id 5b1f17b1804b1-48557c6e2b1sm68018115e9.28.2026.03.15.08.38.17 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sun, 15 Mar 2026 08:38:18 -0700 (PDT) From: Kit Dallege To: Andrew Morton , Baoquan He Cc: kexec@lists.infradead.org, linux-kernel@vger.kernel.org, Kit Dallege , Claude Subject: [PATCH] kexec: add missing kernel-doc parameters for ELF loading functions Date: Sun, 15 Mar 2026 16:38:08 +0100 Message-ID: <20260315153808.49218-1-xaum.io@gmail.com> X-Mailer: git-send-email 2.53.0 Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="utf-8" Document all missing parameters across 6 functions in kexec_elf.c: elf_is_ehdr_sane(), elf_is_phdr_sane(), elf_read_phdrs(), kexec_free_elf_info(), kexec_build_elf_info(), and kexec_elf_load(). Assisted-by: Claude Signed-off-by: Kit Dallege --- kernel/kexec_elf.c | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/kernel/kexec_elf.c b/kernel/kexec_elf.c index 3a5c25b2adc9..48f7c0677e87 100644 --- a/kernel/kexec_elf.c +++ b/kernel/kexec_elf.c @@ -58,6 +58,7 @@ static uint16_t elf16_to_cpu(const struct elfhdr *ehdr, u= int16_t value) =20 /** * elf_is_ehdr_sane - check that it is safe to use the ELF header + * @ehdr: pointer to the ELF header to check. * @buf_len: size of the buffer in which the ELF file is loaded. */ static bool elf_is_ehdr_sane(const struct elfhdr *ehdr, size_t buf_len) @@ -180,6 +181,7 @@ static int elf_read_ehdr(const char *buf, size_t len, s= truct elfhdr *ehdr) =20 /** * elf_is_phdr_sane - check that it is safe to use the program header + * @phdr: pointer to the ELF program header to check. * @buf_len: size of the buffer in which the ELF file is loaded. */ static bool elf_is_phdr_sane(const struct elf_phdr *phdr, size_t buf_len) @@ -244,6 +246,9 @@ static int elf_read_phdr(const char *buf, size_t len, =20 /** * elf_read_phdrs - read the program headers from the buffer + * @buf: buffer to read ELF file from. + * @len: size of @buf. + * @elf_info: pointer to existing struct which will be populated. * * This function assumes that the program header table was checked for san= ity. * Use elf_is_ehdr_sane() if it wasn't. @@ -315,6 +320,7 @@ static int elf_read_from_buffer(const char *buf, size_t= len, =20 /** * kexec_free_elf_info - free memory allocated by elf_read_from_buffer + * @elf_info: ELF info struct to free. */ void kexec_free_elf_info(struct kexec_elf_info *elf_info) { @@ -323,6 +329,10 @@ void kexec_free_elf_info(struct kexec_elf_info *elf_in= fo) } /** * kexec_build_elf_info - read ELF executable and check that we can use it + * @buf: buffer to read ELF file from. + * @len: size of @buf. + * @ehdr: pointer to existing struct which will be populated. + * @elf_info: pointer to existing struct which will be populated. */ int kexec_build_elf_info(const char *buf, size_t len, struct elfhdr *ehdr, struct kexec_elf_info *elf_info) @@ -379,7 +389,11 @@ int kexec_elf_probe(const char *buf, unsigned long len) =20 /** * kexec_elf_load - load ELF executable image - * @lowest_load_addr: On return, will be the address where the first PT_LO= AD + * @image: pointer to the kexec image being loaded. + * @ehdr: pointer to the ELF header of the executable. + * @elf_info: pointer to the ELF info struct with program headers. + * @kbuf: pointer to the kexec buffer used for segment loading. + * @lowest_load_addr: on return, will be the address where the first PT_LO= AD * section will be loaded in memory. * * Return: --=20 2.53.0