Emilio Monti / mbed-KL25Z

mbed libraries for KL25Z

Dependents:   FRDM_RGBLED

FileSystemLike.h@2:e9a661555b58, 2012-10-10 (annotated)

Committer:
emilmont
Date:
Wed Oct 10 14:14:12 2012 +0000
Revision:
2:e9a661555b58
Parent:
0:8024c367e29f
Child:
8:c14af7958ef5
Add PWM and I2C implementation;

Who changed what in which revision?

UserRevisionLine numberNew contents of line
emilmont 2:e9a661555b58 1 /* mbed Microcontroller Library - FileSystemLike
emilmont 2:e9a661555b58 2 * Copyright (c) 2008-2009 ARM Limited. All rights reserved.
emilmont 2:e9a661555b58 3 */
emilmont 2:e9a661555b58 4 #ifndef MBED_FILESYSTEMLIKE_H
emilmont 2:e9a661555b58 5 #define MBED_FILESYSTEMLIKE_H
emilmont 2:e9a661555b58 6
emilmont 2:e9a661555b58 7 #ifdef __ARMCC_VERSION
emilmont 2:e9a661555b58 8 # define O_RDONLY 0
emilmont 2:e9a661555b58 9 # define O_WRONLY 1
emilmont 2:e9a661555b58 10 # define O_RDWR 2
emilmont 2:e9a661555b58 11 # define O_CREAT 0x0200
emilmont 2:e9a661555b58 12 # define O_TRUNC 0x0400
emilmont 2:e9a661555b58 13 # define O_APPEND 0x0008
emilmont 2:e9a661555b58 14 typedef int mode_t;
emilmont 2:e9a661555b58 15 #else
emilmont 2:e9a661555b58 16 # include <sys/fcntl.h>
emilmont 2:e9a661555b58 17 #endif
emilmont 2:e9a661555b58 18 #include "Base.h"
emilmont 2:e9a661555b58 19 #include "FileHandle.h"
emilmont 2:e9a661555b58 20 #include "DirHandle.h"
emilmont 2:e9a661555b58 21
emilmont 2:e9a661555b58 22 namespace mbed {
emilmont 2:e9a661555b58 23
emilmont 2:e9a661555b58 24 /* Class FileSystemLike
emilmont 2:e9a661555b58 25 * A filesystem-like object is one that can be used to open files
emilmont 2:e9a661555b58 26 * though it by fopen("/name/filename", mode)
emilmont 2:e9a661555b58 27 *
emilmont 2:e9a661555b58 28 * Implementations must define at least open (the default definitions
emilmont 2:e9a661555b58 29 * of the rest of the functions just return error values).
emilmont 2:e9a661555b58 30 */
emilmont 2:e9a661555b58 31 class FileSystemLike : public Base {
emilmont 2:e9a661555b58 32
emilmont 2:e9a661555b58 33 public:
emilmont 2:e9a661555b58 34 /* Constructor FileSystemLike
emilmont 2:e9a661555b58 35 *
emilmont 2:e9a661555b58 36 * Variables
emilmont 2:e9a661555b58 37 * name - The name to use for the filesystem.
emilmont 2:e9a661555b58 38 */
emilmont 2:e9a661555b58 39 FileSystemLike(const char *name) : Base(name) {
emilmont 2:e9a661555b58 40 base_type = FileSystemType;
emilmont 2:e9a661555b58 41 }
emilmont 2:e9a661555b58 42
emilmont 2:e9a661555b58 43 /* Function open
emilmont 2:e9a661555b58 44 *
emilmont 2:e9a661555b58 45 * Variables
emilmont 2:e9a661555b58 46 * filename - The name of the file to open.
emilmont 2:e9a661555b58 47 * flags - One of O_RDONLY, O_WRONLY, or O_RDWR, OR'd with
emilmont 2:e9a661555b58 48 * zero or more of O_CREAT, O_TRUNC, or O_APPEND.
emilmont 2:e9a661555b58 49 * returns - A pointer to a FileHandle object representing the
emilmont 2:e9a661555b58 50 * file on success, or NULL on failure.
emilmont 2:e9a661555b58 51 */
emilmont 2:e9a661555b58 52 virtual FileHandle *open(const char *filename, int flags) = 0;
emilmont 2:e9a661555b58 53
emilmont 2:e9a661555b58 54 /* Function remove
emilmont 2:e9a661555b58 55 * Remove a file from the filesystem.
emilmont 2:e9a661555b58 56 *
emilmont 2:e9a661555b58 57 * Variables
emilmont 2:e9a661555b58 58 * filename - the name of the file to remove.
emilmont 2:e9a661555b58 59 * returns - 0 on success, -1 on failure.
emilmont 2:e9a661555b58 60 */
emilmont 2:e9a661555b58 61 virtual int remove(const char *filename) { return -1; };
emilmont 2:e9a661555b58 62
emilmont 2:e9a661555b58 63 /* Function rename
emilmont 2:e9a661555b58 64 * Rename a file in the filesystem.
emilmont 2:e9a661555b58 65 *
emilmont 2:e9a661555b58 66 * Variables
emilmont 2:e9a661555b58 67 * oldname - the name of the file to rename.
emilmont 2:e9a661555b58 68 * newname - the name to rename it to.
emilmont 2:e9a661555b58 69 * returns - 0 on success, -1 on failure.
emilmont 2:e9a661555b58 70 */
emilmont 2:e9a661555b58 71 virtual int rename(const char *oldname, const char *newname) { return -1; };
emilmont 2:e9a661555b58 72
emilmont 2:e9a661555b58 73 /* Function opendir
emilmont 2:e9a661555b58 74 * Opens a directory in the filesystem and returns a DirHandle
emilmont 2:e9a661555b58 75 * representing the directory stream.
emilmont 2:e9a661555b58 76 *
emilmont 2:e9a661555b58 77 * Variables
emilmont 2:e9a661555b58 78 * name - The name of the directory to open.
emilmont 2:e9a661555b58 79 * returns - A DirHandle representing the directory stream, or
emilmont 2:e9a661555b58 80 * NULL on failure.
emilmont 2:e9a661555b58 81 */
emilmont 2:e9a661555b58 82 virtual DirHandle *opendir(const char *name) { return NULL; };
emilmont 2:e9a661555b58 83
emilmont 2:e9a661555b58 84 /* Function mkdir
emilmont 2:e9a661555b58 85 * Creates a directory in the filesystem.
emilmont 2:e9a661555b58 86 *
emilmont 2:e9a661555b58 87 * Variables
emilmont 2:e9a661555b58 88 * name - The name of the directory to create.
emilmont 2:e9a661555b58 89 * mode - The permissions to create the directory with.
emilmont 2:e9a661555b58 90 * returns - 0 on success, -1 on failure.
emilmont 2:e9a661555b58 91 */
emilmont 2:e9a661555b58 92 virtual int mkdir(const char *name, mode_t mode) { return -1; }
emilmont 2:e9a661555b58 93
emilmont 2:e9a661555b58 94 // TODO other filesystem functions (mkdir, rm, rn, ls etc)
emilmont 2:e9a661555b58 95
emilmont 2:e9a661555b58 96 };
emilmont 2:e9a661555b58 97
emilmont 2:e9a661555b58 98 } // namespace mbed
emilmont 2:e9a661555b58 99
emilmont 2:e9a661555b58 100 #endif