aiclk_ppm.h

Go to the documentation of this file.

/*
 * Copyright (c) 2024 Tenstorrent AI ULC
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef AICLK_PPM_H
#define AICLK_PPM_H
 
#include <stdint.h>
#include <stdbool.h>
 
/* Bounds checks for FMAX and FMIN (in MHz) */
#define AICLK_FMAX_MAX        1400.0F
#define AICLK_FMAX_MIN        800.0F
#define AICLK_FMIN_MAX        1400.0F
#define AICLK_FMIN_MIN        200.0F
#define AICLK_RESET_SAFE_FREQ 250.0F

enum aiclk_arb_max {
        aiclk_arb_max_fmax,             
        aiclk_arb_max_tdp,              
        aiclk_arb_max_fast_tdc,         
        aiclk_arb_max_tdc,              
        aiclk_arb_max_thm,              
        aiclk_arb_max_board_power,      
        aiclk_arb_max_voltage,          
        aiclk_arb_max_gddr_thm,         
        aiclk_arb_max_doppler_slow,     
        aiclk_arb_max_doppler_critical, 
        aiclk_arb_max_host_fmax,        
        aiclk_arb_max_count,            
};

enum aiclk_arb_min {
        aiclk_arb_min_fmin,  
        aiclk_arb_min_busy,  
        aiclk_arb_min_count, 
};
 
enum targ_freq_reason {
        limit_reason_min_arb, 
        limit_reason_max_arb, 
        limit_reason_fmin, 
        limit_reason_sweep,  
        limit_reason_forced, 
};

union aiclk_targ_freq_info {
        uint32_t u32_all;
        struct {
                uint32_t arbiter: 16;
                uint32_t reason: 16;
        };
};
 
void aiclk_update_busy(void);
void SetAiclkArbMax(enum aiclk_arb_max arb_max, float freq);
void SetAiclkArbMin(enum aiclk_arb_min arb_min, float freq);
void EnableArbMax(enum aiclk_arb_max arb_max, bool enable);
void EnableArbMin(enum aiclk_arb_min arb_min, bool enable);
void CalculateTargAiclk(void);
void DecreaseAiclk(void);
void IncreaseAiclk(void);
void InitArbMaxVoltage(void);
float GetThrottlerArbMax(enum aiclk_arb_max arb_max);
uint8_t ForceAiclk(uint32_t freq);
void SetAiclkResetSafe(bool enable);
uint32_t GetAiclkTarg(void);
uint32_t GetMaxAiclkForVoltage(uint32_t voltage);
uint32_t GetAiclkFmin(void);
uint32_t GetAiclkFmax(void);
uint32_t get_aiclk_effective_arb_min(enum aiclk_arb_min *effective_min_arb);
uint32_t get_aiclk_effective_arb_max(enum aiclk_arb_max *effective_max_arb);
uint32_t get_enabled_arb_min_bitmask(void);
uint32_t get_enabled_arb_max_bitmask(void);
union aiclk_targ_freq_info get_targ_aiclk_info(void);
 
struct response;
union request;
uint8_t throttler_counter_handler(const union request *request, struct response *response);
 
#endif