2 * Copyright (c) 2000, 2002 Kenneth D. Merry
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions, and the following disclaimer,
10 * without modification, immediately at the beginning of the file.
11 * 2. The name of the author may not be used to endorse or promote products
12 * derived from this software without specific prior written permission.
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 FOR
18 * 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
28 * Written by Julian Elischer (julian@tfs.com)
29 * for TRW Financial Systems.
31 * TRW Financial Systems, in accordance with their agreement with Carnegie
32 * Mellon University, makes this software available to CMU to distribute
33 * or use in any manner that they see fit as long as this message is kept with
34 * the software. For this reason TFS also grants any other persons or
35 * organisations permission to use or modify this software.
37 * TFS supplies this software to be publicly redistributed
38 * on the understanding that TFS is not responsible for the correct
39 * functioning of this software in any circumstances.
41 * Ported to run under 386BSD by Julian Elischer (julian@tfs.com) Sept 1992
43 * from: scsi_cd.h,v 1.10 1997/02/22 09:44:28 peter Exp $
46 #ifndef _SCSI_SCSI_CD_H
47 #define _SCSI_SCSI_CD_H 1
50 * Define two bits always in the same place in byte 2 (flag byte)
52 #define CD_RELADDR 0x01
84 struct scsi_play_track
101 u_int8_t blk_addr[4];
103 u_int8_t xfer_len[2];
110 u_int8_t byte2; /* same as above */
111 u_int8_t blk_addr[4];
112 u_int8_t xfer_len[4];
117 struct scsi_play_rel_12
120 u_int8_t byte2; /* same as above */
121 u_int8_t blk_addr[4];
122 u_int8_t xfer_len[4];
127 struct scsi_read_header
131 u_int8_t blk_addr[4];
133 u_int8_t data_len[2];
137 struct scsi_read_subchannel
142 #define SRS_SUBQ 0x40
143 u_int8_t subchan_format;
146 u_int8_t data_len[2];
156 u_int8_t data_len[2];
160 struct scsi_read_cd_capacity
164 u_int8_t addr_3; /* Most Significant */
167 u_int8_t addr_0; /* Least Significant */
172 struct scsi_set_speed
176 u_int8_t readspeed[2];
177 u_int8_t writespeed[2];
178 u_int8_t reserved[5];
182 struct scsi_report_key
187 u_int8_t reserved1[2];
188 u_int8_t alloc_len[2];
189 u_int8_t agid_keyformat;
190 #define RK_KF_AGID_MASK 0xc0
191 #define RK_KF_AGID_SHIFT 6
192 #define RK_KF_KEYFORMAT_MASK 0x3f
193 #define RK_KF_AGID 0x00
194 #define RK_KF_CHALLENGE 0x01
195 #define RF_KF_KEY1 0x02
196 #define RK_KF_KEY2 0x03
197 #define RF_KF_TITLE 0x04
198 #define RF_KF_ASF 0x05
199 #define RK_KF_RPC_SET 0x06
200 #define RF_KF_RPC_REPORT 0x08
201 #define RF_KF_INV_AGID 0x3f
206 * See the report key structure for key format and AGID definitions.
211 u_int8_t reserved[7];
212 u_int8_t param_len[2];
213 u_int8_t agid_keyformat;
217 struct scsi_read_dvd_structure
222 u_int8_t layer_number;
224 #define RDS_FORMAT_PHYSICAL 0x00
225 #define RDS_FORMAT_COPYRIGHT 0x01
226 #define RDS_FORMAT_DISC_KEY 0x02
227 #define RDS_FORMAT_BCA 0x03
228 #define RDS_FORMAT_MANUFACTURER 0x04
229 #define RDS_FORMAT_CMGS_CPM 0x05
230 #define RDS_FORMAT_PROT_DISCID 0x06
231 #define RDS_FORMAT_DISC_KEY_BLOCK 0x07
232 #define RDS_FORMAT_DDS 0x08
233 #define RDS_FORMAT_DVDRAM_MEDIA_STAT 0x09
234 #define RDS_FORMAT_SPARE_AREA 0x0a
235 #define RDS_FORMAT_RMD_BORDEROUT 0x0c
236 #define RDS_FORMAT_RMD 0x0d
237 #define RDS_FORMAT_LEADIN 0x0e
238 #define RDS_FORMAT_DISC_ID 0x0f
239 #define RDS_FORMAT_DCB 0x30
240 #define RDS_FORMAT_WRITE_PROT 0xc0
241 #define RDS_FORMAT_STRUCTURE_LIST 0xff
242 u_int8_t alloc_len[2];
250 #define READ_CD_CAPACITY 0x25 /* slightly different from disk */
251 #define READ_SUBCHANNEL 0x42 /* cdrom read Subchannel */
252 #define READ_TOC 0x43 /* cdrom read TOC */
253 #define READ_HEADER 0x44 /* cdrom read header */
254 #define PLAY_10 0x45 /* cdrom play 'play audio' mode */
255 #define PLAY_MSF 0x47 /* cdrom play Min,Sec,Frames mode */
256 #define PLAY_TRACK 0x48 /* cdrom play track/index mode */
257 #define PLAY_TRACK_REL 0x49 /* cdrom play track/index mode */
258 #define PAUSE 0x4b /* cdrom pause in 'play audio' mode */
259 #define SEND_KEY 0xa3 /* dvd send key command */
260 #define REPORT_KEY 0xa4 /* dvd report key command */
261 #define PLAY_12 0xa5 /* cdrom pause in 'play audio' mode */
262 #define PLAY_TRACK_REL_BIG 0xa9 /* cdrom play track/index mode */
263 #define READ_DVD_STRUCTURE 0xad /* read dvd structure */
264 #define SET_CD_SPEED 0xbb /* set c/dvd speed */
266 struct scsi_report_key_data_header
268 u_int8_t data_len[2];
269 u_int8_t reserved[2];
272 struct scsi_report_key_data_agid
274 u_int8_t data_len[2];
275 u_int8_t reserved[5];
277 #define RKD_AGID_MASK 0xc0
278 #define RKD_AGID_SHIFT 6
281 struct scsi_report_key_data_challenge
283 u_int8_t data_len[2];
284 u_int8_t reserved0[2];
285 u_int8_t challenge_key[10];
286 u_int8_t reserved1[2];
289 struct scsi_report_key_data_key1_key2
291 u_int8_t data_len[2];
292 u_int8_t reserved0[2];
294 u_int8_t reserved1[3];
297 struct scsi_report_key_data_title
299 u_int8_t data_len[2];
300 u_int8_t reserved0[2];
302 #define RKD_TITLE_CPM 0x80
303 #define RKD_TITLE_CPM_SHIFT 7
304 #define RKD_TITLE_CP_SEC 0x40
305 #define RKD_TITLE_CP_SEC_SHIFT 6
306 #define RKD_TITLE_CMGS_MASK 0x30
307 #define RKD_TITLE_CMGS_SHIFT 4
308 #define RKD_TITLE_CMGS_NO_RST 0x00
309 #define RKD_TITLE_CMGS_RSVD 0x10
310 #define RKD_TITLE_CMGS_1_GEN 0x20
311 #define RKD_TITLE_CMGS_NO_COPY 0x30
312 u_int8_t title_key[5];
313 u_int8_t reserved1[2];
316 struct scsi_report_key_data_asf
318 u_int8_t data_len[2];
319 u_int8_t reserved[5];
321 #define RKD_ASF_SUCCESS 0x01
324 struct scsi_report_key_data_rpc
326 u_int8_t data_len[2];
327 u_int8_t rpc_scheme0;
328 #define RKD_RPC_SCHEME_UNKNOWN 0x00
329 #define RKD_RPC_SCHEME_PHASE_II 0x01
332 #define RKD_RPC_TYPE_MASK 0xC0
333 #define RKD_RPC_TYPE_SHIFT 6
334 #define RKD_RPC_TYPE_NONE 0x00
335 #define RKD_RPC_TYPE_SET 0x40
336 #define RKD_RPC_TYPE_LAST_CHANCE 0x80
337 #define RKD_RPC_TYPE_PERM 0xC0
338 #define RKD_RPC_VENDOR_RESET_MASK 0x38
339 #define RKD_RPC_VENDOR_RESET_SHIFT 3
340 #define RKD_RPC_USER_RESET_MASK 0x07
341 #define RKD_RPC_USER_RESET_SHIFT 0
342 u_int8_t region_mask;
343 u_int8_t rpc_scheme1;
347 struct scsi_send_key_data_rpc
349 u_int8_t data_len[2];
350 u_int8_t reserved0[2];
351 u_int8_t region_code;
352 u_int8_t reserved1[3];
356 * Common header for the return data from the READ DVD STRUCTURE command.
358 struct scsi_read_dvd_struct_data_header
360 u_int8_t data_len[2];
361 u_int8_t reserved[2];
364 struct scsi_read_dvd_struct_data_layer_desc
366 u_int8_t book_type_version;
367 #define RDSD_BOOK_TYPE_DVD_ROM 0x00
368 #define RDSD_BOOK_TYPE_DVD_RAM 0x10
369 #define RDSD_BOOK_TYPE_DVD_R 0x20
370 #define RDSD_BOOK_TYPE_DVD_RW 0x30
371 #define RDSD_BOOK_TYPE_DVD_PRW 0x90
372 #define RDSD_BOOK_TYPE_MASK 0xf0
373 #define RDSD_BOOK_TYPE_SHIFT 4
374 #define RDSD_BOOK_VERSION_MASK 0x0f
376 * The lower 4 bits of this field is referred to as the "minimum
377 * rate" field in MMC2, and the "maximum rate" field in MMC3. Ugh.
379 u_int8_t disc_size_max_rate;
380 #define RDSD_DISC_SIZE_120MM 0x00
381 #define RDSD_DISC_SIZE_80MM 0x10
382 #define RDSD_DISC_SIZE_MASK 0xf0
383 #define RDSD_DISC_SIZE_SHIFT 4
384 #define RDSD_MAX_RATE_0252 0x00
385 #define RDSD_MAX_RATE_0504 0x01
386 #define RDSD_MAX_RATE_1008 0x02
387 #define RDSD_MAX_RATE_NOT_SPEC 0x0f
388 #define RDSD_MAX_RATE_MASK 0x0f
390 #define RDSD_NUM_LAYERS_MASK 0x60
391 #define RDSD_NUM_LAYERS_SHIFT 5
392 #define RDSD_NL_ONE_LAYER 0x00
393 #define RDSD_NL_TWO_LAYERS 0x20
394 #define RDSD_TRACK_PATH_MASK 0x10
395 #define RDSD_TRACK_PATH_SHIFT 4
396 #define RDSD_TP_PTP 0x00
397 #define RDSD_TP_OTP 0x10
398 #define RDSD_LAYER_TYPE_RO 0x01
399 #define RDSD_LAYER_TYPE_RECORD 0x02
400 #define RDSD_LAYER_TYPE_RW 0x04
401 #define RDSD_LAYER_TYPE_MASK 0x0f
403 #define RDSD_LIN_DENSITY_0267 0x00
404 #define RDSD_LIN_DENSITY_0293 0x10
405 #define RDSD_LIN_DENSITY_0409_0435 0x20
406 #define RDSD_LIN_DENSITY_0280_0291 0x40
407 /* XXX MMC2 uses 0.176um/bit instead of 0.353 as in MMC3 */
408 #define RDSD_LIN_DENSITY_0353 0x80
409 #define RDSD_LIN_DENSITY_MASK 0xf0
410 #define RDSD_LIN_DENSITY_SHIFT 4
411 #define RDSD_TRACK_DENSITY_074 0x00
412 #define RDSD_TRACK_DENSITY_080 0x01
413 #define RDSD_TRACK_DENSITY_0615 0x02
414 #define RDSD_TRACK_DENSITY_MASK 0x0f
416 u_int8_t main_data_start[3];
417 #define RDSD_MAIN_DATA_START_DVD_RO 0x30000
418 #define RDSD_MAIN_DATA_START_DVD_RW 0x31000
420 u_int8_t main_data_end[3];
422 u_int8_t end_sector_layer0[3];
424 #define RDSD_BCA 0x80
425 #define RDSD_BCA_MASK 0x80
426 #define RDSD_BCA_SHIFT 7
427 u_int8_t media_specific[2031];
430 struct scsi_read_dvd_struct_data_physical
432 u_int8_t data_len[2];
433 u_int8_t reserved[2];
434 struct scsi_read_dvd_struct_data_layer_desc layer_desc;
437 struct scsi_read_dvd_struct_data_copyright
439 u_int8_t data_len[2];
440 u_int8_t reserved0[2];
442 #define RDSD_CPS_NOT_PRESENT 0x00
443 #define RDSD_CPS_DATA_EXISTS 0x01
444 u_int8_t region_info;
445 u_int8_t reserved1[2];
448 struct scsi_read_dvd_struct_data_disc_key
450 u_int8_t data_len[2];
451 u_int8_t reserved[2];
452 u_int8_t disc_key[2048];
455 struct scsi_read_dvd_struct_data_bca
457 u_int8_t data_len[2];
458 u_int8_t reserved[2];
459 u_int8_t bca_info[188]; /* XXX 12-188 bytes */
462 struct scsi_read_dvd_struct_data_manufacturer
464 u_int8_t data_len[2];
465 u_int8_t reserved[2];
466 u_int8_t manuf_info[2048];
469 struct scsi_read_dvd_struct_data_copy_manage
471 u_int8_t data_len[2];
472 u_int8_t reserved0[2];
474 #define RDSD_CPM_NO_COPYRIGHT 0x00
475 #define RDSD_CPM_HAS_COPYRIGHT 0x80
476 #define RDSD_CPM_MASK 0x80
477 #define RDSD_CMGS_COPY_ALLOWED 0x00
478 #define RDSD_CMGS_ONE_COPY 0x20
479 #define RDSD_CMGS_NO_COPIES 0x30
480 #define RDSD_CMGS_MASK 0x30
481 u_int8_t reserved1[3];
484 struct scsi_read_dvd_struct_data_prot_discid
486 u_int8_t data_len[2];
487 u_int8_t reserved[2];
488 u_int8_t prot_discid_data[16];
491 struct scsi_read_dvd_struct_data_disc_key_blk
494 * Length is 0x6ffe == 28670 for CPRM, 0x3002 == 12990 for CSS2.
496 u_int8_t data_len[2];
498 u_int8_t total_packs;
499 u_int8_t disc_key_pack_data[28668];
501 struct scsi_read_dvd_struct_data_dds
503 u_int8_t data_len[2];
504 u_int8_t reserved[2];
505 u_int8_t dds_info[2048];
508 struct scsi_read_dvd_struct_data_medium_status
510 u_int8_t data_len[2];
511 u_int8_t reserved0[2];
513 #define RDSD_MS_CARTRIDGE 0x80
514 #define RDSD_MS_OUT 0x40
515 #define RDSD_MS_MSWI 0x08
516 #define RDSD_MS_CWP 0x04
517 #define RDSD_MS_PWP 0x02
518 u_int8_t disc_type_id;
519 #define RDSD_DT_NEED_CARTRIDGE 0x00
520 #define RDSD_DT_NO_CART_NEEDED 0x01
522 u_int8_t ram_swi_info;
523 #define RDSD_SWI_NO_BARE 0x01
524 #define RDSD_SWI_UNSPEC 0xff
527 struct scsi_read_dvd_struct_data_spare_area
529 u_int8_t data_len[2];
530 u_int8_t reserved[2];
531 u_int8_t unused_primary[4];
532 u_int8_t unused_supl[4];
533 u_int8_t allocated_supl[4];
536 struct scsi_read_dvd_struct_data_rmd_borderout
538 u_int8_t data_len[2];
539 u_int8_t reserved[2];
540 u_int8_t rmd[30720]; /* maximum is 30720 bytes */
543 struct scsi_read_dvd_struct_data_rmd
545 u_int8_t data_len[2];
546 u_int8_t reserved[2];
547 u_int8_t last_sector_num[4];
548 u_int8_t rmd_bytes[32768]; /* This is the maximum */
552 * XXX KDM this is the MMC2 version of the structure.
553 * The variable positions have changed (in a semi-conflicting way) in the
554 * MMC3 spec, although the overall length of the structure is the same.
556 struct scsi_read_dvd_struct_data_leadin
558 u_int8_t data_len[2];
559 u_int8_t reserved0[2];
562 u_int8_t disc_physical_data;
563 u_int8_t last_addr[3];
564 u_int8_t reserved1[2];
567 u_int8_t rwp_wavelength;
568 u_int8_t optimum_write_strategy;
569 u_int8_t reserved2[4];
571 u_int8_t manuf_id_17_12[6];
574 u_int8_t manuf_id_11_6[6];
577 u_int8_t manuf_id_5_0[6];
578 u_int8_t reserved5[25];
581 struct scsi_read_dvd_struct_data_disc_id
583 u_int8_t data_len[2];
584 u_int8_t reserved[4];
585 u_int8_t random_num[2];
594 struct scsi_read_dvd_struct_data_generic_dcb
596 u_int8_t content_desc[4];
598 u_int8_t unknown_desc_actions[4];
599 #define RDSD_ACTION_RECORDING 0x0001
600 #define RDSD_ACTION_READING 0x0002
601 #define RDSD_ACTION_FORMAT 0x0004
602 #define RDSD_ACTION_MODIFY_DCB 0x0008
603 u_int8_t vendor_id[32];
604 u_int8_t dcb_data[32728];
607 struct scsi_read_dvd_struct_data_dcb
609 u_int8_t data_len[2];
610 u_int8_t reserved[2];
611 struct scsi_read_dvd_struct_data_generic_dcb dcb;
614 struct read_dvd_struct_write_prot
616 u_int8_t data_len[2];
617 u_int8_t reserved0[2];
618 u_int8_t write_prot_status;
619 #define RDSD_WPS_MSWI 0x08
620 #define RDSD_WPS_CWP 0x04
621 #define RDSD_WPS_PWP 0x02
622 #define RDSD_WPS_SWPP 0x01
623 u_int8_t reserved[3];
626 struct read_dvd_struct_list_entry
628 u_int8_t format_code;
630 #define RDSD_SDS_NOT_WRITEABLE 0x00
631 #define RDSD_SDS_WRITEABLE 0x80
632 #define RDSD_SDS_MASK 0x80
633 #define RDSD_RDS_NOT_READABLE 0x00
634 #define RDSD_RDS_READABLE 0x40
635 #define RDSD_RDS_MASK 0x40
636 u_int8_t struct_len[2];
639 struct read_dvd_struct_data_list
641 u_int8_t data_len[2];
642 u_int8_t reserved[2];
643 struct read_dvd_struct_list_entry entries[0];
646 struct scsi_read_cd_cap_data
648 u_int8_t addr_3; /* Most significant */
651 u_int8_t addr_0; /* Least significant */
652 u_int8_t length_3; /* Most significant */
655 u_int8_t length_0; /* Least significant */
661 #define CD_PAGE_CODE 0x3F
662 #define AUDIO_PAGE 0x0e
663 #define CD_PAGE_PS 0x80
666 #define CD_PA_SOTC 0x02
667 #define CD_PA_IMMED 0x04
670 #define CD_PA_FORMAT_LBA 0x0F
671 #define CD_PA_APR_VALID 0x80
672 u_int8_t lb_per_sec[2];
681 #define LEFT_CHANNEL CHANNEL_0
682 #define RIGHT_CHANNEL CHANNEL_1
691 struct cd_audio_page audio;
694 struct cd_mode_data_10
696 struct scsi_mode_header_10 header;
697 struct scsi_mode_blk_desc blk_desc;
703 struct scsi_mode_header_6 header;
704 struct scsi_mode_blk_desc blk_desc;
708 union cd_mode_data_6_10
710 struct cd_mode_data mode_data_6;
711 struct cd_mode_data_10 mode_data_10;
714 struct cd_mode_params
716 STAILQ_ENTRY(cd_mode_params) links;
723 void scsi_report_key(struct ccb_scsiio *csio, u_int32_t retries,
724 void (*cbfcnp)(struct cam_periph *, union ccb *),
725 u_int8_t tag_action, u_int32_t lba, u_int8_t agid,
726 u_int8_t key_format, u_int8_t *data_ptr,
727 u_int32_t dxfer_len, u_int8_t sense_len,
730 void scsi_send_key(struct ccb_scsiio *csio, u_int32_t retries,
731 void (*cbfcnp)(struct cam_periph *, union ccb *),
732 u_int8_t tag_action, u_int8_t agid, u_int8_t key_format,
733 u_int8_t *data_ptr, u_int32_t dxfer_len, u_int8_t sense_len,
736 void scsi_read_dvd_structure(struct ccb_scsiio *csio, u_int32_t retries,
737 void (*cbfcnp)(struct cam_periph *, union ccb *),
738 u_int8_t tag_action, u_int32_t address,
739 u_int8_t layer_number, u_int8_t format,
740 u_int8_t agid, u_int8_t *data_ptr,
741 u_int32_t dxfer_len, u_int8_t sense_len,
746 #endif /*_SCSI_SCSI_CD_H*/