uspace/drv/bus/usb/uhci/transfer_list.h

   1 /*
   2  * Copyright (c) 2011 Jan Vesely
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  *
   9  * - Redistributions of source code must retain the above copyright
  10  *   notice, this list of conditions and the following disclaimer.
  11  * - Redistributions in binary form must reproduce the above copyright
  12  *   notice, this list of conditions and the following disclaimer in the
  13  *   documentation and/or other materials provided with the distribution.
  14  * - The name of the author may not be used to endorse or promote products
  15  *   derived from this software without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  18  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  19  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  20  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  21  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  22  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  23  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  24  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27  */
  28
  29 /** @addtogroup drvusbuhci
  30  * @{
  31  */
  32 /** @file
  33  * @brief UHCI driver transfer list structure
  34  */
  35
  36 #ifndef DRV_UHCI_TRANSFER_LIST_H
  37 #define DRV_UHCI_TRANSFER_LIST_H
  38
  39 #include <adt/list.h>
  40 #include <fibril_synch.h>
  41
  42 #include "hw_struct/queue_head.h"
  43 #include "uhci_batch.h"
  44 /** Structure maintaining both hw queue and software list
  45  * of currently executed transfers
  46  */
  47 typedef struct transfer_list {
  48         /** Guard against multiple add/remove races */
  49         fibril_mutex_t guard;
  50         /** UHCI hw structure representing this queue */
  51         qh_t *queue_head;
  52         /** Assigned name, for nicer debug output */
  53         const char *name;
  54         /** List of all batches in this list */
  55         list_t batch_list;
  56 } transfer_list_t;
  57
  58 void transfer_list_fini(transfer_list_t *);
  59 errno_t transfer_list_init(transfer_list_t *, const char *);
  60 void transfer_list_set_next(transfer_list_t *, transfer_list_t *);
  61 errno_t transfer_list_add_batch(transfer_list_t *, uhci_transfer_batch_t *);
  62 void transfer_list_remove_batch(transfer_list_t *, uhci_transfer_batch_t *);
  63 void transfer_list_check_finished(transfer_list_t *);
  64 void transfer_list_abort_all(transfer_list_t *);
  65
  66 #endif
  67
  68 /**
  69  * @}
  70  */