Subversion Repositories shark

Rev

Rev 929 | Go to most recent revision | Details | Last modification | View Log | RSS feed

Rev Author Line No. Line
882 trimarchi 1 
/**
2 
   \mainpage FSF reference
3 
 
4 
   @author Giuseppe Lipari
5 
   @author Michael Gonzalez Harbour
6 
   @authos Alan Burns
7 
   @author Gehrard Fohler
8 
 
9 
   This reference manual contains the description of the API provided
10 
   by the FSF library.
11 
 
12 
   \section intro Introduction to FSF
13 
 
14 
   The First Scheduling Framework (FSF) is the result of a joint
15 
   effort from four european research groups to propose an API for
16 
   flexible real-time scheduling in Real Time operating systems.
17 
 
18 
   \section lib Objectives
19 
 
20 
   (from the FIRST documentation...) Links to the public documents.
21 
 
22 
   \section what What it provides
23 
 
24 
   description of the services and modules
25 
 
26 
   \section modu The modules
27 
 
28 
 
29 
 
30 
 */
31 
 
32 
/**
33 
   \defgroup coremodule Core module
34 
 
35 
   This module includes the basic functions and services that are
36 
   provided by any FSF implementation. This module includes basic type
37 
   definitions, and functions to
38 
 
39 
   - create a contract and initialize it
40 
   - set/get the basic parameters of a contract
41 
   - negotiate a service contract, obtaining a server id
42 
   - create and bind threads to servers
43 
   - create/destroy a synchronization object
44 
   - manage bounded workloads
45 
*/
46 
 
47 
/**
48 
   \defgroup sparemodule Spare capacity sharing module
49 
 
50 
   This modules include functions for sharing the spare capacity in
51 
   the system between the servers. It allows to mainly to specify
52 
   additional contract parameters to allow the sharing of the spare
53 
   capacity.
54 
 
55 
   The features provided by this module are different from the
56 
   services provided by the Dynamic reclamation module. This module
57 
   influences the negotiation procedure very much (see the \ref
58 
   core_negotiate module).
59 
 
60 
   @todo [PEPPE: TB continued]
61 
 
62 
 */
63 
 
64 
/**
65 
   \defgroup hiermodule Hierarchical scheduling module
66 
 
67 
   This module includes functions to schedule more than one thread in
68 
   each server. Each server must be assigned a local scheduler which
69 
   is responsible for scheduling the threads in the server.
70 
 
71 
   @todo [PEPPE: TB continued]
72 
 */
73 
 
74 
/**
75 
   \defgroup shobjmodule Shared Objects module
76 
 
77 
   This module include functions to manage shared objects between
78 
   threads.
79 
 
80 
 
81 
   @todo [PEPPE: TB continued]
82 
 
83 
 */