frsh_energy_management_types.h

   1 // -----------------------------------------------------------------------
   2 //  Copyright (C) 2006 - 2009 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 FRSH (FRescor ScHeduler)
  35 //
  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.
  46 //
  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 // -----------------------------------------------------------------------
  55 //frsh_energy_management_types.h
  56 //==============================================
  57 //  ******** *******    ********  **      **
  58 //  **///// /**////**  **//////  /**     /**
  59 //  **      /**   /** /**        /**     /**
  60 //  ******* /*******  /********* /**********
  61 //  **////  /**///**  ////////** /**//////**
  62 //  **      /**  //**        /** /**     /**
  63 //  **      /**   //** ********  /**     /**
  64 //  //       //     // ////////   //      //
  65 //
  66 // FRSH(FRescor ScHeduler), pronounced "fresh"
  67 //==============================================
  68 #ifndef         FRSH_ENERGY_MANAGEMENT_TYPES_H_
  69 #define         FRSH_ENERGY_MANAGEMENT_TYPES_H_
  70
  71 #include <time.h>
  72 #include "frsh_core_types.h"
  73
  74 FRSH_CPP_BEGIN_DECLS
  75
  76 /**
  77  * @file frsh_energy_management_types.h
  78  **/
  79
  80 /**
  81  * @addtogroup energymgmnt
  82  *
  83  * @{
  84  **/
  85
  86
  87
  88
  89 /**
  90  * Here we define the different power levels.  They will be
  91  * used as index to the budget arrays in energy management.
  92  **/
  93 typedef enum {
  94     FRSH_PLT_HIGH   = 0,
  95     FRSH_PLT_MEDIUM = 1,
  96     FRSH_PLT_LOW    = 2
  97 } frsh_power_level_t;
  98
  99
 100 /**
 101  * Here we define a capacity specification for all power levels.
 102  **/
 103 typedef struct {
 104     frsh_rel_time_t budget[3];
 105     frsh_rel_time_t period;
 106 } frsh_utilization_line_pow_t;
 107
 108 /**
 109  * Here we define the utilization set for different power levels
 110  **/
 111 typedef struct {
 112     int size;
 113     frsh_utilization_line_pow_t utilizations[FRSH_MAX_N_UTILIZATION_VALUES];
 114 } frsh_utilization_set_pow_t;
 115
 116 FRSH_CPP_END_DECLS
 117
 118 #endif      /* !FRSH_ENERGY_MANAGEMENT_TYPES_H_ */