379 lines
12 KiB
C
379 lines
12 KiB
C
/*
|
|
* 86Box A hypervisor and IBM PC system emulator that specializes in
|
|
* running old operating systems and software designed for IBM
|
|
* PC systems and compatibles from 1981 through fairly recent
|
|
* system designs based on the PCI bus.
|
|
*
|
|
* This file is part of the 86Box distribution.
|
|
*
|
|
* SCSI controller handler header.
|
|
*
|
|
* Version: @(#)scsi_h 1.0.16 2018/03/28
|
|
*
|
|
* Authors: TheCollector1995, <mariogplayer@gmail.com>
|
|
* Miran Grca, <mgrca8@gmail.com>
|
|
* Fred N. van Kempen, <decwiz@yahoo.com>
|
|
*
|
|
* Copyright 2016-2018 TheCollector1995.
|
|
* Copyright 2016-2018 Miran Grca.
|
|
* Copyright 2017,2018 Fred N. van Kempen.
|
|
*/
|
|
#ifndef EMU_SCSI_H
|
|
#define EMU_SCSI_H
|
|
|
|
|
|
#ifdef WALTJE
|
|
#define SCSI_TIME (50 * (1 << TIMER_SHIFT))
|
|
#else
|
|
#define SCSI_TIME (5 * 100 * (1 << TIMER_SHIFT))
|
|
#endif
|
|
|
|
|
|
/* Configuration. */
|
|
#define SCSI_ID_MAX 16 /* 16 on wide buses */
|
|
#define SCSI_LUN_MAX 8 /* always 8 */
|
|
|
|
|
|
/* SCSI commands. */
|
|
#define GPCMD_TEST_UNIT_READY 0x00
|
|
#define GPCMD_REZERO_UNIT 0x01
|
|
#define GPCMD_REQUEST_SENSE 0x03
|
|
#define GPCMD_FORMAT_UNIT 0x04
|
|
#define GPCMD_IOMEGA_SENSE 0x06
|
|
#define GPCMD_READ_6 0x08
|
|
#define GPCMD_WRITE_6 0x0a
|
|
#define GPCMD_SEEK_6 0x0b
|
|
#define GPCMD_IOMEGA_SET_PROTECTION_MODE 0x0c
|
|
#define GPCMD_IOMEGA_EJECT 0x0d /* ATAPI only? */
|
|
#define GPCMD_INQUIRY 0x12
|
|
#define GPCMD_VERIFY_6 0x13
|
|
#define GPCMD_MODE_SELECT_6 0x15
|
|
#define GPCMD_SCSI_RESERVE 0x16
|
|
#define GPCMD_SCSI_RELEASE 0x17
|
|
#define GPCMD_MODE_SENSE_6 0x1a
|
|
#define GPCMD_START_STOP_UNIT 0x1b
|
|
#define GPCMD_SEND_DIAGNOSTIC 0x1d
|
|
#define GPCMD_PREVENT_REMOVAL 0x1e
|
|
#define GPCMD_READ_FORMAT_CAPACITIES 0x23
|
|
#define GPCMD_READ_CDROM_CAPACITY 0x25
|
|
#define GPCMD_READ_10 0x28
|
|
#define GPCMD_WRITE_10 0x2a
|
|
#define GPCMD_SEEK_10 0x2b
|
|
#define GPCMD_WRITE_AND_VERIFY_10 0x2e
|
|
#define GPCMD_VERIFY_10 0x2f
|
|
#define GPCMD_READ_BUFFER 0x3c
|
|
#define GPCMD_WRITE_SAME_10 0x41
|
|
#define GPCMD_READ_SUBCHANNEL 0x42
|
|
#define GPCMD_READ_TOC_PMA_ATIP 0x43
|
|
#define GPCMD_READ_HEADER 0x44
|
|
#define GPCMD_PLAY_AUDIO_10 0x45
|
|
#define GPCMD_GET_CONFIGURATION 0x46
|
|
#define GPCMD_PLAY_AUDIO_MSF 0x47
|
|
#define GPCMD_PLAY_AUDIO_TRACK_INDEX 0x48
|
|
#define GPCMD_GET_EVENT_STATUS_NOTIFICATION 0x4a
|
|
#define GPCMD_PAUSE_RESUME 0x4b
|
|
#define GPCMD_STOP_PLAY_SCAN 0x4e
|
|
#define GPCMD_READ_DISC_INFORMATION 0x51
|
|
#define GPCMD_READ_TRACK_INFORMATION 0x52
|
|
#define GPCMD_MODE_SELECT_10 0x55
|
|
#define GPCMD_MODE_SENSE_10 0x5a
|
|
#define GPCMD_PLAY_AUDIO_12 0xa5
|
|
#define GPCMD_READ_12 0xa8
|
|
#define GPCMD_WRITE_12 0xaa
|
|
#define GPCMD_READ_DVD_STRUCTURE 0xad /* For reading. */
|
|
#define GPCMD_WRITE_AND_VERIFY_12 0xae
|
|
#define GPCMD_VERIFY_12 0xaf
|
|
#define GPCMD_PLAY_CD_OLD 0xb4
|
|
#define GPCMD_READ_CD_OLD 0xb8
|
|
#define GPCMD_READ_CD_MSF 0xb9
|
|
#define GPCMD_SCAN 0xba
|
|
#define GPCMD_SET_SPEED 0xbb
|
|
#define GPCMD_PLAY_CD 0xbc
|
|
#define GPCMD_MECHANISM_STATUS 0xbd
|
|
#define GPCMD_READ_CD 0xbe
|
|
#define GPCMD_SEND_DVD_STRUCTURE 0xbf /* This is for writing only, irrelevant to PCem. */
|
|
#define GPCMD_PAUSE_RESUME_ALT 0xc2
|
|
#define GPCMD_SCAN_ALT 0xcd /* Should be equivalent to 0xba */
|
|
#define GPCMD_SET_SPEED_ALT 0xda /* Should be equivalent to 0xbb */
|
|
|
|
/* Mode page codes for mode sense/set */
|
|
#define GPMODE_R_W_ERROR_PAGE 0x01
|
|
#define GPMODE_CDROM_PAGE 0x0d
|
|
#define GPMODE_CDROM_AUDIO_PAGE 0x0e
|
|
#define GPMODE_CAPABILITIES_PAGE 0x2a
|
|
#define GPMODE_ALL_PAGES 0x3f
|
|
|
|
/* Mode page codes for presence */
|
|
#define GPMODEP_R_W_ERROR_PAGE 0x0000000000000002LL
|
|
#define GPMODEP_CDROM_PAGE 0x0000000000002000LL
|
|
#define GPMODEP_CDROM_AUDIO_PAGE 0x0000000000004000LL
|
|
#define GPMODEP_CAPABILITIES_PAGE 0x0000040000000000LL
|
|
#define GPMODEP_ALL_PAGES 0x8000000000000000LL
|
|
|
|
/* SCSI Status Codes */
|
|
#define SCSI_STATUS_OK 0
|
|
#define SCSI_STATUS_CHECK_CONDITION 2
|
|
|
|
/* SCSI Sense Keys */
|
|
#define SENSE_NONE 0
|
|
#define SENSE_NOT_READY 2
|
|
#define SENSE_ILLEGAL_REQUEST 5
|
|
#define SENSE_UNIT_ATTENTION 6
|
|
|
|
/* SCSI Additional Sense Codes */
|
|
#define ASC_AUDIO_PLAY_OPERATION 0x00
|
|
#define ASC_NOT_READY 0x04
|
|
#define ASC_ILLEGAL_OPCODE 0x20
|
|
#define ASC_LBA_OUT_OF_RANGE 0x21
|
|
#define ASC_INV_FIELD_IN_CMD_PACKET 0x24
|
|
#define ASC_INV_LUN 0x25
|
|
#define ASC_INV_FIELD_IN_PARAMETER_LIST 0x26
|
|
#define ASC_WRITE_PROTECTED 0x27
|
|
#define ASC_MEDIUM_MAY_HAVE_CHANGED 0x28
|
|
#define ASC_CAPACITY_DATA_CHANGED 0x2A
|
|
#define ASC_INCOMPATIBLE_FORMAT 0x30
|
|
#define ASC_MEDIUM_NOT_PRESENT 0x3a
|
|
#define ASC_DATA_PHASE_ERROR 0x4b
|
|
#define ASC_ILLEGAL_MODE_FOR_THIS_TRACK 0x64
|
|
|
|
#define ASCQ_UNIT_IN_PROCESS_OF_BECOMING_READY 0x01
|
|
#define ASCQ_INITIALIZING_COMMAND_REQUIRED 0x02
|
|
#define ASCQ_CAPACITY_DATA_CHANGED 0x09
|
|
#define ASCQ_AUDIO_PLAY_OPERATION_IN_PROGRESS 0x11
|
|
#define ASCQ_AUDIO_PLAY_OPERATION_PAUSED 0x12
|
|
#define ASCQ_AUDIO_PLAY_OPERATION_COMPLETED 0x13
|
|
|
|
/* Tell RISC OS that we have a 4x CD-ROM drive (600kb/sec data, 706kb/sec raw).
|
|
Not that it means anything */
|
|
#define CDROM_SPEED 706 /* 0x2C2 */
|
|
|
|
#define BUFFER_SIZE (256*1024)
|
|
|
|
#define RW_DELAY (TIMER_USEC * 500)
|
|
|
|
/* Some generally useful CD-ROM information */
|
|
#define CD_MINS 75 /* max. minutes per CD */
|
|
#define CD_SECS 60 /* seconds per minute */
|
|
#define CD_FRAMES 75 /* frames per second */
|
|
#define CD_FRAMESIZE 2048 /* bytes per frame, "cooked" mode */
|
|
#define CD_MAX_BYTES (CD_MINS * CD_SECS * CD_FRAMES * CD_FRAMESIZE)
|
|
#define CD_MAX_SECTORS (CD_MAX_BYTES / 512)
|
|
|
|
/* Event notification classes for GET EVENT STATUS NOTIFICATION */
|
|
#define GESN_NO_EVENTS 0
|
|
#define GESN_OPERATIONAL_CHANGE 1
|
|
#define GESN_POWER_MANAGEMENT 2
|
|
#define GESN_EXTERNAL_REQUEST 3
|
|
#define GESN_MEDIA 4
|
|
#define GESN_MULTIPLE_HOSTS 5
|
|
#define GESN_DEVICE_BUSY 6
|
|
|
|
/* Event codes for MEDIA event status notification */
|
|
#define MEC_NO_CHANGE 0
|
|
#define MEC_EJECT_REQUESTED 1
|
|
#define MEC_NEW_MEDIA 2
|
|
#define MEC_MEDIA_REMOVAL 3 /* only for media changers */
|
|
#define MEC_MEDIA_CHANGED 4 /* only for media changers */
|
|
#define MEC_BG_FORMAT_COMPLETED 5 /* MRW or DVD+RW b/g format completed */
|
|
#define MEC_BG_FORMAT_RESTARTED 6 /* MRW or DVD+RW b/g format restarted */
|
|
#define MS_TRAY_OPEN 1
|
|
#define MS_MEDIA_PRESENT 2
|
|
|
|
/*
|
|
* The MMC values are not IDE specific and might need to be moved
|
|
* to a common header if they are also needed for the SCSI emulation
|
|
*/
|
|
|
|
/* Profile list from MMC-6 revision 1 table 91 */
|
|
#define MMC_PROFILE_NONE 0x0000
|
|
#define MMC_PROFILE_CD_ROM 0x0008
|
|
#define MMC_PROFILE_CD_R 0x0009
|
|
#define MMC_PROFILE_CD_RW 0x000A
|
|
#define MMC_PROFILE_DVD_ROM 0x0010
|
|
#define MMC_PROFILE_DVD_R_SR 0x0011
|
|
#define MMC_PROFILE_DVD_RAM 0x0012
|
|
#define MMC_PROFILE_DVD_RW_RO 0x0013
|
|
#define MMC_PROFILE_DVD_RW_SR 0x0014
|
|
#define MMC_PROFILE_DVD_R_DL_SR 0x0015
|
|
#define MMC_PROFILE_DVD_R_DL_JR 0x0016
|
|
#define MMC_PROFILE_DVD_RW_DL 0x0017
|
|
#define MMC_PROFILE_DVD_DDR 0x0018
|
|
#define MMC_PROFILE_DVD_PLUS_RW 0x001A
|
|
#define MMC_PROFILE_DVD_PLUS_R 0x001B
|
|
#define MMC_PROFILE_DVD_PLUS_RW_DL 0x002A
|
|
#define MMC_PROFILE_DVD_PLUS_R_DL 0x002B
|
|
#define MMC_PROFILE_BD_ROM 0x0040
|
|
#define MMC_PROFILE_BD_R_SRM 0x0041
|
|
#define MMC_PROFILE_BD_R_RRM 0x0042
|
|
#define MMC_PROFILE_BD_RE 0x0043
|
|
#define MMC_PROFILE_HDDVD_ROM 0x0050
|
|
#define MMC_PROFILE_HDDVD_R 0x0051
|
|
#define MMC_PROFILE_HDDVD_RAM 0x0052
|
|
#define MMC_PROFILE_HDDVD_RW 0x0053
|
|
#define MMC_PROFILE_HDDVD_R_DL 0x0058
|
|
#define MMC_PROFILE_HDDVD_RW_DL 0x005A
|
|
#define MMC_PROFILE_INVALID 0xFFFF
|
|
|
|
#define SCSI_ONLY 32
|
|
#define ATAPI_ONLY 16
|
|
#define IMPLEMENTED 8
|
|
#define NONDATA 4
|
|
#define CHECK_READY 2
|
|
#define ALLOW_UA 1
|
|
|
|
|
|
extern uint8_t SCSICommandTable[0x100];
|
|
extern uint8_t mode_sense_pages[0x40];
|
|
extern int readcdmode;
|
|
|
|
/* Mode sense/select stuff. */
|
|
extern uint8_t mode_pages_in[256][256];
|
|
extern uint8_t page_flags[256];
|
|
extern uint8_t prefix_len;
|
|
extern uint8_t page_current;
|
|
#define PAGE_CHANGEABLE 1
|
|
#define PAGE_CHANGED 2
|
|
|
|
struct _scsisense_ {
|
|
uint8_t SenseBuffer[18];
|
|
uint8_t SenseLength;
|
|
uint8_t UnitAttention;
|
|
uint8_t SenseKey;
|
|
uint8_t Asc;
|
|
uint8_t Ascq;
|
|
} SCSISense;
|
|
|
|
extern int cd_status;
|
|
extern int prev_status;
|
|
|
|
enum {
|
|
SCSI_NONE = 0,
|
|
SCSI_DISK,
|
|
SCSI_CDROM,
|
|
SCSI_ZIP
|
|
};
|
|
|
|
#define MSFtoLBA(m,s,f) ((((m*60)+s)*75)+f)
|
|
|
|
#define MSG_COMMAND_COMPLETE 0x00
|
|
|
|
#define BUS_DBP 0x01
|
|
#define BUS_SEL 0x02
|
|
#define BUS_IO 0x04
|
|
#define BUS_CD 0x08
|
|
#define BUS_MSG 0x10
|
|
#define BUS_REQ 0x20
|
|
#define BUS_BSY 0x40
|
|
#define BUS_RST 0x80
|
|
#define BUS_ACK 0x200
|
|
#define BUS_ATN 0x200
|
|
#define BUS_ARB 0x8000
|
|
#define BUS_SETDATA(val) ((uint32_t)val << 16)
|
|
#define BUS_GETDATA(val) ((val >> 16) & 0xff)
|
|
#define BUS_DATAMASK 0xff0000
|
|
|
|
#define BUS_IDLE (1 << 31)
|
|
|
|
#define SCSI_PHASE_DATA_OUT 0
|
|
#define SCSI_PHASE_DATA_IN BUS_IO
|
|
#define SCSI_PHASE_COMMAND BUS_CD
|
|
#define SCSI_PHASE_STATUS (BUS_CD | BUS_IO)
|
|
#define SCSI_PHASE_MESSAGE_OUT (BUS_MSG | BUS_CD)
|
|
#define SCSI_PHASE_MESSAGE_IN (BUS_MSG | BUS_CD | BUS_IO)
|
|
|
|
typedef struct {
|
|
uint8_t *CmdBuffer;
|
|
int LunType;
|
|
int32_t BufferLength;
|
|
uint8_t Status;
|
|
uint8_t Phase;
|
|
} scsi_device_t;
|
|
|
|
|
|
extern scsi_device_t SCSIDevices[SCSI_ID_MAX][SCSI_LUN_MAX];
|
|
|
|
extern void SCSIReset(uint8_t id, uint8_t lun);
|
|
|
|
extern int cdrom_add_error_and_subchannel(uint8_t *b, int real_sector_type);
|
|
extern int cdrom_LBAtoMSF_accurate(void);
|
|
|
|
extern int mode_select_init(uint8_t command, uint16_t pl_length, uint8_t do_save);
|
|
extern int mode_select_terminate(int force);
|
|
extern int mode_select_write(uint8_t val);
|
|
|
|
extern int scsi_card_current;
|
|
|
|
extern int scsi_card_available(int card);
|
|
extern char *scsi_card_getname(int card);
|
|
#ifdef EMU_DEVICE_H
|
|
extern const device_t *scsi_card_getdevice(int card);
|
|
#endif
|
|
extern int scsi_card_has_config(int card);
|
|
extern char *scsi_card_get_internal_name(int card);
|
|
extern int scsi_card_get_from_internal_name(char *s);
|
|
extern void scsi_mutex(uint8_t start);
|
|
extern void scsi_card_init(void);
|
|
|
|
extern uint8_t scsi_hard_disks[16][8];
|
|
|
|
extern int scsi_hd_err_stat_to_scsi(uint8_t id);
|
|
extern int scsi_hd_phase_to_scsi(uint8_t id);
|
|
extern int find_hdc_for_scsi_id(uint8_t scsi_id, uint8_t scsi_lun);
|
|
extern void build_scsi_hd_map(void);
|
|
extern void scsi_hd_reset(uint8_t id);
|
|
extern void scsi_hd_request_sense_for_scsi(uint8_t id, uint8_t *buffer, uint8_t alloc_length);
|
|
extern void scsi_hd_command(uint8_t id, uint8_t *cdb);
|
|
extern void scsi_hd_callback(uint8_t id);
|
|
|
|
|
|
#pragma pack(push,1)
|
|
typedef struct {
|
|
uint8_t hi;
|
|
uint8_t mid;
|
|
uint8_t lo;
|
|
} addr24;
|
|
#pragma pack(pop)
|
|
|
|
#define ADDR_TO_U32(x) (((x).hi<<16)|((x).mid<<8)|((x).lo&0xFF))
|
|
#define U32_TO_ADDR(a,x) do {(a).hi=(x)>>16;(a).mid=(x)>>8;(a).lo=(x)&0xFF;}while(0)
|
|
|
|
|
|
/*
|
|
*
|
|
* Scatter/Gather Segment List Definitions
|
|
*
|
|
* Adapter limits
|
|
*/
|
|
#define MAX_SG_DESCRIPTORS 32 /* Always make the array 32 elements long, if less are used, that's not an issue. */
|
|
|
|
#pragma pack(push,1)
|
|
typedef struct {
|
|
uint32_t Segment;
|
|
uint32_t SegmentPointer;
|
|
} SGE32;
|
|
#pragma pack(pop)
|
|
|
|
#pragma pack(push,1)
|
|
typedef struct {
|
|
addr24 Segment;
|
|
addr24 SegmentPointer;
|
|
} SGE;
|
|
#pragma pack(pop)
|
|
|
|
#pragma pack(push,1)
|
|
typedef struct {
|
|
uint8_t pages[0x40][0x40];
|
|
} mode_sense_pages_t;
|
|
#pragma pack(pop)
|
|
|
|
|
|
#define MODE_SELECT_PHASE_IDLE 0
|
|
#define MODE_SELECT_PHASE_HEADER 1
|
|
#define MODE_SELECT_PHASE_BLOCK_DESC 2
|
|
#define MODE_SELECT_PHASE_PAGE_HEADER 3
|
|
#define MODE_SELECT_PHASE_PAGE 4
|
|
|
|
#endif /*EMU_SCSI_H*/
|
|
|
|
extern void scsi_mutex_wait(uint8_t wait);
|