1 // -----------------------------------------------------------------------
2 // Copyright (C) 2006 - 2008 FRESCOR consortium partners:
4 // Universidad de Cantabria, SPAIN
5 // University of York, UK
6 // Scuola Superiore Sant'Anna, ITALY
7 // Kaiserslautern University, GERMANY
8 // Univ. Politécnica Valencia, SPAIN
9 // Czech Technical University in Prague, CZECH REPUBLIC
11 // Thales Communication S.A. FRANCE
12 // Visual Tools S.A. SPAIN
13 // Rapita Systems Ltd UK
16 // See http://www.frescor.org for a link to partners' websites
18 // FRESCOR project (FP6/2005/IST/5-034026) is funded
19 // in part by the European Union Sixth Framework Programme
20 // The European Union is not liable of any use that may be
24 // based on previous work (FSF) done in the FIRST project
26 // Copyright (C) 2005 Mälardalen University, SWEDEN
27 // Scuola Superiore S.Anna, ITALY
28 // Universidad de Cantabria, SPAIN
29 // University of York, UK
31 // FSF API web pages: http://marte.unican.es/fsf/docs
32 // http://shark.sssup.it/contrib/first/docs/
34 // This file is part of FRSH (FRescor ScHeduler)
36 // FRSH is free software; you can redistribute it and/or modify it
37 // under terms of the GNU General Public License as published by the
38 // Free Software Foundation; either version 2, or (at your option) any
39 // later version. FRSH is distributed in the hope that it will be
40 // useful, but WITHOUT ANY WARRANTY; without even the implied warranty
41 // of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
42 // General Public License for more details. You should have received a
43 // copy of the GNU General Public License along with FRSH; see file
44 // COPYING. If not, write to the Free Software Foundation, 675 Mass Ave,
45 // Cambridge, MA 02139, USA.
47 // As a special exception, including FRSH header files in a file,
48 // instantiating FRSH generics or templates, or linking other files
49 // with FRSH objects to produce an executable application, does not
50 // by itself cause the resulting executable application to be covered
51 // by the GNU General Public License. This exception does not
52 // however invalidate any other reasons why the executable file might be
53 // covered by the GNU Public License.
54 // -----------------------------------------------------------------------
56 //==============================================
57 // ******** ******* ******** ** **
58 // **///// /**////** **////// /** /**
59 // ** /** /** /** /** /**
60 // ******* /******* /********* /**********
61 // **//// /**///** ////////** /**//////**
62 // ** /** //** /** /** /**
63 // ** /** //** ******** /** /**
64 // // // // //////// // //
66 // FRSH(FRescor ScHeduler), pronounced "fresh"
67 //==============================================
69 #ifndef FRSH_SHARED_OBJECTS_TYPES_H_
70 #define FRSH_SHARED_OBJECTS_TYPES_H_
73 #include "frsh_core_types.h"
74 #include "frsh_configuration_parameters.h"
79 * @file frsh_shared_objects_types.h
83 * @addtogroup sharedobj
88 /** Mutex object. Attributes are handled by FOSA **/
89 typedef fosa_mutex_t frsh_mutex_t;
93 * Shared object handle: It is an opaque type (i.e. the internal
94 * structure of this data type is implementation dependent).
96 typedef FRSH_SHAREDOBJ_HANDLE_T_OPAQUE frsh_sharedobj_handle_t;
99 * Shared object textual label
101 typedef char frsh_sharedobj_label_t[FRSH_MAX_SIZE_SHARED_OBJ_LABEL + 1];
104 * Kind of shared object: protected or unprotected
107 {FRSH_SOK_UNPROTECTED, FRSH_SOK_PROTECTED}
108 frsh_sharedobj_kind_t;
111 * Kind of protected operation: read, write or unchecked
114 {FRSH_CSOK_UNCHECKED, FRSH_CSOK_READ, FRSH_CSOK_WRITE}
115 frsh_csect_op_kind_t;
118 * Pointer to protected operation, which takes a pointer to
119 * the input parameters, and a pointer to the output
120 * parameters; the user is responsible for not exceeding the
121 * sizes of the respective input and output parameters data structures
123 typedef void (*frsh_csect_op_t)
124 (const void * input_arg, void * output_arg);
132 } frsh_memory_area_data_t;
135 * Memory areas container
139 frsh_memory_area_data_t memory_areas[FRSH_MAX_N_MEMORY_AREAS];
140 } frsh_memory_areas_t;
144 * Critical section data (opaque type)
146 typedef FRSH_CSECT_T_OPAQUE frsh_csect_t;
150 * Container of a group of critical sections, up to a maximum size
153 int size; // size of the group; initially=0
154 frsh_csect_t csects[FRSH_MAX_N_CRITICAL_SECTIONS]; // array of csect
155 } frsh_csects_group_t;
162 #endif /* !FRSH_SHARED_OBJECTS_TYPES_H_ */