Demos/Host/ClassDriver/StillImageHost/StillImageHost.c

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2021.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2021  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 StillImageHost demo. This file contains the main tasks of
  34  *  the demo and is responsible for the initial application hardware configuration.
  35  */
  36
  37 #include "StillImageHost.h"
  38
  39 /** LUFA Still Image Class driver interface configuration and state information. This structure is
  40  *  passed to all Still Image 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_SI_Host_t DigitalCamera_SI_Interface =
  44         {
  45                 .Config =
  46                         {
  47                                 .DataINPipe             =
  48                                         {
  49                                                 .Address        = (PIPE_DIR_IN  | 1),
  50                                                 .Banks          = 1,
  51                                         },
  52                                 .DataOUTPipe            =
  53                                         {
  54                                                 .Address        = (PIPE_DIR_OUT | 2),
  55                                                 .Banks          = 1,
  56                                         },
  57                                 .EventsPipe             =
  58                                         {
  59                                                 .Address        = (PIPE_DIR_IN  | 3),
  60                                                 .Banks          = 1,
  61                                         },
  62                         },
  63         };
  64
  65
  66 /** Main program entry point. This routine configures the hardware required by the application, then
  67  *  enters a loop to run the application tasks in sequence.
  68  */
  69 int main(void)
  70 {
  71         SetupHardware();
  72
  73         puts_P(PSTR(ESC_FG_CYAN "Still Image Host Demo running.\r\n" ESC_FG_WHITE));
  74
  75         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
  76         GlobalInterruptEnable();
  77
  78         for (;;)
  79         {
  80                 StillImageHost_Task();
  81
  82                 SI_Host_USBTask(&DigitalCamera_SI_Interface);
  83                 USB_USBTask();
  84         }
  85 }
  86
  87 /** Configures the board hardware and chip peripherals for the demo's functionality. */
  88 void SetupHardware(void)
  89 {
  90 #if (ARCH == ARCH_AVR8)
  91         /* Disable watchdog if enabled by bootloader/fuses */
  92         MCUSR &= ~(1 << WDRF);
  93         wdt_disable();
  94
  95         /* Disable clock division */
  96         clock_prescale_set(clock_div_1);
  97 #endif
  98
  99         /* Hardware Initialization */
 100         Serial_Init(9600, false);
 101         LEDs_Init();
 102         USB_Init();
 103
 104         /* Create a stdio stream for the serial port for stdin and stdout */
 105         Serial_CreateStream(NULL);
 106 }
 107
 108 /** Task to manage an enumerated USB Still Image device once connected, to manage a
 109  *  new PIMA session in order to send commands to the attached device.
 110  */
 111 void StillImageHost_Task(void)
 112 {
 113         if (USB_HostState != HOST_STATE_Configured)
 114           return;
 115
 116         puts_P(PSTR("Opening Session...\r\n"));
 117
 118         if (SI_Host_OpenSession(&DigitalCamera_SI_Interface) != PIPE_RWSTREAM_NoError)
 119         {
 120                 puts_P(PSTR("Could not open PIMA session.\r\n"));
 121                 USB_Host_SetDeviceConfiguration(0);
 122                 return;
 123         }
 124
 125         puts_P(PSTR("Turning off Device...\r\n"));
 126
 127         SI_Host_SendCommand(&DigitalCamera_SI_Interface, 0x1013, 0, NULL);
 128         if (SI_Host_ReceiveResponse(&DigitalCamera_SI_Interface))
 129         {
 130                 puts_P(PSTR("Could not turn off device.\r\n"));
 131                 USB_Host_SetDeviceConfiguration(0);
 132                 return;
 133         }
 134
 135         puts_P(PSTR("Device Off.\r\n"));
 136
 137         puts_P(PSTR("Closing Session...\r\n"));
 138
 139         if (SI_Host_CloseSession(&DigitalCamera_SI_Interface) != PIPE_RWSTREAM_NoError)
 140         {
 141                 puts_P(PSTR("Could not close PIMA session.\r\n"));
 142                 USB_Host_SetDeviceConfiguration(0);
 143                 return;
 144         }
 145
 146         LEDs_SetAllLEDs(LEDMASK_USB_READY);
 147         USB_Host_SetDeviceConfiguration(0);
 148 }
 149
 150 /** Event handler for the USB_DeviceAttached event. This indicates that a device has been attached to the host, and
 151  *  starts the library USB task to begin the enumeration and USB management process.
 152  */
 153 void EVENT_USB_Host_DeviceAttached(void)
 154 {
 155         puts_P(PSTR("Device Attached.\r\n"));
 156         LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
 157 }
 158
 159 /** Event handler for the USB_DeviceUnattached event. This indicates that a device has been removed from the host, and
 160  *  stops the library USB task management process.
 161  */
 162 void EVENT_USB_Host_DeviceUnattached(void)
 163 {
 164         puts_P(PSTR("\r\nDevice Unattached.\r\n"));
 165         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
 166 }
 167
 168 /** Event handler for the USB_DeviceEnumerationComplete event. This indicates that a device has been successfully
 169  *  enumerated by the host and is now ready to be used by the application.
 170  */
 171 void EVENT_USB_Host_DeviceEnumerationComplete(void)
 172 {
 173         LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
 174
 175         uint16_t ConfigDescriptorSize;
 176         uint8_t  ConfigDescriptorData[512];
 177
 178         if (USB_Host_GetDeviceConfigDescriptor(1, &ConfigDescriptorSize, ConfigDescriptorData,
 179                                                sizeof(ConfigDescriptorData)) != HOST_GETCONFIG_Successful)
 180         {
 181                 puts_P(PSTR("Error Retrieving Configuration Descriptor.\r\n"));
 182                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 183                 return;
 184         }
 185
 186         if (SI_Host_ConfigurePipes(&DigitalCamera_SI_Interface,
 187                                    ConfigDescriptorSize, ConfigDescriptorData) != SI_ENUMERROR_NoError)
 188         {
 189                 puts_P(PSTR("Attached Device Not a Valid Still Image Class Device.\r\n"));
 190                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 191                 return;
 192         }
 193
 194         if (USB_Host_SetDeviceConfiguration(1) != HOST_SENDCONTROL_Successful)
 195         {
 196                 puts_P(PSTR("Error Setting Device Configuration.\r\n"));
 197                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 198                 return;
 199         }
 200
 201         puts_P(PSTR("Still Image Device Enumerated.\r\n"));
 202         LEDs_SetAllLEDs(LEDMASK_USB_READY);
 203 }
 204
 205 /** Event handler for the USB_HostError event. This indicates that a hardware error occurred while in host mode. */
 206 void EVENT_USB_Host_HostError(const uint8_t ErrorCode)
 207 {
 208         USB_Disable();
 209
 210         printf_P(PSTR(ESC_FG_RED "Host Mode Error\r\n"
 211                                  " -- Error Code %d\r\n" ESC_FG_WHITE), ErrorCode);
 212
 213         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 214         for(;;);
 215 }
 216
 217 /** Event handler for the USB_DeviceEnumerationFailed event. This indicates that a problem occurred while
 218  *  enumerating an attached USB device.
 219  */
 220 void EVENT_USB_Host_DeviceEnumerationFailed(const uint8_t ErrorCode,
 221                                             const uint8_t SubErrorCode)
 222 {
 223         printf_P(PSTR(ESC_FG_RED "Dev Enum Error\r\n"
 224                                  " -- Error Code %d\r\n"
 225                                  " -- Sub Error Code %d\r\n"
 226                                  " -- In State %d\r\n" ESC_FG_WHITE), ErrorCode, SubErrorCode, USB_HostState);
 227
 228         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 229 }
 230