]> FriiDump Source - friidump.git/blob - libfriidump/dvd_drive.h
PFES-REPO-README-001: Refresh canonical documentation
[friidump.git] / libfriidump / dvd_drive.h
1 /***************************************************************************
2  *   Copyright (C) 2007 by Arep                                            *
3  *   Support is provided through the forums at                             *
4  *   http://wii.console-tribe.com                                          *
5  *                                                                         *
6  *   This program is free software; you can redistribute it and/or modify  *
7  *   it under the terms of the GNU General Public License as published by  *
8  *   the Free Software Foundation; either version 2 of the License, or     *
9  *   (at your option) any later version.                                   *
10  *                                                                         *
11  *   This program is distributed in the hope that it will be useful,       *
12  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
13  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
14  *   GNU General Public License for more details.                          *
15  *                                                                         *
16  *   You should have received a copy of the GNU General Public License     *
17  *   along with this program; if not, write to the                         *
18  *   Free Software Foundation, Inc.,                                       *
19  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
20  ***************************************************************************/
21
22 #ifndef DVD_DRIVE_H_INCLUDED
23 #define DVD_DRIVE_H_INCLUDED
24
25 #include "misc.h"
26 #include <sys/types.h>
27
28
29 typedef struct dvd_drive_s dvd_drive;
30
31
32 typedef struct {
33         int sense_key;
34         int asc;
35         int ascq;
36 } req_sense;
37
38
39 typedef enum {
40         DVD_DATA_NONE = 0,
41         DVD_DATA_IN = 1,
42         DVD_DATA_OUT = 2
43 } dvd_data_direction;
44
45 typedef struct {
46         u_int8_t cmd[12];
47         int cmdlen;
48         dvd_data_direction direction;
49         req_sense *sense;
50         u_int8_t *buffer;
51         int buflen;
52 } mmc_command;
53
54
55 /* Functions */
56 dvd_drive *dvd_drive_new (char *device, u_int32_t command);
57 void *dvd_drive_destroy (dvd_drive *d);
58 int dvd_read_sector_dummy (dvd_drive *dvd, u_int32_t sector, u_int32_t sectors, req_sense *sense, u_int8_t *extbuf, size_t extbufsize);
59 int dvd_read_sector_streaming (dvd_drive *dvd, u_int32_t sector, req_sense *sense, u_int8_t *extbuf, size_t extbufsize);
60 int dvd_read_streaming (dvd_drive *dvd, u_int32_t sector, u_int32_t sectors, req_sense *sense, u_int8_t *extbuf, size_t extbufsize);
61 int dvd_flush_cache_READ12 (dvd_drive *dvd, u_int32_t sector, req_sense *sense);
62 int dvd_start_stop_unit (dvd_drive *dvd, bool start, bool load_eject, req_sense *sense);
63 int dvd_stop_unit (dvd_drive *dvd, bool start, req_sense *sense);
64 int dvd_media_cycle (dvd_drive *dvd, req_sense *sense);
65 int dvd_wait_ready (dvd_drive *dvd, unsigned int timeout_ms);
66 int dvd_test_unit_ready (dvd_drive *dvd, req_sense *sense);
67 int dvd_read_capacity_10 (dvd_drive *dvd, u_int32_t *sectors, u_int32_t *sector_size, req_sense *sense);
68 int dvd_read_10 (dvd_drive *dvd, u_int32_t sector, u_int32_t sectors, req_sense *sense, u_int8_t *extbuf, size_t extbufsize);
69 int dvd_mode_sense_10 (dvd_drive *dvd, u_int8_t page, u_int8_t *extbuf, size_t extbufsize, req_sense *sense);
70 int dvd_mode_select_10 (dvd_drive *dvd, const u_int8_t *buf, size_t bufsize, req_sense *sense);
71 int dvd_mode_select_6 (dvd_drive *dvd, const u_int8_t *buf, size_t bufsize, req_sense *sense);
72 int dvd_read_dvd_structure (dvd_drive *dvd, u_int8_t format, u_int8_t layer, u_int8_t *extbuf, size_t extbufsize, req_sense *sense);
73 int dvd_xbox_gdr8050l_unlock (dvd_drive *dvd, u_int32_t *unlocked_sectors);
74 int dvd_xbox_vendor_lock (dvd_drive *dvd);
75 int dvd_xbox_vendor_unlock_wxripper (dvd_drive *dvd, u_int32_t *unlocked_sectors);
76 int dvd_xbox_vendor_set_error_skip (dvd_drive *dvd, bool enabled);
77 int dvd_xbox_recovery_kick (dvd_drive *dvd, bool auth_recovery);
78 int dvd_refresh_volume (dvd_drive *dvd);
79 int dvd_lock_volume (dvd_drive *dvd);
80 int dvd_xbox_refresh_volume (dvd_drive *dvd);
81 int dvd_xbox_lock_volume (dvd_drive *dvd);
82 bool dvd_is_xbox_drive (dvd_drive *dvd);
83 bool dvd_is_xbox_unlock_drive (dvd_drive *dvd);
84 bool dvd_is_xbox_challenge_drive (dvd_drive *dvd);
85 bool dvd_is_xbox_vendor_unlock_drive (dvd_drive *dvd);
86 int dvd_set_speed (dvd_drive *dvd, u_int32_t speed, req_sense *sense);
87 int dvd_get_size (dvd_drive *dvd, u_int32_t *size, req_sense *sense);
88 int dvd_get_layerbreak (dvd_drive *dvd, u_int32_t *layerbreak, req_sense *sense);
89 int dvd_set_streaming (dvd_drive *dvd, u_int32_t speed, req_sense *sense);
90 int dvd_memdump (dvd_drive *dvd, u_int32_t block_off, u_int32_t block_len, u_int32_t block_size, u_int8_t *buf);
91 char *dvd_get_vendor (dvd_drive *dvd);
92 char *dvd_get_product_id (dvd_drive *dvd);
93 char *dvd_get_product_revision (dvd_drive *dvd);
94 char *dvd_get_model_string (dvd_drive *dvd);
95 char *dvd_get_device (dvd_drive *dvd);
96 void *dvd_get_native_handle (dvd_drive *dvd);
97 bool dvd_get_support_status (dvd_drive *dvd);
98 u_int32_t dvd_get_def_method (dvd_drive *dvd);
99 u_int32_t dvd_get_command (dvd_drive *dvd);
100 const char *dvd_get_hlds_e7_profile_name (dvd_drive *dvd);
101 const char *dvd_get_hlds_e7_support_tier (dvd_drive *dvd);
102 const char *dvd_get_hlds_e7_family (dvd_drive *dvd);
103 const char *dvd_get_hlds_e7_tokens (dvd_drive *dvd);
104 const char *dvd_get_hlds_e7_record_id (dvd_drive *dvd);
105 const char *dvd_get_hlds_e7_notes (dvd_drive *dvd);
106 u_int32_t dvd_get_hlds_e7_type (dvd_drive *dvd);
107 u_int32_t dvd_get_hlds_e7_cache_base (dvd_drive *dvd);
108 u_int32_t dvd_get_hlds_e7_mem_blocks (dvd_drive *dvd);
109 u_int32_t dvd_get_hlds_e7_static_cdb_base (dvd_drive *dvd);
110 u_int32_t dvd_get_hlds_e7_static_gate (dvd_drive *dvd);
111 int dvd_get_hlds_e7_preferred_method (dvd_drive *dvd);
112 void dvd_set_hlds_e7_runtime_profile (dvd_drive *dvd, u_int32_t type, u_int32_t cache_base, u_int32_t mem_blocks);
113
114 /* The following are exported for use by drive-specific functions */
115 typedef int (*dvd_drive_memdump_func) (dvd_drive *dvd, u_int32_t block_off, u_int32_t block_len, u_int32_t block_size, u_int8_t *buf);
116 void dvd_init_command (mmc_command *mmc, u_int8_t *buf, int len, req_sense *sense);
117 int dvd_execute_cmd (dvd_drive *dvd, mmc_command *mmc, bool ignore_errors);
118
119 #endif