xref: /illumos-gate/usr/src/cmd/cdrw/mmc.h (revision a89c0811c892ec231725fe10817ef95dda813c06)
1 /*
2  * CDDL HEADER START
3  *
4  * The contents of this file are subject to the terms of the
5  * Common Development and Distribution License (the "License").
6  * You may not use this file except in compliance with the License.
7  *
8  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9  * or http://www.opensolaris.org/os/licensing.
10  * See the License for the specific language governing permissions
11  * and limitations under the License.
12  *
13  * When distributing Covered Code, include this CDDL HEADER in each
14  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15  * If applicable, add the following below this CDDL HEADER, with the
16  * fields enclosed by brackets "[]" replaced with your own identifying
17  * information: Portions Copyright [yyyy] [name of copyright owner]
18  *
19  * CDDL HEADER END
20  */
21 /*
22  * Copyright 2007 Sun Microsystems, Inc.  All rights reserved.
23  * Use is subject to license terms.
24  */
25 
26 #ifndef	_MMC_H
27 #define	_MMC_H
28 
29 #ifdef	__cplusplus
30 extern "C" {
31 #endif
32 
33 /* bytelengths for some SCSI data structures */
34 #define	SENSE_DATA_SIZE		16
35 #define	TRACK_INFO_SIZE		36
36 #define	DISC_INFO_BLOCK_SIZE	32
37 #define	INQUIRY_DATA_LENGTH	96
38 #define	GET_PERF_DATA_LEN	24
39 #define	SET_STREAM_DATA_LEN	28
40 
41 #define	DEFAULT_SCSI_TIMEOUT    60
42 
43 #define	MMC_FTR_HDR_LEN		8	/* byte len of Feature Header */
44 /*
45  * byte length of the static part of a Feature Descriptor
46  */
47 #define	MMC_FTR_DSCRPTR_BASE_LEN	4
48 #define	MMC_PRFL_DSCRPTR_LEN	4	/* byte len of Profile Descriptor */
49 /*
50  * MMC Features; can be added to over time
51  */
52 #define	MMC_FTR_PRFL_LIST	0x0000	/* Profile List Feature */
53 #define	MMC_FTR_CORE		0x0001	/* Core Feature */
54 #define	MMC_FTR_MORPHING	0x0002	/* Morphing Feature */
55 #define	MMC_FTR_REM_MED		0x0003	/* Removable Medium Feature */
56 #define	MMC_FTR_WR_PROTECT	0x0004	/* Write Protect Feature */
57 #define	MMC_FTR_RAND_READ	0x0010	/* Random Readable Feature */
58 #define	MMC_FTR_MULTI_READ	0x001D	/* Multi-Read Feature */
59 #define	MMC_FTR_CD_READ		0x001E	/* CD Read Feature */
60 #define	MMC_FTR_DVD_READ	0x001F	/* DVD Read Feature */
61 #define	MMC_FTR_RAND_WR		0x0020	/* Random Writable Feature */
62 #define	MMC_FTR_INC_STR_WR	0x0021	/* Incremental Streaming Writable */
63 #define	MMC_FTR_SCTR_ERSBL	0x0022	/* Sector Erasable Feature */
64 #define	MMC_FTR_FORMATTABLE	0x0023	/* Formattable Feature */
65 #define	MMC_FTR_DFCT_MNGMNT	0x0024	/* Hardware Defect Management Feature */
66 #define	MMC_FTR_RT_STREAM	0x0107	/* Real Time Streaming Feature */
67 
68 /* Constants for READ TOC/PMA/ATIP command */
69 #define	FORMAT_FORMATTED_TOC	0
70 #define	FORMAT_MULTISESS_INFO	1
71 #define	FORMAT_RAW_TOC		2
72 
73 /* size in bytes of raw TOC Data Length field */
74 #define	RTOC_DATA_LEN_SZ	2
75 
76 /* Point field values for Raw TOC Track Descriptor */
77 #define	POINT_SESS_FIRST_TRK	0xA0	/* 1st track in session */
78 #define	POINT_SESS_LAST_TRK	0xA1	/* Last track in session */
79 #define	POINT_LEADOUT_ADDR	0xA2	/* Starting leadout address */
80 
81 /* Q Sub-channel constants */
82 #define	Q_MODE_1		1	/* Mode-1 Q */
83 #define	Q_MODE_2		2	/* Mode-2 Q */
84 
85 /* Convert Minute,Second,Frame address into Logical Block Address */
86 #define	MSF2LBA(m, s, f)	(((m) * 60 + (s)) * 75 + (f) - 150)
87 
88 /*
89  * MMC Response Data structures.  Use the read_scsi[16,32] and load_scsi[16,32]
90  * routines when reading/writing fields > 1 byte in size.
91  */
92 /*
93  * Structures for the Raw TOC Response Format of the READ TOC/PMA/ATIP
94  * command.
95  */
96 typedef struct rtoc_hdr {	/* Raw TOC response format Header */
97 	uchar_t rh_data_len1;
98 	uchar_t rh_data_len0;
99 	uchar_t rh_first_sess_num;
100 	uchar_t rh_last_sess_num;
101 } rtoc_hdr_t;
102 
103 typedef struct rtoc_td {	/* Raw TOC response format Track Descriptor */
104 	uchar_t rt_session_num;
105 #if defined(_BIT_FIELDS_LTOH)
106 	uchar_t	rt_control	: 4;
107 	uchar_t rt_adr		: 4;
108 #elif defined(_BIT_FIELDS_HTOL)
109 	uchar_t rt_adr		: 4;
110 	uchar_t rt_control	: 4;
111 #else
112 #error	One of _BIT_FIELDS_LTOH or _BIT_FIELDS_HTOL must be defined
113 #endif	/* _BIT_FIELDS_LTOH */
114 
115 	uchar_t rt_tno;
116 	uchar_t rt_point;
117 	uchar_t rt_min;
118 	uchar_t rt_sec;
119 	uchar_t rt_frame;
120 	uchar_t rt_zero;
121 	uchar_t	rt_pmin;
122 	uchar_t rt_psec;
123 	uchar_t rt_pframe;
124 } rtoc_td_t;
125 
126 int test_unit_ready(int fd);
127 int inquiry(int fd, uchar_t *inq);
128 int read_capacity(int fd, uchar_t *capbuf);
129 int read_track_info(int fd, int trackno, uchar_t *ti);
130 int mode_sense(int fd, uchar_t pc, int dbd, int page_len, uchar_t *buffer);
131 int mode_select(int fd, int page_len, uchar_t *buffer);
132 int read_toc(int fd, int format, int trackno, int buflen, uchar_t *buf);
133 int read_disc_info(int fd, uchar_t *di);
134 int get_configuration(int fd, uint16_t feature, int bufsize, uchar_t *buf);
135 int read10(int fd, uint32_t start_blk, uint16_t nblk, uchar_t *buf,
136     uint32_t bufsize);
137 int write10(int fd, uint32_t start_blk, uint16_t nblk, uchar_t *buf,
138     uint32_t bufsize);
139 int close_track(int fd, int trackno, int close_session, int immediate);
140 int blank_disc(int fd, int type, int immediate);
141 int read_cd(int fd, uint32_t start_blk, uint16_t nblk, uchar_t sector_type,
142     uchar_t *buf, uint32_t bufsize);
143 int load_unload(int fd, int load);
144 int prevent_allow_mr(int fd, int op);
145 int read_header(int fd, uint32_t lba, uchar_t *buf);
146 int set_cd_speed(int fd, uint16_t read_speed, uint16_t write_speed);
147 int get_performance(int fd, int get_write_performance, uchar_t *perf);
148 int set_streaming(int fd, uchar_t *buf);
149 int rezero_unit(int fd);
150 int start_stop(int fd, int start);
151 int flush_cache(int fd);
152 int set_reservation(int fd, ulong_t size);
153 int format_media(int fd);
154 uint32_t read_format_capacity(int fd, uint_t *bsize);
155 void reset_dev(int fd);
156 
157 extern int uscsi_error;		/* used for debugging failed uscsi */
158 
159 #define	REZERO_UNIT_CMD		0x01
160 #define	FORMAT_UNIT_CMD		0x04
161 #define	INQUIRY_CMD		0x12
162 #define	MODE_SELECT_6_CMD	0x15
163 #define	MODE_SENSE_6_CMD	0x1A
164 #define	START_STOP_CMD		0x1B
165 #define	PREVENT_ALLOW_CMD	0x1E
166 #define	READ_FORMAT_CAP_CMD	0x23
167 #define	READ_CAP_CMD		0x25
168 #define	READ_10_CMD		0x28
169 #define	WRITE_10_CMD		0x2A
170 #define	SYNC_CACHE_CMD		0x35
171 #define	READ_TOC_CMD		0x43
172 #define	MODE_SELECT_10_CMD	0x55
173 #define	MODE_SENSE_10_CMD	0x5A
174 #define	READ_HDR_CMD		0x44
175 #define	GET_CONFIG_CMD		0x46
176 
177 #define	READ_INFO_CMD		0x51
178 #define	READ_TRACK_CMD		0x52
179 #define	SET_RESERVATION_CMD	0x53
180 #define	CLOSE_TRACK_CMD		0x5B
181 
182 #define	BLANK_CMD		0xA1
183 #define	GET_PERFORMANCE_CMD	0xAC
184 #define	READ_DVD_STRUCTURE	0xAD
185 #define	READ_CD_CMD		0xBE
186 #define	SET_CD_SPEED		0xBB
187 
188 #define	STREAM_CMD		0xB6
189 #define	READ_AUDIO_CMD		0xD8
190 
191 #ifdef	__cplusplus
192 }
193 #endif
194 
195 #endif /* _MMC_H */
196