2022-06-26 22:58:56 +00:00
|
|
|
/* SPDX-License-Identifier: GPL-2.0-or-later */
|
|
|
|
|
2007-03-16 09:12:22 +00:00
|
|
|
/***************************************************************************
|
|
|
|
* Copyright (C) 2007 by Dominic Rath *
|
|
|
|
* Dominic.Rath@gmx.de *
|
|
|
|
* *
|
2009-07-17 19:54:25 +00:00
|
|
|
* Copyright (C) 2007,2008 Øyvind Harboe *
|
2008-07-25 06:54:17 +00:00
|
|
|
* oyvind.harboe@zylin.com *
|
|
|
|
* *
|
2008-09-20 10:50:53 +00:00
|
|
|
* Copyright (C) 2008 by Spencer Oliver *
|
|
|
|
* spen@spen-soft.co.uk *
|
2007-03-16 09:12:22 +00:00
|
|
|
***************************************************************************/
|
2012-01-30 14:31:21 +00:00
|
|
|
|
2015-09-21 19:07:46 +00:00
|
|
|
#ifndef OPENOCD_HELPER_FILEIO_H
|
|
|
|
#define OPENOCD_HELPER_FILEIO_H
|
2007-03-16 09:12:22 +00:00
|
|
|
|
2021-04-19 20:04:30 +00:00
|
|
|
#include "types.h"
|
|
|
|
|
2009-05-12 08:35:17 +00:00
|
|
|
#define FILEIO_MAX_ERROR_STRING (128)
|
2007-03-16 09:12:22 +00:00
|
|
|
|
2012-01-30 14:31:21 +00:00
|
|
|
enum fileio_type {
|
2007-05-29 11:23:42 +00:00
|
|
|
FILEIO_TEXT,
|
|
|
|
FILEIO_BINARY,
|
2007-03-16 09:12:22 +00:00
|
|
|
};
|
|
|
|
|
2012-01-30 14:31:21 +00:00
|
|
|
enum fileio_access {
|
2009-11-08 06:37:39 +00:00
|
|
|
FILEIO_NONE, /* open without any access (invalid mode) */
|
2007-03-16 09:12:22 +00:00
|
|
|
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 */
|
|
|
|
FILEIO_APPEND, /* open for writing, position at end */
|
|
|
|
FILEIO_APPENDREAD, /* open for writing, position at end, allow reading */
|
|
|
|
};
|
|
|
|
|
2015-10-04 15:18:40 +00:00
|
|
|
struct fileio;
|
2007-03-16 09:12:22 +00:00
|
|
|
|
2015-10-04 15:18:40 +00:00
|
|
|
int fileio_open(struct fileio **fileio, const char *url,
|
|
|
|
enum fileio_access access_type, enum fileio_type type);
|
2009-11-13 11:08:29 +00:00
|
|
|
int fileio_close(struct fileio *fileio);
|
2017-10-28 17:39:35 +00:00
|
|
|
int fileio_feof(struct fileio *fileio);
|
2009-11-09 10:47:00 +00:00
|
|
|
|
2009-11-13 22:44:53 +00:00
|
|
|
int fileio_seek(struct fileio *fileio, size_t position);
|
|
|
|
int fileio_fgets(struct fileio *fileio, size_t size, void *buffer);
|
2009-11-09 10:47:00 +00:00
|
|
|
|
2009-11-13 11:08:29 +00:00
|
|
|
int fileio_read(struct fileio *fileio,
|
2009-11-13 22:44:53 +00:00
|
|
|
size_t size, void *buffer, size_t *size_read);
|
2009-11-13 11:08:29 +00:00
|
|
|
int fileio_write(struct fileio *fileio,
|
2009-11-13 22:44:53 +00:00
|
|
|
size_t size, const void *buffer, size_t *size_written);
|
2009-11-09 10:47:00 +00:00
|
|
|
|
2009-11-13 11:08:29 +00:00
|
|
|
int fileio_read_u32(struct fileio *fileio, uint32_t *data);
|
|
|
|
int fileio_write_u32(struct fileio *fileio, uint32_t data);
|
2015-10-02 15:35:15 +00:00
|
|
|
int fileio_size(struct fileio *fileio, size_t *size);
|
2008-12-13 12:44:39 +00:00
|
|
|
|
2012-01-30 14:31:21 +00:00
|
|
|
#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)
|
2007-03-16 09:12:22 +00:00
|
|
|
#define ERROR_FILEIO_OPERATION_NOT_SUPPORTED (-1205)
|
|
|
|
|
2015-09-21 19:07:46 +00:00
|
|
|
#endif /* OPENOCD_HELPER_FILEIO_H */
|