SystemResources.hpp

Go to the documentation of this file.

// ======================================================================
// \title  SystemResources.hpp
// \author mstarch
// \brief  hpp file for SystemResources component implementation class
//
// \copyright
// Copyright 2021, by the California Institute of Technology.
// ALL RIGHTS RESERVED.  United States Government Sponsorship
// acknowledged.
//
// ======================================================================
#ifndef _SystemResources_hpp_
#define _SystemResources_hpp_
 
#include <FpConfig.hpp>
 
namespace Os {
namespace SystemResources {
 
enum SystemResourcesStatus {
    SYSTEM_RESOURCES_OK,     
    SYSTEM_RESOURCES_ERROR,  
};
 
struct CpuTicks {
    FwSizeType used;   
    FwSizeType total;  
};
 
struct MemUtil {
    FwSizeType used;   
    FwSizeType total;  
};
 
SystemResourcesStatus getCpuCount(U32& cpu_count);
 
SystemResourcesStatus getCpuTicks(CpuTicks& ticks, U32 cpu_index = 0);
 
SystemResourcesStatus getMemUtil(MemUtil& memory_util);
}  // namespace SystemResources
}  // namespace Os
 
#endif