Damian Gabino / picoGW_mcu

MCU driver/HAL for the Picocell Gateway concentrator board. The firmware implements either a USB CDC protocol or a UART protocol to bridge commands coming from host to the SX1308 SPI interface.

src/mbed-dev/api/FileSystemLike.h@0:c76361bd82e8, 2018-04-11 (annotated)

Committer:
dgabino
Date:
Wed Apr 11 14:42:47 2018 +0000
Revision:
0:c76361bd82e8
Initial commit

Who changed what in which revision?

UserRevisionLine numberNew contents of line
dgabino 0:c76361bd82e8 1 /* mbed Microcontroller Library
dgabino 0:c76361bd82e8 2 * Copyright (c) 2006-2013 ARM Limited
dgabino 0:c76361bd82e8 3 *
dgabino 0:c76361bd82e8 4 * Licensed under the Apache License, Version 2.0 (the "License");
dgabino 0:c76361bd82e8 5 * you may not use this file except in compliance with the License.
dgabino 0:c76361bd82e8 6 * You may obtain a copy of the License at
dgabino 0:c76361bd82e8 7 *
dgabino 0:c76361bd82e8 8 * http://www.apache.org/licenses/LICENSE-2.0
dgabino 0:c76361bd82e8 9 *
dgabino 0:c76361bd82e8 10 * Unless required by applicable law or agreed to in writing, software
dgabino 0:c76361bd82e8 11 * distributed under the License is distributed on an "AS IS" BASIS,
dgabino 0:c76361bd82e8 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
dgabino 0:c76361bd82e8 13 * See the License for the specific language governing permissions and
dgabino 0:c76361bd82e8 14 * limitations under the License.
dgabino 0:c76361bd82e8 15 */
dgabino 0:c76361bd82e8 16 #ifndef MBED_FILESYSTEMLIKE_H
dgabino 0:c76361bd82e8 17 #define MBED_FILESYSTEMLIKE_H
dgabino 0:c76361bd82e8 18
dgabino 0:c76361bd82e8 19 #include "platform.h"
dgabino 0:c76361bd82e8 20
dgabino 0:c76361bd82e8 21 #include "FileBase.h"
dgabino 0:c76361bd82e8 22 #include "FileHandle.h"
dgabino 0:c76361bd82e8 23 #include "DirHandle.h"
dgabino 0:c76361bd82e8 24
dgabino 0:c76361bd82e8 25 namespace mbed {
dgabino 0:c76361bd82e8 26
dgabino 0:c76361bd82e8 27 /** A filesystem-like object is one that can be used to open files
dgabino 0:c76361bd82e8 28 * though it by fopen("/name/filename", mode)
dgabino 0:c76361bd82e8 29 *
dgabino 0:c76361bd82e8 30 * Implementations must define at least open (the default definitions
dgabino 0:c76361bd82e8 31 * of the rest of the functions just return error values).
dgabino 0:c76361bd82e8 32 *
dgabino 0:c76361bd82e8 33 * @Note Synchronization level: Set by subclass
dgabino 0:c76361bd82e8 34 */
dgabino 0:c76361bd82e8 35 class FileSystemLike : public FileBase {
dgabino 0:c76361bd82e8 36
dgabino 0:c76361bd82e8 37 public:
dgabino 0:c76361bd82e8 38 /** FileSystemLike constructor
dgabino 0:c76361bd82e8 39 *
dgabino 0:c76361bd82e8 40 * @param name The name to use for the filesystem.
dgabino 0:c76361bd82e8 41 */
dgabino 0:c76361bd82e8 42 FileSystemLike(const char *name);
dgabino 0:c76361bd82e8 43
dgabino 0:c76361bd82e8 44 virtual ~FileSystemLike();
dgabino 0:c76361bd82e8 45
dgabino 0:c76361bd82e8 46 static DirHandle *opendir();
dgabino 0:c76361bd82e8 47 friend class BaseDirHandle;
dgabino 0:c76361bd82e8 48
dgabino 0:c76361bd82e8 49 /** Opens a file from the filesystem
dgabino 0:c76361bd82e8 50 *
dgabino 0:c76361bd82e8 51 * @param filename The name of the file to open.
dgabino 0:c76361bd82e8 52 * @param flags One of O_RDONLY, O_WRONLY, or O_RDWR, OR'd with
dgabino 0:c76361bd82e8 53 * zero or more of O_CREAT, O_TRUNC, or O_APPEND.
dgabino 0:c76361bd82e8 54 *
dgabino 0:c76361bd82e8 55 * @returns
dgabino 0:c76361bd82e8 56 * A pointer to a FileHandle object representing the
dgabino 0:c76361bd82e8 57 * file on success, or NULL on failure.
dgabino 0:c76361bd82e8 58 */
dgabino 0:c76361bd82e8 59 virtual FileHandle *open(const char *filename, int flags) = 0;
dgabino 0:c76361bd82e8 60
dgabino 0:c76361bd82e8 61 /** Remove a file from the filesystem.
dgabino 0:c76361bd82e8 62 *
dgabino 0:c76361bd82e8 63 * @param filename the name of the file to remove.
dgabino 0:c76361bd82e8 64 * @param returns 0 on success, -1 on failure.
dgabino 0:c76361bd82e8 65 */
dgabino 0:c76361bd82e8 66 virtual int remove(const char *filename) { (void) filename; return -1; };
dgabino 0:c76361bd82e8 67
dgabino 0:c76361bd82e8 68 /** Rename a file in the filesystem.
dgabino 0:c76361bd82e8 69 *
dgabino 0:c76361bd82e8 70 * @param oldname the name of the file to rename.
dgabino 0:c76361bd82e8 71 * @param newname the name to rename it to.
dgabino 0:c76361bd82e8 72 *
dgabino 0:c76361bd82e8 73 * @returns
dgabino 0:c76361bd82e8 74 * 0 on success,
dgabino 0:c76361bd82e8 75 * -1 on failure.
dgabino 0:c76361bd82e8 76 */
dgabino 0:c76361bd82e8 77 virtual int rename(const char *oldname, const char *newname) { (void) oldname, (void) newname; return -1; };
dgabino 0:c76361bd82e8 78
dgabino 0:c76361bd82e8 79 /** Opens a directory in the filesystem and returns a DirHandle
dgabino 0:c76361bd82e8 80 * representing the directory stream.
dgabino 0:c76361bd82e8 81 *
dgabino 0:c76361bd82e8 82 * @param name The name of the directory to open.
dgabino 0:c76361bd82e8 83 *
dgabino 0:c76361bd82e8 84 * @returns
dgabino 0:c76361bd82e8 85 * A DirHandle representing the directory stream, or
dgabino 0:c76361bd82e8 86 * NULL on failure.
dgabino 0:c76361bd82e8 87 */
dgabino 0:c76361bd82e8 88 virtual DirHandle *opendir(const char *name) { (void) name; return NULL; };
dgabino 0:c76361bd82e8 89
dgabino 0:c76361bd82e8 90 /** Creates a directory in the filesystem.
dgabino 0:c76361bd82e8 91 *
dgabino 0:c76361bd82e8 92 * @param name The name of the directory to create.
dgabino 0:c76361bd82e8 93 * @param mode The permissions to create the directory with.
dgabino 0:c76361bd82e8 94 *
dgabino 0:c76361bd82e8 95 * @returns
dgabino 0:c76361bd82e8 96 * 0 on success,
dgabino 0:c76361bd82e8 97 * -1 on failure.
dgabino 0:c76361bd82e8 98 */
dgabino 0:c76361bd82e8 99 virtual int mkdir(const char *name, mode_t mode) { (void) name, (void) mode; return -1; }
dgabino 0:c76361bd82e8 100
dgabino 0:c76361bd82e8 101 // TODO other filesystem functions (mkdir, rm, rn, ls etc)
dgabino 0:c76361bd82e8 102 };
dgabino 0:c76361bd82e8 103
dgabino 0:c76361bd82e8 104 } // namespace mbed
dgabino 0:c76361bd82e8 105
dgabino 0:c76361bd82e8 106 #endif