From nobody Tue Apr 7 05:42:07 2026 Received: from mail-wm1-f42.google.com (mail-wm1-f42.google.com [209.85.128.42]) (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 EAA2B1A9FBC for ; Sun, 15 Mar 2026 17:10:23 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.128.42 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1773594625; cv=none; b=CmMNF+MgJZw2AqgYdAEWyYLdu1P2Bg7BU94rH+/xGljq67bWSB8NpwImDM/75lVClg7f3I1xSAOuW3eEJSp8ZGYpG8rgjbdUishWE7usQ40yUuJ0Xy6yB/UuaPjmZD7vzST8UoJOC9WinistfH6Vf3KDLZTl6a0jEC87J5ru7is= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1773594625; c=relaxed/simple; bh=w8QQyAnKHTCJANMer94bVLG2aMQnYGw00SNP5sHCnkE=; h=From:To:Cc:Subject:Date:Message-ID:MIME-Version; b=eZv9v11Pcwv46zbubjaIpoZVY5cQPlJsXlZw4KHdPpdjyGzrgkod4QTBxHpBrWwHlIZBiSNGEL7vktwM1RatDyjhm/qE2CPU3yvd1Gj0m2uxvbeZx1zLn4dXwaynVS81tomaOi8PjuGap69/ZbKqwQVPxP603YeNOB+ze4aYeEs= 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=eU1noDY+; arc=none smtp.client-ip=209.85.128.42 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="eU1noDY+" Received: by mail-wm1-f42.google.com with SMTP id 5b1f17b1804b1-4853c3c2fe7so22925665e9.0 for ; Sun, 15 Mar 2026 10:10:23 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1773594622; x=1774199422; 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=YRgTtVCfp33nFF3iOJpPBpviRk62A8CIxOCCKEiDg4M=; b=eU1noDY+Alf1J9iqXFacH/nzVgPptqHSX2VTic/zsT35LmhmSSx4lh8UPU41UAT0MK 4b4JeJltloJ23uu+Fe0RFcgctwnE6BVzFLIY1DF+70mC51ckeJmTmW379IYlSZbeciwr G2t2XHq8lir4QESZQ/RuRp6CY8hxrD63p9PluGUfS7mfAGE2U3Qdha0j7e13ETdCBYak wo2vrGiyA1sRCOQaTmAHbQUdzsNm8IAf/huZ3f+uVBWbF5f6dNex2PYBHJabueukyh3Y nWRjy1l34Bm+NoAfhJ5e/aAkMonRciAu5fzYTVdC9N54fokTzfOscKb/MKyMYpF/MQ1B awPg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20251104; t=1773594622; x=1774199422; 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=YRgTtVCfp33nFF3iOJpPBpviRk62A8CIxOCCKEiDg4M=; b=BWsuZLuBTpHechmEua/+e0t//jCQtJozjatpacXnKqDmeqN8+Mj0kgFtVOPYFx6Tdi HnLd+SUVai8t/tdkVWtEQKTtb0T24DBiIdM4GYuJvYQ7mUFmsKX01zHyUTTCyKEbPFtz 56VMlHzN+mfNjZrf8QMgbOOBbMRfcQn7jE01qdJP1BORh02VHCWElcF5QmdgkQ4cb/BB VZl8TVSAhd0c21d6DDgPVW7+JT0bfWx44h/Ckilc3v54k2aFA+cNLFa4NS1ERu01hf0w 32CfY94UZwoDRunJ+eDgmEVhK61TG+nIoDK5wEo5jrW0HrhmNOFABlbuGgxv4QPdOB3c 3L7A== X-Forwarded-Encrypted: i=1; AJvYcCXPT08wbY6JuZUqtaZUqtmTFR5j0EitTf3namVhq8KnWJjvak5J8Z1fiIhYIABK9JFkL7GSwCEOnbAE7kA=@vger.kernel.org X-Gm-Message-State: AOJu0Yyp3/2DhpGkTJiZxUF7LkAqLnTVcRCev79zBy/4fH7UZmgb8cuz BxSBQh9l6gcDhrT67OZlVnZ15oE6gzkSk2HjmrGrdKR4FJWAFZNITbJ1//L4Zkwe1uA= X-Gm-Gg: ATEYQzw8wRLTm+HgFJRvQ96Cw/cznS457sCJS5/KuKrYUQC4h+MG5YF9fSGrIoMCyKS 8QEJVl4TDUgy+FHyfWYAIv8daiWhu6FkWCSjY/7ehqEmLtR6ZoBJjPvZ25gB7D33GRRnIFQhzLh YVf/+MVt/NeuqOor5GQPFRblaS+yDuo9Z3SQHL5m8ZUxjP1N1/3ejwPrMEyvIjU+L03ifDTVL7z kNpl+iPAF9FK+5mufvmDYcLSFJdS3xOLVyRq4ENfOfMA+munvI5S2dKrnZ1MqjXEWR8uDQ2Vjuj Q3OJkMPO95kM0IfHL79XB6JdnH3S75ho8SY2MNcAwLg3OBvCPLjBkz66oN58V3fE1FIAZ1nDuh0 WK5QM/FDZZudh/zueps76lXQQdrbO6qTyn8qO936aFyEwEGNx1V1oBPvqri47zIvOa77F8bNF/V yCr2S/2Nlpq4aOIas+AIEszlFRNjPjGhxrtsB+1QhyL3lFrnj6XLihgrOm6nVyFOgzQPAM1a9UW kMxoMy2i7rrEEPkhGXIVRcNTRwVTg== X-Received: by 2002:a05:600c:4f8b:b0:485:3e6c:aa84 with SMTP id 5b1f17b1804b1-4855670f7d3mr167790935e9.33.1773594622123; Sun, 15 Mar 2026 10:10:22 -0700 (PDT) Received: from DESKTOP-TILNSD1.localdomain ([139.47.104.103]) by smtp.gmail.com with ESMTPSA id 5b1f17b1804b1-4854b5e9179sm354997525e9.3.2026.03.15.10.10.21 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sun, 15 Mar 2026 10:10:21 -0700 (PDT) From: Kit Dallege To: Andrew Morton , Baoquan He Cc: kexec@lists.infradead.org, linux-kernel@vger.kernel.org Subject: [PATCH v2] kexec: add missing kernel-doc parameters for ELF loading functions Date: Sun, 15 Mar 2026 18:10:11 +0100 Message-ID: <20260315171011.66068-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:claude-opus-4-6 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