source: trunk/kernel/vfs/ramfs.h @ 302

Last change on this file since 302 was 188, checked in by alain, 7 years ago

Redefine the PIC device API.

File size: 2.1 KB
Line 
1/*
2 * ramfs.h  RAMFS file system API definition.
3 *
4 * Authors   Mohamed Lamine Karaoui (2014,2015)
5 *           Alain Greiner (2016,2017)
6 *
7 * Copyright (c) UPMC Sorbonne Universites
8 *
9 * This file is part of ALMOS-MKH.
10 *
11 * ALMOS-MKH is free software; you can redistribute it and/or modify it
12 * under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; version 2.0 of the License.
14 *
15 * ALMOS-MKH is distributed in the hope that it will be useful, but
16 * WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
18 * General Public License for more details.
19 *
20 * You should have received a copy of the GNU General Public License
21 * along with ALMOS-MKH; if not, write to the Free Software Foundation,
22 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
23 */
24
25#ifndef _RAMFS_H_
26#define _RAMFS_H_
27
28///////////////////////////////////////////////////////////////////////////////////////////
29// The RAMFS File System does not uses any external device to store data.
30// It stores the dynamically created files and directories in the VFS mappers.
31// The ramfs_read_page() and ramfs_write_page() functions should never be used.
32// The RAMFS cannot be used as the root File System.
33//
34// There is no RAMFS context extension, and no RAMFS inode extension.
35///////////////////////////////////////////////////////////////////////////////////////////
36
37
38
39/******************************************************************************************
40 * This function mount a RAMFS on a given inode of the root FS.
41 * It actually creates a new VFS dentry in the cluster containing the parent inode,
42 * and create a new VFS inode in another cluster.
43 ******************************************************************************************
44 * @ parent_inode_xp : extended pointer on the parent inode in VFS.
45 * @ ramfs_root_name : RAMFS root directory name.
46 *****************************************************************************************/
47error_t ramfs_mount( xptr_t   parent_inode_xp,
48                     char   * ramfs_root_name );
49
50#endif  /* _RAMFS_H_ */
Note: See TracBrowser for help on using the repository browser.