git.sur5r.net Git - openocd/blob - src/flash/nand/arm_io.h

   1 /*
   2  * Copyright (C) 2009 by David Brownell
   3  *
   4  * This program is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation; either version 2 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program; if not, write to the
  16  * Free Software Foundation, Inc.,
  17  * 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  18  */
  19 #ifndef __ARM_NANDIO_H
  20 #define __ARM_NANDIO_H
  21
  22 #include <flash/nand.h>
  23 #include <helper/binarybuffer.h>
  24
  25 /**
  26  * Available operational states the arm_nand_data struct can be in.
  27  */
  28 enum arm_nand_op {
  29         ARM_NAND_NONE, /**< No operation performed. */
  30         ARM_NAND_READ, /**< Read operation performed. */
  31         ARM_NAND_WRITE, /**< Write operation performed. */
  32 };
  33
  34 /**
  35  * The arm_nand_data struct is used for defining NAND I/O operations on an ARM
  36  * core.
  37  */
  38 struct arm_nand_data {
  39         /** Target is proxy for some ARM core. */
  40         struct target *target;
  41
  42         /** The copy area holds code loop and data for I/O operations. */
  43         struct working_area     *copy_area;
  44
  45         /** The chunk size is the page size or ECC chunk. */
  46         unsigned chunk_size;
  47
  48         /** Where data is read from or written to. */
  49         uint32_t data;
  50
  51         /** Last operation executed using this struct. */
  52         enum arm_nand_op op;
  53
  54         /* currently implicit:  data width == 8 bits (not 16) */
  55 };
  56
  57 int arm_nandwrite(struct arm_nand_data *nand, uint8_t *data, int size);
  58 int arm_nandread(struct arm_nand_data *nand, uint8_t *data, uint32_t size);
  59
  60 #endif /* __ARM_NANDIO_H */