src/flash/nand/s3c24xx.h

   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 #ifndef S3C24xx_NAND_H
  22 #define S3C24xx_NAND_H
  23
  24 /*
  25  * S3C24XX Series OpenOCD NAND Flash controller support.
  26  *
  27  * Many thanks to Simtec Electronics for sponsoring this work.
  28  */
  29
  30 #include "imp.h"
  31 #include "s3c24xx_regs.h"
  32 #include <target/target.h>
  33
  34 struct s3c24xx_nand_controller
  35 {
  36         struct target *target;
  37
  38         /* register addresses */
  39         uint32_t                 cmd;
  40         uint32_t                 addr;
  41         uint32_t                 data;
  42         uint32_t                 nfstat;
  43 };
  44
  45 /* Default to using the un-translated NAND register based address */
  46 #undef S3C2410_NFREG
  47 #define S3C2410_NFREG(x) ((x) + 0x4e000000)
  48
  49 #define S3C24XX_DEVICE_COMMAND() \
  50                 COMMAND_HELPER(s3c24xx_nand_device_command, \
  51                                 struct nand_device *nand, \
  52                                 struct s3c24xx_nand_controller **info)
  53
  54 S3C24XX_DEVICE_COMMAND();
  55
  56 #define CALL_S3C24XX_DEVICE_COMMAND(d, i) \
  57         do { \
  58                 int retval = CALL_COMMAND_HANDLER(s3c24xx_nand_device_command, d, i); \
  59                 if (ERROR_OK != retval) \
  60                         return retval; \
  61         } while (0)
  62
  63 int s3c24xx_reset(struct nand_device *nand);
  64
  65 int s3c24xx_command(struct nand_device *nand, uint8_t command);
  66 int s3c24xx_address(struct nand_device *nand, uint8_t address);
  67
  68 int s3c24xx_write_data(struct nand_device *nand, uint16_t data);
  69 int s3c24xx_read_data(struct nand_device *nand, void *data);
  70
  71 int s3c24xx_controller_ready(struct nand_device *nand, int tout);
  72
  73 #define s3c24xx_write_page NULL
  74 #define s3c24xx_read_page NULL
  75
  76 /* code shared between different controllers */
  77
  78 int s3c2440_nand_ready(struct nand_device *nand, int timeout);
  79
  80 int s3c2440_read_block_data(struct nand_device *nand,
  81                 uint8_t *data, int data_size);
  82 int s3c2440_write_block_data(struct nand_device *nand,
  83                 uint8_t *data, int data_size);
  84
  85 #endif // S3C24xx_NAND_H