/*************************************************************************** * __________ __ ___. * Open \______ \ ____ ____ | | _\_ |__ _______ ___ * Source | _// _ \_/ ___\| |/ /| __ \ / _ \ \/ / * Jukebox | | ( <_> ) \___| < | \_\ ( <_> > < < * Firmware |____|_ /\____/ \___ >__|_ \|___ /\____/__/\_ \ * \/ \/ \/ \/ \/ * $Id$ * * Copyright (C) 2002 by Alan Korr * * This program is free software; you can redistribute it and/or * modify it under the terms of the GNU General Public License * as published by the Free Software Foundation; either version 2 * of the License, or (at your option) any later version. * * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY * KIND, either express or implied. * ****************************************************************************/ #include #include "ata.h" #include "kernel.h" #include "thread.h" #include "led.h" #include "cpu.h" #include "system.h" #include "debug.h" #include "panic.h" #include "usb.h" #include "power.h" #include "string.h" #include "ata_idle_notify.h" #include "ata-target.h" #include "storage.h" #define SECTOR_SIZE (512) #define ATA_FEATURE ATA_ERROR #define ATA_STATUS ATA_COMMAND #define ATA_ALT_STATUS ATA_CONTROL #define SELECT_DEVICE1 0x10 #define SELECT_LBA 0x40 #define CONTROL_nIEN 0x02 #define CONTROL_SRST 0x04 #define CMD_READ_SECTORS 0x20 #define CMD_WRITE_SECTORS 0x30 #define CMD_WRITE_SECTORS_EXT 0x34 #define CMD_READ_MULTIPLE 0xC4 #define CMD_READ_MULTIPLE_EXT 0x29 #define CMD_WRITE_MULTIPLE 0xC5 #define CMD_SET_MULTIPLE_MODE 0xC6 #define CMD_STANDBY_IMMEDIATE 0xE0 #define CMD_STANDBY 0xE2 #define CMD_IDENTIFY 0xEC #define CMD_SLEEP 0xE6 #define CMD_SET_FEATURES 0xEF #define CMD_SECURITY_FREEZE_LOCK 0xF5 /* Should all be < 0x100 (which are reserved for control messages) */ #define Q_SLEEP 0 #define Q_CLOSE 1 #define READ_TIMEOUT 5*HZ #ifdef HAVE_ATA_POWER_OFF #define ATA_POWER_OFF_TIMEOUT 2*HZ #endif #ifdef ATA_DRIVER_CLOSE static unsigned int ata_thread_id = 0; #endif #if defined(MAX_PHYS_SECTOR_SIZE) && MEM == 64 /* Hack - what's the deal with 5g? */ struct ata_lock { struct thread_entry *thread; int count; volatile unsigned char locked; IF_COP( struct corelock cl; ) }; static void ata_lock_init(struct ata_lock *l) { corelock_init(&l->cl); l->locked = 0; l->count = 0; l->thread = NULL; } static void ata_lock_lock(struct ata_lock *l) { struct thread_entry * const current = thread_id_entry(THREAD_ID_CURRENT); if (current == l->thread) { l->count++; return; } corelock_lock(&l->cl); IF_PRIO( current->skip_count = -1; ) while (l->locked != 0) { corelock_unlock(&l->cl); switch_thread(); corelock_lock(&l->cl); } l->locked = 1; l->thread = current; corelock_unlock(&l->cl); } static void ata_lock_unlock(struct ata_lock *l) { if (l->count > 0) { l->count--; return; } corelock_lock(&l->cl); IF_PRIO( l->thread->skip_count = 0; ) l->thread = NULL; l->locked = 0; corelock_unlock(&l->cl); } #define mutex ata_lock #define mutex_init ata_lock_init #define mutex_lock ata_lock_lock #define mutex_unlock ata_lock_unlock #endif /* MAX_PHYS_SECTOR_SIZE */ #if defined(HAVE_USBSTACK) && defined(USE_ROCKBOX_USB) #define ALLOW_USB_SPINDOWN #endif static struct mutex ata_mtx SHAREDBSS_ATTR; static int ata_device; /* device 0 (master) or 1 (slave) */ static int spinup_time = 0; #if (CONFIG_LED == LED_REAL) static bool ata_led_enabled = true; static bool ata_led_on = false; #endif static bool spinup = false; static bool sleeping = true; static bool poweroff = false; static long sleep_timeout = 5*HZ; #ifdef HAVE_LBA48 static bool lba48 = false; /* set for 48 bit addressing */ #endif static long ata_stack[(DEFAULT_STACK_SIZE*3)/sizeof(long)]; static const char ata_thread_name[] = "ata"; static struct event_queue ata_queue SHAREDBSS_ATTR; static bool initialized = false; static long last_user_activity = -1; static long last_disk_activity = -1; static unsigned long total_sectors; static int multisectors; /* number of supported multisectors */ static unsigned short identify_info[SECTOR_SIZE/2]; #ifdef MAX_PHYS_SECTOR_SIZE struct sector_cache_entry { bool inuse; unsigned long sectornum; /* logical sector */ unsigned char data[MAX_PHYS_SECTOR_SIZE]; }; /* buffer for reading and writing large physical sectors */ #define NUMCACHES 2 static struct sector_cache_entry sector_cache; static int phys_sector_mult = 1; #endif static int ata_power_on(void); static int perform_soft_reset(void); static int set_multiple_mode(int sectors); static int set_features(void); STATICIRAM ICODE_ATTR int wait_for_bsy(void) { long timeout = current_tick + HZ*30; do { if (!(ATA_STATUS & STATUS_BSY)) return 1; last_disk_activity = current_tick; yield(); } while (TIME_BEFORE(current_tick, timeout)); return 0; /* timeout */ } STATICIRAM ICODE_ATTR int wait_for_rdy(void) { long timeout; if (!wait_for_bsy()) return 0; timeout = current_tick + HZ*10; do { if (ATA_ALT_STATUS & STATUS_RDY) return 1; last_disk_activity = current_tick; yield(); } while (TIME_BEFORE(current_tick, timeout)); return 0; /* timeout */ } STATICIRAM ICODE_ATTR int wait_for_start_of_transfer(void) { if (!wait_for_bsy()) return 0; return (ATA_ALT_STATUS & (STATUS_BSY|STATUS_DRQ)) == STATUS_DRQ; } STATICIRAM ICODE_ATTR int wait_for_end_of_transfer(void) { if (!wait_for_bsy()) return 0; return (ATA_ALT_STATUS & (STATUS_RDY|STATUS_DRQ)) == STATUS_RDY; } #if (CONFIG_LED == LED_REAL) /* Conditionally block LED access for the ATA driver, so the LED can be * (mis)used for other purposes */ static void ata_led(bool on) { ata_led_on = on; if (ata_led_enabled) led(ata_led_on); } #else #define ata_led(on) led(on) #endif #ifndef ATA_OPTIMIZED_READING STATICIRAM ICODE_ATTR void copy_read_sectors(unsigned char* buf, int wordcount) { unsigned short tmp = 0; if ( (unsigned long)buf & 1) { /* not 16-bit aligned, copy byte by byte */ unsigned char* bufend = buf + wordcount*2; do { tmp = ATA_DATA; #if defined(SWAP_WORDS) || defined(ROCKBOX_LITTLE_ENDIAN) *buf++ = tmp & 0xff; /* I assume big endian */ *buf++ = tmp >> 8; /* and don't use the SWAB16 macro */ #else *buf++ = tmp >> 8; *buf++ = tmp & 0xff; #endif } while (buf < bufend); /* tail loop is faster */ } else { /* 16-bit aligned, can do faster copy */ unsigned short* wbuf = (unsigned short*)buf; unsigned short* wbufend = wbuf + wordcount; do { #ifdef SWAP_WORDS *wbuf = swap16(ATA_DATA); #else *wbuf = ATA_DATA; #endif } while (++wbuf < wbufend); /* tail loop is faster */ } } #endif /* !ATA_OPTIMIZED_READING */ #ifdef MAX_PHYS_SECTOR_SIZE static int _read_sectors(unsigned long start, int incount, void* inbuf) #else int ata_read_sectors(IF_MV2(int drive,) unsigned long start, int incount, void* inbuf) #endif { int ret = 0; long timeout; int count; void* buf; long spinup_start; #ifndef MAX_PHYS_SECTOR_SIZE #ifdef HAVE_MULTIVOLUME (void)drive; /* unused for now */ #endif mutex_lock(&ata_mtx); #endif if (start + incount > total_sectors) { ret = -1; goto error; } last_disk_activity = current_tick; spinup_start = current_tick; ata_led(true); if ( sleeping ) { spinup = true; if (poweroff) { if (ata_power_on()) { ret = -2; goto error; } } else { if (perform_soft_reset()) { ret = -2; goto error; } } } timeout = current_tick + READ_TIMEOUT; SET_REG(ATA_SELECT, ata_device); if (!wait_for_rdy()) { ret = -3; goto error; } retry: buf = inbuf; count = incount; while (TIME_BEFORE(current_tick, timeout)) { ret = 0; last_disk_activity = current_tick; #ifdef HAVE_LBA48 if (lba48) { SET_REG(ATA_NSECTOR, count >> 8); SET_REG(ATA_NSECTOR, count & 0xff); SET_REG(ATA_SECTOR, (start >> 24) & 0xff); /* 31:24 */ SET_REG(ATA_SECTOR, start & 0xff); /* 7:0 */ SET_REG(ATA_LCYL, 0); /* 39:32 */ SET_REG(ATA_LCYL, (start >> 8) & 0xff); /* 15:8 */ SET_REG(ATA_HCYL, 0); /* 47:40 */ SET_REG(ATA_HCYL, (start >> 16) & 0xff); /* 23:16 */ SET_REG(ATA_SELECT, SELECT_LBA | ata_device); SET_REG(ATA_COMMAND, CMD_READ_MULTIPLE_EXT); } else #endif { SET_REG(ATA_NSECTOR, count & 0xff); /* 0 means 256 sectors */ SET_REG(ATA_SECTOR, start & 0xff); SET_REG(ATA_LCYL, (start >> 8) & 0xff); SET_REG(ATA_HCYL, (start >> 16) & 0xff); SET_REG(ATA_SELECT, ((start >> 24) & 0xf) | SELECT_LBA | ata_device); SET_REG(ATA_COMMAND, CMD_READ_MULTIPLE); } /* wait at least 400ns between writing command and reading status */ __asm__ volatile ("nop"); __asm__ volatile ("nop"); __asm__ volatile ("nop"); __asm__ volatile ("nop"); __asm__ volatile ("nop"); while (count) { int sectors; int wordcount; int status; if (!wait_for_start_of_transfer()) { /* We have timed out waiting for RDY and/or DRQ, possibly because the hard drive is shaking and has problems reading the data. We have two options: 1) Wait some more 2) Perform a soft reset and try again. We choose alternative 2. */ perform_soft_reset(); ret = -5; goto retry; } if (spinup) { spinup_time = current_tick - spinup_start; spinup = false; sleeping = false; poweroff = false; } /* read the status register exactly once per loop */ status = ATA_STATUS; if (count >= multisectors ) sectors = multisectors; else sectors = count; wordcount = sectors * SECTOR_SIZE / 2; copy_read_sectors(buf, wordcount); /* "Device errors encountered during READ MULTIPLE commands are posted at the beginning of the block or partial block transfer, but the DRQ bit is still set to one and the data transfer shall take place, including transfer of corrupted data, if any." -- ATA specification */ if ( status & (STATUS_BSY | STATUS_ERR | STATUS_DF) ) { perform_soft_reset(); ret = -6; goto retry; } buf += sectors * SECTOR_SIZE; /* Advance one chunk of sectors */ count -= sectors; last_disk_activity = current_tick; } if(!ret && !wait_for_end_of_transfer()) { perform_soft_reset(); ret = -4; goto retry; } break; } error: ata_led(false); #ifndef MAX_PHYS_SECTOR_SIZE mutex_unlock(&ata_mtx); #endif return ret; } #ifndef ATA_OPTIMIZED_WRITING STATICIRAM ICODE_ATTR void copy_write_sectors(const unsigned char* buf, int wordcount) { if ( (unsigned long)buf & 1) { /* not 16-bit aligned, copy byte by byte */ unsigned short tmp = 0; const unsigned char* bufend = buf + wordcount*2; do { #if defined(SWAP_WORDS) || defined(ROCKBOX_LITTLE_ENDIAN) tmp = (unsigned short) *buf++; tmp |= (unsigned short) *buf++ << 8; SET_16BITREG(ATA_DATA, tmp); #else tmp = (unsigned short) *buf++ << 8; tmp |= (unsigned short) *buf++; SET_16BITREG(ATA_DATA, tmp); #endif } while (buf < bufend); /* tail loop is faster */ } else { /* 16-bit aligned, can do faster copy */ unsigned short* wbuf = (unsigned short*)buf; unsigned short* wbufend = wbuf + wordcount; do { #ifdef SWAP_WORDS SET_16BITREG(ATA_DATA, swap16(*wbuf)); #else SET_16BITREG(ATA_DATA, *wbuf); #endif } while (++wbuf < wbufend); /* tail loop is faster */ } } #endif /* !ATA_OPTIMIZED_WRITING */ #ifdef MAX_PHYS_SECTOR_SIZE static int _write_sectors(unsigned long start, int count, const void* buf) #else int ata_write_sectors(IF_MV2(int drive,) unsigned long start, int count, const void* buf) #endif { int i; int ret = 0; long spinup_start; #ifndef MAX_PHYS_SECTOR_SIZE #ifdef HAVE_MULTIVOLUME (void)drive; /* unused for now */ #endif mutex_lock(&ata_mtx); #endif if (start + count > total_sectors) panicf("Writing past end of disk"); last_disk_activity = current_tick; spinup_start = current_tick; ata_led(true); if ( sleeping ) { spinup = true; if (poweroff) { if (ata_power_on()) { ret = -1; goto error; } } else { if (perform_soft_reset()) { ret = -1; goto error; } } } SET_REG(ATA_SELECT, ata_device); if (!wait_for_rdy()) { ret = -2; goto error; } #ifdef HAVE_LBA48 if (lba48) { SET_REG(ATA_NSECTOR, count >> 8); SET_REG(ATA_NSECTOR, count & 0xff); SET_REG(ATA_SECTOR, (start >> 24) & 0xff); /* 31:24 */ SET_REG(ATA_SECTOR, start & 0xff); /* 7:0 */ SET_REG(ATA_LCYL, 0); /* 39:32 */ SET_REG(ATA_LCYL, (start >> 8) & 0xff); /* 15:8 */ SET_REG(ATA_HCYL, 0); /* 47:40 */ SET_REG(ATA_HCYL, (start >> 16) & 0xff); /* 23:16 */ SET_REG(ATA_SELECT, SELECT_LBA | ata_device); SET_REG(ATA_COMMAND, CMD_WRITE_SECTORS_EXT); } else #endif { SET_REG(ATA_NSECTOR, count & 0xff); /* 0 means 256 sectors */ SET_REG(ATA_SECTOR, start & 0xff); SET_REG(ATA_LCYL, (start >> 8) & 0xff); SET_REG(ATA_HCYL, (start >> 16) & 0xff); SET_REG(ATA_SELECT, ((start >> 24) & 0xf) | SELECT_LBA | ata_device); SET_REG(ATA_COMMAND, CMD_WRITE_SECTORS); } for (i=0; i Flash interface automatically sleeps almost immediately after the * last command. */ int ret; int retry_count; SET_REG(ATA_SELECT, SELECT_LBA | ata_device ); SET_REG(ATA_CONTROL, CONTROL_nIEN|CONTROL_SRST ); sleep(1); /* >= 5us */ SET_REG(ATA_CONTROL, CONTROL_nIEN); sleep(1); /* >2ms */ /* This little sucker can take up to 30 seconds */ retry_count = 8; do { ret = wait_for_rdy(); } while(!ret && retry_count--); if (!ret) return -1; if (set_features()) return -2; if (set_multiple_mode(multisectors)) return -3; if (freeze_lock()) return -4; return 0; } int ata_soft_reset(void) { int ret; mutex_lock(&ata_mtx); ret = perform_soft_reset(); mutex_unlock(&ata_mtx); return ret; } static int ata_power_on(void) { int rc; ide_power_enable(true); sleep(HZ/4); /* allow voltage to build up */ /* Accessing the PP IDE controller too early after powering up the disk * makes the core hang for a short time, causing an audio dropout. This * also depends on the disk; iPod Mini G2 needs at least HZ/5 to get rid * of the dropout. Since this time isn't additive (the wait_for_bsy() in * ata_hard_reset() will shortened by the same amount), it's a good idea * to do this on all HDD based targets. */ if( ata_hard_reset() ) return -1; rc = set_features(); if (rc) return rc * 10 - 2; if (set_multiple_mode(multisectors)) return -3; if (freeze_lock()) return -4; return 0; } static int master_slave_detect(void) { /* master? */ SET_REG(ATA_SELECT, 0); if ( ATA_STATUS & (STATUS_RDY|STATUS_BSY) ) { ata_device = 0; DEBUGF("Found master harddisk\n"); } else { /* slave? */ SET_REG(ATA_SELECT, SELECT_DEVICE1); if ( ATA_STATUS & (STATUS_RDY|STATUS_BSY) ) { ata_device = SELECT_DEVICE1; DEBUGF("Found slave harddisk\n"); } else return -1; } return 0; } static int identify(void) { int i; SET_REG(ATA_SELECT, ata_device); if(!wait_for_rdy()) { DEBUGF("identify() - not RDY\n"); return -1; } SET_REG(ATA_COMMAND, CMD_IDENTIFY); if (!wait_for_start_of_transfer()) { DEBUGF("identify() - CMD failed\n"); return -2; } for (i=0; i second try, always with hard reset */ DEBUGF("ata: init failed, retrying...\n"); rc = init_and_check(true); if (rc) return rc; } rc = identify(); if (rc) return -40 + rc; multisectors = identify_info[47] & 0xff; if (multisectors == 0) /* Invalid multisector info, try with 16 */ multisectors = 16; DEBUGF("ata: %d sectors per ata request\n",multisectors); #ifdef MAX_PHYS_SECTOR_SIZE /* Find out the physical sector size */ if((identify_info[106] & 0xe000) == 0x6000) phys_sector_mult = 1 << (identify_info[106] & 0x000f); else phys_sector_mult = 1; DEBUGF("ata: %d logical sectors per phys sector", phys_sector_mult); if (phys_sector_mult > (MAX_PHYS_SECTOR_SIZE/SECTOR_SIZE)) panicf("Unsupported physical sector size: %d", phys_sector_mult * SECTOR_SIZE); #endif total_sectors = identify_info[60] | (identify_info[61] << 16); #ifdef HAVE_LBA48 if (identify_info[83] & 0x0400 /* 48 bit address support */ && total_sectors == 0x0FFFFFFF) /* and disk size >= 128 GiB */ { /* (needs BigLBA addressing) */ if (identify_info[102] || identify_info[103]) panicf("Unsupported disk size: >= 2^32 sectors"); total_sectors = identify_info[100] | (identify_info[101] << 16); lba48 = true; /* use BigLBA */ } #endif rc = freeze_lock(); if (rc) return -50 + rc; rc = set_features(); if (rc) return -60 + rc; mutex_lock(&ata_mtx); /* Balance unlock below */ last_disk_activity = current_tick; #ifdef ATA_DRIVER_CLOSE ata_thread_id = #endif create_thread(ata_thread, ata_stack, sizeof(ata_stack), 0, ata_thread_name IF_PRIO(, PRIORITY_USER_INTERFACE) IF_COP(, CPU)); initialized = true; } rc = set_multiple_mode(multisectors); if (rc) rc = -70 + rc; mutex_unlock(&ata_mtx); return rc; } #ifdef ATA_DRIVER_CLOSE void ata_close(void) { unsigned int thread_id = ata_thread_id; if (thread_id == 0) return; ata_thread_id = 0; queue_post(&ata_queue, Q_CLOSE, 0); thread_wait(thread_id); } #endif /* ATA_DRIVER_CLOSE */ #if (CONFIG_LED == LED_REAL) void ata_set_led_enabled(bool enabled) { ata_led_enabled = enabled; if (ata_led_enabled) led(ata_led_on); else led(false); } #endif long ata_last_disk_activity(void) { return last_disk_activity; } int ata_spinup_time(void) { return spinup_time; } #ifdef STORAGE_GET_INFO void ata_get_info(struct storage_info *info) { unsigned short *src,*dest; static char vendor[8]; static char product[16]; static char revision[4]; int i; info->sector_size = SECTOR_SIZE; info->num_sectors= ((unsigned long)identify_info[61] << 16 | \ (unsigned long)identify_info[60]); src = (unsigned short*)&identify_info[27]; dest = (unsigned short*)vendor; for (i=0;i<4;i++) dest[i] = htobe16(src[i]); info->vendor=vendor; src = (unsigned short*)&identify_info[31]; dest = (unsigned short*)product; for (i=0;i<8;i++) dest[i] = htobe16(src[i]); info->product=product; src = (unsigned short*)&identify_info[23]; dest = (unsigned short*)revision; for (i=0;i<2;i++) dest[i] = htobe16(src[i]); info->revision=revision; } #endif