1
/* usbtrans.c - USB Transfers and Transactions. */
3
* GRUB -- GRand Unified Bootloader
4
* Copyright (C) 2008 Free Software Foundation, Inc.
6
* GRUB is free software: you can redistribute it and/or modify
7
* it under the terms of the GNU General Public License as published by
8
* the Free Software Foundation, either version 3 of the License, or
9
* (at your option) any later version.
11
* GRUB is distributed in the hope that it will be useful,
12
* but WITHOUT ANY WARRANTY; without even the implied warranty of
13
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14
* GNU General Public License for more details.
16
* You should have received a copy of the GNU General Public License
17
* along with GRUB. If not, see <http://www.gnu.org/licenses/>.
23
#include <grub/misc.h>
25
#include <grub/usbtrans.h>
26
#include <grub/time.h>
29
grub_usb_execute_and_wait_transfer (grub_usb_device_t dev,
30
grub_usb_transfer_t transfer,
31
int timeout, grub_size_t *actual)
34
grub_uint64_t endtime;
36
err = dev->controller.dev->setup_transfer (&dev->controller, transfer);
39
/* endtime moved behind setup transfer to prevent false timeouts
40
* while debugging... */
41
endtime = grub_get_time_ms () + timeout;
44
err = dev->controller.dev->check_transfer (&dev->controller, transfer,
47
return GRUB_USB_ERR_NONE;
48
if (err != GRUB_USB_ERR_WAIT)
50
if (grub_get_time_ms () > endtime)
52
err = dev->controller.dev->cancel_transfer (&dev->controller,
56
return GRUB_USB_ERR_TIMEOUT;
63
grub_usb_control_msg (grub_usb_device_t dev,
68
grub_size_t size0, char *data_in)
71
grub_usb_transfer_t transfer;
73
volatile struct grub_usb_packet_setup *setupdata;
74
grub_uint32_t setupdata_addr;
77
struct grub_pci_dma_chunk *data_chunk, *setupdata_chunk;
79
grub_uint32_t data_addr;
80
grub_size_t size = size0;
83
/* FIXME: avoid allocation any kind of buffer in a first place. */
84
data_chunk = grub_memalign_dma32 (128, size ? : 16);
86
return GRUB_USB_ERR_INTERNAL;
87
data = grub_dma_get_virt (data_chunk);
88
data_addr = grub_dma_get_phys (data_chunk);
89
grub_memcpy ((char *) data, data_in, size);
92
"control: reqtype=0x%02x req=0x%02x val=0x%02x idx=0x%02x size=%lu\n",
93
reqtype, request, value, index, (unsigned long)size);
95
/* Create a transfer. */
96
transfer = grub_malloc (sizeof (*transfer));
99
grub_dma_free (data_chunk);
103
setupdata_chunk = grub_memalign_dma32 (32, sizeof (*setupdata));
104
if (! setupdata_chunk)
106
grub_free (transfer);
107
grub_dma_free (data_chunk);
111
setupdata = grub_dma_get_virt (setupdata_chunk);
112
setupdata_addr = grub_dma_get_phys (setupdata_chunk);
114
/* Determine the maximum packet size. */
115
if (dev->descdev.maxsize0)
116
max = dev->descdev.maxsize0;
120
grub_dprintf ("usb", "control: transfer = %p, dev = %p\n", transfer, dev);
122
datablocks = (size + max - 1) / max;
124
/* XXX: Discriminate between different types of control
126
transfer->transcnt = datablocks + 2;
127
transfer->size = size; /* XXX ? */
128
transfer->endpoint = 0;
129
transfer->devaddr = dev->addr;
130
transfer->type = GRUB_USB_TRANSACTION_TYPE_CONTROL;
134
/* Allocate an array of transfer data structures. */
135
transfer->transactions = grub_malloc (transfer->transcnt
136
* sizeof (struct grub_usb_transfer));
137
if (! transfer->transactions)
139
grub_free (transfer);
140
grub_dma_free (setupdata_chunk);
141
grub_dma_free (data_chunk);
145
/* Build a Setup packet. XXX: Endianness. */
146
setupdata->reqtype = reqtype;
147
setupdata->request = request;
148
setupdata->value = value;
149
setupdata->index = index;
150
setupdata->length = size;
151
transfer->transactions[0].size = sizeof (*setupdata);
152
transfer->transactions[0].pid = GRUB_USB_TRANSFER_TYPE_SETUP;
153
transfer->transactions[0].data = setupdata_addr;
154
transfer->transactions[0].toggle = 0;
156
/* Now the data... XXX: Is this the right way to transfer control
158
for (i = 0; i < datablocks; i++)
160
grub_usb_transaction_t tr = &transfer->transactions[i + 1];
162
tr->size = (size > max) ? max : size;
163
/* Use the right most bit as the data toggle. Simple and
165
tr->toggle = !(i & 1);
167
tr->pid = GRUB_USB_TRANSFER_TYPE_IN;
169
tr->pid = GRUB_USB_TRANSFER_TYPE_OUT;
170
tr->data = data_addr + i * max;
171
tr->preceding = i * max;
175
/* End with an empty OUT transaction. */
176
transfer->transactions[datablocks + 1].size = 0;
177
transfer->transactions[datablocks + 1].data = 0;
178
if ((reqtype & 128) && datablocks)
179
transfer->transactions[datablocks + 1].pid = GRUB_USB_TRANSFER_TYPE_OUT;
181
transfer->transactions[datablocks + 1].pid = GRUB_USB_TRANSFER_TYPE_IN;
183
transfer->transactions[datablocks + 1].toggle = 1;
185
err = grub_usb_execute_and_wait_transfer (dev, transfer, 1000, &actual);
187
grub_dprintf ("usb", "control: err=%d\n", err);
189
grub_free (transfer->transactions);
191
grub_free (transfer);
192
grub_dma_free (data_chunk);
193
grub_dma_free (setupdata_chunk);
195
grub_memcpy (data_in, (char *) data, size0);
200
static grub_usb_transfer_t
201
grub_usb_bulk_setup_readwrite (grub_usb_device_t dev,
202
int endpoint, grub_size_t size0, char *data_in,
203
grub_transfer_type_t type)
206
grub_usb_transfer_t transfer;
210
grub_uint32_t data_addr;
211
struct grub_pci_dma_chunk *data_chunk;
212
grub_size_t size = size0;
213
int toggle = dev->toggle[endpoint];
215
grub_dprintf ("usb", "bulk: size=0x%02lx type=%d\n", (unsigned long) size,
218
/* FIXME: avoid allocation any kind of buffer in a first place. */
219
data_chunk = grub_memalign_dma32 (128, size);
222
data = grub_dma_get_virt (data_chunk);
223
data_addr = grub_dma_get_phys (data_chunk);
224
if (type == GRUB_USB_TRANSFER_TYPE_OUT)
225
grub_memcpy ((char *) data, data_in, size);
227
/* Use the maximum packet size given in the endpoint descriptor. */
228
if (dev->initialized)
230
struct grub_usb_desc_endp *endpdesc;
231
endpdesc = grub_usb_get_endpdescriptor (dev, endpoint);
234
max = endpdesc->maxpacket;
241
/* Create a transfer. */
242
transfer = grub_malloc (sizeof (struct grub_usb_transfer));
245
grub_dma_free (data_chunk);
249
datablocks = ((size + max - 1) / max);
250
transfer->transcnt = datablocks;
251
transfer->size = size - 1;
252
transfer->endpoint = endpoint;
253
transfer->devaddr = dev->addr;
254
transfer->type = GRUB_USB_TRANSACTION_TYPE_BULK;
255
transfer->dir = type;
258
transfer->last_trans = -1; /* Reset index of last processed transaction (TD) */
259
transfer->data_chunk = data_chunk;
260
transfer->data = data_in;
262
/* Allocate an array of transfer data structures. */
263
transfer->transactions = grub_malloc (transfer->transcnt
264
* sizeof (struct grub_usb_transfer));
265
if (! transfer->transactions)
267
grub_free (transfer);
268
grub_dma_free (data_chunk);
272
/* Set up all transfers. */
273
for (i = 0; i < datablocks; i++)
275
grub_usb_transaction_t tr = &transfer->transactions[i];
277
tr->size = (size > max) ? max : size;
278
/* XXX: Use the right most bit as the data toggle. Simple and
281
toggle = toggle ? 0 : 1;
283
tr->data = data_addr + i * max;
284
tr->preceding = i * max;
291
grub_usb_bulk_finish_readwrite (grub_usb_transfer_t transfer)
293
grub_usb_device_t dev = transfer->dev;
294
int toggle = dev->toggle[transfer->endpoint];
296
/* We must remember proper toggle value even if some transactions
297
* were not processed - correct value should be inversion of last
298
* processed transaction (TD). */
299
if (transfer->last_trans >= 0)
300
toggle = transfer->transactions[transfer->last_trans].toggle ? 0 : 1;
302
toggle = dev->toggle[transfer->endpoint]; /* Nothing done, take original */
303
grub_dprintf ("usb", "bulk: toggle=%d\n", toggle);
304
dev->toggle[transfer->endpoint] = toggle;
306
if (transfer->dir == GRUB_USB_TRANSFER_TYPE_IN)
307
grub_memcpy (transfer->data, (void *)
308
grub_dma_get_virt (transfer->data_chunk),
311
grub_free (transfer->transactions);
312
grub_free (transfer);
313
grub_dma_free (transfer->data_chunk);
316
static grub_usb_err_t
317
grub_usb_bulk_readwrite (grub_usb_device_t dev,
318
int endpoint, grub_size_t size0, char *data_in,
319
grub_transfer_type_t type, int timeout,
323
grub_usb_transfer_t transfer;
325
transfer = grub_usb_bulk_setup_readwrite (dev, endpoint, size0,
328
return GRUB_USB_ERR_INTERNAL;
329
err = grub_usb_execute_and_wait_transfer (dev, transfer, timeout, actual);
331
grub_usb_bulk_finish_readwrite (transfer);
337
grub_usb_bulk_write (grub_usb_device_t dev,
338
int endpoint, grub_size_t size, char *data)
343
err = grub_usb_bulk_readwrite (dev, endpoint, size, data,
344
GRUB_USB_TRANSFER_TYPE_OUT, 1000, &actual);
345
if (!err && actual != size)
346
err = GRUB_USB_ERR_DATA;
351
grub_usb_bulk_read (grub_usb_device_t dev,
352
int endpoint, grub_size_t size, char *data)
356
err = grub_usb_bulk_readwrite (dev, endpoint, size, data,
357
GRUB_USB_TRANSFER_TYPE_IN, 1000, &actual);
358
if (!err && actual != size)
359
err = GRUB_USB_ERR_DATA;
364
grub_usb_check_transfer (grub_usb_transfer_t transfer, grub_size_t *actual)
367
grub_usb_device_t dev = transfer->dev;
369
err = dev->controller.dev->check_transfer (&dev->controller, transfer,
371
if (err == GRUB_USB_ERR_WAIT)
374
grub_usb_bulk_finish_readwrite (transfer);
380
grub_usb_bulk_read_background (grub_usb_device_t dev,
381
int endpoint, grub_size_t size, void *data)
384
grub_usb_transfer_t transfer;
386
transfer = grub_usb_bulk_setup_readwrite (dev, endpoint, size,
387
data, GRUB_USB_TRANSFER_TYPE_IN);
391
err = dev->controller.dev->setup_transfer (&dev->controller, transfer);
399
grub_usb_cancel_transfer (grub_usb_transfer_t transfer)
401
grub_usb_device_t dev = transfer->dev;
402
dev->controller.dev->cancel_transfer (&dev->controller, transfer);
403
grub_errno = GRUB_ERR_NONE;
407
grub_usb_bulk_read_extended (grub_usb_device_t dev,
408
int endpoint, grub_size_t size, char *data,
409
int timeout, grub_size_t *actual)
411
return grub_usb_bulk_readwrite (dev, endpoint, size, data,
412
GRUB_USB_TRANSFER_TYPE_IN, timeout, actual);