Added Class, ClassDevice, ClassHost and ClassCommon to the internal class driver...

[pub/lufa.git] / LUFA / Drivers / USB / Class / MassStorageClass.h

diff --git a/LUFA/Drivers/USB/Class/MassStorageClass.h b/LUFA/Drivers/USB/Class/MassStorageClass.h
new file mode 100644 (file)
index 0000000..003c63b
--- /dev/null
+++ b/LUFA/Drivers/USB/Class/MassStorageClass.h
@@ -0,0 +1,80 @@
+/*
+             LUFA Library
+     Copyright (C) Dean Camera, 2011.
+
+  dean [at] fourwalledcubicle [dot] com
+           www.lufa-lib.org
+*/
+
+/*
+  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
+  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
+  software, including all implied warranties of merchantability
+  and fitness.  In no event shall the author be liable for any
+  special, indirect or consequential damages or any damages
+  whatsoever resulting from loss of use, data or profits, whether
+  in an action of contract, negligence or other tortious action,
+  arising out of or in connection with the use or performance of
+  this software.
+*/
+
+/** \file
+ *  \brief Master include file for the library USB Mass Storage Class driver.
+ *
+ *  Master include file for the library USB Mass Storage Class driver, for both host and device modes, where available.
+ *
+ *  This file should be included in all user projects making use of this optional class driver, instead of
+ *  including any headers in the USB/ClassDriver/Device, USB/ClassDriver/Host or USB/ClassDriver/Common subdirectories.
+ */
+
+/** \ingroup Group_USBClassDrivers
+ *  \defgroup Group_USBClassMS Mass Storage Class Driver
+ *
+ *  \section Sec_Dependencies Module Source Dependencies
+ *  The following files must be built with any user project that uses this module:
+ *    - LUFA/Drivers/USB/Class/Device/MassStorage.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>
+ *    - LUFA/Drivers/USB/Class/Host/MassStorage.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>
+ *
+ *  \section Sec_ModDescription Module Description
+ *  Mass Storage Class Driver module. This module contains an internal implementation of the USB Mass Storage Class, for both
+ *  Device and Host USB modes. User applications can use this class driver instead of implementing the Mass Storage class
+ *  manually via the low-level LUFA APIs.
+ *
+ *  This module is designed to simplify the user code by exposing only the required interface needed to interface with
+ *  Hosts or Devices using the USB Mass Storage Class.
+ *
+ *  @{
+ */
+
+#ifndef _MS_CLASS_H_
+#define _MS_CLASS_H_
+
+       /* Macros: */
+               #define __INCLUDE_FROM_USB_DRIVER
+               #define __INCLUDE_FROM_MS_DRIVER
+
+       /* Includes: */
+               #include "../Core/USBMode.h"
+
+               #if defined(USB_CAN_BE_DEVICE)
+                       #include "Device/MassStorageClassDevice.h"
+               #endif
+
+               #if defined(USB_CAN_BE_HOST)
+                       #include "Host/MassStorageClassHost.h"
+               #endif
+
+#endif
+
+/** @} */
+