update files to correct FSF address
[fw/openocd] / src / flash / nand / fileio.h
1 /***************************************************************************
2  *   Copyright (C) 2009 Zachary T Welch <zw@superlucidity.net>             *
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
20 #ifndef FLASH_NAND_FILEIO_H
21 #define FLASH_NAND_FILEIO_H
22
23 #include <helper/time_support.h>
24 #include <helper/fileio.h>
25
26 struct nand_fileio_state {
27         uint32_t address;
28         uint32_t size;
29
30         uint8_t *page;
31         uint32_t page_size;
32
33         enum oob_formats oob_format;
34         uint8_t *oob;
35         uint32_t oob_size;
36
37         const int *eccpos;
38
39         bool file_opened;
40         struct fileio fileio;
41
42         struct duration bench;
43 };
44
45 void nand_fileio_init(struct nand_fileio_state *state);
46 int nand_fileio_start(struct command_context *cmd_ctx,
47                 struct nand_device *nand, const char *filename, int filemode,
48                 struct nand_fileio_state *state);
49 int nand_fileio_cleanup(struct nand_fileio_state *state);
50 int nand_fileio_finish(struct nand_fileio_state *state);
51
52 COMMAND_HELPER(nand_fileio_parse_args, struct nand_fileio_state *state,
53         struct nand_device **dev, enum fileio_access filemode,
54         bool need_size, bool sw_ecc);
55
56 int nand_fileio_read(struct nand_device *nand, struct nand_fileio_state *s);
57
58 #endif  /* FLASH_NAND_FILEIO_H */