source: mainline/uspace/drv/bus/usb/ohci/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.9 KB
RevLine 
[f98b8269]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/** @addtogroup drvusbohci
29 * @{
30 */
31/** @file
32 * @brief OHCI driver transfer list structure
33 */
[5a2c42b]34#ifndef DRV_OHCI_ENDPOINT_LIST_H
35#define DRV_OHCI_ENDPOINT_LIST_H
[f98b8269]36
[0d4b110]37#include <adt/list.h>
38#include <assert.h>
[f98b8269]39#include <fibril_synch.h>
[8d2dd7f2]40#include <stdint.h>
[2dbfe44]41#include <usb/host/utils/malloc32.h>
[f98b8269]42
[e6b9182]43#include "ohci_bus.h"
[f98b8269]44#include "hw_struct/endpoint_descriptor.h"
45
[d1582b50]46/** Structure maintains both OHCI queue and software list of active endpoints. */
[02cacce]47typedef struct endpoint_list {
[d736fe38]48 /** Guard against add/remove races */
[f98b8269]49 fibril_mutex_t guard;
[d736fe38]50 /** OHCI hw structure at the beginning of the queue */
[f98b8269]51 ed_t *list_head;
[d736fe38]52 /** Physical address of the first(dummy) ED */
[f98b8269]53 uint32_t list_head_pa;
[d736fe38]54 /** Assigned name, provides nicer debug output */
[f98b8269]55 const char *name;
[d736fe38]56 /** Sw list of all active EDs */
[b72efe8]57 list_t endpoint_list;
[5a2c42b]58} endpoint_list_t;
[f98b8269]59
60/** Dispose transfer list structures.
61 *
62 * @param[in] instance Memory place to use.
63 *
[d736fe38]64 * Frees memory of the internal ed_t structure.
[f98b8269]65 */
[5a2c42b]66static inline void endpoint_list_fini(endpoint_list_t *instance)
[f98b8269]67{
68 assert(instance);
69 free32(instance->list_head);
[0d4b110]70 instance->list_head = NULL;
[f98b8269]71}
72
[5a6cc679]73errno_t endpoint_list_init(endpoint_list_t *instance, const char *name);
[57e06ef]74void endpoint_list_set_next(
75 const endpoint_list_t *instance, const endpoint_list_t *next);
[e20eaed]76void endpoint_list_add_ep(endpoint_list_t *instance, ohci_endpoint_t *ep);
77void endpoint_list_remove_ep(endpoint_list_t *instance, ohci_endpoint_t *ep);
[58563585]78
[f98b8269]79#endif
[58563585]80
[f98b8269]81/**
82 * @}
83 */
Note: See TracBrowser for help on using the repository browser.