summaryrefslogtreecommitdiffstats
path: root/man7/spufs.7
diff options
context:
space:
mode:
Diffstat (limited to 'man7/spufs.7')
-rw-r--r--man7/spufs.767
1 files changed, 52 insertions, 15 deletions
diff --git a/man7/spufs.7 b/man7/spufs.7
index fc3b424..3e8c2ed 100644
--- a/man7/spufs.7
+++ b/man7/spufs.7
@@ -10,14 +10,14 @@
.\" 2007-07-10, quite a lot of polishing by mtk
.\" 2007-09-28, updates for newer kernels by Jeremy Kerr <jk@ozlabs.org>
.\"
-.TH spufs 7 2023-02-05 "Linux man-pages 6.05.01"
+.TH spufs 7 2023-10-31 "Linux man-pages 6.7"
.SH NAME
spufs \- SPU filesystem
.SH DESCRIPTION
The SPU filesystem is used on PowerPC machines that implement the
Cell Broadband Engine Architecture in order to access Synergistic
Processor Units (SPUs).
-.PP
+.P
The filesystem provides a name space similar to POSIX shared
memory or message queues.
Users that have write permissions
@@ -26,7 +26,7 @@ on the filesystem can use
to establish SPU contexts under the
.B spufs
root directory.
-.PP
+.P
Every SPU context is represented by a directory containing
a predefined set of files.
These files can be
@@ -58,7 +58,7 @@ supported on regular filesystems.
This list details the supported
operations and the deviations from the standard behavior described
in the respective man pages.
-.PP
+.P
All files that support the
.BR read (2)
operation also support
@@ -80,7 +80,7 @@ structure that contain reliable information are
.IR st_uid ,
and
.IR st_gid .
-.PP
+.P
All files support the
.BR chmod (2)/\c
.BR fchmod (2)
@@ -91,7 +91,7 @@ operations, but will not be able to grant permissions that contradict
the possible operations (e.g., read access on the
.I wbox
file).
-.PP
+.P
The current set of files is:
.TP
.I /capabilities
@@ -105,7 +105,7 @@ This context may be scheduled.
.TP
.B step
This context can be run in single-step mode, for debugging.
-.PP
+.P
New capabilities flags may be added in the future.
.RE
.TP
@@ -119,7 +119,15 @@ The possible operations on an open
file are:
.RS
.TP
-.BR read "(2), " pread "(2), " write "(2), " pwrite "(2), " lseek (2)
+.BR read (2)
+.TQ
+.BR pread (2)
+.TQ
+.BR write (2)
+.TQ
+.BR pwrite (2)
+.TQ
+.BR lseek (2)
These operate as usual, with the exception that
.BR lseek (2),
.BR write (2),
@@ -289,7 +297,11 @@ file returns
whenever space is available for writing.
.RE
.TP
-.IR /mbox_stat ", " /ibox_stat ", " /wbox_stat
+.I /mbox_stat
+.TQ
+.I /ibox_stat
+.TQ
+.I /wbox_stat
These are read-only files that contain the length of the current
queue of each mailbox\[em]that is, how many words can be read from
.IR mbox " or " ibox
@@ -324,8 +336,21 @@ the respective mailbox without blocking or returning an
error.
.RE
.TP
-.IR /npc ", " /decr ", " /decr_status ", " /spu_tag_mask ", " \
-/event_mask ", " /event_status ", " /srr0 ", " /lslr
+.I /npc
+.TQ
+.I /decr
+.TQ
+.I /decr_status
+.TQ
+.I /spu_tag_mask
+.TQ
+.I /event_mask
+.TQ
+.I /event_status
+.TQ
+.I /srr0
+.TQ
+.I /lslr
Internal registers of the SPU.
These files contain an ASCII string
representing the hex value of the specified register.
@@ -433,7 +458,9 @@ updating the value of the
register.
.RE
.TP
-.IR /signal1 ", " /signal2
+.I /signal1
+.TQ
+.I /signal2
The files provide access to the two signal notification channels
of an SPU.
These are read-write files that operate on four-byte words.
@@ -484,7 +511,9 @@ or
files respectively.
.RE
.TP
-.IR /signal1_type ", " /signal2_type
+.I /signal1_type
+.TQ
+.I /signal2_type
These two files change the behavior of the
.I signal1
and
@@ -524,7 +553,15 @@ Subsequent writes to the same file descriptor overwrite the
previous setting.
.RE
.TP
-.IR /mbox_info ", " /ibox_info ", " /wbox_info ", " /dma_into ", " /proxydma_info
+.I /mbox_info
+.TQ
+.I /ibox_info
+.TQ
+.I /wbox_info
+.TQ
+.I /dma_into
+.TQ
+.I /proxydma_info
Read-only files that contain the saved state of the SPU mailboxes and
DMA queues.
This allows the SPU status to be inspected, mainly for debugging.
@@ -763,5 +800,5 @@ none /spu spufs gid=spu 0 0
.BR spu_create (2),
.BR spu_run (2),
.BR capabilities (7)
-.PP
+.P
.I The Cell Broadband Engine Architecture (CBEA) specification