src/flash/nand/arm_io.h

   1 /* SPDX-License-Identifier: GPL-2.0-or-later */
   2
   3 /*
   4  * Copyright (C) 2009 by David Brownell
   5  */
   6 #ifndef OPENOCD_FLASH_NAND_ARM_IO_H
   7 #define OPENOCD_FLASH_NAND_ARM_IO_H
   8
   9 /**
  10  * Available operational states the arm_nand_data struct can be in.
  11  */
  12 enum arm_nand_op {
  13         ARM_NAND_NONE,  /**< No operation performed. */
  14         ARM_NAND_READ,  /**< Read operation performed. */
  15         ARM_NAND_WRITE, /**< Write operation performed. */
  16 };
  17
  18 /**
  19  * The arm_nand_data struct is used for defining NAND I/O operations on an ARM
  20  * core.
  21  */
  22 struct arm_nand_data {
  23         /** Target is proxy for some ARM core. */
  24         struct target *target;
  25
  26         /** The copy area holds code loop and data for I/O operations. */
  27         struct working_area *copy_area;
  28
  29         /** The chunk size is the page size or ECC chunk. */
  30         unsigned chunk_size;
  31
  32         /** Where data is read from or written to. */
  33         uint32_t data;
  34
  35         /** Last operation executed using this struct. */
  36         enum arm_nand_op op;
  37
  38         /* currently implicit:  data width == 8 bits (not 16) */
  39 };
  40
  41 int arm_nandwrite(struct arm_nand_data *nand, uint8_t *data, int size);
  42 int arm_nandread(struct arm_nand_data *nand, uint8_t *data, uint32_t size);
  43
  44 #endif /* OPENOCD_FLASH_NAND_ARM_IO_H */