summaryrefslogtreecommitdiffstats
path: root/cfe/cfe/main/cfe_filesys.c
blob: 569d7bc1a42b21c710c26d24600bf62565d18a8d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
/*  *********************************************************************
    *  Broadcom Common Firmware Environment (CFE)
    *  
    *  Filesystem manager			File: cfe_filesys.c
    *  
    *  This module maintains the list of available file systems.
    *  
    *  Author:  Mitch Lichtenberg (mpl@broadcom.com)
    *  
    *********************************************************************  
    *
    *  Copyright 2000,2001,2002,2003
    *  Broadcom Corporation. All rights reserved.
    *  
    *  This software is furnished under license and may be used and 
    *  copied only in accordance with the following terms and 
    *  conditions.  Subject to these conditions, you may download, 
    *  copy, install, use, modify and distribute modified or unmodified 
    *  copies of this software in source and/or binary form.  No title 
    *  or ownership is transferred hereby.
    *  
    *  1) Any source code used, modified or distributed must reproduce 
    *     and retain this copyright notice and list of conditions 
    *     as they appear in the source file.
    *  
    *  2) No right is granted to use any trade name, trademark, or 
    *     logo of Broadcom Corporation.  The "Broadcom Corporation" 
    *     name may not be used to endorse or promote products derived 
    *     from this software without the prior written permission of 
    *     Broadcom Corporation.
    *  
    *  3) THIS SOFTWARE IS PROVIDED "AS-IS" AND ANY EXPRESS OR
    *     IMPLIED WARRANTIES, INCLUDING BUT NOT LIMITED TO, ANY IMPLIED
    *     WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR 
    *     PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED. IN NO EVENT 
    *     SHALL BROADCOM BE LIABLE FOR ANY DAMAGES WHATSOEVER, AND IN 
    *     PARTICULAR, BROADCOM SHALL NOT BE LIABLE FOR DIRECT, INDIRECT,
    *     INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES 
    *     (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
    *     GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
    *     BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY 
    *     OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR 
    *     TORT (INCLUDING NEGLIGENCE OR OTHERWISE), EVEN IF ADVISED OF 
    *     THE POSSIBILITY OF SUCH DAMAGE.
    ********************************************************************* */

#include "lib_types.h"
#include "lib_string.h"
#include "lib_malloc.h"

#include "cfe_error.h"
#include "cfe_fileops.h"

#include "cfe.h"

#include "bsp_config.h"

/*  *********************************************************************
    *  Externs
    ********************************************************************* */

extern const fileio_dispatch_t raw_fileops;
#if CFG_NETWORK
extern const fileio_dispatch_t tftp_fileops;
#if (CFG_TCP) && (CFG_HTTPFS)
extern const fileio_dispatch_t http_fileops;
#endif
#endif
#if CFG_FATFS
extern const fileio_dispatch_t fatfs_fileops;
extern const fileio_dispatch_t pfatfs_fileops;
#endif
#if CFG_ZLIB
extern const fileio_dispatch_t zlibfs_fileops;
#endif

/*  *********************************************************************
    *  File system list
    ********************************************************************* */

static const fileio_dispatch_t * const cfe_filesystems[] = {
#if !defined(CONFIG_MIPS_BRCM)
    &raw_fileops,
#endif
#if CFG_NETWORK
    &tftp_fileops,
#if (CFG_TCP) & (CFG_HTTPFS)
    &http_fileops,
#endif
#endif
#if CFG_FATFS
    &fatfs_fileops,
    &pfatfs_fileops,
#endif
#if CFG_ZLIB
    &zlibfs_fileops,
#endif
    NULL
};

/*  *********************************************************************
    *  cfe_findfilesys(name)
    *  
    *  Locate the dispatch record for a particular file system.
    *  
    *  Input parameters: 
    *  	   name - name of filesys to locate
    *  	   
    *  Return value:
    *  	   pointer to dispatch table or NULL if not found
    ********************************************************************* */

const fileio_dispatch_t *cfe_findfilesys(const char *name)
{
    const fileio_dispatch_t * const *disp;
    
    disp = cfe_filesystems;

    while (*disp) {
	if (strcmp((*disp)->method,name) == 0) return *disp;
	disp++;
	}

    return NULL;
}

/*  *********************************************************************
    *  fs_init(name,fsctx,device)
    *  
    *  Initialize a filesystem context
    *  
    *  Input parameters: 
    *  	   name - name of file system
    *  	   fsctx - returns a filesystem context
    *  	   device - device name or other info
    *  	   
    *  Return value:
    *  	   0 if ok
    *  	   else error code
    ********************************************************************* */
int fs_init(char *fsname,fileio_ctx_t **fsctx,void *device)
{
    fileio_ctx_t *ctx;
    int res;
    const fileio_dispatch_t *ops;

    ops = cfe_findfilesys((const char *)fsname);
    if (!ops) return CFE_ERR_FSNOTAVAIL;

    ctx = (fileio_ctx_t *) KMALLOC(sizeof(fileio_ctx_t),0);
    if (!ctx) return CFE_ERR_NOMEM;

    ctx->ops = ops;
    res = BDINIT(ops,&(ctx->fsctx),device);

    if (res != 0) {
	KFREE(ctx);
	}

    *fsctx = ctx;

    return res;
}


/*  *********************************************************************
    *  fs_hook(fsctx,name)
    *  
    *  "Hook" a filesystem to attach a filter, like a decompression
    *  or decryption engine.
    *  
    *  Input parameters: 
    *  	   fsctx - result from a previous fs_init 
    *  	   name - name of fs to hook onto the beginning
    *  	   
    *  Return value:
    *  	   0 if ok
    *  	   else error
    ********************************************************************* */

int fs_hook(fileio_ctx_t *fsctx,char *fsname)
{
    void *hookfsctx;
    const fileio_dispatch_t *ops;
    int res;

    /*
     * Find the hook filesystem (well, actually a filter)
     */

    ops = cfe_findfilesys((const char *)fsname);
    if (!ops) return CFE_ERR_FSNOTAVAIL;

    /* 
     * initialize our hook file filter.
     */

    res = BDINIT(ops,&hookfsctx,fsctx);
    if (res != 0) return res;

    /*
     * Now replace dispatch table for current filesystem
     * with the hook's dispatch table.  When fs_read is called,
     * we'll go to the hook, and the hook will call the original.
     *
     * When fs_uninit is called, the hook will call the original's
     * uninit routine.
     */

    fsctx->ops = ops;
    fsctx->fsctx = hookfsctx;

    return 0;

}

/*  *********************************************************************
    *  fs_uninit(fsctx)
    *  
    *  Uninitialize a file system context.
    *  
    *  Input parameters: 
    *  	   fsctx - filesystem context to remove (from fs_init)
    *  	   
    *  Return value:
    *  	   0 if ok
    *  	   else error
    ********************************************************************* */
int fs_uninit(fileio_ctx_t *fsctx)
{
    BDUNINIT(fsctx->ops,fsctx->fsctx);

    KFREE(fsctx);

    return 0;
}


/*  *********************************************************************
    *  fs_open(fsctx,ref,filename,mode)
    *  
    *  Open a file on the file system
    *  
    *  Input parameters: 
    *  	   fsctx - filesystem context (from fs_init)
    *  	   ref - returns file handle
    *  	   filename - name of file to open
    *  	   mode - file open mode
    *  	   
    *  Return value:
    *  	   0 if ok
    *  	   else error code
    ********************************************************************* */
int fs_open(fileio_ctx_t *fsctx,void **ref,char *filename,int mode)
{
    return BDOPEN2(fsctx->ops,ref,fsctx->fsctx,filename,mode);
}

/*  *********************************************************************
    *  fs_close(fsctx,ref)
    *  
    *  Close a file on the file system
    *  
    *  Input parameters: 
    *  	   fsctx - filesystem context (from fs_init)
    *  	   ref - file handle (from fs_open)
    *  	   
    *  Return value:
    *  	   0 if ok
    *  	   else error code
    ********************************************************************* */
int fs_close(fileio_ctx_t *fsctx,void *ref)
{
    BDCLOSE(fsctx->ops,ref);

    return 0;
}


/*  *********************************************************************
    *  fs_read(fsctx,ref,buffer,len)
    *  
    *  Read data from the device.
    *  
    *  Input parameters: 
    *  	   fsctx - filesystem context (from fs_init)
    *  	   ref - file handle (from fs_open)
    *  	   buffer - buffer pointer
    *  	   len - length
    *  	   
    *  Return value:
    *  	   number of bytes read
    *  	   0=eof
    *  	   <0 = error
    ********************************************************************* */

int fs_read(fileio_ctx_t *fsctx,void *ref,uint8_t *buffer,int len)
{
    return BDREAD(fsctx->ops,ref,buffer,len);
}

/*  *********************************************************************
    *  fs_write(fsctx,ref,buffer,len)
    *  
    *  write data from the device.
    *  
    *  Input parameters: 
    *  	   fsctx - filesystem context (from fs_init)
    *  	   ref - file handle (from fs_open)
    *  	   buffer - buffer pointer
    *  	   len - length
    *  	   
    *  Return value:
    *  	   number of bytes written
    *  	   0=eof
    *  	   <0 = error
    ********************************************************************* */

int fs_write(fileio_ctx_t *fsctx,void *ref,uint8_t *buffer,int len)
{
    return BDWRITE(fsctx->ops,ref,buffer,len);
}

/*  *********************************************************************
    *  fs_seek(fsctx,ref,offset,how)
    *  
    *  move file pointer on the device
    *  
    *  Input parameters: 
    *  	   fsctx - filesystem context (from fs_init)
    *  	   ref - file handle (from fs_open)
    *  	   offset - distance to move
    *  	   how - origin (FILE_SEEK_xxx)
    *  	   
    *  Return value:
    *  	   new offset
    *  	   <0 = error
    ********************************************************************* */

int fs_seek(fileio_ctx_t *fsctx,void *ref,int offset,int how)
{
    return BDSEEK(fsctx->ops,ref,offset,how);
}