mirror of
https://github.com/torvalds/linux.git
synced 2024-11-10 14:11:52 +00:00
docs: filesystems: convert spufs/spufs.txt to ReST
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 <mchehab+huawei@kernel.org> Link: https://lore.kernel.org/r/9ca05fad12390931bc7da0fa2502d1a450a4b87f.1588021877.git.mchehab+huawei@kernel.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
This commit is contained in:
Mauro Carvalho Chehab
Jonathan Corbet
parent
dc3f043ff0
commit
299cd2747c
@ -8,4 +8,5 @@ SPU Filesystem
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
spufs
|
||||
spu_create
|
||||
|
||||
@ -1,12 +1,18 @@
|
||||
SPUFS(2) Linux Programmer's Manual SPUFS(2)
|
||||
.. SPDX-License-Identifier: GPL-2.0
|
||||
|
||||
=====
|
||||
spufs
|
||||
=====
|
||||
|
||||
Name
|
||||
====
|
||||
|
||||
NAME
|
||||
spufs - the SPU file system
|
||||
|
||||
|
||||
DESCRIPTION
|
||||
Description
|
||||
===========
|
||||
|
||||
The SPU file system is used on PowerPC machines that implement the Cell
|
||||
Broadband Engine Architecture in order to access Synergistic Processor
|
||||
Units (SPUs).
|
||||
@ -21,7 +27,9 @@ DESCRIPTION
|
||||
ally add or remove files.
|
||||
|
||||
|
||||
MOUNT OPTIONS
|
||||
Mount Options
|
||||
=============
|
||||
|
||||
uid=<uid>
|
||||
set the user owning the mount point, the default is 0 (root).
|
||||
|
||||
@ -29,7 +37,9 @@ MOUNT OPTIONS
|
||||
set the group owning the mount point, the default is 0 (root).
|
||||
|
||||
|
||||
FILES
|
||||
Files
|
||||
=====
|
||||
|
||||
The files in spufs mostly follow the standard behavior for regular sys-
|
||||
tem calls like read(2) or write(2), but often support only a subset of
|
||||
the operations supported on regular file systems. This list details the
|
||||
@ -125,14 +135,12 @@ FILES
|
||||
space is available for writing.
|
||||
|
||||
|
||||
/mbox_stat
|
||||
/ibox_stat
|
||||
/wbox_stat
|
||||
/mbox_stat, /ibox_stat, /wbox_stat
|
||||
Read-only files that contain the length of the current queue, i.e. how
|
||||
many words can be read from mbox or ibox or how many words can be
|
||||
written to wbox without blocking. The files can be read only in 4-byte
|
||||
units and return a big-endian binary integer number. The possible
|
||||
operations on an open *box_stat file are:
|
||||
operations on an open ``*box_stat`` file are:
|
||||
|
||||
read(2)
|
||||
If a count smaller than four is requested, read returns -1 and
|
||||
@ -143,12 +151,7 @@ FILES
|
||||
in EAGAIN.
|
||||
|
||||
|
||||
/npc
|
||||
/decr
|
||||
/decr_status
|
||||
/spu_tag_mask
|
||||
/event_mask
|
||||
/srr0
|
||||
/npc, /decr, /decr_status, /spu_tag_mask, /event_mask, /srr0
|
||||
Internal registers of the SPU. The representation is an ASCII string
|
||||
with the numeric value of the next instruction to be executed. These
|
||||
can be used in read/write mode for debugging, but normal operation of
|
||||
@ -157,17 +160,14 @@ FILES
|
||||
|
||||
The contents of these files are:
|
||||
|
||||
=================== ===================================
|
||||
npc Next Program Counter
|
||||
|
||||
decr SPU Decrementer
|
||||
|
||||
decr_status Decrementer Status
|
||||
|
||||
spu_tag_mask MFC tag mask for SPU DMA
|
||||
|
||||
event_mask Event mask for SPU interrupts
|
||||
|
||||
srr0 Interrupt Return address register
|
||||
=================== ===================================
|
||||
|
||||
|
||||
The possible operations on an open npc, decr, decr_status,
|
||||
@ -206,8 +206,7 @@ FILES
|
||||
from the data buffer, updating the value of the fpcr register.
|
||||
|
||||
|
||||
/signal1
|
||||
/signal2
|
||||
/signal1, /signal2
|
||||
The two signal notification channels of an SPU. These are read-write
|
||||
files that operate on a 32 bit word. Writing to one of these files
|
||||
triggers an interrupt on the SPU. The value written to the signal
|
||||
@ -233,8 +232,7 @@ FILES
|
||||
file.
|
||||
|
||||
|
||||
/signal1_type
|
||||
/signal2_type
|
||||
/signal1_type, /signal2_type
|
||||
These two files change the behavior of the signal1 and signal2 notifi-
|
||||
cation files. The contain a numerical ASCII string which is read as
|
||||
either "1" or "0". In mode 0 (overwrite), the hardware replaces the
|
||||
@ -259,18 +257,17 @@ FILES
|
||||
the previous setting.
|
||||
|
||||
|
||||
EXAMPLES
|
||||
Examples
|
||||
========
|
||||
/etc/fstab entry
|
||||
none /spu spufs gid=spu 0 0
|
||||
|
||||
|
||||
AUTHORS
|
||||
Authors
|
||||
=======
|
||||
Arnd Bergmann <arndb@de.ibm.com>, Mark Nutter <mnutter@us.ibm.com>,
|
||||
Ulrich Weigand <Ulrich.Weigand@de.ibm.com>
|
||||
|
||||
SEE ALSO
|
||||
See Also
|
||||
========
|
||||
capabilities(7), close(2), spu_create(2), spu_run(2), spufs(7)
|
||||
|
||||
|
||||
|
||||
Linux 2005-09-28 SPUFS(2)
|
||||
@ -15882,7 +15882,7 @@ M: Jeremy Kerr <jk@ozlabs.org>
|
||||
L: linuxppc-dev@lists.ozlabs.org
|
||||
S: Supported
|
||||
W: http://www.ibm.com/developerworks/power/cell/
|
||||
F: Documentation/filesystems/spufs.txt
|
||||
F: Documentation/filesystems/spufs/spufs.rst
|
||||
F: arch/powerpc/platforms/cell/spufs/
|
||||
|
||||
SQUASHFS FILE SYSTEM
|
||||
|
||||
Loading…
Reference in New Issue
Block a user