/** @file
  Header file for USB4 domain definition

@copyright
  INTEL CONFIDENTIAL
  Copyright 2021 Intel Corporation.

  The source code contained or described herein and all documents related to the
  source code ("Material") are owned by Intel Corporation or its suppliers or
  licensors. Title to the Material remains with Intel Corporation or its suppliers
  and licensors. The Material may contain trade secrets and proprietary and
  confidential information of Intel Corporation and its suppliers and licensors,
  and is protected by worldwide copyright and trade secret laws and treaty
  provisions. No part of the Material may be used, copied, reproduced, modified,
  published, uploaded, posted, transmitted, distributed, or disclosed in any way
  without Intel's prior express written permission.

  No license under any patent, copyright, trade secret or other intellectual
  property right is granted to or conferred upon you by disclosure or delivery
  of the Materials, either expressly, by implication, inducement, estoppel or
  otherwise. Any license under such intellectual property rights must be
  express and approved by Intel in writing.

  Unless otherwise agreed by Intel in writing, you may not remove or alter
  this notice or any other notice embedded in Materials by Intel or
  Intel's suppliers or licensors in any way.

  This file contains a 'Sample Driver' and is licensed as such under the terms
  of your license agreement with Intel or your vendor. This file may be modified
  by the user, subject to the additional terms of the license agreement.

@par Specification Reference:
**/

#ifndef _USB4_DOMAIN_DEFS_H_
#define _USB4_DOMAIN_DEFS_H_

#include <Uefi.h>
#include <Usb4Common.h>
#include <Usb4RouterDefs.h>

//
// DP stream information in USB4 domain
//
typedef struct _USB4_DP_STREAM {
  // Router containing DP source
  PUSB4_ROUTER    DpSrcRouter;
  // DP source adapter number
  UINT8           DpSrcAdpNum;
  // Router containing DP sink
  PUSB4_ROUTER    DpSinkRouter;
  // DP sink adapter number
  UINT8           DpSinkAdpNum;
  // DP stream configuration is ready
  BOOLEAN         StreamReady;
} USB4_DP_STREAM, *PUSB4_DP_STREAM;

struct _USB4_HR_INSTANCE;

#define USB4_DOMAIN_SIGNATURE      SIGNATURE_32 ('u', '4', 'd', 'm')

//
// USB4 domain instance for maintaining domain topology
//
typedef struct _USB4_DOMAIN {
  UINT32            Signature;
  // Router pool in domain
  USB4_ROUTER       Router[USB4_ROUTER_SUPPORT_MAX];
  // Start index of next free router search
  UINT32            NextRtSearch;
  // In-use router count in router pool
  UINT32            RtInUse;
  // Root of router tree in domain, it represents router node of host router
  USB4_ROUTER       *RootRt;
  // Router count in domain
  UINT32            RouterCount;
  // DP stream count in domain
  UINT32            DpStreamCount;
  // DP stream information in domain
  USB4_DP_STREAM    DpStream[USB4_DP_STREAM_MAX];
  // USB4_CS_IO function table used for USB4 config space access in domain
  USB4_CS_IO        *Usb4CsIo;
  // USB4 host router instance binding to domain
  struct _USB4_HR_INSTANCE    *Usb4Hr;
} USB4_DOMAIN, *PUSB4_DOMAIN;

#endif