checkpatch: add logging functions

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

diff --git a/src/helper/fileio.h b/src/helper/fileio.h
index 597bafc0124ae5c53934bb9f866d61f9f6b57284..6b4be8ef560efe8b170a8f6abb544ea7bcb3efdd 100644 (file)
--- a/src/helper/fileio.h
+++ b/src/helper/fileio.h
@@ -1,3 +1,5 @@
+/* SPDX-License-Identifier: GPL-2.0-or-later */
+
 /***************************************************************************
  *   Copyright (C) 2007 by Dominic Rath                                    *
  *   Dominic.Rath@gmx.de                                                   *
@@ -7,37 +9,21 @@
  *                                                                         *
  *   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     *
- *   (at your option) any later version.                                   *
- *                                                                         *
- *   This program is distributed in the hope that it will be useful,       *
- *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
- *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
- *   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.             *
  ***************************************************************************/
-#ifndef FILEIO_H
-#define FILEIO_H
 
-#include <helper/types.h>
+#ifndef OPENOCD_HELPER_FILEIO_H
+#define OPENOCD_HELPER_FILEIO_H
+
+#include "types.h"
 
 #define FILEIO_MAX_ERROR_STRING                (128)
 
-enum fileio_type
-{
+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 */
@@ -46,17 +32,12 @@ enum fileio_access
        FILEIO_APPENDREAD,      /* open for writing, position at end, allow reading */
 };
 
-struct fileio {
-       const char *url;
-       ssize_t size;
-       enum fileio_type type;
-       enum fileio_access access;
-       FILE *file;
-};
+struct fileio;
 
-int fileio_open(struct fileio *fileio,
-       const char *url, enum fileio_access access, enum fileio_type type);
+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);
 
 int fileio_seek(struct fileio *fileio, size_t position);
 int fileio_fgets(struct fileio *fileio, size_t size, void *buffer);
@@ -68,12 +49,13 @@ int fileio_write(struct fileio *fileio,
 
 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);
 
-#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 */