← Back to branch summary

~hamo/ubuntu/precise/grub2/grub2.hi_res

« back to all changes in this revision

Viewing changes to disk/usbms.c

  • Committer: Bazaar Package Importer
  • Author(s): Colin Watson, Colin Watson, Robert Millan, Updated translations
  • Date: 2010-11-22 12:24:56 UTC
  • mfrom: (1.26.4 upstream) (17.3.36 sid)
  • mto: (17.3.43 sid)
  • mto: This revision was merged to the branch mainline in revision 89.
  • Revision ID: james.westby@ubuntu.com-20101122122456-y82z3sfb7k4zfdcc
Tags: 1.99~20101122-1
http://bugs.debian.org/550658
http://bugs.debian.org/550702
http://bugs.debian.org/591416
http://bugs.debian.org/593347
http://bugs.debian.org/551627
http://bugs.debian.org/589325
http://bugs.debian.org/543924
http://bugs.debian.org/603354
http://bugs.debian.org/604003
http://bugs.debian.org/604102
[ Colin Watson ]
* New Bazaar snapshot.  Too many changes to list in full, but some of the
  more user-visible ones are as follows:
  - GRUB script:
    + Function parameters, "break", "continue", "shift", "setparams",
      "return", and "!".
    + "export" command supports multiple variable names.
    + Multi-line quoted strings support.
    + Wildcard expansion.
  - sendkey support.
  - USB hotunplugging and USB serial support.
  - Rename CD-ROM to cd on BIOS.
  - Add new --boot-directory option to grub-install, grub-reboot, and
    grub-set-default; the old --root-directory option is still accepted
    but was often confusing.
  - Basic btrfs detection/UUID support (but no file reading yet).
  - bash-completion for utilities.
  - If a device is listed in device.map, always assume that it is
    BIOS-visible rather than using extra layers such as LVM or RAID.
  - Add grub-mknetdir script (closes: #550658).
  - Remove deprecated "root" command.
  - Handle RAID devices containing virtio components.
  - GRUB Legacy configuration file support (via grub-menulst2cfg).
  - Keyboard layout support (via grub-mklayout and grub-kbdcomp).
  - Check generated grub.cfg for syntax errors before saving.
  - Pause execution for at most ten seconds if any errors are displayed,
    so that the user has a chance to see them.
  - Support submenus.
  - Write embedding zone using Reed-Solomon, so that it's robust against
    being partially overwritten (closes: #550702, #591416, #593347).
  - GRUB_DISABLE_LINUX_RECOVERY and GRUB_DISABLE_NETBSD_RECOVERY merged
    into a single GRUB_DISABLE_RECOVERY variable.
  - Fix loader memory allocation failure (closes: #551627).
  - Don't call savedefault on recovery entries (closes: #589325).
  - Support triple-indirect blocks on ext2 (closes: #543924).
  - Recognise DDF1 fake RAID (closes: #603354).

[ Robert Millan ]
* Use dpkg architecture wildcards.

[ Updated translations ]
* Slovenian (Vanja Cvelbar).  Closes: #604003
* Dzongkha (dawa pemo via Tenzin Dendup).  Closes: #604102

Show diffs side-by-side

added added

removed removed

Lines of Context:
disk/usbms.c
1
 
/* usbms.c - USB Mass Storage Support.  */
2
 
/*
3
 
 *  GRUB  --  GRand Unified Bootloader
4
 
 *  Copyright (C) 2008  Free Software Foundation, Inc.
5
 
 *
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.
10
 
 *
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.
15
 
 *
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/>.
18
 
 */
19
 
 
20
 
#include <grub/dl.h>
21
 
#include <grub/mm.h>
22
 
#include <grub/usb.h>
23
 
#include <grub/scsi.h>
24
 
#include <grub/scsicmd.h>
25
 
#include <grub/misc.h>
26
 
 
27
 
#define GRUB_USBMS_DIRECTION_BIT        7
28
 
 
29
 
/* The USB Mass Storage Command Block Wrapper.  */
30
 
struct grub_usbms_cbw
31
 
{
32
 
  grub_uint32_t signature;
33
 
  grub_uint32_t tag;
34
 
  grub_uint32_t transfer_length;
35
 
  grub_uint8_t flags;
36
 
  grub_uint8_t lun;
37
 
  grub_uint8_t length;
38
 
  grub_uint8_t cbwcb[16];
39
 
} __attribute__ ((packed));
40
 
 
41
 
struct grub_usbms_csw
42
 
{
43
 
  grub_uint32_t signature;
44
 
  grub_uint32_t tag;
45
 
  grub_uint32_t residue;
46
 
  grub_uint8_t status;
47
 
} __attribute__ ((packed));
48
 
 
49
 
struct grub_usbms_dev
50
 
{
51
 
  struct grub_usb_device *dev;
52
 
 
53
 
  int luns;
54
 
 
55
 
  int interface;
56
 
  struct grub_usb_desc_endp *in;
57
 
  struct grub_usb_desc_endp *out;
58
 
 
59
 
  int in_maxsz;
60
 
  int out_maxsz;
61
 
 
62
 
  struct grub_usbms_dev *next;
63
 
};
64
 
typedef struct grub_usbms_dev *grub_usbms_dev_t;
65
 
 
66
 
static grub_usbms_dev_t grub_usbms_dev_list;
67
 
 
68
 
static int devcnt;
69
 
 
70
 
static grub_err_t
71
 
grub_usbms_reset (grub_usb_device_t dev, int interface)
72
 
{
73
 
  return grub_usb_control_msg (dev, 0x21, 255, 0, interface, 0, 0);
74
 
}
75
 
 
76
 
static void
77
 
grub_usbms_finddevs (void)
78
 
{
79
 
  auto int usb_iterate (grub_usb_device_t dev);
80
 
 
81
 
  int usb_iterate (grub_usb_device_t usbdev)
82
 
    {
83
 
      grub_usb_err_t err;
84
 
      struct grub_usb_desc_device *descdev = &usbdev->descdev;
85
 
      int i;
86
 
 
87
 
      if (descdev->class != 0 || descdev->subclass || descdev->protocol != 0)
88
 
        return 0;
89
 
 
90
 
      /* XXX: Just check configuration 0 for now.  */
91
 
      for (i = 0; i < usbdev->config[0].descconf->numif; i++)
92
 
        {
93
 
          struct grub_usbms_dev *usbms;
94
 
          struct grub_usb_desc_if *interf;
95
 
          int j;
96
 
          grub_uint8_t luns;
97
 
 
98
 
          interf = usbdev->config[0].interf[i].descif;
99
 
 
100
 
          /* If this is not a USB Mass Storage device with a supported
101
 
             protocol, just skip it.  */
102
 
          if (interf->class != GRUB_USB_CLASS_MASS_STORAGE
103
 
              || interf->subclass != GRUB_USBMS_SUBCLASS_BULK
104
 
              || interf->protocol != GRUB_USBMS_PROTOCOL_BULK)
105
 
            {
106
 
              continue;
107
 
            }
108
 
 
109
 
          devcnt++;
110
 
          usbms = grub_zalloc (sizeof (struct grub_usbms_dev));
111
 
          if (! usbms)
112
 
            return 1;
113
 
 
114
 
          usbms->dev = usbdev;
115
 
          usbms->interface = i;
116
 
 
117
 
          /* Iterate over all endpoints of this interface, at least a
118
 
             IN and OUT bulk endpoint are required.  */
119
 
          for (j = 0; j < interf->endpointcnt; j++)
120
 
            {
121
 
              struct grub_usb_desc_endp *endp;
122
 
              endp = &usbdev->config[0].interf[i].descendp[j];
123
 
 
124
 
              if ((endp->endp_addr & 128) && (endp->attrib & 3) == 2)
125
 
                {
126
 
                  /* Bulk IN endpoint.  */
127
 
                  usbms->in = endp;
128
 
                  grub_usb_clear_halt (usbdev, endp->endp_addr & 128);
129
 
                  usbms->in_maxsz = endp->maxpacket;
130
 
                }
131
 
              else if (!(endp->endp_addr & 128) && (endp->attrib & 3) == 2)
132
 
                {
133
 
                  /* Bulk OUT endpoint.  */
134
 
                  usbms->out = endp;
135
 
                  grub_usb_clear_halt (usbdev, endp->endp_addr & 128);
136
 
                  usbms->out_maxsz = endp->maxpacket;
137
 
                }
138
 
            }
139
 
 
140
 
          if (!usbms->in || !usbms->out)
141
 
            {
142
 
              grub_free (usbms);
143
 
              return 0;
144
 
            }
145
 
 
146
 
          /* Query the amount of LUNs.  */
147
 
          err = grub_usb_control_msg (usbdev, 0xA1, 254,
148
 
                                      0, i, 1, (char *) &luns);
149
 
          if (err)
150
 
            {
151
 
              /* In case of a stall, clear the stall.  */
152
 
              if (err == GRUB_USB_ERR_STALL)
153
 
                {
154
 
                  grub_usb_clear_halt (usbdev, usbms->in->endp_addr & 3);
155
 
                  grub_usb_clear_halt (usbdev, usbms->out->endp_addr & 3);
156
 
                }
157
 
 
158
 
              /* Just set the amount of LUNs to one.  */
159
 
              grub_errno = GRUB_ERR_NONE;
160
 
              usbms->luns = 1;
161
 
            }
162
 
          else
163
 
            usbms->luns = luns;
164
 
 
165
 
          /* XXX: Check the magic values, does this really make
166
 
             sense?  */
167
 
          grub_usb_control_msg (usbdev, (1 << 6) | 1, 255,
168
 
                                0, i, 0, 0);
169
 
 
170
 
          /* XXX: To make Qemu work?  */
171
 
          if (usbms->luns == 0)
172
 
            usbms->luns = 1;
173
 
 
174
 
          usbms->next = grub_usbms_dev_list;
175
 
          grub_usbms_dev_list = usbms;
176
 
 
177
 
          /* XXX: Activate the first configuration.  */
178
 
          grub_usb_set_configuration (usbdev, 1);
179
 
 
180
 
          /* Bulk-Only Mass Storage Reset, after the reset commands
181
 
             will be accepted.  */
182
 
          grub_usbms_reset (usbdev, i);
183
 
 
184
 
          return 0;
185
 
        }
186
 
 
187
 
      return 0;
188
 
    }
189
 
 
190
 
  grub_usb_iterate (usb_iterate);
191
 
}
192
 
 
193
 
 
194
 
 
195
 
static int
196
 
grub_usbms_iterate (int (*hook) (const char *name, int luns))
197
 
{
198
 
  grub_usbms_dev_t p;
199
 
  int cnt = 0;
200
 
 
201
 
  for (p = grub_usbms_dev_list; p; p = p->next)
202
 
    {
203
 
      char *devname;
204
 
      devname = grub_xasprintf ("usb%d", cnt);
205
 
 
206
 
      if (hook (devname, p->luns))
207
 
        {
208
 
          grub_free (devname);
209
 
          return 1;
210
 
        }
211
 
      grub_free (devname);
212
 
      cnt++;
213
 
    }
214
 
 
215
 
  return 0;
216
 
}
217
 
 
218
 
static grub_err_t
219
 
grub_usbms_transfer (struct grub_scsi *scsi, grub_size_t cmdsize, char *cmd,
220
 
                     grub_size_t size, char *buf, int read_write)
221
 
{
222
 
  struct grub_usbms_cbw cbw;
223
 
  grub_usbms_dev_t dev = (grub_usbms_dev_t) scsi->data;
224
 
  struct grub_usbms_csw status;
225
 
  static grub_uint32_t tag = 0;
226
 
  grub_usb_err_t err = GRUB_USB_ERR_NONE;
227
 
  int retrycnt = 3 + 1;
228
 
 
229
 
 retry:
230
 
  retrycnt--;
231
 
  if (retrycnt == 0)
232
 
    return grub_error (GRUB_ERR_IO, "USB Mass Storage stalled");
233
 
 
234
 
  /* Setup the request.  */
235
 
  grub_memset (&cbw, 0, sizeof (cbw));
236
 
  cbw.signature = grub_cpu_to_le32 (0x43425355);
237
 
  cbw.tag = tag++;
238
 
  cbw.transfer_length = grub_cpu_to_le32 (size);
239
 
  cbw.flags = (!read_write) << GRUB_USBMS_DIRECTION_BIT;
240
 
  cbw.lun = scsi->lun << GRUB_SCSI_LUN_SHIFT;
241
 
  cbw.length = cmdsize;
242
 
  grub_memcpy (cbw.cbwcb, cmd, cmdsize);
243
 
 
244
 
  /* Write the request.  */
245
 
  err = grub_usb_bulk_write (dev->dev, dev->out->endp_addr & 15,
246
 
                             sizeof (cbw), (char *) &cbw);
247
 
  if (err)
248
 
    {
249
 
      if (err == GRUB_USB_ERR_STALL)
250
 
        {
251
 
          grub_usb_clear_halt (dev->dev, dev->out->endp_addr);
252
 
          goto retry;
253
 
        }
254
 
      return grub_error (GRUB_ERR_IO, "USB Mass Storage request failed");
255
 
    }
256
 
 
257
 
  /* Read/write the data.  */
258
 
  if (read_write == 0)
259
 
    {
260
 
      err = grub_usb_bulk_read (dev->dev, dev->in->endp_addr & 15, size, buf);
261
 
      grub_dprintf ("usb", "read: %d %d\n", err, GRUB_USB_ERR_STALL);
262
 
      if (err)
263
 
        {
264
 
          if (err == GRUB_USB_ERR_STALL)
265
 
            {
266
 
              grub_usb_clear_halt (dev->dev, dev->in->endp_addr);
267
 
              goto retry;
268
 
            }
269
 
          return grub_error (GRUB_ERR_READ_ERROR,
270
 
                             "can't read from USB Mass Storage device");
271
 
        }
272
 
    }
273
 
  else
274
 
    {
275
 
      err = grub_usb_bulk_write (dev->dev, dev->in->endp_addr & 15, size, buf);
276
 
      grub_dprintf ("usb", "write: %d %d\n", err, GRUB_USB_ERR_STALL);
277
 
      if (err)
278
 
        {
279
 
          if (err == GRUB_USB_ERR_STALL)
280
 
            {
281
 
              grub_usb_clear_halt (dev->dev, dev->out->endp_addr);
282
 
              goto retry;
283
 
            }
284
 
          return grub_error (GRUB_ERR_WRITE_ERROR,
285
 
                             "can't write to USB Mass Storage device");
286
 
        }
287
 
    }
288
 
 
289
 
  /* Read the status.  */
290
 
  err = grub_usb_bulk_read (dev->dev, dev->in->endp_addr & 15,
291
 
                            sizeof (status), (char *) &status);
292
 
  if (err)
293
 
    {
294
 
      if (err == GRUB_USB_ERR_STALL)
295
 
        {
296
 
          grub_usb_clear_halt (dev->dev, dev->in->endp_addr);
297
 
          goto retry;
298
 
        }
299
 
      return grub_error (GRUB_ERR_READ_ERROR,
300
 
                         "can't read status from USB Mass Storage device");
301
 
    }
302
 
 
303
 
  /* XXX: Magic and check this code.  */
304
 
  if (status.status == 2)
305
 
    {
306
 
      /* XXX: Phase error, reset device.  */
307
 
      grub_usbms_reset (dev->dev, dev->interface);
308
 
      grub_usb_clear_halt (dev->dev, dev->in->endp_addr);
309
 
      grub_usb_clear_halt (dev->dev, dev->out->endp_addr);
310
 
 
311
 
      goto retry;
312
 
    }
313
 
 
314
 
  if (status.status)
315
 
    return grub_error (GRUB_ERR_READ_ERROR,
316
 
                       "error communication with USB Mass Storage device");
317
 
 
318
 
  return GRUB_ERR_NONE;
319
 
}
320
 
 
321
 
 
322
 
static grub_err_t
323
 
grub_usbms_read (struct grub_scsi *scsi, grub_size_t cmdsize, char *cmd,
324
 
                 grub_size_t size, char *buf)
325
 
{
326
 
  return grub_usbms_transfer (scsi, cmdsize, cmd, size, buf, 0);
327
 
}
328
 
 
329
 
static grub_err_t
330
 
grub_usbms_write (struct grub_scsi *scsi, grub_size_t cmdsize, char *cmd,
331
 
                  grub_size_t size, char *buf)
332
 
{
333
 
  return grub_usbms_transfer (scsi, cmdsize, cmd, size, buf, 1);
334
 
}
335
 
 
336
 
static grub_err_t
337
 
grub_usbms_open (const char *name, struct grub_scsi *scsi)
338
 
{
339
 
  grub_usbms_dev_t p;
340
 
  int devnum;
341
 
  int i = 0;
342
 
 
343
 
  if (grub_strncmp (name, "usb", 3))
344
 
    return grub_error (GRUB_ERR_UNKNOWN_DEVICE,
345
 
                       "not a USB Mass Storage device");
346
 
 
347
 
  devnum = grub_strtoul (name + 3, NULL, 10);
348
 
  for (p = grub_usbms_dev_list; p; p = p->next)
349
 
    {
350
 
      /* Check if this is the devnumth device.  */
351
 
      if (devnum == i)
352
 
        {
353
 
          scsi->data = p;
354
 
          scsi->name = grub_strdup (name);
355
 
          scsi->luns = p->luns;
356
 
          if (! scsi->name)
357
 
            return grub_errno;
358
 
 
359
 
          return GRUB_ERR_NONE;
360
 
        }
361
 
 
362
 
      i++;
363
 
    }
364
 
 
365
 
  return grub_error (GRUB_ERR_UNKNOWN_DEVICE,
366
 
                     "not a USB Mass Storage device");
367
 
}
368
 
 
369
 
static void
370
 
grub_usbms_close (struct grub_scsi *scsi)
371
 
{
372
 
  grub_free (scsi->name);
373
 
}
374
 
 
375
 
static struct grub_scsi_dev grub_usbms_dev =
376
 
  {
377
 
    .name = "usb",
378
 
    .iterate = grub_usbms_iterate,
379
 
    .open = grub_usbms_open,
380
 
    .close = grub_usbms_close,
381
 
    .read = grub_usbms_read,
382
 
    .write = grub_usbms_write
383
 
  };
384
 
 
385
 
GRUB_MOD_INIT(usbms)
386
 
{
387
 
  grub_usbms_finddevs ();
388
 
  grub_scsi_dev_register (&grub_usbms_dev);
389
 
}
390
 
 
391
 
GRUB_MOD_FINI(usbms)
392
 
{
393
 
  grub_scsi_dev_unregister (&grub_usbms_dev);
394
 
}