chio.h 5.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166
  1. /* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
  2. /*
  3. * ioctl interface for the scsi media changer driver
  4. */
  5. #ifndef _UAPI_LINUX_CHIO_H
  6. #define _UAPI_LINUX_CHIO_H
  7. /* changer element types */
  8. #define CHET_MT 0 /* media transport element (robot) */
  9. #define CHET_ST 1 /* storage element (media slots) */
  10. #define CHET_IE 2 /* import/export element */
  11. #define CHET_DT 3 /* data transfer element (tape/cdrom/whatever) */
  12. #define CHET_V1 4 /* vendor specific #1 */
  13. #define CHET_V2 5 /* vendor specific #2 */
  14. #define CHET_V3 6 /* vendor specific #3 */
  15. #define CHET_V4 7 /* vendor specific #4 */
  16. /*
  17. * CHIOGPARAMS
  18. * query changer properties
  19. *
  20. * CHIOVGPARAMS
  21. * query vendor-specific element types
  22. *
  23. * accessing elements works by specifing type and unit of the element.
  24. * for example, storage elements are addressed with type = CHET_ST and
  25. * unit = 0 .. cp_nslots-1
  26. *
  27. */
  28. struct changer_params {
  29. int cp_curpicker; /* current transport element */
  30. int cp_npickers; /* number of transport elements (CHET_MT) */
  31. int cp_nslots; /* number of storage elements (CHET_ST) */
  32. int cp_nportals; /* number of import/export elements (CHET_IE) */
  33. int cp_ndrives; /* number of data transfer elements (CHET_DT) */
  34. };
  35. struct changer_vendor_params {
  36. int cvp_n1; /* number of vendor specific elems (CHET_V1) */
  37. char cvp_label1[16];
  38. int cvp_n2; /* number of vendor specific elems (CHET_V2) */
  39. char cvp_label2[16];
  40. int cvp_n3; /* number of vendor specific elems (CHET_V3) */
  41. char cvp_label3[16];
  42. int cvp_n4; /* number of vendor specific elems (CHET_V4) */
  43. char cvp_label4[16];
  44. int reserved[8];
  45. };
  46. /*
  47. * CHIOMOVE
  48. * move a medium from one element to another
  49. */
  50. struct changer_move {
  51. int cm_fromtype; /* type/unit of source element */
  52. int cm_fromunit;
  53. int cm_totype; /* type/unit of destination element */
  54. int cm_tounit;
  55. int cm_flags;
  56. };
  57. #define CM_INVERT 1 /* flag: rotate media (for double-sided like MOD) */
  58. /*
  59. * CHIOEXCHANGE
  60. * move one medium from element #1 to element #2,
  61. * and another one from element #2 to element #3.
  62. * element #1 and #3 are allowed to be identical.
  63. */
  64. struct changer_exchange {
  65. int ce_srctype; /* type/unit of element #1 */
  66. int ce_srcunit;
  67. int ce_fdsttype; /* type/unit of element #2 */
  68. int ce_fdstunit;
  69. int ce_sdsttype; /* type/unit of element #3 */
  70. int ce_sdstunit;
  71. int ce_flags;
  72. };
  73. #define CE_INVERT1 1
  74. #define CE_INVERT2 2
  75. /*
  76. * CHIOPOSITION
  77. * move the transport element (robot arm) to a specific element.
  78. */
  79. struct changer_position {
  80. int cp_type;
  81. int cp_unit;
  82. int cp_flags;
  83. };
  84. #define CP_INVERT 1
  85. /*
  86. * CHIOGSTATUS
  87. * get element status for all elements of a specific type
  88. */
  89. struct changer_element_status {
  90. int ces_type;
  91. unsigned char __user *ces_data;
  92. };
  93. #define CESTATUS_FULL 0x01 /* full */
  94. #define CESTATUS_IMPEXP 0x02 /* media was imported (inserted by sysop) */
  95. #define CESTATUS_EXCEPT 0x04 /* error condition */
  96. #define CESTATUS_ACCESS 0x08 /* access allowed */
  97. #define CESTATUS_EXENAB 0x10 /* element can export media */
  98. #define CESTATUS_INENAB 0x20 /* element can import media */
  99. /*
  100. * CHIOGELEM
  101. * get more detailed status information for a single element
  102. */
  103. struct changer_get_element {
  104. int cge_type; /* type/unit */
  105. int cge_unit;
  106. int cge_status; /* status */
  107. int cge_errno; /* errno */
  108. int cge_srctype; /* source element of the last move/exchange */
  109. int cge_srcunit;
  110. int cge_id; /* scsi id (for data transfer elements) */
  111. int cge_lun; /* scsi lun (for data transfer elements) */
  112. char cge_pvoltag[36]; /* primary volume tag */
  113. char cge_avoltag[36]; /* alternate volume tag */
  114. int cge_flags;
  115. };
  116. /* flags */
  117. #define CGE_ERRNO 0x01 /* errno available */
  118. #define CGE_INVERT 0x02 /* media inverted */
  119. #define CGE_SRC 0x04 /* media src available */
  120. #define CGE_IDLUN 0x08 /* ID+LUN available */
  121. #define CGE_PVOLTAG 0x10 /* primary volume tag available */
  122. #define CGE_AVOLTAG 0x20 /* alternate volume tag available */
  123. /*
  124. * CHIOSVOLTAG
  125. * set volume tag
  126. */
  127. struct changer_set_voltag {
  128. int csv_type; /* type/unit */
  129. int csv_unit;
  130. char csv_voltag[36]; /* volume tag */
  131. int csv_flags;
  132. };
  133. #define CSV_PVOLTAG 0x01 /* primary volume tag */
  134. #define CSV_AVOLTAG 0x02 /* alternate volume tag */
  135. #define CSV_CLEARTAG 0x04 /* clear volume tag */
  136. /* ioctls */
  137. #define CHIOMOVE _IOW('c', 1,struct changer_move)
  138. #define CHIOEXCHANGE _IOW('c', 2,struct changer_exchange)
  139. #define CHIOPOSITION _IOW('c', 3,struct changer_position)
  140. #define CHIOGPICKER _IOR('c', 4,int) /* not impl. */
  141. #define CHIOSPICKER _IOW('c', 5,int) /* not impl. */
  142. #define CHIOGPARAMS _IOR('c', 6,struct changer_params)
  143. #define CHIOGSTATUS _IOW('c', 8,struct changer_element_status)
  144. #define CHIOGELEM _IOW('c',16,struct changer_get_element)
  145. #define CHIOINITELEM _IO('c',17)
  146. #define CHIOSVOLTAG _IOW('c',18,struct changer_set_voltag)
  147. #define CHIOGVPARAMS _IOR('c',19,struct changer_vendor_params)
  148. #endif /* _UAPI_LINUX_CHIO_H */