libusbk-sys 0.2.0

Rust Windows library for accessing USB devices via libusbK
Documentation 
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

/*! \file drv_interface.h
*/

#ifndef __DRV_INTERFACE_H__
#define __DRV_INTERFACE_H__


#include "drv_private.h"

PINTERFACE_CONTEXT Interface_GetContextByNumber(
    __in PDEVICE_CONTEXT deviceContext,
    __in UCHAR interfaceNumber);

PINTERFACE_CONTEXT Interface_GetContextByIndex(
    __in PDEVICE_CONTEXT deviceContext,
    __in UCHAR interfaceIndex);

NTSTATUS Interface_Start(
    __in PDEVICE_CONTEXT deviceContext,
    __in PINTERFACE_CONTEXT interfaceContext);

NTSTATUS Interface_InitContext(
    __in PDEVICE_CONTEXT deviceContext,
    __in PINTERFACE_CONTEXT interfaceContext);

VOID Interface_DeletePipesAndQueues(
    __in PINTERFACE_CONTEXT interfaceContext);

NTSTATUS Interface_SetAltSetting(
    __in  PDEVICE_CONTEXT deviceContext,
    __in  PREQUEST_CONTEXT requestContext,
    __out PINTERFACE_CONTEXT* interfaceContext);

NTSTATUS Interface_GetAltSetting(
    __in PDEVICE_CONTEXT deviceContext,
    __in PREQUEST_CONTEXT requestContext,
    __out PINTERFACE_CONTEXT* interfaceContext);

NTSTATUS Interface_Claim(
    __in PDEVICE_CONTEXT deviceContext,
    __in PREQUEST_CONTEXT requestContext,
    __in PFILE_OBJECT fileObject,
    __out PINTERFACE_CONTEXT* interfaceContext);

NTSTATUS Interface_Release(
    __in PDEVICE_CONTEXT deviceContext,
    __in PREQUEST_CONTEXT requestContext,
    __in PFILE_OBJECT fileObject,
    __out PINTERFACE_CONTEXT* interfaceContext);

NTSTATUS Interface_ReleaseAll(
    __in  PDEVICE_CONTEXT deviceContext,
    __in  PFILE_OBJECT fileObject);

FORCEINLINE NTSTATUS GetInterfaceAltSettingIndexFromRequest(
    __in PREQUEST_CONTEXT requestContext,
    __in PINTERFACE_CONTEXT interfaceContext,
    __out_opt PUCHAR altsetting_index,
    __out_opt PUCHAR altSettingCount,
    __out_opt PUSB_INTERFACE_DESCRIPTOR altSettingInterfaceDescriptor)
{
	UCHAR altCount = WdfUsbInterfaceGetNumSettings(interfaceContext->Interface);
	UCHAR altIndex = BYTE_MAX;
	USB_INTERFACE_DESCRIPTOR interfaceDescriptor = {0};

	if (requestContext->IoControlRequest.intf.altf_use_index)
	{
		if (requestContext->IoControlRequest.intf.altsetting_index >= altCount)
		{
			USBERR("alternate interface index %u does not exist\n",
			       requestContext->IoControlRequest.intf.altsetting_index);
			return STATUS_NO_MORE_ENTRIES;
		}
		altIndex = (UCHAR)requestContext->IoControlRequest.intf.altsetting_index;
		WdfUsbInterfaceGetDescriptor(interfaceContext->Interface, altIndex, &interfaceDescriptor);

	}
	else
	{
		UCHAR altPos;
		for (altPos = 0; altPos < altCount; altPos++)
		{
			WdfUsbInterfaceGetDescriptor(interfaceContext->Interface, altPos, &interfaceDescriptor);
			if (interfaceDescriptor.bAlternateSetting == requestContext->IoControlRequest.intf.altsetting_number)
			{
				altIndex = altPos;
				break;
			}
		}
	}

	if (altIndex == BYTE_MAX)
	{
		USBERR("alternate interface number %u does not exist\n",
		       requestContext->IoControlRequest.intf.altsetting_number);
		return STATUS_NO_MORE_ENTRIES;
	}

	if (altsetting_index)
		*altsetting_index = altIndex;

	if (altSettingCount)
		*altSettingCount = altCount;

	if (altSettingInterfaceDescriptor)
		RtlCopyMemory(altSettingInterfaceDescriptor, &interfaceDescriptor, sizeof(*altSettingInterfaceDescriptor));

	return STATUS_SUCCESS;
}

FORCEINLINE NTSTATUS GetInterfaceContextFromRequest(
    __in  PDEVICE_CONTEXT deviceContext,
    __in  PREQUEST_CONTEXT requestContext,
    __out PINTERFACE_CONTEXT* interfaceContext)
{
	if (!deviceContext->UsbConfigurationDescriptor)
	{
		USBERR("device is not configured\n");
		return STATUS_INVALID_DEVICE_STATE;
	}

	if (requestContext->IoControlRequest.intf.intf_use_index)
	{
		UCHAR intfIndex = (UCHAR)requestContext->IoControlRequest.intf.interface_index;
		*interfaceContext = Interface_GetContextByIndex(deviceContext, intfIndex);
		if (!(*interfaceContext))
		{
			USBERR("unable to get interface index %u\n", intfIndex);
			return STATUS_NO_MORE_ENTRIES;
		}
	}
	else
	{
		UCHAR intfNumber = (UCHAR)requestContext->IoControlRequest.intf.interface_number;
		*interfaceContext = Interface_GetContextByNumber(deviceContext, intfNumber);
		if (!(*interfaceContext))
		{
			USBERR("unable to get interface number %u\n", intfNumber);
			return STATUS_NO_MORE_ENTRIES;
		}
	}

	return (*interfaceContext) ? STATUS_SUCCESS : STATUS_UNSUCCESSFUL;
}

#endif