Remove redundant sys/types.h #include directives (now in types.h).
[fw/openocd] / src / helper / fileio.h
1 /***************************************************************************
2  *   Copyright (C) 2007 by Dominic Rath                                    *
3  *   Dominic.Rath@gmx.de                                                   *
4  *                                                                         *
5  *   Copyright (C) 2007,2008 Ã˜yvind Harboe                                 *
6  *   oyvind.harboe@zylin.com                                               *
7  *                                                                         *
8  *   Copyright (C) 2008 by Spencer Oliver                                  *
9  *   spen@spen-soft.co.uk                                                  *
10  *                                                                         *
11  *   This program is free software; you can redistribute it and/or modify  *
12  *   it under the terms of the GNU General Public License as published by  *
13  *   the Free Software Foundation; either version 2 of the License, or     *
14  *   (at your option) any later version.                                   *
15  *                                                                         *
16  *   This program is distributed in the hope that it will be useful,       *
17  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
18  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
19  *   GNU General Public License for more details.                          *
20  *                                                                         *
21  *   You should have received a copy of the GNU General Public License     *
22  *   along with this program; if not, write to the                         *
23  *   Free Software Foundation, Inc.,                                       *
24  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
25  ***************************************************************************/
26 #ifndef FILEIO_H
27 #define FILEIO_H
28
29 #define FILEIO_MAX_ERROR_STRING         (128)
30
31 #include "types.h"
32
33 #include <stdio.h>
34 #include <unistd.h>
35 #include <stdlib.h>
36 #include <sys/stat.h>
37 #include <errno.h>
38 #include <ctype.h>
39
40 enum fileio_type
41 {
42         FILEIO_TEXT,
43         FILEIO_BINARY,
44 };
45
46 enum fileio_access
47 {
48         FILEIO_READ,            /* open for reading, position at beginning */
49         FILEIO_WRITE,           /* open for writing, position at beginning */
50         FILEIO_READWRITE,       /* open for writing, position at beginning, allow reading */
51         FILEIO_APPEND,          /* open for writing, position at end */
52         FILEIO_APPENDREAD,      /* open for writing, position at end, allow reading */
53 };
54
55 typedef struct fileio_s
56 {
57         char *url;
58         long long size;
59         enum fileio_type type;
60         enum fileio_access access;
61         FILE *file;
62 } fileio_t;
63
64 extern int fileio_write(fileio_t *fileio, u32 size, const u8 *buffer, u32 *size_written);
65 extern int fileio_read(fileio_t *fileio, u32 size, u8 *buffer, u32 *size_read);
66 extern int fileio_fgets(fileio_t *fileio, u32 size, char *buffer);
67 extern int fileio_seek(fileio_t *fileio, u32 position);
68 extern int fileio_close(fileio_t *fileio);
69 extern int fileio_open(fileio_t *fileio, const char *url, enum fileio_access access, enum fileio_type type);
70 extern int fileio_read_u32(fileio_t *fileio, u32 *data);
71 extern int fileio_write_u32(fileio_t *fileio, u32 data);
72
73 #define ERROR_FILEIO_LOCATION_UNKNOWN   (-1200)
74 #define ERROR_FILEIO_NOT_FOUND                  (-1201)
75 #define ERROR_FILEIO_OPERATION_FAILED           (-1202)
76 #define ERROR_FILEIO_ACCESS_NOT_SUPPORTED       (-1203)
77 #define ERROR_FILEIO_RESOURCE_TYPE_UNKNOWN      (-1204)
78 #define ERROR_FILEIO_OPERATION_NOT_SUPPORTED    (-1205)
79
80 #endif /* FILEIO_H */