Contiki 2.6

energest.h

Go to the documentation of this file.
00001 /*
00002  * Copyright (c) 2007, Swedish Institute of Computer Science.
00003  * All rights reserved.
00004  *
00005  * Redistribution and use in source and binary forms, with or without
00006  * modification, are permitted provided that the following conditions
00007  * are met:
00008  * 1. Redistributions of source code must retain the above copyright
00009  *    notice, this list of conditions and the following disclaimer.
00010  * 2. Redistributions in binary form must reproduce the above copyright
00011  *    notice, this list of conditions and the following disclaimer in the
00012  *    documentation and/or other materials provided with the distribution.
00013  * 3. Neither the name of the Institute nor the names of its contributors
00014  *    may be used to endorse or promote products derived from this software
00015  *    without specific prior written permission.
00016  *
00017  * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
00018  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00019  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
00020  * ARE DISCLAIMED.  IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
00021  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
00022  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
00023  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
00024  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
00025  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
00026  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
00027  * SUCH DAMAGE.
00028  *
00029  * This file is part of the Contiki operating system.
00030  *
00031  * $Id: energest.h,v 1.5 2009/10/20 20:19:27 adamdunkels Exp $
00032  */
00033 
00034 /**
00035  * \file
00036  *         Header file for the energy estimation mechanism
00037  * \author
00038  *         Adam Dunkels <adam@sics.se>
00039  */
00040 
00041 #ifndef __ENERGEST_H__
00042 #define __ENERGEST_H__
00043 
00044 #include "sys/rtimer.h"
00045 
00046 typedef struct {
00047   /*  unsigned long cumulative[2];*/
00048   unsigned long current;
00049 } energest_t;
00050 
00051 enum energest_type {
00052   ENERGEST_TYPE_CPU,
00053   ENERGEST_TYPE_LPM,
00054   ENERGEST_TYPE_IRQ,
00055   ENERGEST_TYPE_LED_GREEN,
00056   ENERGEST_TYPE_LED_YELLOW,
00057   ENERGEST_TYPE_LED_RED,
00058   ENERGEST_TYPE_TRANSMIT,
00059   ENERGEST_TYPE_LISTEN,
00060 
00061   ENERGEST_TYPE_FLASH_READ,
00062   ENERGEST_TYPE_FLASH_WRITE,
00063 
00064   ENERGEST_TYPE_SENSORS,
00065 
00066   ENERGEST_TYPE_SERIAL,
00067 
00068   ENERGEST_TYPE_MAX
00069 };
00070 
00071 void energest_init(void);
00072 unsigned long energest_type_time(int type);
00073 #ifdef ENERGEST_CONF_LEVELDEVICE_LEVELS
00074 unsigned long energest_leveldevice_leveltime(int powerlevel);
00075 #endif
00076 void energest_type_set(int type, unsigned long value);
00077 void energest_flush(void);
00078 
00079 #if ENERGEST_CONF_ON
00080 /*extern int energest_total_count;*/
00081 extern energest_t energest_total_time[ENERGEST_TYPE_MAX];
00082 extern rtimer_clock_t energest_current_time[ENERGEST_TYPE_MAX];
00083 extern unsigned char energest_current_mode[ENERGEST_TYPE_MAX];
00084 
00085 #ifdef ENERGEST_CONF_LEVELDEVICE_LEVELS
00086 extern energest_t energest_leveldevice_current_leveltime[ENERGEST_CONF_LEVELDEVICE_LEVELS];
00087 #endif
00088 
00089 #define ENERGEST_ON(type)  do { \
00090                            /*++energest_total_count;*/ \
00091                            energest_current_time[type] = RTIMER_NOW(); \
00092                            energest_current_mode[type] = 1; \
00093                            } while(0)
00094 #ifdef __AVR__
00095 /* Handle 16 bit rtimer wraparound */
00096 #define ENERGEST_OFF(type) if(energest_current_mode[type] != 0) do {    \
00097                                                         if (RTIMER_NOW() < energest_current_time[type]) energest_total_time[type].current += RTIMER_ARCH_SECOND; \
00098                                                         energest_total_time[type].current += (rtimer_clock_t)(RTIMER_NOW() - \
00099                                                         energest_current_time[type]); \
00100                                                         energest_current_mode[type] = 0; \
00101                            } while(0)
00102 
00103 #define ENERGEST_OFF_LEVEL(type,level) do { \
00104                                                                                 if (RTIMER_NOW() < energest_current_time[type]) energest_total_time[type].current += RTIMER_ARCH_SECOND; \
00105                                                                                 energest_leveldevice_current_leveltime[level].current += (rtimer_clock_t)(RTIMER_NOW() - \
00106                                                                                 energest_current_time[type]); \
00107                                                                                 energest_current_mode[type] = 0; \
00108                                        } while(0)
00109 #else
00110 #define ENERGEST_OFF(type) if(energest_current_mode[type] != 0) do {    \
00111                            energest_total_time[type].current += (rtimer_clock_t)(RTIMER_NOW() - \
00112                            energest_current_time[type]); \
00113                            energest_current_mode[type] = 0; \
00114                            } while(0)
00115 
00116 #define ENERGEST_OFF_LEVEL(type,level) do { \
00117                                         energest_leveldevice_current_leveltime[level].current += (rtimer_clock_t)(RTIMER_NOW() - \
00118                                         energest_current_time[type]); \
00119                            energest_current_mode[type] = 0; \
00120                                         } while(0)
00121 #endif
00122 
00123 
00124 #else /* ENERGEST_CONF_ON */
00125 #define ENERGEST_ON(type) do { } while(0)
00126 #define ENERGEST_OFF(type) do { } while(0)
00127 #define ENERGEST_OFF_LEVEL(type,level) do { } while(0)
00128 #endif /* ENERGEST_CONF_ON */
00129 
00130 #endif /* __ENERGEST_H__ */