From patchwork Thu Mar 19 14:43:15 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Heinrich Schuchardt X-Patchwork-Id: 1258273 X-Patchwork-Delegate: xypron.glpk@gmx.de Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Authentication-Results: ozlabs.org; spf=pass (sender SPF authorized) smtp.mailfrom=lists.denx.de (client-ip=2a01:238:438b:c500:173d:9f52:ddab:ee01; helo=phobos.denx.de; envelope-from=u-boot-bounces@lists.denx.de; receiver=) Authentication-Results: ozlabs.org; dmarc=none (p=none dis=none) header.from=gmx.de Authentication-Results: ozlabs.org; dkim=pass (1024-bit key; secure) header.d=gmx.net header.i=@gmx.net header.a=rsa-sha256 header.s=badeba3b8450 header.b=abyMHAF0; dkim-atps=neutral Received: from phobos.denx.de (phobos.denx.de [IPv6:2a01:238:438b:c500:173d:9f52:ddab:ee01]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits)) (No client certificate requested) by ozlabs.org (Postfix) with ESMTPS id 48jqQr3JXvz9sTX for ; Fri, 20 Mar 2020 01:43:32 +1100 (AEDT) Received: from h2850616.stratoserver.net (localhost [IPv6:::1]) by phobos.denx.de (Postfix) with ESMTP id 23DEE801D2; Thu, 19 Mar 2020 15:43:26 +0100 (CET) Authentication-Results: phobos.denx.de; dmarc=none (p=none dis=none) header.from=gmx.de Authentication-Results: phobos.denx.de; spf=pass smtp.mailfrom=u-boot-bounces@lists.denx.de Authentication-Results: phobos.denx.de; dkim=pass (1024-bit key; secure) header.d=gmx.net header.i=@gmx.net header.b="abyMHAF0"; dkim-atps=neutral Received: by phobos.denx.de (Postfix, from userid 109) id E06518025D; Thu, 19 Mar 2020 15:43:23 +0100 (CET) X-Spam-Checker-Version: SpamAssassin 3.4.2 (2018-09-13) on phobos.denx.de X-Spam-Level: X-Spam-Status: No, score=-1.9 required=5.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,FREEMAIL_FROM,SPF_HELO_NONE,URIBL_BLOCKED autolearn=ham autolearn_force=no version=3.4.2 Received: from mout.gmx.net (mout.gmx.net [212.227.15.15]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by phobos.denx.de (Postfix) with ESMTPS id B7501800DF for ; Thu, 19 Mar 2020 15:43:20 +0100 (CET) Authentication-Results: phobos.denx.de; dmarc=none (p=none dis=none) header.from=gmx.de Authentication-Results: phobos.denx.de; spf=pass smtp.mailfrom=xypron.glpk@gmx.de DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=gmx.net; s=badeba3b8450; t=1584628999; bh=KXRZjUUIKfEOwSPoOEq16X1ygoKPpbcZpr8//dy7Dds=; h=X-UI-Sender-Class:From:To:Cc:Subject:Date; b=abyMHAF0U8rlY/33hCz736v29MGc8lDJGxY7zltugOPNTBpe+2c64waW53mBAf8nT FQ5I7+EkoNG8mmi20SMDbMRSS9a6/g4bAgt00Nn62CudhV0B1Zsceyx3zNRNPPal7W lGxVRvXbq/mg76ZXN1mj81cuY4Bpy8ahozgiz9rs= X-UI-Sender-Class: 01bb95c1-4bf8-414a-932a-4f6e2808ef9c Received: from workstation5.fritz.box ([84.119.33.226]) by mail.gmx.com (mrgmx005 [212.227.17.184]) with ESMTPSA (Nemesis) id 1MNbkv-1iuPfg241T-00P98n; Thu, 19 Mar 2020 15:43:19 +0100 From: Heinrich Schuchardt To: Alexander Graf Cc: u-boot@lists.denx.de, Heinrich Schuchardt Subject: [PATCH 1/1] efi_loader: fix function descriptions in efi_disk.c Date: Thu, 19 Mar 2020 15:43:15 +0100 Message-Id: <20200319144315.40712-1-xypron.glpk@gmx.de> X-Mailer: git-send-email 2.25.1 MIME-Version: 1.0 X-Provags-ID: V03:K1:1lZa/A8uYcWqx00LoX0H6EWV2yyyMKyTJARIfCQt5Lzn7lVoRQb n69BEoZmPF8ToDA+YYpNyqal3Sna5jiIsTiOppVWEAliKMHj4q3HZyrGpYJV1z6zPsw9t/Q S2UgLOUjzsVBVf4/n0iYZMJQ/KRGUAlIlOxLN6JW3xF6kkuco8IA0w02NtdZuVyLauh7R++ kfkUijMioTk/EoUlfR+Xw== X-UI-Out-Filterresults: notjunk:1; V03:K0:qqOeQTVN/X0=:VDTaJGttSYjmBeD+Rsiz4Q 4EIPJ5zFzhIrQ1ZTku6FDBxKIFjCWydfmiAVhbAPgZGMXWfvd1w42ZHN1vmYjvNL2tVFFBxGQ 8N+zeZAFYc1bCsjEtTtu7r7iGBPcFU/CybwXMQaSqUIQG2bB0wzchwSgtPIfm9gijQ5ycAkcX 9DUS6xskDj0ZpAIxasZCDCgS8HnsHKRW8yVhhKz1uFCc087dJ35EKkJotsegykXyLXPVap8f8 eioVa4iUSgDFnXjGQYXAnJzCxaVR6Z3gRGc7f7WsN1aVuZFbT5C0/eqR4VyHA4ntsTOJ5QcsH 3q/fnG2CEEAyrnfsbybGPv2j7ksJkDuY3DOxh6noBZTomdECRU2fuZAKcsN8U9hs6iwQds/sR 6Xo4QUdyYg90KF6F0GmZ2FB5hQbgTnCVGq4ixaC3T05Rx3PbBWZLCgnNgLzQbO/gSKGhNi1rN 134Bkyiabsy8aZwJr0IgpThzPngYnCJXntBU1syYuU55eAtCXfgMALW71AbVH8Kf8WdFAn43X pGTopwbPH/bSNIae4t0NeB5CuTNVteFDCRb1So6pb4BPQJ1XIlrd86N+rp/UU+ypHhvtCo0up ccPmJx9k+QiltUDpuQiwY7pEuf+h/lEhE2G7p1rUl4hlCtOmV6YtRFBQCk9zjUEnlLmu8G14X Jfcwl8lMbBmVdaj+bkjxUuSfpXks7TrzWnRX0JvM0l3cSoQzZTC/9VVjgacV2VmUJ1lVgomZO dJPH6U3Ghw8hrkqVZe5Td6X8HYEoWZlxCi47arCYEwIYCu52WrixGk7SkXSyho+Lar5ExosqG O6ikGNilhBZqGZ0hHceGIwvjCEZ/1XBQ+O9Gz3Ce11vSp1XJAfWl4Vocs+pIDj75JF5cfKTdc ul8NBuSOWWf09BRNSwQBVTwnlp0yShO3qSGaxZCHlzMC9DUzTz6kY524tSZWlTGXieDdoN/5A T1Ntu2GdAwzhA+jwm0xd4cKb6eRrBP4SW/YhcxWHeHmlSEK6nLtU+WXJwkjB4UIbSFvd0w4HM dNVlYXsgPkco0uKOMoKCdou5pS8+n15Ds4XyIe6JVBYQsZCb81yiAI4bnGQEVLJA2fjCfGRRo 4OPTVxnU+1ulzaIIaKuJxYvWH3oqy2rU+IH9zfIUyFIGLIyTWBmo/EvGadtOFc2Gc4VATTGLk hJp8FZ9N2nCgJGQcpLXQh30OTla2PtF9PCsAgeNVm4RH2hV0DWY0boXwm5TsKw4pmJazAFe/j dg5ZKGHWJEk3JPt2n X-BeenThere: u-boot@lists.denx.de X-Mailman-Version: 2.1.30rc1 Precedence: list List-Id: U-Boot discussion List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: u-boot-bounces@lists.denx.de Sender: "U-Boot" X-Virus-Scanned: clamav-milter 0.102.2 at phobos.denx.de X-Virus-Status: Clean Use Sphinx style for function descriptions. Signed-off-by: Heinrich Schuchardt --- lib/efi_loader/efi_disk.c | 52 ++++++++++++++++++++++----------------- 1 file changed, 30 insertions(+), 22 deletions(-) -- 2.25.1 diff --git a/lib/efi_loader/efi_disk.c b/lib/efi_loader/efi_disk.c index ed7fb3f7d3..9563556691 100644 --- a/lib/efi_loader/efi_disk.c +++ b/lib/efi_loader/efi_disk.c @@ -222,15 +222,17 @@ static const struct efi_block_io block_io_disk_template = { .flush_blocks = &efi_disk_flush_blocks, }; -/* - * Get the simple file system protocol for a file device path. +/** + * efi_fs_from_path() - retrieve simple file system protocol + * + * Gets the simple file system protocol for a file device path. * * The full path provided is split into device part and into a file * part. The device part is used to find the handle on which the * simple file system protocol is installed. * - * @full_path device path including device and file - * @return simple file system protocol + * @full_path: device path including device and file + * Return: simple file system protocol */ struct efi_simple_file_system_protocol * efi_fs_from_path(struct efi_device_path *full_path) @@ -285,15 +287,15 @@ static int efi_fs_exists(struct blk_desc *desc, int part) } /* - * Create a handle for a partition or disk + * efi_disk_add_dev() - create a handle for a partition or disk * - * @parent parent handle - * @dp_parent parent device path - * @if_typename interface name for block device - * @desc internal block device - * @dev_index device index for block device - * @offset offset into disk for simple partitions - * @return disk object + * @parent: parent handle + * @dp_parent: parent device path + * @if_typename: interface name for block device + * @desc: internal block device + * @dev_index: device index for block device + * @offset: offset into disk for simple partitions + * Return: disk object */ static efi_status_t efi_disk_add_dev( efi_handle_t parent, @@ -373,15 +375,17 @@ static efi_status_t efi_disk_add_dev( return EFI_SUCCESS; } -/* - * Create handles and protocols for the partitions of a block device +/** + * efi_disk_create_partitions() - create handles and protocols for partitions * - * @parent handle of the parent disk - * @blk_desc block device - * @if_typename interface type - * @diskid device number - * @pdevname device name - * @return number of partitions created + * Create handles and protocols for the partitions of a block device. + * + * @parent: handle of the parent disk + * @blk_desc: block device + * @if_typename: interface type + * @diskid: device number + * @pdevname: device name + * Return: number of partitions created */ int efi_disk_create_partitions(efi_handle_t parent, struct blk_desc *desc, const char *if_typename, int diskid, @@ -418,16 +422,20 @@ int efi_disk_create_partitions(efi_handle_t parent, struct blk_desc *desc, return disks; } -/* +/** + * efi_disk_register() - register block devices + * * U-Boot doesn't have a list of all online disk devices. So when running our * EFI payload, we scan through all of the potentially available ones and * store them in our object pool. * + * This function is called in efi_init_obj_list(). + * * TODO(sjg@chromium.org): Actually with CONFIG_BLK, U-Boot does have this. * Consider converting the code to look up devices as needed. The EFI device * could be a child of the UCLASS_BLK block device, perhaps. * - * This gets called from do_bootefi_exec(). + * Return: status code */ efi_status_t efi_disk_register(void) {