Skip to content
Snippets Groups Projects
Select Git revision
  • 2bd88ebc4f37baf81d550e79b3e3118b0843e61c
  • master default protected
  • LUFA-170418
  • LUFA-151115
  • LUFA-140928
  • LUFA-140302
  • LUFA-130901
  • LUFA-130901-BETA
  • LUFA-130303
  • LUFA-120730
  • LUFA-120730-BETA
  • LUFA-120219
  • LUFA-120219-BETA
  • LUFA-111009
  • LUFA-111009-BETA
  • LUFA-110528
  • LUFA-110528-BETA
17 results

USB.h

Blame
  • user avatar
    Dean Camera authored
    More documentation changes for better module-level documentation rather than file-level documentation.
    d38fa49c
    History
    USB.h 3.80 KiB
    /*
                 LUFA Library
         Copyright (C) Dean Camera, 2009.
                  
      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
      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
     *
     *  Master include file for the library USB functionality. This file should be included in all user projects making
     *  use of the USB portions of the library, instead of including any headers in the USB/LowLevel or USB/HighLevel
     *  directories.
     */
    
    /** @defgroup Group_USB USB - LUFA/Drivers/USB/USB.h
     *
     *  \section Sec_Dependencies Module Source Dependencies
     *  The following files must be built with any user project that uses this module:
     *    - LUFA/Drivers/USB/LowLevel/DevChapter9.c
     *    - LUFA/Drivers/USB/LowLevel/Endpoint.c
     *    - LUFA/Drivers/USB/LowLevel/Host.c
     *    - LUFA/Drivers/USB/LowLevel/HostChapter9.c
     *    - LUFA/Drivers/USB/LowLevel/LowLevel.c
     *    - LUFA/Drivers/USB/LowLevel/Pipe.c
     *    - LUFA/Drivers/USB/HighLevel/Events.c
     *    - LUFA/Drivers/USB/HighLevel/StdDescriptors.c
     *    - LUFA/Drivers/USB/HighLevel/USBInterrupt.c
     *    - LUFA/Drivers/USB/HighLevel/USBTask.c
     *    - LUFA/Drivers/USB/Class/ConfigDescriptor.c
     *    - LUFA/Drivers/USB/Class/HIDParser.c
     *
     *  \section Module Description
     *  Functions, macros, variables, enums and types related to the management of USB communications.
     */
    
    #ifndef __USB_H__
    #define __USB_H__
    
    	/* Preprocessor Checks: */
    		#if (!(defined(__AVR_AT90USB1287__) || defined(__AVR_AT90USB647__)) && defined(USB_HOST_ONLY))
    			#error USB_HOST_ONLY is not available for the currently selected USB AVR model.
    		#endif
    		
    		#if (!(defined(__AVR_AT90USB1287__) || defined(__AVR_AT90USB647__) ||  \
    		       defined(__AVR_AT90USB1286__) || defined(__AVR_AT90USB646__) ||  \
    			   defined(__AVR_AT90USB162__)  || defined(__AVR_AT90USB82__)  ||  \
    			   defined(__AVR_ATmega16U4__)  || defined(__AVR_ATmega32U4__) ||  \
    			   defined(__AVR_ATmega32U6__)))
    			#error The currently selected AVR model is not supported under the USB component of the LUFA library.
    		#endif
    		
    	/* Includes: */
    		#include "HighLevel/USBMode.h"
    		#include "HighLevel/USBTask.h"
    		#include "HighLevel/USBInterrupt.h"
    		#include "HighLevel/Events.h"
    		#include "HighLevel/StdDescriptors.h"
    
    		#include "LowLevel/LowLevel.h"
    	
    		#if defined(USB_CAN_BE_HOST) || defined(__DOXYGEN__)
    			#include "LowLevel/Host.h"
    			#include "LowLevel/HostChapter9.h"
    			#include "LowLevel/Pipe.h"
    		#endif
    		
    		#if defined(USB_CAN_BE_DEVICE) || defined(__DOXYGEN__)
    			#include "LowLevel/Device.h"
    			#include "LowLevel/DevChapter9.h"
    			#include "LowLevel/Endpoint.h"
    		#endif
    		
    		#if defined(USB_CAN_BE_BOTH) || defined(__DOXYGEN__)
    			#include "LowLevel/OTG.h"
    		#endif
    		
    		#include "Class/ConfigDescriptor.h"
    		#include "Class/HIDParser.h"
    		
    #endif