/* SPDX-License-Identifier: GPL-2.0-only */
/*
 * GXP SSMT driver.
 *
 * Copyright (C) 2022 Google LLC
 */

#ifndef __GXP_SSMT_H__
#define __GXP_SSMT_H__

#include <gcip/gcip-slc.h>

#include "gxp-internal.h"

#define SSMT_CFG_OFFSET (0x0004)
#define SSMT_MODE_CLAMPED (0x0u)
#define SSMT_MODE_CLIENT (0x1u)

#define SSMT_CLAMP_MODE_BYPASS (1u << 31)
#define MAX_NUM_CONTEXTS 8

#define SSMT_NUM_STREAMS (128)
#define SSMT_NS_READ_STREAM_VID_OFFSET (0x1000u)
#define SSMT_NS_WRITE_STREAM_VID_OFFSET (0x1200u)
#define SSMT_NS_READ_PID_OFFSET (0x4000u)
#define SSMT_NS_WRITE_PID_OFFSET (0x4200u)
#define SSMT_NS_CACHE_OFFSET (0x4400u)
#define SSMT_NS_READ_ALLOCATE_OVERRIDE_OFFSET (0x4600u)
#define SSMT_NS_WRITE_ALLOCATE_OVERRIDE_OFFSET (0x4800u)

struct gxp_ssmt {
	struct gxp_dev *gxp;
	void __iomem *idma_ssmt_base;
	void __iomem *inst_data_ssmt_base;
};

/*
 * Initializes @ssmt structure.
 *
 * Resources allocated in this function are all device-managed.
 *
 * Returns 0 on success, -errno otherwise.
 */
int gxp_gsx01_ssmt_init(struct gxp_dev *gxp, struct gxp_ssmt *ssmt);

/*
 * Programs SSMT to have @core (0 ~ GXP_NUM_CORES - 1) issue transactions
 * with VID = @vid.
 */
void gxp_gsx01_ssmt_set_core_vid(struct gxp_ssmt *ssmt, uint core, uint vid);

/**
 * gxp_gsx01_ssmt_activate_scid() - Activates the transactions with SCID @scid.
 *
 * SSMT will be configured as streams with SCID=@scid to have VID=@scid for memory transactions.
 */
void gxp_gsx01_ssmt_activate_scid(struct gxp_ssmt *ssmt, uint scid);

/**
 * gxp_gsx01_ssmt_deactivate_scid() - Dectivates the transactions with SCID @scid.
 *
 * SSMT will be configured as streams with SCID=@scid to have VID=0 signal for memory
 * transactions.
 */
void gxp_gsx01_ssmt_deactivate_scid(struct gxp_ssmt *ssmt, uint scid);

/**
 * gxp_gsx01_ssmt_set_slc_attr() - Sets the SSMT with SLC attributes.
 */
void gxp_gsx01_ssmt_set_slc_attr(struct gxp_ssmt *ssmt, struct gcip_slc *slc);

#endif /* __GXP_SSMT_H__ */