X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/5a4def747897c1c6ffbe465506d846c7c686d3e9..0019fbd1294ccc9ecb0ac4ddb5d8c71efcf9597f:/LUFA/Drivers/USB/Class/Host/MassStorage.h diff --git a/LUFA/Drivers/USB/Class/Host/MassStorage.h b/LUFA/Drivers/USB/Class/Host/MassStorage.h index f442db846..93034c3bc 100644 --- a/LUFA/Drivers/USB/Class/Host/MassStorage.h +++ b/LUFA/Drivers/USB/Class/Host/MassStorage.h @@ -1,13 +1,13 @@ /* LUFA Library - Copyright (C) Dean Camera, 2010. + Copyright (C) Dean Camera, 2011. dean [at] fourwalledcubicle [dot] com - www.fourwalledcubicle.com + www.lufa-lib.org */ /* - Copyright 2010 Dean Camera (dean [at] fourwalledcubicle [dot] com) + Copyright 2011 Dean Camera (dean [at] fourwalledcubicle [dot] com) Permission to use, copy, modify, distribute, and sell this software and its documentation for any purpose is hereby granted @@ -33,8 +33,8 @@ * * Host mode driver for the library USB Mass Storage Class driver. * - * \note This file should not be included directly. It is automatically included as needed by the class driver - * dispatch header located in LUFA/Drivers/USB/Class/MassStorage.h. + * \note This file should not be included directly. It is automatically included as needed by the USB module driver + * dispatch header located in LUFA/Drivers/USB.h. */ /** \ingroup Group_USBClassMS @@ -44,7 +44,7 @@ * The following files must be built with any user project that uses this module: * - LUFA/Drivers/USB/Class/Host/MassStorage.c (Makefile source module name: LUFA_SRC_USBCLASS) * - * \section Module Description + * \section Sec_ModDescription Module Description * Host Mode USB Class driver framework interface, for the Mass Storage USB Class driver. * * @{ @@ -64,7 +64,7 @@ /* Preprocessor Checks: */ #if !defined(__INCLUDE_FROM_MS_DRIVER) - #error Do not include this file directly. Include LUFA/Drivers/Class/MassStorage.h instead. + #error Do not include this file directly. Include LUFA/Drivers/USB.h instead. #endif /* Public Interface - May be used in end-application: */ @@ -76,7 +76,7 @@ /** \brief Mass Storage Class Host Mode Configuration and State Structure. * * Class state structure. An instance of this structure should be made within the user application, - * and passed to each of the Mass Storage class driver functions as the MSInterfaceInfo parameter. This + * and passed to each of the Mass Storage class driver functions as the \c MSInterfaceInfo parameter. This * stores each Mass Storage interface's configuration and state information. */ typedef struct @@ -127,6 +127,7 @@ MS_ENUMERROR_NoError = 0, /**< Configuration Descriptor was processed successfully. */ MS_ENUMERROR_InvalidConfigDescriptor = 1, /**< The device returned an invalid Configuration Descriptor. */ MS_ENUMERROR_NoCompatibleInterfaceFound = 2, /**< A compatible Mass Storage interface was not found in the device's Configuration Descriptor. */ + MS_ENUMERROR_PipeConfigurationFailed = 3, /**< One or more pipes for the specified interface could not be configured correctly. */ }; /* Function Prototypes: */ @@ -243,7 +244,7 @@ * * \param[in,out] MSInterfaceInfo Pointer to a structure containing a MS Class host configuration and state. * \param[in] LUNIndex LUN index within the device the command is being issued to. - * \param[in] PreventRemoval Boolean true if the device should be locked from removal, false otherwise. + * \param[in] PreventRemoval Boolean \c true if the device should be locked from removal, \c false otherwise. * * \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum or \ref MS_ERROR_LOGICAL_CMD_FAILED if not ready. */ @@ -309,23 +310,10 @@ /* Private Interface - For use in library only: */ #if !defined(__DOXYGEN__) /* Macros: */ - #define MASS_STORE_CLASS 0x08 - #define MASS_STORE_SUBCLASS 0x06 - #define MASS_STORE_PROTOCOL 0x50 - - #define REQ_MassStorageReset 0xFF - #define REQ_GetMaxLUN 0xFE - - #define CBW_SIGNATURE 0x43425355UL - #define CSW_SIGNATURE 0x53425355UL - - #define COMMAND_DIRECTION_DATA_OUT (0 << 7) - #define COMMAND_DIRECTION_DATA_IN (1 << 7) - - #define COMMAND_DATA_TIMEOUT_MS 10000 + #define MS_COMMAND_DATA_TIMEOUT_MS 10000 /* Function Prototypes: */ - #if defined(__INCLUDE_FROM_MS_CLASS_HOST_C) + #if defined(__INCLUDE_FROM_MASSSTORAGE_HOST_C) static uint8_t DCOMP_MS_Host_NextMSInterface(void* const CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1); static uint8_t DCOMP_MS_Host_NextMSInterfaceEndpoint(void* const CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1);