/* SPDX-License-Identifier: GPL-2.0 */
/*
 * Edge TPU driver SoC-specific APIs.
 *
 * Copyright (C) 2022 Google LLC
 */

#ifndef __EDGETPU_SOC_H__
#define __EDGETPU_SOC_H__

#include <linux/types.h>

#include "edgetpu-internal.h"
#include "edgetpu-kci.h"

/* SoC-specific calls for the following functions. */

/* Probe-time init */
int edgetpu_soc_init(struct edgetpu_dev *etdev);

/* Prep for running firmware: set access control, etc. */
int edgetpu_soc_prepare_firmware(struct edgetpu_dev *etdev);

/*
 * Power management get TPU clock rate.
 * @flags can be used by platform-specific code to pass additional flags to the SoC
 *        handler; for calls from generic code this value must be zero.
 */
long edgetpu_soc_pm_get_rate(struct edgetpu_dev *etdev, int flags);

/* Power management set TPU clock rate */
int edgetpu_soc_pm_set_rate(unsigned long rate);

/* Power down */
void edgetpu_soc_pm_power_down(struct edgetpu_dev *etdev);

/* Init SoC PM system */
int edgetpu_soc_pm_init(struct edgetpu_dev *etdev);

/* De-init SoC PM system */
void edgetpu_soc_pm_exit(struct edgetpu_dev *etdev);

/*
 * Handle Reverse KCI commands for SoC family.
 * Note: This will get called from the system's work queue.
 * Code should not block for extended periods of time
 */
void edgetpu_soc_handle_reverse_kci(struct edgetpu_dev *etdev,
				    struct gcip_kci_response_element *resp);

/* Init thermal subsystem SoC specifics for TPU */
void edgetpu_soc_thermal_init(struct edgetpu_dev *etdev);

/* De-init thermal subsystem SoC specifics for TPU */
void edgetpu_soc_thermal_exit(struct edgetpu_dev *etdev);

/* Activates the context of @pasid. */
int edgetpu_soc_activate_context(struct edgetpu_dev *etdev, int pasid);

/* Deactivates the context of @pasid. */
void edgetpu_soc_deactivate_context(struct edgetpu_dev *etdev, int pasid);

#endif /* __EDGETPU_SOC_H__ */