/*
 * Copyright (c) 2015 MediaTek Inc.
 * Author:
 *  Zhigang.Wun <zhigang.wei@mediatek.com>
 *  Chunfeng.Yun <chunfeng.yun@mediatek.com>
 *
 * This software is licensed under the terms of the GNU General Public
 * License version 2, as published by the Free Software Foundation, and
 * may be copied, distributed, and modified under those terms.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 */

#ifndef _XHCI_MTK_H_
#define _XHCI_MTK_H_

#include "xhci.h"

/**
 * To simplify scheduler algorithm, set a upper limit for ESIT,
 * if a synchromous ep's ESIT is larger than @XHCI_MTK_MAX_ESIT,
 * round down to the limit value, that means allocating more
 * bandwidth to it.
 */
#define MAX_EP_NUM	32

struct sch_ep {
	int rh_port; /* root hub port number */
	/* device info */
	int speed;
	int is_tt;
	/* ep info */
	int is_in;
	int ep_type;
	int maxp;
	int interval;
	int burst;
	int mult;
	/* scheduling info */
	int offset;
	int repeat;
	int pkts;
	int cs_count;
	int burst_mode;
	/* other */
	int bw_cost; /* bandwidth cost in each repeat; including overhead */
	struct usb_host_endpoint *ep;
	struct xhci_ep_ctx *ep_ctx;
};

/**
 * struct mu3h_sch_ep_info
 * @esit: unit is 125us, equal to 2 << Interval field in ep-context
 * @num_budget_microframes: number of continuous uframes
 *		(@repeat==1) scheduled within the interval
 * @ep: address of usb_host_endpoint
 * @offset: which uframe of the interval that transfer should be
 *		scheduled first time within the interval
 * @repeat: the time gap between two uframes that transfers are
 *		scheduled within a interval. in the simple algorithm, only
 *		assign 0 or 1 to it; 0 means using only one uframe in a
 *		interval, and1 means using @num_budget_microframes
 *		continuous uframes
 * @pkts: number of packets to be transferred in the scheduled uframes
 * @cs_count: number of CS that host will trigger
 */
struct sch_port {
	struct sch_ep *ss_out_eps[MAX_EP_NUM];
	struct sch_ep *ss_in_eps[MAX_EP_NUM];
	struct sch_ep *hs_eps[MAX_EP_NUM];	/* including tt isoc */
	struct sch_ep *tt_intr_eps[MAX_EP_NUM];

	/* mtk xhci scheduling info */
};


#if IS_ENABLED(CONFIG_SSUSB_MTK_XHCI)

int xhci_mtk_init_quirk(struct xhci_hcd *xhci);
void xhci_mtk_exit_quirk(struct xhci_hcd *xhci);
int xhci_mtk_add_ep_quirk(struct usb_hcd *hcd, struct usb_device *udev,
		struct usb_host_endpoint *ep);
int xhci_mtk_drop_ep_quirk(struct usb_hcd *hcd, struct usb_device *udev,
		struct usb_host_endpoint *ep);
u32 xhci_mtk_td_remainder_quirk(unsigned int td_running_total,
	unsigned trb_buffer_length, struct urb *urb);

#else
static inline int xhci_mtk_init_quirk(struct xhci_hcd *xhci)
{
	return 0;
}

static inline void xhci_mtk_exit_quirk(struct xhci_hcd *xhci)
{
}

static inline int xhci_mtk_add_ep_quirk(struct usb_hcd *hcd,
	struct usb_device *udev, struct usb_host_endpoint *ep)
{
	return 0;
}

static inline int xhci_mtk_drop_ep_quirk(struct usb_hcd *hcd,
	struct usb_device *udev, struct usb_host_endpoint *ep)
{
	return 0;
}

u32 xhci_mtk_td_remainder_quirk(unsigned int td_running_total,
	unsigned trb_buffer_length, struct urb *urb)
{
	return 0;
}

#endif

#endif		/* _XHCI_MTK_H_ */