src_aquosa/fosa_group_clocks.c

   1 // -----------------------------------------------------------------------
   2 //  Copyright (C) 2006 - 2008 FRESCOR consortium partners:
   3 //
   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
  10 //    ENEA                                   SWEDEN
  11 //    Thales Communication S.A.              FRANCE
  12 //    Visual Tools S.A.                      SPAIN
  13 //    Rapita Systems Ltd                     UK
  14 //    Evidence                               ITALY
  15 //
  16 //    See http://www.frescor.org for a link to partners' websites
  17 //
  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
  21 //        made of this code.
  22 //
  23 //
  24 //  based on previous work (FSF) done in the FIRST project
  25 //
  26 //   Copyright (C) 2005  Mälardalen University, SWEDEN
  27 //                       Scuola Superiore S.Anna, ITALY
  28 //                       Universidad de Cantabria, SPAIN
  29 //                       University of York, UK
  30 //
  31 //   FSF API web pages: http://marte.unican.es/fsf/docs
  32 //                      http://shark.sssup.it/contrib/first/docs/
  33 //
  34 //   This file is part of FOSA (Frsh Operating System Adaption)
  35 //
  36 //  FOSA 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.  FOSA 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 FOSA; see file
  44 //  COPYING. If not, write to the Free Software Foundation, 675 Mass Ave,
  45 //  Cambridge, MA 02139, USA.
  46 //
  47 //  As a special exception, including FOSA header files in a file,
  48 //  instantiating FOSA generics or templates, or linking other files
  49 //  with FOSA 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 // -----------------------------------------------------------------------
  55 //fosa_group_clocks.c
  56 //==============================================
  57 //  ********  ******    ********  **********
  58 //  **///// /**    **  **//////  /**     /**
  59 //  **      /**    ** /**        /**     /**
  60 //  ******* /**    ** /********* /**********
  61 //  **////  /**    ** ////////** /**//////**
  62 //  **      /**    **        /** /**     /**
  63 //  **      /**    **  ********  /**     /**
  64 //  //       /******/  ////////   //      //
  65 //
  66 // FOSA(Frescor Operating System Adaptation layer)
  67 //================================================
  68
  69
  70 #include "fosa_group_clocks.h"
  71
  72 /**
  73  * fosa_thread_set_create()
  74  *
  75  * Create an empty thread set and return an identifier
  76  *
  77  * This function stores in the variable pointed to by set the
  78  * identifier of a thread set that is created by the function.
  79  *
  80  * Returns 0 if successful; otherwise it returns an error code:
  81  *    FOSA_EAGAIN: no resources are currently available to create the
  82  *    thread set
  83  *
  84  * Alternatively, in case of error the implementation is allowed to
  85  * notify it to the system console and then terminate the FRSH
  86  * implementation and dependant applications
  87  **/
  88 int fosa_thread_set_create(fosa_thread_set_id_t *set)
  89 {
  90         return EINVAL;
  91 }
  92
  93
  94 /**
  95  * fosa_thread_set_destroy()
  96  *
  97  * Destroy a thread set
  98  *
  99  * This function destroys the thread set identified by set. The
 100  * threads that were in the set are detached from the set.  It is
 101  * an error to use the identifier after this call. The effects of
 102  * using a CPU-time clock associated with the destroyed thread are
 103  * undefined.
 104  *
 105  * Returns 0 if successful; otherwise it returns an error code:
 106  *    FOSA_EINVAL: set is invalid
 107  *
 108  * Alternatively, in case of error the implementation is allowed to
 109  * notify it to the system console and then terminate the FRSH
 110  * implementation and dependant applications
 111  **/
 112 int fosa_thread_set_destroy(fosa_thread_set_id_t set)
 113 {
 114         return EINVAL;
 115 }
 116
 117
 118 /**
 119  * fosa_thread_set_add()
 120  *
 121  * Add a thread to a thread set
 122  *
 123  * This function adds the thread identified with thread_id to the
 124  * thread set identified by set.
 125  *
 126  * Returns 0 if successful; otherwise it returns an error code:
 127  *    FOSA_EINVAL: set is invalid
 128  *    FOSA_ENOTSUP: thread already a member of some other set
 129  *    FOSA_EAGAIN: no resources available to add the new thread
 130  *    FOSA_ESRCH: thread_id doesn't identify a valid thread
 131  *
 132  * Alternatively, in case of error the implementation is allowed to
 133  * notify it to the system console and then terminate the FRSH
 134  * implementation and dependant applications
 135  **/
 136 int fosa_thread_set_add(fosa_thread_set_id_t set, fosa_thread_id_t thread_id)
 137 {
 138         return EINVAL;
 139 }
 140
 141
 142 /**
 143  * fosa_thread_set_del()
 144  *
 145  * Delete a thread from a thread set
 146  *
 147  * This function deletes the thread identified with thread_id from
 148  *  the thread set identified by set.
 149  *
 150  * Returns 0 if successful; otherwise it returns an error code:
 151  *    FOSA_EINVAL: set is invalid
 152  *    FOSA_EINVAL: thread is not a member of the set
 153  *    FOSA_ESRCH: thread_id doesn't identify a valid thread
 154  *
 155  * Alternatively, in case of error the implementation is allowed to
 156  * notify it to the system console and then terminate the FRSH
 157  * implementation and dependant applications
 158  **/
 159
 160 int fosa_thread_set_del(fosa_thread_set_id_t set, fosa_thread_id_t thread_id)
 161 {
 162         return EINVAL;
 163 }
 164
 165
 166 /**
 167  * fosa_get_groupcpu_clock()
 168  *
 169  * Get the identifier of a cpu-time clock associated to a thread
 170  * set
 171  *
 172  * This function stores in the variable pointed to by clockid the
 173  * identifier of a cpu-time clock for the thread set specified
 174  * by set.
 175  *
 176  * Returns 0 if successful; otherwise it returns an error code:
 177  *    FOSA_EINVAL: the set is invalid
 178  *    FOSA_EINVAL: clock_id is a null pointer
 179  *
 180  * Alternatively, in case of error the implementation is allowed to
 181  * notify it to the system console and then terminate the FRSH
 182  * implementation and dependant applications
 183  **/
 184 int fosa_get_groupcpu_clock(const fosa_thread_set_id_t set,
 185                             fosa_clock_id_t *clock_id)
 186 {
 187         return EINVAL;
 188 }
 189