core/sys/energest.h

   1 /*
   2  * Copyright (c) 2007, Swedish Institute of Computer Science.
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  * 3. Neither the name of the Institute nor the names of its contributors
  14  *    may be used to endorse or promote products derived from this software
  15  *    without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
  18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
  21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  27  * SUCH DAMAGE.
  28  *
  29  * This file is part of the Contiki operating system.
  30  *
  31  * $Id: energest.h,v 1.5 2009/10/20 20:19:27 adamdunkels Exp $
  32  */
  33
  34 /**
  35  * \file
  36  *         Header file for the energy estimation mechanism
  37  * \author
  38  *         Adam Dunkels <adam@sics.se>
  39  */
  40
  41 #ifndef __ENERGEST_H__
  42 #define __ENERGEST_H__
  43
  44 #include "sys/rtimer.h"
  45
  46 typedef struct {
  47   /*  unsigned long cumulative[2];*/
  48   unsigned long current;
  49 } energest_t;
  50
  51 enum energest_type {
  52   ENERGEST_TYPE_CPU,
  53   ENERGEST_TYPE_LPM,
  54   ENERGEST_TYPE_IRQ,
  55   ENERGEST_TYPE_LED_GREEN,
  56   ENERGEST_TYPE_LED_YELLOW,
  57   ENERGEST_TYPE_LED_RED,
  58   ENERGEST_TYPE_TRANSMIT,
  59   ENERGEST_TYPE_LISTEN,
  60
  61   ENERGEST_TYPE_FLASH_READ,
  62   ENERGEST_TYPE_FLASH_WRITE,
  63
  64   ENERGEST_TYPE_SENSORS,
  65
  66   ENERGEST_TYPE_SERIAL,
  67
  68   ENERGEST_TYPE_MAX
  69 };
  70
  71 void energest_init(void);
  72 unsigned long energest_type_time(int type);
  73 #ifdef ENERGEST_CONF_LEVELDEVICE_LEVELS
  74 unsigned long energest_leveldevice_leveltime(int powerlevel);
  75 #endif
  76 void energest_type_set(int type, unsigned long value);
  77 void energest_flush(void);
  78
  79 #if ENERGEST_CONF_ON
  80 /*extern int energest_total_count;*/
  81 extern energest_t energest_total_time[ENERGEST_TYPE_MAX];
  82 extern rtimer_clock_t energest_current_time[ENERGEST_TYPE_MAX];
  83 extern unsigned char energest_current_mode[ENERGEST_TYPE_MAX];
  84
  85 #ifdef ENERGEST_CONF_LEVELDEVICE_LEVELS
  86 extern energest_t energest_leveldevice_current_leveltime[ENERGEST_CONF_LEVELDEVICE_LEVELS];
  87 #endif
  88
  89 #define ENERGEST_ON(type)  do { \
  90                            /*++energest_total_count;*/ \
  91                            energest_current_time[type] = RTIMER_NOW(); \
  92                            energest_current_mode[type] = 1; \
  93                            } while(0)
  94
  95 #define ENERGEST_OFF(type) if(energest_current_mode[type] != 0) do {    \
  96                            energest_total_time[type].current += (rtimer_clock_t)(RTIMER_NOW() - \
  97                            energest_current_time[type]); \
  98                            energest_current_mode[type] = 0; \
  99                            } while(0)
 100
 101 #define ENERGEST_OFF_LEVEL(type,level) do { \
 102                                         energest_leveldevice_current_leveltime[level].current += (rtimer_clock_t)(RTIMER_NOW() - \
 103                                         energest_current_time[type]); \
 104                            energest_current_mode[type] = 0; \
 105                                         } while(0)
 106
 107
 108 #else /* ENERGEST_CONF_ON */
 109 #define ENERGEST_ON(type) do { } while(0)
 110 #define ENERGEST_OFF(type) do { } while(0)
 111 #define ENERGEST_OFF_LEVEL(type,level) do { } while(0)
 112 #endif /* ENERGEST_CONF_ON */
 113
 114 #endif /* __ENERGEST_H__ */