drivers/systemace.c

   1 /*
   2  * Copyright (c) 2004 Picture Elements, Inc.
   3  *    Stephen Williams (XXXXXXXXXXXXXXXX)
   4  *
   5  *    This source code is free software; you can redistribute it
   6  *    and/or modify it in source code form under the terms of the GNU
   7  *    General Public License as published by the Free Software
   8  *    Foundation; either version 2 of the License, or (at your option)
   9  *    any later version.
  10  *
  11  *    This program is distributed in the hope that it will be useful,
  12  *    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  *    GNU General Public License for more details.
  15  *
  16  *    You should have received a copy of the GNU General Public License
  17  *    along with this program; if not, write to the Free Software
  18  *    Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
  19  */
  20
  21 /*
  22  * The Xilinx SystemACE chip support is activated by defining
  23  * CONFIG_SYSTEMACE to turn on support, and CFG_SYSTEMACE_BASE
  24  * to set the base address of the device. This code currently
  25  * assumes that the chip is connected via a byte-wide bus.
  26  *
  27  * The CONFIG_SYSTEMACE also adds to fat support the device class
  28  * "ace" that allows the user to execute "fatls ace 0" and the
  29  * like. This works by making the systemace_get_dev function
  30  * available to cmd_fat.c:get_dev and filling in a block device
  31  * description that has all the bits needed for FAT support to
  32  * read sectors.
  33  *
  34  * According to Xilinx technical support, before accessing the
  35  * SystemACE CF you need to set the following control bits:
  36  *      FORCECFGMODE : 1
  37  *      CFGMODE : 0
  38  *      CFGSTART : 0
  39  */
  40
  41 #include <common.h>
  42 #include <command.h>
  43 #include <systemace.h>
  44 #include <part.h>
  45 #include <asm/io.h>
  46
  47 #ifdef CONFIG_SYSTEMACE
  48
  49 /*
  50  * The ace_readw and writew functions read/write 16bit words, but the
  51  * offset value is the BYTE offset as most used in the Xilinx
  52  * datasheet for the SystemACE chip. The CFG_SYSTEMACE_BASE is defined
  53  * to be the base address for the chip, usually in the local
  54  * peripheral bus.
  55  */
  56 #if (CFG_SYSTEMACE_WIDTH == 8)
  57 #if !defined(__BIG_ENDIAN)
  58 #define ace_readw(off) ((readb(CFG_SYSTEMACE_BASE+off)<<8) | \
  59                         (readb(CFG_SYSTEMACE_BASE+off+1)))
  60 #define ace_writew(val, off) {writeb(val>>8, CFG_SYSTEMACE_BASE+off); \
  61                               writeb(val, CFG_SYSTEMACE_BASE+off+1);}
  62 #else
  63 #define ace_readw(off) ((readb(CFG_SYSTEMACE_BASE+off)) | \
  64                         (readb(CFG_SYSTEMACE_BASE+off+1)<<8))
  65 #define ace_writew(val, off) {writeb(val, CFG_SYSTEMACE_BASE+off); \
  66                               writeb(val>>8, CFG_SYSTEMACE_BASE+off+1);}
  67 #endif
  68 #else
  69 #define ace_readw(off) (in16(CFG_SYSTEMACE_BASE+off))
  70 #define ace_writew(val, off) (out16(CFG_SYSTEMACE_BASE+off,val))
  71 #endif
  72
  73 /* */
  74
  75 static unsigned long systemace_read(int dev, unsigned long start,
  76                                     unsigned long blkcnt, void *buffer);
  77
  78 static block_dev_desc_t systemace_dev = { 0 };
  79
  80 static int get_cf_lock(void)
  81 {
  82         int retry = 10;
  83
  84         /* CONTROLREG = LOCKREG */
  85         unsigned val = ace_readw(0x18);
  86         val |= 0x0002;
  87         ace_writew((val & 0xffff), 0x18);
  88
  89         /* Wait for MPULOCK in STATUSREG[15:0] */
  90         while (!(ace_readw(0x04) & 0x0002)) {
  91
  92                 if (retry < 0)
  93                         return -1;
  94
  95                 udelay(100000);
  96                 retry -= 1;
  97         }
  98
  99         return 0;
 100 }
 101
 102 static void release_cf_lock(void)
 103 {
 104         unsigned val = ace_readw(0x18);
 105         val &= ~(0x0002);
 106         ace_writew((val & 0xffff), 0x18);
 107 }
 108
 109 block_dev_desc_t *systemace_get_dev(int dev)
 110 {
 111         /* The first time through this, the systemace_dev object is
 112            not yet initialized. In that case, fill it in. */
 113         if (systemace_dev.blksz == 0) {
 114                 systemace_dev.if_type = IF_TYPE_UNKNOWN;
 115                 systemace_dev.dev = 0;
 116                 systemace_dev.part_type = PART_TYPE_UNKNOWN;
 117                 systemace_dev.type = DEV_TYPE_HARDDISK;
 118                 systemace_dev.blksz = 512;
 119                 systemace_dev.removable = 1;
 120                 systemace_dev.block_read = systemace_read;
 121
 122 #if (CFG_SYSTEMACE_WIDTH == 16)
 123                 /*
 124                  * By default the SystemACE comes up in 8-bit mode.
 125                  * Ensure that 16-bit mode gets enabled.
 126                  */
 127                 ace_writew(0x0001, 0);
 128 #endif
 129
 130                 init_part(&systemace_dev);
 131
 132         }
 133
 134         return &systemace_dev;
 135 }
 136
 137 /*
 138  * This function is called (by dereferencing the block_read pointer in
 139  * the dev_desc) to read blocks of data. The return value is the
 140  * number of blocks read. A zero return indicates an error.
 141  */
 142 static unsigned long systemace_read(int dev, unsigned long start,
 143                                     unsigned long blkcnt, void *buffer)
 144 {
 145         int retry;
 146         unsigned blk_countdown;
 147         unsigned char *dp = buffer;
 148         unsigned val;
 149
 150         if (get_cf_lock() < 0) {
 151                 unsigned status = ace_readw(0x04);
 152
 153                 /* If CFDETECT is false, card is missing. */
 154                 if (!(status & 0x0010)) {
 155                         printf("** CompactFlash card not present. **\n");
 156                         return 0;
 157                 }
 158
 159                 printf("**** ACE locked away from me (STATUSREG=%04x)\n",
 160                        status);
 161                 return 0;
 162         }
 163 #ifdef DEBUG_SYSTEMACE
 164         printf("... systemace read %lu sectors at %lu\n", blkcnt, start);
 165 #endif
 166
 167         retry = 2000;
 168         for (;;) {
 169                 val = ace_readw(0x04);
 170
 171                 /* If CFDETECT is false, card is missing. */
 172                 if (!(val & 0x0010)) {
 173                         printf("**** ACE CompactFlash not found.\n");
 174                         release_cf_lock();
 175                         return 0;
 176                 }
 177
 178                 /* If RDYFORCMD, then we are ready to go. */
 179                 if (val & 0x0100)
 180                         break;
 181
 182                 if (retry < 0) {
 183                         printf("**** SystemACE not ready.\n");
 184                         release_cf_lock();
 185                         return 0;
 186                 }
 187
 188                 udelay(1000);
 189                 retry -= 1;
 190         }
 191
 192         /* The SystemACE can only transfer 256 sectors at a time, so
 193            limit the current chunk of sectors. The blk_countdown
 194            variable is the number of sectors left to transfer. */
 195
 196         blk_countdown = blkcnt;
 197         while (blk_countdown > 0) {
 198                 unsigned trans = blk_countdown;
 199
 200                 if (trans > 256)
 201                         trans = 256;
 202
 203 #ifdef DEBUG_SYSTEMACE
 204                 printf("... transfer %lu sector in a chunk\n", trans);
 205 #endif
 206                 /* Write LBA block address */
 207                 ace_writew((start >> 0) & 0xffff, 0x10);
 208                 ace_writew((start >> 16) & 0x0fff, 0x12);
 209
 210                 /* NOTE: in the Write Sector count below, a count of 0
 211                    causes a transfer of 256, so &0xff gives the right
 212                    value for whatever transfer count we want. */
 213
 214                 /* Write sector count | ReadMemCardData. */
 215                 ace_writew((trans & 0xff) | 0x0300, 0x14);
 216
 217                 /* Reset the configruation controller */
 218                 val = ace_readw(0x18);
 219                 val |= 0x0080;
 220                 ace_writew(val, 0x18);
 221
 222                 retry = trans * 16;
 223                 while (retry > 0) {
 224                         int idx;
 225
 226                         /* Wait for buffer to become ready. */
 227                         while (!(ace_readw(0x04) & 0x0020)) {
 228                                 udelay(100);
 229                         }
 230
 231                         /* Read 16 words of 2bytes from the sector buffer. */
 232                         for (idx = 0; idx < 16; idx += 1) {
 233                                 unsigned short val = ace_readw(0x40);
 234                                 *dp++ = val & 0xff;
 235                                 *dp++ = (val >> 8) & 0xff;
 236                         }
 237
 238                         retry -= 1;
 239                 }
 240
 241                 /* Clear the configruation controller reset */
 242                 val = ace_readw(0x18);
 243                 val &= ~0x0080;
 244                 ace_writew(val, 0x18);
 245
 246                 /* Count the blocks we transfer this time. */
 247                 start += trans;
 248                 blk_countdown -= trans;
 249         }
 250
 251         release_cf_lock();
 252
 253         return blkcnt;
 254 }
 255 #endif /* CONFIG_SYSTEMACE */