From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from phobos.denx.de (phobos.denx.de [85.214.62.61]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.lore.kernel.org (Postfix) with ESMTPS id 2B848C433EF for ; Tue, 22 Mar 2022 21:02:19 +0000 (UTC) Received: from h2850616.stratoserver.net (localhost [IPv6:::1]) by phobos.denx.de (Postfix) with ESMTP id 9501883D03; Tue, 22 Mar 2022 22:01:38 +0100 (CET) Authentication-Results: phobos.denx.de; dmarc=pass (p=reject dis=none) header.from=seco.com Authentication-Results: phobos.denx.de; spf=pass smtp.mailfrom=u-boot-bounces@lists.denx.de Authentication-Results: phobos.denx.de; dkim=pass (2048-bit key; unprotected) header.d=seco.com header.i=@seco.com header.b="qBxtANMF"; dkim-atps=neutral Received: by phobos.denx.de (Postfix, from userid 109) id A50A383C07; Tue, 22 Mar 2022 22:00:34 +0100 (CET) Received: from EUR04-HE1-obe.outbound.protection.outlook.com (mail-he1eur04on0621.outbound.protection.outlook.com [IPv6:2a01:111:f400:fe0d::621]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by phobos.denx.de (Postfix) with ESMTPS id E0F4B83B58 for ; Tue, 22 Mar 2022 22:00:15 +0100 (CET) Authentication-Results: phobos.denx.de; dmarc=pass (p=reject dis=none) header.from=seco.com Authentication-Results: phobos.denx.de; spf=pass smtp.mailfrom=sean.anderson@seco.com ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=fWJUXgAkYOwdC1F3/v9psjtz4uwP8DG6SV4LTZF6wwyrbRyRRVVGgahVXOSL3egAjlYzjxZR0VDtq5vBYWQUEaWbGq/zT3J7dQxKwB51fDXAikXo0HTN2RgHycApJrS6HrKJCwPFbkZ9uMjq3P/DFBjtI5mWzgiXc48fBou3wH1hPoF933ycexdi5CS2Oyzxo0exdjgsBltOZG2f+2CIjRMnfMMeuQzF37MFtUq3nJU0Kvlp88ojwIxhh3RQ8ZvKrGxkaP0ish2YfBLsC1hqF+SsU/9XFqXwmxQ59J2NZBibRSHxTjyptHrAuKrjKQMEiqh+NRdctAeLGOSR2gJMlw== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector9901; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-AntiSpam-MessageData-ChunkCount:X-MS-Exchange-AntiSpam-MessageData-0:X-MS-Exchange-AntiSpam-MessageData-1; bh=GotR8hcH7NEumpw+EMaZQE6vrf2mXC4g/Q9ArHKaU2A=; b=O+QBuO6PCbHDpWVq20r3cMGt9eNVUFCrkr4zl1BeLdCcHpB9JP4X3Gg2WM44DF9p3FlgUlFi5En5JT95dbgMtVie/7AYG1bX02buA9bTbeEABoj4+w8ykhIz9PLyucTX9J1TRI+Ymm3TtEtBQ0woKC0U8eQHCjIqQeqRtwTQlTNYcumFPPxfIYoA2bKULJn/21SOcOyD6XE7Vp6WFCHCqua73RSbsHgknyyvvlWa6IwM0o5mUw2g0Aq7z8Aq1NtpzhxDh2E8+wYHm3qIXFqx8xT2E57q0/Gn2tCNmwUE+8RFUWllizjnFNketHR5J/qB1a7JZB/ZFbiFzwO60QqRPA== ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=pass smtp.mailfrom=seco.com; dmarc=pass action=none header.from=seco.com; dkim=pass header.d=seco.com; arc=none DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=seco.com; s=selector1; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=GotR8hcH7NEumpw+EMaZQE6vrf2mXC4g/Q9ArHKaU2A=; b=qBxtANMFfZsxdTzQyUDtGGlX4L7ckzuh3SV4qjS2Ue84zR+AR+ljBEq3I8iKTyZ7jOjQHGVf30vVovzgb9pK8VxkQCfSUwWFgi2YOM4esznqc1+L8/bmpngf+jZ/Pjf0ULDSJ9wh+oEvmFh7L5OwsX0r50WPP3PflPvjursEnIPoM0NDw7ojnW+hgiNV7oE6s7IwdnjdIPerAjYIasdQckI5LGvkJwyV9GQ/x79eIaOBDFhbXCuxuor4Yx8DGR+Da2mQ04o6ufL/7QQRIzYXimdJ7LR9jB57owGTc7bZEPIY+dA9NhmqNgLiN07dKlZKGgl0E6ufV9ZlzAQ9dQqIlg== Authentication-Results: dkim=none (message not signed) header.d=none;dmarc=none action=none header.from=seco.com; Received: from DB7PR03MB4972.eurprd03.prod.outlook.com (2603:10a6:10:7d::22) by AM0PR03MB3938.eurprd03.prod.outlook.com (2603:10a6:208:6e::29) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.5081.23; Tue, 22 Mar 2022 21:00:15 +0000 Received: from DB7PR03MB4972.eurprd03.prod.outlook.com ([fe80::2414:8ad5:9fd6:3bff]) by DB7PR03MB4972.eurprd03.prod.outlook.com ([fe80::2414:8ad5:9fd6:3bff%5]) with mapi id 15.20.5081.023; Tue, 22 Mar 2022 21:00:14 +0000 From: Sean Anderson To: Tom Rini Cc: Linus Walleij , Liviu Dudau , Andre Przywara , Simon Glass , u-boot@lists.denx.de, Sean Anderson Subject: [PATCH v3 09/29] arm: smh: Document functions in header Date: Tue, 22 Mar 2022 16:59:17 -0400 Message-Id: <20220322205938.1721846-10-sean.anderson@seco.com> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20220322205938.1721846-1-sean.anderson@seco.com> References: <20220322205938.1721846-1-sean.anderson@seco.com> Content-Transfer-Encoding: 8bit Content-Type: text/plain X-ClientProxiedBy: MN2PR20CA0012.namprd20.prod.outlook.com (2603:10b6:208:e8::25) To DB7PR03MB4972.eurprd03.prod.outlook.com (2603:10a6:10:7d::22) MIME-Version: 1.0 X-MS-PublicTrafficType: Email X-MS-Office365-Filtering-Correlation-Id: 6f65456a-0852-4e06-c8b3-08da0c46f666 X-MS-TrafficTypeDiagnostic: AM0PR03MB3938:EE_ X-Microsoft-Antispam-PRVS: X-MS-Exchange-SenderADCheck: 1 X-MS-Exchange-AntiSpam-Relay: 0 X-Microsoft-Antispam: BCL:0; X-Microsoft-Antispam-Message-Info: NN3rCWuMbp8h/h7LM+qgoXD/ZK/JC8RSdx2tfTJt+3pqXPljYvTnGAwoOZmH0XCDqanh75WYlyXH+pdZzed1r/EyF7LYt3R8LJngqhf3Ehn0cV9+G487WwRT1KoeLX+gc/LDb/m89aOvd4yWJOxEfn6tWs6SL6T1jhF+D4gd9wh6sNGl3JwtZmfUlY12CYjTtg5oOtKJjkOQg15FYPRcNPuCpvWiFOUox3VfKHOZkIKmQTfyDEEmiVyj9JzTzvg1SJ1O7Gx9V629HjgR7C3HwdWc+C3kszuG69dCGQxEUa8/vj5rB1zegsbbfrBsa++IPYZlfn5VAoPzFtBmyO8v7hpOmpC4kdwJf+1j01tPj8oUjZQT2b6R68vl72IPoA1kuAytdL7wD+V1Ct8xwctVwqVcvZM1Ng+ZQkrP0lvYuo1Uz6z7Iwml633PTS5ukeaidXcr8qVEQVLI2fh9iPym2KIN728hZ0U7e1c94+LIRabTJG/wgms6Al//3iX66Ny9UaX1SDGQo+DNN0+guVTtXfVrl4tfkDH0R+34zak7ChdSwJlSc9iYM9OiUFrKpGIY9sCeqDMNQ0WT32Ct2W5XnuMoYyYFzNh1VCqUmgAT5jC9V8R9kL5IlgWngiCj266fZIbwWg9YFTpVtKrSCNfNtHoFuWYlZtmn5cBL7McKaIUMjCdUb08dUsvPhqv/Gw0PEpwqQXeObc/aTtIljnbStQ== X-Forefront-Antispam-Report: CIP:255.255.255.255; CTRY:; LANG:en; SCL:1; SRV:; IPV:NLI; SFV:NSPM; H:DB7PR03MB4972.eurprd03.prod.outlook.com; PTR:; CAT:NONE; SFS:(13230001)(366004)(38100700002)(38350700002)(86362001)(2906002)(508600001)(66946007)(83380400001)(6486002)(8676002)(66556008)(66476007)(107886003)(4326008)(1076003)(5660300002)(2616005)(8936002)(54906003)(186003)(26005)(44832011)(52116002)(6916009)(36756003)(6506007)(6512007)(316002); DIR:OUT; SFP:1101; X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1 X-MS-Exchange-AntiSpam-MessageData-0: =?us-ascii?Q?0KQo/boKsXFmJvhA8KDzj+b8SxMcSlK1Ej+ODq35Fn+fbwT4rKecBX06PWjk?= =?us-ascii?Q?4FtbaKDxiAxRayNndvvwihxXCzVakEXzpg6EhrkRbCkQ+z5v5jteJBPHQiXc?= =?us-ascii?Q?8blnwuLcLU4cEvRchuVrTxUKbNA/K5CW4iMtb4pcvzmJT06Xf9cMR796mREt?= =?us-ascii?Q?E1awcOkkxiByw7ZE7g2KenL4yGpnEoY3sE+4+PdveMlGSyr26yhYE9MxiXmZ?= =?us-ascii?Q?j4MY2kWCknd79ymYUvqqJ6RnrJqt709Lq6nC2jo9X4f59VV0NpJy5DqHhtIX?= =?us-ascii?Q?lg8UgrEjPja3Jvvyr5bcpS6EQrCPL3X4WSqzzatlSExQyLGZqATEE+X9pxv0?= =?us-ascii?Q?pEIc+7SvQph7Rj5otFnqqZKycJtP5h0HGHmARY/lx4M+yV5LD8vY8uqRSUED?= =?us-ascii?Q?y1/bu4LKjllbADwaH5vHHipxix/xSoiL0kMn/DvdyBj/9bGEUlrPdvTeLymd?= =?us-ascii?Q?/af3zlepGNNHEjfmU2rxZoMdBPB0oPuWgeDImc1UB0sUJpsB0QG3t+ncLNs4?= =?us-ascii?Q?mfa3DPIN3JvLEfCTVQSsXy69xDI2nJnl7HEXjjJ+QzgbilXG4H+dNuDKwvr3?= =?us-ascii?Q?y3/wFQuXwBIbwyE1rVzX1GXkrn3yHvNXtRWj0+DLZchHdYT6EE3si3r4oBj9?= =?us-ascii?Q?nuLlR6Zmz9U+dNXnJQDjIshb+DhPSMIGQrQrJTCH8CuIzc0nNf2UW3WrtGu3?= =?us-ascii?Q?91DXxIHn6aVrFPIxo5V9GpvZWbuqkY3bH6YzFzI2HKgqxmujwK6GZMjXf5OF?= =?us-ascii?Q?+t+ST/UheM6RDzCXsT3b5XUo6AlKSg5OOFHWvTKWAJNrvCjwbK1Icyb05jLn?= =?us-ascii?Q?ftoIpxJ5z//sZc+UjnGRged4lMTR7WMgCMVnKUXS3/Esorr+gDTc7ie2rtDA?= =?us-ascii?Q?Q0gZ/z6C9jDZDZ49fH8uemXwuQEtnYOEFoQQLcUSUpvOxb4Vx8PHXA6EEOmN?= =?us-ascii?Q?tB8znUewnTNHB2kR1RAAl+OGrlUYo+Xt56seuU8BlqJ56/PIfokv5pRdxPl7?= =?us-ascii?Q?YMoF0E1/4RUvcGKOn2Z8/JtLI+eaxQebV7RfFQVDVQ7Hz8s/h37fVDNgWZnY?= =?us-ascii?Q?JVz2Pprb1Jt+JMDMa8twhX4xukjoi9RCpsVkMR6L3tVwy6T863vRelfUZOr2?= =?us-ascii?Q?ae6JOixhqbiJc4y6klyjcW+649IxPxKNFfhgTLVI1pbdVMoMz3UmXwRVu/gE?= =?us-ascii?Q?uSPHhIjkd8UnVFOoEUrMPgVu7MMnEPDoHqCmK/lzeyq7XajZhd/GcOYxrcUd?= =?us-ascii?Q?fztvWdPcC6SJyeUX/GbFznz3t8Frqtp87F9ad7tJyfmpWGnU0toTfEu+Qk+w?= =?us-ascii?Q?WSvSfa+elw/Gk2QUeAJFCw7x3o64mQAajax7q6PAvc+EAHItMhBQatnuOBp2?= =?us-ascii?Q?RNAaayv8YYH9zu8HSNT8+3MgfmACiaKWjOmoXGOMuj3AF4SCzeRF+9hCLFU1?= =?us-ascii?Q?rnj68LB8GNzN507YTHVnnxKftwKXAK5hbgbBoRpirj070J8K7Jd7DA=3D=3D?= X-OriginatorOrg: seco.com X-MS-Exchange-CrossTenant-Network-Message-Id: 6f65456a-0852-4e06-c8b3-08da0c46f666 X-MS-Exchange-CrossTenant-AuthSource: DB7PR03MB4972.eurprd03.prod.outlook.com X-MS-Exchange-CrossTenant-AuthAs: Internal X-MS-Exchange-CrossTenant-OriginalArrivalTime: 22 Mar 2022 21:00:14.8927 (UTC) X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted X-MS-Exchange-CrossTenant-Id: bebe97c3-6438-442e-ade3-ff17aa50e733 X-MS-Exchange-CrossTenant-MailboxType: HOSTED X-MS-Exchange-CrossTenant-UserPrincipalName: kn3yZ8c8XhAadq0jPK/zbR4mlZy9F0oZORrWHjxHmUygtj1X0pf13M6+JdpF0mVP7wtut9kpfIF3mp5MYD97RA== X-MS-Exchange-Transport-CrossTenantHeadersStamped: AM0PR03MB3938 X-BeenThere: u-boot@lists.denx.de X-Mailman-Version: 2.1.39 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.103.5 at phobos.denx.de X-Virus-Status: Clean This adds some documentation for semihosting functions in the header. Signed-off-by: Sean Anderson --- (no changes since v1) arch/arm/lib/semihosting.c | 9 --------- include/semihosting.h | 32 ++++++++++++++++++++++++++++++++ 2 files changed, 32 insertions(+), 9 deletions(-) diff --git a/arch/arm/lib/semihosting.c b/arch/arm/lib/semihosting.c index 1686457685..2943f7b82f 100644 --- a/arch/arm/lib/semihosting.c +++ b/arch/arm/lib/semihosting.c @@ -80,9 +80,6 @@ long smh_open(const char *fname, enum smh_open_mode mode) return fd; } -/* - * Read 'len' bytes of file into 'memp'. Returns 0 on success, else failure - */ long smh_read(long fd, void *memp, size_t len) { long ret; @@ -104,9 +101,6 @@ long smh_read(long fd, void *memp, size_t len) return len - ret; } -/* - * Close the file using the file descriptor - */ long smh_close(long fd) { long ret; @@ -119,9 +113,6 @@ long smh_close(long fd) return 0; } -/* - * Get the file length from the file descriptor - */ long smh_flen(long fd) { long ret; diff --git a/include/semihosting.h b/include/semihosting.h index cf54819192..d8337b6269 100644 --- a/include/semihosting.h +++ b/include/semihosting.h @@ -29,9 +29,41 @@ enum smh_open_mode { MODE_APPEND = 0x8, }; +/** + * smh_open() - Open a file on the host + * @fname: The name of the file to open + * @mode: The mode to use when opening the file + * + * Return: Either a file descriptor or a negative error on failure + */ long smh_open(const char *fname, enum smh_open_mode mode); + +/** + * smh_read() - Read data from a file + * @fd: A file descriptor returned from smh_open() + * @memp: Pointer to a buffer of memory of at least @len bytes + * @len: The number of bytes to read + * + * Return: + * * The number of bytes read on success, with 0 indicating %EOF + * * A negative error on failure + */ long smh_read(long fd, void *memp, size_t len); + +/** + * smh_close() - Close an open file + * @fd: A file descriptor returned from smh_open() + * + * Return: 0 on success or negative error on failure + */ long smh_close(long fd); + +/** + * smh_flen() - Get the length of a file + * @fd: A file descriptor returned from smh_open() + * + * Return: The length of the file, in bytes, or a negative error on failure + */ long smh_flen(long fd); #endif /* _SEMIHOSTING_H */ -- 2.25.1