summaryrefslogtreecommitdiff
path: root/ucoo/intf
diff options
context:
space:
mode:
authorNicolas Schodet2015-10-09 11:39:53 +0200
committerNicolas Schodet2019-10-07 00:44:50 +0200
commit381c4d1886ec72364e0e62ad0f08a2511a0c8304 (patch)
treee5fd1155c800d92477f090ce7dabf175ebe4bfbf /ucoo/intf
parent0f38f554b462a516d66649f919faa7336a9601d2 (diff)
ucoo/{intf,arch}: add file system interface
Diffstat (limited to 'ucoo/intf')
-rw-r--r--ucoo/intf/Module2
-rw-r--r--ucoo/intf/file_system.cc58
-rw-r--r--ucoo/intf/file_system.hh83
3 files changed, 142 insertions, 1 deletions
diff --git a/ucoo/intf/Module b/ucoo/intf/Module
index db0f820..9d0f337 100644
--- a/ucoo/intf/Module
+++ b/ucoo/intf/Module
@@ -1 +1 @@
-ucoo_intf_SOURCES = stream.cc spi_master.cc lcd.cc
+ucoo_intf_SOURCES = stream.cc spi_master.cc lcd.cc file_system.cc
diff --git a/ucoo/intf/file_system.cc b/ucoo/intf/file_system.cc
new file mode 100644
index 0000000..b171861
--- /dev/null
+++ b/ucoo/intf/file_system.cc
@@ -0,0 +1,58 @@
+// ucoolib - Microcontroller object oriented library. {{{
+//
+// Copyright (C) 2015 Nicolas Schodet
+//
+// Permission is hereby granted, free of charge, to any person obtaining a
+// copy of this software and associated documentation files (the "Software"),
+// to deal in the Software without restriction, including without limitation
+// the rights to use, copy, modify, merge, publish, distribute, sublicense,
+// and/or sell copies of the Software, and to permit persons to whom the
+// Software is furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in
+// all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+// DEALINGS IN THE SOFTWARE.
+//
+// }}}
+#include "ucoo/intf/file_system.hh"
+#ifdef TARGET_newlib
+# include "ucoo/arch/syscalls.newlib.hh"
+# include "ucoo/common.hh"
+#endif
+
+namespace ucoo {
+
+void
+FileSystem::enable (bool root)
+{
+ disable ();
+ enabled_ = true;
+ root_ = root;
+#ifdef TARGET_newlib
+ if (root_)
+ {
+ assert (!syscalls_file_system);
+ syscalls_file_system = this;
+ }
+#endif
+}
+
+void
+FileSystem::disable ()
+{
+#ifdef TARGET_newlib
+ if (enabled_ && root_)
+ syscalls_file_system = nullptr;
+#endif
+ enabled_ = false;
+ root_ = false;
+}
+
+} // namespace ucoo
diff --git a/ucoo/intf/file_system.hh b/ucoo/intf/file_system.hh
new file mode 100644
index 0000000..ad43e98
--- /dev/null
+++ b/ucoo/intf/file_system.hh
@@ -0,0 +1,83 @@
+#ifndef ucoo_intf_file_system_hh
+#define ucoo_intf_file_system_hh
+// ucoolib - Microcontroller object oriented library. {{{
+//
+// Copyright (C) 2015 Nicolas Schodet
+//
+// Permission is hereby granted, free of charge, to any person obtaining a
+// copy of this software and associated documentation files (the "Software"),
+// to deal in the Software without restriction, including without limitation
+// the rights to use, copy, modify, merge, publish, distribute, sublicense,
+// and/or sell copies of the Software, and to permit persons to whom the
+// Software is furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in
+// all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+// DEALINGS IN THE SOFTWARE.
+//
+// }}}
+#include "ucoo/intf/stream.hh"
+
+namespace ucoo {
+
+/// Interface to a simple file system, can be bound to newlib syscalls.
+class FileSystem
+{
+ public:
+ /// Open mode.
+ enum class Mode {
+ /// Read only.
+ READ,
+ /// Write only. If file exists, it is truncated, else it is created.
+ WRITE,
+ };
+ /// Error code.
+ enum class Error {
+ /// Access not allowed.
+ ACCESS_DENIED,
+ /// The maximum number of open files is exceeded.
+ TOO_MANY_OPEN_FILES,
+ /// File name is too long.
+ NAME_TOO_LONG,
+ /// File does not exists.
+ NO_SUCH_FILE,
+ /// No space left on device.
+ NO_SPACE_LEFT,
+ /// Read only file system.
+ READ_ONLY,
+ };
+ public:
+ /// Enable (and register to newlib syscalls).
+ virtual void enable (bool root = true);
+ /// Disable (and unregister from newlib syscalls).
+ virtual void disable ();
+ /// Open file and return an open stream or nullptr on failure.
+ virtual Stream *open (const char *filename, Mode mode, Error &error) = 0;
+ /// Open file and return an open stream or nullptr on failure, no error
+ /// code.
+ Stream *open (const char *filename, Mode mode = Mode::READ)
+ {
+ Error error;
+ return open (filename, mode, error);
+ }
+ /// Close a previously open file.
+ virtual void close (Stream *file) = 0;
+ /// Remove a file, does not complain if the file does not exists.
+ virtual void unlink (const char *filename) = 0;
+ private:
+ /// Is it enabled?
+ bool enabled_;
+ /// Is this the root file system?
+ bool root_;
+};
+
+} // namespace ucoo
+
+#endif // ucoo_intf_file_system_hh