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  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  18  */
  19 #ifndef __ARM_NANDIO_H
  20 #define __ARM_NANDIO_H
  21
  22 /**
  23  * Available operational states the arm_nand_data struct can be in.
  24  */
  25 enum arm_nand_op {
  26         ARM_NAND_NONE,  /**< No operation performed. */
  27         ARM_NAND_READ,  /**< Read operation performed. */
  28         ARM_NAND_WRITE, /**< Write operation performed. */
  29 };
  30
  31 /**
  32  * The arm_nand_data struct is used for defining NAND I/O operations on an ARM
  33  * core.
  34  */
  35 struct arm_nand_data {
  36         /** Target is proxy for some ARM core. */
  37         struct target *target;
  38
  39         /** The copy area holds code loop and data for I/O operations. */
  40         struct working_area *copy_area;
  41
  42         /** The chunk size is the page size or ECC chunk. */
  43         unsigned chunk_size;
  44
  45         /** Where data is read from or written to. */
  46         uint32_t data;
  47
  48         /** Last operation executed using this struct. */
  49         enum arm_nand_op op;
  50
  51         /* currently implicit:  data width == 8 bits (not 16) */
  52 };
  53
  54 int arm_nandwrite(struct arm_nand_data *nand, uint8_t *data, int size);
  55 int arm_nandread(struct arm_nand_data *nand, uint8_t *data, uint32_t size);
  56
  57 #endif  /* __ARM_NANDIO_H */