Adding frsh_usec_to_rel_time()

[frescor/frsh-include.git] / frsh_shared_objects_types.h

diff --git a/frsh_shared_objects_types.h b/frsh_shared_objects_types.h
index d27266c6f172fca81483d11defe6a0cd289c0e47..582c59c175c504516b46baa1333a679f96095fcd 100644 (file)
--- a/frsh_shared_objects_types.h
+++ b/frsh_shared_objects_types.h
@@ -73,36 +73,49 @@
 #define        FRSH_SHARED_OBJECTS_TYPES_H_
 
 #include <time.h>
-#include "frsh_opaque_types.h"
+#include "frsh_core_types.h"
 #include "frsh_configuration_parameters.h"
 
+FRSH_CPP_BEGIN_DECLS
+
+/**
+ * @file frsh_shared_objects_types.h
+ **/
+
 /**
  * @addtogroup sharedobj
  *
  * @{
  **/
 
-
-typedef char * frsh_shared_obj_id_t;     
+/** Mutex object.  Attributes are handled by FOSA **/
+typedef fosa_mutex_t frsh_mutex_t;
 
 
 /** 
  *  Shared object handle:  It is an opaque type (i.e. the internal
  *  structure of this data type is implementation dependent).
  **/
-typedef FRSH_SHARED_OBJ_HANDLE_T_OPAQUE  frsh_shared_obj_handle_t; 
+typedef FRSH_SHAREDOBJ_HANDLE_T_OPAQUE  frsh_sharedobj_handle_t; 
 
+/**
+ *  Shared object textual label
+ **/
+typedef char frsh_sharedobj_label_t[FRSH_MAX_SIZE_SHARED_OBJ_LABEL + 1];
 
 /**
- * Kind of shared object
+ * Kind of shared object: protected or unprotected
  */
-typedef enum {FRSH_SOK_UNPROTECTED, FRSH_SOK_PROTECTED}
-          frsh_shared_obj_kind_t;                           
+typedef enum 
+  {FRSH_SOK_UNPROTECTED, FRSH_SOK_PROTECTED}
+frsh_sharedobj_kind_t;
 
 /**
- * Kind of protected operation
- */
-typedef enum {FRSH_CSOK_UNPROTECTED, FRSH_CSOK_READ, FRSH_CSOK_WRITE} frsh_critical_section_op_kind_t;                           
+ * Kind of protected operation: read, write or unchecked
+ **/
+typedef enum 
+  {FRSH_CSOK_UNCHECKED, FRSH_CSOK_READ, FRSH_CSOK_WRITE} 
+frsh_csect_op_kind_t;                           
 
 /**
  *  Pointer to protected operation, which takes a pointer to
@@ -110,7 +123,7 @@ typedef enum {FRSH_CSOK_UNPROTECTED, FRSH_CSOK_READ, FRSH_CSOK_WRITE} frsh_criti
  *  parameters; the user is responsible for not exceeding the 
  *  sizes of the respective input and output parameters data structures
  */
-typedef void (*frsh_critical_section_op_t)
+typedef void (*frsh_csect_op_t)
           (const void * input_arg, void * output_arg);
 
 /**
@@ -121,28 +134,32 @@ typedef struct {
   void * area;
 } frsh_memory_area_data_t;
 
-/** Memory areas container **/
+/** 
+ * Memory areas container 
+ **/
 typedef struct {
     int size; // = 0
-    frsh_memory_area_data_t section[FRSH_MAX_N_MEMORY_AREAS];
+    frsh_memory_area_data_t memory_areas[FRSH_MAX_N_MEMORY_AREAS];
 } frsh_memory_areas_t;
 
 
 /**
- * Critical section data (opaque type) 
+ * Critical section data (opaque type)
  **/
-typedef FRSH_CRITICAL_SECTION_DATA_T_OPAQUE 
-        frsh_critical_section_data_t;
+typedef FRSH_CSECT_T_OPAQUE frsh_csect_t;
 
 
 /**
- * Critical section container 
+ * Container of a group of critical sections, up to a maximum size
  **/
 typedef struct {
-    int size; // = 0
-    frsh_critical_section_data_t section[FRSH_MAX_N_CRITICAL_SECTIONS];
-} frsh_critical_sections_t;
+  int size;     // size of the group; initially=0
+  frsh_csect_t csects[FRSH_MAX_N_CRITICAL_SECTIONS]; // array of csect 
+} frsh_csects_group_t;
 
 /*@}*/
 
+
+FRSH_CPP_END_DECLS
+
 #endif             /* !FRSH_SHARED_OBJECTS_TYPES_H_ */