Archipelago » qemu

#ifndef HW_IDE_INTERNAL_H

#define HW_IDE_INTERNAL_H

/*

 * QEMU IDE Emulation -- internal header file

 * only files in hw/ide/ are supposed to include this file.

 * non-internal declarations are in hw/ide.h

 */

#include <hw/ide.h>

/* debug IDE devices */

//#define DEBUG_IDE

//#define DEBUG_IDE_ATAPI

//#define DEBUG_AIO

#define USE_DMA_CDROM

typedef struct IDEBus IDEBus;

typedef struct IDEState IDEState;

typedef struct BMDMAState BMDMAState;

/* debug IDE devices */

//#define DEBUG_IDE

//#define DEBUG_IDE_ATAPI

//#define DEBUG_AIO

#define USE_DMA_CDROM

/* Bits of HD_STATUS */

#define ERR_STAT                0x01

#define INDEX_STAT                0x02

#define ECC_STAT                0x04        /* Corrected error */

#define DRQ_STAT                0x08

#define SEEK_STAT                0x10

#define SRV_STAT                0x10

#define WRERR_STAT                0x20

#define READY_STAT                0x40

#define BUSY_STAT                0x80

/* Bits for HD_ERROR */

#define MARK_ERR                0x01        /* Bad address mark */

#define TRK0_ERR                0x02        /* couldn't find track 0 */

#define ABRT_ERR                0x04        /* Command aborted */

#define MCR_ERR                        0x08        /* media change request */

#define ID_ERR                        0x10        /* ID field not found */

#define MC_ERR                        0x20        /* media changed */

#define ECC_ERR                        0x40        /* Uncorrectable ECC error */

#define BBD_ERR                        0x80        /* pre-EIDE meaning:  block marked bad */

#define ICRC_ERR                0x80        /* new meaning:  CRC error during transfer */

/* Bits of HD_NSECTOR */

#define CD                        0x01

#define IO                        0x02

#define REL                        0x04

#define TAG_MASK                0xf8

#define IDE_CMD_RESET           0x04

#define IDE_CMD_DISABLE_IRQ     0x02

/* ATA/ATAPI Commands pre T13 Spec */

#define WIN_NOP                                0x00

/*

 *        0x01->0x02 Reserved

 */

#define CFA_REQ_EXT_ERROR_CODE                0x03 /* CFA Request Extended Error Code */

/*

 *        0x04->0x07 Reserved

 */

#define WIN_SRST                        0x08 /* ATAPI soft reset command */

#define WIN_DEVICE_RESET                0x08

/*

 *        0x09->0x0F Reserved

 */

#define WIN_RECAL                        0x10

#define WIN_RESTORE                        WIN_RECAL

/*

 *        0x10->0x1F Reserved

 */

#define WIN_READ                        0x20 /* 28-Bit */

#define WIN_READ_ONCE                        0x21 /* 28-Bit without retries */

#define WIN_READ_LONG                        0x22 /* 28-Bit */

#define WIN_READ_LONG_ONCE                0x23 /* 28-Bit without retries */

#define WIN_READ_EXT                        0x24 /* 48-Bit */

#define WIN_READDMA_EXT                        0x25 /* 48-Bit */

#define WIN_READDMA_QUEUED_EXT                0x26 /* 48-Bit */

#define WIN_READ_NATIVE_MAX_EXT                0x27 /* 48-Bit */

/*

 *        0x28

 */

#define WIN_MULTREAD_EXT                0x29 /* 48-Bit */

/*

 *        0x2A->0x2F Reserved

 */

#define WIN_WRITE                        0x30 /* 28-Bit */

#define WIN_WRITE_ONCE                        0x31 /* 28-Bit without retries */

#define WIN_WRITE_LONG                        0x32 /* 28-Bit */

#define WIN_WRITE_LONG_ONCE                0x33 /* 28-Bit without retries */

#define WIN_WRITE_EXT                        0x34 /* 48-Bit */

#define WIN_WRITEDMA_EXT                0x35 /* 48-Bit */

#define WIN_WRITEDMA_QUEUED_EXT                0x36 /* 48-Bit */

#define WIN_SET_MAX_EXT                        0x37 /* 48-Bit */

#define CFA_WRITE_SECT_WO_ERASE                0x38 /* CFA Write Sectors without erase */

#define WIN_MULTWRITE_EXT                0x39 /* 48-Bit */

/*

 *        0x3A->0x3B Reserved

 */

#define WIN_WRITE_VERIFY                0x3C /* 28-Bit */

/*

 *        0x3D->0x3F Reserved

 */

#define WIN_VERIFY                        0x40 /* 28-Bit - Read Verify Sectors */

#define WIN_VERIFY_ONCE                        0x41 /* 28-Bit - without retries */

#define WIN_VERIFY_EXT                        0x42 /* 48-Bit */

/*

 *        0x43->0x4F Reserved

 */

#define WIN_FORMAT                        0x50

/*

 *        0x51->0x5F Reserved

 */

#define WIN_INIT                        0x60

/*

 *        0x61->0x5F Reserved

 */

#define WIN_SEEK                        0x70 /* 0x70-0x7F Reserved */

#define CFA_TRANSLATE_SECTOR                0x87 /* CFA Translate Sector */

#define WIN_DIAGNOSE                        0x90

#define WIN_SPECIFY                        0x91 /* set drive geometry translation */

#define WIN_DOWNLOAD_MICROCODE                0x92

#define WIN_STANDBYNOW2                        0x94

#define CFA_IDLEIMMEDIATE                0x95 /* force drive to become "ready" */

#define WIN_STANDBY2                        0x96

#define WIN_SETIDLE2                        0x97

#define WIN_CHECKPOWERMODE2                0x98

#define WIN_SLEEPNOW2                        0x99

/*

 *        0x9A VENDOR

 */

#define WIN_PACKETCMD                        0xA0 /* Send a packet command. */

#define WIN_PIDENTIFY                        0xA1 /* identify ATAPI device        */

#define WIN_QUEUED_SERVICE                0xA2

#define WIN_SMART                        0xB0 /* self-monitoring and reporting */

#define CFA_ACCESS_METADATA_STORAGE        0xB8

#define CFA_ERASE_SECTORS               0xC0 /* microdrives implement as NOP */

#define WIN_MULTREAD                        0xC4 /* read sectors using multiple mode*/

#define WIN_MULTWRITE                        0xC5 /* write sectors using multiple mode */

#define WIN_SETMULT                        0xC6 /* enable/disable multiple mode */

#define WIN_READDMA_QUEUED                0xC7 /* read sectors using Queued DMA transfers */

#define WIN_READDMA                        0xC8 /* read sectors using DMA transfers */

#define WIN_READDMA_ONCE                0xC9 /* 28-Bit - without retries */

#define WIN_WRITEDMA                        0xCA /* write sectors using DMA transfers */

#define WIN_WRITEDMA_ONCE                0xCB /* 28-Bit - without retries */

#define WIN_WRITEDMA_QUEUED                0xCC /* write sectors using Queued DMA transfers */

#define CFA_WRITE_MULTI_WO_ERASE        0xCD /* CFA Write multiple without erase */

#define WIN_GETMEDIASTATUS                0xDA

#define WIN_ACKMEDIACHANGE                0xDB /* ATA-1, ATA-2 vendor */

#define WIN_POSTBOOT                        0xDC

#define WIN_PREBOOT                        0xDD

#define WIN_DOORLOCK                        0xDE /* lock door on removable drives */

#define WIN_DOORUNLOCK                        0xDF /* unlock door on removable drives */

#define WIN_STANDBYNOW1                        0xE0

#define WIN_IDLEIMMEDIATE                0xE1 /* force drive to become "ready" */

#define WIN_STANDBY                     0xE2 /* Set device in Standby Mode */

#define WIN_SETIDLE1                        0xE3

#define WIN_READ_BUFFER                        0xE4 /* force read only 1 sector */

#define WIN_CHECKPOWERMODE1                0xE5

#define WIN_SLEEPNOW1                        0xE6

#define WIN_FLUSH_CACHE                        0xE7

#define WIN_WRITE_BUFFER                0xE8 /* force write only 1 sector */

#define WIN_WRITE_SAME                        0xE9 /* read ata-2 to use */

        /* SET_FEATURES 0x22 or 0xDD */

#define WIN_FLUSH_CACHE_EXT                0xEA /* 48-Bit */

#define WIN_IDENTIFY                        0xEC /* ask drive to identify itself        */

#define WIN_MEDIAEJECT                        0xED

#define WIN_IDENTIFY_DMA                0xEE /* same as WIN_IDENTIFY, but DMA */

#define WIN_SETFEATURES                        0xEF /* set special drive features */

#define EXABYTE_ENABLE_NEST                0xF0

#define IBM_SENSE_CONDITION                0xF0 /* measure disk temperature */

#define WIN_SECURITY_SET_PASS                0xF1

#define WIN_SECURITY_UNLOCK                0xF2

#define WIN_SECURITY_ERASE_PREPARE        0xF3

#define WIN_SECURITY_ERASE_UNIT                0xF4

#define WIN_SECURITY_FREEZE_LOCK        0xF5

#define CFA_WEAR_LEVEL                        0xF5 /* microdrives implement as NOP */

#define WIN_SECURITY_DISABLE                0xF6

#define WIN_READ_NATIVE_MAX                0xF8 /* return the native maximum address */

#define WIN_SET_MAX                        0xF9

#define DISABLE_SEAGATE                        0xFB

/* set to 1 set disable mult support */

#define MAX_MULT_SECTORS 16

#define IDE_DMA_BUF_SECTORS 256

#if (IDE_DMA_BUF_SECTORS < MAX_MULT_SECTORS)

#error "IDE_DMA_BUF_SECTORS must be bigger or equal to MAX_MULT_SECTORS"

#endif

/* ATAPI defines */

#define ATAPI_PACKET_SIZE 12

/* The generic packet command opcodes for CD/DVD Logical Units,

 * From Table 57 of the SFF8090 Ver. 3 (Mt. Fuji) draft standard. */

#define GPCMD_BLANK                            0xa1

#define GPCMD_CLOSE_TRACK                    0x5b

#define GPCMD_FLUSH_CACHE                    0x35

#define GPCMD_FORMAT_UNIT                    0x04

#define GPCMD_GET_CONFIGURATION                    0x46

#define GPCMD_GET_EVENT_STATUS_NOTIFICATION 0x4a

#define GPCMD_GET_PERFORMANCE                    0xac

#define GPCMD_INQUIRY                            0x12

#define GPCMD_LOAD_UNLOAD                    0xa6

#define GPCMD_MECHANISM_STATUS                    0xbd

#define GPCMD_MODE_SELECT_10                    0x55

#define GPCMD_MODE_SENSE_10                    0x5a

#define GPCMD_PAUSE_RESUME                    0x4b

#define GPCMD_PLAY_AUDIO_10                    0x45

#define GPCMD_PLAY_AUDIO_MSF                    0x47

#define GPCMD_PLAY_AUDIO_TI                    0x48

#define GPCMD_PLAY_CD                            0xbc

#define GPCMD_PREVENT_ALLOW_MEDIUM_REMOVAL  0x1e

#define GPCMD_READ_10                            0x28

#define GPCMD_READ_12                            0xa8

#define GPCMD_READ_CDVD_CAPACITY            0x25

#define GPCMD_READ_CD                            0xbe

#define GPCMD_READ_CD_MSF                    0xb9

#define GPCMD_READ_DISC_INFO                    0x51

#define GPCMD_READ_DVD_STRUCTURE            0xad

#define GPCMD_READ_FORMAT_CAPACITIES            0x23

#define GPCMD_READ_HEADER                    0x44

#define GPCMD_READ_TRACK_RZONE_INFO            0x52

#define GPCMD_READ_SUBCHANNEL                    0x42

#define GPCMD_READ_TOC_PMA_ATIP                    0x43

#define GPCMD_REPAIR_RZONE_TRACK            0x58

#define GPCMD_REPORT_KEY                    0xa4

#define GPCMD_REQUEST_SENSE                    0x03

#define GPCMD_RESERVE_RZONE_TRACK            0x53

#define GPCMD_SCAN                            0xba

#define GPCMD_SEEK                            0x2b

#define GPCMD_SEND_DVD_STRUCTURE            0xad

#define GPCMD_SEND_EVENT                    0xa2

#define GPCMD_SEND_KEY                            0xa3

#define GPCMD_SEND_OPC                            0x54

#define GPCMD_SET_READ_AHEAD                    0xa7

#define GPCMD_SET_STREAMING                    0xb6

#define GPCMD_START_STOP_UNIT                    0x1b

#define GPCMD_STOP_PLAY_SCAN                    0x4e

#define GPCMD_TEST_UNIT_READY                    0x00

#define GPCMD_VERIFY_10                            0x2f

#define GPCMD_WRITE_10                            0x2a

#define GPCMD_WRITE_AND_VERIFY_10            0x2e

/* This is listed as optional in ATAPI 2.6, but is (curiously)

 * missing from Mt. Fuji, Table 57.  It _is_ mentioned in Mt. Fuji

 * Table 377 as an MMC command for SCSi devices though...  Most ATAPI

 * drives support it. */

#define GPCMD_SET_SPEED                            0xbb

/* This seems to be a SCSI specific CD-ROM opcode

 * to play data at track/index */

#define GPCMD_PLAYAUDIO_TI                    0x48

/*

 * From MS Media Status Notification Support Specification. For

 * older drives only.

 */

#define GPCMD_GET_MEDIA_STATUS                    0xda

#define GPCMD_MODE_SENSE_6                    0x1a

/* Mode page codes for mode sense/set */

#define GPMODE_R_W_ERROR_PAGE                0x01

#define GPMODE_WRITE_PARMS_PAGE                0x05

#define GPMODE_AUDIO_CTL_PAGE                0x0e

#define GPMODE_POWER_PAGE                0x1a

#define GPMODE_FAULT_FAIL_PAGE                0x1c

#define GPMODE_TO_PROTECT_PAGE                0x1d

#define GPMODE_CAPABILITIES_PAGE        0x2a

#define GPMODE_ALL_PAGES                0x3f

/* Not in Mt. Fuji, but in ATAPI 2.6 -- depricated now in favor

 * of MODE_SENSE_POWER_PAGE */

#define GPMODE_CDROM_PAGE                0x0d

/*

 * Based on values from <linux/cdrom.h> but extending CD_MINS

 * to the maximum common size allowed by the Orange's Book ATIP

 *

 * 90 and 99 min CDs are also available but using them as the

 * upper limit reduces the effectiveness of the heuristic to

 * detect DVDs burned to less than 25% of their maximum capacity

 */

/* Some generally useful CD-ROM information */

#define CD_MINS                       80 /* 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)

/*

 * 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 ATAPI_INT_REASON_CD             0x01 /* 0 = data transfer */

#define ATAPI_INT_REASON_IO             0x02 /* 1 = transfer to the host */

#define ATAPI_INT_REASON_REL            0x04

#define ATAPI_INT_REASON_TAG            0xf8

/* same constants as bochs */

#define ASC_ILLEGAL_OPCODE                   0x20

#define ASC_LOGICAL_BLOCK_OOR                0x21

#define ASC_INV_FIELD_IN_CMD_PACKET          0x24

#define ASC_MEDIUM_MAY_HAVE_CHANGED          0x28

#define ASC_INCOMPATIBLE_FORMAT              0x30

#define ASC_MEDIUM_NOT_PRESENT               0x3a

#define ASC_SAVING_PARAMETERS_NOT_SUPPORTED  0x39

#define ASC_MEDIA_REMOVAL_PREVENTED          0x53

#define CFA_NO_ERROR            0x00

#define CFA_MISC_ERROR          0x09

#define CFA_INVALID_COMMAND     0x20

#define CFA_INVALID_ADDRESS     0x21

#define CFA_ADDRESS_OVERFLOW    0x2f

#define SENSE_NONE            0

#define SENSE_NOT_READY       2

#define SENSE_ILLEGAL_REQUEST 5

#define SENSE_UNIT_ATTENTION  6

#define SMART_READ_DATA       0xd0

#define SMART_READ_THRESH     0xd1

#define SMART_ATTR_AUTOSAVE   0xd2

#define SMART_SAVE_ATTR       0xd3

#define SMART_EXECUTE_OFFLINE 0xd4

#define SMART_READ_LOG        0xd5

#define SMART_WRITE_LOG       0xd6

#define SMART_ENABLE          0xd8

#define SMART_DISABLE         0xd9

#define SMART_STATUS          0xda

typedef void EndTransferFunc(IDEState *);

/* NOTE: IDEState represents in fact one drive */

struct IDEState {

    IDEBus *bus;

    uint8_t unit;

    /* ide config */

    int is_cdrom;

    int is_cf;

    int cylinders, heads, sectors;

    int64_t nb_sectors;

    int mult_sectors;

    int identify_set;

    uint16_t identify_data[256];

    int drive_serial;

    char drive_serial_str[21];

    /* ide regs */

    uint8_t feature;

    uint8_t error;

    uint32_t nsector;

    uint8_t sector;

    uint8_t lcyl;

    uint8_t hcyl;

    /* other part of tf for lba48 support */

    uint8_t hob_feature;

    uint8_t hob_nsector;

    uint8_t hob_sector;

    uint8_t hob_lcyl;

    uint8_t hob_hcyl;

    uint8_t select;

    uint8_t status;

    /* set for lba48 access */

    uint8_t lba48;

    BlockDriverState *bs;

    /* ATAPI specific */

    uint8_t sense_key;

    uint8_t asc;

    uint8_t cdrom_changed;

    int packet_transfer_size;

    int elementary_transfer_size;

    int io_buffer_index;

    int lba;

    int cd_sector_size;

    int atapi_dma; /* true if dma is requested for the packet cmd */

    /* ATA DMA state */

    int io_buffer_size;

    QEMUSGList sg;

    /* PIO transfer handling */

    int req_nb_sectors; /* number of sectors per interrupt */

    EndTransferFunc *end_transfer_func;

    uint8_t *data_ptr;

    uint8_t *data_end;

    uint8_t *io_buffer;

    QEMUTimer *sector_write_timer; /* only used for win2k install hack */

    uint32_t irq_count; /* counts IRQs when using win2k install hack */

    /* CF-ATA extended error */

    uint8_t ext_error;

    /* CF-ATA metadata storage */

    uint32_t mdata_size;

    uint8_t *mdata_storage;

    int media_changed;

    /* for pmac */

    int is_read;

    /* SMART */

    uint8_t smart_enabled;

    uint8_t smart_autosave;

    int smart_errors;

    uint8_t smart_selftest_count;

    uint8_t *smart_selftest_data;

};

struct IDEBus {

    BusState qbus;

    BMDMAState *bmdma;

    IDEState ifs[2];

    uint8_t unit;

    uint8_t cmd;

    qemu_irq irq;

};

#define BM_STATUS_DMAING 0x01

#define BM_STATUS_ERROR  0x02

#define BM_STATUS_INT    0x04

#define BM_STATUS_DMA_RETRY  0x08

#define BM_STATUS_PIO_RETRY  0x10

#define BM_CMD_START     0x01

#define BM_CMD_READ      0x08

struct BMDMAState {

    uint8_t cmd;

    uint8_t status;

    uint32_t addr;

    struct PCIIDEState *pci_dev;

    IDEBus *bus;

    /* current transfer state */

    uint32_t cur_addr;

    uint32_t cur_prd_last;

    uint32_t cur_prd_addr;

    uint32_t cur_prd_len;

    uint8_t unit;

    BlockDriverCompletionFunc *dma_cb;

    BlockDriverAIOCB *aiocb;

    struct iovec iov;

    QEMUIOVector qiov;

    int64_t sector_num;

    uint32_t nsector;

    QEMUBH *bh;

};

static inline IDEState *idebus_active_if(IDEBus *bus)

{

    return bus->ifs + bus->unit;

}

static inline IDEState *bmdma_active_if(BMDMAState *bmdma)

{

    assert(bmdma->unit != (uint8_t)-1);

    return bmdma->bus->ifs + bmdma->unit;

}

static inline void ide_set_irq(IDEBus *bus)

{

    BMDMAState *bm = bus->bmdma;

    if (!(bus->cmd & IDE_CMD_DISABLE_IRQ)) {

        if (bm) {

            bm->status |= BM_STATUS_INT;

        }

        qemu_irq_raise(bus->irq);

    }

}

/* ide.c */

void ide_save(QEMUFile* f, IDEState *s);

void ide_load(QEMUFile* f, IDEState *s, int version_id);

void idebus_save(QEMUFile* f, IDEBus *bus);

void idebus_load(QEMUFile* f, IDEBus *bus, int version_id);

void ide_reset(IDEState *s);

int64_t ide_get_sector(IDEState *s);

void ide_set_sector(IDEState *s, int64_t sector_num);

void ide_dma_cancel(BMDMAState *bm);

void ide_dma_restart_cb(void *opaque, int running, int reason);

void ide_dma_error(IDEState *s);

void ide_atapi_cmd_ok(IDEState *s);

void ide_atapi_cmd_error(IDEState *s, int sense_key, int asc);

void ide_atapi_io_error(IDEState *s, int ret);

void ide_ioport_write(void *opaque, uint32_t addr, uint32_t val);

uint32_t ide_ioport_read(void *opaque, uint32_t addr1);

uint32_t ide_status_read(void *opaque, uint32_t addr);

void ide_cmd_write(void *opaque, uint32_t addr, uint32_t val);

void ide_data_writew(void *opaque, uint32_t addr, uint32_t val);

uint32_t ide_data_readw(void *opaque, uint32_t addr);

void ide_data_writel(void *opaque, uint32_t addr, uint32_t val);

uint32_t ide_data_readl(void *opaque, uint32_t addr);

void ide_init2(IDEBus *bus, DriveInfo *hd0, DriveInfo *hd1,

               qemu_irq irq);

void ide_init_ioport(IDEBus *bus, int iobase, int iobase2);

#endif /* HW_IDE_INTERNAL_H */