source: mainline/uspace/lib/usbhost/src/endpoint.c@ af42a2b

lfn serial ticket/834-toolchain-update topic/msim-upgrade topic/simplify-dev-export
Last change on this file since af42a2b was 17412546, checked in by Jan Vesely <jano.vesely@…>, 14 years ago

libusbhost: endpoint_t: extend mutex protection, add doxygen comments.
  • Property mode set to 100644
File size: 6.2 KB
Line 
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 libusbhost
29 * @{
30 */
31/** @file
32 * @brief UHCI host controller driver structure
33 */
34
35#include <assert.h>
36#include <stdlib.h>
37#include <errno.h>
38#include <usb/host/endpoint.h>
39
40/** Allocate ad initialize endpoint_t structure.
41 * @param address USB address.
42 * @param endpoint USB endpoint number.
43 * @param direction Communication direction.
44 * @param type USB transfer type.
45 * @param speed Communication speed.
46 * @param max_packet_size Maximum size of data packets.
47 * @param bw Required bandwidth.
48 * @return Pointer to initialized endpoint_t structure, NULL on failure.
49 */
50endpoint_t * endpoint_create(usb_address_t address, usb_endpoint_t endpoint,
51 usb_direction_t direction, usb_transfer_type_t type, usb_speed_t speed,
52 size_t max_packet_size, size_t bw)
53{
54 endpoint_t *instance = malloc(sizeof(endpoint_t));
55 if (instance) {
56 instance->address = address;
57 instance->endpoint = endpoint;
58 instance->direction = direction;
59 instance->transfer_type = type;
60 instance->speed = speed;
61 instance->max_packet_size = max_packet_size;
62 instance->bandwidth = bw;
63 instance->toggle = 0;
64 instance->active = false;
65 instance->hc_data.data = NULL;
66 instance->hc_data.toggle_get = NULL;
67 instance->hc_data.toggle_set = NULL;
68 link_initialize(&instance->link);
69 fibril_mutex_initialize(&instance->guard);
70 fibril_condvar_initialize(&instance->avail);
71 }
72 return instance;
73}
74/*----------------------------------------------------------------------------*/
75/** Properly dispose of endpoint_t structure.
76 * @param instance endpoint_t structure.
77 */
78void endpoint_destroy(endpoint_t *instance)
79{
80 assert(instance);
81 //TODO: Do something about waiting fibrils.
82 assert(!instance->active);
83 assert(instance->hc_data.data == NULL);
84 free(instance);
85}
86/*----------------------------------------------------------------------------*/
87/** Set device specific data and hooks.
88 * @param instance endpoint_t structure.
89 * @param data device specific data.
90 * @param toggle_get Hook to call when retrieving value of toggle bit.
91 * @param toggle_set Hook to call when setting the value of toggle bit.
92 */
93void endpoint_set_hc_data(endpoint_t *instance,
94 void *data, int (*toggle_get)(void *), void (*toggle_set)(void *, int))
95{
96 assert(instance);
97 fibril_mutex_lock(&instance->guard);
98 instance->hc_data.data = data;
99 instance->hc_data.toggle_get = toggle_get;
100 instance->hc_data.toggle_set = toggle_set;
101 fibril_mutex_unlock(&instance->guard);
102}
103/*----------------------------------------------------------------------------*/
104/** Clear device specific data and hooks.
105 * @param instance endpoint_t structure.
106 * @note This function does not free memory pointed to by data pointer.
107 */
108void endpoint_clear_hc_data(endpoint_t *instance)
109{
110 assert(instance);
111 fibril_mutex_lock(&instance->guard);
112 instance->hc_data.data = NULL;
113 instance->hc_data.toggle_get = NULL;
114 instance->hc_data.toggle_set = NULL;
115 fibril_mutex_unlock(&instance->guard);
116}
117/*----------------------------------------------------------------------------*/
118/** Mark the endpoint as active and block access for further fibrils.
119 * @param instance endpoint_t structure.
120 */
121void endpoint_use(endpoint_t *instance)
122{
123 assert(instance);
124 fibril_mutex_lock(&instance->guard);
125 while (instance->active)
126 fibril_condvar_wait(&instance->avail, &instance->guard);
127 instance->active = true;
128 fibril_mutex_unlock(&instance->guard);
129}
130/*----------------------------------------------------------------------------*/
131/** Mark the endpoint as inactive and allow access for further fibrils.
132 * @param instance endpoint_t structure.
133 */
134void endpoint_release(endpoint_t *instance)
135{
136 assert(instance);
137 fibril_mutex_lock(&instance->guard);
138 instance->active = false;
139 fibril_mutex_unlock(&instance->guard);
140 fibril_condvar_signal(&instance->avail);
141}
142/*----------------------------------------------------------------------------*/
143/** Get the value of toggle bit.
144 * @param instance endpoint_t structure.
145 * @note Will use provided hook.
146 */
147int endpoint_toggle_get(endpoint_t *instance)
148{
149 assert(instance);
150 fibril_mutex_lock(&instance->guard);
151 if (instance->hc_data.toggle_get)
152 instance->toggle =
153 instance->hc_data.toggle_get(instance->hc_data.data);
154 const int ret = instance->toggle;
155 fibril_mutex_unlock(&instance->guard);
156 return ret;
157}
158/*----------------------------------------------------------------------------*/
159/** Set the value of toggle bit.
160 * @param instance endpoint_t structure.
161 * @note Will use provided hook.
162 */
163void endpoint_toggle_set(endpoint_t *instance, int toggle)
164{
165 assert(instance);
166 assert(toggle == 0 || toggle == 1);
167 fibril_mutex_lock(&instance->guard);
168 instance->toggle = toggle;
169 if (instance->hc_data.toggle_set)
170 instance->hc_data.toggle_set(instance->hc_data.data, toggle);
171 fibril_mutex_unlock(&instance->guard);
172}
173/**
174 * @}
175 */
Note: See TracBrowser for help on using the repository browser.