src/devices/usb/drivers/xhci/xhci-util.h

// Copyright 2016 The Fuchsia Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef SRC_DEVICES_USB_DRIVERS_XHCI_XHCI_UTIL_H_
#define SRC_DEVICES_USB_DRIVERS_XHCI_XHCI_UTIL_H_

#include <lib/sync/completion.h>

#include "xhci-transfer.h"
#include "xhci.h"

namespace usb_xhci {

typedef struct {
  xhci_command_context_t context;
  sync_completion_t completion;
  // from command completion event TRB
  uint32_t status;
  uint32_t control;
} xhci_sync_command_t;

void xhci_sync_command_init(xhci_sync_command_t* command);

// returns condition code
int xhci_sync_command_wait(xhci_sync_command_t* command);

static inline int xhci_sync_command_slot_id(xhci_sync_command_t* command) {
  return (command->control & XHCI_MASK(TRB_SLOT_ID_START, TRB_SLOT_ID_BITS)) >> TRB_SLOT_ID_START;
}

// executes a command with a 1 second timeout
zx_status_t xhci_send_command(xhci_t* xhci, uint32_t command, uint64_t ptr, uint32_t control_bits);

// Returns the next extended capability, optionally starting from a
// specific capability and/or only matching a particular id.
//
// prev_cap: if non-null, searching begins at the following capability, otherwise
//           searching begins at mmio base.
// match_cap_id: if non-null, only capabilities with this id will be returned.
uint32_t* xhci_get_next_ext_cap(void* mmio, uint32_t* prev_cap, uint32_t* match_cap_id);

}  // namespace usb_xhci

#endif  // SRC_DEVICES_USB_DRIVERS_XHCI_XHCI_UTIL_H_