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
|
/*
* BRLTTY - A background process providing access to the console screen (when in
* text mode) for a blind person using a refreshable braille display.
*
* Copyright (C) 1995-2024 by The BRLTTY Developers.
*
* BRLTTY comes with ABSOLUTELY NO WARRANTY.
*
* This is free software, placed under the terms of the
* GNU Lesser General Public License, as published by the Free Software
* Foundation; either version 2.1 of the License, or (at your option) any
* later version. Please see the file LICENSE-LGPL for details.
*
* Web Page: http://brltty.app/
*
* This software is maintained by Dave Mielke <dave@mielke.cc>.
*/
#ifndef BRLTTY_INCLUDED_USB_INTERNAL
#define BRLTTY_INCLUDED_USB_INTERNAL
#include "usb_types.h"
#include "queue.h"
#include "async_io.h"
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
typedef struct {
UsbInputFilter *filter;
} UsbInputFilterEntry;
typedef struct UsbDeviceExtensionStruct UsbDeviceExtension;
typedef struct UsbEndpointStruct UsbEndpoint;
typedef struct UsbEndpointExtensionStruct UsbEndpointExtension;
struct UsbEndpointStruct {
UsbDevice *device;
const UsbInterfaceDescriptor *interface;
const UsbEndpointDescriptor *descriptor;
UsbEndpointExtension *extension;
int (*prepare) (UsbEndpoint *endpoint);
union {
struct {
struct {
Queue *requests;
AsyncHandle alarm;
int delay;
} pending;
struct {
void *request;
unsigned char *buffer;
size_t length;
} completed;
struct {
FileDescriptor input;
FileDescriptor output;
AsyncHandle monitor;
int error;
} pipe;
} input;
struct {
char structMayNotBeEmpty;
} output;
} direction;
};
struct UsbDeviceStruct {
UsbDeviceDescriptor descriptor;
UsbDeviceExtension *extension;
struct {
const UsbSerialOperations *operations;
UsbSerialData *data;
} serial;
UsbConfigurationDescriptor *configuration;
const UsbInterfaceDescriptor *interface;
Queue *endpoints;
Queue *inputFilters;
uint16_t language;
unsigned char resetDevice:1;
unsigned char disableEndpointReset:1;
struct {
const UsbInterfaceDescriptor *endpointInterfaceDescriptor;
} scratch;
};
extern UsbDevice *usbTestDevice (
UsbDeviceExtension *extension,
UsbDeviceChooser *chooser,
UsbChooseChannelData *data
);
extern UsbEndpoint *usbGetEndpoint (UsbDevice *device, unsigned char endpointAddress);
extern UsbEndpoint *usbGetInputEndpoint (UsbDevice *device, unsigned char endpointNumber);
extern UsbEndpoint *usbGetOutputEndpoint (UsbDevice *device, unsigned char endpointNumber);
extern int usbApplyInputFilters (UsbEndpoint *endpoint, void *buffer, size_t size, ssize_t *length);
extern void usbLogInputProblem (UsbEndpoint *endpoint, const char *problem);
extern int usbHandleInputResponse (UsbEndpoint *endpoint, const void *buffer, size_t length);
extern int usbSetSerialOperations (UsbDevice *device);
extern int usbSetConfiguration (UsbDevice *device, unsigned char configuration);
extern int usbClaimInterface (UsbDevice *device, unsigned char interface);
extern int usbReleaseInterface (UsbDevice *device, unsigned char interface);
extern int usbSetAlternative (
UsbDevice *device,
unsigned char interface,
unsigned char alternative
);
extern int usbMakeInputPipe (UsbEndpoint *endpoint);
extern void usbDestroyInputPipe (UsbEndpoint *endpoint);
extern int usbEnqueueInput (UsbEndpoint *endpoint, const void *buffer, size_t length);
extern void usbSetEndpointInputError (UsbEndpoint *endpoint, int error);
extern void usbSetDeviceInputError (UsbDevice *device, int error);
extern int usbMonitorInputPipe (
UsbDevice *device, unsigned char endpointNumber,
AsyncMonitorCallback *callback, void *data
);
extern ssize_t usbControlTransfer (
UsbDevice *device,
uint8_t direction,
uint8_t recipient,
uint8_t type,
uint8_t request,
uint16_t value,
uint16_t index,
void *buffer,
uint16_t length,
int timeout
);
extern int usbReadDeviceDescriptor (UsbDevice *device);
extern int usbAllocateEndpointExtension (UsbEndpoint *endpoint);
extern void usbDeallocateEndpointExtension (UsbEndpointExtension *eptx);
extern void usbDeallocateDeviceExtension (UsbDeviceExtension *devx);
extern void usbLogSetupPacket (const UsbSetupPacket *setup);
extern void usbMakeSetupPacket (
UsbSetupPacket *setup,
uint8_t direction,
uint8_t recipient,
uint8_t type,
uint8_t request,
uint16_t value,
uint16_t index,
uint16_t length
);
extern void usbLogEndpointData (
UsbEndpoint *endpoint, const char *label,
const void *data, size_t size
);
#ifdef __cplusplus
}
#endif /* __cplusplus */
#endif /* BRLTTY_INCLUDED_USB_INTERNAL */
|
