src/include/diskimage.h

#ifndef DISKIMAGE_H
#define DISKIMAGE_H

/*
 *  Copyright (C) 2003-2007  Anders Gavare.  All rights reserved.
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions are met:
 *
 *  1. Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *  2. Redistributions in binary form must reproduce the above copyright  
 *     notice, this list of conditions and the following disclaimer in the 
 *     documentation and/or other materials provided with the distribution.
 *  3. The name of the author may not be used to endorse or promote products
 *     derived from this software without specific prior written permission.
 *
 *  THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
 *  ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 *  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 *  ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE   
 *  FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 *  DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 *  OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 *  HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 *  LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 *  OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 *  SUCH DAMAGE.
 *
 *
 *  $Id: diskimage.h,v 1.36 2007/03/24 06:39:29 debug Exp $
 *
 *  Generic disk image functions.  (See diskimage.c for more info.)
 */

#include <stdio.h>
#include <sys/types.h>

#include "misc.h"

/*  Diskimage types:  */
#define DISKIMAGE_SCSI          1
#define DISKIMAGE_IDE           2
#define DISKIMAGE_FLOPPY        3

#define DISKIMAGE_TYPES         { "(NONE)", "SCSI", "IDE", "FLOPPY" }


/*  512 bytes per overlay block. Don't change this.  */
#define OVERLAY_BLOCK_SIZE      512

struct diskimage_overlay {
        char            *overlay_basename;
        FILE            *f_data;
        FILE            *f_bitmap;
};

struct diskimage {
        struct diskimage *next;
        int             type;           /*  DISKIMAGE_SCSI, etc  */
        int             id;             /*  SCSI id  */

        /*  Filename in host's file system:  */
        char            *fname;
        FILE            *f;

        /*  Overlays:  */
        int             nr_of_overlays;
        struct diskimage_overlay *overlays;

        int             chs_override;
        int             cylinders;
        int             heads;
        int             sectors_per_track;

        off_t           total_size;
        int64_t         override_base_offset;
        int             logical_block_size;

        int             writable;
        int             is_a_cdrom;
        int             is_boot_device;

        int             is_a_tape;
        uint64_t        tape_offset;
        int             tape_filenr;
        int             filemark;

        int             rpms;
        int             ncyls;
};


/*  Transfer command, sent from a SCSI controller device to a disk:  */
struct scsi_transfer {
        struct scsi_transfer    *next_free;

        /*  These should be set by the SCSI controller before the call:  */
        unsigned char           *msg_out;
        size_t                  msg_out_len;
        unsigned char           *cmd;
        size_t                  cmd_len;

        /*  data_out_len is set by the SCSI disk, if it needs data_out,
            which is then filled in during a second pass in the controller.  */
        unsigned char           *data_out;
        size_t                  data_out_len;
        size_t                  data_out_offset;

        /*  These should be set by the SCSI (disk) device before returning:  */
        unsigned char           *data_in;
        size_t                  data_in_len;
        unsigned char           *msg_in;
        size_t                  msg_in_len;
        unsigned char           *status;
        size_t                  status_len;
};


struct machine;


/*  diskimage_scsicmd.c:  */
struct scsi_transfer *scsi_transfer_alloc(void);
void scsi_transfer_free(struct scsi_transfer *);
void scsi_transfer_allocbuf(size_t *lenp, unsigned char **pp,
        size_t want_len, int clearflag);
int diskimage_scsicommand(struct cpu *cpu, int id, int type,
        struct scsi_transfer *);


/*  diskimage.c:  */
int64_t diskimage_getsize(struct machine *machine, int id, int type);
int64_t diskimage_get_baseoffset(struct machine *machine, int id, int type);
void diskimage_getchs(struct machine *machine, int id, int type,
        int *c, int *h, int *s);
int diskimage__internal_access(struct diskimage *d, int writeflag,
        off_t offset, unsigned char *buf, size_t len);
int diskimage_access(struct machine *machine, int id, int type, int writeflag,
        off_t offset, unsigned char *buf, size_t len);
void diskimage_add_overlay(struct diskimage *d, char *overlay_basename);
void diskimage_recalc_size(struct diskimage *d);
int diskimage_exist(struct machine *machine, int id, int type);
int diskimage_bootdev(struct machine *machine, int *typep);
int diskimage_add(struct machine *machine, char *fname);
int diskimage_getname(struct machine *machine, int id, int type,
        char *buf, size_t bufsize);
int diskimage_is_a_cdrom(struct machine *machine, int id, int type);
int diskimage_is_a_tape(struct machine *machine, int id, int type);
void diskimage_dump_info(struct machine *machine);


/*
 *  SCSI commands: 
 */
#define SCSICMD_TEST_UNIT_READY         0x00    /*  Mandatory  */
#define SCSICMD_REQUEST_SENSE           0x03    /*  Mandatory  */
#define SCSICMD_INQUIRY                 0x12    /*  Mandatory  */

#define SCSICMD_READ                    0x08
#define SCSICMD_READ_10                 0x28
#define SCSICMD_WRITE                   0x0a
#define SCSICMD_WRITE_10                0x2a
#define SCSICMD_MODE_SELECT             0x15
#define SCSICMD_MODE_SENSE              0x1a
#define SCSICMD_START_STOP_UNIT         0x1b
#define SCSICMD_PREVENT_ALLOW_REMOVE    0x1e
#define SCSICMD_MODE_SENSE10            0x5a

#define SCSICMD_SYNCHRONIZE_CACHE       0x35

/*  SCSI block device commands:  */
#define SCSIBLOCKCMD_READ_CAPACITY      0x25

/*  SCSI CD-ROM commands:  */
#define SCSICDROM_READ_SUBCHANNEL       0x42
#define SCSICDROM_READ_TOC              0x43
#define SCSICDROM_READ_DISCINFO         0x51
#define SCSICDROM_READ_TRACKINFO        0x52

/*  SCSI tape commands:  */
#define SCSICMD_REWIND                  0x01
#define SCSICMD_READ_BLOCK_LIMITS       0x05
#define SCSICMD_SPACE                   0x11


#endif  /*  DISKIMAGE_H  */
1	dpavlin	4	#ifndef DISKIMAGE_H
2			#define DISKIMAGE_H
3
4			/*
5	dpavlin	34	* Copyright (C) 2003-2007 Anders Gavare. All rights reserved.
6	dpavlin	4	*
7			* Redistribution and use in source and binary forms, with or without
8			* modification, are permitted provided that the following conditions are met:
9			*
10			* 1. Redistributions of source code must retain the above copyright
11			* notice, this list of conditions and the following disclaimer.
12			* 2. Redistributions in binary form must reproduce the above copyright
13			* notice, this list of conditions and the following disclaimer in the
14			* documentation and/or other materials provided with the distribution.
15			* 3. The name of the author may not be used to endorse or promote products
16			* derived from this software without specific prior written permission.
17			*
18			* THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19			* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20			* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21			* ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
22			* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23			* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24			* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25			* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26			* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27			* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28			* SUCH DAMAGE.
29			*
30			*
31	dpavlin	38	* $Id: diskimage.h,v 1.36 2007/03/24 06:39:29 debug Exp $
32	dpavlin	4	*
33			* Generic disk image functions. (See diskimage.c for more info.)
34			*/
35
36			#include <stdio.h>
37			#include <sys/types.h>
38
39			#include "misc.h"
40
41			/* Diskimage types: */
42			#define DISKIMAGE_SCSI 1
43			#define DISKIMAGE_IDE 2
44			#define DISKIMAGE_FLOPPY 3
45
46	dpavlin	6	#define DISKIMAGE_TYPES { "(NONE)", "SCSI", "IDE", "FLOPPY" }
47
48	dpavlin	38
49			/* 512 bytes per overlay block. Don't change this. */
50			#define OVERLAY_BLOCK_SIZE 512
51
52			struct diskimage_overlay {
53			char *overlay_basename;
54			FILE *f_data;
55			FILE *f_bitmap;
56			};
57
58	dpavlin	4	struct diskimage {
59			struct diskimage *next;
60			int type; /* DISKIMAGE_SCSI, etc */
61			int id; /* SCSI id */
62
63	dpavlin	38	/* Filename in host's file system: */
64	dpavlin	4	char *fname;
65			FILE *f;
66
67	dpavlin	38	/* Overlays: */
68			int nr_of_overlays;
69			struct diskimage_overlay *overlays;
70
71	dpavlin	6	int chs_override;
72			int cylinders;
73			int heads;
74			int sectors_per_track;
75
76	dpavlin	4	off_t total_size;
77	dpavlin	34	int64_t override_base_offset;
78	dpavlin	4	int logical_block_size;
79
80			int writable;
81			int is_a_cdrom;
82			int is_boot_device;
83
84			int is_a_tape;
85			uint64_t tape_offset;
86			int tape_filenr;
87			int filemark;
88
89			int rpms;
90			int ncyls;
91			};
92
93
94			/* Transfer command, sent from a SCSI controller device to a disk: */
95			struct scsi_transfer {
96			struct scsi_transfer *next_free;
97
98			/* These should be set by the SCSI controller before the call: */
99			unsigned char *msg_out;
100			size_t msg_out_len;
101			unsigned char *cmd;
102			size_t cmd_len;
103
104			/* data_out_len is set by the SCSI disk, if it needs data_out,
105			which is then filled in during a second pass in the controller. */
106			unsigned char *data_out;
107			size_t data_out_len;
108			size_t data_out_offset;
109
110			/* These should be set by the SCSI (disk) device before returning: */
111			unsigned char *data_in;
112			size_t data_in_len;
113			unsigned char *msg_in;
114			size_t msg_in_len;
115			unsigned char *status;
116			size_t status_len;
117			};
118
119
120			struct machine;
121
122	dpavlin	38
123			/* diskimage_scsicmd.c: */
124	dpavlin	4	struct scsi_transfer *scsi_transfer_alloc(void);
125			void scsi_transfer_free(struct scsi_transfer *);
126			void scsi_transfer_allocbuf(size_t lenp, unsigned char *pp,
127			size_t want_len, int clearflag);
128	dpavlin	38	int diskimage_scsicommand(struct cpu *cpu, int id, int type,
129			struct scsi_transfer *);
130	dpavlin	4
131
132	dpavlin	38	/* diskimage.c: */
133	dpavlin	6	int64_t diskimage_getsize(struct machine *machine, int id, int type);
134	dpavlin	34	int64_t diskimage_get_baseoffset(struct machine *machine, int id, int type);
135	dpavlin	6	void diskimage_getchs(struct machine *machine, int id, int type,
136			int c, int h, int *s);
137	dpavlin	38	int diskimage__internal_access(struct diskimage *d, int writeflag,
138			off_t offset, unsigned char *buf, size_t len);
139	dpavlin	6	int diskimage_access(struct machine *machine, int id, int type, int writeflag,
140	dpavlin	4	off_t offset, unsigned char *buf, size_t len);
141	dpavlin	38	void diskimage_add_overlay(struct diskimage d, char overlay_basename);
142			void diskimage_recalc_size(struct diskimage *d);
143	dpavlin	14	int diskimage_exist(struct machine *machine, int id, int type);
144	dpavlin	6	int diskimage_bootdev(struct machine machine, int typep);
145	dpavlin	4	int diskimage_add(struct machine machine, char fname);
146	dpavlin	14	int diskimage_getname(struct machine *machine, int id, int type,
147			char *buf, size_t bufsize);
148	dpavlin	6	int diskimage_is_a_cdrom(struct machine *machine, int id, int type);
149			int diskimage_is_a_tape(struct machine *machine, int id, int type);
150	dpavlin	4	void diskimage_dump_info(struct machine *machine);
151
152	dpavlin	38
153	dpavlin	4	/*
154			* SCSI commands:
155			*/
156			#define SCSICMD_TEST_UNIT_READY 0x00 /* Mandatory */
157			#define SCSICMD_REQUEST_SENSE 0x03 /* Mandatory */
158			#define SCSICMD_INQUIRY 0x12 /* Mandatory */
159
160			#define SCSICMD_READ 0x08
161			#define SCSICMD_READ_10 0x28
162			#define SCSICMD_WRITE 0x0a
163			#define SCSICMD_WRITE_10 0x2a
164			#define SCSICMD_MODE_SELECT 0x15
165			#define SCSICMD_MODE_SENSE 0x1a
166			#define SCSICMD_START_STOP_UNIT 0x1b
167	dpavlin	20	#define SCSICMD_PREVENT_ALLOW_REMOVE 0x1e
168			#define SCSICMD_MODE_SENSE10 0x5a
169	dpavlin	4
170			#define SCSICMD_SYNCHRONIZE_CACHE 0x35
171
172			/* SCSI block device commands: */
173			#define SCSIBLOCKCMD_READ_CAPACITY 0x25
174
175			/* SCSI CD-ROM commands: */
176			#define SCSICDROM_READ_SUBCHANNEL 0x42
177			#define SCSICDROM_READ_TOC 0x43
178	dpavlin	32	#define SCSICDROM_READ_DISCINFO 0x51
179			#define SCSICDROM_READ_TRACKINFO 0x52
180	dpavlin	4
181			/* SCSI tape commands: */
182			#define SCSICMD_REWIND 0x01
183			#define SCSICMD_READ_BLOCK_LIMITS 0x05
184			#define SCSICMD_SPACE 0x11
185
186
187			#endif /* DISKIMAGE_H */