Fix Printer bootloader top level documentation.
[pub/USBasp.git] / Bootloaders / Incomplete / MassStorage / BootloaderMassStorage.c
1 /*
2 LUFA Library
3 Copyright (C) Dean Camera, 2013.
4
5 dean [at] fourwalledcubicle [dot] com
6 www.lufa-lib.org
7 */
8
9 /*
10 Copyright 2013 Dean Camera (dean [at] fourwalledcubicle [dot] com)
11
12 Permission to use, copy, modify, distribute, and sell this
13 software and its documentation for any purpose is hereby granted
14 without fee, provided that the above copyright notice appear in
15 all 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 disclaims 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 Mass Storage class bootloader. This file contains the complete bootloader logic.
34 */
35
36 #include "BootloaderMassStorage.h"
37
38 /** LUFA Mass Storage Class driver interface configuration and state information. This structure is
39 * passed to all Mass Storage Class driver functions, so that multiple instances of the same class
40 * within a device can be differentiated from one another.
41 */
42 USB_ClassInfo_MS_Device_t Disk_MS_Interface =
43 {
44 .Config =
45 {
46 .InterfaceNumber = 0,
47 .DataINEndpoint =
48 {
49 .Address = MASS_STORAGE_IN_EPADDR,
50 .Size = MASS_STORAGE_IO_EPSIZE,
51 .Banks = 1,
52 },
53 .DataOUTEndpoint =
54 {
55 .Address = MASS_STORAGE_OUT_EPADDR,
56 .Size = MASS_STORAGE_IO_EPSIZE,
57 .Banks = 1,
58 },
59 .TotalLUNs = 1,
60 },
61 };
62
63
64 /** Main program entry point. This routine configures the hardware required by the application, then
65 * enters a loop to run the application tasks in sequence.
66 */
67 int main(void)
68 {
69 SetupHardware();
70
71 LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
72 GlobalInterruptEnable();
73
74 for (;;)
75 {
76 MS_Device_USBTask(&Disk_MS_Interface);
77 USB_USBTask();
78 }
79 }
80
81 /** Configures the board hardware and chip peripherals for the demo's functionality. */
82 void SetupHardware(void)
83 {
84 /* Disable watchdog if enabled by bootloader/fuses */
85 MCUSR &= ~(1 << WDRF);
86 wdt_disable();
87
88 /* Disable clock division */
89 clock_prescale_set(clock_div_1);
90
91 /* Relocate the interrupt vector table to the bootloader section */
92 MCUCR = (1 << IVCE);
93 MCUCR = (1 << IVSEL);
94
95 /* Hardware Initialization */
96 LEDs_Init();
97 USB_Init();
98
99 /* Bootloader active LED toggle timer initialization */
100 TIMSK1 = (1 << TOIE1);
101 TCCR1B = ((1 << CS11) | (1 << CS10));
102 }
103
104 /** ISR to periodically toggle the LEDs on the board to indicate that the bootloader is active. */
105 ISR(TIMER1_OVF_vect, ISR_BLOCK)
106 {
107 LEDs_ToggleLEDs(LEDS_LED1 | LEDS_LED2);
108 }
109
110 /** Event handler for the USB_Connect event. This indicates that the device is enumerating via the status LEDs. */
111 void EVENT_USB_Device_Connect(void)
112 {
113 /* Indicate USB enumerating */
114 LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
115 }
116
117 /** Event handler for the USB_Disconnect event. This indicates that the device is no longer connected to a host via
118 * the status LEDs and stops the Mass Storage management task.
119 */
120 void EVENT_USB_Device_Disconnect(void)
121 {
122 /* Indicate USB not ready */
123 LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
124 }
125
126 /** Event handler for the library USB Configuration Changed event. */
127 void EVENT_USB_Device_ConfigurationChanged(void)
128 {
129 bool ConfigSuccess = true;
130
131 /* Setup Mass Storage Data Endpoints */
132 ConfigSuccess &= MS_Device_ConfigureEndpoints(&Disk_MS_Interface);
133
134 /* Indicate endpoint configuration success or failure */
135 LEDs_SetAllLEDs(ConfigSuccess ? LEDMASK_USB_READY : LEDMASK_USB_ERROR);
136 }
137
138 /** Event handler for the library USB Control Request reception event. */
139 void EVENT_USB_Device_ControlRequest(void)
140 {
141 MS_Device_ProcessControlRequest(&Disk_MS_Interface);
142 }
143
144 /** Mass Storage class driver callback function the reception of SCSI commands from the host, which must be processed.
145 *
146 * \param[in] MSInterfaceInfo Pointer to the Mass Storage class interface configuration structure being referenced
147 */
148 bool CALLBACK_MS_Device_SCSICommandReceived(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo)
149 {
150 bool CommandSuccess;
151
152 LEDs_SetAllLEDs(LEDMASK_USB_BUSY);
153 CommandSuccess = SCSI_DecodeSCSICommand(MSInterfaceInfo);
154 LEDs_SetAllLEDs(LEDMASK_USB_READY);
155
156 return CommandSuccess;
157 }
158