source: mainline/uspace/lib/usb/src/usbdrvreq.c@ 97bfba1

lfn serial ticket/834-toolchain-update topic/msim-upgrade topic/simplify-dev-export
Last change on this file since 97bfba1 was 97bfba1, checked in by Vojtech Horky <vojtechhorky@…>, 15 years ago

Add generic function for GET_DESCRIPTOR request
  • Property mode set to 100644
File size: 8.3 KB
Line 
1/*
2 * Copyright (c) 2010 Vojtech Horky
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 libusb usb
30 * @{
31 */
32/** @file
33 * @brief USB driver - standard USB requests (implementation).
34 */
35#include <usb/usbdrv.h>
36#include <errno.h>
37
38/** Change address of connected device.
39 *
40 * @see usb_drv_reserve_default_address
41 * @see usb_drv_release_default_address
42 * @see usb_drv_request_address
43 * @see usb_drv_release_address
44 * @see usb_drv_bind_address
45 *
46 * @param phone Open phone to HC driver.
47 * @param old_address Current address.
48 * @param address Address to be set.
49 * @return Error code.
50 */
51int usb_drv_req_set_address(int phone, usb_address_t old_address,
52 usb_address_t new_address)
53{
54 /* Prepare the target. */
55 usb_target_t target = {
56 .address = old_address,
57 .endpoint = 0
58 };
59
60 /* Prepare the setup packet. */
61 usb_device_request_setup_packet_t setup_packet = {
62 .request_type = 0,
63 .request = USB_DEVREQ_SET_ADDRESS,
64 .index = 0,
65 .length = 0,
66 };
67 setup_packet.value = new_address;
68
69 int rc = usb_drv_psync_control_write(phone, target,
70 &setup_packet, sizeof(setup_packet), NULL, 0);
71
72 return rc;
73}
74
75/** Retrieve USB descriptor of connected USB device.
76 *
77 * @param[in] hc_phone Open phone to HC driver.
78 * @param[in] address Device USB address.
79 * @param[in] request_type Request type (standard/class/vendor).
80 * @param[in] descriptor_type Descriptor type (device/configuration/HID/...).
81 * @param[in] descriptor_index Descriptor index.
82 * @param[in] langauge Language index.
83 * @param[out] buffer Buffer where to store the retrieved descriptor.
84 * @param[in] size Size of the @p buffer.
85 * @param[out] actual_size Number of bytes actually transferred.
86 * @return Error code.
87 */
88int usb_drv_req_get_descriptor(int hc_phone, usb_address_t address,
89 usb_request_type_t request_type,
90 uint8_t descriptor_type, uint8_t descriptor_index,
91 uint16_t language,
92 void *buffer, size_t size, size_t *actual_size)
93{
94 /* Prepare the target. */
95 usb_target_t target = {
96 .address = address,
97 .endpoint = 0
98 };
99
100 /* Prepare the setup packet. */
101 usb_device_request_setup_packet_t setup_packet = {
102 .request_type = 128 | (request_type << 5),
103 .request = USB_DEVREQ_GET_DESCRIPTOR,
104 .index = language,
105 .length = (uint16_t) size,
106 };
107 setup_packet.value_high = descriptor_type;
108 setup_packet.value_low = descriptor_index;
109
110 /* Perform CONTROL READ */
111 int rc = usb_drv_psync_control_read(hc_phone, target,
112 &setup_packet, sizeof(setup_packet),
113 buffer, size, actual_size);
114
115 return rc;
116}
117
118/** Retrieve device descriptor of connected USB device.
119 *
120 * @param[in] phone Open phone to HC driver.
121 * @param[in] address Device USB address.
122 * @param[out] descriptor Storage for the device descriptor.
123 * @return Error code.
124 * @retval EBADMEM @p descriptor is NULL.
125 */
126int usb_drv_req_get_device_descriptor(int phone, usb_address_t address,
127 usb_standard_device_descriptor_t *descriptor)
128{
129 if (descriptor == NULL) {
130 return EBADMEM;
131 }
132
133 /* Prepare the target. */
134 usb_target_t target = {
135 .address = address,
136 .endpoint = 0
137 };
138
139 /* Prepare the setup packet. */
140 usb_device_request_setup_packet_t setup_packet = {
141 .request_type = 128,
142 .request = USB_DEVREQ_GET_DESCRIPTOR,
143 .index = 0,
144 .length = sizeof(usb_standard_device_descriptor_t)
145 };
146 setup_packet.value_high = USB_DESCTYPE_DEVICE;
147 setup_packet.value_low = 0;
148
149 /* Prepare local descriptor. */
150 size_t actually_transferred = 0;
151 usb_standard_device_descriptor_t descriptor_tmp;
152
153 /* Perform the control read transaction. */
154 int rc = usb_drv_psync_control_read(phone, target,
155 &setup_packet, sizeof(setup_packet),
156 &descriptor_tmp, sizeof(descriptor_tmp), &actually_transferred);
157
158 if (rc != EOK) {
159 return rc;
160 }
161
162 /* Verify that all data has been transferred. */
163 if (actually_transferred < sizeof(descriptor_tmp)) {
164 return ELIMIT;
165 }
166
167 /* Everything is okay, copy the descriptor. */
168 memcpy(descriptor, &descriptor_tmp,
169 sizeof(descriptor_tmp));
170
171 return EOK;
172}
173
174
175/** Retrieve configuration descriptor of connected USB device.
176 *
177 * The function does not retrieve additional data binded with configuration
178 * descriptor (such as its interface and endpoint descriptors) - use
179 * usb_drv_req_get_full_configuration_descriptor() instead.
180 *
181 * @param[in] phone Open phone to HC driver.
182 * @param[in] address Device USB address.
183 * @param[in] index Configuration descriptor index.
184 * @param[out] descriptor Storage for the configuration descriptor.
185 * @return Error code.
186 * @retval EBADMEM @p descriptor is NULL.
187 */
188int usb_drv_req_get_bare_configuration_descriptor(int phone,
189 usb_address_t address, int index,
190 usb_standard_configuration_descriptor_t *descriptor)
191{
192 if (descriptor == NULL) {
193 return EBADMEM;
194 }
195
196 /* Prepare the target. */
197 usb_target_t target = {
198 .address = address,
199 .endpoint = 0
200 };
201
202 /* Prepare the setup packet. */
203 usb_device_request_setup_packet_t setup_packet = {
204 .request_type = 128,
205 .request = USB_DEVREQ_GET_DESCRIPTOR,
206 .index = 0,
207 .length = sizeof(usb_standard_configuration_descriptor_t)
208 };
209 setup_packet.value_high = USB_DESCTYPE_CONFIGURATION;
210 setup_packet.value_low = index;
211
212 /* Prepare local descriptor. */
213 size_t actually_transferred = 0;
214 usb_standard_configuration_descriptor_t descriptor_tmp;
215
216 /* Perform the control read transaction. */
217 int rc = usb_drv_psync_control_read(phone, target,
218 &setup_packet, sizeof(setup_packet),
219 &descriptor_tmp, sizeof(descriptor_tmp), &actually_transferred);
220
221 if (rc != EOK) {
222 return rc;
223 }
224
225 /* Verify that all data has been transferred. */
226 if (actually_transferred < sizeof(descriptor_tmp)) {
227 return ELIMIT;
228 }
229
230 /* Everything is okay, copy the descriptor. */
231 memcpy(descriptor, &descriptor_tmp,
232 sizeof(descriptor_tmp));
233
234 return EOK;
235}
236
237/** Retrieve full configuration descriptor of connected USB device.
238 *
239 * @warning The @p buffer might be touched (i.e. its contents changed)
240 * even when error occurres.
241 *
242 * @param[in] phone Open phone to HC driver.
243 * @param[in] address Device USB address.
244 * @param[in] index Configuration descriptor index.
245 * @param[out] buffer Buffer for the whole configuration descriptor.
246 * @param[in] buffer_size Size of the prepared @p buffer.
247 * @param[out] actual_buffer_size Bytes actually transfered.
248 * @return Error code.
249 * @retval EBADMEM @p descriptor is NULL.
250 */
251int usb_drv_req_get_full_configuration_descriptor(int phone,
252 usb_address_t address, int index,
253 void *buffer, size_t buffer_size, size_t *actual_buffer_size)
254{
255 if (buffer == NULL) {
256 return EBADMEM;
257 }
258
259 /* Prepare the target. */
260 usb_target_t target = {
261 .address = address,
262 .endpoint = 0
263 };
264
265 /* Prepare the setup packet. */
266 usb_device_request_setup_packet_t setup_packet = {
267 .request_type = 128,
268 .request = USB_DEVREQ_GET_DESCRIPTOR,
269 .index = 0,
270 .length = buffer_size
271 };
272 setup_packet.value_high = USB_DESCTYPE_CONFIGURATION;
273 setup_packet.value_low = index;
274
275 /* Perform the control read transaction. */
276 int rc = usb_drv_psync_control_read(phone, target,
277 &setup_packet, sizeof(setup_packet),
278 buffer, buffer_size, actual_buffer_size);
279
280 return rc;
281}
282
283
284/**
285 * @}
286 */
Note: See TracBrowser for help on using the repository browser.