Remove FSF address from GPL notices
[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, see <http://www.gnu.org/licenses/>. *
16  ***************************************************************************/
17
18 #ifndef FLASH_NAND_FILEIO_H
19 #define FLASH_NAND_FILEIO_H
20
21 #include <helper/time_support.h>
22 #include <helper/fileio.h>
23
24 struct nand_fileio_state {
25         uint32_t address;
26         uint32_t size;
27
28         uint8_t *page;
29         uint32_t page_size;
30
31         enum oob_formats oob_format;
32         uint8_t *oob;
33         uint32_t oob_size;
34
35         const int *eccpos;
36
37         bool file_opened;
38         struct fileio *fileio;
39
40         struct duration bench;
41 };
42
43 void nand_fileio_init(struct nand_fileio_state *state);
44 int nand_fileio_start(struct command_context *cmd_ctx,
45                 struct nand_device *nand, const char *filename, int filemode,
46                 struct nand_fileio_state *state);
47 int nand_fileio_cleanup(struct nand_fileio_state *state);
48 int nand_fileio_finish(struct nand_fileio_state *state);
49
50 COMMAND_HELPER(nand_fileio_parse_args, struct nand_fileio_state *state,
51         struct nand_device **dev, enum fileio_access filemode,
52         bool need_size, bool sw_ecc);
53
54 int nand_fileio_read(struct nand_device *nand, struct nand_fileio_state *s);
55
56 #endif  /* FLASH_NAND_FILEIO_H */