xref: /nrf52832-nimble/rt-thread/components/dfs/filesystems/uffs/src/inc/uffs/uffs_utils.h (revision 104654410c56c573564690304ae786df310c91fc)
1 /*
2   This file is part of UFFS, the Ultra-low-cost Flash File System.
3 
4   Copyright (C) 2005-2009 Ricky Zheng <[email protected]>
5 
6   UFFS is free software; you can redistribute it and/or modify it under
7   the GNU Library General Public License as published by the Free Software
8   Foundation; either version 2 of the License, or (at your option) any
9   later version.
10 
11   UFFS is distributed in the hope that it will be useful, but WITHOUT
12   ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13   FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14   or GNU Library General Public License, as applicable, for more details.
15 
16   You should have received a copy of the GNU General Public License
17   and GNU Library General Public License along with UFFS; if not, write
18   to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
19   Boston, MA  02110-1301, USA.
20 
21   As a special exception, if other files instantiate templates or use
22   macros or inline functions from this file, or you compile this file
23   and link it with other works to produce a work based on this file,
24   this file does not by itself cause the resulting work to be covered
25   by the GNU General Public License. However the source code for this
26   file must still be made available in accordance with section (3) of
27   the GNU General Public License v2.
28 
29   This exception does not invalidate any other reasons why a work based
30   on this file might be covered by the GNU General Public License.
31 */
32 
33 #ifndef _UFFS_UTILS_H_
34 #define _UFFS_UTILS_H_
35 
36 #include "uffs/uffs_types.h"
37 #include "uffs/uffs_device.h"
38 #include "uffs/uffs_core.h"
39 
40 #ifdef __cplusplus
41 extern "C"{
42 #endif
43 
44 
45 //get UFFS disk version, if fail, return 0
46 int uffs_GetUFFSVersion(struct uffs_DeviceSt *dev);
47 
48 void uffs_InitGlobalFsLock(void);
49 void uffs_ReleaseGlobalFsLock(void);
50 void uffs_GlobalFsLockLock(void);
51 void uffs_GlobalFsLockUnlock(void);
52 
53 URET uffs_FormatDevice(uffs_Device *dev, UBOOL force);
54 
55 #ifdef __cplusplus
56 }
57 #endif
58 
59 typedef void dump_msg_cb(struct uffs_DeviceSt *dev, const char *fmt, ...);
60 
61 void uffs_DumpDevice(struct uffs_DeviceSt *dev, dump_msg_cb *dump);
62 
63 #endif
64 
65