/share/man/man9/VOP_IOCTL.9

https://bitbucket.org/freebsd/freebsd-head/ · Unknown · 74 lines · 74 code · 0 blank · 0 comment · 0 complexity · ae4d94b1feb8a0d2f6eb89b1fc59e6c1 MD5 · raw file 

    

  1. .\" -*- nroff -*-
    2. 

  2. .\"
    3. 

  3. .\" Copyright (c) 1996 Doug Rabson
    4. 

  4. .\"
    5. 

  5. .\" All rights reserved.
    6. 

  6. .\"
    7. 

  7. .\" This program is free software.
    8. 

  8. .\"
    9. 

  9. .\" Redistribution and use in source and binary forms, with or without
    10. 

  10. .\" modification, are permitted provided that the following conditions
    11. 

  11. .\" are met:
    12. 

  12. .\" 1. Redistributions of source code must retain the above copyright
    13. 

  13. .\"    notice, this list of conditions and the following disclaimer.
    14. 

  14. .\" 2. Redistributions in binary form must reproduce the above copyright
    15. 

  15. .\"    notice, this list of conditions and the following disclaimer in the
    16. 

  16. .\"    documentation and/or other materials provided with the distribution.
    17. 

  17. .\"
    18. 

  18. .\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
    19. 

  19. .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
    20. 

  20. .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
    21. 

  21. .\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
    22. 

  22. .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
    23. 

  23. .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
    24. 

  24. .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
    25. 

  25. .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
    26. 

  26. .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
    27. 

  27. .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
    28. 

  28. .\"
    29. 

  29. .\" $FreeBSD$
    30. 

  30. .\"
    31. 

  31. .Dd July 24, 1996
    32. 

  32. .Dt VOP_IOCTL 9
    33. 

  33. .Os
    34. 

  34. .Sh NAME
    35. 

  35. .Nm VOP_IOCTL
    36. 

  36. .Nd device specific control
    37. 

  37. .Sh SYNOPSIS
    38. 

  38. .In sys/param.h
    39. 

  39. .In sys/vnode.h
    40. 

  40. .Ft int
    41. 

  41. .Fn VOP_IOCTL "struct vnode *vp" "u_long command" "caddr_t data" "int fflag" "struct ucred *cred" "struct thread *td"
    42. 

  42. .Sh DESCRIPTION
    43. 

  43. Manipulate a file in device dependent ways.
    44. 

  44. .Pp
    45. 

  45. Its arguments are:
    46. 

  46. .Bl -tag -width command
    47. 

  47. .It Fa vp
    48. 

  48. The vnode of the file (normally representing a device).
    49. 

  49. .It Fa command
    50. 

  50. The device specific operation to perform.
    51. 

  51. .It Fa data
    52. 

  52. Extra data for the specified operation.
    53. 

  53. .It Fa fflag
    54. 

  54. Some flags ???
    55. 

  55. .It Fa cred
    56. 

  56. The caller's credentials.
    57. 

  57. .It Fa td
    58. 

  58. The calling thread.
    59. 

  59. .El
    60. 

  60. .Pp
    61. 

  61. Most file systems do not implement this entry point.
    62. 

  62. .Sh LOCKS
    63. 

  63. The file should not be locked on entry.
    64. 

  64. .Sh RETURN VALUES
    65. 

  65. If successful, zero is returned, otherwise an appropriate error code.
    66. 

  66. .Pp
    67. 

  67. If the ioctl is not recognized or not handled,
    68. 

  68. .Er ENOTTY
    69. 

  69. should be returned.
    70. 

  70. .Sh SEE ALSO
    71. 

  71. .Xr vnode 9
    72. 

  72. .Sh AUTHORS
    73. 

  73. This manual page was written by
    74. 

  74. .An Doug Rabson .
    75.