summaryrefslogtreecommitdiff
path: root/usb/driver/get_descriptor.c
blob: 2b5172edde3aed557ba128b6d5c5333420c0d44d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
/* libusb-win32, Generic Windows USB Library
 * Copyright (c) 2002-2005 Stephan Meyer <ste_meyer@web.de>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */


#include "libusb_driver.h"



NTSTATUS get_descriptor(libusb_device_t *dev,
                        void *buffer, int size, int type, int recipient,
                        int index, int language_id, int *received, int timeout)
{
    NTSTATUS status = STATUS_SUCCESS;
    URB urb;

	USBMSG("buffer size: %d type: %04d recipient: %04d index: %04d language id: %04d timeout: %d\n", 
		size, type, recipient, index, language_id, timeout);

    memset(&urb, 0, sizeof(struct _URB_CONTROL_DESCRIPTOR_REQUEST));

    switch (recipient)
    {
    case USB_RECIP_DEVICE:
        urb.UrbHeader.Function = URB_FUNCTION_GET_DESCRIPTOR_FROM_DEVICE;
        break;
    case USB_RECIP_INTERFACE:
        urb.UrbHeader.Function = URB_FUNCTION_GET_DESCRIPTOR_FROM_INTERFACE;
        break;
    case USB_RECIP_ENDPOINT:
        urb.UrbHeader.Function = URB_FUNCTION_GET_DESCRIPTOR_FROM_ENDPOINT;
        break;
    default:
        USBERR0("invalid recipient\n");
        return STATUS_INVALID_PARAMETER;
    }

    urb.UrbHeader.Length = sizeof(struct _URB_CONTROL_DESCRIPTOR_REQUEST);
    urb.UrbControlDescriptorRequest.TransferBufferLength = size;
    urb.UrbControlDescriptorRequest.TransferBuffer = buffer;
    urb.UrbControlDescriptorRequest.DescriptorType = (UCHAR)type;
    urb.UrbControlDescriptorRequest.Index = (UCHAR)index;
    urb.UrbControlDescriptorRequest.LanguageId = (USHORT)language_id;

	// the device and active config descriptors are cached. If the request
	// is for one of these and we have already retrieved it, then this is
	// a non-blocking non-i/o call.

	if (type == USB_DEVICE_DESCRIPTOR_TYPE && 
		recipient == USB_RECIP_DEVICE && 
		index == 0 && 
		language_id == 0 && 
		size >= sizeof(USB_DEVICE_DESCRIPTOR))
	{
		// this is a device descriptor request.
		if (dev->device_descriptor.bLength == 0)
		{
			// this is the first request made for the device descriptor.
			// Cache it now and forever
			status = call_usbd(dev, &urb, IOCTL_INTERNAL_USB_SUBMIT_URB, timeout);
			if (NT_SUCCESS(status) && urb.UrbControlDescriptorRequest.TransferBufferLength < sizeof(USB_DEVICE_DESCRIPTOR))
			{
				USBERR("Invalid device decriptor length %d\n", urb.UrbControlDescriptorRequest.TransferBufferLength);
				status = STATUS_BAD_DEVICE_TYPE;
				*received = 0;
				goto Done;
			}

			if (!NT_SUCCESS(status) || !USBD_SUCCESS(urb.UrbHeader.Status))
			{
				USBERR("getting descriptor failed: status: 0x%x, urb-status: 0x%x\n", status, urb.UrbHeader.Status);
				*received = 0;
				goto Done;
			}

			// valid device descriptor
			size = sizeof(USB_DEVICE_DESCRIPTOR);
			RtlCopyMemory(&dev->device_descriptor, buffer, size);
			*received = size;

		}
		else
		{
			// device descriptor is already cached.
			size = sizeof(USB_DEVICE_DESCRIPTOR);
			RtlCopyMemory(buffer, &dev->device_descriptor, size);
			*received = size;
		}

		goto Done;
	}

	if (type == USB_CONFIGURATION_DESCRIPTOR_TYPE && 
		recipient == USB_RECIP_DEVICE && 
		language_id == 0 && 
		size >= sizeof(USB_CONFIGURATION_DESCRIPTOR))
	{
		if (dev->device_descriptor.bLength != 0	&& index >=dev->device_descriptor.bNumConfigurations)
		{
			USBWRN("config descriptor index %d out of range.\n", index);
			status = STATUS_NO_MORE_ENTRIES;
			*received = 0;
			goto Done;
		}

		// this is a config descriptor request.
		if (!dev->config.descriptor || dev->config.index != index)
		{
			// this is either:
			// * The first request made for a config descriptor.
			// * A request for a config descriptor other than the cached index.
			status = call_usbd(dev, &urb, IOCTL_INTERNAL_USB_SUBMIT_URB, timeout);

			if (!NT_SUCCESS(status) || !USBD_SUCCESS(urb.UrbHeader.Status))
			{
				USBERR("getting descriptor failed: status: 0x%x, urb-status: 0x%x\n", status, urb.UrbHeader.Status);
				*received = 0;
				goto Done;
			}

			if (!dev->config.descriptor && 
				urb.UrbControlDescriptorRequest.TransferBufferLength >= ((PUSB_CONFIGURATION_DESCRIPTOR)buffer)->wTotalLength)
			{
				//
				// This is a special case scenario where we cache the first
				// config deescriptor requested when dev->config.descriptor == NULL
				// and this was a request for the *entire* descriptor.
				// 
				// Nearly all windows USB devices will only have one configuration.
				// In the case a the filter driver, it does *not* auto configure the
				// device which is where the *active* config descriptor caching occurs.
				//
				// This code ensures the first config descriptor requested is always cached
				// even if the device is not configured yet.
				//

				PUSB_CONFIGURATION_DESCRIPTOR config_desc;
				size = ((PUSB_CONFIGURATION_DESCRIPTOR)buffer)->wTotalLength;

				if (!( config_desc = ExAllocatePool(NonPagedPool, size)))
				{
					USBERR0("memory allocation error\n");
					status =  STATUS_NO_MEMORY;
					goto Done;
				}

				dev->config.descriptor=config_desc;

				RtlCopyMemory(dev->config.descriptor,buffer,size);
				dev->config.value=0;
				dev->config.total_size=size;
				dev->config.index=index;

				*received = size;
			}
			else
			{
				*received = urb.UrbControlDescriptorRequest.TransferBufferLength;
			}
			goto Done;
		}
		else
		{
			// This is a request for the active configuration descriptor.
			// This is only updated upon a successful set_configuration().
			size = (size > dev->config.descriptor->wTotalLength) ? dev->config.descriptor->wTotalLength : size;
			RtlCopyMemory(buffer, dev->config.descriptor, size);

			*received = size;
			goto Done;
		}
	}

	// this is not a device or config descriptor reequest
	status = call_usbd(dev, &urb, IOCTL_INTERNAL_USB_SUBMIT_URB, timeout);


	if (!NT_SUCCESS(status) || !USBD_SUCCESS(urb.UrbHeader.Status))
	{
		USBERR("getting descriptor failed: status: 0x%x, urb-status: 0x%x\n", status, urb.UrbHeader.Status);
		*received = 0;
	}
	else
	{
		*received = urb.UrbControlDescriptorRequest.TransferBufferLength;
	}

Done:
    return status;
}

PUSB_CONFIGURATION_DESCRIPTOR get_config_descriptor(
	libusb_device_t *dev,
	int value,
	int *size,
	int* index)
{
    NTSTATUS status;
    USB_CONFIGURATION_DESCRIPTOR *desc = NULL;
    USB_DEVICE_DESCRIPTOR device_descriptor;
    int i;
    volatile int desc_size;
	
	*index = 0;

    status = get_descriptor(dev, &device_descriptor,
                            sizeof(USB_DEVICE_DESCRIPTOR),
                            USB_DEVICE_DESCRIPTOR_TYPE,
                            USB_RECIP_DEVICE,
                            0, 0, size, LIBUSB_DEFAULT_TIMEOUT);

    if (!NT_SUCCESS(status) || *size != sizeof(USB_DEVICE_DESCRIPTOR))
    {
        USBERR0("getting device descriptor failed\n");
        return NULL;
    }

    if (!(desc = ExAllocatePool(NonPagedPool,
                                sizeof(USB_CONFIGURATION_DESCRIPTOR))))
    {
        USBERR0("memory allocation error\n");
        return NULL;
    }

    for (i = 0; i < device_descriptor.bNumConfigurations; i++)
    {

        if (!NT_SUCCESS(get_descriptor(dev, desc,
                                       sizeof(USB_CONFIGURATION_DESCRIPTOR),
                                       USB_CONFIGURATION_DESCRIPTOR_TYPE,
                                       USB_RECIP_DEVICE,
                                       i, 0, size, LIBUSB_DEFAULT_TIMEOUT)))
        {
            USBERR0("getting configuration descriptor failed\n");
            break;
        }

		// if value is negative, get the descriptor by index
		// if positive, get it by value.
        if ((value > 0 && desc->bConfigurationValue == value) ||
			(value < 0 && -(i+1) == (value)))
        {
            desc_size = desc->wTotalLength;
            ExFreePool(desc);

            if (!(desc = ExAllocatePool(NonPagedPool, desc_size)))
            {
                USBERR0("memory allocation error\n");
                break;
            }

            if (!NT_SUCCESS(get_descriptor(dev, desc, desc_size,
                                           USB_CONFIGURATION_DESCRIPTOR_TYPE,
                                           USB_RECIP_DEVICE,
                                           i, 0, size, LIBUSB_DEFAULT_TIMEOUT)))
            {
                USBERR0("getting configuration descriptor failed\n");
                break;
            }
			else
			{
				*index = i;
			}

            return desc;
        }
    }

    if (desc)
    {
        ExFreePool(desc);
    }

    return NULL;
}