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