An1003 usb

AN1003
USB Mass Storage Device Using a PIC® MCU
• Files created using FAT16, FAT32 or NTFS file
Author: Gurinder Singh
format supported (see “References”).
Microchip Technology Inc.
• SD and MMC cards supported (see “References”).
INTRODUCTION • Uses the Windows operating system storage
In recent years, there has been immense growth in driver, usbstor.sys. The Windows Server 2003,
Universal Serial Bus (USB) based applications, Windows XP, Windows 2000 and Windows Me
primarily due to the Plug and Play nature of USB. operating systems provide native support for USB
Mass Storage Class devices. Therefore, MSD is
This application note describes the design and compatible with these operating systems.
implementation of a USB Mass Storage Device (MSD)
using a Secure Digital card, which should prove useful Version 1.0 of the MSD has the following limitations
to developers of USB mass storage solutions. This (later revisions will have additional features):
application may be used as a stand-alone MSD or as a • Does not support the Windows 98 operating
Secure Digital/Multimedia Card (SD/MMC) reader/ system (see Appendix A: “Frequently Asked
writer interface. Questions” for details).
This design consists of the following components: • Does not support the FAT12 file system. In
general, small capacity SD cards (i.e., <= 16 MB)
• USB V2.0 compliant PIC18F4550 microcontroller
can only be formatted in a FAT12 file system.
• PICDEM™ FS USB Demonstration Board
• If the SD card is removed, the USB cable must be
• PICtail™ Board for SD™ and MMC Cards disconnected and reconnected after the card has
• Windows® operating system compatible been reinserted.
(Me, 2000, XP and Windows Server™ 2003)
• The SD card must be present at power-up.
Figure 1 shows the hardware configuration of the
MSD. The PICtail™ Board for SD™ and MMC Cards Note: The implementation and use of the FAT file
(check the Microchip web site for availability) is system, SD card specifications, MMC card
connected into a socket on the PICDEM™ FS USB specifications and other third party tools
Demonstration Board. For additional details, refer to may require a license from various entities,
the PICDEM FS USB Demonstration Board User’s including, but not limited to Microsoft®
Guide (see “References”). Corporation, SD Card Association and
MMCA. It is your responsibility to obtain
The MSD design has the following features:
more information regarding any applicable
• USB V2.0 full-speed compliant. licensing obligations. Some third party web
• No custom drivers required (Windows operating sites have been listed in “References” for
system built-in driver, usbstor.sys, is used). your convenience.

FIGURE 1: MSD HARDWARE CONFIGURATION

© 2005 Microchip Technology Inc. DS01003A-page 1

AN1003
USB Enumeration
A device endpoint is defined in the USB V2.0 Before the applications can communicate with the
specification as “a uniquely addressable portion of USB device, the host needs to learn about the device and
device that is the source or sink of information in a assign a device driver. Enumeration is defined as the
communication flow between the host and device” (see initial exchange of information that accomplishes this.
“References”). The unique address required for each During the enumeration process, the device moves
endpoint consists of an endpoint number (which may through the following device states as defined by the
range from 0 to 15) and direction (IN or OUT). The USB V2.0 specification: Powered, Default, Address
endpoint direction is from the host’s perspective; IN is and Configured. Two other USB device states are:
towards the host and OUT is away from the host. An Attached and Suspend. Exact details of the enumera-
endpoint configured to do control transfers must tion process are beyond the scope of this document;
transfer data in both directions, so a control endpoint however, the commands and structures used in the
actually consists of a pair of IN and OUT endpoints that device configuration are briefly described.
share an endpoint number. All USB devices must have Descriptors are data structures that enable the host to
Endpoint 0 configured as a control endpoint. learn about a device. During enumeration, the host
USB V2.0 supports four types of data transfers: requests descriptors, starting from high-level device
Control, Bulk, Interrupt and Isochronous. descriptors to low-level endpoint descriptors, in the
Control transfer is used to configure a device at the sequence shown in Figure 2. The structure, description
time of plug-in and can be used for other device- and values of device, configuration and interface
specific purposes, including control of other pipes on descriptors are detailed in Appendix C: “USB
the device. Descriptor Formats”. A code example of descriptor
structures is provided in Appendix D: “USB
Bulk data transfers are used when the data is generated Descriptor Structures”. Details of bulk-only endpoint
or consumed in relatively large, bursty quantities. descriptors can be found in Appendix F: “Bulk
Interrupt data transfers are used for timely, but Endpoint Descriptors”.
reliable, delivery of data. For example, characters or
coordinates with human perceptible echo or feedback FIGURE 2: STANDARD USB
response characteristics. DESCRIPTORS
Isochronous data transfers occupy a pre-negotiated
amount of USB bandwidth with pre-negotiated delivery
latency (also called streaming real-time transfers).
Device Descriptor
For any given device configuration, an endpoint sup-
ports only one of the types of transfers described
above. In this application, apart from Endpoint 0, we
configure Endpoint 1 IN and OUT as bulk endpoints.
To meet the needs of various applications using USB, Configuration Descriptor
three speeds of operation have been designed in the
USB V2.0 specification: Low-Speed (LS, 1.5 Mbps),
Full-Speed (FS, 12 Mbps) and High-Speed (HS,
480 Mbps).
Interface Descriptor
See “References” for detailed information on USB,
including references to the USB specification and USB
related publications.
The PIC18F4550 used in this application is USB V2.0
compliant and can support LS and FS data transfers. Endpoint Descriptor
For more information on the PIC18F4550, refer to the
the device data sheet (see “References”).

DS01003A-page 2 © 2005 Microchip Technology Inc.

AN1003
ENUMERATION PROCESS Control Transfer
The following summarizes the steps involved in the Control transfer enables the host and the device to
enumeration of a USB device and explains how the exchange information about device configuration and
device goes from Powered to Default, Address and the other control messages. Control transfers are ensured
Configured state during the enumeration process. to have 10 percent of the bandwidth at Low-Speed and
1. User plugs a USB device into a USB port. The Full-Speed operation and 20 percent at High-Speed
hub provides power to the port and the device is operation. A control transfer consists of a Setup stage,
in the Powered state. an optional Data stage and a Status stage.
2. The hub detects the device. Appendix E: “Standard USB Device Requests”
3. The hub uses an interrupt pipe to report the summarizes the 11 USB standard control transfer
event to the host. requests, along with a description of each request. All
4. Host sends Get_Port_Status request to USB devices must respond to these requests (even
obtain more information about the device. though the response may be just a STALL). Note that
apart from the standard requests, a class may define
5. Hub detects whether device is Low-Speed or
requests for devices in its class. A class-specific
Full-Speed operation and sends the information
request may be required or optional. For example,
to the host in response to Get_Port_Status.
Mass Storage Devices may implement the
6. Host sends a Set_Port_Feature request, Get Max LUN (Logical Unit Number) request that is
asking the hub to reset the port. used by the host to find out the number of logical units
7. Hub resets the device. the device supports. The class-specific requests for
8. Host learns if a Full-Speed device supports the Mass Storage Devices are discussed in “Mass
High-Speed operation (using Chirp K signal). Storage Class”.
9. Host verifies if the device has exited the Reset
state using Get_Port_Status. Mass Storage Class
10. At this point, the device is in the Default state
Bulk transfers are useful for transferring data when
(device is ready to respond to control transfers
time is not a critical factor. Only High-Speed and Full-
over the default pipe at Endpoint 0, default
Speed devices can do bulk transfers. A bulk transfer
address is 00h and the device can draw up to
can send large amounts of data without overloading the
100 mA from the bus).
bus because it waits for the availability of the bus. The
11. Host sends Get_Descriptor to learn the Mass Storage Class supports two transport protocols
maximum packet size (Note: eighth byte of the that determine which transfer type the device and host
device descriptor is bMaxPacketSize). use to send command, data and status information.
12. The host assigns an address by sending a These two types of transport protocols are:
Set_Address request. Device is now in the
• Bulk-Only Transport (BOT)
Address state.
• Control/Bulk/Interrupt (CBI) Transport
13. Host sends Get_Descriptor to learn more
about the device. The host responds by sending BOT is a data transport protocol that uses Bulk
the descriptor followed by all other subordinate transport, whereas CBI transport uses Control transfer,
descriptors. Bulk transport and Interrupt transfer. CBI is further
14. Host assigns and loads a device driver. subdivided into a data transport protocol that uses
Interrupt transfer and one that does not use Interrupt
15. Host’s device driver selects a configuration by
transfer. In this application, BOT is used as the data
sending a Set_Configuration request. The
transport protocol.
device is now in the Configured state.
16. Host assigns drivers for interfaces in composite
devices.
17. If the hub detects an overcurrent, or if the host
requests the hub to remove power, the device
will be unpowered by the USB bus. In this case,
the device and host cannot communicate and
the device is in the Attached state.
18. If the device does not see any activity on the bus
for 3 ms, it goes into the Suspend state. The
device consumes minimal bus power in this
state.


AN1003
The Mass Storage Class specification (see Appendix G: “CBW and CSW” shows the format of a
“References”) defines two class-specific requests, Get CBW packet. In the CBW, the dCBWSignature value,
Max LUN and Mass Storage Reset, that must be “43425355h” (little-endian), identifies a CBW packet.
implemented by a Mass Storage Device. Bulk-Only dCBWTag is the command block tag that is echoed
Mass Storage Reset (bmRequestType = 00100001b back in CSW to associate the CSW with the
and bRequest = 11111111b) is used to reset the corresponding CBW. dCBWDataTransferLength
Mass Storage Device and its associated interface. Get indicates the number of bytes the host expects to trans-
Max LUN (bmRequestType = 10100001b and fer on a Bulk-In or Bulk-Out endpoint (as indicated by
bRequest = 11111110b) request is used to the Direction bit). Only bit 7 of bmCBWFlags is used
determine the number of logical units supported by the to indicate the direction of data flow, with a ‘1’ signifying
device. The value of Max LUN can vary between 0 and Data-In (i.e., from device to host). The field, bCBWLUN,
15 (1-16 logical devices). Note that the LUN starts from specifies the device LUN to which the command block
0. The device may share multiple logical units that is being sent. The field, bCBWCB, defines the valid
share the common device characteristics. The host length of the command block. The CBWCB is the
should not send the Command Block Wrapper (CBW) command block to be executed by the device.
to a non-existing LUN. The size of a CSW is 13 bytes in length. A
The interface descriptor fields for configuring an dCSWSignature value of “54425355h” (little-endian)
interface as a Mass Storage Device implementing the identifies a CSW packet. The field, dCSWTag, echoes
BOT are shown in Appendix C: “USB Descriptor the dCSWTag value from the associated CBW. For
Formats”. Note that bInterfaceClass = 08h Data-Out, dCSWDataResidue is the difference
implies Mass Storage Class. Subclass code, between the data expected and the actual amount of
bInterfaceSubClass = 06h, indicates that SCSI data processed by the device. For Data-In, it is the dif-
Primary Command-2 (SPC-2) definitions (see “Ref- ference between the data expected and the actual
erences”) are supported by the device and the amount of relevant data sent by the device. The value
bInterfaceProtocol = 50h indicates the BOT of dCSWDataResidue is always less than or equal to
implementation. the value of dCBWDataTransferLength. The value
A device implementing BOT shall support at least three of bCSWStatus indicates the success or failure of the
endpoints: Control, Bulk-In and Bulk-Out. The USB command. The bCSWStatus value of 00h indicates
V2.0 specification defines a control endpoint command success, 01h indicates command failure,
(Endpoint 0) as the default endpoint that does not whereas 02h indicates phase error.
require a descriptor. The Bulk-In endpoint is used for
transferring data and status from the device to the host, FIGURE 3: COMMAND/DATA/STATUS
and the Bulk-Out endpoint is used for transferring FLOW IN BULK-ONLY
commands and data from the host to the device. The TRANSPORT
endpoint descriptor values for configuring a Bulk-In and
Bulk-Out endpoint are shown in Appendix F: “Bulk
Ready
Endpoint Descriptors”.

Bulk-Only Transport (BOT)
Command
Like Control transfer, BOT also consists of a Command Transport
stage, an optional Data stage and a Status stage. The (CBW)
Data stage may or may not be present for all command
requests. Figure 3 shows the flow of Command trans-
port, Data-In, Data-Out and Status transport for BOT.
The CBW is a short packet of exactly 31 bytes in length.
Data-Out Data-In
The CBW and all subsequent data and Command Sta-
(from host) (to host)
tus Wrapper (CSW) start on a new packet boundary. It
is important to note that all CBW transfers are ordered
little-endian with LSB (byte 0) first.

Status
Transport
(CSW)


AN1003
Secure Digital (SD) Card COMMUNICATION OVERVIEW
A Secure Digital card is the most common storage This section provides a general overview of the com-
media used in portable devices, such as PDAs, Digital munication between the SD card and the Personal
Cameras and MP3 Players, among others. SD cards Computer (PC) application and system hardware.
can be purchased with storage sizes ranging from
Figure 4 shows the functional block diagram of the
16 MB to 2 GB. Both SD cards and the MMC support
entire system. A device driver is defined as “any code
the SPI™ transfer protocol and have an almost identi-
that handles communication details for a hardware
cal electrical interface. While the form factor and the
device that interfaces to a CPU”. In the layered driver
shape of the SD card and the MMC are identical, SD
model used in USB communications, each layer
cards can be operated up to four times faster, have a
handles one part of the communication process. In this
write-protect switch and may include cryptographic
application, the MSD is enumerated as a Mass Storage
security for protection of copyrighted data. Due to these
Device implementing BOT. Therefore, the host uses
features, SD cards are more popular than MMC and
the USB storage device driver (usbstor.sys) as the
are the focus of this design. However, MMC have been
functional driver. The host loads Disk.sys,
tested and found to be fully functional with the MSD
PartMgr.sys and VolSnap.sys as filter drivers to
design.
communicate between the end application and the
The SD card can be operated in SD Bus mode or SPI device driver (usbstor.sys). The root hub driver
mode. In this application, the SD card is connected to (usbhub.sys) manages the port initialization and, in
the Serial Peripheral Interface (SPI) bus of the general, manages the communications between
PIC18F4550 and operated in the SPI mode. In the SPI device drivers and the bus class driver. The bus class
mode, only one data line is used for data transmission driver (usbd.sys) manages bus power, enumeration,
in each direction. The data transfer rate in this mode is USB transactions and communications between the
therefore the same as the SD Bus mode with one data root hub driver and the host controller driver.
line (up to 25 Kbits per second).
On the MSD application side, the Serial Interface
Apart from the Power and Ground, the SPI bus consists Engine (SIE) of the PIC18F4550 handles the low-level
of Chip Select (CS), Serial Data Input (SDI), Serial Data USB communications. USB data moves between the
Output (SDO) and Serial Clock (SCLK) signals. The SD microcontroller core and the SIE through a memory
card and MMC sample data input on the rising clock space known as the USB RAM. The PIC18F4550
edge and set data output on the falling clock edge. On provides the capability to configure and control up to
power-up, an SD card wakes up in the SD Bus mode. 16 bidirectional endpoints. In this application, two
Therefore, an initialization routine is required to operate bidirectional endpoints are used. Endpoint 0 is required
the SD card in SPI mode. This can be achieved by for all USB devices for control transfers and does not
asserting the CS signal (logic low) during the reception require configuration. The mass storage application
of the Reset command, CMD0. Unlike the SD Bus configures Endpoint 1 IN and OUT as bulk endpoints
mode, in SPI mode, the selected card always responds for Bulk-Only Transport. It also communicates with the
to the command. In case of a data retrieval problem, SD card’s SPI bus to read the data from and write the
the card responds with an error response instead of a data to the SD card.
time-out as in the SD Bus mode. See “References” for
information on the SD card specification.


AN1003
Hardware number of external components and enable a low-cost
design. On a side note, the PICDEM FS USB
The PICDEM FS USB Demonstration Board is used as Demonstration Board also features a potentiometer,
the platform for developing the USB MSD application. simulating analog input for the controller and a digital
The PICtail™ Board for SD™ and MMC Cards is temperature sensor. While not being used in the USB
connected on the expansion headers, J6 and J7, on the SD card mass storage application, these features may
PICDEM FS USB Demonstration Board. The USB V2.0 be useful in developing other USB applications. More
compliant PIC18F4550 microcontroller forms the heart details of the PICDEM FS USB Demonstration Board
of the PICDEM FS USB Demonstration Board. The can be found in the PICDEM FS USB Demonstration
PIC18F4550 has an on-chip USB voltage regulator, Board User’s Guide (see “References”).
transceivers and pull-up resistors to minimize the

FIGURE 4: PC, MSD COMMUNICATION BLOCK DIAGRAM

PC Application
(e.g., file explorer)
PICtail™ Board for
® SD™ and MMC Cards
Win32 API Calls

Win32 Subsystem SPI™
Bus
PIC18F4550
Disk Drivers
(disk.sys, SD Card Interface
PartMgr.sys) Function (sdcard.c, sdcard.h)
Drivers
Storage Volume (usbstor.sys)
Driver USB Endpoint 0
(VolSnap.sys) Control
USB Endpoint 1
Transfer
(usbdrv.c, Bulk Transfer
USB Hub Driver (usbhub.sys) usb9.c, (msd.c, msd.h)
usbctrltrf.c)

Bus Drivers (usbd.sys)
USB Serial Interface Engine (SIE)

Hardware (Root Hub)
USB Port

EP0 USB Control, EP1 SCSI Commands


AN1003
The SD card operates in the 2.7-3.6V range, whereas the SCSI Commands
PIC18F4550 on the PICDEM FS USB Demonstration
Board requires a 5V VDD. The voltage regulation from 5V After the successful enumeration of the target USB
to 3V is achieved using Microchip’s TC1186-3.3VCT713. device, the host initiates commands according to the
Appendix J: “Schematic” shows the schematic for the bInterfaceSubClass specified in the interface
PICtail™ Board for SD™ and MMC Cards (Part No. descriptor during the enumeration process.
AC164122). Pin 7 (RA5) of the PIC18F4550 is connected The USB MSD application specifies bInterface-
to the SHDN (Shutdown input) pin of the TC1186 via SubClass = 06h, indicating that the device will support
jumper JP4 (position 2-3). This enables the user to turn SCSI Primary Commands-2 (SPC-2) or later. A
off the SD card power using firmware (setting RA5 turns bInterfaceProtocol value of 0x50 in the interface
the power on). Alternately, by changing the jumper JP4 descriptor indicates that the BOT protocol is being
setting (position 1-2), the user may turn the SD card used. As shown in Figure 3, a BOT transfer begins with
power on permanently. The PICtail™ Board for SD™ a CBW. The device indicates the successful transport
and MMC Cards also implements two MC74VHCT125A of a CBW by accepting (ACKing) the CBW. If the host
devices as signal level translators for translating 5V DC detects a STALL of the Bulk-Out endpoint during Com-
signals on the microcontroller side to 3.3V DC signals on mand transport, the host shall respond with a Reset
the SD card side and vice versa. The MC74VHCT125A recovery. The host shall attempt to transfer an exact
is a high-speed CMOS quad buffer fabricated with silicon number of bytes to or from the device as specified by
gate CMOS technology. Since it has a full 5.0V CMOS the dCBWDataTransferLength and the Direction
level output swing, this device is ideal for signal level bit. The device shall send each CSW to the host via the
translation between 3.0V and 5.0V levels. For 5V to 3.3V Bulk-In endpoint.
signal translation, a supply voltage of 3.3V is applied to
In this section, we briefly describe the SCSI commands
U1 and corresponding OE pins are enabled (active-low).
that are supported in the MSD implementation. The
Similarly, 3.3V to 5V translation is achieved by applying a
reader may refer to SCSI Primary Commands-3 (SPC-3)
5V supply to U2 and enabling the corresponding OE
and SCSI Block Commands-2 (SBC-2) specifications for
pins. Further details on the MC74VHCT125A can be
further details (see “References”). The first byte of the
found in its respective data sheet (see “References”).
command block, CBWCB, is always the operation code or
Note: The user application may not require the opcode in short.
signal translation if the PIC microcontroller • INQUIRY (Opcode 12h)
is operated at 3V.
The INQUIRY command requests that the informa-
The PICtail™ Board for SD™ and MMC Cards also tion regarding the logical unit and SCSI target device
features a power LED (D1), an SD card activity LED be sent to the application client (host). The SPC-3
(D2) and test points for monitoring the SPI bus. LED D1 specification requires that the INQUIRY data should
indicates that power is available at the output of the be returned even though the device server is not
TC1186. LED D2 indicates SD card activity (based on ready for other commands. Moreover, the standard
Chip Select signal, CS). The Serial Data Input (SDI), INQUIRY data should be available without incurring
Serial Clock (SCK), Serial Data Output (SDO), Chip any media access delays. The standard INQUIRY
Select (CS) and Ground (GND) signals of the SPI bus data is at least 36 bytes.
can be monitored on the test points. The PICtail™
• READ CAPACITY (Opcode 25h)
Board for SD™ and MMC Cards is designed to operate
with a multitude of demonstration boards, including all The READ CAPACITY command requests that the
demonstration boards having PICtail signals, Explorer device server transfer bytes of parameter data
16 development board having card edge connectors describing the capacity and medium format to the
and demonstration boards with non-standard PICtail Data-In buffer. The response to the READ CAPACITY
signals. The following jumper settings must be used for command is 4 bytes of returned Logical Block
operating the PICtail™ Board for SD™ and MMC Address and 4 bytes of block length in bytes.
Cards with different demonstration boards. Returned Logical Block Address (LBA) is the
LBA of the last logical block on the direct access
1. If the demonstration board has standard PICtail
block device. If the number of logical blocks exceeds
signals, connect JP1-JP2 and JP5 on the PICtail
the maximum value that can be specified in the
side (default setting).
returned Logical Block Address field, the
2. If the demonstration board provides card edge device shall set the returned Logical Block
signals, connect JP2-JP3 and JP5 on the card Address field to FFFFFFFFh.
edge side.
3. If the demonstration board does not provide
standard PICtail signals, open J3, jump signals
from J5 and J11 to appropriate signals on J2.


AN1003
• READ (10) (Opcode 28h) • MODE SENSE (6) (Opcode 1Ah)
The READ (10) command specifies that the device The MODE SENSE (6) command provides a means
server read the specified logical block(s) and transfer for a device server to report parameters to an appli-
them to the Data-In buffer. The READ (10) com- cation client. It is a complementary command to the
mand is a 10-byte CBWCB with the eighth and ninth MODE SELECT (6) command. The mode parameter
bytes specifying the TRANSFER LENGTH (see header that is used by the MODE SENSE (6) and the
Appendix I: “SCSI Command and Data Format”). MODE SELECT (6) command is shown in Appen-
The TRANSFER LENGTH field specifies the number dix H: “SCSI Command Set”. The MEDIUM TYPE
of contiguous logical blocks of data that shall be read and DEVICE SPECIFIC PARAMETER fields are
and transferred to the Data-In buffer, starting with the unique for each device type. In this application, the
logical block specified by the Logical Block MEDIUM TYPE field is set to 00h, indicating a direct
Address field (bytes 3-6). A TRANSFER LENGTH access block device. This value is the same as the
field set to zero specifies that no logical blocks shall value of the PERIPHERAL DEVICE TYPE field in the
be read. standard INQUIRY data.
• WRITE (10) (Opcode 2Ah) • PREVENT ALLOW MEDIUM REMOVAL
The WRITE (10) command requests that the device (Opcode 1Eh)
server transfer the specified logical blocks from the The PREVENT ALLOW MEDIUM REMOVAL command
Data-Out buffer and write them. The CBWCB format requests that the logical unit enable or disable the
for the WRITE (10) command is the same as the removal of the medium. The prevention of medium
READ (10) command with TRANSFER LENGTH removal shall begin when an application client issues
specifying the number of contiguous logical blocks of a PREVENT ALLOW MEDIUM REMOVAL command
data that shall be transferred from the Data-Out with a PREVENT field (fifth byte, bits 0-1 of CBWCB) of
buffer and written, starting with the logical block 01b or 11b (i.e., medium removal prevented). Since
specified by the Logical Block Address field. A in an SD card, there is no way to prevent card
TRANSFER LENGTH field set to zero specifies that no removal, the firmware decodes the command and
logical blocks shall be written. prepares to notify the host PC that the operation has
• REQUEST SENSE (6) (Opcode 03h) been successfully completed. If the medium is inac-
cessible, the command is specified as Fail
The REQUEST SENSE (6) command requests that (bCSWStatus = 0x01) with the SENSE KEY set to
the device server transfer the sense data to the Not Ready.
application client. Appendix H: “SCSI Command
Set” shows the fixed format sense data response. • TEST UNIT READY (Opcode 00h)
The contents of the RESPONSE CODE field indicate The TEST UNIT READY command provides a means
the error type and format of the sense data. The to check if the logical unit is ready. This is not a request
RESPONSE CODE 70h signifies the current error, for self-check. If the logical unit is able to accept an
RESPONSE CODE 71h signifies the deferred error in appropriate medium access command, without return-
the fixed format sense data and code values, 72h ing a Check Condition status, this command shall
and 73h, indicate the current and deferred error code return a Good status. Otherwise, the command is
in the descriptor format sense data. The SENSE terminated with the Check Condition status and the
KEY, ADDITIONAL SENSE CODE (ASC) and SENSE KEY is set to reflect the error condition.
ADDITIONAL SENSE CODE QUALIFIER (ASCQ) • VERIFY (10) (Opcode 2Fh)
fields provide a hierarchy of information. The SENSE
KEY field indicates the generic information describing The VERIFY (10) command requests that the
an error or exception condition, ASC indicates further device server verify the specified logical block(s) on
information related to the error reported in the SENSE the medium. If the BYTCHK bit is set to ‘0’, the device
KEY field, whereas the ASCQ field indicates the shall perform medium verification with no data com-
detailed information related to the ADDITIONAL parison and not transfer any data from the Data-Out
SENSE CODE. Refer to Table 27 and Table 28 of the buffer. If the BYTCHK bit is set to ‘1’, the device server
SPC-3 specification (see “References”) for a list of shall perform a byte-by-byte comparison of user data
SENSE KEY error codes and ASC and ASCQ error read from the medium and user data transferred from
code assignments. This application implements the the Data-Out buffer. The firmware decodes the
fixed format, current error code sense data response command and then prepares to notify the host PC
(defined in ~systemusbclassmsdmsd.h). that the command has been successfully completed.
If the medium is inaccessible, the command is
specified as Fail, with the SENSE KEY set to Not
Ready.


AN1003
• START/STOP (Opcode 1Bh) Using the PICtail™ Board for SD™ and
The START/STOP command requests that the MMC Cards
device server change the power condition of the log-
First, connect the demonstration board to the MPLAB®
ical unit, or load, or eject the medium. This includes
ICD 2 and program the device. The following steps are
specifying that the device server enable or disable
required to run the MSD application:
the direct access block device for medium access
operations by controlling power conditions and tim- 1. Connect the PICtail™ Board for SD™ and MMC
ers. The POWER CONDITION field (fifth byte, bit 7-4) Cards to the PICDEM FS USB Demonstration
is used to specify that the logical unit be placed into Board as shown in Figure 1.
a power condition or to adjust a timer. If the value of 2. Insert the SD card in the reader slot, making
this field is not equal to 0h, the START (fifth byte, sure that write-protect is disabled on the SD
bit 0) and LOEJ (Load Eject, fifth byte, bit 1) bits are card.
ignored. If the POWER CONDITION field is Active 3. Apply power to the demonstration board.
(1h), Idle (2h) or Standby (3h), then the logical unit
4. Observe the LEDs (D1, D2, D3 and D4) on the
shall transition to the specified power. If POWER
demonstration board. If all of the LEDs are ON,
CONDITION = 0h (START_VALID), then the START,
this indicates an SD card initialization failure.
LOEJ = (0,0) signifies that the logical unit shall
transition to the stopped power condition; START, 5. If no errors have occurred, connect a USB cable
LOEJ = (0,1) signifies the logical unit shall unload from the PC to the USB connector on the
the medium; START, LOEJ = (1,0) signifies that demonstration board.
the logical unit shall transition to the active power 6. Observe under Control Panel > System >
condition. If START, LOEJ = (1,1), then the Hardware > Device Manager (for Windows XP
logical unit shall load the medium. system) that USB Mass Storage Device gets
enumerated under Universal Serial Bus
UNSUPPORTED COMMANDS controllers. Verify that the Microchp Mass
Storage USB Device is enumerated under Disk
If the command opcode field in the CBWCB is not
drive and Generic volume is enumerated
supported, the SENSE KEY is set to Illegal Request,
under Storage volumes, as shown in Figure 5.
indicating that there was an illegal parameter in the
CDB with ASC and ACSQ codes set corresponding to an 7. Look for a removable drive under My
invalid command opcode. Computer.
8. Use the removable drive icon to access the SD
card as a MSD.
MASS STORAGE DEVICE (MSD)
9. Before removing the USB cable from the demo
FIRMWARE board, click the “Safely Remove Hardware”
This firmware implements a USB-based Mass Storage icon in the Windows task bar.
Device using an SD card. When plugged into the USB The four LEDs on the PICDEM FS USB Demonstration
port, the firmware enumerates the SD card as a remov- Board have been implemented as follows:
able disk drive and allows the user to exercise all
1. LED D1 turns ON after successfully responding
standard features of a disk drive. The user can write,
to the INQUIRY command.
read, edit and delete files on the MSD just like any other
removable disk media. This application also allows the 2. LED D2 toggles ON after each successful TEST
user to format the SD card in any of the following FAT file UNIT READY command execution.
formats: FAT16, FAT32 or NTFS (Windows drivers han- 3. LED D3 blinks during read operation (turns ON
dle the format, firmware is only required to implement while a read from the SD card is taking place).
the SCSI commands). The firmware calculates the 4. LED D4 blinks during write operation (turns ON
capacity of the SD card based on the Card Specific Data while a write to the SD card is taking place).
(CSD) register read from the SD card. This information
is conveyed to the PC host in response to the READ
CAPACITY command. The exact size of the disk can be
seen in the disk properties on the PC. Further details on
firmware and SCSI command implementation can be
found in “SCSI Commands”.
The project framework is organized under a single root
directory with each subdirectory containing files for
each category or class of source code. If the SD card is
not found, or not initialized, the 4 LEDs (D1, D2, D3 and
D4) on the demonstration board are turned on
permanently.


AN1003
FIGURE 5: DEVICE MANAGER Directory Structure
The file structure consists of a collection of sub-
directories containing specific files under a root project
directory. The user may create the root project directory
in any location with a valid directory name. The subdi-
rectories structure should always be maintained. The
basic directory structure is similar to the PICDEM FS
USB demonstration code. This backward compatibility
has been maintained to ensure that users already
familiar with PICDEM FS USB demonstration code can
easily integrate this mass storage application.
Figure 6 shows the directory structure for the MSD
application.

Function Description
Table 1 and Table 2 provide brief descriptions of the
functions contained in files msd.c and sdcard.c,
respectively.

FIGURE 6: MSD DIRECTORY
STRUCTURE


AN1003
TABLE 1: msd.c FUNCTIONS
Function Name Description
USBCheckMSDRequest Handles the class-specific requests received on Endpoint 0.
ProcessIO() Handles MSD requests on Endpoint 1.
MSDInitEP Initializes Bulk-In and Bulk-Out endpoints (MSD_BD_IN, MSD_BD_OUT).
SDCardInit Initializes the SD card in SPI™ mode.
MSDCommandHandler Decodes and processes the received SCSI command.
MSDInquiryHandler Executes the INQUIRY command.
MSDReadCapacityHandler Executes the READ CAPACITY command.
MSDReadHandler Executes the READ (10) command.
MSDWriteHandler Executes the WRITE (10) command.
MSDModeSenseHandler Executes the MODE SENSE (6) command.
MSDMediumRemovalHandler Executes the PREVENT ALLOW MEDIUM REMOVAL command.
MSDRequestSenseHandler Executes the REQUEST SENSE (6) command.
MSDTestUnitReadyHandler Executes the TEST UNIT READY command.
MSDVerifyHandler Executes the VERIFY (10) command.
MSDStopStartHandler Executes the START/STOP command.
IsMeaningfulCBW Checks if the received CBW is meaningful.
IsValidCBW Checks if the received CBW is valid.
PrepareCSWData Prepares CSW data (Tag and Signature).
SendData(byte* Y, byte X) Sends X bytes of data starting at location Y.
SendCSW Sends the CSW and sets MSD_State to MSD_WAIT.
ResetSenseData Initializes the sense response data.
MSDDataIn Sends data to the host.
MSDDataOut Reads data from the host.

TABLE 2: sdcard.c FUNCTIONS
Function Description
SDC_Error MediaInitialize(SDCSTATE*) Initializes the SD card in SPI™ mode and reads its first
sector.
SocketInitialize Initializes card select, detect signals and socket
interface.
SDC_Error SectorRead(dword SN, byte* buff) Reads the specified sector SN into buffer
(msd_buffer).
SDC_Error SectorWrite(dword SN, byte* buff) Writes the data pointed to by buffer into sector SN.
SDC_Error CSDRead Reads the CSD register from SD card.
MediaDetect Returns True if SD card is detected.
SDC_Response SendSDCCmd(byte, dword) Sends SDC command packet on SPI interface.
ReadMedia Reads in one byte of data from SPI port while sending
out 0xFF to SD card.


AN1003
Memory Organization FIGURE 7: COMPLETE MEMORY
ORGANIZATION (INCLUDING
Data banks 4 through 7 of the data memory are
ENDPOINT BUFFERS)
mapped to special dual port RAM (see Example 2).
When the USB module is disabled, the General 00h
Access RAM
Purpose Registers (GPRs) in these banks are used like 5Fh
any other GPRs in the data memory space. When the 60h
GPR0
FFh
USB module is enabled, the memory in these banks is 100h
allocated as buffer RAM for USB operation. This area
GPR1
is shared between the microcontroller core and the SIE
1FFh
and is used to transfer data directly between the two.
200h
Note that the linker script has been modified to define
GPR2
MSD as a single data bank of 512 bytes. The 512-byte
msd_buffer has been defined in the MSD data bank 2FFh
300h
(see Example 1). Figure 7 shows the entire memory
map including the endpoint buffers. GPR3
3FFh
EXAMPLE 1: BUFFERS FOR MSD ep0Bo 400h
(usbmmap.c) (Endpoint 0,
BD Out)
#if defined(USB_USE_MSD) ep0Bi
volatile far USB_MSD_CBW msd_cbw; (Endpoint 0,
volatile far USB_MSD_CSW msd_csw; BD In)
#pragma udata myMSD=0x600
volatile far char msd_buffer[512]; •
#endif
•
•
ep15Bo
(Endpoint 15,
BD Out)
ep15Bi
(Endpoint 15,
BD In) 5FFh
msd_buffer 600h
[0]
•
•
•
[511]
7FFh

* The ep<n>Bo and ep<n>Bi actually declared are
dependant on the number of endpoints used in the
application.

EXAMPLE 2: MODIFIED LINKER SCRIPT
ACCESSBANK NAME=accessram START=0x0 END=0x5F
DATABANK NAME=gpr0 START=0x60 END=0xFF
DATABANK NAME=gpr1 START=0x100 END=0x1FF
DATABANK NAME=usb4 START=0x400 END=0x4FF PROTECTED
DATABANK NAME=usb5 START=0x500 END=0x5FF PROTECTED

// Combine usb6 and usb7 banks to define a 512 byte msd bank .......... ..............
//DATABANK NAME=usb6 START=0x600 END=0x6FF PROTECTED
//DATABANK NAME=usb7 START=0x700 END=0x7FF PROTECTED

DATABANK NAME=msd START=0x600 END=0x7FF PROTECTED


AN1003
Firmware Description USBCheckStdRequest() cannot process the
requests, it calls USBCheckMSDRequest().
Figure 8 shows the relationship between various files in USBCheckMSDRequest() checks if it is a class-specific
this firmware. The details of the USB framework files request (SetupPkt.RequestType == CLASS) and
can be found in the user’s guide for the PICDEM FS SetupPkt.bRequest == FFh (Bulk-Only Mass Storage
USB Demonstration Board. This application note Reset) or FEh (Get Max LUN). If a Bulk-Only Mass
focuses on the USB mass storage application and Storage Reset request is received, the firmware disables
communication with the SD card. Endpoint 1, clears the STALL and reinitializes Endpoint
A USB request can be either standard or class-specific. 1. The response to the Get Max LUN request is one byte
A standard request is serviced by the that consists of the maximum LUN supported by the
USBCheckStdRequest() which handles the standard device. For example, if the device supports three LUNs,
requests as specified in Chapter 9 of the USB V2.0 spec- then the LUNs would be numbered from 0 to 2 and the
ification. A Mass Storage Class specific request is han- return value would be ‘2’. In our case, the number of
dled by the firmware in msd.c. If the LUNs is 1, so the return value is ‘0’.

FIGURE 8: RELATIONSHIP BETWEEN USB FRAMEWORK DEMONSTRATION FILES AND THE
MSD APPLICATION

main.c usbdrv.c
Initialize usbdsc.c
USBDriverService()
System() VID and PID,
while(1) Descriptor Strings
{
}
usbctrltrf.c usb9.c
USBCtrlEPService() USBCheckStdRequest()

USBStdSetCfgHandler()

msd.c
MSDInitEP()
USBCheckMSDRequest() sdcard.c
SDCardInit() SocketInitialize()
ProcessIO() MediaInitialize()

MSDCommandHandler()

MSDReadHandler() SectorRead()

MSDWriteHandler() SectorWrite()

MSDReadCapacityHandler() CSDRead()

usbcfg.c Data Memory

USB Configuration
usbmmap.c

USB RAM Mapping


AN1003
The USB enumeration process is handled mainly in buffer), then MSD_IN_EP_SIZE bytes of data are sent;
usb9.c. The SET_CONFIGURATION request is han- otherwise, the remaining dCSWDataResidue bytes of
dled by USBStdSetCfgHandler(). This function data are sent using the MSD_BD_IN buffer.
calls the function, MSDInitEP(). The function, Note that the only command where data needs to be
MSDInitEP(), configures and initializes a Bulk-In and read from the host is the WRITE (10) command. In the
a Bulk-Out endpoint. MSD_WAIT state, the MSD_BD_OUT points to the
The main() function in file main.c is an infinite loop msd_cbw structure in order to read the next command
that services different tasks – USB or mass storage block. But when a WRITE (10) command is received,
application tasks. USB tasks are handled by the device changes to MSD_DATA_OUT. In this state,
USBDriverService() which handles all USB the device must read more data from the host and write
hardware interrupts. The mass storage application it to the SD card. This is done using the 512-byte
tasks are handled by ProcessIO(). ProcessIO() msd_buffer. So, in the MSD_DATA_OUT state, the
forms the core of the handling of mass storage MSD_BD_OUT (Endpoint 1 OUT) buffer points to
communications on Endpoint 1. Figure 9 shows the msd_buffer. In order to read the entire 512-byte data
flowchart of the ProcessIO(). block, after every read, the MSD_BD_OUT points to a
When Endpoint 1 is initialized, the MSD_State is set to location in the msd_buffer incremented by
MSD_WAIT. The firmware basically waits for a CBW to MSD_OUT_EP_SIZE (size of the Endpoint 1 OUT
be received on Endpoint 1. Upon receiving a valid and buffer). Once the msd_buffer is filled (8 reads of
meaningful CBW (as defined in the USB Mass Storage 64 bytes), the block of data is written to a specific loca-
Class Bulk-Only Transport specification, see tion in the SD card using the SECTORwrite(...)
“References”), the CSW data is prepared. Basically, function (defined in sdcard.c). This process is
the dCBWTag is copied to dCSWTag in order to repeated if multiple blocks of data are to be written to
associate the CSW with the corresponding CBW and the SD card. The LBA field of the WRITE (10) CBWCB
the dCSWSignature field is set to “53425355h” (little- gives the information about the starting LBA and the
endian). The Direction bit is read to find the direction TRANSFER LENGTH field indicates the number of
of data transfer (i.e., from host to device or vice versa) contiguous LBAs to be written.
and sets MSD_State to MSD_DATA_OUT or
MSD_DATA_IN, respectively (see Figure 10). Further, EXAMPLE 3: STRUCTURE FOR COMMAND
the first byte of CBWCB is the operation code of the BLOCK WRAPPER
received command. This is used to decode the typedef struct _USB_MSD_CBW
command and take the appropriate action {
(MSDCommandHandler). It may happen that the dword dCBWSignature;
command does not require any data transfer. The dword dCBWTag;
Direction bit is ‘0’ in this case and the MSD_State dword dCBWDataTransferLength;
is set to MSD_DATA_OUT. If there is no data transfer byte bCBWFlags;
required for a given command, the command is byte bCBWLUN;
byte bCBWCBLength;
executed and the status is sent using sendCSW(). The
byte CBWCB[16];
values of the dDataResidue and bCSWStatus fields } USB_MSD_CBW;
are set based on the result of the command execution.
Figure 11 shows the flowchart of the MSDDataIn() Out endpoint size is configured as 64 bytes. The
function. This function is used to send the data msd_buffer is a 512-byte buffer declared in the USB
prepared while processing the command in dual port RAM area. The block size of the SD card is
MSDCommandHandler(), from the device to the host, 512 bytes. The msd_buffer is used to read 512 bytes
using MSD_BD_IN. After command execution, from the host using multiple 64-byte reads from
dCSWDataResidue reflects the number of bytes of MSD_BD_OUT. Once 512 bytes of data are read from the
data obtained as a result of the command execution host (msd_buffer is filled), the entire block of data is
that are to be sent to the host. In case of an error written to the SD card using the function,
(bCSWStatus! = 0x00), zero padded data of the size SECTORWrite(). For WRITE (10) commands where
expected by the host (dCBWDataTransferLength) is the TRANSFER LENGTH > 1, multiple blocks of 512 bytes
sent. If there is no error, the size of data to be sent of data are written to consecutive sectors, starting with
(dCSWDataResidue), as a result of command execu- the Logical Block Address field in the command
tion, may not be the same as the size expected by the block. The translation between LBA and the physical
host (dCBWDataTransferLength). In this case, the address is as follows: since each sector has
dCSWDataResidue field in the CSW will reflect the dif- 29 = 512 bytes, the physical address is obtained by left
ference. If the data to be sent is greater than shifting the LBA by 9 positions. Similarly, for READ (10),
MSD_IN_EP_SIZE (64 bytes, size of the Endpoint 1 IN a block of 512 bytes of data is read from the SD card
using the function, SECTORread(), and then transmit-
ted to the host in 64-byte packets using the MSD_BD_IN


AN1003
buffer. Note that after each read or write from the An 8-byte response indicating the total number of LBAs
MSD_BD_OUT or MSD_BD_IN, mUSBDriverService() and the block length in bytes is expected for the READ
is called to clear the TRNIF bit. CAPACITY command. To obtain this information, we
The macro, mUSBBufferReady(MSD_BD_IN) or read the Card Specific Data (CSD) from the SD card by
mUSBBufferReady(MSD_BD_OUT), is called to write or calling the CSDread(...) function (defined in
read the data from the corresponding Buffer Descriptor sdcard.c). The CSDread function issues the SPI
(BD) register. This call should be made after command, CSD_READ, to the SD card and reads the
arming the corresponding BD registers. The response in the global variable, gblCSDReg. The card
mUSBBufferReady(...) macros toggle the Data capacity (not including the security protected area) can
Toggle Sync (DTS) bit and give the buffer ownership to be computed from the C_SIZE, C_SIZE_MULT and
SIE. READ_BL_LEN fields from the CSD register.
The firmware only supports the fixed format response Memory capacity = BLOCKNR * BLOCK_LEN,
to the INQUIRY command. According to the specifica- where BLOCKNR = (C_SIZE + 1) * MULT and
tions, a media access delay must not be incurred in MULT = 2C_SIZE_MULT + 2.
responding to the INQUIRY command. The INQUIRY The block length (BLOCK_LEN) can be computed
data format and the values stored in ROM for this appli- using:
cation are shown in Appendix H: “SCSI Command
Set”. The standard INQUIRY data is at least 36 bytes, • READ_BL_LEN = WRITE_BL_LEN
but can be up to 96 bytes, excluding the vendor- • BLOCK_LEN = 2READ_BL_LEN
specific parameters as described in the SPC-3
specification.

FIGURE 9: ProcessIO() FLOWCHART

Start

Is
MSD_State == Yes Yes Send Status
All data sent?
MSD_DATA_IN? sendCSW()

No
No Send Data
MSDDataIn()

Is
MSD_State == Yes Yes Send Status
All data read?(1)
MSD_DATA_OUT? sendCSW()

No

Is CBW received? To
Yes Yes
MSD_State == (MSD_BD_OUT.Stat Command
MSD_WAIT? .UOWN == _UCPU) Transport

No

Return

Note 1: The MSD_DATA_OUT state is required only for the WRITE (10) command. Due to limited buffer space, all the data
is read from MSD_BD_OUT and written to the SD card in MSDWriteHandler(). This part of the code is reached when
all of the data has been read.


AN1003
FIGURE 10: COMMAND TRANSPORT FLOWCHART

Command

Copy the CBW to
gblCBW

No
Is CBW valid?

Yes

Is CBW No
meaningful?

Yes

Prepare CSW
dCSWTag,
dCSWSignature

No
Is Direction bit = 1? Set MSD_State = MSD_DATA_OUT

Yes
Set MSD_State = MSD_DATA_IN

Decode and Process the
Received CBWCB
MSDCommandHandler()

USBBufferReady(MSD_BD_OUT)

USBDriverService()

Return


AN1003
FIGURE 11: MSDDataIn() (BULK-IN TRANSPORT) FLOWCHART

MSDDataIn()

Is
dCSWStatus = 0x00
Yes
and remaining transmit data
length is larger than
MSD_IN_EP_SIZE?
MSD_IN_EP_SIZE
Bytes of Data Written
to Transmit Register

No
dCSWDataResidue- = MSD_IN_EP_SIZE
dCBWDataTransferLength- = MSD_IN_EP_SIZE

No Is Yes
dCSWStatus! = 0x0?

Zero Padded Data
Remaining Data Output
(dCSWDataResidue)
Written to Transmit
Register and Sent dataLen =
(sendData()) min(bCBWDataTransferLength, MSD_IN_EP_SIZE)
Bytes of Data Written to Transmit Register and Sent

dCSWDataResidue =
|dCBWDataTransferLength – dCSWDataResidue|
dCBWDataTransferLength = 0

dCSWDataResidue- = dataLen
dCBWDataTransferLength- = dataLen

Return


AN1003
TOOLS, TESTING AND The firmware can be modified to interface with other
portable media cards with an SPI interface. For exam-
CUSTOMIZATION
ple, compact Flash, mini-SD card, XD picture card,
The firmware was developed using these Microchip memory stick pro and so on. This enhanced application
development tools (see “References”): can be developed as a multi-card reader device. Many
digital devices, such as Digital Cameras, MP3 Players
• MPLAB® IDE, V7.11
and PDAs, have an SD card interface for bulk storage.
• Microchip C18 C Compiler, V2.40 This application is useful for developers of SD card
The following third party tools (see “References”) media interfaces for other portable devices as well.
were used for USB packet level troubleshooting and Alternatively, this can be developed as a stand-alone
analysis of sector level reading and writing on the SD data logger application by including FAT libraries.
card: Another possible modification is to replace the SD card
• SnoopyPro 0.22 (USB Sniffer) with Flash memory to develop a Flash thumb drive.
• Directory Snoop™, V5.01 (Sector Level
Media Analyzer)
SUMMARY
The firmware has been tested with SD cards of varying This application note has demonstrated enumerating a
sizes from different manufacturers. Table 3 summarizes PIC18F4550 as a Mass Storage Device using an SD
the test results. The initialization, read, write, delete, card in Single-Bit mode on an SPI bus. In addition, it
format and rename operations were successfully tested has demonstrated how to use bulk endpoints, MSD
for all SD cards listed. The firmware was also tested for buffers, the Bulk-Only Transport protocol and SCSI
64 MB MMC. The 16 MB SD/MMC card is not supported commands for data transfer.
as it utilizes the FAT12 file system that is not supported The application described is embedded FAT-free; how-
by the Windows drivers. The code has been tested on ever, code implementation is modular and allows for
OHCI, UHCI and EHCI USB root hubs. Auto-triggering seamless integration of any embedded FAT file system
and accessing files from the SD card through PC appli- for stand-alone applications.
cations has been tested. The enumerated disk drive can
be formatted (using the Windows Explorer application)
as a FAT16, FAT32 or NTFS volume. Like any remov-
able disk drive application, the USB Mass Storage
Device allows users to create, edit, save, delete, rename
and read files or folders on the SD card.

TABLE 3: MSD SD CARD TEST RESULTS
Manufacturer Card Capacity Test Result
EP Memory 512 MB Passed
Lexar 256 MB Passed
Lexar 512 MB Passed
Lexar 1.0 GB Passed
SanDisk 128 MB Passed
SanDisk 512 MB Passed
SanDisk 1.0 GB Passed
SimpleTech 256 MB Passed
SimpleTech 1 GB Passed
Viking 256 MB Passed
Viking 512 MB Passed


AN1003
REFERENCES
• Directory Snoop™, V5.01,
http://www.briggsoft.com/dsnoop.htm
• FAT File System Specification – available by license,
http://www.microsoft.com/mscorp/ip/tech/fat.asp
• “PIC18F2455/2550/4455/4550 Data Sheet”
(DS39632), http://www.microchip.com
• “PICDEM™ FS USB Demonstration Board User’s
Guide” (DS51526),
http://www.microchip.com
• MC74VHCT125A Data Sheet,
http://www.onsemi.com
• Microchip MPLAB® C18 C Compiler – student
edition is available by license free of charge from
the Microchip web site,
http://www.microchip.com/C18
• MMC Specifications – some are available by
license and others are available for purchase,
http://www.mmca.org/compliance
• Microchip MPLAB® IDE – available by license free
of charge from the Microchip web site,
http://www.microchip.com/mplabide
• SCSI Primary Commands-2 (SPC-2),
Revision i23, 18 July 2003,
http://www.t10.org/ftp/t10/drafts/spc2/spc2i23.pdf
• SCSI Primary Commands-3 (SPC-3),
Revision 21d, 14 February 2005,
http://www.t10.org/ftp/t10/drafts/spc3/spc3r23.pdf
• SCSI Block Commands-2 (SBC-2), Revision 16,
13 November 2004,
http://www.t10.org/ftp/t10/drafts/sbc2/sbc2r16.pdf
• SD Card Specification – available by license,
http://www.sdcard.org
• SnoopyPro 0.22,
http://sourceforge.net/projects/usbsnoop/
• “USB Complete: Everything You Need to Develop
Custom USB Peripherals” by Jan Axelson,
ISBN 0-9650819-5-8
• Universal Serial Bus Specification Revision 2.0,
http://www.usb.org/developers/docs/
• Universal Serial Bus Mass Storage Class
Bulk-Only Transport, Revision 1.0,
http://www.usb.org/developers/devclass_docs/
usbmassbulk_10.pdf


AN1003
APPENDIX A: FREQUENTLY ASKED QUESTIONS
In this appendix, answers are provided to some of the frequently asked questions about the Mass Storage Device as
well as this implementation.

Q: When I plug in the SD card, all of the LEDs turn on. What does this mean?
A: This an indication that there was an error in the SD card initialization. Try removing the external power to the board
and USB cable, removing and reinserting the SD card, reconnecting the USB cable and external power (if applicable).
If this does not solve the problem, verify whether the SD card you are using has been tested with MSD (see Table 3
for the list of cards tested).

Q: Which endpoints are used in the MSD application?
A: Endpoint 0 is the mandatory endpoint that must be implemented in all USB devices for control transfers. This appli-
cation uses Endpoint 1 IN and OUT as Bulk transport endpoints for a bidirectional communication between the host
and the device.

Q: What is the size of the msd_buffer and how does MSD handle large data transfers?
A: The size of the msd_buffer is 512 bytes. Data is written to and read from the SD card in blocks which are
512 bytes for the SD card. Large data transfers imply multiple block read/write operations. However, the multi-read
and multi-write SD card commands are not implemented – instead, multiple single block read/write commands are
issued to achieve large transfers.

Q: What is the size of the code in terms of single-word instructions?
A: The size of Chapter 9 code is approximately 3K and Mass Storage Device code is approximately another 1K.

Q: Why is LED D2 not blinking?
A: After initial enumeration and reading the directory from the SD card, the host repeatedly sends the TEST UNIT
READY command to continue checking the status of the device. The D2 LED toggles when a TEST UNIT READY
command returns a success. So if the D2 LED is not toggling, there was an error. Check whether the SD card was
properly inserted in the card reader interface before connecting the USB cable.

Q: What is the communication protocol between the SD card and the PICDEM™ FS USB Demonstration Board?
A: The SD card is operated in Single-Bit mode using the SPI bus protocol.

Q: What is the data transfer speed?
A: The maximum data transfer speed observed during MSD testing was 944 kbps. The data transfer speed of the
PICDEM™ FS USB bus is 12 Mbps. The system bottleneck is the SPI bus (with the SD card operated in Single-Bit
SPI Bus mode). We believe that reading 64 bytes from the endpoints into the msd_buffer and writing 512 bytes
into the SD card also slows the overall data transfer speed.

Q: Is it possible to integrate the FAT file system into this implementation?
A: Yes. The FAT file system is required if files need to be created on the SD card without using a PC (i.e., data logging
applications). However, it is possible to reuse the functions associated with the SCSI command interface and the
SD card communication interface in the firmware.

Q: Why does it show “Microchp” in Device Manager > Disk drives? Is this a typographical error?
A: Microchp is an 8-byte Vendor ID sent from the device to the host in response to the INQUIRY command. Since
the Vendor ID field can be only 8 bytes, Microchp is a shortened version of Microchip.

Q: Why doesn’t MSD work with Windows 98?
A: The MSD demonstration uses the native Windows driver, usbstor.sys. The Windows 98 operating system does
not provide native support for usbstor.sys. Please refer to the Microsoft® web site for details:
http://www.microsoft.com/whdc/device/storage/usbfaq.mspx

Q: Why does MSD implement the SCSI command set and not the RBC?
A: Currently, Windows 2000 and Windows XP do not provide support to handle devices that implement Reduced Block
Commands (RBC, subclass 0x01) protocol. Please refer to the Microsoft web site for further details:
http://www.microsoft.com/whdc/device/storage/usbfaq.mspx


AN1003
APPENDIX B: SOURCE CODE
Software License Agreement
The software supplied herewith by Microchip Technology Incorporated (the “Company”) is intended and supplied to you, the
Company’s customer, for use solely and exclusively with products manufactured by the Company.
The software is owned by the Company and/or its supplier, and is protected under applicable copyright laws. All rights are reserved.
Any use in violation of the foregoing restrictions may subject the user to criminal sanctions under applicable laws, as well as to civil
liability for the breach of the terms and conditions of this license.
THIS SOFTWARE IS PROVIDED IN AN “AS IS” CONDITION. NO WARRANTIES, WHETHER EXPRESS, IMPLIED OR STATU-
TORY, INCLUDING, BUT NOT LIMITED TO, IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICU-
LAR PURPOSE APPLY TO THIS SOFTWARE. THE COMPANY SHALL NOT, IN ANY CIRCUMSTANCES, BE LIABLE FOR
SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES, FOR ANY REASON WHATSOEVER.

The complete source code, including any demo appli-
cations and necessary support files, is available for
download as a single archive file from the Microchip
corporate web site, at:
www.microchip.com


AN1003
APPENDIX C: USB DESCRIPTOR FORMATS

TABLE C-1: DEVICE DESCRIPTOR
Device Descriptor

Field Value Description
bDescriptorType 01h Device descriptor type.
bDeviceClass 00h Class specified in the interface
descriptor.
bDeviceSubClass 00h Subclass specified in the interface
descriptor.
bDeviceProtocol 00h Protocol specified in the interface
descriptor.
bMaxPacketSize 10h Endpoint 0 size.
idVendor 04D8h Vendor ID assigned by USB-IF.
bNumConfiguration 01h Number of possible configurations.

TABLE C-2: CONFIGURATION DESCRIPTOR
bDescriptorType 02h Configuration descriptor type.
bNumInterfaces 01h Number of interfaces supported by
this configuration.
bConfigurationValue 01h Index value of this configuration.
bmAttributes C0h Configuration Characteristics:
Bit Description
7 Reserved (set to ‘1’)
6 Self-powered
5 Remote wake-up
4-0 Reserved
MaxPower 32h Maximum power consumption of the
USB device from the bus, expressed
in 2 mA units (i.e., 50 = 100 mA).

TABLE C-3: INTERFACE DESCRIPTOR
bDescriptorType 04h Interface descriptor type.
bInterfaceNumber 00h Number of interface. Zero-based
value identifying the index in the array
of concurrent interfaces supported by
this configuration.
bNumEndpoints 02h Number of endpoints used by this
interface (excluding Endpoint 0). This
value shall be at least 2.
bInterfaceClass 08h Mass Storage Class.
bInterfaceSubClass 06h Subclass code (assigned by USB-IF).
Indicates which industry standard
command block definition to use.
bInterfaceProtocol 50h Bulk-Only Transport.


AN1003
APPENDIX D: USB DESCRIPTOR STRUCTURES
~systemusbusbdefsusbdefs_std_dsc.h

DEVICE DESCRIPTOR
typedef struct _USB_DEV_DSC
{
byte bLength; byte bDscType;
word bcdUSB; byte bDevCls;
byte bDevSubCls; byte bDevProtocol;
byte bMaxPktSize0; word idVendor;
word idProduct; word bcdDevice;
byte iMFR; byte iProduct;
byte iSerialNum; byte bNumCfg;
} USB_DEV_DSC;

CONFIGURATION DESCRIPTOR
typedef struct _USB_CFG_DSC
{
word wTotalLength; byte bNumIntf;
byte bCfgValue; byte iCfg;
byte bmAttributes; byte bMaxPower;
} USB_CFG_DSC;

INTERFACE DESCRIPTOR
typedef struct _USB_INTF_DSC
{
byte bIntfNum; byte bAltSetting;
byte bNumEPs; byte bIntfCls;
byte bIntfSubCls; byte bIntfProtocol;
byte iIntf;
} USB_INTF_DSC;

ENDPOINT DESCRIPTOR
typedef struct _USB_EP_DSC
{
byte bEPAdr; byte bmAttributes;
word wMaxPktSize; byte bInterval;
} USB_EP_DSC;


AN1003
APPENDIX E: STANDARD USB DEVICE REQUESTS

TABLE E-1: STANDARD REQUESTS FOR CONTROL TRANSFERS
bmRequestType bRequest Description
00000000b CLEAR_FEATURE The host requests to disable a feature on a
00000001b device, interface or endpoint.
00000010b
10000000b GET_CONFIGURATION The host requests the value of the current
device configuration.
10000000b GET_DESCRIPTOR The host requests a specific descriptor.
10000001b GET_INTERFACE
10000000b GET_STATUS Index value of the configuration.
10000001b
10000010b
00000000b SET_ADDRESS The host specifies an address to use in future
communications with the device.
00000000b SET_CONFIGURATION
00000000b SET_DESCRIPTOR The host adds a descriptor or updates an
existing descriptor.
00000000b SET_FEATURE The host requests to enable a feature on a
00000001b device, interface or endpoint.
00000010b
00000001b SET_INTERFACE For devices with a configuration that supports
multiple, mutually exclusive settings for the
interface, the host requests the device to use
specific settings.
10000010b SYNC_FRAME The device sets and reports an endpoint’s
synchronization frame.


AN1003
APPENDIX F: BULK ENDPOINT DESCRIPTORS

TABLE F-1: BULK-IN ENDPOINT DESCRIPTOR
Bulk-In Endpoint Descriptor

bDescriptorType 05h Endpoint descriptor type.
bEndpointAddress 81h The address of this endpoint on the
USB device. The address is encoded
as follows:
Bit Description
3-0 The endpoint number
6-4 Reserved, set to ‘0’
7 1 = In
bmAttributes 02h This is a Bulk endpoint.
bMaxPacketSize 40h Maximum packet size. Shall be 8, 16,
32 or 64 bytes (64 bytes in our case).
bInterval 00h Does not apply to Bulk endpoints.

TABLE F-2: BULK-OUT ENDPOINT DESCRIPTOR
Bulk-Out Endpoint Descriptor

bDescriptorType 05h Endpoint descriptor type.
bEndpointAddress 01h The address of this endpoint on the
USB device. The address is encoded
as follows:
Bit Description
3-0 The endpoint number
6-4 Reserved, set to ‘0’
7 0 = Out
bmAttributes 02h This is a Bulk endpoint.
bMaxPacketSize 40h Maximum packet size. Shall be 8, 16,
32 or 64 bytes (64 bytes in our case).
bInterval 00h Does not apply to Bulk endpoints.


AN1003
APPENDIX G: CBW AND CSW

TABLE G-1: COMMAND BLOCK WRAPPER (CBW)
Command Block Wrapper (CBW)

Byte Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0
0-3 dCBWSignature
4-7 dCBWTag
8-11 dCBWDataTransferLength
12 bmCBWFlags
13 Reserved (0) bCBWLUN
14 Reserved (0) BCBMCBLength
15-30 CBWCB

TABLE G-2: COMMAND STATUS WRAPPER (CSW)
Command Status Wrapper (CSW)

0-3 dCBWSignature
4-7 dCSWTag
8-11 dCSWDataResidue
12 bCSWStatus


AN1003
APPENDIX H: SCSI COMMAND SET

TABLE H-1: SCSI COMMAND SET
Command Name Operation Code Description
INQUIRY 12h Gets device Information.
READ CAPACITY 25h Requests for capacity and medium format
parameters.
READ FORMATTED CAPACITY 23h Reports current media capacity and formatting
capacities supported by media.
READ (10) 28h Transfers binary data from the media to the
host.
WRITE (10) 2Ah Transfers binary data from the host to the
media.
MODE SENSE (6) 1Ah Requests device to report parameters.
REQUEST SENSE (6) 03h Transfers status sense data to the host.
PREVENT ALLOW MEDIUM REMOVAL 1Eh Prevents or allows the removal of media from
a removable media device.
TEST UNIT READY 00h Requests to check if logical unit is ready.
VERIFY (10) 2Fh Requests to verify a specified LBA on medium.
START/STOP 1Bh Requests a removable media device to load or
unload its media.


AN1003
APPENDIX I: SCSI COMMAND AND DATA FORMAT

TABLE I-1: MODE PARAMETER HEADER (6)
0 MODE DATA LENGTH
1 MEDIUM TYPE
2 DEVICE SPECIFIC PARAMETER
3 BLOCK DESCRIPTOR LENGTH

TABLE I-2: FIXED FORMAT SENSE DATA
Fixed Format Sense Data

0 RESPONSE CODE (70h or 71h)
1 Obsolete
2 FILEMARK EOM ILI Reserved SENSE KEY
3-6 INFORMATION
7 ADDITIONAL SENSE LENGTH (n-7)
8-11 COMMAND SPECIFIC INFORMATION
12 ADDITIONAL SENSE CODE
13 ADDITIONAL SENSE CODE QUALIFIER
14 FIELD REPLACEMENT UNIT CODE
15-17 SENSE KEY SPECIFIC
18-n Additional Sense Bytes

TABLE I-3: STANDARD INQUIRY DATA FORMAT
Standard Inquiry Data Format

0 PERIPHERAL QUALIFIER PERIPHERAL DEVICE TYPE
1 RMB Reserved
2 Version
3 Obsolete NORMACA HISUP RESPONSE DATA FORMAT
4 ADDITIONAL LENGTH (n-4)
5 SCCS ACC TPGS 3PC Reserved PRTOECT
6 BQUE ENCSERV VS MULTIP MCHNGR Obsolete ADDR16
7 Obsolete WUSB16 SYNC LINKED Obsolete CMDQUE VS
8-15 (MSB)
T10 VENDOR IDENTIFICATION
(LSB)
16-31 (MSB)
PRODUCT IDENTIFICATION
(LSB)
32-35 (MSB)
PRODUCT REVISION LEVEL
(LSB)


AN1003
TABLE I-4: READ (10) COMMAND
0 Operation Code (28h)
1 RDPROTECT DPO FUA Reserved FUA_NV Obsolete
2 (MSB)
Logical Block Address
5 (LSB)
6 Reserved Group Number
7 (MSB)
TRANSFER LENGTH
8 (LSB)
9 CONTROL


FIGURE J-1:

DS01003A-page 30
APPENDIX J:
AN1003

12 11

13
180Ω
.01 μF
2 3

1

5 6

4

9 8

PICtail™
10
SCHEMATIC

3 2

1

6 5

4
Card
8 9 dect
Write
10 dect
DM1AA-SF-PEJ(21) FPS009-2203-10
11 12

13

VIN VOUT
GND
SHDN NC
.1 μF 10 μF
TC1186
180Ω

PICtail™ CONN

1 μF
PICtail™ BOARD FOR SD™ AND MMC CARDS SCHEMATIC

© 2005 Microchip Technology Inc.

Note the following details of the code protection feature on Microchip devices:
• Microchip products meet the specification contained in their particular Microchip Data Sheet.

• Microchip believes that its family of products is one of the most secure families of its kind on the market today, when used in the
intended manner and under normal conditions.

• There are dishonest and possibly illegal methods used to breach the code protection feature. All of these methods, to our
knowledge, require using the Microchip products in a manner outside the operating specifications contained in Microchip’s Data
Sheets. Most likely, the person doing so is engaged in theft of intellectual property.

• Microchip is willing to work with the customer who is concerned about the integrity of their code.

• Neither Microchip nor any other semiconductor manufacturer can guarantee the security of their code. Code protection does not
mean that we are guaranteeing the product as “unbreakable.”

Code protection is constantly evolving. We at Microchip are committed to continuously improving the code protection features of our
products. Attempts to break Microchip’s code protection feature may be a violation of the Digital Millennium Copyright Act. If such acts
allow unauthorized access to your software or other copyrighted work, you may have a right to sue for relief under that Act.

Information contained in this publication regarding device Trademarks
applications and the like is provided only for your convenience
The Microchip name and logo, the Microchip logo, Accuron,
and may be superseded by updates. It is your responsibility to dsPIC, KEELOQ, microID, MPLAB, PIC, PICmicro, PICSTART,
ensure that your application meets with your specifications.
PRO MATE, PowerSmart, rfPIC, and SmartShunt are
MICROCHIP MAKES NO REPRESENTATIONS OR WAR-
registered trademarks of Microchip Technology Incorporated
RANTIES OF ANY KIND WHETHER EXPRESS OR IMPLIED,
in the U.S.A. and other countries.
WRITTEN OR ORAL, STATUTORY OR OTHERWISE,
RELATED TO THE INFORMATION, INCLUDING BUT NOT AmpLab, FilterLab, Migratable Memory, MXDEV, MXLAB,
LIMITED TO ITS CONDITION, QUALITY, PERFORMANCE, PICMASTER, SEEVAL, SmartSensor and The Embedded
MERCHANTABILITY OR FITNESS FOR PURPOSE. Control Solutions Company are registered trademarks of
Microchip disclaims all liability arising from this information and Microchip Technology Incorporated in the U.S.A.
its use. Use of Microchip’s products as critical components in Analog-for-the-Digital Age, Application Maestro, dsPICDEM,
life support systems is not authorized except with express dsPICDEM.net, dsPICworks, ECAN, ECONOMONITOR,
written approval by Microchip. No licenses are conveyed, FanSense, FlexROM, fuzzyLAB, In-Circuit Serial
implicitly or otherwise, under any Microchip intellectual property Programming, ICSP, ICEPIC, Linear Active Thermistor,
rights. MPASM, MPLIB, MPLINK, MPSIM, PICkit, PICDEM,
PICDEM.net, PICLAB, PICtail, PowerCal, PowerInfo,
PowerMate, PowerTool, rfLAB, rfPICDEM, Select Mode,
Smart Serial, SmartTel, Total Endurance and WiperLock are
trademarks of Microchip Technology Incorporated in the
U.S.A. and other countries.
SQTP is a service mark of Microchip Technology Incorporated
in the U.S.A.
All other trademarks mentioned herein are property of their
respective companies.
© 2005, Microchip Technology Incorporated, Printed in the
U.S.A., All Rights Reserved.
Printed on recycled paper.

Microchip received ISO/TS-16949:2002 quality system certification for
its worldwide headquarters, design and wafer fabrication facilities in
Chandler and Tempe, Arizona and Mountain View, California in
October 2003. The Company’s quality system processes and
procedures are for its PICmicro® 8-bit MCUs, KEELOQ® code hopping
devices, Serial EEPROMs, microperipherals, nonvolatile memory and
analog products. In addition, Microchip’s quality system for the design
and manufacture of development systems is ISO 9001:2000 certified.


WORLDWIDE SALES AND SERVICE
AMERICAS ASIA/PACIFIC ASIA/PACIFIC EUROPE
Corporate Office Australia - Sydney India - Bangalore Austria - Weis
2355 West Chandler Blvd. Tel: 61-2-9868-6733 Tel: 91-80-2229-0061 Tel: 43-7242-2244-399
Chandler, AZ 85224-6199 Fax: 61-2-9868-6755 Fax: 91-80-2229-0062 Fax: 43-7242-2244-393
Tel: 480-792-7200 China - Beijing Denmark - Copenhagen
India - New Delhi
Fax: 480-792-7277 Tel: 86-10-8528-2100 Tel: 45-4450-2828
Tel: 91-11-5160-8631
Technical Support: Fax: 86-10-8528-2104 Fax: 45-4485-2829
Fax: 91-11-5160-8632
http://support.microchip.com
China - Chengdu India - Pune France - Paris
Web Address:
Tel: 86-28-8676-6200 Tel: 91-20-2566-1512 Tel: 33-1-69-53-63-20
www.microchip.com
Fax: 86-28-8676-6599 Fax: 91-20-2566-1513 Fax: 33-1-69-30-90-79
Atlanta
Alpharetta, GA China - Fuzhou Japan - Yokohama Germany - Munich
Tel: 86-591-8750-3506 Tel: 81-45-471- 6166 Tel: 49-89-627-144-0
Tel: 770-640-0034
Fax: 86-591-8750-3521 Fax: 49-89-627-144-44
Fax: 770-640-0307 Fax: 81-45-471-6122
China - Hong Kong SAR Italy - Milan
Boston Korea - Gumi
Tel: 852-2401-1200 Tel: 39-0331-742611
Westborough, MA Tel: 82-54-473-4301
Fax: 852-2401-3431 Fax: 39-0331-466781
Tel: 774-760-0087 Fax: 82-54-473-4302
Fax: 774-760-0088 China - Qingdao Netherlands - Drunen
Korea - Seoul
Tel: 86-532-8502-7355 Tel: 82-2-554-7200 Tel: 31-416-690399
Chicago
Fax: 86-532-8502-7205 Fax: 82-2-558-5932 or Fax: 31-416-690340
Itasca, IL
Tel: 630-285-0071 China - Shanghai 82-2-558-5934 Spain - Madrid
Fax: 630-285-0075 Tel: 86-21-5407-5533 Tel: 34-91-352-30-52
Malaysia - Penang
Fax: 86-21-5407-5066 Tel: 604-646-8870 Fax: 34-91-352-11-47
Dallas
Addison, TX China - Shenyang Fax: 604-646-5086 UK - Wokingham
Tel: 972-818-7423 Tel: 86-24-2334-2829 Tel: 44-118-921-5869
Philippines - Manila
Fax: 972-818-2924 Fax: 86-24-2334-2393 Fax: 44-118-921-5820
Tel: 632-634-9065
Detroit China - Shenzhen Fax: 632-634-9069
Farmington Hills, MI Tel: 86-755-8203-2660
Singapore
Tel: 248-538-2250 Fax: 86-755-8203-1760
Tel: 65-6334-8870
Fax: 248-538-2260 China - Shunde Fax: 65-6334-8850
Kokomo Tel: 86-757-2839-5507
Taiwan - Hsin Chu
Kokomo, IN Fax: 86-757-2839-5571
Tel: 886-3-572-9526
Tel: 765-864-8360 China - Wuhan Fax: 886-3-572-6459
Fax: 765-864-8387 Tel: 86-27-5980-5300
Taiwan - Kaohsiung
Los Angeles Fax: 86-27-5980-5118 Tel: 886-7-536-4818
Mission Viejo, CA China - Xian Fax: 886-7-536-4803
Tel: 949-462-9523 Tel: 86-29-8833-7250 Taiwan - Taipei
Fax: 949-462-9608 Fax: 86-29-8833-7256 Tel: 886-2-2500-6610
San Jose Fax: 886-2-2508-0102
Mountain View, CA
Thailand - Bangkok
Tel: 650-215-1444
Tel: 66-2-694-1351
Fax: 650-961-0286
Fax: 66-2-694-1350
Toronto
Mississauga, Ontario,
Canada
Tel: 905-673-0699
Fax: 905-673-6509

08/24/05


An1003 usb

More Related Content

What's hot (20)

Viewers also liked (18)

Similar to An1003 usb (20)

Recently uploaded (20)

An1003 usb