X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/aaa0bed556d0fa424b831418a7ce2531653a8b03..fc31973daffea3506051ce51a5f79383ce0867d6:/LUFA/Drivers/USB/Class/Common/MassStorage.h

diff --git a/LUFA/Drivers/USB/Class/Common/MassStorage.h b/LUFA/Drivers/USB/Class/Common/MassStorage.h
index 49a18663f..b5e590ea3 100644
--- a/LUFA/Drivers/USB/Class/Common/MassStorage.h
+++ b/LUFA/Drivers/USB/Class/Common/MassStorage.h
@@ -1,21 +1,21 @@
 /*
              LUFA Library
-     Copyright (C) Dean Camera, 2009.
+     Copyright (C) Dean Camera, 2010.
               
   dean [at] fourwalledcubicle [dot] com
       www.fourwalledcubicle.com
 */
 
 /*
-  Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)
-
-  Permission to use, copy, modify, and distribute this software
-  and its documentation for any purpose and without fee is hereby
-  granted, provided that the above copyright notice appear in all
-  copies and that both that the copyright notice and this
-  permission notice and warranty disclaimer appear in supporting
-  documentation, and that the name of the author not be used in
-  advertising or publicity pertaining to distribution of the
+  Copyright 2010  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
+  without fee, provided that the above copyright notice appear in 
+  all copies and that both that the copyright notice and this
+  permission notice and warranty disclaimer appear in supporting 
+  documentation, and that the name of the author not be used in 
+  advertising or publicity pertaining to distribution of the 
   software without specific, written prior permission.
 
   The author disclaim all warranties with regard to this
@@ -28,6 +28,15 @@
   this software.
 */
 
+/** \file
+ *  \brief Common definitions and declarations for the library USB Mass Storage Class driver.
+ *
+ *  Common definitions and declarations 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.
+ */
+
 /** \ingroup Group_USBClassMS
  *  @defgroup Group_USBClassMSCommon  Common Class Definitions
  *
@@ -51,6 +60,11 @@
 			extern "C" {
 		#endif
 
+	/* Preprocessor Checks: */
+		#if !defined(__INCLUDE_FROM_MS_DRIVER)
+			#error Do not include this file directly. Include LUFA/Drivers/Class/MassStorage.h instead.
+		#endif
+		
 	/* Macros: */
 		/** Mass Storage Class specific request to reset the Mass Storage interface, ready for the next command. */
 		#define REQ_MassStorageReset       0xFF
@@ -192,7 +206,9 @@
 		#define SCSI_ASENSEQ_OPERATION_IN_PROGRESS             0x07
 		
 	/* Type defines: */
-		/** Type define for a Command Block Wrapper, used in the Mass Storage Bulk-Only Transport protocol. */
+		/** \brief Mass Storage Class Command Block Wrapper.
+		 *
+		 *  Type define for a Command Block Wrapper, used in the Mass Storage Bulk-Only Transport protocol. */
 		typedef struct
 		{
 			uint32_t Signature; /**< Command block signature, must be CBW_SIGNATURE to indicate a valid Command Block */
@@ -204,7 +220,10 @@
 			uint8_t  SCSICommandData[16]; /**< Issued SCSI command in the Command Block */
 		} MS_CommandBlockWrapper_t;
 		
-		/** Type define for a Command Status Wrapper, used in the Mass Storage Bulk-Only Transport protocol. */
+		/** \brief Mass Storage Class Command Status Wrapper.
+		 *
+		 *  Type define for a Command Status Wrapper, used in the Mass Storage Bulk-Only Transport protocol.
+		 */
 		typedef struct
 		{
 			uint32_t Signature; /**< Status block signature, must be CSW_SIGNATURE to indicate a valid Command Status */
@@ -213,7 +232,9 @@
 			uint8_t  Status; /**< Status code of the issued command - a value from the MassStorage_CommandStatusCodes_t enum */
 		} MS_CommandStatusWrapper_t;
 		
-		/** Type define for a SCSI Sense structure. Structures of this type are filled out by the
+		/** \brief Mass Storage Class SCSI Sense Structure
+		 *  
+		 *  Type define for a SCSI Sense structure. Structures of this type are filled out by the
 		 *  device via the MassStore_RequestSense() function, indicating the current sense data of the
 		 *  device (giving explicit error codes for the last issued command). For details of the
 		 *  structure contents, refer to the SCSI specifications.
@@ -239,7 +260,9 @@
 			uint8_t      SenseKeySpecific[3];
 		} SCSI_Request_Sense_Response_t;
 
-		/** Type define for a SCSI Inquiry structure. Structures of this type are filled out by the
+		/** \brief Mass Storage Class SCSI Inquiry Structure.
+		 *
+		 *  Type define for a SCSI Inquiry structure. Structures of this type are filled out by the
 		 *  device via the MassStore_Inquiry() function, retrieving the attached device's information.
 		 *  For details of the structure contents, refer to the SCSI specifications.
 		 */