README.md
1<!--
2 Copyright 2020, Data61
3 Commonwealth Scientific and Industrial Research Organisation (CSIRO)
4 ABN 41 687 119 230.
5
6 This software may be distributed and modified according to the terms of
7 the BSD 2-Clause license. Note that NO WARRANTY is provided.
8 See "LICENSE_BSD2.txt" for details.
9
10 @TAG(DATA61_BSD)
11-->
12
13# FileServer
14
15This is a CAmkES component that is intended to multiplex client accesses to a
16CPIO archive.
17
18## Dependencies
19
20There are currently no dependencies for this component.
21
22## Usage
23
24For clients to use the functionality exposed by the component, the clients will
25need to be connected to this CAmkES interface using the `seL4RPCDataport`
26connector.
27
28```
29provides FileServerInterface fs_ctrl;
30```
31
32## Supported platforms
33
34This component is supported on all platforms.
35
36## Limitations
37
38This component is currently only able to serve files from a memory-backed CPIO
39archive. Thus, the amount of files that it can serve is limited to the size of
40memory.
41
42