src/flash/s3c2440_nand.c

   1 /***************************************************************************
   2  *   Copyright (C) 2007, 2008 by Ben Dooks                                 *
   3  *   ben@fluff.org                                                         *
   4  *                                                                         *
   5  *   This program is free software; you can redistribute it and/or modify  *
   6  *   it under the terms of the GNU General Public License as published by  *
   7  *   the Free Software Foundation; either version 2 of the License, or     *
   8  *   (at your option) any later version.                                   *
   9  *                                                                         *
  10  *   This program is distributed in the hope that it will be useful,       *
  11  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  12  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  13  *   GNU General Public License for more details.                          *
  14  *                                                                         *
  15  *   You should have received a copy of the GNU General Public License     *
  16  *   along with this program; if not, write to the                         *
  17  *   Free Software Foundation, Inc.,                                       *
  18  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
  19  ***************************************************************************/
  20
  21 /*
  22  * S3C2440 OpenOCD NAND Flash controller support.
  23  *
  24  * Many thanks to Simtec Electronics for sponsoring this work.
  25  */
  26
  27 #ifdef HAVE_CONFIG_H
  28 #include "config.h"
  29 #endif
  30
  31 #include "replacements.h"
  32 #include "log.h"
  33
  34 #include <stdlib.h>
  35 #include <string.h>
  36
  37 #include "nand.h"
  38 #include "s3c24xx_nand.h"
  39 #include "target.h"
  40
  41 int s3c2440_nand_device_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc, struct nand_device_s *device);
  42 int s3c2440_init(struct nand_device_s *device);
  43 int s3c2440_nand_ready(struct nand_device_s *device, int timeout);
  44
  45 nand_flash_controller_t s3c2440_nand_controller =
  46 {
  47         .name                   = "s3c2440",
  48         .nand_device_command    = s3c2440_nand_device_command,
  49         .register_commands      = s3c24xx_register_commands,
  50         .init                   = s3c2440_init,
  51         .reset                  = s3c24xx_reset,
  52         .command                = s3c24xx_command,
  53         .address                = s3c24xx_address,
  54         .write_data             = s3c24xx_write_data,
  55         .read_data              = s3c24xx_read_data,
  56         .write_page             = s3c24xx_write_page,
  57         .read_page              = s3c24xx_read_page,
  58         .write_block_data       = s3c2440_write_block_data,
  59         .read_block_data        = s3c2440_read_block_data,
  60         .controller_ready       = s3c24xx_controller_ready,
  61         .nand_ready             = s3c2440_nand_ready,
  62 };
  63
  64 int s3c2440_nand_device_command(struct command_context_s *cmd_ctx, char *cmd,
  65                                 char **args, int argc,
  66                                 struct nand_device_s *device)
  67 {
  68         s3c24xx_nand_controller_t *info;
  69
  70         info = s3c24xx_nand_device_command(cmd_ctx, cmd, args, argc, device);
  71         if (info == NULL) {
  72                 return ERROR_NAND_DEVICE_INVALID;
  73         }
  74
  75         /* fill in the address fields for the core device */
  76         info->cmd = S3C2440_NFCMD;
  77         info->addr = S3C2440_NFADDR;
  78         info->data = S3C2440_NFDATA;
  79         info->nfstat = S3C2440_NFSTAT;
  80
  81         return ERROR_OK;
  82 }
  83
  84 int s3c2440_init(struct nand_device_s *device)
  85 {
  86         s3c24xx_nand_controller_t *s3c24xx_info = device->controller_priv;
  87         target_t *target = s3c24xx_info->target;
  88
  89         target_write_u32(target, S3C2410_NFCONF,
  90                          S3C2440_NFCONF_TACLS(3) |
  91                          S3C2440_NFCONF_TWRPH0(7) |
  92                          S3C2440_NFCONF_TWRPH1(7));
  93
  94         target_write_u32(target, S3C2440_NFCONT,
  95                          S3C2440_NFCONT_INITECC | S3C2440_NFCONT_ENABLE);
  96
  97         return ERROR_OK;
  98 }
  99
 100 int s3c2440_nand_ready(struct nand_device_s *device, int timeout)
 101 {
 102         s3c24xx_nand_controller_t *s3c24xx_info = device->controller_priv;
 103         target_t *target = s3c24xx_info->target;
 104         u8 status;
 105
 106         if (target->state != TARGET_HALTED) {
 107                 LOG_ERROR("target must be halted to use S3C24XX NAND flash controller");
 108                 return ERROR_NAND_OPERATION_FAILED;
 109         }
 110
 111         do {
 112                 target_read_u8(target, s3c24xx_info->nfstat, &status);
 113
 114                 if (status & S3C2440_NFSTAT_READY)
 115                         return 1;
 116
 117                 alive_sleep(1);
 118         } while (timeout-- > 0);
 119
 120
 121         return 0;
 122 }
 123
 124 /* use the fact we can read/write 4 bytes in one go via a single 32bit op */
 125
 126 int s3c2440_read_block_data(struct nand_device_s *device, u8 *data, int data_size)
 127 {
 128         s3c24xx_nand_controller_t *s3c24xx_info = device->controller_priv;
 129         target_t *target = s3c24xx_info->target;
 130         u32 nfdata = s3c24xx_info->data;
 131         u32 tmp;
 132
 133         LOG_INFO("%s: reading data: %p, %p, %d\n", __func__, device, data, data_size);
 134
 135         if (target->state != TARGET_HALTED) {
 136                 LOG_ERROR("target must be halted to use S3C24XX NAND flash controller");
 137                 return ERROR_NAND_OPERATION_FAILED;
 138         }
 139
 140         while (data_size >= 4) {
 141                 target_read_u32(target, nfdata, &tmp);
 142
 143                 data[0] = tmp;
 144                 data[1] = tmp >> 8;
 145                 data[2] = tmp >> 16;
 146                 data[3] = tmp >> 24;
 147
 148                 data_size -= 4;
 149                 data += 4;
 150         }
 151
 152         while (data_size > 0) {
 153                 target_read_u8(target, nfdata, data);
 154
 155                 data_size -= 1;
 156                 data += 1;
 157         }
 158
 159         return ERROR_OK;
 160 }
 161
 162 int s3c2440_write_block_data(struct nand_device_s *device, u8 *data, int data_size)
 163 {
 164         s3c24xx_nand_controller_t *s3c24xx_info = device->controller_priv;
 165         target_t *target = s3c24xx_info->target;
 166         u32 nfdata = s3c24xx_info->data;
 167         u32 tmp;
 168
 169         if (target->state != TARGET_HALTED) {
 170                 LOG_ERROR("target must be halted to use S3C24XX NAND flash controller");
 171                 return ERROR_NAND_OPERATION_FAILED;
 172         }
 173
 174         while (data_size >= 4) {
 175                 tmp = le_to_h_u32(data);
 176                 target_write_u32(target, nfdata, tmp);
 177
 178                 data_size -= 4;
 179                 data += 4;
 180         }
 181
 182         while (data_size > 0) {
 183                 target_write_u8(target, nfdata, *data);
 184
 185                 data_size -= 1;
 186                 data += 1;
 187         }
 188
 189         return ERROR_OK;
 190 }