]> rtime.felk.cvut.cz Git - frescor/fosa.git/blob - src_ose/Readme
Makefile: Add missing header file
[frescor/fosa.git] / src_ose / Readme
1 \95 Brief description: \r
2     To port FRSH from MARTE to OSE, FOSA was introduced. Here are the \r
3     first increment of the implementation of FOSA on OSE.\r
4 \r
5 \95 Version: First increment EP3v1, in the FRESCOR project.\r
6 \r
7 \95 Status: Not complete version. Though running tests of the implemented\r
8                   parts.\r
9 \r
10 \95 Authors: of this folder (src_ose) and its content are \r
11         erik.thorin@enea.com\r
12         malin.ling@enea.com\r
13 \r
14 \95 Most recent versions of the software: Contact Enea.\r
15 \r
16 --------------------------------------------------------------------------\r
17 ----------- Short User Guide ---------------------------------------------\r
18 --------------------------------------------------------------------------\r
19 To make FOSA work on OSE, first install and then run the test program.\r
20 \r
21 Content the user guide:\r
22  - To install from Enea Linköpings Subversion\r
23  - To run the test program on the soft kernel\r
24  - To install from FRESCOR Subversion\r
25 \r
26 -------------To install from Enea Linköpings Subversion-------------------\r
27 \95 Install a clean OSE5.2 installation with the standard choice. \r
28 \r
29 \95 Replace your newly created refsys catalogue with the one from \r
30   svn+ssh://selinsrv01/proj/FRESCOR/Repository/ose_including_frsh/trunk.\r
31 (Can only be made from within Enea)\r
32 \r
33 \r
34 -------------To run the test program on the soft kernel-------------------\r
35 \95 Start cygwin.\r
36 \r
37 \95 Type "make all" in OSE5.2/refsys/rtose/sfk-win32/.\r
38 \r
39 \95 Start ose by typing "obj/rtose_debug/rtose.exe -c rtose5.conf".\r
40 \r
41 \95 Run the test program by typing "fosa_test".\r
42 \r
43 \r
44 -------------To install from FRESCOR Subversion---------------------------\r
45 \95 Install a clean OSE5.2 installation with the standard choice. \r
46 \r
47 \95 Copy the folders to these paths:\r
48         {Repository} = http://www.frescor.org/private/svn/frescor/fosa/trunk\r
49         \r
50         {Repository}/                              \r
51                 -> OSE5.2/refsys/modules/frescor_fosa\r
52         \r
53         {Repository}/src_ose/frescor_fosa_handlers \r
54                 -> OSE5.2/refsys/modules/frescor_fosa_handlers\r
55         \r
56         {Repository}/src_ose/frescor_fosa_test     \r
57                 -> OSE5.2/refsys/modules/frescor_fosa_test\r
58         \r
59         {Repository}/../../frsh/trunk              \r
60                 -> OSE5.2/refsys/modules/frescor_frsh\r
61         \r
62 \95 Merge the OSE part of the following three files into its counterparts. \r
63   This point is due to the bad design of FRSH and FOSA. FOSA are not a \r
64   clean API, it also uses things from FRSH. The OSE parts are clearly \r
65   marked in the files with "////// OSE ///////" in the beginning and \r
66   "////// End of OSE ///////" in the end.\r
67 \r
68     {Repository}/src_ose/copies_of_changed_files/fosa_opaque_types.h\r
69        -> OSE5.2/refsys/modules/frescor_fosa/include/fosa_opaque_types.h\r
70 \r
71     {Repository}/src_ose/copies_of_changed_files/fosa_types.h\r
72        -> OSE5.2/refsys/modules/frescor_fosa/include/fosa_types.h\r
73        \r
74     {Repository}/src_ose/copies_of_changed_files/frsh_fosa_opaque.h\r
75        -> OSE5.2/refsys/modules/frescor_frsh/include/frsh_fosa_opaque.h\r
76        \r
77 \r
78 \95 Change the file krn.con in the OSE board catalogue \r
79   i.e. OSE5.2/refsys/rtose/sfk-win32/krn.con\r
80   Add the following lines:\r
81 \r
82         /* Added by Erik Thorin in krn.con */\r
83         CREATE_HANDLER    (fosa_ose_create_handler)\r
84         SWAP_IN_HANDLER   (fosa_ose_swap_in_handler)\r
85         SWAP_OUT_HANDLER  (fosa_ose_swap_out_handler)\r
86         SWAP_OUT_HANDLER  (fosa_ose_swap_out_handler2)\r
87         KILL_HANDLER      (fosa_ose_kill_handler)\r
88         USER_AREA         (21) /* Size of per process user area. */\r
89         /* End added by Erik Thorin */\r
90 \r
91 \95 Add the following lines to the file rtose.mk in the same catalogue \r
92 \r
93         #Added by Erik Thorin in rtose.mk\r
94         override MODS += frescor_fosa_handlers\r
95         override MODS += frescor_fosa\r
96         override MODS += frescor_fosa_test\r
97         #override MODS += frescor_frsh\r
98         #End added by Erik Thorin\r
99 \r
100 \r
101 --------------------------------------------------------------------------\r
102 ----------- End of the User Guide ----------------------------------------\r
103 --------------------------------------------------------------------------\r
104 \r
105 \r
106 // -----------------------------------------------------------------------\r
107 //  Copyright (C) 2006 - 2007 by the FRESCOR consortium:\r
108 //\r
109 //    Universidad de Cantabria,              SPAIN\r
110 //    University of York,                    UK\r
111 //    Scuola Superiore Sant'Anna,            ITALY\r
112 //    Kaiserslautern University,             GERMANY\r
113 //    Univ. Politecnica  Valencia,           SPAIN\r
114 //    Czech Technical University in Prague,  CZECH REPUBLIC\r
115 //    ENEA                                   SWEDEN\r
116 //    Thales Communication S.A.              FRANCE\r
117 //    Visual Tools S.A.                      SPAIN\r
118 //    Rapita Systems Ltd                     UK\r
119 //    Evidence                               ITALY\r
120 //\r
121 //    See http://www.frescor.org\r
122 //\r
123 //        The FRESCOR project (FP6/2005/IST/5-034026) is funded\r
124 //        in part by the European Union Sixth Framework Programme\r
125 //        The European Union is not liable of any use that may be\r
126 //        made of this code.\r
127 //\r
128 //  All rights reserved.\r
129 //\r
130 //  Redistribution and use in source and binary forms, with or \r
131 //  without modification, are permitted provided that the \r
132 //  following conditions are met:\r
133 //\r
134 //    * Redistributions of source code must retain the above \r
135 //      copyright notice, this list of conditions and the \r
136 //      following disclaimer.\r
137 //    * Redistributions in binary form must reproduce the above \r
138 //      copyright notice, this list of conditions and the \r
139 //      following disclaimer in the documentation and/or other \r
140 //      materials provided with the distribution.\r
141 //    * Neither the name of FRESCOR nor the names of its \r
142 //      contributors may be used to endorse or promote products \r
143 //      derived from this software without specific prior \r
144 //      written permission.\r
145 //\r
146 //  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND \r
147 //  CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, \r
148 //  INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF \r
149 //  MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE \r
150 //  DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR \r
151 //  CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, \r
152 //  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES \r
153 //  (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE \r
154 //  GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR \r
155 //  BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF \r
156 //  LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT \r
157 //  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT \r
158 //  OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE \r
159 //  POSSIBILITY OF SUCH DAMAGE.\r
160 // -----------------------------------------------------------------------\r
161 \r
162 This work has been funded in part by the European Community\92s Sixth\r
163 Framework Programme under the FRESCOR project (FP6/2005/IST/5-034026).