msr_thermal.h

Go to the documentation of this file.

/* msr_thermal.h
 *
 * Copyright (c) 2011-2016, Lawrence Livermore National Security, LLC.
 * LLNL-CODE-645430
 *
 * Produced at Lawrence Livermore National Laboratory
 * Written by  Barry Rountree, rountree@llnl.gov
 *             Scott Walker,   walker91@llnl.gov
 *             Kathleen Shoga, shoga1@llnl.gov
 *
 * All rights reserved.
 *
 * This file is part of libmsr.
 *
 * libmsr is free software: you can redistribute it and/or modify it under the
 * terms of the GNU Lesser General Public License as published by the Free
 * Software Foundation, either version 3 of the License, or (at your option)
 * any later version.
 *
 * libmsr is distributed in the hope that it will be useful, but WITHOUT ANY
 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
 * details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with libmsr. If not, see <http://www.gnu.org/licenses/>.
 *
 * This material is based upon work supported by the U.S. Department of
 * Energy's Lawrence Livermore National Laboratory. Office of Science, under
 * Award number DE-AC52-07NA27344.
 *
 */

#ifndef MSR_THERMAL_H_INCLUDE
#define MSR_THERMAL_H_INCLUDE

#include <stdio.h>

#include "master.h"

#ifdef __cplusplus
extern "C" {
#endif

struct msr_temp_target {
    uint64_t **raw;
    uint64_t *temp_target;
};

struct therm_stat {
    uint64_t **raw;
    int *status;
    int *status_log;
    int *PROCHOT_or_FORCEPR_event;
    int *PROCHOT_or_FORCEPR_log;
    int *crit_temp_status;
    int *crit_temp_log;
    int *therm_thresh1_status;
    int *therm_thresh1_log;
    int *therm_thresh2_status;
    int *therm_thresh2_log;
    int *power_limit_status;
    int *power_notification_log;
    int *readout;
    int *resolution_deg_celsius;
    int *readout_valid;
};

struct therm_interrupt {
    uint64_t **raw;
    int *high_temp_enable;
    int *low_temp_enable;
    int *PROCHOT_enable;
    int *FORCEPR_enable;
    int *crit_temp_enable;
    int *thresh1_val;
    int *thresh1_enable;
    int *thresh2_val;
    int *thresh2_enable;
    int *pwr_limit_notification_enable;
};

struct pkg_therm_stat {
    uint64_t **raw;
    int *status;
    int *status_log;
    int *PROCHOT_event;
    int *PROCHOT_log;
    int *crit_temp_status;
    int *crit_temp_log;
    int *therm_thresh1_status;
    int *therm_thresh1_log;
    int *therm_thresh2_status;
    int *therm_thresh2_log;
    int *power_limit_status;    //Read only
    int *power_notification_log;
    int *readout;
};

struct pkg_therm_interrupt {
    uint64_t **raw;
    int *high_temp_enable;
    int *low_temp_enable;
    int *PROCHOT_enable;
    int *crit_temp_enable;
    int *thresh1_val;
    int *thresh1_enable;
    int *thresh2_val;
    int *thresh2_enable;
    int *pwr_limit_notification_enable;
};

void store_temp_target(struct msr_temp_target **tt);

void store_therm_stat(struct therm_stat **ts);

void store_therm_interrupt(struct therm_interrupt **ti);

void store_pkg_therm_stat(struct pkg_therm_stat **ps);

void store_pkg_therm_interrupt(struct pkg_therm_interrupt **pi);

void is_init(void);

/************************************/
/* MSR_TEMPERATURE_TARGET Functions */
/************************************/

void get_temp_target(struct msr_temp_target *s);

/*********************************************/
/* Thermal Functions (Status and Interrupts) */
/*********************************************/

void get_therm_stat(struct therm_stat *s);

void get_therm_interrupt(struct therm_interrupt *s);

void get_pkg_therm_stat(struct pkg_therm_stat *s);

void get_pkg_therm_interrupt(struct pkg_therm_interrupt *s);

int therm2_ctl_storage(uint64_t **thermctlref);

int get_pkg_therm2_ctl(void);

int dump_therm2_ctl(FILE *writedest);

void set_therm_stat(struct therm_stat *s);

void set_therm_interrupt(struct therm_interrupt *s);

void set_pkg_therm_stat(struct pkg_therm_stat *s);

void set_pkg_therm_interrupt(struct pkg_therm_interrupt *s);

void dump_therm_data_terse_label(FILE *writedest);

void dump_therm_data_terse(FILE *writedest);

void dump_therm_data_verbose_label(FILE *writedest);

void dump_therm_temp_reading(FILE *writedest);

void dump_therm_data_verbose(FILE *writedest);

#ifdef __cplusplus
}
#endif
#endif