HelenOS sources

root/uspace/drv/bus/usb/xhci/bus.h

/* [<][>][^][v][top][bottom][index][help] */

INCLUDED FROM


DEFINITIONS

This source file includes following definitions.
  1. bus_to_xhci_bus

/*
 * Copyright (c) 2018 Ondrej Hlavaty
 * 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 libusbhost
 * @{
 */
/** @file
 *
 * An implementation of bus keeper for xHCI. The (physical) HC itself takes
 * care about addressing devices, so this implementation is actually simpler
 * than those of [OUE]HCI.
 */
#ifndef XHCI_BUS_H
#define XHCI_BUS_H

#include <usb/host/bus.h>

typedef struct xhci_hc xhci_hc_t;
typedef struct xhci_device xhci_device_t;

/** Endpoint management structure */
typedef struct xhci_bus {
        bus_t base; /**< Inheritance. Keep this first. */
        xhci_hc_t *hc; /**< Pointer to managing HC (to issue commands) */
        xhci_device_t **devices_by_slot; /**< Devices by Slot ID */
} xhci_bus_t;

extern errno_t xhci_bus_init(xhci_bus_t *, xhci_hc_t *);
extern void xhci_bus_fini(xhci_bus_t *);

static inline xhci_bus_t *bus_to_xhci_bus(bus_t *bus_base)
{
        assert(bus_base);
        return (xhci_bus_t *) bus_base;
}

#endif
/**
 * @}
 */

/* [<][>][^][v][top][bottom][index][help] */
HelenOS homepage, sources at GitHub