devctl.h 2.4 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970
  1. /*
  2. * Copyright (c) 2016,2019 Joel Sherrill <joel@rtems.org>.
  3. * All rights reserved.
  4. *
  5. * Redistribution and use in source and binary forms, with or without
  6. * modification, are permitted provided that the following conditions
  7. * are met:
  8. * 1. Redistributions of source code must retain the above copyright
  9. * notice, this list of conditions and the following disclaimer.
  10. * 2. Redistributions in binary form must reproduce the above copyright
  11. * notice, this list of conditions and the following disclaimer in the
  12. * documentation and/or other materials provided with the distribution.
  13. *
  14. * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15. * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16. * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17. * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18. * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19. * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20. * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21. * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22. * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23. * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24. * SUCH DAMAGE.
  25. */
  26. #ifndef _POSIX_DEVCTL_h_
  27. #define _POSIX_DEVCTL_h_
  28. /*
  29. * Nothing in this file should be visible unless _POSIX_26_C_SOURCE is
  30. * defined.
  31. */
  32. #ifdef _POSIX_26_C_SOURCE
  33. #include <sys/cdefs.h>
  34. #if defined(__rtems__)
  35. /*
  36. * The FACE Technical Standard, Edition 3.0 and later require the
  37. * definition of the subcommand SOCKCLOSE in <devctl.h>.
  38. *
  39. * Reference: https://www.opengroup.org/face
  40. *
  41. * Using 'D' should avoid the letters used by other users of <sys/ioccom.h>
  42. */
  43. #include <sys/ioccom.h>
  44. #define SOCKCLOSE _IO('D', 1) /* socket close */
  45. #endif
  46. /*
  47. * The posix_devctl() method is defined by POSIX 1003.26-2003. Aside
  48. * from the single method, it adds the following requirements:
  49. *
  50. * + define _POSIX_26_VERSION to 200312L
  51. * + add _SC_POSIX_26_VERSION in <unistd.h>. Return _POSIX_26_VERSION
  52. * + application must define _POSIX_26_C_SOURCE to use posix_devctl().
  53. * + posix_devctl() is prototyped in <devctl.h>
  54. */
  55. int posix_devctl(
  56. int fd,
  57. int dcmd,
  58. void *__restrict dev_data_ptr,
  59. size_t nbyte,
  60. int *__restrict dev_info_ptr
  61. );
  62. #endif
  63. #endif