/***************************************************************************
 *             __________               __   ___.
 *   Open      \______   \ ____   ____ |  | _\_ |__   _______  ___
 *   Source     |       _//  _ \_/ ___\|  |/ /| __ \ /  _ \  \/  /
 *   Jukebox    |    |   (  <_> )  \___|    < | \_\ (  <_> > <  <
 *   Firmware   |____|_  /\____/ \___  >__|_ \|___  /\____/__/\_ \
 *                     \/            \/     \/    \/            \/
 *
 * Copyright (C) 2011 Thomas Martitz
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
 * KIND, either express or implied.
 *
 ****************************************************************************/


#ifndef __CPUINFO_LINUX_H__
#define __CPUINFO_LINUX_H__

#include <stdbool.h>

struct cpuusage {
    long usage; /* in hundredth percent */
    long utime; /* in clock ticks */
    long stime; /* in clock ticks */
    long rtime; /* in clock ticks */
    long hz;    /* how clock ticks per second */
};

struct time_state {
    long frequency;
    long time;
};

int cpuusage_linux(struct cpuusage* u);
/* Return the frequency of a CPU. Note that whenever CPU frequency scaling is supported by the
 * driver, this frequency may not be accurate and may vaguely reflect the cpu mode. Use
 * current_scaling_frequency() to get the actual frequency if scaling is supported.
 * Return -1 on error. */
int frequency_linux(int cpu);

/*
    Get the current cpufreq scaling governor.
    cpu [in]: The number of the cpu to query.
    governor [out]: Buffer for the governor.
    governor_size [in]: Size of the buffer for the governor.
    Returns true on success, false else.
*/
bool current_scaling_governor(int cpu, char* governor, int governor_size);


/*
    Get the minimum, current or maximum cpufreq scaling frequency.
    cpu [in]: The number of the cpu to query.
    Returns -1 failure.
*/
int min_scaling_frequency(int cpu);
int current_scaling_frequency(int cpu);
int max_scaling_frequency(int cpu);

int cpustatetimes_linux(int cpu, struct time_state* data, int max_elements);
int cpucount_linux(void);

#endif /* __CPUINFO_LINUX_H__ */
