6b31fabd0b677ee3c12be12201120d8f6baa4a86
[people/sha0/winvblock.git] / src / include / disk.h
1 /**
2  * Copyright (C) 2009-2011, Shao Miller <shao.miller@yrdsb.edu.on.ca>.
3  * Copyright 2006-2008, V.
4  * For WinAoE contact information, see http://winaoe.org/
5  *
6  * This file is part of WinVBlock, derived from WinAoE.
7  *
8  * WinVBlock is free software: you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation, either version 3 of the License, or
11  * (at your option) any later version.
12  *
13  * WinVBlock is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with WinVBlock.  If not, see <http://www.gnu.org/licenses/>.
20  */
21 #ifndef WV_M_DISK_H_
22 #  define WV_M_DISK_H_
23
24 /**
25  * @file
26  *
27  * Disk device specifics.
28  */
29
30 typedef enum WVL_DISK_MEDIA_TYPE {
31     WvlDiskMediaTypeFloppy,
32     WvlDiskMediaTypeHard,
33     WvlDiskMediaTypeOptical,
34     WvlDiskMediaTypes
35   } WVL_E_DISK_MEDIA_TYPE, * WVL_EP_DISK_MEDIA_TYPE;
36
37 typedef char WVL_A_DISK_BOOT_SECT[512];
38 typedef WVL_A_DISK_BOOT_SECT * WVL_AP_DISK_BOOT_SECT;
39
40 extern BOOLEAN WvDiskIsRemovable[WvlDiskMediaTypes];
41 extern PWCHAR WvDiskCompatIds[WvlDiskMediaTypes];
42
43 typedef enum WVL_DISK_IO_MODE {
44     WvlDiskIoModeRead,
45     WvlDiskIoModeWrite,
46     WvlDiskIoModes
47   } WVL_E_DISK_IO_MODE, * WVL_EP_DISK_IO_MODE;
48
49 /* Forward declaration. */
50 typedef struct WV_DISK_T WV_S_DISK_T, * WV_SP_DISK_T;
51
52 /**
53  * I/O Request.
54  *
55  * @v dev_ptr           Points to the disk's device structure.
56  * @v mode              Read / write mode.
57  * @v start_sector      First sector for request.
58  * @v sector_count      Number of sectors to work with.
59  * @v buffer            Buffer to read / write sectors to / from.
60  * @v irp               Interrupt request packet for this request.
61  */
62 typedef NTSTATUS STDCALL WV_F_DISK_IO(
63     IN WV_SP_DEV_T,
64     IN WVL_E_DISK_IO_MODE,
65     IN LONGLONG,
66     IN UINT32,
67     IN PUCHAR,
68     IN PIRP
69   );
70 typedef WV_F_DISK_IO * WV_FP_DISK_IO;
71
72 /**
73  * Maximum transfer length response routine.
74  *
75  * @v disk_ptr        The disk being queried.
76  * @ret UINT32        The maximum transfer length.
77  */
78 typedef UINT32 WV_F_DISK_MAX_XFER_LEN(IN WV_SP_DISK_T);
79 typedef WV_F_DISK_MAX_XFER_LEN * WV_FP_DISK_MAX_XFER_LEN;
80
81 /**
82  * Disk initialization routine.
83  *
84  * @v disk_ptr        The disk device being initialized.
85  * @ret BOOLEAN       FALSE if initialization failed, otherwise TRUE
86  */
87 typedef BOOLEAN STDCALL WV_F_DISK_INIT(IN WV_SP_DISK_T);
88 typedef WV_F_DISK_INIT * WV_FP_DISK_INIT;
89
90 /**
91  * Disk close routine.
92  *
93  * @v disk_ptr        The disk device being closed.
94  */
95 typedef VOID STDCALL WV_F_DISK_CLOSE(IN WV_SP_DISK_T);
96 typedef WV_F_DISK_CLOSE * WV_FP_DISK_CLOSE;
97
98 /**
99  * Fetch disk unit number routine.
100  *
101  * @v disk              The disk whose unit number is fetched.
102  * @ret UCHAR           The disk's unit number.
103  */
104 typedef UCHAR STDCALL WVL_F_DISK_UNIT_NUM(IN WV_SP_DISK_T);
105 typedef WVL_F_DISK_UNIT_NUM * WVL_FP_DISK_UNIT_NUM;
106 extern WVL_M_LIB WVL_F_DISK_UNIT_NUM WvlDiskUnitNum;
107
108 typedef struct WV_DISK_OPS {
109     WV_FP_DISK_IO Io;
110     WV_FP_DISK_MAX_XFER_LEN MaxXferLen;
111     WV_FP_DISK_INIT Init;
112     WV_FP_DISK_CLOSE Close;
113     WVL_FP_DISK_UNIT_NUM UnitNum;
114   } WV_S_DISK_OPS, * WV_SP_DISK_OPS;
115
116 struct WV_DISK_T {
117     WV_S_DEV_T Dev[1];
118     KEVENT SearchEvent;
119     KSPIN_LOCK SpinLock;
120     WVL_E_DISK_MEDIA_TYPE Media;
121     WV_S_DISK_OPS disk_ops;
122     ULONGLONG LBADiskSize;
123     ULONGLONG Cylinders;
124     UINT32 Heads;
125     UINT32 Sectors;
126     UINT32 SectorSize;
127     UINT32 SpecialFileCount;
128     LIST_ENTRY tracking;
129     PVOID ext;
130     PDRIVER_OBJECT DriverObj;
131   };
132
133 /* Yield a pointer to the disk. */
134 #define disk__get_ptr(dev_ptr) ((WV_SP_DISK_T) dev_ptr->ext)
135
136 /* An MBR C/H/S address and ways to access its components. */
137 typedef UCHAR chs[3];
138
139 #define     chs_head(chs) chs[0]
140 #define   chs_sector(chs) (chs[1] & 0x3F)
141 #define chs_cyl_high(chs) (((UINT16) (chs[1] & 0xC0)) << 2)
142 #define  chs_cyl_low(chs) ((UINT16) chs[2])
143 #define chs_cylinder(chs) (chs_cyl_high(chs) | chs_cyl_low(chs))
144
145 /* An MBR. */
146 #ifdef _MSC_VER
147 #  pragma pack(1)
148 #endif
149 struct WVL_DISK_MBR {
150     UCHAR code[440];
151     UINT32 disk_sig;
152     UINT16 pad;
153     struct {
154         UCHAR status;
155         chs chs_start;
156         UCHAR type;
157         chs chs_end;
158         UINT32 lba_start;
159         UINT32 lba_count;
160       } partition[4] __attribute__((packed));
161     UINT16 mbr_sig;
162   } __attribute__((__packed__));
163 typedef struct WVL_DISK_MBR WVL_S_DISK_MBR, * WVL_SP_DISK_MBR;
164 #ifdef _MSC_VER
165 #  pragma pack()
166 #endif
167
168 extern WV_F_DISK_IO disk__io;
169 extern WV_F_DISK_MAX_XFER_LEN disk__max_xfer_len;
170
171 /**
172  * Attempt to guess a disk's geometry.
173  *
174  * @v boot_sect_ptr     The MBR or VBR with possible geometry clues.
175  * @v disk_ptr          The disk to set the geometry for.
176  */
177 extern WVL_M_LIB VOID disk__guess_geometry(
178     IN WVL_AP_DISK_BOOT_SECT,
179     IN OUT WV_SP_DISK_T disk_ptr
180   );
181
182 extern WVL_M_LIB NTSTATUS STDCALL WvlDiskCreatePdo(
183     IN PDRIVER_OBJECT,
184     IN SIZE_T,
185     IN WVL_E_DISK_MEDIA_TYPE,
186     OUT PDEVICE_OBJECT *
187   );
188 extern WVL_M_LIB VOID STDCALL WvDiskInit(IN WV_SP_DISK_T);
189
190 /* IRP-related. */
191 extern WVL_M_LIB WV_F_DEV_DISPATCH WvDiskIrpPower;
192 extern WVL_M_LIB WV_F_DEV_DISPATCH WvDiskIrpSysCtl;
193 /* IRP_MJ_DEVICE_CONTROL dispatcher from disk/dev_ctl.c */
194 extern WVL_M_LIB NTSTATUS STDCALL WvlDiskDevCtl(
195     IN WV_SP_DISK_T,
196     IN PIRP,
197     IN ULONG POINTER_ALIGNMENT
198   );
199 /* IRP_MJ_SCSI dispatcher from disk/scsi.c */
200 extern WVL_M_LIB WV_F_DEV_SCSI disk_scsi__dispatch;
201 /* IRP_MJ_PNP dispatcher from disk/pnp.c */
202 extern WVL_M_LIB WV_F_DEV_PNP disk_pnp__dispatch;
203
204
205 #endif  /* WV_M_DISK_H_ */