iPXE
Data Structures | Macros | Functions
usbblk.h File Reference

USB mass storage driver. More...

#include <stdint.h>
#include <ipxe/usb.h>
#include <ipxe/scsi.h>
#include <ipxe/interface.h>

Go to the source code of this file.

Data Structures

struct  usbblk_command_wrapper
 Command block wrapper. More...
struct  usbblk_status_wrapper
 Command status wrapper. More...
struct  usbblk_command
 A USB mass storage command. More...
struct  usbblk_device
 A USB mass storage device. More...

Macros

#define USB_CLASS_MSC   0x08
 Mass storage class code.
#define USB_SUBCLASS_MSC_SCSI   0x06
 SCSI command set subclass code.
#define USB_PROTOCOL_MSC_BULK   0x50
 Bulk-only transport protocol.
#define USBBLK_RESET
 Mass storage reset command.
#define USBBLK_COMMAND_SIGNATURE   0x43425355UL
 Command block wrapper signature.
#define USBBLK_STATUS_SIGNATURE   0x53425355UL
 Command status wrapper signature.
#define USBBLK_TAG_MAGIC   0x18ae0000
 Command tag magic.
#define USBBLK_MAX_LEN   2048
 Maximum length of USB data block.
#define USBBLK_MAX_FILL   4
 Maximum endpoint fill level.

Functions

 FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
 FILE_SECBOOT (PERMITTED)

Detailed Description

USB mass storage driver.

Definition in file usbblk.h.

Macro Definition Documentation

◆ USB_CLASS_MSC

#define USB_CLASS_MSC   0x08

Mass storage class code.

Definition at line 19 of file usbblk.h.

◆ USB_SUBCLASS_MSC_SCSI

#define USB_SUBCLASS_MSC_SCSI   0x06

SCSI command set subclass code.

Definition at line 22 of file usbblk.h.

◆ USB_PROTOCOL_MSC_BULK

#define USB_PROTOCOL_MSC_BULK   0x50

Bulk-only transport protocol.

Definition at line 25 of file usbblk.h.

◆ USBBLK_RESET

#define USBBLK_RESET
Value:
( USB_DIR_OUT | USB_TYPE_CLASS | USB_RECIP_INTERFACE | \
USB_REQUEST_TYPE ( 255 ) )
USB_DIR_OUT
#define USB_DIR_OUT
Data transfer is from host to device.
Definition usb.h:95
USB_TYPE_CLASS
#define USB_TYPE_CLASS
Class-specific request type.
Definition usb.h:104
USB_RECIP_INTERFACE
#define USB_RECIP_INTERFACE
Request recipient is an interface.
Definition usb.h:116

Mass storage reset command.

Definition at line 28 of file usbblk.h.

28#define USBBLK_RESET ( USB_DIR_OUT | USB_TYPE_CLASS | USB_RECIP_INTERFACE | \
29 USB_REQUEST_TYPE ( 255 ) )

Referenced by usbblk_open().

◆ USBBLK_COMMAND_SIGNATURE

#define USBBLK_COMMAND_SIGNATURE   0x43425355UL

Command block wrapper signature.

Definition at line 50 of file usbblk.h.

Referenced by usbblk_out_command().

◆ USBBLK_STATUS_SIGNATURE

#define USBBLK_STATUS_SIGNATURE   0x53425355UL

Command status wrapper signature.

Definition at line 65 of file usbblk.h.

Referenced by usbblk_in_status().

◆ USBBLK_TAG_MAGIC

#define USBBLK_TAG_MAGIC   0x18ae0000

Command tag magic.

This is a policy decision.

Definition at line 108 of file usbblk.h.

Referenced by usbblk_start().

◆ USBBLK_MAX_LEN

#define USBBLK_MAX_LEN   2048

Maximum length of USB data block.

This is a policy decision.

Definition at line 114 of file usbblk.h.

Referenced by usbblk_in_refill(), usbblk_out_data(), and usbblk_probe().

◆ USBBLK_MAX_FILL

#define USBBLK_MAX_FILL   4

Maximum endpoint fill level.

This is a policy decision.

Definition at line 120 of file usbblk.h.

Referenced by usbblk_out_refill(), and usbblk_probe().

Function Documentation

◆ FILE_LICENCE()

FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL )

◆ FILE_SECBOOT()

FILE_SECBOOT ( PERMITTED )
Generated by doxygen 1.14.0