Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

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>

authored by

Mauro Carvalho Chehab and committed by
Jonathan Corbet
299cd274 dc3f043f

+30 -32
+1
Documentation/filesystems/spufs/index.rst
··· 8 8 .. toctree:: 9 9 :maxdepth: 1 10 10 11 + spufs 11 12 spu_create
+28 -31
Documentation/filesystems/spufs/spufs.txt Documentation/filesystems/spufs/spufs.rst
··· 1 - SPUFS(2) Linux Programmer's Manual SPUFS(2) 1 + .. SPDX-License-Identifier: GPL-2.0 2 2 3 + ===== 4 + spufs 5 + ===== 3 6 7 + Name 8 + ==== 4 9 5 - NAME 6 10 spufs - the SPU file system 7 11 8 12 9 - DESCRIPTION 13 + Description 14 + =========== 15 + 10 16 The SPU file system is used on PowerPC machines that implement the Cell 11 17 Broadband Engine Architecture in order to access Synergistic Processor 12 18 Units (SPUs). ··· 27 21 ally add or remove files. 28 22 29 23 30 - MOUNT OPTIONS 24 + Mount Options 25 + ============= 26 + 31 27 uid=<uid> 32 28 set the user owning the mount point, the default is 0 (root). 33 29 ··· 37 29 set the group owning the mount point, the default is 0 (root). 38 30 39 31 40 - FILES 32 + Files 33 + ===== 34 + 41 35 The files in spufs mostly follow the standard behavior for regular sys- 42 36 tem calls like read(2) or write(2), but often support only a subset of 43 37 the operations supported on regular file systems. This list details the ··· 135 125 space is available for writing. 136 126 137 127 138 - /mbox_stat 139 - /ibox_stat 140 - /wbox_stat 128 + /mbox_stat, /ibox_stat, /wbox_stat 141 129 Read-only files that contain the length of the current queue, i.e. how 142 130 many words can be read from mbox or ibox or how many words can be 143 131 written to wbox without blocking. The files can be read only in 4-byte 144 132 units and return a big-endian binary integer number. The possible 145 - operations on an open *box_stat file are: 133 + operations on an open ``*box_stat`` file are: 146 134 147 135 read(2) 148 136 If a count smaller than four is requested, read returns -1 and ··· 151 143 in EAGAIN. 152 144 153 145 154 - /npc 155 - /decr 156 - /decr_status 157 - /spu_tag_mask 158 - /event_mask 159 - /srr0 146 + /npc, /decr, /decr_status, /spu_tag_mask, /event_mask, /srr0 160 147 Internal registers of the SPU. The representation is an ASCII string 161 148 with the numeric value of the next instruction to be executed. These 162 149 can be used in read/write mode for debugging, but normal operation of ··· 160 157 161 158 The contents of these files are: 162 159 160 + =================== =================================== 163 161 npc Next Program Counter 164 - 165 162 decr SPU Decrementer 166 - 167 163 decr_status Decrementer Status 168 - 169 164 spu_tag_mask MFC tag mask for SPU DMA 170 - 171 165 event_mask Event mask for SPU interrupts 172 - 173 166 srr0 Interrupt Return address register 167 + =================== =================================== 174 168 175 169 176 170 The possible operations on an open npc, decr, decr_status, ··· 206 206 from the data buffer, updating the value of the fpcr register. 207 207 208 208 209 - /signal1 210 - /signal2 209 + /signal1, /signal2 211 210 The two signal notification channels of an SPU. These are read-write 212 211 files that operate on a 32 bit word. Writing to one of these files 213 212 triggers an interrupt on the SPU. The value written to the signal ··· 232 233 file. 233 234 234 235 235 - /signal1_type 236 - /signal2_type 236 + /signal1_type, /signal2_type 237 237 These two files change the behavior of the signal1 and signal2 notifi- 238 238 cation files. The contain a numerical ASCII string which is read as 239 239 either "1" or "0". In mode 0 (overwrite), the hardware replaces the ··· 257 259 the previous setting. 258 260 259 261 260 - EXAMPLES 262 + Examples 263 + ======== 261 264 /etc/fstab entry 262 265 none /spu spufs gid=spu 0 0 263 266 264 267 265 - AUTHORS 268 + Authors 269 + ======= 266 270 Arnd Bergmann <arndb@de.ibm.com>, Mark Nutter <mnutter@us.ibm.com>, 267 271 Ulrich Weigand <Ulrich.Weigand@de.ibm.com> 268 272 269 - SEE ALSO 273 + See Also 274 + ======== 270 275 capabilities(7), close(2), spu_create(2), spu_run(2), spufs(7) 271 - 272 - 273 - 274 - Linux 2005-09-28 SPUFS(2)
+1 -1
MAINTAINERS
··· 15882 15882 L: linuxppc-dev@lists.ozlabs.org 15883 15883 S: Supported 15884 15884 W: http://www.ibm.com/developerworks/power/cell/ 15885 - F: Documentation/filesystems/spufs.txt 15885 + F: Documentation/filesystems/spufs/spufs.rst 15886 15886 F: arch/powerpc/platforms/cell/spufs/ 15887 15887 15888 15888 SQUASHFS FILE SYSTEM