openapi_switch_cpu.h

Go to the documentation of this file.

/*********************************************************************
*
*  Copyright 2018 Broadcom.
*
*  Licensed under the Apache License, Version 2.0 (the "License");
*  you may not use this file except in compliance with the License.
*  You may obtain a copy of the License at
*
*      http://www.apache.org/licenses/LICENSE-2.0
*
*  Unless required by applicable law or agreed to in writing, software
*  distributed under the License is distributed on an "AS IS" BASIS,
*  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
*  See the License for the specific language governing permissions and
*  limitations under the License.
*
**********************************************************************
*
* @filename  openapi_switch_cpu.h
*
* @purpose   Switch CPU API
*
* @component OpEN
*
* @create    08/31/2018
*
* @end
*                                    
**********************************************************************/
#ifndef OPENAPI_SWITCH_CPU_H_INCLUDED
#define OPENAPI_SWITCH_CPU_H_INCLUDED

#include "openapi_common.h"

#define OPEN_CPU_UTIL_SCALAR 10000

#define OPEN_CPU_TASK_UTIL_SIZE         65

/* Header and footer prints */
#define OPEN_CPU_TASK_UTIL_HEADER_ROWS  5

/* The OPEN_CPU_TASK_COUNT_AVERAGE is used as average task count and is used to
 * calculate the minimum buffer size required. If the tasks are more, provide
 * the buffer size calculated with L7_CPU_UTIL_MAX_TASKS. If the tasks are more
 * than OPEN_CPU_TASK_COUNT_AVERAGE and provided a buffer calculated with
 * OPEN_CPU_TASK_COUNT_AVERAGE, the provided buffer size will be filled and 
 * skipping the remaining data.
 */
#define OPEN_CPU_TASK_COUNT_AVERAGE     100

typedef enum
{
  OPEN_CPU_UTIL_MONITOR_RISING_THRESHOLD_PARAM = 0,     
  OPEN_CPU_UTIL_MONITOR_RISING_PERIOD_PARAM = 1,        
  OPEN_CPU_UTIL_MONITOR_FALLING_THRESHOLD_PARAM = 2,    
  OPEN_CPU_UTIL_MONITOR_FALLING_PERIOD_PARAM = 3,       
  OPEN_CPU_UTIL_MONITOR_LAST_PARAM = 4                  
} OPEN_CPU_UTIL_MONITOR_PARAMS_t;

typedef struct
{
  uint32_t timePeriod;   
  uint32_t utilization;  
} OPEN_CPU_PERIOD_UTIL_INFO_t;

/*****************************************************************/
open_error_t openapiTotalCpuUtilArrayGet(openapiClientHandle_t *client_handle,
                                         open_buffdesc *data);

/*****************************************************************/
open_error_t openapiCpuUtilMaxPeriodsGet(openapiClientHandle_t *client_handle,
                                         uint32_t *max);

/*************************************************************************/
open_error_t openapiCpuUtilMonitorParamGet(openapiClientHandle_t *client_handle,
                                           OPEN_CPU_UTIL_MONITOR_PARAMS_t param_Type,
                                           uint32_t *param_val);

/*************************************************************************/
open_error_t openapiCpuUtilMonitorParamSet(openapiClientHandle_t *client_handle,
                                           OPEN_CPU_UTIL_MONITOR_PARAMS_t param_Type,
                                           uint32_t param_val);

/*****************************************************************/
open_error_t openapiTaskUtilPrint(openapiClientHandle_t *client_handle,
                                  open_buffdesc *data);
#endif  /* OPENAPI_SWITCH_CPU_H_INCLUDED */