/*
 * Copyright (c) 2017 Michal Staruch
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * - Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 * - Redistributions in binary form must reproduce the above copyright
 *   notice, this list of conditions and the following disclaimer in the
 *   documentation and/or other materials provided with the distribution.
 * - The name of the author may not be used to endorse or promote products
 *   derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

/** @addtogroup drvusbxhci
 * @{
 */
/** @file
 * @brief The roothub structures abstraction.
 */

#ifndef XHCI_RH_H
#define XHCI_RH_H

#include <usb/host/usb_transfer_batch.h>
#include <usbvirt/virthub_base.h>
#include "hw_struct/regs.h"

typedef struct xhci_hc xhci_hc_t;

enum {
	XHCI_MAX_PORTS = 255,
};

/**
 * xHCI lets the controller define speeds of ports it controls.
 */
typedef struct xhci_port_speed {
	char name [4];
	uint8_t major, minor;
	uint64_t rx_bps, tx_bps;
} xhci_port_speed_t;

/* XHCI root hub instance */
typedef struct {
	/** Virtual hub instance */
	virthub_base_t base;

	/** Host controller */
	xhci_hc_t *hc;

	/** Port speeds reported from HC */
	xhci_port_speed_t speeds [16];

	/** USB hub descriptor describing the XHCI root hub */
	struct {
		usb_hub_descriptor_header_t header;
		uint8_t rempow[STATUS_BYTES(XHCI_MAX_PORTS) * 2];
	} __attribute__((packed)) hub_descriptor;

	/** Interrupt transfer waiting for an actual interrupt to occur */
	usb_transfer_batch_t *unfinished_interrupt_transfer;

	/* Number of hub ports. */
	uint8_t max_ports;
} xhci_rh_t;

int xhci_rh_init(xhci_rh_t *, xhci_hc_t *);
int xhci_rh_fini(xhci_rh_t *);
const xhci_port_speed_t *xhci_get_port_speed(xhci_rh_t *, uint8_t);
int xhci_handle_port_status_change_event(xhci_hc_t *, xhci_trb_t *);
int xhci_get_hub_port(xhci_trb_t *);
int xhci_reset_hub_port(xhci_hc_t *, uint8_t);
int xhci_rh_schedule(xhci_rh_t *, usb_transfer_batch_t *);
int xhci_rh_interrupt(xhci_rh_t *);

/** Get XHCI rh address.
 *
 * @param rh XHCI rh instance.
 * @return USB address assigned to the hub.
 * Wrapper for virtual hub address
 */
static inline usb_address_t xhci_rh_get_address(xhci_rh_t *rh)
{
	assert(rh);
	return virthub_base_get_address(&rh->base);
}

static inline bool xhci_is_usb3_port(xhci_rh_t* rh, uint8_t port)
{
	return xhci_get_port_speed(rh, port)->major == 3;
}
#endif

/**
 * @}
 */