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
|
// Copyright 2019 The Chromium OS Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
use std::cmp;
use std::sync::Arc;
use super::error::*;
use super::utils::{submit_transfer, update_transfer_state};
use crate::usb::xhci::scatter_gather_buffer::ScatterGatherBuffer;
use crate::usb::xhci::xhci_transfer::{
TransferDirection, XhciTransfer, XhciTransferState, XhciTransferType,
};
use crate::utils::AsyncJobQueue;
use crate::utils::FailHandle;
use sync::Mutex;
use sys_util::error;
use usb_util::{
Device, EndpointDirection, EndpointType, Transfer, TransferStatus, ENDPOINT_DIRECTION_OFFSET,
};
/// Isochronous, Bulk or Interrupt endpoint.
pub struct UsbEndpoint {
fail_handle: Arc<dyn FailHandle>,
job_queue: Arc<AsyncJobQueue>,
device: Arc<Mutex<Device>>,
endpoint_number: u8,
direction: EndpointDirection,
ty: EndpointType,
}
impl UsbEndpoint {
/// Create new endpoint. This function will panic if endpoint type is control.
pub fn new(
fail_handle: Arc<dyn FailHandle>,
job_queue: Arc<AsyncJobQueue>,
device: Arc<Mutex<Device>>,
endpoint_number: u8,
direction: EndpointDirection,
ty: EndpointType,
) -> UsbEndpoint {
assert!(ty != EndpointType::Control);
UsbEndpoint {
fail_handle,
job_queue,
device,
endpoint_number,
direction,
ty,
}
}
fn ep_addr(&self) -> u8 {
self.endpoint_number | ((self.direction as u8) << ENDPOINT_DIRECTION_OFFSET)
}
/// Returns true is this endpoint matches number and direction.
pub fn match_ep(&self, endpoint_number: u8, dir: TransferDirection) -> bool {
let self_dir = match self.direction {
EndpointDirection::HostToDevice => TransferDirection::Out,
EndpointDirection::DeviceToHost => TransferDirection::In,
};
self.endpoint_number == endpoint_number && self_dir == dir
}
/// Handle a xhci transfer.
pub fn handle_transfer(&self, transfer: XhciTransfer) -> Result<()> {
let buffer = match transfer
.get_transfer_type()
.map_err(Error::GetXhciTransferType)?
{
XhciTransferType::Normal(buffer) => buffer,
XhciTransferType::Noop => {
return transfer
.on_transfer_complete(&TransferStatus::Completed, 0)
.map_err(Error::TransferComplete);
}
_ => {
error!("unhandled xhci transfer type by usb endpoint");
return transfer
.on_transfer_complete(&TransferStatus::Error, 0)
.map_err(Error::TransferComplete);
}
};
match self.ty {
EndpointType::Bulk => {
self.handle_bulk_transfer(transfer, buffer)?;
}
EndpointType::Interrupt => {
self.handle_interrupt_transfer(transfer, buffer)?;
}
_ => {
return transfer
.on_transfer_complete(&TransferStatus::Error, 0)
.map_err(Error::TransferComplete);
}
}
Ok(())
}
fn get_transfer_buffer(&self, buffer: &ScatterGatherBuffer) -> Result<Vec<u8>> {
let mut v = vec![0u8; buffer.len().map_err(Error::BufferLen)?];
if self.direction == EndpointDirection::HostToDevice {
// Read data from ScatterGatherBuffer to a continuous memory.
buffer.read(v.as_mut_slice()).map_err(Error::ReadBuffer)?;
}
Ok(v)
}
fn handle_bulk_transfer(
&self,
xhci_transfer: XhciTransfer,
buffer: ScatterGatherBuffer,
) -> Result<()> {
let transfer_buffer = self.get_transfer_buffer(&buffer)?;
let usb_transfer =
Transfer::new_bulk(self.ep_addr(), transfer_buffer).map_err(Error::CreateTransfer)?;
self.do_handle_transfer(xhci_transfer, usb_transfer, buffer)
}
fn handle_interrupt_transfer(
&self,
xhci_transfer: XhciTransfer,
buffer: ScatterGatherBuffer,
) -> Result<()> {
let transfer_buffer = self.get_transfer_buffer(&buffer)?;
let usb_transfer = Transfer::new_interrupt(self.ep_addr(), transfer_buffer)
.map_err(Error::CreateTransfer)?;
self.do_handle_transfer(xhci_transfer, usb_transfer, buffer)
}
fn do_handle_transfer(
&self,
xhci_transfer: XhciTransfer,
mut usb_transfer: Transfer,
buffer: ScatterGatherBuffer,
) -> Result<()> {
let xhci_transfer = Arc::new(xhci_transfer);
let tmp_transfer = xhci_transfer.clone();
match self.direction {
EndpointDirection::HostToDevice => {
usb_debug!(
"out transfer ep_addr {:#x}, buffer len {:?}",
self.ep_addr(),
buffer.len(),
);
let callback = move |t: Transfer| {
usb_debug!("out transfer callback");
update_transfer_state(&xhci_transfer, &t)?;
let state = xhci_transfer.state().lock();
match *state {
XhciTransferState::Cancelled => {
usb_debug!("transfer has been cancelled");
drop(state);
xhci_transfer
.on_transfer_complete(&TransferStatus::Cancelled, 0)
.map_err(Error::TransferComplete)
}
XhciTransferState::Completed => {
let status = t.status();
let actual_length = t.actual_length();
drop(state);
xhci_transfer
.on_transfer_complete(&status, actual_length as u32)
.map_err(Error::TransferComplete)
}
_ => {
error!("xhci trasfer state (host to device) is invalid");
Err(Error::BadXhciTransferState)
}
}
};
let fail_handle = self.fail_handle.clone();
usb_transfer.set_callback(move |t: Transfer| match callback(t) {
Ok(_) => {}
Err(e) => {
error!("bulk transfer callback failed: {:?}", e);
fail_handle.fail();
}
});
submit_transfer(
self.fail_handle.clone(),
&self.job_queue,
tmp_transfer,
&mut self.device.lock(),
usb_transfer,
)?;
}
EndpointDirection::DeviceToHost => {
usb_debug!(
"in transfer ep_addr {:#x}, buffer len {:?}",
self.ep_addr(),
buffer.len()
);
let _addr = self.ep_addr();
let callback = move |t: Transfer| {
usb_debug!("ep {:#x} in transfer data {:?}", _addr, t.buffer.as_slice());
update_transfer_state(&xhci_transfer, &t)?;
let state = xhci_transfer.state().lock();
match *state {
XhciTransferState::Cancelled => {
usb_debug!("transfer has been cancelled");
drop(state);
xhci_transfer
.on_transfer_complete(&TransferStatus::Cancelled, 0)
.map_err(Error::TransferComplete)
}
XhciTransferState::Completed => {
let status = t.status();
let actual_length = t.actual_length() as usize;
let copied_length = buffer
.write(t.buffer.as_slice())
.map_err(Error::WriteBuffer)?;
let actual_length = cmp::min(actual_length, copied_length);
drop(state);
xhci_transfer
.on_transfer_complete(&status, actual_length as u32)
.map_err(Error::TransferComplete)
}
_ => {
// update state is already invoked. This match should not be in any
// other state.
error!("xhci trasfer state (device to host) is invalid");
Err(Error::BadXhciTransferState)
}
}
};
let fail_handle = self.fail_handle.clone();
usb_transfer.set_callback(move |t: Transfer| match callback(t) {
Ok(_) => {}
Err(e) => {
error!("bulk transfer callback {:?}", e);
fail_handle.fail();
}
});
submit_transfer(
self.fail_handle.clone(),
&self.job_queue,
tmp_transfer,
&mut self.device.lock(),
usb_transfer,
)?;
}
}
Ok(())
}
}
|