source: mainline/uspace/drv/bus/usb/ehci/endpoint_list.h

Last change on this file was d1582b50, checked in by Jiri Svoboda <jiri@…>, 5 years ago

Fix spacing in single-line comments using latest ccheck

This found incorrectly formatted section comments (with blocks of
asterisks or dashes). I strongly believe against using section comments
but I am not simply removing them since that would probably be
controversial.

  • Property mode set to 100644
File size: 2.7 KB
Line 
1/*
2 * Copyright (c) 2014 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/** @addtogroup drvusbehci
29 * @{
30 */
31/** @file
32 * @brief EHCI driver transfer list structure
33 */
34#ifndef DRV_EHCI_ENDPOINT_LIST_H
35#define DRV_EHCI_ENDPOINT_LIST_H
36
37#include <adt/list.h>
38#include <assert.h>
39#include <fibril_synch.h>
40
41#include "ehci_bus.h"
42#include "hw_struct/queue_head.h"
43
44/** Structure maintains both EHCI queue and software list of active endpoints. */
45typedef struct endpoint_list {
46 /** Guard against add/remove races */
47 fibril_mutex_t guard;
48 /** EHCI hw structure at the beginning of the queue */
49 qh_t *list_head;
50 dma_buffer_t dma_buffer;
51 /** Assigned name, provides nicer debug output */
52 const char *name;
53 /** Sw list of all active EDs */
54 list_t endpoint_list;
55} endpoint_list_t;
56
57/** Dispose transfer list structures.
58 *
59 * @param[in] instance Memory place to use.
60 *
61 * Frees memory of the internal ed_t structure.
62 */
63static inline void endpoint_list_fini(endpoint_list_t *instance)
64{
65 assert(instance);
66 dma_buffer_free(&instance->dma_buffer);
67 instance->list_head = NULL;
68}
69
70errno_t endpoint_list_init(endpoint_list_t *instance, const char *name);
71void endpoint_list_chain(endpoint_list_t *instance, const endpoint_list_t *next);
72void endpoint_list_append_ep(endpoint_list_t *instance, ehci_endpoint_t *ep);
73void endpoint_list_remove_ep(endpoint_list_t *instance, ehci_endpoint_t *ep);
74#endif
75/**
76 * @}
77 */
Note: See TracBrowser for help on using the repository browser.