Cleanup of config/includes.

[openocd.git] / src / helper / fileio.h

diff --git a/src/helper/fileio.h b/src/helper/fileio.h
index c047cb87aa029183dd9e78457fb4cdd5f2ef7eeb..16c1046575bfeb9f2d7acee0d3eff78eabbe0af6 100644 (file)
--- a/src/helper/fileio.h
+++ b/src/helper/fileio.h
@@ -2,6 +2,12 @@
  *   Copyright (C) 2007 by Dominic Rath                                    *
  *   Dominic.Rath@gmx.de                                                   *
  *                                                                         *
+ *   Copyright (C) 2007,2008 Øyvind Harboe                                 *
+ *   oyvind.harboe@zylin.com                                               *
+ *                                                                         *
+ *   Copyright (C) 2008 by Spencer Oliver                                  *
+ *   spen@spen-soft.co.uk                                                  *
+ *                                                                         *
  *   This program is free software; you can redistribute it and/or modify  *
  *   it under the terms of the GNU General Public License as published by  *
  *   the Free Software Foundation; either version 2 of the License, or     *
@@ -13,54 +19,23 @@
  *   GNU General Public License for more details.                          *
  *                                                                         *
  *   You should have received a copy of the GNU General Public License     *
- *   along with this program; if not, write to the                         *
- *   Free Software Foundation, Inc.,                                       *
- *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
+ *   along with this program.  If not, see <http://www.gnu.org/licenses/>. *
  ***************************************************************************/
-#ifndef FILEIO_H
-#define FILEIO_H
-
-#define FILEIO_MAX_ERROR_STRING                (128)
 
-/* make buffering of complete intel-hex format files optional
- * to account for resource-limited hosts
- */
-#define FILEIO_BUFFER_COMPLETE_IHEX
+#ifndef OPENOCD_HELPER_FILEIO_H
+#define OPENOCD_HELPER_FILEIO_H
 
-#include <sys/stat.h>
+#include "types.h"
 
-enum fileio_pri_type
-{
-       FILEIO_TEXT = 0x1,
-       FILEIO_IMAGE = 0x2,
-};
-
-enum fileio_sec_type
-{
-       FILEIO_PLAIN = 0x10,
-       FILEIO_IHEX = 0x20,
-/*
- * Possible future enhancements:
- * FILEIO_ELF,
- * FILEIO_SRECORD,
- */
-};
+#define FILEIO_MAX_ERROR_STRING                (128)
 
-enum fileio_location
-{
-       FILEIO_LOCAL,
-/*
- * Possible future enhancements:
- * FILEIO_NFS,
- * FILEIO_BOOTP,
- * FILEIO_[XYZ]MODEM,
- * FILEIO_HTTP,
- * FILEIO_FTP,
- */
+enum fileio_type {
+       FILEIO_TEXT,
+       FILEIO_BINARY,
 };
 
-enum fileio_access
-{
+enum fileio_access {
+       FILEIO_NONE,            /* open without any access (invalid mode) */
        FILEIO_READ,            /* open for reading, position at beginning */
        FILEIO_WRITE,           /* open for writing, position at beginning */
        FILEIO_READWRITE,       /* open for writing, position at beginning, allow reading */
@@ -68,59 +43,30 @@ enum fileio_access
        FILEIO_APPENDREAD,      /* open for writing, position at end, allow reading */
 };
 
-typedef struct fileio_s
-{
-       char *url;
-       char error_str[FILEIO_MAX_ERROR_STRING];
-       long long size;
-       enum fileio_pri_type pri_type;
-       enum fileio_sec_type sec_type;
-       enum fileio_location location;
-       enum fileio_access access;
-       void *location_private;
-       void *pri_type_private;
-       void *sec_type_private;
-} fileio_t;
+struct fileio;
 
-typedef struct fileio_text_s
-{
-} fileio_text_t;
+int fileio_open(struct fileio **fileio, const char *url,
+               enum fileio_access access_type, enum fileio_type type);
+int fileio_close(struct fileio *fileio);
+int fileio_feof(struct fileio *fileio);
 
-typedef struct fileio_image_s
-{
-       u32 base_address;
-       int has_start_address;
-       u32 start_address;
-} fileio_image_t;
+int fileio_seek(struct fileio *fileio, size_t position);
+int fileio_fgets(struct fileio *fileio, size_t size, void *buffer);
 
-typedef struct fileio_local_s
-{
-       FILE *file;
-       struct stat file_stat;
-} fileio_local_t;
+int fileio_read(struct fileio *fileio,
+               size_t size, void *buffer, size_t *size_read);
+int fileio_write(struct fileio *fileio,
+               size_t size, const void *buffer, size_t *size_written);
 
-typedef struct fileio_ihex_s
-{
-       u32 position;
-       u32 raw_size;
-#ifdef FILEIO_BUFFER_COMPLETE_IHEX
-       u8 *buffer;
-#endif
-} fileio_ihex_t;
+int fileio_read_u32(struct fileio *fileio, uint32_t *data);
+int fileio_write_u32(struct fileio *fileio, uint32_t data);
+int fileio_size(struct fileio *fileio, size_t *size);
 
-extern int fileio_identify_image_type(enum fileio_sec_type *sec_type, char *type_string);
-extern int fileio_write(fileio_t *fileio, u32 size, u8 *buffer, u32 *size_written);
-extern int fileio_read(fileio_t *fileio, u32 size, u8 *buffer, u32 *size_read);
-extern int fileio_seek(fileio_t *fileio, u32 position);
-extern int fileio_close(fileio_t *fileio);
-extern int fileio_open(fileio_t *fileio, char *url, enum fileio_access access,
-       enum fileio_pri_type pri_type, void *pri_info, enum fileio_sec_type sec_type);
-       
-#define ERROR_FILEIO_LOCATION_UNKNOWN  (-1200)
-#define ERROR_FILEIO_NOT_FOUND                 (-1201)
-#define ERROR_FILEIO_OPERATION_FAILED          (-1202)
-#define ERROR_FILEIO_ACCESS_NOT_SUPPORTED      (-1203)
-#define ERROR_FILEIO_RESOURCE_TYPE_UNKNOWN     (-1204)
+#define ERROR_FILEIO_LOCATION_UNKNOWN                  (-1200)
+#define ERROR_FILEIO_NOT_FOUND                                 (-1201)
+#define ERROR_FILEIO_OPERATION_FAILED                  (-1202)
+#define ERROR_FILEIO_ACCESS_NOT_SUPPORTED              (-1203)
+#define ERROR_FILEIO_RESOURCE_TYPE_UNKNOWN             (-1204)
 #define ERROR_FILEIO_OPERATION_NOT_SUPPORTED   (-1205)
 
-#endif /* FILEIO_H */
+#endif /* OPENOCD_HELPER_FILEIO_H */