osd-contiki/core/lib/energest.h
nifi d76474bc13 Changed energest_type_time() to first update the total time, if the device
is currently active, before returning the total time.

Added energest_flush() that updates the total time for all currently
active devices. It should be called periodically to avoid the time to
overflow for devices that are active for long periods of time.
2008-06-02 13:12:07 +00:00

116 lines
4.1 KiB
C

/*
* Copyright (c) 2007, Swedish Institute of Computer Science.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* 3. Neither the name of the Institute nor the names of its contributors
* may be used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*
* This file is part of the Contiki operating system.
*
* $Id: energest.h,v 1.10 2008/06/02 13:12:07 nifi Exp $
*/
/**
* \file
* Header file for the energy estimation mechanism
* \author
* Adam Dunkels <adam@sics.se>
*/
#ifndef __ENERGEST_H__
#define __ENERGEST_H__
#include "sys/rtimer.h"
typedef struct {
/* unsigned long cummulative[2];*/
unsigned long current;
} energest_t;
enum energest_type {
ENERGEST_TYPE_CPU,
ENERGEST_TYPE_LPM,
ENERGEST_TYPE_IRQ,
ENERGEST_TYPE_LED_GREEN,
ENERGEST_TYPE_LED_YELLOW,
ENERGEST_TYPE_LED_RED,
ENERGEST_TYPE_TRANSMIT,
ENERGEST_TYPE_LISTEN,
ENERGEST_TYPE_SENSORS,
ENERGEST_TYPE_SERIAL,
ENERGEST_TYPE_MAX
};
void energest_init(void);
unsigned long energest_type_time(int type);
#ifdef ENERGEST_CONF_LEVELDEVICE_LEVELS
unsigned long energest_leveldevice_leveltime(int powerlevel);
#endif
void energest_type_set(int type, unsigned long value);
void energest_flush(void);
#if ENERGEST_CONF_ON
/*extern int energest_total_count;*/
extern energest_t energest_total_time[ENERGEST_TYPE_MAX];
extern unsigned short energest_current_time[ENERGEST_TYPE_MAX];
extern unsigned char energest_current_mode[ENERGEST_TYPE_MAX];
#ifdef ENERGEST_CONF_LEVELDEVICE_LEVELS
extern energest_t energest_leveldevice_current_leveltime[ENERGEST_CONF_LEVELDEVICE_LEVELS];
#endif
#define ENERGEST_ON(type) do { \
/*++energest_total_count;*/ \
energest_current_time[type] = RTIMER_NOW(); \
energest_current_mode[type] = 1; \
} while(0)
#define ENERGEST_OFF(type) do { \
energest_total_time[type].current += (unsigned long)((signed short)RTIMER_NOW() - \
(signed short)energest_current_time[type]); \
energest_current_mode[type] = 0; \
} while(0)
#define ENERGEST_OFF_LEVEL(type,level) do { \
energest_leveldevice_current_leveltime[level].current += (unsigned long)((signed short)RTIMER_NOW() - \
(signed short)energest_current_time[type]); \
energest_current_mode[type] = 0; \
} while(0)
#else /* ENERGEST_CONF_ON */
#define ENERGEST_ON(type) do { } while(0)
#define ENERGEST_OFF(type) do { } while(0)
#define ENERGEST_OFF_LEVEL(type,level) do { } while(0)
#endif /* ENERGEST_CONF_ON */
#define ENERGEST_SECOND RTIMER_ARCH_SECOND
unsigned long energest_arch_current_estimate(void);
unsigned short energest_arch_now(void);
#endif /* __ENERGEST_H__ */