Cleanups to the MassStorage Device demos, and the MassStorage Device Class driver.
[pub/USBasp.git] / Demos / Host / ClassDriver / MassStorageHost / MassStorageHost.c
1 /*
2 LUFA Library
3 Copyright (C) Dean Camera, 2009.
4
5 dean [at] fourwalledcubicle [dot] com
6 www.fourwalledcubicle.com
7 */
8
9 /*
10 Copyright 2009 Dean Camera (dean [at] fourwalledcubicle [dot] com)
11
12 Permission to use, copy, modify, and distribute this software
13 and its documentation for any purpose and without fee is hereby
14 granted, provided that the above copyright notice appear in all
15 copies and that both that the copyright notice and this
16 permission notice and warranty disclaimer appear in supporting
17 documentation, and that the name of the author not be used in
18 advertising or publicity pertaining to distribution of the
19 software without specific, written prior permission.
20
21 The author disclaim all warranties with regard to this
22 software, including all implied warranties of merchantability
23 and fitness. In no event shall the author be liable for any
24 special, indirect or consequential damages or any damages
25 whatsoever resulting from loss of use, data or profits, whether
26 in an action of contract, negligence or other tortious action,
27 arising out of or in connection with the use or performance of
28 this software.
29 */
30
31 /** \file
32 *
33 * Main source file for the MassStorageHost demo. This file contains the main tasks of
34 * the demo and is responsible for the initial application hardware configuration.
35 */
36
37 #include "MassStorageHost.h"
38
39 /** LUFA Mass Storage Class driver interface configuration and state information. This structure is
40 * passed to all Mass Storage Class driver functions, so that multiple instances of the same class
41 * within a device can be differentiated from one another.
42 */
43 USB_ClassInfo_MS_Host_t FlashDisk_MS_Interface =
44 {
45 .Config =
46 {
47 .DataINPipeNumber = 1,
48 .DataINPipeDoubleBank = false,
49
50 .DataOUTPipeNumber = 2,
51 .DataOUTPipeDoubleBank = false,
52 },
53 };
54
55
56 /** Main program entry point. This routine configures the hardware required by the application, then
57 * enters a loop to run the application tasks in sequence.
58 */
59 int main(void)
60 {
61 SetupHardware();
62
63 puts_P(PSTR(ESC_FG_CYAN "Mass Storage Host Demo running.\r\n" ESC_FG_WHITE));
64
65 LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
66
67 for (;;)
68 {
69 switch (USB_HostState)
70 {
71 case HOST_STATE_Addressed:
72 LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
73
74 uint16_t ConfigDescriptorSize;
75 uint8_t ConfigDescriptorData[512];
76
77 if (USB_Host_GetDeviceConfigDescriptor(1, &ConfigDescriptorSize, ConfigDescriptorData,
78 sizeof(ConfigDescriptorData)) != HOST_GETCONFIG_Successful)
79 {
80 printf("Error Retrieving Configuration Descriptor.\r\n");
81 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
82 USB_HostState = HOST_STATE_WaitForDeviceRemoval;
83 break;
84 }
85
86 if (MS_Host_ConfigurePipes(&FlashDisk_MS_Interface,
87 ConfigDescriptorSize, ConfigDescriptorData) != MS_ENUMERROR_NoError)
88 {
89 printf("Attached Device Not a Valid Mass Storage Device.\r\n");
90 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
91 USB_HostState = HOST_STATE_WaitForDeviceRemoval;
92 break;
93 }
94
95 if (USB_Host_SetDeviceConfiguration(1) != HOST_SENDCONTROL_Successful)
96 {
97 printf("Error Setting Device Configuration.\r\n");
98 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
99 USB_HostState = HOST_STATE_WaitForDeviceRemoval;
100 break;
101 }
102
103 printf("Mass Storage Device Enumerated.\r\n");
104 USB_HostState = HOST_STATE_Configured;
105 break;
106 case HOST_STATE_Configured:
107 LEDs_SetAllLEDs(LEDMASK_USB_BUSY);
108
109 uint8_t MaxLUNIndex;
110 if (MS_Host_GetMaxLUN(&FlashDisk_MS_Interface, &MaxLUNIndex))
111 {
112 printf("Error retrieving max LUN index.\r\n");
113 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
114 USB_HostState = HOST_STATE_WaitForDeviceRemoval;
115 break;
116 }
117
118 printf("Total LUNs: %d - Using first LUN in device.\r\n", (MaxLUNIndex + 1));
119
120 if (MS_Host_ResetMSInterface(&FlashDisk_MS_Interface))
121 {
122 printf("Error resetting Mass Storage interface.\r\n");
123 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
124 USB_HostState = HOST_STATE_WaitForDeviceRemoval;
125 break;
126 }
127
128 SCSI_Request_Sense_Response_t SenseData;
129 if (MS_Host_RequestSense(&FlashDisk_MS_Interface, 0, &SenseData) != 0)
130 {
131 printf("Error retrieving device sense.\r\n");
132 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
133 USB_HostState = HOST_STATE_WaitForDeviceRemoval;
134 break;
135 }
136
137 if (MS_Host_PreventAllowMediumRemoval(&FlashDisk_MS_Interface, 0, true))
138 {
139 printf("Error setting Prevent Device Removal bit.\r\n");
140 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
141 USB_HostState = HOST_STATE_WaitForDeviceRemoval;
142 break;
143 }
144
145 SCSI_Inquiry_Response_t InquiryData;
146 if (MS_Host_GetInquiryData(&FlashDisk_MS_Interface, 0, &InquiryData))
147 {
148 printf("Error retrieving device Inquiry data.\r\n");
149 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
150 USB_HostState = HOST_STATE_WaitForDeviceRemoval;
151 break;
152 }
153
154 printf("Vendor \"%.8s\", Product \"%.16s\"\r\n", InquiryData.VendorID, InquiryData.ProductID);
155
156 printf("Waiting until ready...\r\n");
157
158 for (;;)
159 {
160 uint8_t ErrorCode = MS_Host_TestUnitReady(&FlashDisk_MS_Interface, 0);
161
162 if (!(ErrorCode))
163 break;
164
165 /* Check if an error other than a logical command error (device busy) received */
166 if (ErrorCode != MS_ERROR_LOGICAL_CMD_FAILED)
167 {
168 printf("Error waiting for device to be ready.\r\n");
169 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
170 USB_HostState = HOST_STATE_WaitForDeviceRemoval;
171 break;
172 }
173 }
174
175 printf("Retrieving Capacity... ");
176
177 SCSI_Capacity_t DiskCapacity;
178 if (MS_Host_ReadDeviceCapacity(&FlashDisk_MS_Interface, 0, &DiskCapacity))
179 {
180 printf("Error retrieving device capacity.\r\n");
181 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
182 USB_HostState = HOST_STATE_WaitForDeviceRemoval;
183 break;
184 }
185
186 printf("%lu blocks of %lu bytes.\r\n", DiskCapacity.Blocks, DiskCapacity.BlockSize);
187
188 uint8_t BlockBuffer[DiskCapacity.BlockSize];
189
190 if (MS_Host_ReadDeviceBlocks(&FlashDisk_MS_Interface, 0, 0x00000000, 1, DiskCapacity.BlockSize, BlockBuffer))
191 {
192 printf("Error reading device block.\r\n");
193 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
194 USB_HostState = HOST_STATE_WaitForDeviceRemoval;
195 break;
196 }
197
198 printf("\r\nContents of first block:\r\n");
199
200 for (uint16_t Chunk = 0; Chunk < (DiskCapacity.BlockSize >> 4); Chunk++)
201 {
202 uint8_t* ChunkPtr = &BlockBuffer[Chunk << 4];
203
204 /* Print out the 16 bytes of the chunk in HEX format */
205 for (uint8_t ByteOffset = 0; ByteOffset < (1 << 4); ByteOffset++)
206 {
207 char CurrByte = *(ChunkPtr + ByteOffset);
208 printf_P(PSTR("%.2X "), CurrByte);
209 }
210
211 printf(" ");
212
213 /* Print out the 16 bytes of the chunk in ASCII format */
214 for (uint8_t ByteOffset = 0; ByteOffset < (1 << 4); ByteOffset++)
215 {
216 char CurrByte = *(ChunkPtr + ByteOffset);
217 putchar(isprint(CurrByte) ? CurrByte : '.');
218 }
219
220 printf("\r\n");
221 }
222
223 LEDs_SetAllLEDs(LEDMASK_USB_READY);
224 USB_HostState = HOST_STATE_WaitForDeviceRemoval;
225 break;
226 }
227
228 MS_Host_USBTask(&FlashDisk_MS_Interface);
229 USB_USBTask();
230 }
231 }
232
233 /** Configures the board hardware and chip peripherals for the demo's functionality. */
234 void SetupHardware(void)
235 {
236 /* Disable watchdog if enabled by bootloader/fuses */
237 MCUSR &= ~(1 << WDRF);
238 wdt_disable();
239
240 /* Disable clock division */
241 clock_prescale_set(clock_div_1);
242
243 /* Hardware Initialization */
244 SerialStream_Init(9600, false);
245 LEDs_Init();
246 USB_Init();
247 }
248
249 /** Event handler for the USB_DeviceAttached event. This indicates that a device has been attached to the host, and
250 * starts the library USB task to begin the enumeration and USB management process.
251 */
252 void EVENT_USB_Host_DeviceAttached(void)
253 {
254 puts_P(PSTR("Device Attached.\r\n"));
255 LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
256 }
257
258 /** Event handler for the USB_DeviceUnattached event. This indicates that a device has been removed from the host, and
259 * stops the library USB task management process.
260 */
261 void EVENT_USB_Host_DeviceUnattached(void)
262 {
263 puts_P(PSTR("\r\nDevice Unattached.\r\n"));
264 LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
265 }
266
267 /** Event handler for the USB_DeviceEnumerationComplete event. This indicates that a device has been successfully
268 * enumerated by the host and is now ready to be used by the application.
269 */
270 void EVENT_USB_Host_DeviceEnumerationComplete(void)
271 {
272 LEDs_SetAllLEDs(LEDMASK_USB_READY);
273 }
274
275 /** Event handler for the USB_HostError event. This indicates that a hardware error occurred while in host mode. */
276 void EVENT_USB_Host_HostError(const uint8_t ErrorCode)
277 {
278 USB_ShutDown();
279
280 printf_P(PSTR(ESC_FG_RED "Host Mode Error\r\n"
281 " -- Error Code %d\r\n" ESC_FG_WHITE), ErrorCode);
282
283 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
284 for(;;);
285 }
286
287 /** Event handler for the USB_DeviceEnumerationFailed event. This indicates that a problem occurred while
288 * enumerating an attached USB device.
289 */
290 void EVENT_USB_Host_DeviceEnumerationFailed(const uint8_t ErrorCode, const uint8_t SubErrorCode)
291 {
292 printf_P(PSTR(ESC_FG_RED "Dev Enum Error\r\n"
293 " -- Error Code %d\r\n"
294 " -- Sub Error Code %d\r\n"
295 " -- In State %d\r\n" ESC_FG_WHITE), ErrorCode, SubErrorCode, USB_HostState);
296
297 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
298 }