Added diagrams.

git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@15143 27425a3e-05d8-49a3-a47f-9c15f0e5edd8

os/vfs/dox/vfs_arch.dox

@@ -0,0 +1,101 @@
+/*
+    ChibiOS - Copyright (C) 2006,2007,2008,2009,2010,2011,2012,2013,2014,
+              2015,2016,2017,2018,2019,2020,2021 Giovanni Di Sirio.
+
+    This file is part of ChibiOS.
+
+    ChibiOS 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 version 3 of the License.
+
+    ChibiOS 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/>.
+*/
+
+/**
+ * @startuml {vfs_arch.png} "VFS Core"
+ * package "Abstract Classes" {
+ *   class vfs_driver_t {
+ *     - rootname: const char *
+ *     + open_dir()
+ *     + open_file()
+ *   }
+ *   class vfs_node_t {
+ *     - refs: unsigned
+ *     - driver: vfs_driver_t *
+ *     + release()
+ *   }
+ *   class vfs_directory_node_t {
+ *     + dir_first()
+ *     + dir_next()
+ *   }
+ *   class vfs_file_node_t {
+ *     + get_stream()
+ *     + file_read()
+ *     + file_write()
+ *     + file_setpos()
+ *     + file_getpos()
+ *     + file_getsize()
+ *   }
+ * 
+ *   vfs_node_t "1" o-- vfs_driver_t : owner\ndriver
+ *   vfs_node_t <|-- vfs_directory_node_t : extends
+ *   vfs_node_t <|-- vfs_file_node_t: extends
+ * }
+ * 
+ * package "Root Driver" {
+ *   class vfs_root_driver_t {
+ *     - dir_nodes_pool: memory_pool_t
+ *     - next_driver
+ *     - drivers[]: vfs_driver_t *
+ *   }
+ *   class vfs_root_dir_node_t {
+ *     - index: unsigned
+ *   }
+ * 
+ *   vfs_driver_t <|-- vfs_root_driver_t : extends
+ *   vfs_directory_node_t <|-- vfs_root_dir_node_t : extends
+ * }
+ * 
+ * package "Streams Driver" {
+ *   class vfs_streams_driver_t {
+ *     - file_nodes_pool: memory_pool_t
+ *     - dir_nodes_pool: memory_pool_t
+ *     - streams[]: drv_stream_element_t *
+ *   }
+ *   class vfs_stream_dir_node_t {
+ *     - index: unsigned
+ *   }
+ *   class vfs_stream_file_node_t {
+ *     - stream: BaseSequentialStream *
+ *   }
+ * 
+ *   vfs_driver_t <|-- vfs_streams_driver_t : extends
+ *   vfs_directory_node_t <|-- vfs_stream_dir_node_t : extends
+ *   vfs_file_node_t <|-- vfs_stream_file_node_t : extends
+ * }
+ * 
+ * package "FatFS Driver" {
+ *   class vfs_fatfs_driver_t {
+ *     - file_nodes_pool: memory_pool_t
+ *     - dir_nodes_pool: memory_pool_t
+ *   }
+ *   class vfs_fatfs_dir_node_t {
+ *     - dir: DIR
+ *   }
+ *   class vfs_fatfs_file_node_t {
+ *     - file: FIL
+ *   }
+ * 
+ *   vfs_driver_t <|-- vfs_fatfs_driver_t : extends
+ *   vfs_directory_node_t <|-- vfs_fatfs_dir_node_t : extends
+ *   vfs_file_node_t <|-- vfs_fatfs_file_node_t : extends
+ * }
+ * 
+ * @enduml
+ */

os/vfs/drivers/streams/drvstreams.c

@@ -182,13 +182,13 @@ static vfs_offset_t node_file_getpos(void *instance);
 static vfs_offset_t node_file_getsize(void *instance);
 
 static const struct vfs_stream_file_node_vmt file_node_vmt = {
-  .release      = node_file_release,
-  .get_stream   = node_file_get_stream,
-  .file_read    = node_file_read,
-  .file_write   = node_file_write,
-  .file_setpos  = node_file_setpos,
-  .file_getpos  = node_file_getpos,
-  .file_getsize = node_file_getsize
+  .release         = node_file_release,
+  .file_get_stream = node_file_get_stream,
+  .file_read       = node_file_read,
+  .file_write      = node_file_write,
+  .file_setpos     = node_file_setpos,
+  .file_getpos     = node_file_getpos,
+  .file_getsize    = node_file_getsize
 };
 
 static vfs_stream_dir_node_t drv_dir_nodes[DRV_DIR_NODES_NUM];

os/vfs/include/vfsnodes.h

@@ -176,7 +176,7 @@ typedef struct vfs_file_node vfs_file_node_t;
  */
 #define __vfs_file_node_methods                                             \
   __vfs_node_methods                                                        \
-  BaseSequentialStream *(*get_stream)(void *instance);                      \
+  BaseSequentialStream *(*file_get_stream)(void *instance);                 \
   ssize_t (*file_read)(void *instance, uint8_t *buf, size_t n);             \
   ssize_t (*file_write)(void *instance, const uint8_t *buf, size_t n);      \
   msg_t (*file_setpos)(void *instance, vfs_offset_t offset);                \

os/vfs/src/vfssystem.c

@@ -484,7 +484,7 @@ BaseSequentialStream *vfsGetFileStream(vfs_file_node_t *vfnp) {
 
   chDbgAssert(vfnp->refs > 0U, "zero count");
 
-  return vfnp->vmt->get_stream((void *)vfnp);
+  return vfnp->vmt->file_get_stream((void *)vfnp);
 }
 
 /** @} */