Commit dc3f043f authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab Committed by Jonathan Corbet
Browse files

docs: filesystems: convert spufs/spu_create.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: default avatarMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/4d42e97d5560a79bd5dd443c592be04f9ae9a757.1588021877.git.mchehab+huawei@kernel.org


Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
parent a5a1c349

Documentation/filesystems/index.rst

+1 −0
Original line number Original line Diff line number Diff line
@@ -105,6 +105,7 @@ Documentation for filesystem implementations. 
   ramfs-rootfs-initramfs

   ramfs-rootfs-initramfs

   relay

   relay

   romfs

   romfs

   spufs/index

   squashfs

   squashfs

   sysfs

   sysfs

   sysv-fs

   sysv-fs

Documentation/filesystems/spufs/index.rst

0 → 100644
+11 −0
Original line number Original line Diff line number Diff line 
.. SPDX-License-Identifier: GPL-2.0



==============

SPU Filesystem

==============





.. toctree::

   :maxdepth: 1



   spu_create

Documentation/filesystems/spufs/spu_create.txt→Documentation/filesystems/spufs/spu_create.rst

+29 −17
Original line number Original line Diff line number Diff line 
SPU_CREATE(2)              Linux Programmer's Manual             SPU_CREATE(2)

.. SPDX-License-Identifier: GPL-2.0





==========

spu_create

==========







Name

NAME

====

       spu_create - create a new spu context

       spu_create - create a new spu context









SYNOPSIS

Synopsis

========



       ::



         #include <sys/types.h>

         #include <sys/types.h>

         #include <sys/spu.h>

         #include <sys/spu.h>





         int spu_create(const char *pathname, int flags, mode_t mode);

         int spu_create(const char *pathname, int flags, mode_t mode);





DESCRIPTION

Description

===========

       The  spu_create  system call is used on PowerPC machines that implement

       The  spu_create  system call is used on PowerPC machines that implement

       the Cell Broadband Engine Architecture in order to  access  Synergistic

       the Cell Broadband Engine Architecture in order to  access  Synergistic

       Processor  Units (SPUs). It creates a new logical context for an SPU in

       Processor  Units (SPUs). It creates a new logical context for an SPU in
@@ -43,13 +51,15 @@ DESCRIPTION 
       possible mode values.

       possible mode values.









RETURN VALUE

Return Value

============

       spu_create  returns a new file descriptor. It may return -1 to indicate

       spu_create  returns a new file descriptor. It may return -1 to indicate

       an error condition and set errno to  one  of  the  error  codes  listed

       an error condition and set errno to  one  of  the  error  codes  listed

       below.

       below.









ERRORS

Errors

======

       EACCES

       EACCES

              The  current  user does not have write access on the spufs mount

              The  current  user does not have write access on the spufs mount

              point.

              point.
@@ -87,33 +97,35 @@ ERRORS 












NOTES

Notes

=====

       spu_create  is  meant  to  be used from libraries that implement a more

       spu_create  is  meant  to  be used from libraries that implement a more

       abstract interface to SPUs, not to be used from  regular  applications.

       abstract interface to SPUs, not to be used from  regular  applications.

       See  http://www.bsc.es/projects/deepcomputing/linuxoncell/ for the rec-

       See  http://www.bsc.es/projects/deepcomputing/linuxoncell/ for the rec-

       ommended libraries.

       ommended libraries.









FILES

Files

=====

       pathname must point to a location beneath the mount point of spufs.  By

       pathname must point to a location beneath the mount point of spufs.  By

       convention, it gets mounted in /spu.

       convention, it gets mounted in /spu.









CONFORMING TO

Conforming to

=============

       This call is Linux specific and only implemented by the ppc64 architec-

       This call is Linux specific and only implemented by the ppc64 architec-

       ture. Programs using this system call are not portable.

       ture. Programs using this system call are not portable.









BUGS

Bugs

====

       The code does not yet fully implement all features lined out here.

       The code does not yet fully implement all features lined out here.









AUTHOR

Author

======

       Arnd Bergmann <arndb@de.ibm.com>

       Arnd Bergmann <arndb@de.ibm.com>





SEE ALSO

See Also

========

       capabilities(7), close(2), spu_run(2), spufs(7)
 
       capabilities(7), close(2), spu_run(2), spufs(7)
 






Linux                             2005-09-28                     SPU_CREATE(2)