diff options
| author | gdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4> | 2013-01-03 11:29:55 +0000 |
|---|---|---|
| committer | gdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4> | 2013-01-03 11:29:55 +0000 |
| commit | 5a73ea36d8c957c9c1041dcad676c1f6347767c7 (patch) | |
| tree | 561ae97e51ad5ce79c4961621b5f58409a4e638b /os/fs | |
| parent | e2adb48040fe4bb6436b33b33d57851f4bf05678 (diff) | |
| download | ChibiOS-5a73ea36d8c957c9c1041dcad676c1f6347767c7.tar.gz ChibiOS-5a73ea36d8c957c9c1041dcad676c1f6347767c7.tar.bz2 ChibiOS-5a73ea36d8c957c9c1041dcad676c1f6347767c7.zip | |
File system abstract interface added.
git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@5024 35acf78f-673a-0410-8e92-d51de3d6d3f4
Diffstat (limited to 'os/fs')
| -rw-r--r-- | os/fs/fs.hpp | 194 |
1 files changed, 194 insertions, 0 deletions
diff --git a/os/fs/fs.hpp b/os/fs/fs.hpp new file mode 100644 index 000000000..599205ff5 --- /dev/null +++ b/os/fs/fs.hpp @@ -0,0 +1,194 @@ +/*
+ ChibiOS/RT - Copyright (C) 2006,2007,2008,2009,2010,
+ 2011,2012 Giovanni Di Sirio.
+
+ This file is part of ChibiOS/RT.
+
+ ChibiOS/RT 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 3 of the License, or
+ (at your option) any later version.
+
+ ChibiOS/RT 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, see <http://www.gnu.org/licenses/>.
+*/
+
+/**
+ * @file fs.hpp
+ * @brief File System interfaces header.
+ *
+ * @addtogroup fs_interface
+ * @{
+ */
+
+#ifndef _FS_HPP_
+#define _FS_HPP_
+
+#include <ch.hpp>
+
+/**
+ * @brief No error return code.
+ */
+#define FILE_OK 0
+
+/**
+ * @brief Error code from the file stream methods.
+ */
+#define FILE_ERROR 0xFFFFFFFFUL
+
+namespace chibios_fs {
+
+ /**
+ * @brief File offset type.
+ */
+ typedef uint32_t fileoffset_t;
+
+ /*------------------------------------------------------------------------*
+ * chibios_fs::BaseFileStreamInterface *
+ *------------------------------------------------------------------------*/
+ /**
+ * @brief Interface of an abstract file object.
+ */
+ class BaseFileStreamInterface : public chibios_rt::BaseSequentialStreamInterface {
+ public:
+ /**
+ * @brief File close and object destruction.
+ *
+ * @api
+ */
+ virtual ~BaseFileStreamInterface(void) = 0;
+
+ /**
+ * @brief Returns an implementation dependent error code.
+ *
+ * @return An implementation-dependent error code.
+ *
+ * @api
+ */
+ virtual uint32_t getAndClearLastError(void) = 0;
+
+ /**
+ * @brief Returns the current file size.
+ *
+ * @return The file size.
+ * @retval FILE_ERROR if the operation failed.
+ *
+ * @api
+ */
+ virtual fileoffset_t getSize(void) = 0;
+
+ /**
+ * @brief Returns the current file pointer position.
+ *
+ * @return The current position inside the file.
+ * @retval FILE_ERROR if the operation failed.
+ *
+ * @api
+ */
+ virtual fileoffset_t getPosition(void) = 0;
+
+ /**
+ * @brief sets the current file pointer position.
+ *
+ * @param[in] offset new absolute position
+ * @return The operation status.
+ * @retval FILE_OK if no error.
+ * @retval FILE_ERROR if the operation failed.
+ *
+ * @api
+ */
+ virtual uint32_t setPosition(fileoffset_t offset) = 0;
+ };
+
+ /*------------------------------------------------------------------------*
+ * chibios_fs::BaseFileSystemInterface *
+ *------------------------------------------------------------------------*/
+ /**
+ * @brief Interface of an abstract file system object.
+ * @note The interface only exposes common features, the implementing
+ * classes can offer an extended interface.
+ */
+ class BaseFileSystemInterface {
+ /**
+ * @brief File system unmount and object destruction.
+ */
+ virtual ~BaseFileSystemInterface() = 0;
+
+ /**
+ * @brief Returns an implementation dependent error code.
+ *
+ * @return An implementation-dependent error code.
+ *
+ * @api
+ */
+ virtual uint32_t getAndClearLastError(void) = 0;
+
+ /**
+ * @brief Synchronizes caches with media device.
+ */
+ virtual void synchronize(void) = 0;
+
+ /**
+ * @brief Removes a file.
+ *
+ * @param[in] fname file name
+ *
+ * @api
+ */
+ virtual void remove(const char *fname) = 0;
+
+ /**
+ * @brief Opens a file for read and write.
+ *
+ * @param[in] fname file name
+ * @return An interface of a file object.
+ * @retval NULL if the operation failed.
+ *
+ * @api
+ */
+ virtual BaseFileStreamInterface *open(const char *fname) = 0;
+
+ /**
+ * @brief Opens a file for read only.
+ *
+ * @param[in] fname file name
+ * @return An interface of a file object.
+ * @retval NULL if the operation failed.
+ *
+ * @api
+ */
+ virtual BaseFileStreamInterface *openForRead(const char *fname) = 0;
+
+ /**
+ * @brief Opens a file for write only.
+ *
+ * @param[in] fname file name
+ * @return An interface of a file object.
+ * @retval NULL if the operation failed.
+ *
+ * @api
+ */
+ virtual BaseFileStreamInterface *openForWrite(const char *fname) = 0;
+
+ /**
+ * @brief Creates a file and opens it for write only.
+ * @details If a file with the same name already exists then it is
+ * overwritten.
+ *
+ * @param[in] fname file name
+ * @return An interface of a file object.
+ * @retval NULL if the operation failed.
+ *
+ * @api
+ */
+ virtual BaseFileStreamInterface *create(const char *fname) = 0;
+ };
+}
+#endif /* _FS_HPP_ */
+
+/** @} */
|