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 X-Spam-Level: X-Spam-Status: No, score=-10.1 required=3.0 tests=DKIMWL_WL_HIGH,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,INCLUDES_PATCH,MAILING_LIST_MULTI,SIGNED_OFF_BY, SPF_HELO_NONE,SPF_PASS,USER_AGENT_GIT autolearn=unavailable autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id EB484C81C40 for ; Mon, 27 Apr 2020 21:18:36 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id C54F2206D6 for ; Mon, 27 Apr 2020 21:18:36 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=default; t=1588022316; bh=N8bgzSaxaSPsvZKSTzHZfDpMlxQCMfS1JI2Jy6c2/m0=; h=From:To:Cc:Subject:Date:In-Reply-To:References:List-ID:From; b=gGYky7Ed7g1vvUAK6Gc33iGsBK1lXu+MfTi4cXoDtUjiSrevcx7fC2I2rsE5FfxwS 3+NUdOC8c3D3b5mvTpbTQhQRqudJxWTbc85kaQaevYriE5DZhuMQWWDYgObd9aAs4r GUCVaT9l+rr4f6ndq5317DDwyGhOMYyNxRRuuSdE= Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1726738AbgD0VSf (ORCPT ); Mon, 27 Apr 2020 17:18:35 -0400 Received: from mail.kernel.org ([198.145.29.99]:34202 "EHLO mail.kernel.org" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1726399AbgD0VR1 (ORCPT ); Mon, 27 Apr 2020 17:17:27 -0400 Received: from mail.kernel.org (ip5f5ad5c5.dynamic.kabel-deutschland.de [95.90.213.197]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPSA id F0AE922205; Mon, 27 Apr 2020 21:17:24 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=default; t=1588022245; bh=N8bgzSaxaSPsvZKSTzHZfDpMlxQCMfS1JI2Jy6c2/m0=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=fxkNb+E7KjrZ7oUihDpHGpW6eJJtZOe5QrGQGDAC4YHEo3NbcOFinPRiVk/DhOmq7 MPLCkzV/Hv513uB1ZIO1VjUxlLD0mGP5rGPCTT3DFBWYOZEZ1sPdamRQf37yW1xPK3 ZhlQk70aCfBMyodSIf3eO8zABHaCTbU7Vp1D6JAE= Received: from mchehab by mail.kernel.org with local (Exim 4.92.3) (envelope-from ) id 1jTB7z-000HlW-9L; Mon, 27 Apr 2020 23:17:23 +0200 From: Mauro Carvalho Chehab To: Linux Doc Mailing List Cc: Mauro Carvalho Chehab , linux-kernel@vger.kernel.org, Jonathan Corbet Subject: [PATCH v3 24/29] docs: filesystems: convert spufs/spu_run.txt to ReST Date: Mon, 27 Apr 2020 23:17:16 +0200 Message-Id: <7d8ee1edf5ef0137009bc65ff0441826ce555895.1588021877.git.mchehab+huawei@kernel.org> X-Mailer: git-send-email 2.25.4 In-Reply-To: References: MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Sender: linux-kernel-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org This file is at groff output format. Manually convert it to ReST format, trying to preserve a similar output after parsed. Signed-off-by: Mauro Carvalho Chehab --- Documentation/filesystems/spufs/index.rst | 1 + .../spufs/{spu_run.txt => spu_run.rst} | 65 ++++++++++++------- 2 files changed, 42 insertions(+), 24 deletions(-) rename Documentation/filesystems/spufs/{spu_run.txt => spu_run.rst} (84%) diff --git a/Documentation/filesystems/spufs/index.rst b/Documentation/filesystems/spufs/index.rst index 939cf59a7d9e..5ed4a8494967 100644 --- a/Documentation/filesystems/spufs/index.rst +++ b/Documentation/filesystems/spufs/index.rst @@ -10,3 +10,4 @@ SPU Filesystem spufs spu_create + spu_run diff --git a/Documentation/filesystems/spufs/spu_run.txt b/Documentation/filesystems/spufs/spu_run.rst similarity index 84% rename from Documentation/filesystems/spufs/spu_run.txt rename to Documentation/filesystems/spufs/spu_run.rst index d5c6a00d0f97..7fdb1c31cb91 100644 --- a/Documentation/filesystems/spufs/spu_run.txt +++ b/Documentation/filesystems/spufs/spu_run.rst @@ -1,17 +1,26 @@ -SPU_RUN(2) Linux Programmer's Manual SPU_RUN(2) +.. SPDX-License-Identifier: GPL-2.0 +======= +spu_run +======= -NAME +Name +==== spu_run - execute an spu context -SYNOPSIS - #include +Synopsis +======== - int spu_run(int fd, unsigned int *npc, unsigned int *event); + :: -DESCRIPTION + #include + + int spu_run(int fd, unsigned int *npc, unsigned int *event); + +Description +=========== The spu_run system call is used on PowerPC machines that implement the Cell Broadband Engine Architecture in order to access Synergistic Pro- cessor Units (SPUs). It uses the fd that was returned from spu_cre- @@ -45,24 +54,31 @@ DESCRIPTION If NULL is passed as the event argument, these errors will result in a signal delivered to the calling process. -RETURN VALUE +Return Value +============ spu_run returns the value of the spu_status register or -1 to indicate an error and set errno to one of the error codes listed below. The spu_status register value contains a bit mask of status codes and optionally a 14 bit code returned from the stop-and-signal instruction on the SPU. The bit masks for the status codes are: - 0x02 SPU was stopped by stop-and-signal. + 0x02 + SPU was stopped by stop-and-signal. - 0x04 SPU was stopped by halt. + 0x04 + SPU was stopped by halt. - 0x08 SPU is waiting for a channel. + 0x08 + SPU is waiting for a channel. - 0x10 SPU is in single-step mode. + 0x10 + SPU is in single-step mode. - 0x20 SPU has tried to execute an invalid instruction. + 0x20 + SPU has tried to execute an invalid instruction. - 0x40 SPU has tried to access an invalid channel. + 0x40 + SPU has tried to access an invalid channel. 0x3fff0000 The bits masked with this value contain the code returned from @@ -71,7 +87,8 @@ RETURN VALUE There are always one or more of the lower eight bits set or an error code is returned from spu_run. -ERRORS +Errors +====== EAGAIN or EWOULDBLOCK fd is in non-blocking mode and spu_run would block. @@ -93,29 +110,29 @@ ERRORS not loaded. -NOTES +Notes +===== spu_run is meant to be used from libraries that implement a more abstract interface to SPUs, not to be used from regular applications. See http://www.bsc.es/projects/deepcomputing/linuxoncell/ for the rec- ommended libraries. -CONFORMING TO +Conforming to +============= This call is Linux specific and only implemented by the ppc64 architec- ture. Programs using this system call are not portable. -BUGS +Bugs +==== The code does not yet fully implement all features lined out here. -AUTHOR +Author +====== Arnd Bergmann -SEE ALSO +See Also +======== capabilities(7), close(2), spu_create(2), spufs(7) - - - - -Linux 2005-09-28 SPU_RUN(2) -- 2.25.4