/* * This file is part of the Palacios Virtual Machine Monitor developed * by the V3VEE Project with funding from the United States National * Science Foundation and the Department of Energy. * * The V3VEE Project is a joint project between Northwestern University * and the University of New Mexico. You can find out more at * http://www.v3vee.org * * Copyright (c) 2008, Jack Lange * Copyright (c) 2008, The V3VEE Project * All rights reserved. * * Author: Jack Lange * * This is free software. You are permitted to use, * redistribute, and modify it as specified in the file "V3VEE_LICENSE". */ #include #include #include "ide-types.h" #include "atapi-types.h" #define PRI_DEFAULT_IRQ 14 #define SEC_DEFAULT_IRQ 15 #define PRI_DATA_PORT 0x1f0 #define PRI_FEATURES_PORT 0x1f1 #define PRI_SECT_CNT_PORT 0x1f2 #define PRI_SECT_NUM_PORT 0x1f3 #define PRI_CYL_LOW_PORT 0x1f4 #define PRI_CYL_HIGH_PORT 0x1f5 #define PRI_DRV_SEL_PORT 0x1f6 #define PRI_CMD_PORT 0x1f7 #define PRI_CTRL_PORT 0x3f6 #define PRI_ADDR_REG_PORT 0x3f7 #define SEC_DATA_PORT 0x170 #define SEC_FEATURES_PORT 0x171 #define SEC_SECT_CNT_PORT 0x172 #define SEC_SECT_NUM_PORT 0x173 #define SEC_CYL_LOW_PORT 0x174 #define SEC_CYL_HIGH_PORT 0x175 #define SEC_DRV_SEL_PORT 0x176 #define SEC_CMD_PORT 0x177 #define SEC_CTRL_PORT 0x376 #define SEC_ADDR_REG_PORT 0x377 #define DATA_BUFFER_SIZE 2048 static const char * ide_dev_type_strs[] = {"HARDDISK", "CDROM", "NONE"}; static inline const char * device_type_to_str(v3_ide_dev_type_t type) { if (type > 2) { return NULL; } return ide_dev_type_strs[type]; } struct ide_cd_state { struct atapi_sense_data sense; uint_t current_lba; }; struct ide_hd_state { }; struct ide_drive { // Command Registers v3_ide_dev_type_t drive_type; union { struct v3_ide_cd_ops * cd_ops; struct v3_ide_hd_ops * hd_ops; }; union { struct ide_cd_state cd_state; struct ide_hd_state hd_state; }; char model[41]; // Where we are in the data transfer uint_t transfer_index; // the length of a transfer // calculated for easy access uint_t transfer_length; // We have a local data buffer that we use for IO port accesses uint8_t data_buf[DATA_BUFFER_SIZE]; void * private_data; uint8_t sector_count; // 0x1f2,0x172 uint8_t sector_num; // 0x1f3,0x173 union { uint16_t cylinder; struct { uint8_t cylinder_low; // 0x1f4,0x174 uint8_t cylinder_high; // 0x1f5,0x175 } __attribute__((packed)); } __attribute__((packed)); }; struct ide_channel { struct ide_drive drives[2]; // Command Registers struct ide_error_reg error_reg; // [read] 0x1f1,0x171 struct ide_features_reg features; struct ide_drive_head_reg drive_head; // 0x1f6,0x176 struct ide_status_reg status; // [read] 0x1f7,0x177 uint8_t cmd_reg; // [write] 0x1f7,0x177 int irq; // this is temporary until we add PCI support // Control Registers struct ide_ctrl_reg ctrl_reg; // [write] 0x3f6,0x376 }; struct ide_internal { struct ide_channel channels[2]; }; static inline uint32_t be_to_le_16(const uint16_t val) { uint8_t * buf = (uint8_t *)&val; return (buf[0] << 8) | (buf[1]) ; } static inline uint32_t be_to_le_32(const uint32_t val) { uint8_t * buf = (uint8_t *)&val; return (buf[0] << 24) | (buf[1] << 16) | (buf[2] << 8) | buf[3]; } static inline int get_channel_index(ushort_t port) { if (((port & 0xfff8) == 0x1f0) || ((port & 0xfffe) == 0x3f6)) { return 0; } else if (((port & 0xfff8) == 0x170) || ((port & 0xfffe) == 0x376)) { return 1; } return -1; } static inline struct ide_channel * get_selected_channel(struct ide_internal * ide, ushort_t port) { int channel_idx = get_channel_index(port); return &(ide->channels[channel_idx]); } static inline struct ide_drive * get_selected_drive(struct ide_channel * channel) { return &(channel->drives[channel->drive_head.drive_sel]); } static inline int is_lba_enabled(struct ide_channel * channel) { return channel->drive_head.lba_mode; } static void ide_raise_irq(struct vm_device * dev, struct ide_channel * channel) { if (channel->ctrl_reg.irq_disable == 0) { v3_raise_irq(dev->vm, channel->irq); } } static void drive_reset(struct ide_drive * drive) { drive->sector_count = 0x01; drive->sector_num = 0x01; if (drive->drive_type == IDE_CDROM) { drive->cylinder = 0xeb14; } else { drive->cylinder = 0x0000; } memset(drive->data_buf, 0, sizeof(drive->data_buf)); drive->transfer_length = 0; drive->transfer_index = 0; // Send the reset signal to the connected device callbacks // channel->drives[0].reset(); // channel->drives[1].reset(); } static void channel_reset(struct ide_channel * channel) { // set busy and seek complete flags channel->status.val = 0x90; // Clear errors channel->error_reg.val = 0x01; // clear commands channel->cmd_reg = 0x00; channel->ctrl_reg.irq_disable = 0; } static void channel_reset_complete(struct ide_channel * channel) { channel->status.busy = 0; channel->status.ready = 1; channel->drive_head.head_num = 0; drive_reset(&(channel->drives[0])); drive_reset(&(channel->drives[1])); } static void ide_abort_command(struct vm_device * dev, struct ide_channel * channel) { channel->status.val = 0x41; // Error + ready channel->error_reg.val = 0x04; // No idea... ide_raise_irq(dev, channel); } // Include the ATAPI interface handlers #include "atapi.h" static int write_cmd_port(ushort_t port, void * src, uint_t length, struct vm_device * dev) { struct ide_internal * ide = (struct ide_internal *)(dev->private_data); struct ide_channel * channel = get_selected_channel(ide, port); struct ide_drive * drive = get_selected_drive(channel); if (length != 1) { PrintError("Invalid Write Length on IDE command Port %x\n", port); return -1; } PrintDebug("IDE: Writing Command Port %x (val=%x)\n", port, *(uint8_t *)src); channel->cmd_reg = *(uint8_t *)src; switch (channel->cmd_reg) { case 0xa0: // ATAPI Command Packet if (drive->drive_type != IDE_CDROM) { ide_abort_command(dev, channel); } drive->sector_count = 1; channel->status.busy = 0; channel->status.write_fault = 0; channel->status.data_req = 1; channel->status.error = 0; // reset the data buffer... drive->transfer_length = ATAPI_PACKET_SIZE; drive->transfer_index = 0; break; case 0xa1: // ATAPI Identify Device Packet atapi_identify_device(drive); channel->error_reg.val = 0; channel->status.val = 0x58; // ready, data_req, seek_complete ide_raise_irq(dev, channel); break; case 0xec: // Identify Device if (drive->drive_type != IDE_DISK) { drive_reset(drive); // JRL: Should we abort here? ide_abort_command(dev, channel); } else { PrintError("IDE Disks currently not implemented\n"); return -1; } break; default: PrintError("Unimplemented IDE command (%x)\n", channel->cmd_reg); return -1; } return length; } static int write_data_port(ushort_t port, void * src, uint_t length, struct vm_device * dev) { struct ide_internal * ide = (struct ide_internal *)(dev->private_data); struct ide_channel * channel = get_selected_channel(ide, port); struct ide_drive * drive = get_selected_drive(channel); PrintDebug("IDE: Writing Data Port %x (val=%x, len=%d)\n", port, *(uint32_t *)src, length); memcpy(drive->data_buf + drive->transfer_index, src, length); drive->transfer_index += length; // Transfer is complete, dispatch the command if (drive->transfer_index >= drive->transfer_length) { switch (channel->cmd_reg) { case 0x30: // Write Sectors PrintError("Writing Data not yet implemented\n"); return -1; case 0xa0: // ATAPI packet command if (atapi_handle_packet(dev, channel) == -1) { PrintError("Error handling ATAPI packet\n"); return -1; } break; default: PrintError("Unhandld IDE Command %x\n", channel->cmd_reg); return -1; } } return length; } static int read_data_port(ushort_t port, void * dst, uint_t length, struct vm_device * dev) { struct ide_internal * ide = (struct ide_internal *)(dev->private_data); struct ide_channel * channel = get_selected_channel(ide, port); struct ide_drive * drive = get_selected_drive(channel); int data_offset = drive->transfer_index % DATA_BUFFER_SIZE; PrintDebug("IDE: Reading Data Port %x\n", port); if (data_offset == DATA_BUFFER_SIZE) { // check for more data to transfer, if there isn't any then that's a problem... /* * if (ide_update_buffer(drive) == -1) { * return -1; * } */ return -1; } // check for overruns... // We will return the data padded with 0's if (drive->transfer_index + length > drive->transfer_length) { length = drive->transfer_length - drive->transfer_index; memset(dst, 0, length); } memcpy(dst, drive->data_buf + data_offset, length); drive->transfer_index += length; if (drive->transfer_index >= drive->transfer_length) { channel->status.data_req = 0; } return length; } static int write_port_std(ushort_t port, void * src, uint_t length, struct vm_device * dev) { struct ide_internal * ide = (struct ide_internal *)(dev->private_data); struct ide_channel * channel = get_selected_channel(ide, port); struct ide_drive * drive = get_selected_drive(channel); if (length != 1) { PrintError("Invalid Write length on IDE port %x\n", port); return -1; } PrintDebug("IDE: Writing Standard Port %x (val=%x)\n", port, *(uint8_t *)src); switch (port) { // reset and interrupt enable case PRI_CTRL_PORT: case SEC_CTRL_PORT: { struct ide_ctrl_reg * tmp_ctrl = (struct ide_ctrl_reg *)src; // only reset channel on a 0->1 reset bit transition if ((!channel->ctrl_reg.soft_reset) && (tmp_ctrl->soft_reset)) { channel_reset(channel); } else if ((channel->ctrl_reg.soft_reset) && (!tmp_ctrl->soft_reset)) { channel_reset_complete(channel); } channel->ctrl_reg.val = tmp_ctrl->val; break; } case PRI_FEATURES_PORT: case SEC_FEATURES_PORT: channel->features.val = *(uint8_t *)src; break; case PRI_SECT_CNT_PORT: case SEC_SECT_CNT_PORT: drive->sector_count = *(uint8_t *)src; break; case PRI_SECT_NUM_PORT: case SEC_SECT_NUM_PORT: drive->sector_num = *(uint8_t *)src; case PRI_CYL_LOW_PORT: case SEC_CYL_LOW_PORT: drive->cylinder_low = *(uint8_t *)src; break; case PRI_CYL_HIGH_PORT: case SEC_CYL_HIGH_PORT: drive->cylinder_high = *(uint8_t *)src; break; case PRI_DRV_SEL_PORT: case SEC_DRV_SEL_PORT: { channel->drive_head.val = *(uint8_t *)src; // make sure the reserved bits are ok.. // JRL TODO: check with new ramdisk to make sure this is right... channel->drive_head.val |= 0xa0; drive = get_selected_drive(channel); // Selecting a non-present device is a no-no if (drive->drive_type == IDE_NONE) { PrintDebug("Attempting to select a non-present drive\n"); channel->error_reg.abort = 1; channel->status.error = 1; } break; } default: PrintError("IDE: Write to unknown Port %x\n", port); return -1; } return length; } static int read_port_std(ushort_t port, void * dst, uint_t length, struct vm_device * dev) { struct ide_internal * ide = (struct ide_internal *)(dev->private_data); struct ide_channel * channel = get_selected_channel(ide, port); struct ide_drive * drive = get_selected_drive(channel); if (length != 1) { PrintError("Invalid Read length on IDE port %x\n", port); return -1; } PrintDebug("IDE: Reading Standard Port %x\n", port); if ((port == PRI_ADDR_REG_PORT) || (port == SEC_ADDR_REG_PORT)) { // unused, return 0xff *(uint8_t *)dst = 0xff; return length; } // if no drive is present just return 0 + reserved bits if (drive->drive_type == IDE_NONE) { if ((port == PRI_DRV_SEL_PORT) || (port == SEC_DRV_SEL_PORT)) { *(uint8_t *)dst = 0xa0; } else { *(uint8_t *)dst = 0; } return length; } switch (port) { // This is really the error register. case PRI_FEATURES_PORT: case SEC_FEATURES_PORT: *(uint8_t *)dst = channel->error_reg.val; break; case PRI_SECT_CNT_PORT: case SEC_SECT_CNT_PORT: *(uint8_t *)dst = drive->sector_count; break; case PRI_SECT_NUM_PORT: case SEC_SECT_NUM_PORT: *(uint8_t *)dst = drive->sector_num; break; case PRI_CYL_LOW_PORT: case SEC_CYL_LOW_PORT: *(uint8_t *)dst = drive->cylinder_low; break; case PRI_CYL_HIGH_PORT: case SEC_CYL_HIGH_PORT: *(uint8_t *)dst = drive->cylinder_high; break; case PRI_DRV_SEL_PORT: case SEC_DRV_SEL_PORT: // hard disk drive and head register 0x1f6 *(uint8_t *)dst = channel->drive_head.val; break; case PRI_CTRL_PORT: case SEC_CTRL_PORT: case PRI_CMD_PORT: case SEC_CMD_PORT: // Something about lowering interrupts here.... *(uint8_t *)dst = channel->status.val; break; default: PrintError("Invalid Port: %x\n", port); return -1; } PrintDebug("\tVal=%x\n", *(uint8_t *)dst); return length; } static void init_drive(struct ide_drive * drive) { drive->sector_count = 0x01; drive->sector_num = 0x01; drive->cylinder = 0x0000; drive->drive_type = IDE_NONE; memset(drive->model, 0, sizeof(drive->model)); drive->transfer_index = 0; drive->transfer_length = 0; memset(drive->data_buf, 0, sizeof(drive->data_buf)); drive->private_data = NULL; drive->cd_ops = NULL; } static void init_channel(struct ide_channel * channel) { int i = 0; channel->error_reg.val = 0x01; channel->drive_head.val = 0x00; channel->status.val = 0x00; channel->cmd_reg = 0x00; channel->ctrl_reg.val = 0x08; for (i = 0; i < 2; i++) { init_drive(&(channel->drives[i])); } } static void init_ide_state(struct ide_internal * ide) { int i; for (i = 0; i < 2; i++) { init_channel(&(ide->channels[i])); // JRL: this is a terrible hack... ide->channels[i].irq = PRI_DEFAULT_IRQ + i; } } static int init_ide(struct vm_device * dev) { struct ide_internal * ide = (struct ide_internal *)(dev->private_data); PrintDebug("IDE: Initializing IDE\n"); init_ide_state(ide); v3_dev_hook_io(dev, PRI_CTRL_PORT, &read_port_std, &write_port_std); v3_dev_hook_io(dev, PRI_DATA_PORT, &read_data_port, &write_data_port); v3_dev_hook_io(dev, PRI_FEATURES_PORT, &read_port_std, &write_port_std); v3_dev_hook_io(dev, PRI_SECT_CNT_PORT, &read_port_std, &write_port_std); v3_dev_hook_io(dev, PRI_SECT_NUM_PORT, &read_port_std, &write_port_std); v3_dev_hook_io(dev, PRI_CYL_LOW_PORT, &read_port_std, &write_port_std); v3_dev_hook_io(dev, PRI_CYL_HIGH_PORT, &read_port_std, &write_port_std); v3_dev_hook_io(dev, PRI_DRV_SEL_PORT, &read_port_std, &write_port_std); v3_dev_hook_io(dev, PRI_CMD_PORT, &read_port_std, &write_cmd_port); v3_dev_hook_io(dev, SEC_CTRL_PORT, &read_port_std, &write_port_std); v3_dev_hook_io(dev, SEC_DATA_PORT, &read_data_port, &write_data_port); v3_dev_hook_io(dev, SEC_FEATURES_PORT, &read_port_std, &write_port_std); v3_dev_hook_io(dev, SEC_SECT_CNT_PORT, &read_port_std, &write_port_std); v3_dev_hook_io(dev, SEC_SECT_NUM_PORT, &read_port_std, &write_port_std); v3_dev_hook_io(dev, SEC_CYL_LOW_PORT, &read_port_std, &write_port_std); v3_dev_hook_io(dev, SEC_CYL_HIGH_PORT, &read_port_std, &write_port_std); v3_dev_hook_io(dev, SEC_DRV_SEL_PORT, &read_port_std, &write_port_std); v3_dev_hook_io(dev, SEC_CMD_PORT, &read_port_std, &write_cmd_port); v3_dev_hook_io(dev, SEC_ADDR_REG_PORT, &read_port_std, &write_port_std); v3_dev_hook_io(dev, PRI_ADDR_REG_PORT, &read_port_std, &write_port_std); return 0; } static int deinit_ide(struct vm_device * dev) { // unhook io ports.... // deregister from PCI? return 0; } static struct vm_device_ops dev_ops = { .init = init_ide, .deinit = deinit_ide, .reset = NULL, .start = NULL, .stop = NULL, }; struct vm_device * v3_create_ide() { struct ide_internal * ide = (struct ide_internal *)V3_Malloc(sizeof(struct ide_internal)); struct vm_device * device = v3_create_device("IDE", &dev_ops, ide); // ide->pci = pci; PrintDebug("IDE: Creating IDE bus x 2\n"); return device; } int v3_ide_register_cdrom(struct vm_device * ide_dev, uint_t bus_num, uint_t drive_num, char * dev_name, struct v3_ide_cd_ops * ops, void * private_data) { struct ide_internal * ide = (struct ide_internal *)(ide_dev->private_data); struct ide_channel * channel = NULL; struct ide_drive * drive = NULL; V3_ASSERT((bus_num >= 0) && (bus_num < 2)); V3_ASSERT((drive_num >= 0) && (drive_num < 2)); channel = &(ide->channels[bus_num]); drive = &(channel->drives[drive_num]); if (drive->drive_type != IDE_NONE) { PrintError("Device slot (bus=%d, drive=%d) already occupied\n", bus_num, drive_num); return -1; } strncpy(drive->model, dev_name, sizeof(drive->model) - 1); while (strlen((char *)(drive->model)) < 40) { strcat((char*)(drive->model), " "); } drive->drive_type = IDE_CDROM; drive->cd_ops = ops; drive->private_data = private_data; return 0; } int v3_ide_register_harddisk(struct vm_device * ide_dev, uint_t bus_num, uint_t drive_num, char * dev_name, struct v3_ide_hd_ops * ops, void * private_data) { struct ide_internal * ide = (struct ide_internal *)(ide_dev->private_data); struct ide_channel * channel = NULL; struct ide_drive * drive = NULL; V3_ASSERT((bus_num >= 0) && (bus_num < 2)); V3_ASSERT((drive_num >= 0) && (drive_num < 2)); channel = &(ide->channels[bus_num]); drive = &(channel->drives[drive_num]); if (drive->drive_type != IDE_NONE) { PrintError("Device slot (bus=%d, drive=%d) already occupied\n", bus_num, drive_num); return -1; } strncpy(drive->model, dev_name, sizeof(drive->model) - 1); drive->drive_type = IDE_DISK; drive->hd_ops = ops; drive->private_data = private_data; return 0; }