X-Git-Url: https://review.openocd.org/gitweb?a=blobdiff_plain;f=src%2Fhelper%2Ffileio.h;h=680bdd2b82d0cd23820f3a23476731b756f4ad7c;hb=3b020c5bb3c332ad7518de388695cc8a98e388f2;hp=20e5c62962eb51a8e1b93187a8a86b26d16f9da6;hpb=995326b6000773efd454e308d487dec0b9f564b5;p=openocd.git diff --git a/src/helper/fileio.h b/src/helper/fileio.h index 20e5c62962..680bdd2b82 100644 --- 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 * @@ -15,44 +21,21 @@ * 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. * + * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. * ***************************************************************************/ + #ifndef FILEIO_H #define FILEIO_H #define FILEIO_MAX_ERROR_STRING (128) -#include "types.h" - -#include -#include -#include -#include -#include -#include -#include - -enum fileio_type -{ +enum fileio_type { FILEIO_TEXT, FILEIO_BINARY, }; -enum fileio_location -{ - FILEIO_LOCAL, -/* - * Possible future enhancements: - * FILEIO_NFS, - * FILEIO_BOOTP, - * FILEIO_[XYZ]MODEM, - * FILEIO_HTTP, - * FILEIO_FTP, - */ -}; - -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 */ @@ -60,37 +43,32 @@ 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_type type; - enum fileio_location location; - enum fileio_access access; - void *location_private; -} fileio_t; +struct fileio { + /* The structure is opaque */ + struct fileio_internal *fp; +}; + +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_seek(struct fileio *fileio, size_t position); +int fileio_fgets(struct fileio *fileio, size_t size, void *buffer); + +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_local_s -{ - FILE *file; - struct stat file_stat; -} fileio_local_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, int *size); -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_fgets(fileio_t *fileio, u32 size, u8 *buffer); -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_type type); -extern int fileio_read_u32(fileio_t *fileio, u32 *data); -extern int fileio_write_u32(fileio_t *fileio, u32 data); - -#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 /* FILEIO_H */