LUFA/Drivers/USB/Class/Host/MassStorage.h

   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 /** \ingroup Group_USBClassMS
  32  *  @defgroup Group_USBClassMassStorageHost Mass Storage Class Host Mode Driver
  33  *
  34  *  \section Sec_Dependencies Module Source Dependencies
  35  *  The following files must be built with any user project that uses this module:
  36  *    - LUFA/Drivers/USB/Class/Host/MassStorage.c
  37  *
  38  *  \section Module Description
  39  *  Host Mode USB Class driver framework interface, for the Mass Storage USB Class driver.
  40  *
  41  *  @{
  42  */
  43
  44 #ifndef __MS_CLASS_HOST_H__
  45 #define __MS_CLASS_HOST_H__
  46
  47         /* Includes: */
  48                 #include "../../USB.h"
  49                 #include "../Common/MassStorage.h"
  50
  51         /* Enable C linkage for C++ Compilers: */
  52                 #if defined(__cplusplus)
  53                         extern "C" {
  54                 #endif
  55
  56         /* Public Interface - May be used in end-application: */
  57                 /* Type Defines: */
  58                         /** Class state structure. An instance of this structure should be made within the user application,
  59                          *  and passed to each of the HID class driver functions as the HIDInterfaceInfo parameter. This
  60                          *  stores each HID interface's configuration and state information.
  61                          */
  62                         typedef struct
  63                         {
  64                                 const struct
  65                                 {
  66                                         uint8_t  DataINPipeNumber; /**< Pipe number of the MS interface's IN data pipe */
  67                                         uint8_t  DataOUTPipeNumber; /**< Pipe number of the MS interface's OUT data pipe */
  68                                 } Config; /**< Config data for the USB class interface within the device. All elements in this section
  69                                            *   <b>must</b> be set or the interface will fail to enumerate and operate correctly.
  70                                            */
  71                                 struct
  72                                 {
  73                                         bool Active; /**< Indicates if the current interface instance is connected to an attached device, valid
  74                                                       *   after \ref HID_Host_ConfigurePipes() is called and the Host state machine is in the
  75                                                       *   Configured state
  76                                                       */
  77                                         uint8_t InterfaceNumber; /**< Interface index of the HID interface within the attached device */
  78
  79                                         uint16_t DataINPipeSize; /**< Size in bytes of the MS interface's IN data pipe */
  80                                         uint16_t DataOUTPipeSize;  /**< Size in bytes of the MS interface's OUT data pipe */
  81                                 } State; /**< State data for the USB class interface within the device. All elements in this section
  82                                                   *   <b>may</b> be set to initial values, but may also be ignored to default to sane values when
  83                                                   *   the interface is enumerated.
  84                                                   */
  85                         } USB_ClassInfo_MS_Host_t;
  86
  87                 /* Enums: */
  88                         enum
  89                         {
  90                                 MS_ENUMERROR_NoError                    = 0, /**< Configuration Descriptor was processed successfully */
  91                                 MS_ENUMERROR_InvalidConfigDescriptor    = 1, /**< The device returned an invalid Configuration Descriptor */
  92                                 MS_ENUMERROR_NoMSInterfaceFound        = 2, /**< A compatible Mass Storage interface was not found in the device's Configuration Descriptor */
  93                                 MS_ENUMERROR_EndpointsNotFound          = 3, /**< Compatible Mass Storage endpoints were not found in the device's interfaces */
  94                         } MSHost_EnumerationFailure_ErrorCodes_t;
  95
  96                 /* Function Prototypes: */
  97                         void MS_Host_USBTask(USB_ClassInfo_MS_Host_t* MSInterfaceInfo);
  98                         uint8_t MS_Host_ConfigurePipes(USB_ClassInfo_MS_Host_t* MSInterfaceInfo, uint16_t ConfigDescriptorLength,
  99                                                        uint8_t* DeviceConfigDescriptor);
 100
 101         /* Private Interface - For use in library only: */
 102         #if !defined(__DOXYGEN__)
 103                 /* Macros: */
 104                         #define MASS_STORE_CLASS               0x08
 105                         #define MASS_STORE_SUBCLASS            0x06
 106                         #define MASS_STORE_PROTOCOL            0x50
 107
 108                         #define MS_FOUND_DATAPIPE_IN           (1 << 0)
 109                         #define MS_FOUND_DATAPIPE_OUT          (1 << 1)
 110
 111                 /* Function Prototypes: */
 112                         #if defined(INCLUDE_FROM_MS_CLASS_HOST_C)
 113                                 static uint8_t DComp_NextMassStorageInterface(void* CurrentDescriptor);
 114                                 static uint8_t DComp_NextInterfaceBulkDataEndpoint(void* CurrentDescriptor);
 115                         #endif
 116         #endif
 117
 118         /* Disable C linkage for C++ Compilers: */
 119                 #if defined(__cplusplus)
 120                         }
 121                 #endif
 122
 123 #endif
 124
 125 /** @} */